@@ -1,6 +1,7 @@

+  * Manpage sync-accounts(8).

diff --git a/debian/changelog b/debian/changelog
index 4cc3477fb466fc1fb955b9eca481d2da1913bb84..5b424f6d2f9b5169438dd4276f308079b66488ad 100644 (file)
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,6 +1,7 @@
 chiark-utils (3.0.0) unstable; urgency=low
 
   * Added sync-accounts.
+  * Manpage sync-accounts(8).
 
  --
 

diff --git a/sync-accounts/sync-accounts.8 b/sync-accounts/sync-accounts.8
new file mode 100644 (file)
index 0000000..92e1e80
--- /dev/null
+++ b/sync-accounts/sync-accounts.8
@@ -0,0 +1,135 @@
+.\" Hey, Emacs!  This is an -*- nroff -*- source file.
+.TH SYNC\-ACCOUNTS 8 "14th July 2002" "Greenend" "chiark utilities"
+.SH NAME
+sync\-accounts \- synchronise accounts and passwords
+.SH SYNOPSIS
+.BR sync\-accounts " [\fIoptions\fP] [\fIsource\fP ...]"
+.SH DESCRIPTION
+.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
+and updates all of the local details it is configured to synchronise,
+from all relevant sources.
+
+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
+configuration.
+.SH OPTIONS
+.TP
+.BI \-C config\-file
+Reads
+.I config\-file
+instead of
+.BR /etc/sync\-accounts .
+.TP
+.BR \-q
+Instead of updating local information, sync\-accounts displays a
+summary of which accounts are synchronised or not, and from where.
+.TP
+.BR \-n
+Causes sync-accounts not to actually install the new information in
+the local password and group databases.  Instead, updated versions are
+written to the files
+.B passwd
+and
+.B group
+in the current directory.  With
+.B \-n
+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
+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.
+
+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
+.TP
+.B 0
+All went well and there were no warnings.
+.TP
+any other
+There were problems.  The local databases may or may not have been
+updated.
+.SH FILES
+.TP
+.B /etc/sync-accounts
+Default configuration file.  (Override with
+.BR -C .)
+.TP
+.B sync\-accounts\-createuser
+Default command invoked by sync-accounts to create local users.
+.TP
+.B /home
+Default location for created users' home directories.
+.TP
+.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.
+.SH ENVIRONMENT
+.TP
+.BR EDITOR ", " VISUAL
+Manipulated by sync-\accounts when it is reinvoking itself via vipw or
+vigr, according to
+.B lockpasswd runvia
+or
+.BR "lockgroup runvia" .
+.TP
+.BR SYNC_ACCOUNTS_*
+Used by sync-accounts for its own purposes.  Do not set these
+variables.
+.LP
+Setting variables used by
+.BR vipw (8)
+and
+.BR vigr (8),
+apart from
+.BR EDITOR " and/or"  VISUAL
+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 .
+.SH BUGS
+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.
+.SH AUTHOR
+.B sync\-accounts
+and this manpage were written by Ian Jackson
+<ian@chiark.greenend.org.uk>.  They are Copyright 2002 Ian Jackson.
+
+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.
+
+This is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+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.