BSD 4_3_Net_2 release
[unix-history] / usr / src / usr.bin / rdist / rdist.1
index 071619f..42e200d 100644 (file)
@@ -1,23 +1,37 @@
 .\" Copyright (c) 1985, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1985, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" 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 ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. 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.
 .\"
 .\"
-.\"     @(#)rdist.1    6.9 (Berkeley) 7/24/90
+.\" 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.
 .\"
 .\"
-.Dd July 24, 1990
+.\"    @(#)rdist.1     6.11 (Berkeley) 7/27/91
+.\"
+.Dd July 27, 1991
 .Dt RDIST 1
 .Os BSD 4.3
 .Sh NAME
 .Dt RDIST 1
 .Os BSD 4.3
 .Sh NAME
 .Op Fl d Ar var=value
 .Op Fl m host
 .Op Ar name ...
 .Op Fl d Ar var=value
 .Op Fl m host
 .Op Ar name ...
-.Pp
 .Nm rdist
 .Op Fl nqbRhivwy
 .Fl c
 .Ar name ...
 .Nm rdist
 .Op Fl nqbRhivwy
 .Fl c
 .Ar name ...
-.Cx Op login@
-.Ar host
-.Op :dest
-.Cx
+.Oo login@ Oc Ns Ar host Ns Op :dest
 .Sh DESCRIPTION
 .Nm Rdist
 is a program to maintain identical copies of files over multiple hosts.
 .Sh DESCRIPTION
 .Nm Rdist
 is a program to maintain identical copies of files over multiple hosts.
@@ -51,20 +61,17 @@ to direct the updating of files and/or directories.
 .Pp
 Options specific to the first SYNOPSIS form:
 .Pp
 .Pp
 Options specific to the first SYNOPSIS form:
 .Pp
-.Tw Fl
-.Tp Fl 
+.Bl -tag -width indent
+.It Fl
 If
 .Ar distfile
 is
 .Sq Fl ,
 the standard input is used.
 If
 .Ar distfile
 is
 .Sq Fl ,
 the standard input is used.
-.Tp Cx Fl f
-.Cx \&\ \&
-.Ar distfile
-.Cx
+.It Fl f Ar distfile
 Use the specified
 .Ar distfile.
 Use the specified
 .Ar distfile.
-.Tp
+.El
 .Pp
 If either the
 .Fl f
 .Pp
 If either the
 .Fl f
@@ -87,7 +94,8 @@ using specific commands.
 .Pp
 Options specific to the second SYNOPSIS form:
 .Pp
 .Pp
 Options specific to the second SYNOPSIS form:
 .Pp
-.Tp Fl c
+.Bl -tag -width Fl c
+.It Fl c
 Forces
 .Nm rdist
 to interpret the remaining arguments as a small
 Forces
 .Nm rdist
 to interpret the remaining arguments as a small
@@ -95,25 +103,25 @@ to interpret the remaining arguments as a small
 .Pp
 The equivalent distfile is as follows.
 .Pp
 .Pp
 The equivalent distfile is as follows.
 .Pp
-.Df I
+.Bd -filled -offset indent -compact
 .Pq Ar name ...
 .Li ->
 .Op Ar login@
 .Ar host
 .Pq Ar name ...
 .Li ->
 .Op Ar login@
 .Ar host
-.Df I
+.Bd -filled -offset indent -compact
 .Li install
 .Op Ar dest ;
 .Li install
 .Op Ar dest ;
-.De
-.De
-.Tp
+.Ed
+.Ed
+.El
 .Pp
 Options common to both forms:
 .Pp
 .Pp
 Options common to both forms:
 .Pp
-.Tw Ic
-.Tp Cx Fl d
-.Cx \&\ \&
-.Ar var=value
-.Cx
+.Bl -tag -width Ic
+.It Fl b
+Binary comparison. Perform a binary comparison and update files if they differ
+rather than comparing dates and sizes.
+.It Fl d Ar var=value
 Define
 .Ar var
 to have
 Define
 .Ar var
 to have
@@ -125,47 +133,44 @@ option is used to define or override variable definitions in the
 .Ar Value
 can be the empty string, one name, or a list of names surrounded by
 parentheses and separated by tabs and/or spaces.
 .Ar Value
 can be the empty string, one name, or a list of names surrounded by
 parentheses and separated by tabs and/or spaces.
-.Tp Cx Fl m
-.Cx \&\ \&
-.Ar host
-.Cx
+.It Fl h
+Follow symbolic links. Copy the file that the link points to rather than the
+link itself.
+.It Fl i
+Ignore unresolved links.
+.Nm Rdist
+will normally try to maintain the link structure of files being transfered
+and warn the user if all the links cannot be found.
+.It Fl m Ar host
 Limit which machines are to be updated. Multiple
 .Fl m
 arguments can be given to limit updates to a subset of the hosts listed the
 .Ar distfile  .
 Limit which machines are to be updated. Multiple
 .Fl m
 arguments can be given to limit updates to a subset of the hosts listed the
 .Ar distfile  .
-.Tp Fl n
+.It Fl n
 Print the commands without executing them. This option is
 useful for debugging
 .Ar distfile  .
 Print the commands without executing them. This option is
 useful for debugging
 .Ar distfile  .
-.Tp Fl q
+.It Fl q
 Quiet mode. Files that are being modified are normally
 printed on standard output. The
 .Fl q
 option suppresses this.
 Quiet mode. Files that are being modified are normally
 printed on standard output. The
 .Fl q
 option suppresses this.
-.Tp Fl R
+.It Fl R
 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 truely identical copies of directories.
 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 truely identical copies of directories.
-.Tp Fl h
-Follow symbolic links. Copy the file that the link points to rather than the
-link itself.
-.Tp Fl i
-Ignore unresolved links.
-.Nm Rdist
-will normally try to maintain the link structure of files being transfered
-and warn the user if all the links cannot be found.
-.Tp Fl v
+.It Fl v
 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 any mail sent.
 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 any mail sent.
-.Tp Fl w
+.It Fl w
 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,
 renaming a list of files such as ( dir1/f1 dir2/f2 ) to dir3 would create
 files dir3/dir1/f1 and dir3/dir2/f2 instead of dir3/f1 and dir3/f2.
 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,
 renaming a list of files such as ( dir1/f1 dir2/f2 ) to dir3 would create
 files dir3/dir1/f1 and dir3/dir2/f2 instead of dir3/f1 and dir3/f2.
-.Tp Fl y
+.It Fl y
 Younger mode. Files are normally updated if their
 .Ar mtime
 and
 Younger mode. Files are normally updated if their
 .Ar mtime
 and
@@ -180,21 +185,18 @@ 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.
 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.
-.Tp Fl b
-Binary comparison. Perform a binary comparison and update files if they differ
-rather than comparing dates and sizes.
-.Tp
+.El
 .Pp
 .Ar 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.
 .Pp
 .Pp
 .Ar 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.
 .Pp
-.Ds I
+.Bd -literal -offset indent -compact
 <variable name> `=' <name list>
 [label:]<source list> `\->' <destination list> <command list>
 [label:]<source list> `::' <time_stamp file> <command list>
 <variable name> `=' <name list>
 [label:]<source list> `\->' <destination list> <command list>
 [label:]<source list> `::' <time_stamp file> <command list>
-.De
+.Ed
 .Pp
 The first format is used for defining variables.
 The second format is used for distributing files to other hosts.
 .Pp
 The first format is used for defining variables.
 The second format is used for distributing files to other hosts.
@@ -221,14 +223,13 @@ Variables to be expanded begin with `$' 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:
 a name enclosed in curly braces (see the examples at the end).
 .Pp
 The source and destination lists have the following format:
-.Pp
-.Ds I
+.Bd -literal -offset indent
 <name>
 <name>
-.De
+.Ed
 or
 or
-.Ds I
+.Bd -literal -offset indent -compact
 `(' <zero or more names separated by white-space> `)'
 `(' <zero or more names separated by white-space> `)'
-.De
+.Ed
 .Pp
 The shell meta-characters `[', `]', `{', `}', `*', and `?'
 are recognized and expanded (on the local host only) in the same way as
 .Pp
 The shell meta-characters `[', `]', `{', `}', `*', and `?'
 are recognized and expanded (on the local host only) in the same way as
@@ -246,15 +247,15 @@ 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.
 .Pp
 The command list consists of zero or more commands of the following
 format.
-.Ds I
-.Cw except_patx pattern\ listx
-.Cl `install'  <options>       opt_dest_name `;'
-.Cl `notify'   <name list>     `;'
-.Cl `except'   <name list>     `;'
-.Cl `except_pat'       <pattern list>  `;'
-.Cl `special'  <name list>     string `;'
-.Cw
-.De
+.Bd -ragged -offset indent -compact
+.Bl -column except_patx pattern\ listx
+.It `install'  <options>       opt_dest_name `;'
+.It `notify'   <name list>     `;'
+.It `except'   <name list>     `;'
+.It `except_pat'       <pattern list>  `;'
+.It `special'  <name list>     string `;'
+.El
+.Ed
 .Pp
 The
 .Ic install
 .Pp
 The
 .Ic install
@@ -343,53 +344,52 @@ command can be used to rebuild private databases, etc.
 after a program has been updated.
 .Pp
 The following is a small example:
 after a program has been updated.
 .Pp
 The following is a small example:
-.Pp
-.Ds I
+.Bd -literal -offset indent
 HOSTS = ( matisse root@arpa )
 HOSTS = ( matisse root@arpa )
-.sp
+
 FILES = ( /bin /lib /usr/bin /usr/games
 \t/usr/include/{*.h,{stand,sys,vax*,pascal,machine}/*.h}
 \t/usr/lib /usr/man/man? /usr/ucb /usr/local/rdist )
 FILES = ( /bin /lib /usr/bin /usr/games
 \t/usr/include/{*.h,{stand,sys,vax*,pascal,machine}/*.h}
 \t/usr/lib /usr/man/man? /usr/ucb /usr/local/rdist )
-.sp
+
 EXLIB = ( Mail.rc aliases aliases.dir aliases.pag crontab dshrc
 \tsendmail.cf sendmail.fc sendmail.hf sendmail.st uucp vfont )
 EXLIB = ( Mail.rc aliases aliases.dir aliases.pag crontab dshrc
 \tsendmail.cf sendmail.fc sendmail.hf sendmail.st uucp vfont )
-.sp
+
 ${FILES} -> ${HOSTS}
 \tinstall -R ;
 \texcept /usr/lib/${EXLIB} ;
 \texcept /usr/games/lib ;
 \tspecial /usr/lib/sendmail "/usr/lib/sendmail -bz" ;
 ${FILES} -> ${HOSTS}
 \tinstall -R ;
 \texcept /usr/lib/${EXLIB} ;
 \texcept /usr/games/lib ;
 \tspecial /usr/lib/sendmail "/usr/lib/sendmail -bz" ;
-.sp
+
 srcs:
 /usr/src/bin -> arpa
 \texcept_pat ( \e\e.o\e$ /SCCS\e$ ) ;
 srcs:
 /usr/src/bin -> arpa
 \texcept_pat ( \e\e.o\e$ /SCCS\e$ ) ;
-.sp
+
 IMAGEN = (ips dviimp catdvi)
 IMAGEN = (ips dviimp catdvi)
-.sp
+
 imagen:
 /usr/local/${IMAGEN} -> arpa
 \tinstall /usr/local/lib ;
 \tnotify ralph ;
 imagen:
 /usr/local/${IMAGEN} -> arpa
 \tinstall /usr/local/lib ;
 \tnotify ralph ;
-.sp
+
 ${FILES} :: stamp.cory
 \tnotify root@cory ;
 ${FILES} :: stamp.cory
 \tnotify root@cory ;
-.De
+.Ed
 .Sh FILES
 .Sh FILES
-.Dw /tmp/rdist*
-.Di L
-.Dp Pa distfile
+.Bl -tag -width /tmp/rdist* -compact
+.It Pa distfile
 input command file
 input command file
-.Dp Pa /tmp/rdist*
+.It Pa /tmp/rdist*
 temporary file for update lists
 temporary file for update lists
-.Dp
+.El
 .Sh SEE ALSO
 .Xr sh 1 ,
 .Xr csh 1 ,
 .Xr stat 2
 .Sh HISTORY
 The
 .Sh SEE ALSO
 .Xr sh 1 ,
 .Xr csh 1 ,
 .Xr stat 2
 .Sh HISTORY
 The
-.Nm
-command appeared in 4.3 BSD.
+.Nm rdist
+command appeared in
+.Bx 4.3 .
 .Sh DIAGNOSTICS
 A complaint about mismatch of rdist version numbers may really stem
 from some problem with starting your shell, e.g., you are in too many groups.
 .Sh DIAGNOSTICS
 A complaint about mismatch of rdist version numbers may really stem
 from some problem with starting your shell, e.g., you are in too many groups.