sync-accounts/grab-account.8

   1 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
   2 .TH GRAB\-ACCOUNT 8 "14th July 2002" "Greenend" "chiark utilities"
   3 .SH NAME
   4 grab\-account \- add new account synchronised to remote system
   5 .SH SYNOPSIS
   6 .BI "grab\-account " local\-user " " source " [" remote\-user ]
   7 .SH DESCRIPTION
   8 .B grab-account
   9 reconfigures sync-accounts to start synchronising a specified local
  10 user (which may not yet exist) from a specified remote system, and
  11 then invokes sync-accounts once to synchronise from that source.
  12
  13 .B /etc/sync-accounts/createuser
  14 should contain a
  15 .B addhere
  16 line in the appropriate source section (ie, after
  17 .BR host " \fIsource\fP)."
  18 grab-account adds a
  19 .br
  20 .BR "  user" " \fIlocal\-user\fP [" remote= "\fIremote\-user\fP]"
  21 .br
  22 directive just before
  23 .B addhere
  24 and runs
  25 .BR sync-accounts " \fIsource\fP."
  26 .SH EXIT STATUS
  27 .TP
  28 .B 0
  29 All went well.
  30 .TP
  31 any other
  32 There were problems.
  33 .SH FILES
  34 .BR /etc/sync-accounts ;
  35 See also
  36 .BR sync-accounts (8).
  37 .SH ENVIRONMENT
  38 See
  39 .BR sync-accounts (8).
  40 .SH BUGS
  41 There is no locking of
  42 .B /etc/sync-accounts
  43 so do not invoke grab-account from a script, or more than once at a
  44 time by hand.  Do not edit /etc/sync-accounts by hand and also
  45 simultaneously run grab-account.
  46
  47 The mechanism involving
  48 .B addhere
  49 is suboptimal.  This should be done with an include feature in
  50 sync-accounts, so that grab-account does not have to edit a
  51 configuration file that really belongs to the sysadmin.
  52 .SH AUTHOR
  53 .B grab-account
  54 and this manpage are part of the
  55 .B sync-accounts
  56 package which was written by Ian Jackson <ian@chiark.greenend.org.uk>.
  57 They are Copyright 1999-2000,2002 Ian Jackson
  58 <ian@davenant.greenend.org.uk>, and Copyright 2000-2001 nCipher
  59 Corporation Ltd.
  60
  61 The sync-accounts package is free software; you can redistribute it
  62 and/or modify it under the terms of the GNU General Public License as
  63 published by the Free Software Foundation; either version 3, or (at
  64 your option) any later version.
  65
  66 This is distributed in the hope that it will be useful, but WITHOUT ANY
  67 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  68 FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  69 details.
  70
  71 You should have received a copy of the GNU General Public License along
  72 with this program; if not, consult the Free Software Foundation's
  73 website at www.fsf.org, or the GNU Project website at www.gnu.org.
  74 .SH SEE ALSO
  75 .BR sync-accounts "(8), "
  76 .BR sync-accounts "(5), "
  77 .BR passwd "(5)"