sync-accounts/sync-accounts.8

   1 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
   2 .TH SYNC\-ACCOUNTS 8 "14th July 2002" "Greenend" "chiark utilities"
   3 .SH NAME
   4 sync\-accounts \- synchronise accounts and passwords
   5 .SH SYNOPSIS
   6 .BR sync\-accounts " [\fIoptions\fP] [\fIsource\fP ...]"
   7 .SH DESCRIPTION
   8 .B sync\-accounts
   9 is a tool for copying account information into the local system's
  10 password and group databases, or equivalent, from other systems.  It
  11 can be used to slave individual accounts, whole systems, or various
  12 partial combinations.
  13
  14 By default, when invoked, sync\-accounts reads is configuration file
  15 and updates all of the local details it is configured to synchronise,
  16 from all relevant sources.
  17
  18 If one or more \fIsource\fPs are named as command-line arguments, only
  19 information from those sources is installed locally.
  20
  21 See
  22 .BR sync\-accounts(5)
  23 for detailed information about sync\-accounts's behaviour and
  24 configuration.
  25 .SH OPTIONS
  26 .TP
  27 .BI \-C config\-file
  28 Reads
  29 .I config\-file
  30 instead of
  31 .BR /etc/sync\-accounts .
  32 .TP
  33 .BR \-q
  34 Instead of updating local information, sync\-accounts displays a
  35 summary of which accounts are synchronised or not, and from where.
  36 .TP
  37 .BR \-n
  38 Causes sync-accounts not to actually install the new information in
  39 the local password and group databases.  Instead, updated versions are
  40 written to the files
  41 .B passwd
  42 and
  43 .B group
  44 in the current directory.  With
  45 .B \-n
  46 new accounts are not created at all.  The system databases are not
  47 locked.
  48 .SH SECURITY
  49 sync\-accounts is not resistant to malicious data in the local
  50 password and group databases, or its configuration file or command
  51 line arguments.
  52
  53 Malicious data in source information will not be able to take control
  54 of sync-accounts, but will be copied to the local databases if
  55 sync\-accounts is configured to do so.
  56
  57 To update the local databases, sync\-accounts must be run as root.
  58 For \-q and \-n sync\-accounts still needs to be able to successfuly
  59 invoke the commands specified in the configuration for getpasswd and
  60 getgroup.
  61 .SH EXIT STATUS
  62 .TP
  63 .B 0
  64 All went well and there were no warnings.
  65 .TP
  66 any other
  67 There were problems.  The local databases may or may not have been
  68 updated.
  69 .SH FILES
  70 .TP
  71 .B /etc/sync-accounts
  72 Default configuration file.  (Override with
  73 .BR -C .)
  74 .TP
  75 .B sync\-accounts\-createuser
  76 Default command invoked by sync-accounts to create local users.
  77 .TP
  78 .B /home
  79 Default location for created users' home directories.
  80 .TP
  81 .B /bin/sh
  82 Default shell for created users.
  83 .TP
  84 .BR /etc/master.passwd ", " /etc/passwd ", " /etc/shadow ", " /etc/group
  85 Default local account databases, depending on configuration.
  86 .SH ENVIRONMENT
  87 .TP
  88 .BR EDITOR ", " VISUAL
  89 Manipulated by sync-\accounts when it is reinvoking itself via vipw or
  90 vigr, according to
  91 .B lockpasswd runvia
  92 or
  93 .BR "lockgroup runvia" .
  94 .TP
  95 .BR SYNC_ACCOUNTS_*
  96 Used by sync-accounts for its own purposes.  Do not set these
  97 variables.
  98 .LP
  99 Setting variables used by
 100 .BR vipw (8)
 101 and
 102 .BR vigr (8),
 103 apart from
 104 .BR EDITOR " and/or"  VISUAL
 105 will affect the operation of sync\-accounts.
 106 Avoid messing with these if possible.
 107 .LP
 108 .B PATH
 109 is used to find subprograms such as
 110 .BR sync\-accounts\-createuser " and " vipw / vigr .
 111 .SH BUGS
 112 Using sync\-accounts does not give particularly prompt propagation of
 113 changed account information.
 114
 115 There is no simple mechanism for automatically getting the right
 116 configuration details for accessing the local system's password and
 117 group databases.
 118 .SH AUTHOR
 119 .B sync\-accounts
 120 and this manpage were written by Ian Jackson
 121 <ian@chiark.greenend.org.uk>.  They are Copyright 2002 Ian Jackson.
 122
 123 sync\-accounts and this manpage are free software; you can
 124 redistribute it and/or modify it under the terms of the GNU General
 125 Public License as published by the Free Software Foundation; either
 126 version 2, or (at your option) any later version.
 127
 128 This is distributed in the hope that it will be useful, but WITHOUT ANY
 129 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 130 FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 131 details.
 132
 133 You should have received a copy of the GNU General Public License along
 134 with this program; if not, write to the Free Software Foundation, Inc.,
 135 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.