Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/trunk]: src/usr.sbin/sup/source New sentence, new line. Remove empty EXA...
details: https://anonhg.NetBSD.org/src/rev/aba02fe11325
branches: trunk
changeset: 769756:aba02fe11325
user: wiz <wiz%NetBSD.org@localhost>
date: Wed Sep 21 20:12:11 2011 +0000
description:
New sentence, new line. Remove empty EXAMPLE section.
diffstat:
usr.sbin/sup/source/sup.1 | 171 +++++++++++++++++++++++++++------------------
1 files changed, 104 insertions(+), 67 deletions(-)
diffs (truncated from 409 to 300 lines):
diff -r d123ae48b682 -r aba02fe11325 usr.sbin/sup/source/sup.1
--- a/usr.sbin/sup/source/sup.1 Wed Sep 21 19:34:54 2011 +0000
+++ b/usr.sbin/sup/source/sup.1 Wed Sep 21 20:12:11 2011 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: sup.1,v 1.19 2011/09/21 19:34:54 christos Exp $
+.\" $NetBSD: sup.1,v 1.20 2011/09/21 20:12:11 wiz Exp $
.\"
.\" Copyright (c) 1992 Carnegie Mellon University
.\" All Rights Reserved.
@@ -54,7 +54,8 @@
.SH "DESCRIPTION"
.I Sup
is a program used for upgrading collections of files from other machines
-to your machine. You execute
+to your machine.
+You execute
.IR sup ,
the
.I client
@@ -66,22 +67,28 @@
to determine which files of the collection need to be upgraded on
your machine.
-Sup collections can have multiple releases. One use for such releases is
-to provide different versions of the same files. At CMU, for example,
+Sup collections can have multiple releases.
+One use for such releases is
+to provide different versions of the same files.
+At CMU, for example,
system binaries have alpha, beta and default release corresponding to
-different staging levels of the software. We also use release names
+different staging levels of the software.
+We also use release names
default and minimal to provide complete releases or subset releases.
In both of these cases, it only makes sense to sup one release of the
-collections. Releases have also been used in private or external sups to
+collections.
+Releases have also been used in private or external sups to
provide subsets of collections where it makes sense to pick up several
-of the releases. For example the Mach 3.0 kernel sources has a default
+of the releases.
+For example the Mach 3.0 kernel sources has a default
release of machine independent sources and separate releases of
machine dependent sources for each supported platform.
In performing an upgrade, the file server constructs a list of
-files included in the specified release of the collection. The list is sent to your machine,
-which determines which files are needed. Those files are then sent
-from the file server.
+files included in the specified release of the collection.
+The list is sent to your machine,
+which determines which files are needed.
+Those files are then sent from the file server.
It will be most useful to run
.I sup
as a daemon each night so you will continually have the latest version of the
@@ -89,15 +96,17 @@
The only required argument to
.I sup
-is the name of a supfile. It must either be given explicitly on the command
-line, or the
+is the name of a supfile.
+It must either be given explicitly on the command line, or the
.B -s
-flag must be specified. If the
+flag must be specified.
+If the
.B -s
flag is given, the system supfile will be used and a supfile command argument
-should not be specified. The list of collections is optional and if specified
-will be the only collections upgraded. The following flags affect all
-collections specified:
+should not be specified.
+The list of collections is optional and if specified
+will be the only collections upgraded.
+The following flags affect all collections specified:
.TP
.B -s
As described above.
@@ -131,15 +140,18 @@
.PP
The remaining flags affect all collections unless an explicit list
-of collections are given with the flags. Multiple flags may be
-specified together that affect the same collections. For the sake
+of collections are given with the flags.
+Multiple flags may be
+specified together that affect the same collections.
+For the sake
of convenience, any flags that always affect all collections can be
-specified with flags that affect only some collections. For
-example,
+specified with flags that affect only some collections.
+For example,
.B sup -sde=coll1,coll2
would perform a system upgrade,
and the first two collections would allow both file deletions and
-command executions. Note that this is not the same command as
+command executions.
+Note that this is not the same command as
.B sup -sde=coll1 coll2,
which would perform a system upgrade of
just the coll2 collection and would ignore the flags given for the
@@ -148,10 +160,12 @@
.B -a
All files in the collection will be copied from
the repository, regardless of their status on the
-current machine. Because of this, it is a very
+current machine.
+Because of this, it is a very
expensive operation and should only be done for
small collections if data corruption is suspected
-and been confirmed. In most cases, the
+and been confirmed.
+In most cases, the
.B -o
flag should be sufficient.
.TP
@@ -163,7 +177,8 @@
supfile
option is specified, the contents of regular files
on the local system will be saved before they are
-overwritten with new data. The file collection maintainer
+overwritten with new data.
+The file collection maintainer
can designate specific files to be
worthy of backing up whenever they are upgraded.
However, such
@@ -204,7 +219,8 @@
.B canonicalize
supfile option, canonicalize all pathnames upon reception to make sure
local changes from directories to symlinks and vice versa have not happened
-behind sup's back, and attempt to repair them. This option is expensive.
+behind sup's back, and attempt to repair them.
+This option is expensive.
.TP
.TP
.B -d
@@ -226,12 +242,12 @@
.TP
.B -e
Sup will execute commands sent from the repository
-that should be run when a file is upgraded. If
-the
+that should be run when a file is upgraded.
+If the
.B -e
flag is omitted, Sup will print a message
-that specifies the command to execute. This may
-also be specified in a supfile with the
+that specifies the command to execute.
+This may also be specified in a supfile with the
.B execute
option.
.TP
@@ -247,14 +263,15 @@
.B -f
A
.I list-only
-upgrade will be performed. Messages
-will be printed that indicate what would happen if
+upgrade will be performed.
+Messages will be printed that indicate what would happen if
an actual upgrade were done.
.TP
.B -k
.I Sup
will check the modification times of
-files on the local disk before updating them. Only files which are
+files on the local disk before updating them.
+Only files which are
newer on the repository than on the local disk will be updated;
files that are newer on the local disk will be kept as they are.
This may also be specified in a supfile with the
@@ -274,10 +291,12 @@
Normally,
.I sup
will not upgrade a collection if the
-repository is on the same machine. This allows
+repository is on the same machine.
+This allows
users to run upgrades on all machines without
having to make special checks for the repository
-machine. If the
+machine.
+If the
.B -l
flag is specified, collections
will be upgraded even if the repository is local.
@@ -307,10 +326,12 @@
.I Sup
will normally only upgrade files that have
changed on the repository since the last time an
-upgrade was performed. That is, if the file in the
+upgrade was performed.
+That is, if the file in the
repository is newer than the date stored in the
.I when
-file on the client. The
+file on the client.
+The
.B -o
flag, or the
.B old
@@ -353,7 +374,8 @@
Normally,
.I sup
will only print messages if there
-are problems. This flag causes
+are problems.
+This flag causes
.I sup
to also print
messages during normal progress showing what
@@ -410,7 +432,8 @@
This file contains a list of files and directories, one per line, that
have been upgraded by
.I sup
-in the past. This information is used when the
+in the past.
+This information is used when the
.B delete
option, or the
.B -d
@@ -431,10 +454,11 @@
.TP
.BI release= releasename
If a collection contains multiple releases, you need to specify which
-release you want. You can only specify one release per line, so
+release you want.
+You can only specify one release per line, so
if you want multiple releases from the same collections, you will need
-to specify the collection more than once. In this case, you should use
-the
+to specify the collection more than once.
+In this case, you should use the
.I use-rel-suffix
option in the supfile
to keep the last and when files for the two releases separate.
@@ -557,7 +581,8 @@
.I last
and
.I when
-files. This is necessary whenever you are supping more than one
+files.
+This is necessary whenever you are supping more than one
release in the same collection.
.DT
.PP
@@ -610,10 +635,11 @@
The name
.B LOCAL
can be used to grant access to all hosts on the local
-network. The host name may be a numeric network address
-or a network name. If a crypt appears on the same line as
-the host name, that crypt will be used for that host. Otherwise,
-the crypt appearing in the
+network.
+The host name may be a numeric network address or a network name.
+If a crypt appears on the same line as
+the host name, that crypt will be used for that host.
+Otherwise, the crypt appearing in the
.I crypt
file, if any will be used.
.TP
@@ -634,8 +660,8 @@
file collection, in a format described below.
.TP
.B releases
-This file describes any releases that the collection may have. Each
-line starts with the release name and then may specify any of the following
+This file describes any releases that the collection may have.
+Each line starts with the release name and then may specify any of the following
files:
.I prefix=\*[Lt]dirname\*[Gt]
to use a different parent directory for the files in this release.
@@ -647,8 +673,10 @@
.I host=\*[Lt]hostfile\*[Gt]
to allow different host restrictions for this release.
.I next=\*[Lt]release\*[Gt]
-used to chain releases together. This has the effect of making one release
-be a combination of several other releases. If the same file appears in
+used to chain releases together.
+This has the effect of making one release
+be a combination of several other releases.
+If the same file appears in
more than one chained release, the first one found will be used.
If these files are not specified for a release the default names:
prefix,list,scan and host will be used.
@@ -657,15 +685,17 @@
This file, created by
.IR supscan ,
is the list of filenames that correspond to the instructions in the
-list file. The scan file is only used for frequently updated file
-collections; it makes the file server run much faster. See
+list file.
+The scan file is only used for frequently updated file
+collections; it makes the file server run much faster.
+See
Home |
Main Index |
Thread Index |
Old Index