@@ -1,4 +1,4 @@

[chiark-utils.git] / sync-accounts / sync-accounts.8

diff --git a/sync-accounts/sync-accounts.8 b/sync-accounts/sync-accounts.8
index 92e1e801478d7384c51bb81d0862035b9b7de69b..fd3b6e72da7e45574b852a9e1fad64572982533a 100644 (file)
--- a/sync-accounts/sync-accounts.8
+++ b/sync-accounts/sync-accounts.8
@@ -5,13 +5,13 @@ sync\-accounts \- synchronise accounts and passwords
 .SH SYNOPSIS
 .BR sync\-accounts " [\fIoptions\fP] [\fIsource\fP ...]"
 .SH DESCRIPTION
-.B sync\-accounts
+.B sync-accounts
 is a tool for copying account information into the local system's
 password and group databases, or equivalent, from other systems.  It
 can be used to slave individual accounts, whole systems, or various
 partial combinations.
 
-By default, when invoked, sync\-accounts reads is configuration file
+By default, when invoked, sync-accounts reads is configuration file
 and updates all of the local details it is configured to synchronise,
 from all relevant sources.
 
@@ -19,19 +19,19 @@ If one or more \fIsource\fPs are named as command-line arguments, only
 information from those sources is installed locally.
 
 See
-.BR sync\-accounts(5)
-for detailed information about sync\-accounts's behaviour and
+.BR sync-accounts(5)
+for detailed information about sync-accounts's behaviour and
 configuration.
 .SH OPTIONS
 .TP
 .BI \-C config\-file
 Reads
-.I config\-file
+.I config-file
 instead of
-.BR /etc/sync\-accounts .
+.BR /etc/sync-accounts .
 .TP
 .BR \-q
-Instead of updating local information, sync\-accounts displays a
+Instead of updating local information, sync-accounts displays a
 summary of which accounts are synchronised or not, and from where.
 .TP
 .BR \-n
@@ -46,16 +46,16 @@ in the current directory.  With
 new accounts are not created at all.  The system databases are not
 locked.
 .SH SECURITY
-sync\-accounts is not resistant to malicious data in the local
+sync-accounts is not resistant to malicious data in the local
 password and group databases, or its configuration file or command
 line arguments.
 
 Malicious data in source information will not be able to take control
 of sync-accounts, but will be copied to the local databases if
-sync\-accounts is configured to do so.
+sync-accounts is configured to do so.
 
-To update the local databases, sync\-accounts must be run as root.
-For \-q and \-n sync\-accounts still needs to be able to successfuly
+To update the local databases, sync-accounts must be run as root.
+For \-q and \-n sync-accounts still needs to be able to successfuly
 invoke the commands specified in the configuration for getpasswd and
 getgroup.
 .SH EXIT STATUS
@@ -72,7 +72,7 @@ updated.
 Default configuration file.  (Override with
 .BR -C .)
 .TP
-.B sync\-accounts\-createuser
+.B sync-accounts-createuser
 Default command invoked by sync-accounts to create local users.
 .TP
 .B /home
@@ -81,8 +81,11 @@ Default location for created users' home directories.
 .B /bin/sh
 Default shell for created users.
 .TP
-.BR /etc/master.passwd ", " /etc/passwd ", " /etc/shadow ", " /etc/group
-Default local account databases, depending on configuration.
+.BR /etc/passwd ", " /etc/group ", " /etc/shadow ", " /etc/master.passwd
+Local account databases, depending on configuration.
+.TP
+.BR /etc/shadow-non-existent
+Must not exist.
 .SH ENVIRONMENT
 .TP
 .BR EDITOR ", " VISUAL
@@ -102,28 +105,35 @@ and
 .BR vigr (8),
 apart from
 .BR EDITOR " and/or"  VISUAL
-will affect the operation of sync\-accounts.  
+will affect the operation of sync-accounts.  
 Avoid messing with these if possible.
 .LP
 .B PATH
 is used to find subprograms such as
-.BR sync\-accounts\-createuser " and " vipw / vigr .
+.BR sync-accounts-createuser " and " vipw / vigr .
 .SH BUGS
-Using sync\-accounts does not give particularly prompt propagation of
+Using sync-accounts does not give particularly prompt propagation of
 changed account information.
 
 There is no simple mechanism for automatically getting the right
 configuration details for accessing the local system's password and
 group databases.
+
+All the systems sharing account information using sync-accounts need
+to be using compatible encrypted-password schemes.
 .SH AUTHOR
-.B sync\-accounts
-and this manpage were written by Ian Jackson
-<ian@chiark.greenend.org.uk>.  They are Copyright 2002 Ian Jackson.
+.B sync-accounts
+and this manpage are part of the
+.B sync-accounts
+package which was written by Ian Jackson <ian@chiark.greenend.org.uk>.
+They are Copyright 1999-2000,2002 Ian Jackson
+<ian@davenant.greenend.org.uk>, and Copyright 2000-2001 nCipher
+Corporation Ltd.
 
-sync\-accounts and this manpage are free software; you can
-redistribute it and/or modify it under the terms of the GNU General
-Public License as published by the Free Software Foundation; either
-version 2, or (at your option) any later version.
+The sync-accounts package is free software; you can redistribute it
+and/or modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation; either version 2, or (at
+your option) any later version.
 
 This is distributed in the hope that it will be useful, but WITHOUT ANY
 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
@@ -133,3 +143,13 @@ details.
 You should have received a copy of the GNU General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+.SH SEE ALSO
+.BR sync-accounts "(5), "
+.BR grab-account "(8), "
+.BR sync-accounts-createuser "(8), "
+.BR passwd "(5), "
+.BR group "(5), "
+.BR shadow "(5), "
+.BR master.passwd "(5), "
+.BR vipw "(8), "
+.BR vigr "(8)"