.\" $OpenBSD: rdist.1,v 1.19 2003/06/10 09:12:11 jmc Exp $ .\" .\" Copyright (c) 1983 Regents of the University of California. .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $From: rdist.man,v 6.34 1996/01/29 22:37:19 mcooper Exp $ .\" @(#)rdist.1 6.6 (Berkeley) 5/13/86 .\" .Dd May 9, 2002 .Dt RDIST 1 .Os .Sh NAME .Nm rdist .Nd remote file distribution client program .Sh SYNOPSIS .Nm rdist .Bk -words .Op Fl DFn .Op Fl A Ar num .Op Fl a Ar num .Op Fl d Ar var=value .Op Fl l Ar .Op Fl L Ar .Op Fl f Ar distfile .Op Fl M Ar maxproc .Op Fl m Ar host .Op Fl o Ar distopts .Op Fl t Ar timeout .Op Fl p Ar .Op Fl P Ar .Op Ar name ... .Ek .Pp .Nm rdist .Fl DFn .Fl c Ar name ... .Ar [login@]host[:dest] .Pp .Nm rdist .Fl Server .Pp .Nm rdist .Fl V .Sh DESCRIPTION .Nm is a program to maintain identical copies of files over multiple hosts. It preserves the owner, group, mode, and mtime of files if possible and can update programs that are executing. .Nm reads commands from .Pa distfile to direct the updating of files and/or directories. If .Pa distfile is .Sq - , the standard input is used. If no .Fl f option is present, the program looks first for .Pa distfile , then .Pa Distfile to use as the input. If no names are specified on the command line, .Nm will update all of the files and directories listed in .Pa distfile . Otherwise, the argument is taken to be the name of a file to be updated or the label of a command to execute. If label and file names conflict, it is assumed to be a label. These may be used together to update specific files using specific commands. .Pp The .Fl c option forces .Nm to interpret the remaining arguments as a small .Pa distfile . The equivalent distfile is as follows. .Bd -literal -offset indent ( \fIname\fP ... ) -> [\fIlogin\fP@]\fIhost\fP install [\fIdest\fP] ; .Ed .Pp The .Fl Server option is recognized to provide partial backward compatible support for older versions of .Nm which used this option to put .Nm into server mode. If .Nm is started with the .Fl Server command line option, it will attempt to exec (run) the old version of .Nm rdist , .Pa /usr/bin/oldrdist . .Pp .Nm uses a remote shell command to access each target host. By default, .Xr ssh 1 is used, unless overridden by the .Fl P option or the .Ev RSH environment variable. If the target host is the string .Em localhost and the remote user name is the same as the local user name, .Nm will run the command .Bd -literal -offset indent /bin/sh -c rdistd -S .Ed .Pp Otherwise, .Nm run will run the command .Bd -literal -offset indent \fBssh \fIhost\fB -l \fIremuser \fBrdistd -S\fR .Ed .Pp where .Em host is the name of the target host, .Em remuser is the name of the user to make the connection as, and .Em rdistd is the rdist server command on the target host as shown below. .Pp On each target host .Nm will attempt to run the command .Bd -literal -offset indent rdistd -S .Ed .Pp or .Bd -literal -offset indent -S .Ed .Pp if the .Fl p option was specified. If no .Fl p option is included, or the .Ar is a simple filename, .Em rdistd or .Em must be somewhere in the .Ev PATH of the user running .Nm on the remote (target) host. .Pp The options are as follows: .Bl -tag -width Ds .It Fl A Ar num Set the minimum number of free files (inodes) on a filesystem that must exist for .Nm to update or install a file. .It Fl a Ar num Set the minimum amount of free space (in bytes) on a filesystem that must exist for .Nm to update or install a file. .It Fl D Enable copious debugging messages. .It Fl d Ar var=value Define .Ar var to have .Ar value . This option is used to define or override variable definitions in the .Pa distfile . .Ar value can be the empty string, one name, or a list of names surrounded by parentheses and separated by tabs and/or spaces. .It Fl F Do not fork any child .Nm processes. All clients are updated sequentially. .It Fl f Ar distfile Set the name of the distfile to use to be .Ar distfile . If .Ar distfile is specified as .Dq - (dash) then read from standard input (stdin). .It Fl l Ar logopts Set local logging options. See the section .Sy MESSAGE LOGGING for details on the syntax for .Ar logopts . .It Fl L Ar logopts Set remote logging options. .Ar logopts is the same as for local logging except the values are passed to the remote server (\fIrdistd\fR). See the section .Sy MESSAGE LOGGING for details on the syntax for .Ar logopts . .It Fl M Ar num Set the maximum number of simultaneously running child .Nm processes to .Ar num . The default is 4. .It Fl m Ar machine Limit which machines are to be updated. Multiple .Fl m arguments can be given to limit updates to a subset of the hosts listed in the .Pa distfile . .It Fl n Print the commands without executing them. This option is useful for debugging a .Pa distfile . .It Fl o Ns Ar distopts Specify the dist options to enable. .Ar distopts is a comma separated list of options which are listed below. The valid values for .Ar distopts are: .Bl -tag -width Ds .It Sy verify Verify that the files are up to date on all the hosts. Any files that are out of date will be displayed but no files will be changed nor will any mail be sent. .It Sy whole Whole mode. The whole file name is appended to the destination directory name. Normally, only the last component of a name is used when renaming files. This will preserve the directory structure of the files being copied instead of flattening the directory structure. For example, rdisting a list of files such as .Pa /path/dir1/f1 and .Pa /path/dir2/f2 to .Pa /tmp/dir would create files .Pa /tmp/dir/path/dir1/f1 and .Pa /tmp/dir/path/dir2/f2 instead of .Pa /tmp/dir/dir1/f1 and .Pa /tmp/dir/dir2/f2 . .It Sy noexec Automatically exclude executable files that are in .Xr a.out 5 format from being checked or updated. .It Sy younger Younger mode. Files are normally updated if their .Em mtime and .Em size (see .Xr stat 2 ) disagree. This option causes .Nm not to update files that are younger than the master copy. This can be used to prevent newer copies on other hosts from being replaced. A warning message is printed for files which are newer than the master copy. .It Sy compare Binary comparison. Perform a binary comparison and update files if they differ rather than comparing dates and sizes. .It Sy follow Follow symbolic links. Copy the file that the link points to rather than the link itself. .It Sy ignlnks Ignore unresolved links. .Nm will normally try to maintain the link structure of files being transferred and warn the user if all the links cannot be found. .It Sy chknfs Do not check or update files on target host that reside on NFS filesystems. .It Sy chkreadonly Enable check on target host to see if a file resides on a read-only filesystem. If a file does, then no checking or updating of the file is attempted. .It Sy chksym If the target on the remote host is a symbolic link, but is not on the master host, the remote target will be left a symbolic link. This behavior is generally considered a bug in the original version of .Nm rdist , but is present to allow compatibility with older versions. .It Sy defgroup[=groupname] If the group of a file to be transferred does not exist on the destination host, use the specified group instead. If groupname is not specified, the .Em bin group is used. .It Sy defowner[=owner] If the owner of a file to be transferred does not exist on the destination host, use the specified owner instead. If owner is not specified, the user .Em bin is used. .It Sy updateperm Do not send the whole file when the size and the modification time match. Instead, just update the ownership, group, and permissions as necessary. .It Sy quiet Quiet mode. Files that are being modified are normally printed on standard output. This option suppresses that. .It Sy remove Remove extraneous files. If a directory is being updated, any files that exist on the remote host that do not exist in the master directory are removed. This is useful for maintaining truly identical copies of directories. .It Sy nochkowner Do not check user ownership of files that already exist. The file ownership is only set when the file is updated. .It Sy nochkgroup Do not check group ownership of files that already exist. The file ownership is only set when the file is updated. .It Sy nochkmode Do not check file and directory permission modes. The permission mode is only set when the file is updated. .It Sy nodescend Do not descend into a directory. Normally, .Nm will recursively check directories. If this option is enabled, then any files listed in the file list in the distfile that are directories are not recursively scanned. Only the existence, ownership, and mode of the directory are checked. .It Sy numchkgroup Use the numeric group ID (GID) to check group ownership instead of the group name. .It Sy numchkowner Use the numeric user ID (UID) to check user ownership instead of the user name. .It Sy savetargets Save files that are updated instead of removing them. Any target file that is updated is first renamed from .Pa file to .Pa file.OLD . .It Sy history When .Sy savetargets and .Sy history are both defined then the target file that is updated is first renamed from .Pa file to .Pa file.NNN where NNN increases for each generation update. The first generation is 001, and the last is 999. After 999 generations, the counter is reset to 001 and 001 will get overwritten all the time. This is undesirable behavior, so some other method needs to be devised to clean up or limit the number of generations. .It Sy sparse Enable checking for sparse (aka .Dq wholely ) files. One of the most common types of sparse files are those produced by .Xr db 3 . This option adds some additional processing overhead so it should only be enabled for targets likely to contain sparse files. .El .It Fl p Ar Set the path where the rdistd server is searched for on the target host. .It Fl P Ar Set the path to the remote shell command. The .I rsh-path may be a colon separated list of possible pathnames. In this case, the first component of the path to exist is used. e.g., .Pa "/usr/bin/ssh:/usr/bin/rsh" , .Pa /usr/bin/ssh . .It Fl t Ar timeout Set the timeout period (in seconds) for waiting for responses from the remote .Nm server. The default is 900 seconds. .It Fl V Print version information and exit. .El .Sh MESSAGE LOGGING .Nm uses a collection of predefined message .Em facilities that each contain a list of message .Sy types specifying which types of messages to send to that .Em facility . The local client (\fIrdist\fR) and the remote server (\fIrdistd\fR) each maintain their own copy of what types of messages to log to what facilities. .Pp The .Fl l .Em logopts option to .Nm tells .Nm what logging options to use locally. The .Fl L .Em logopts option to .Nm tells .Nm what logging options to pass to the remote .Em rdistd server. .Pp .Em logopts should be of the form .Bd -literal -offset indent \fIfacility\fB=\fItypes\fB:\fIfacility\fB=\fItypes... .Ed .Pp The valid facility names are: .Bl -tag -width Ds .It Sy stdout Messages to standard output. .It Sy file Log to a file. To specify the file name, use the format .Dq \fBfile=\fIfilename\fB=\fItypes\fR . e.g., .Dq \fBfile=\fI/tmp/rdist.log\fB=\fIall,debug\fR . .It Sy syslog Use the .Xr syslogd 8 facility. .It Sy notify Use the internal .Nm .Sy notify facility. This facility is used in conjunction with the .Sy notify keyword in a .Pa distfile to specify what messages are mailed to the .Sy notify address. .El .Pp .Em types should be a comma separated list of message types. Each message type specified enables that message level. This is unlike the .Xr syslog 3 system facility which uses an ascending order scheme. The following are the valid .Em types : .Bl -tag -width Ds .It Sy change Things that change. This includes files that are installed or updated in some way. .It Sy info General information. .It Sy notice General info about things that change. This includes things like making directories which are needed in order to install a specific target, but which are not explicitly specified in the .Pa distfile . .It Sy nerror Normal errors that are not fatal. .It Sy ferror Fatal errors. .It Sy warning Warnings about errors which are not as serious as .Sy nerror type messages. .It Sy debug Debugging information. .It Sy all All but debug messages. .El .Pp Here is a sample command line option: .Bd -literal -offset indent -l stdout=all:syslog=change,notice:file=/tmp/rdist.log=all .Ed .Pp This entry will set local message logging to have all but debug messages sent to standard output, change and notice messages will be sent to .Xr syslog 3 , and all messages will be written to the file .Pa /tmp/rdist.log . .Sh DISTFILES The .Pa distfile contains a sequence of entries that specify the files to be copied, the destination hosts, and what operations to perform to do the updating. Each entry has one of the following formats. .Bd -literal -offset indent `=' [ label: ] `\->' [ label: ] `::' .Ed .Pp The first format is used for defining variables. The second format is used for distributing files to other hosts. The third format is used for making lists of files that have been changed since some given date. The .Em source list specifies a list of files and/or directories on the local host which are to be used as the master copy for distribution. The .Em destination list is the list of hosts to which these files are to be copied. Each file in the source list is added to a list of changes if the file is out of date on the host which is being updated (second format) or the file is newer than the time stamp file (third format). .Pp Labels are optional. They are used to identify a command for partial updates. .Pp Newlines, tabs, and blanks are only used as separators and are otherwise ignored. Comments begin with .Sq # and end with a newline. .Pp Variables to be expanded begin with .Sq $ followed by one character or a name enclosed in curly braces (see the examples at the end). .Pp The source and destination lists have the following format: .Bd -literal -offset indent .Ed or .Bd -literal -compact -offset indent `(' `)' .Ed .Pp These simple lists can be modified by using one level of set addition, subtraction, or intersection like this: .Bd -literal -offset indent list '-' list .Ed or .Bd -literal -compact -offset indent list '+' list .Ed or .Bd -literal -compact -offset indent list '&' list .Ed .Pp If additional modifications are needed (e.g., .Do all servers and client machines except for the OSF/1 machines .Dc ) then the list will have to be explicitly constructed in steps using .Dq temporary variables. .Pp The shell meta-characters `[', `]', `{', `}', `*', and `?' are recognized and expanded (on the local host only) in the same way as .Xr csh 1 . They can be escaped with a backslash. The `~' character is also expanded in the same way as .Xr csh 1 but is expanded separately on the local and destination hosts. When the .Fl o Ns Ar whole option is used with a file name that begins with `~', everything except the home directory is appended to the destination name. File names which do not begin with `/' or `~' use the destination user's home directory as the root directory for the rest of the file name. .Pp The command list consists of zero or more commands of the following format. .Bl -column "except_pat" "" "opt_dest_name" ";" -offset indent .It `install' Ta Ta opt_dest_name Ta `;' .It `notify' Ta Ta "" Ta `;' .It `except' Ta Ta "" Ta `;' .It `except_pat' Ta Ta "" Ta `;' .It `special' Ta Ta string Ta `;' .It `cmdspecial' Ta Ta string Ta `;' .El .Pp The .Em install command is used to copy out of date files and/or directories. Each source file is copied to each host in the destination list. Directories are recursively copied in the same way. .Em opt_dest_name is an optional parameter to rename files. If no .Em install command appears in the command list or the destination name is not specified, the source file name is used. Directories in the path name will be created if they do not exist on the remote host. The .Fl o Ns Ar distopts option as specified above has the same semantics as on the command line except .Ar distopts only apply to the files in the source list. The login name used on the destination host is the same as the local host unless the destination name is of the format .Dq login@host . .Pp The .Em notify command is used to mail the list of files updated (and any errors that may have occurred) to the listed names. If no `@' appears in the name, the destination host is appended to the name (e.g., name1@host, name2@host, ...). .Pp The .Em except command is used to update all of the files in the source list .Sy except for the files listed in .Em name list . This is usually used to copy everything in a directory except certain files. .Pp The .Em except_pat command is like the .Em except command except that .Em pattern list is a list of regular expressions (see .Xr ed 1 for details). If one of the patterns matches some string within a file name, that file will be ignored. Note that since `\e' is a quote character, it must be doubled to become part of the regular expression. Variables are expanded in .Em pattern list but not shell file pattern matching characters. To include a `$', it must be escaped with `\e'. .br .Pp The .Em special command is used to specify .Xr sh 1 commands that are to be executed on the remote host after the file in .Em name list is updated or installed. If the .Em name list is omitted then the shell commands will be executed for every file updated or installed. .Em string starts and ends with `"' and can cross multiple lines in .Pa distfile . Multiple commands to the shell should be separated by `;'. Commands are executed in the user's home directory on the host being updated. The .Em special command can be used to rebuild private databases, etc. after a program has been updated. The following environment variables are set for each .Em special command: .Bl -tag -width "BASEFILE" .It Ev FILE The full pathname of the local file that was just updated. .It Ev REMFILE The full pathname of the remote file that was just updated. .It BASEFILE The basename of the remote file that was just updated. .El .Pp The .Em cmdspecial command is similar to the .Em special command, except it is executed only when the entire command is completed instead of after each file is updated. The list of files is placed in the .Ev FILES environment variable. Each file name in .Ev FILES is separated by a `:' (colon). .Pp If a hostname ends in a `+' (plus sign), then the plus is stripped off and NFS checks are disabled. This is equivalent to disabling the .Fl o Ns Ar chknfs option just for this one host. .Pp The following is a small example. .Bd -literal -offset indent HOSTS = ( matisse root@arpa) FILES = ( /bin /lib /usr/bin /usr/games /usr/include/{*.h,{stand,sys,vax*,pascal,machine}/*.h} /usr/lib /usr/man/man? /usr/ucb /usr/local/rdist ) EXLIB = ( Mail.rc aliases aliases.db crontab dshrc sendmail.cf sendmail.hf sendmail.st uucp vfont ) ${FILES} -> ${HOSTS} install -oremove,chknfs ; except /usr/lib/${EXLIB} ; except /usr/games/lib ; special /usr/lib/sendmail "/usr/lib/sendmail -bi" ; srcs: /usr/src/bin -> arpa except_pat ( \e\e.o\e$ /SCCS\e$ ) ; IMAGEN = (ips dviimp catdvi) imagen: /usr/local/${IMAGEN} -> arpa install /usr/local/lib ; notify ralph ; ${FILES} :: stamp.cory notify root@cory ; .Ed .Sh ENVIRONMENT .Bl -tag -width "TMPDIR" .It TMPDIR Name of temporary directory to use. Default is .Pa /tmp . .It RSH Name of the default remote shell program to use. Default is .Xr ssh 1 . .El .Sh FILES .Bl -tag -width "$TMPDIR/rdist*" -compact .It distfile input command file .It $TMPDIR/rdist* temporary file for update lists .El .Sh SEE ALSO .Xr csh 1 , .Xr rsh 1 , .Xr sh 1 , .Xr ssh 1 , .Xr stat 2 , .Xr rcmdsh 3 .Sh NOTES If the basename of a file (the last component in the pathname) is ".", then .Nm assumes the remote (destination) name is a directory. i.e., .Pa /tmp/ . means that .Pa /tmp should be a directory on the remote host. .Pp The following options are still recognized for backwards compatibility: .Pp .Bd -filled -offset indent .Fl v .Fl N .Fl O .Fl q .Fl b .Fl r .Fl R .Fl s .Fl w .Fl y .Fl h .Fl i .Fl x .Ed .Sh BUGS Source files must reside on the local host where rdist is executed. .Pp Variable expansion only works for name lists; there should be a general macro facility. .Pp .Nm aborts on files which have a negative mtime (before Jan 1, 1970). .Pp If a hardlinked file is listed more than once in the same target, then .Nm will report missing links. Only one instance of a link should be listed in each target. .Pp The .Sy defowner , .Sy defgroup , and .Sy updateperm options are extensions to the 6.1.0 protocol and will not work with earlier versions of rdist 6.