git.sur5r.net Git - openldap/blob - doc/man/man8/slurpd.8

   1 .TH SLURPD 8C "22 September 1998" "OpenLDAP LDVERSION"
   2 .SH NAME
   3 slurpd \- Standalone LDAP Update Replication Daemon
   4 .SH SYNOPSIS
   5 .B LIBEXECDIR/slurpd [\-d debug\-level]
   6 .B [\-f slapd\-config\-file] [\-r slapd\-replog\-file]
   7 .B [\-t temp\-dir] [\-o] [\-k srvtab\-file]
   8 .B
   9 .SH DESCRIPTION
  10 .LP
  11 .B Slurpd
  12 is used to propagate changes from one slapd database to another.  If
  13 slapd is configured to produce a replication log,
  14 .B slurpd
  15 reads that
  16 replication log and sends the changes to the slave
  17 .B slapd
  18 instances
  19 via the LDAP protocol.
  20 .B slurpd
  21 is typically invoked at boot time, usually out of
  22 .BR  /etc/rc.local .
  23 .LP
  24 Upon startup,
  25 .B slurpd
  26 normally forks and disassociates itself from the invoking tty,
  27 then reads the replication log (given either by the
  28 .I replogfile
  29 directive in the
  30 .B slapd
  31 config file, or by the
  32 .RB \- r
  33 command-line option).
  34 If the replication log file does not exist or is empty,
  35 .B slurpd
  36 goes to sleep.  It periodically wakes up and checks to see if there
  37 are any changes to be propoagated.
  38 .LP
  39 When
  40 .B slurpd
  41 notices that there are changes to propagate to slave
  42 .B slapd
  43 instances, it locks the replication log, makes its own private copy,
  44 releases the lock, and forks one copy of itself for each replica
  45 .B slapd
  46 to be updated.  Each child process binds to the slave
  47 .B slapd
  48 as the
  49 DN given by the
  50 .I binddn
  51 option to the
  52 .I replica
  53 directive in the
  54 .B slapd
  55 config file, and sends the changes.
  56 .LP
  57 See
  58 .BR slapd (8)
  59 for details on the standalone LDAP daemon.
  60 .SH OPTIONS
  61 .TP
  62 .BI \-d " debug\-level"
  63 Turn on debugging as defined by
  64 .I debug\-level.
  65 If this option is specified, even with a zero argument,
  66 .B slurpd
  67 will not fork or disassociate from the invoking terminal.  Some general
  68 operation and status messages are printed for any value of \fIdebug\-level\fP.
  69 \fIdebug\-level\fP is taken as a bit string, with each bit corresponding to a
  70 different kind of debugging information.  See <ldap.h> for details.
  71 .TP
  72 .BI \-f " slapd\-config\-file"
  73 Specifies the slapd configuration file.  The default is
  74 .BR ETCDIR/slapd.conf .
  75 .TP
  76 .BI \-r " slapd\-replog\-file"
  77 Specifies the name of the
  78 .B slapd
  79 replication logfile.  Normally, the name
  80 of the replication log file is read from the
  81 .B slapd
  82 configuration file.
  83 The
  84 .B \-r
  85 option allows you to override this.  In conjunction with the
  86 .B \-o
  87 option, you can process a replication log file in a "one\-shot" mode.  For
  88 example, if
  89 .B slurpd
  90 has encountered errors in processing a replication log,
  91 you can run it in one\-shot mode and give the rejection file name as
  92 the argument to the \-r option, once you've resolved the problem which caused
  93 the replication to fail.
  94 .TP
  95 .B \-o
  96 Run in "one\-shot" mode.  Normally,
  97 .B slurpd
  98 processes the replog file
  99 and then watches for more replication entries to be appended.  In
 100 one\-shot mode,
 101 .B slurpd
 102 processes a replication log and exits.
 103 .TP
 104 .BI \-t " temp\-dir"
 105 .B slurpd
 106 copies the replication log to a working directory before processing it.
 107 This option allows you to specify the location of these temporary files.
 108 The default is
 109 .BR /usr/tmp .
 110 .TP
 111 .BI \-k " srvtab\-file"
 112 Specify the location of the kerberos srvtab file which contains keys
 113 for the replica
 114 .I slapd
 115 instances.  Overrides the srvtab argument to the
 116 replica directive in the
 117 .I slapd
 118 configuration file.
 119 .SH EXAMPLES
 120 To start
 121 .I slurpd
 122 and have it fork and detach from the terminal and process
 123 the replication logs generated by
 124 .I slapd,
 125 just type:
 126 .LP
 127 .nf
 128 .ft tt
 129         LIBEXECDIR/slurpd
 130 .ft
 131 .fi
 132 .LP
 133 To start
 134 .I slurpd
 135 with an alternate
 136 .I slapd
 137 configuration file, and turn
 138 on voluminous debugging which will be printed on standard error, type:
 139 .LP
 140 .nf
 141 .ft tt
 142         LIBEXECDIR/slurpd -f ETCDIR/slapd.conf -d 255
 143 .ft
 144 .fi
 145 .LP
 146 .SH "SEE ALSO"
 147 .BR ldap (3),
 148 .BR slapd.replog (5),
 149 .BR slapd (8)
 150 .LP
 151 "The SLAPD and SLURPD Administrator's Guide"
 152 .SH ACKNOWLEDGEMENTS
 153 .B      OpenLDAP
 154 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 155 .B      OpenLDAP
 156 is derived from University of Michigan LDAP 3.3 Release.