diff options
| author | Aaron Campbell <aaron@cvs.openbsd.org> | 2000-03-19 17:57:20 +0000 |
|---|---|---|
| committer | Aaron Campbell <aaron@cvs.openbsd.org> | 2000-03-19 17:57:20 +0000 |
| commit | 480390dc59325200978ed49a1b26f00a94c91baa (patch) | |
| tree | 062c09ac43a080a68cd77af35c77fcac0d938f46 | |
| parent | fb660b4c0cea9ae33d3d4dac0984c52ed7b6eeb0 (diff) | |
Remove hard sentence breaks. Add $OpenBSD$ tags where appropriate. Some other
cleanup along the way.
98 files changed, 2275 insertions, 1461 deletions
diff --git a/usr.sbin/ac/ac.8 b/usr.sbin/ac/ac.8 index daaf9cc74b2..0df6c125e55 100644 --- a/usr.sbin/ac/ac.8 +++ b/usr.sbin/ac/ac.8 @@ -1,4 +1,3 @@ -.\" .\" Copyright (c) 1994 Simon J. Gerraty .\" Copyright (c) 1994 Christopher G. Demetriou .\" All rights reserved. @@ -28,7 +27,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: ac.8,v 1.6 1999/09/23 04:12:10 alex Exp $ +.\" $Id: ac.8,v 1.7 2000/03/19 17:56:58 aaron Exp $ .\" .Dd March 15, 1994 .Dt AC 8 @@ -71,7 +70,8 @@ Display the connect times in 24 hour chunks. .It Fl p Print individual users' totals. .It Fl t Ar tty -Only do accounting logins on certain ttys. The +Only do accounting logins on certain ttys. +The .Ar tty specification can start with .Ql \&! @@ -107,7 +107,8 @@ by which rename and rotate the .Pa wtmp files, keeping a week's worth of data on -hand. No login or connect time accounting is performed if +hand. +No login or connect time accounting is performed if .Pa /var/log/wtmp does not exist. .Pp diff --git a/usr.sbin/accton/accton.8 b/usr.sbin/accton/accton.8 index e8c20d7ff94..bc635f9a546 100644 --- a/usr.sbin/accton/accton.8 +++ b/usr.sbin/accton/accton.8 @@ -24,7 +24,7 @@ .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: accton.8,v 1.4 1999/10/07 22:28:04 aaron Exp $ +.\" $Id: accton.8,v 1.5 2000/03/19 17:56:59 aaron Exp $ .\" .Dd October 18, 1993 .Dt ACCTON 8 @@ -40,8 +40,8 @@ With an argument naming an existing .Ar file , .Nm causes system accounting information for every process executed -to be placed at the end of the file. If no argument is given, -accounting is turned off. +to be placed at the end of the file. +If no argument is given, accounting is turned off. .Sh FILES .Bl -tag -width /var/account/acct .It Pa /var/account/acct diff --git a/usr.sbin/adduser/adduser.8 b/usr.sbin/adduser/adduser.8 index 4dbaf996514..7338d9a31df 100644 --- a/usr.sbin/adduser/adduser.8 +++ b/usr.sbin/adduser/adduser.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: adduser.8,v 1.14 1999/10/07 06:24:11 ericj Exp $ +.\" $OpenBSD: adduser.8,v 1.15 2000/03/19 17:57:00 aaron Exp $ +.\" .\" Copyright (c) 1995-1996 Wolfram Schneider <wosch@FreeBSD.org>. Berlin. .\" All rights reserved. .\" @@ -64,15 +65,18 @@ .Sh DESCRIPTION The .Nm adduser -program adds new users to the system. The +program adds new users to the system. +The .Nm rmuser -program removes users from the system. When not passed any arguments, both +program removes users from the system. +When not passed any arguments, both utilities operate in interactive mode and prompt for any required information. .Pp .Nm adduser first performs consistency checks on the password, group, and shell databases. This includes finding any duplicate user or group names, illegal shells, or -shells that aren't executable. Once these tests are passed, +shells that aren't executable. +Once these tests are passed, .Nm performs the following operations for each new user: .Bl -enum -offset indent @@ -103,7 +107,8 @@ entries or jobs belonging to the user. .It Removes the user from the password database and all groups in the group -database. If a group becomes empty and its name is the same as the username, +database. +If a group becomes empty and its name is the same as the username, the group is removed (this complements .Nm adduser Ns No 's unique per-user groups). @@ -123,8 +128,8 @@ politely refuses to remove users whose UID is 0 (typically root). .Sh RESTRICTIONS .Bl -tag -width Ds .It Sy username -Login names should contain only lowercase characters or digits. They should be -no longer than 8 characters (see BUGS section of +Login names should contain only lowercase characters or digits. +They should be no longer than 8 characters (see BUGS section of .Xr setlogin 2 ) . .\" The reasons for this limit are "Historical". .\" Given that people have traditionally wanted to break this @@ -138,7 +143,8 @@ If you need a longer login name for e-mail addresses, you can define an alias in .Pa /etc/aliases . .It Sy fullname -This should contain the user's first name and surname. The +This should contain the user's first name and surname. +The .Ql \&: is not permitted. .It Sy shell @@ -151,11 +157,13 @@ and are permitted. .It Sy uid_start This value is the start of the range where free UID values are -searched for. This value must be less than the value of uid_end. +searched for. +This value must be less than the value of uid_end. The default value is 1000 or as configured in the configuration file. .It Sy uid_end This value is the end of the range where free UID values are -searched for. This value must be more than the value of uid_start. +searched for. +This value must be more than the value of uid_start. The default value is 32000 or as configured in the configuration file. .It Sy gid/login group This value is generated automatically, but can be specified at the @@ -221,7 +229,8 @@ proceeding with the normal interactive adduser procedure. .It Fl dotdir Ar directory Copy files from .Ar directory -into the HOME directory of new users. Files named in the fashion of +into the HOME directory of new users. +Files named in the fashion of .Dq Pa dot.foo will be renamed to .Dq Pa .foo . @@ -236,7 +245,8 @@ Encrypt local passwords using of encryption as described in .Xr passwd.conf 5 . .It Fl group Ar login_group -Specify the default login group. A value of +Specify the default login group. +A value of .Ar USER means that the username is to be used as the login group. .It Xo @@ -270,8 +280,8 @@ Use UIDs from up when automatically generating UIDs. .It Fl unencrypted Causes the program to assume that the password given in batch mode is -unencrypted. The password will be encrypted before it's added to the -password file. +unencrypted. +The password will be encrypted before it's added to the password file. Use of this option will leave username and cleartext password displayable for any user. .It Fl verbose Ns No , Fl v @@ -327,8 +337,8 @@ Create user .Dq vehlefanz in login group .Dq guest . -Start the free -UID search at 5000. No other groups, no realname, no password. +Start the free UID search at 5000. +No other groups, no realname, no password. Do not send a welcome message. .Sh FILES .Bl -tag -width /etc/adduser.messageX -compact diff --git a/usr.sbin/adduser/rmgroup.8 b/usr.sbin/adduser/rmgroup.8 index 53a64c09663..862a8df9d8d 100644 --- a/usr.sbin/adduser/rmgroup.8 +++ b/usr.sbin/adduser/rmgroup.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rmgroup.8,v 1.7 1999/11/13 22:13:42 ericj Exp $ +.\" $OpenBSD: rmgroup.8,v 1.8 2000/03/19 17:57:00 aaron Exp $ .\" .\" Copyright (c) 1996 Wolfram Schneider <wosch@FreeBSD.org>. Berlin. .\" All rights reserved. @@ -43,7 +43,8 @@ from group database. .Nm will not delete the system groups wheel, daemon, kmem, sys, tty, operator, bin, nogroup, nobody, -or groups with gid 0. Do not delete these groups. +or groups with gid 0. +Do not delete these groups. .Sh FILES .Bl -tag -width /etc/groupX -compact .It Pa /etc/group diff --git a/usr.sbin/afs/afsd/afsd.8 b/usr.sbin/afs/afsd/afsd.8 index df8b8c35f81..b25d13c617a 100644 --- a/usr.sbin/afs/afsd/afsd.8 +++ b/usr.sbin/afs/afsd/afsd.8 @@ -1,6 +1,6 @@ -.\" $OpenBSD: afsd.8,v 1.7 2000/03/05 00:28:57 aaron Exp $ +.\" $OpenBSD: afsd.8,v 1.8 2000/03/19 17:56:59 aaron Exp $ .\" -.Dd September 5, 1998 +.Dd September 5, 1998 .Dt AFSD 8 .Os .Sh NAME @@ -36,10 +36,12 @@ .Op Ar device .Sh DESCRIPTION .Nm -runs on AFS client machines. It is used to manage the file cache, fetch files +runs on AFS client machines. +It is used to manage the file cache, fetch files from AFS servers, handle callbacks and manage the authentication information -for users. In normal cases you will not need to run it by yourself. It is -automatically started when +for users. +In normal cases you will not need to run it by yourself. +It is automatically started when .Xr mount_xfs 8 is run. .Pp @@ -133,13 +135,16 @@ default cache directory .El .Pp It is highly recommended that the default cache directory be a separate -filesystem. When enough memory is available this could be a mfs to +file system. +When enough memory is available this could be a mfs to drastically improve performance. .Sh SEE ALSO .Xr mount_xfs 8 .Sh BUGS -This code is still in the experimental stage and some bugs are present. If +This code is still in the experimental stage and some bugs are present. +If .Nm happens to crash, it's recommended to restart it with the .Fl z -flag. Otherwise a corrupted cache can be reused. +flag. +Otherwise a corrupted cache can be reused. diff --git a/usr.sbin/amd/amd/amd.8 b/usr.sbin/amd/amd/amd.8 index 69a2c8596ca..b00f84dda76 100644 --- a/usr.sbin/amd/amd/amd.8 +++ b/usr.sbin/amd/amd/amd.8 @@ -36,7 +36,7 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)amd.8 5.10 (Berkeley) 4/19/94 -.\" $Id: amd.8,v 1.7 1999/07/02 20:11:47 aaron Exp $ +.\" $Id: amd.8,v 1.8 2000/03/19 17:57:00 aaron Exp $ .\" .Dd April 19, 1994 .Dt AMD 8 @@ -100,13 +100,14 @@ The default is Specify a .Ar duration , in seconds, that a looked up name remains -cached when not in use. The default is 5 minutes. +cached when not in use. +The default is 5 minutes. .It Fl d Ar domain -Specify the local domain name. If this option is not -given the domain name is determined from the hostname. +Specify the local domain name. +If this option is not given the domain name is determined from the hostname. .It Fl k Ar kernel-arch -Specifies the kernel architecture. This is used solely -to set the ${karch} selector. +Specifies the kernel architecture. +This is used solely to set the ${karch} selector. .It Fl l Ar logfile Specify a logfile in which to record mount and unmount events. If @@ -118,8 +119,8 @@ the log messages will be sent to the system log daemon by .It Fl n Normalize hostnames. The name referred to by ${rhost} is normalized relative to the -host database before being used. The effect is to translate -aliases into +host database before being used. +The effect is to translate aliases into .Dq official names. .It Fl p @@ -132,8 +133,8 @@ to standard output where it can be saved into a file. Restart existing mounts. .Nm amd will scan the mount file table to determine which filesystems -are currently mounted. Whenever one of these would have -been auto-mounted, +are currently mounted. +Whenever one of these would have been auto-mounted, .Nm amd .Em inherits it. @@ -148,7 +149,8 @@ The second values alters the retransmit counter. Useful defaults are supplied if either or both values are missing. .It Fl v -Version. Displays version and configuration information on standard error. +Version. +Displays version and configuration information on standard error. .It Fl w Ar interval Specify an .Ar interval , @@ -166,13 +168,15 @@ This option is ignored if .Tn NIS support is not available. .It Fl x Ar options -Specify run-time logging options. The options are a comma separated +Specify run-time logging options. +The options are a comma separated list chosen from: fatal, error, user, warn, info, map, stats, all. .It Fl D Ar option -Select from a variety of debug options. Prefixing an -option with the string +Select from a variety of debug options. +Prefixing an option with the string .Dq no -reverses the effect of that option. Options are cumulative. +reverses the effect of that option. +Options are cumulative. The most useful option is .Ar all . .El diff --git a/usr.sbin/amd/amq/amq.8 b/usr.sbin/amd/amq/amq.8 index fa4abe466b9..ac779318d85 100644 --- a/usr.sbin/amd/amq/amq.8 +++ b/usr.sbin/amd/amq/amq.8 @@ -36,7 +36,7 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)amq.8 8.3 (Berkeley) 4/18/94 -.\" $Id: amq.8,v 1.4 1999/08/26 14:35:41 millert Exp $ +.\" $Id: amq.8,v 1.5 2000/03/19 17:57:01 aaron Exp $ .\" .Dd March 16, 1991 .Dt AMQ 8 @@ -78,7 +78,8 @@ Request automounter to flush the internal caches. .It Fl h Ar hostname Query alternate host .Ar hostname . -By default the local host is used. In an +By default the local host is used. +In an .Tn HP-UX cluster, the root server is queried by default, since that is the system on which the automounter is normally run. @@ -90,14 +91,15 @@ which occurred while mounting. Request the automounter to provide system-wide mount statistics. .It Fl u Request the automounter to unmount the named filesystems -instead of providing information about them. Unmounts are requested, -not forced. They merely cause the mounted filesystem to timeout, +instead of providing information about them. +Unmounts are requested, not forced. +They merely cause the mounted filesystem to timeout, which will be picked up by .Nm amd Ns \'s main scheduler thus causing the normal timeout action to be taken. .It Fl v -Request the automounter to provide version information. This is a subset -of the information provided by +Request the automounter to provide version information. +This is a subset of the information provided by .Xr amd Ns \'s Fl v option. .\".It Fl M diff --git a/usr.sbin/apm/apm.8 b/usr.sbin/apm/apm.8 index e4ea299d0d5..4a259ea1a95 100644 --- a/usr.sbin/apm/apm.8 +++ b/usr.sbin/apm/apm.8 @@ -24,7 +24,7 @@ .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: apm.8,v 1.9 2000/03/05 00:28:57 aaron Exp $ +.\" $Id: apm.8,v 1.10 2000/03/19 17:57:01 aaron Exp $ .\" .Dd March 18, 1996 .Dt APM 8 @@ -69,10 +69,12 @@ Display the estimated battery lifetime (in percent). .It Fl m Display the estimated battery lifetime (in minutes). .It Fl b -Display the battery status. 0 means high, 1 means low, 2 means +Display the battery status. +0 means high, 1 means low, 2 means critical, 3 means charging, 4 means absent, and 255 means unknown. .It Fl a -Display the external charger (A/C status). 0 means disconnected, 1 +Display the external charger (A/C status). +0 means disconnected, 1 means connected, 2 means backup power source, and 255 means unknown. .It Fl v Request more verbose description of the displayed states. diff --git a/usr.sbin/apmd/apmd.8 b/usr.sbin/apmd/apmd.8 index 7064cbe5007..47c25bc2406 100644 --- a/usr.sbin/apmd/apmd.8 +++ b/usr.sbin/apmd/apmd.8 @@ -24,7 +24,7 @@ .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: apmd.8,v 1.10 1999/06/05 22:16:28 aaron Exp $ +.\" $Id: apmd.8,v 1.11 2000/03/19 17:57:01 aaron Exp $ .\" .Dd March 24, 1996 .Dt APMD 8 @@ -69,7 +69,8 @@ Suspends are announced with two high tones. .Nm periodically polls the APM driver for the current power state. If the battery charge level changes substantially or the external power -status changes, the new status is logged. The polling rate defaults to +status changes, the new status is logged. +The polling rate defaults to once per 10 minutes, but may be specified using the .Fl t command-line flag. @@ -108,7 +109,8 @@ flag is specified, .Nm does not disable power status messages issued by the .Tn APM -driver. In normal operation these status messages are disabled as they are +driver. +In normal operation these status messages are disabled as they are the same as the information collected by this daemon and reported via syslog. .Pp The @@ -117,16 +119,19 @@ and .Fl p flags are used to re-enable .Tn APM -driver power status messages. In both cases +driver power status messages. +In both cases .Nm exits immediately after setting the desired option. .Fl e unconditionally enables power status messages. .Fl p causes power status messages to be displayed only when the -battery life expectancy changes. This minimized message output +battery life expectancy changes. +This minimized message output for those devices that are constantly updating the estimated time -remaining based upon current processor load. However, in no case +remaining based upon current processor load. +However, in no case will power status messages be displayed until the battery life goes below the percentage in the .Xr sysctl 8 @@ -155,7 +160,8 @@ and The suspend and standby actions are run prior to .Nm performing any other actions (such as disk syncs) and entering the new -mode. The resume program is run after resuming from a stand-by or +mode. +The resume program is run after resuming from a stand-by or suspended state. .Sh FILES .Pa /etc/apm/suspend , diff --git a/usr.sbin/arp/arp.4 b/usr.sbin/arp/arp.4 index b169b3e74b6..74db0ad1b77 100644 --- a/usr.sbin/arp/arp.4 +++ b/usr.sbin/arp/arp.4 @@ -1,3 +1,4 @@ +.\" $OpenBSD: arp.4,v 1.9 2000/03/19 17:57:01 aaron Exp $ .\" $NetBSD: arp.4,v 1.2 1995/03/01 11:50:56 chopps Exp $ .\" .\" Copyright (c) 1985, 1986, 1988, 1994 @@ -91,7 +92,8 @@ Manually added entries may be temporary, static or permanent, and may be .Dq published , in which case the system will respond to ARP requests for that host -as if it were the target of the request. A static entry will not +as if it were the target of the request. +A static entry will not time out, but may be overwritten by network traffic, while a permanent entry will not time out and can not be overwritten. .Pp @@ -110,7 +112,8 @@ same Internet address. .Pp .Em "arp info overwritten for %x!! by %x:%x:%x:%x:%x:%x on %x." An existing route has been overwritten with a new Ethernet address, for -example when the other host has changed Ethernet cards. If the route +example when the other host has changed Ethernet cards. +If the route previously was static/non-expiring, the new route will expire normally. .Pp .Em "arp: attempt to overwrite permanent entry for %x!! by %x:%x:%x:%x:%x:%x on %x." diff --git a/usr.sbin/arp/arp.8 b/usr.sbin/arp/arp.8 index df3f2cbe14e..62b875f41f9 100644 --- a/usr.sbin/arp/arp.8 +++ b/usr.sbin/arp/arp.8 @@ -1,3 +1,4 @@ +.\" $OpenBSD: arp.8,v 1.8 2000/03/19 17:57:01 aaron Exp $ .\" $NetBSD: arp.8,v 1.7 1995/03/01 11:50:59 chopps Exp $ .\" .\" Copyright (c) 1985, 1991, 1993 @@ -91,12 +92,14 @@ entry for the host called with the Ethernet address .Ar ether_addr . The Ethernet address is given as six hex bytes separated by -colons. The entry will be static, i.e., not time out, unless the word +colons. +The entry will be static, i.e., not time out, unless the word .Ar temp -is given in the command. A static ARP entry can be overwritten -by network traffic, unless the word +is given in the command. +A static ARP entry can be overwritten by network traffic, unless the word .Ar permanent -is given. If the word +is given. +If the word .Ar pub is given, the entry will be .Dq published ; @@ -106,16 +109,16 @@ act as an server, responding to requests for .Ar hostname -even though the host address is not its own. This behavior has traditionally -been called +even though the host address is not its own. +This behavior has traditionally been called .Em "proxy arp" . .It Fl f Causes the file .Ar filename to be read and multiple entries to be set in the .Tn ARP -tables. Entries -in the file should be of the form +tables. +Entries in the file should be of the form .Pp .Bd -filled -offset indent -compact .Ar hostname ether_addr diff --git a/usr.sbin/bad144/bad144.8 b/usr.sbin/bad144/bad144.8 index af5429309ce..f4dfd80e4ac 100644 --- a/usr.sbin/bad144/bad144.8 +++ b/usr.sbin/bad144/bad144.8 @@ -30,7 +30,7 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)bad144.8 8.1 (Berkeley) 6/6/93 -.\" $Id: bad144.8,v 1.7 2000/03/14 21:31:43 aaron Exp $ +.\" $Id: bad144.8,v 1.8 2000/03/19 17:57:02 aaron Exp $ .\" .Dd June 6, 1993 .Dt BAD144 8 @@ -99,23 +99,24 @@ the information is specified by .Tn DEC standard 144, as follows. The bad sector information is located in the first 5 even numbered sectors -of the last track of the disk pack. There are five identical copies of -the information, described by the +of the last track of the disk pack. +There are five identical copies of the information, described by the .Va dkbad structure. .Pp Replacement sectors are allocated starting with the first sector before the bad sector information and working backwards towards the beginning -of the disk. A maximum of 126 bad sectors are supported. The position -of the bad sector in the bad sector table determines the replacement -sector to which it corresponds. +of the disk. +A maximum of 126 bad sectors are supported. +The position of the bad sector in the bad sector table determines the +replacement sector to which it corresponds. The bad sectors must be listed in ascending order. .Pp The bad sector information and replacement sectors are conventionally only accessible through the .Dq c -file system partition of the disk. If -that partition is used for a file system, the user is responsible for +file system partition of the disk.o +If that partition is used for a file system, the user is responsible for making sure that it does not overlap the bad sector information or any replacement sectors. Thus, one track plus 126 sectors must be reserved to allow use @@ -179,8 +180,8 @@ errors, or the special (skip sector) errors of RM80-type disks. This means that none of these errors can occur when reading the file .Pa /bsd -to boot. Sectors 0-15 of the disk drive -must also not have any of these errors. +to boot. +Sectors 0-15 of the disk drive must also not have any of these errors. .Pp The drivers which write a system core image on disk after a crash do not handle errors; thus the crash dump area must be free of errors and bad diff --git a/usr.sbin/bootpd/bootpef.8 b/usr.sbin/bootpd/bootpef.8 index 2ffe73a062c..dbb66ae0f30 100644 --- a/usr.sbin/bootpd/bootpef.8 +++ b/usr.sbin/bootpd/bootpef.8 @@ -28,7 +28,8 @@ compiles the extension files for only those clients. .It Fl c Ar chdir-path Sets the current directory used by .Nm -while creating extension files. This is useful when the +while creating extension files. +This is useful when the extension file names are specified as relative pathnames, and .Nm needs to use the same current directory as the TFTP server diff --git a/usr.sbin/bootpd/bootptest.8 b/usr.sbin/bootpd/bootptest.8 index 1de7b6f588e..cc93aa52428 100644 --- a/usr.sbin/bootpd/bootptest.8 +++ b/usr.sbin/bootpd/bootptest.8 @@ -32,7 +32,7 @@ By default, the IP address is copied into the request indicating that this client already knows its IP address. .It Fl m Ar magic_number Initialize the first word of the vendor options field with -.Ar magic_number . +.Ar magic_number . .El .Pp A diff --git a/usr.sbin/catman/catman.8 b/usr.sbin/catman/catman.8 index d928d009a79..4ec5e52e5a2 100644 --- a/usr.sbin/catman/catman.8 +++ b/usr.sbin/catman/catman.8 @@ -27,7 +27,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: catman.8,v 1.3 1999/06/05 22:16:33 aaron Exp $ +.\" $Id: catman.8,v 1.4 2000/03/19 17:57:02 aaron Exp $ .\" .Dd July 30, 1993 .Dt CATMAN 8 @@ -56,7 +56,8 @@ database. The optional .Ar sections argument is one word, and contains the section numbers of all the -sections to be checked. For example, if +sections to be checked. +For example, if .Ar sections is .Dq 138 , @@ -82,8 +83,8 @@ database. Display the commands that would have been executed, but do not actually execute them. .It Fl s -Perform work silently; do not echo commands as they are executed. This -flag is ignored if +Perform work silently; do not echo commands as they are executed. +This flag is ignored if .Fl p is also specified. .It Fl w diff --git a/usr.sbin/chown/chgrp.1 b/usr.sbin/chown/chgrp.1 index 4dcb6cd6d4d..f3a86724c5c 100644 --- a/usr.sbin/chown/chgrp.1 +++ b/usr.sbin/chown/chgrp.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: chgrp.1,v 1.4 2000/03/04 20:02:24 aaron Exp $ +.\" $OpenBSD: chgrp.1,v 1.5 2000/03/19 17:57:02 aaron Exp $ .\" .\" Copyright (c) 1983, 1990, 1993, 1994 .\" The Regents of the University of California. All rights reserved. @@ -78,7 +78,8 @@ in the files instead of just the files themselves. The force option ignores errors, except for usage errors and doesn't query about strange modes (unless the user does not have proper permissions). .It Fl h -Change the group ID of the specified symbolic link. The +Change the group ID of the specified symbolic link. +The .Fl h and .Fl R diff --git a/usr.sbin/chown/chown.8 b/usr.sbin/chown/chown.8 index fdd5049b13f..e2c985bbf63 100644 --- a/usr.sbin/chown/chown.8 +++ b/usr.sbin/chown/chown.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: chown.8,v 1.4 1999/03/10 21:25:30 pjanzen Exp $ +.\" $OpenBSD: chown.8,v 1.5 2000/03/19 17:57:02 aaron Exp $ .\" .\" Copyright (c) 1990, 1991, 1993, 1994 .\" The Regents of the University of California. All rights reserved. @@ -84,7 +84,8 @@ in the files instead of just the files themselves. Don't report any failure to change file owner or group, nor modify the exit status to reflect such failures. .It Fl h -Change the user ID and/or the group ID on symbolic links. The +Change the user ID and/or the group ID on symbolic links. +The .Fl R and .Fl h diff --git a/usr.sbin/config/config.8 b/usr.sbin/config/config.8 index dfce0323877..5d6d0b3136a 100644 --- a/usr.sbin/config/config.8 +++ b/usr.sbin/config/config.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: config.8,v 1.15 2000/03/14 21:31:36 aaron Exp $ +.\" $OpenBSD: config.8,v 1.16 2000/03/19 17:57:03 aaron Exp $ .\" $NetBSD: config.8,v 1.10 1996/08/31 20:58:16 mycroft Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -97,7 +97,8 @@ below for more details. .It Fl f Overwrite the .Ar infile -kernel binary with the modified kernel. Otherwise, +kernel binary with the modified kernel. +Otherwise, .Fl o should be given to specify an alternate output file. .It Fl o Ar outfile @@ -398,10 +399,11 @@ driver. ukc> .Ed .Pp -ne1 seems to match the configuration except it uses IRQ 5 instead of IRQ 10. So -the irq on ne1 should be changed via the +ne1 seems to match the configuration except it uses IRQ 5 instead of IRQ 10. +So the irq on ne1 should be changed via the .Ic change -command. The device can be specified by either name or number. +command. +The device can be specified by either name or number. .Pp .Bd -literal .No ukc> Ic change ne1 @@ -422,8 +424,8 @@ ukc> Another case is a mistakenly detected non-existing device instead of another device at the probed location. One known case is the Mitsumi -CD-ROM in OpenBSD/i386. The simplest thing to solve that problem is to -disable mcd0. +CD-ROM in OpenBSD/i386. +The simplest thing to solve that problem is to disable mcd0. .Pp .Bd -literal .No ukc> Ic find mcd0 @@ -467,7 +469,8 @@ ukc> .Ed .Pp It is possible to add new devices, but only devices that were linked into the -kernel. If a new device is added, following devices will be renumbered. +kernel. +If a new device is added, following devices will be renumbered. .Pp .Bd -literal .No ukc> Ic find ep diff --git a/usr.sbin/cron/cron.8 b/usr.sbin/cron/cron.8 index f9dced87356..8cb0cbe7a0f 100644 --- a/usr.sbin/cron/cron.8 +++ b/usr.sbin/cron/cron.8 @@ -15,7 +15,7 @@ .\" * Paul Vixie <paul@vix.com> uunet!decwrl!vixie!paul .\" */ .\" -.\" $Id: cron.8,v 1.7 1999/07/07 10:50:11 aaron Exp $ +.\" $Id: cron.8,v 1.8 2000/03/19 17:57:03 aaron Exp $ .\" .Dd June 6, 1999 .Dt CRON 8 @@ -49,8 +49,8 @@ which is in a different format (see .Xr crontab 5 ) . .Nm then wakes up every minute, examining all loaded crontabs, checking each -command to see if it should be run in the current minute. When executing -commands, any output is mailed to the user named in the +command to see if it should be run in the current minute. +When executing commands, any output is mailed to the user named in the .Ev MAILTO environment variable in the crontab, or to the owner of the crontab if .Ev MAILTO @@ -63,16 +63,19 @@ checks each minute to see if its spool directory's modtime (or the modtime on has changed, and if it has, .Nm examines the modtime on all crontabs and reloads those which have -changed. Thus +changed. +Thus .Nm -need not be restarted whenever a crontab file is modified. Note that the +need not be restarted whenever a crontab file is modified. +Note that the .Xr crontab 1 command updates the modtime of the spool directory whenever it changes a crontab. .Pp Special considerations exist when the clock is changed by less than 3 hours; for example, at the beginning and end of Daylight Saving -Time. If the time has moved forward, those jobs which would have +Time. +If the time has moved forward, those jobs which would have run in the time that was skipped will be run soon after the change. Conversely, if the time has moved backward by less than 3 hours, those jobs that fall into the repeated time will not be run. @@ -81,7 +84,8 @@ Only jobs that run at a particular time (not specified as @hourly, nor with .Ql * in the hour or minute specifier) are -affected. Jobs which are specified with wildcards are run based on the +affected. +Jobs which are specified with wildcards are run based on the new time immediately. .Pp Clock changes of more than 3 hours are considered to be corrections to diff --git a/usr.sbin/cron/crontab.1 b/usr.sbin/cron/crontab.1 index 5a02decfbad..b0d06cb6efe 100644 --- a/usr.sbin/cron/crontab.1 +++ b/usr.sbin/cron/crontab.1 @@ -15,7 +15,7 @@ .\" * Paul Vixie <paul@vix.com> uunet!decwrl!vixie!paul .\" */ .\" -.\" $Id: crontab.1,v 1.5 1999/07/09 13:35:53 aaron Exp $ +.\" $Id: crontab.1,v 1.6 2000/03/19 17:57:03 aaron Exp $ .\" .Dd June 8, 1999 .Dt CRONTAB 1 @@ -27,7 +27,6 @@ .Nm crontab .Op Fl u Ar user .Ar file -.br .Nm crontab .Op Fl u Ar user .Oo diff --git a/usr.sbin/cron/crontab.5 b/usr.sbin/cron/crontab.5 index 29081f6ec5f..fdfa54990e3 100644 --- a/usr.sbin/cron/crontab.5 +++ b/usr.sbin/cron/crontab.5 @@ -15,7 +15,7 @@ .\" * Paul Vixie <paul@vix.com> uunet!decwrl!vixie!paul .\" */ .\" -.\" $Id: crontab.5,v 1.9 2000/01/10 08:19:18 deraadt Exp $ +.\" $Id: crontab.5,v 1.10 2000/03/19 17:57:03 aaron Exp $ .\" .Dd June 8, 1999 .Dt CRONTAB 5 @@ -63,14 +63,15 @@ Creation, modification, and removal of a should be done using .Xr crontab 1 . .Pp -Blank lines, leading spaces, and tabs are ignored. Lines whose first -non-space character is a pound sign +Blank lines, leading spaces, and tabs are ignored. +Lines whose first non-space character is a pound sign .Pq Ql # are comments, and are ignored. Note that comments are not allowed on the same line as .Xr cron 8 commands, since -they will be taken to be part of the command. Similarly, comments are not +they will be taken to be part of the command. +Similarly, comments are not allowed on the same line as environment variable settings. .Pp An active line in a @@ -84,7 +85,8 @@ command. Environment variable settings create the environment any command in the .Nm -is run in. An environment variable setting is of the form: +is run in. +An environment variable setting is of the form: .Pp .Dl name \&= value .Pp @@ -151,12 +153,14 @@ commands in If .Ev MAILTO is defined (and non-empty), -mail is sent to the user so named. If +mail is sent to the user so named. +If .Ev MAILTO is defined but empty .Pq Ev MAILTO \&= Sq , no -mail will be sent. Otherwise mail is sent to the owner of the +mail will be sent. +Otherwise mail is sent to the owner of the .Nm crontab . This option is useful if you decide on .Pa /bin/mail @@ -176,7 +180,8 @@ usually doesn't read its mail. The format of a .Xr cron 8 command is very much the V7 standard, with a number of -upward-compatible extensions. Lines in the system +upward-compatible extensions. +Lines in the system .Nm have six fields in the form: .Bd -ragged -offset indent @@ -204,7 +209,7 @@ have five fields in the form: Fields are separated by blanks or tabs. The allowed values for the fields are: .Pp -.Bl -tag -width "day-of-month" -compact -offset indent +.Bl -tag -width "day-of-month" -compact -offset indent .It field allowed values .It ----- @@ -225,25 +230,29 @@ a valid username text .El .Pp -Lists are allowed. A list is a set of numbers (or ranges) -separated by commas. Examples: +Lists are allowed. +A list is a set of numbers (or ranges) separated by commas. +Examples: .Sm off .Dq 1 , 2 , 5 , 9 , .Dq 0\&-4 , 8\&-12 . .Sm on .Pp -Ranges of numbers are allowed. Ranges are two numbers separated -with a hyphen. The specified range is inclusive. For example, +Ranges of numbers are allowed. +Ranges are two numbers separated with a hyphen. +The specified range is inclusive. +For example, 8\-11 for an .Fa hour entry specifies execution at hours 8, 9, 10 and 11. .Pp -Step values can be used in conjunction with ranges. Following -a range with +Step values can be used in conjunction with ranges. +Following a range with .No \&/ Ns Ar number specifies skips of .Fa number -through the range. For example, +through the range. +For example, .Dq 0-23/2 can be used in the .Fa hour @@ -263,9 +272,10 @@ Names can be used in the .Fa month and .Fa day\&-of\&-week -fields. Use the first three letters of the particular -day or month (case doesn't matter). Ranges or -lists of names are not allowed. +fields. +Use the first three letters of the particular +day or month (case doesn't matter). +Ranges or lists of names are not allowed. .Pp The .Fa command @@ -315,7 +325,8 @@ and If both fields are restricted (i.e., aren't *), the command will be run when .Em either -field matches the current time. For example, +field matches the current time. +For example, .Pp .Dl 30 4 1\&,15 \&* 5 .Pp @@ -393,7 +404,8 @@ is the same as .Pp Months or days of the week can be specified by name. .Pp -Environment variables can be set in the crontab. In BSD or ATT, the +Environment variables can be set in the crontab. +In BSD or ATT, the environment handed to child processes is basically the one from /etc/rc. .Pp Command output is mailed to the crontab owner (BSD can't do this), can be diff --git a/usr.sbin/dhcp/dhclient/dhclient.8 b/usr.sbin/dhcp/dhclient/dhclient.8 index d63e3bf2f9f..b9b3db7e923 100644 --- a/usr.sbin/dhcp/dhclient/dhclient.8 +++ b/usr.sbin/dhcp/dhclient/dhclient.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dhclient.8,v 1.7 1999/10/05 13:39:31 aaron Exp $ +.\" $OpenBSD: dhclient.8,v 1.8 2000/03/19 17:57:03 aaron Exp $ .\" .\" Copyright (c) 1997 The Internet Software Consortium. .\" All rights reserved. @@ -55,8 +55,8 @@ or if these protocols fail, by statically assigning an address. The names of the network interfaces that .Nm should attempt to -configure may be specified on the command line. If no interface names -are given, +configure may be specified on the command line. +If no interface names are given, .Nm will identify all network interfaces, eliminating non-broadcast interfaces if possible, and @@ -71,7 +71,8 @@ to exit if it failed to configure an interface. .It Fl d Forces .Nm -to always run as a foreground process. By default, +to always run as a foreground process. +By default, .Nm runs in the foreground until it has configured an interface, and then will revert to running in the background. @@ -84,9 +85,10 @@ should listen on, instead of the default (68). .Pp The DHCP protocol allows a host to contact a central server which maintains a list of IP addresses which may be assigned on one or more -subnets. A DHCP client may request an address from this pool, and -then use it on a temporary basis for communication on the network. The -DHCP protocol also provides a mechanism whereby a client can learn +subnets. +A DHCP client may request an address from this pool, and +then use it on a temporary basis for communication on the network. +The DHCP protocol also provides a mechanism whereby a client can learn important details about the network to which it is attached, such as the location of a default router, the location of a name server, and so on. @@ -95,16 +97,18 @@ On startup, .Nm reads .Pa /etc/dhclient.conf -for configuration instructions. It then gets a list of all the -network interfaces that are configured in the current system. It -then attempts to configure each interface with DHCP. +for configuration instructions. +It then gets a list of all the +network interfaces that are configured in the current system. +It then attempts to configure each interface with DHCP. .Pp In order to keep track of leases across system reboots and server restarts, .Nm keeps a list of leases it has been assigned in the .Pa /var/db/dhclient.leases -file. On startup, after reading the +file. +On startup, after reading the .Pa dhclient.conf file, .Nm @@ -117,8 +121,8 @@ In order to prevent the file from becoming arbitrarily large, from time to time .Nm creates a new .Pa dhclient.leases -file from its in-core lease database. The old version -of is retained under the name +file from its in-core lease database. +The old version of is retained under the name .Pa /var/db/dhcpd.leases~ until the next time .Nm @@ -127,7 +131,8 @@ rewrites the database. Old leases are kept around in case the DHCP server is unavailable when .Nm is first invoked (generally during the initial system boot -process). In that event, old leases from the +process). +In that event, old leases from the .Pa dhclient.leases file which have not yet expired are tested, and if they are determined to be valid, they are used until either they expire or the DHCP server @@ -135,14 +140,15 @@ becomes available. .Pp A mobile host which may sometimes need to access a network on which no DHCP server exists may be preloaded with a lease for a fixed -address on that network. When all attempts to contact a DHCP server -have failed, +address on that network. +When all attempts to contact a DHCP server have failed, .Nm will try to validate the static lease, and if it succeeds, it will use that lease until it is restarted. .Pp A mobile host may also travel to some networks on which DHCP is not -available but BOOTP is. In that case, it may be advantageous to +available but BOOTP is. +In that case, it may be advantageous to arrange with the network administrator for an entry on the BOOTP database, so that the host can boot quickly on that network rather than cycling through the list of old leases. @@ -178,12 +184,14 @@ process ID of .Nm has been written for the Internet Software Consortium by Ted Lemon <mellon@fugue.com> in cooperation with Vixie -Enterprises. To learn more about the Internet Software Consortium, -see -.B http://www.vix.com/isc. -To learn more about Vixie -Enterprises, see -.B http://www.vix.com. +Enterprises. +To learn more about the Internet Software Consortium, see +.Pp +.Dl http://www.vix.com/isc. +.Pp +To learn more about Vixie Enterprises, see +.Pp +.Dl http://www.vix.com. .Pp This client was substantially modified and enhanced by Elliot Poger for use on Linux while he was working on the MosquitoNet project at @@ -192,7 +200,8 @@ Stanford. The current version owes much to Elliot's Linux enhancements, but was substantially reorganized and partially rewritten by Ted Lemon so as to use the same networking framework that the Internet Software -Consortium DHCP server uses. Much system-specific configuration code +Consortium DHCP server uses. +Much system-specific configuration code was moved into a shell script so that as support for more operating systems is added, it will not be necessary to port and maintain system-specific configuration code to these operating systems - instead, diff --git a/usr.sbin/eeprom/eeprom.8 b/usr.sbin/eeprom/eeprom.8 index a24a30c7fe1..98d397fced3 100644 --- a/usr.sbin/eeprom/eeprom.8 +++ b/usr.sbin/eeprom/eeprom.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: eeprom.8,v 1.8 1999/06/05 22:16:47 aaron Exp $ +.\" $OpenBSD: eeprom.8,v 1.9 2000/03/19 17:57:03 aaron Exp $ .\" $NetBSD: eeprom.8,v 1.2 1996/02/28 01:13:24 thorpej Exp $ .\" .\" Copyright (c) 1996 The NetBSD Foundation, Inc. @@ -68,15 +68,16 @@ .Sh DESCRIPTION .Nm eeprom provides an interface for displaying and changing the contents of the -EEPROM or OpenProm. Without any arguments, +EEPROM or OpenProm. +Without any arguments, .Nm eeprom will list all of the known fields and their corresponding values. When given the name of a specific field, .Nm eeprom will display that value or set it if the field name is followed by .Dq = -and a value. Only the super-user may modify the contents of the EEPROM -or OpenProm. +and a value. +Only the superuser may modify the contents of the EEPROM or OpenProm. .Pp The options are as follows: .Bl -tag -width indent @@ -84,8 +85,8 @@ The options are as follows: Commands are taken from stdin and displayed on stdout. .It Fl c .Nm eeprom -will fix incorrect checksum values and exit. This flag is quietly ignored -on systems with an OpenProm. +will fix incorrect checksum values and exit. +This flag is quietly ignored on systems with an OpenProm. .It Fl f Ar device On systems with an EEPROM, use .Ar device @@ -98,16 +99,16 @@ instead of the default .It Fl i If checksum values are incorrect, .Nm eeprom -will ignore them and continue after displaying a warning. This flag is -quietly ignored on systems with an OpenProm. +will ignore them and continue after displaying a warning. +This flag is quietly ignored on systems with an OpenProm. .El .Pp The following options are valid only on the SPARC and will produce an error when used on a Sun 3: .Bl -tag -width indent .It Fl v -On systems with an OpenProm, be verbose when setting a value. Systems -with an EEPROM are always verbose. +On systems with an OpenProm, be verbose when setting a value. +Systems with an EEPROM are always verbose. .It Fl N Ar system Use the system image .Ar system @@ -130,15 +131,16 @@ How much memory, in megabytes, is installed in the system. .It memtest How much memory, in megabytes, is to be tested upon power-up. .It scrsize -The size of the screen. Acceptable values are +The size of the screen. +Acceptable values are .Dq 1024x1024 , .Dq 1152x900 , .Dq 1600x1280 , and .Dq 1440x1440 . .It watchdog_reboot -If true, the system will reboot upon reset. Otherwise, the system will fall -into the monitor. +If true, the system will reboot upon reset. +Otherwise, the system will fall into the monitor. .It default_boot If true, the system will use the boot device stored in .Pa bootdev . @@ -158,7 +160,8 @@ This value is .Dq 0 for all Sun keyboards. .It console -Specifies the console type. Valid values are +Specifies the console type. +Valid values are .Dq b&w , .Dq ttya , .Dq ttyb , @@ -212,8 +215,10 @@ and fields are not currently supported. .Pp Since the OpenProm is designed such that the field names are arbitrary, -explaining them here is dubious. Below are field names and values that -one is likely to see on a system with an OpenProm. NOTE: this list +explaining them here is dubious. +Below are field names and values that +one is likely to see on a system with an OpenProm. +NOTE: this list may be incomplete or incorrect due to differences between revisions of the OpenProm. .Bl -tag -width "last-hardware-update " @@ -224,9 +229,9 @@ rather than the OpenProm-style interface. A 32-bit integer specifying the number of megabytes of memory to test upon power-up. .It oem-logo -A 64bitx64bit bitmap in Sun Iconedit format. To set the bitmap, give -the pathname of the file containing the image. NOTE: this property is -not yet supported. +A 64bitx64bit bitmap in Sun Iconedit format. +To set the bitmpa, give the pathname of the file containing the image. +NOTE: this property is not yet supported. .It oem-logo? If true, enables the use of the bitmap stored in .Pa oem-logo @@ -240,9 +245,9 @@ rather than the default Sun banner. .It ttya-mode A string of five comma separated fields in the format .Dq 9600,8,n,1,- . -The first field is the baud rate. The second field is the -number of data bits. The third field is the parity; acceptable values -for parity are +The first field is the baud rate. +The second field is the number of data bits. +The third field is the parity; acceptable values for parity are .Dq n (none), .Dq e @@ -252,8 +257,9 @@ for parity are .Dq m (mark), and .Dq s -(space). The -fourth field is the number of stop bits. The fifth field is the +(space). +The fourth field is the number of stop bits. +The fifth field is the .Dq handshake field; acceptable values are .Dq - @@ -281,8 +287,8 @@ but for ttyb. .It sbus-probe-list Four digits in the format .Dq 0123 -specifying which order to probe the sbus at power-up. It is unlikely that -this value should ever be changed. +specifying which order to probe the sbus at power-up. +It is unlikely that this value should ever be changed. .It screen-#columns An 8-bit integer specifying the number of columns on the console. .It screen-#rows @@ -290,8 +296,8 @@ An 8-bit integer specifying the number of rows on the console. .It auto-boot? If true, the system will boot automatically at power-up. .It watchdog-reboot? -If true, the system will reboot upon reset. Otherwise, system will fall -into the monitor. +If true, the system will reboot upon reset. +Otherwise, system will fall into the monitor. .It input-device One of the strings .Dq keyboard , @@ -315,7 +321,8 @@ describing the translation of physical to logical target. .It st-targets Similar to .Pa sd-targets , -but for tapes. The default translation is +but for tapes. +The default translation is .Dq 45670123 . .It scsi-initiator-id The SCSI ID of the on-board SCSI controller. @@ -331,21 +338,24 @@ If true, the system will boot and run in diagnostic mode. .It local-mac-address? When set to .Pa false -all Ethernet devices will use same system default MAC address. When +all Ethernet devices will use same system default MAC address. +When .Pa true , Ethernet devices which have a unique MAC address will use it rather than the system default MAC address. .El .Sh WARNINGS The fields and their values are not necessarily well defined on -systems with an OpenProm. Your mileage may vary. +systems with an OpenProm. +Your mileage may vary. .Pp There are a few fields known to exist in some revisions of the EEPROM -and/or OpenProm that are not yet supported. Most notable are those +and/or OpenProm that are not yet supported. +Most notable are those relating to password protection of the EEPROM or OpenProm. .Pp -Avoid gratuitously changing the contents of the EEPROM. It has a limited -number of write cycles. +Avoid gratuitously changing the contents of the EEPROM. +It has a limited number of write cycles. .Pp The date parser isn't very intelligent. .Sh FILES diff --git a/usr.sbin/fdformat/fdformat.1 b/usr.sbin/fdformat/fdformat.1 index 4aab1a443e9..2ac4d5f4eb1 100644 --- a/usr.sbin/fdformat/fdformat.1 +++ b/usr.sbin/fdformat/fdformat.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fdformat.1,v 1.9 2000/03/14 21:31:43 aaron Exp $ +.\" $OpenBSD: fdformat.1,v 1.10 2000/03/19 17:57:04 aaron Exp $ .\" .\" Copyright (C) 1993, 1994 by Joerg Wunsch, Dresden .\" All rights reserved. @@ -85,8 +85,8 @@ An alternate method to specify the geometry data to write to the floppy disk. If the .Fl q flag has not been specified, the user is asked for a confirmation -of the intended formatting process. In order to continue, an answer -of +of the intended formatting process. +In order to continue, an answer of .Dq y must be given. .Sh DIAGNOSTICS @@ -102,7 +102,8 @@ while it's being verified, and if an error has been detected, it will finally change to .Dq E . .Pp -An exit status of 0 is returned upon successful operation. Exit status +An exit status of 0 is returned upon successful operation. +Exit status 1 is returned on any errors during floppy formatting, and an exit status of 2 reflects invalid arguments given to the program (along with appropriate information written to diagnostic output). @@ -112,8 +113,10 @@ appropriate information written to diagnostic output). .Nm fdformat was developed for 386BSD 0.1 and upgraded to the new .Xr fd 4 -floppy disk driver. It later became part of -FreeBSD 1.1, and was then ported to +floppy disk driver. +It later became part of +.Fx 1.1 , +and was then ported to .Ox 1.2 . .Sh AUTHOR The program was been contributed by Joerg Wunsch, Dresden, diff --git a/usr.sbin/grfconfig/grfconfig.8 b/usr.sbin/grfconfig/grfconfig.8 index 860648efe76..15d70019894 100644 --- a/usr.sbin/grfconfig/grfconfig.8 +++ b/usr.sbin/grfconfig/grfconfig.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: grfconfig.8,v 1.10 1999/07/04 19:25:20 aaron Exp $ +.\" $OpenBSD: grfconfig.8,v 1.11 2000/03/19 17:57:04 aaron Exp $ .\" $NetBSD: grfconfig.8,v 1.4 1997/07/29 17:40:47 veego Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -49,9 +49,10 @@ .Sh DESCRIPTION .Nm is used to change or view the screen mode definition list contained -in a grf device. You may alter the console screen definition as well -as the definitions for the graphic screen. The console will automatically -reinitialize itself to the new screen mode. +in a grf device. +You may alter the console screen definition as well +as the definitions for the graphic screen. +The console will automatically reinitialize itself to the new screen mode. .Pp The following flags and arguments are interpreted by .Nm grfconfig : @@ -60,10 +61,11 @@ The following flags and arguments are interpreted by Print out a raw listing of the mode definitions instead of the pretty list normally shown. .It Ar device -The grf device to manipulate. This argument is required. +The grf device to manipulate. +This argument is required. .It Ar file -The file which contains the mode definitions. If this argument -is not specified, +The file which contains the mode definitions. +If this argument is not specified, .Nm will print out of a list of the modes currently loaded into the grf device. @@ -87,11 +89,13 @@ The screen mode's height. .It Ar dep The bitdepth of the mode. .It Ar hbs hss hse ht -The horizontal timing parameters for the mode in pixel values. All the +The horizontal timing parameters for the mode in pixel values. +All the values are relative to the end of the horizontal blank (beginning of the displayed area). .It Ar vbs vss vse vt -The vertical timing paramters for the mode in line values. All the +The vertical timing paramters for the mode in line values. +All the values are relative to the end of vertical blank (beginning of the displayed area). .It Ar flags diff --git a/usr.sbin/grfinfo/grfinfo.1 b/usr.sbin/grfinfo/grfinfo.1 index f68b5d17d72..37a67fbcc69 100644 --- a/usr.sbin/grfinfo/grfinfo.1 +++ b/usr.sbin/grfinfo/grfinfo.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: grfinfo.1,v 1.3 1999/05/28 23:00:06 aaron Exp $ +.\" $OpenBSD: grfinfo.1,v 1.4 2000/03/19 17:57:04 aaron Exp $ .\" $NetBSD: grfinfo.1,v 1.1 1997/01/31 23:06:53 carrel Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -48,8 +48,8 @@ .Sh DESCRIPTION The .Nm grfinfo -utility displays information about grf graphics frame buffer devices. By -default, only the frame buffer type is displayed. +utility displays information about grf graphics frame buffer devices. +By default, only the frame buffer type is displayed. .Ar file is the device file for the graphics frame buffer. .Pp @@ -63,7 +63,8 @@ Display only the type, even if an error occurs. .Sh DIAGNOSTICS The .Nm grfinfo -utility exits 0 on success or >0 if an error occurred. If the +utility exits 0 on success or >0 if an error occurred. +If the .Fl t option is used and an error occurs, no error message is displayed, and the type is displayed as diff --git a/usr.sbin/ifmcstat/ifmcstat.8 b/usr.sbin/ifmcstat/ifmcstat.8 index c4cfab87ccb..d720b62b779 100644 --- a/usr.sbin/ifmcstat/ifmcstat.8 +++ b/usr.sbin/ifmcstat/ifmcstat.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ifmcstat.8,v 1.1 1999/12/08 12:34:24 itojun Exp $ +.\" $OpenBSD: ifmcstat.8,v 1.2 2000/03/19 17:57:04 aaron Exp $ .\" .\" Copyright (c) 1996 WIDE Project. All rights reserved. .\" @@ -24,10 +24,10 @@ .\" .Sh DESCRIPTION The -.Nm Ifmcstat -dumps multicast group information in the kernel. +.Nm ifmcstat +program dumps multicast group information in the kernel. .Pp -There are no command-line options. +There are no command line options. .\" .\" .Sh SEE ALSO .\" RFC2080 -- IPng for IPv6. G. Malkin, R. Minnear. January 1997. diff --git a/usr.sbin/inetd/inetd.8 b/usr.sbin/inetd/inetd.8 index 79b01bd6a81..de5780f5ed4 100644 --- a/usr.sbin/inetd/inetd.8 +++ b/usr.sbin/inetd/inetd.8 @@ -30,7 +30,7 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)inetd.8 6.7 (Berkeley) 3/16/91 -.\" $Id: inetd.8,v 1.12 1999/12/08 13:21:17 itojun Exp $ +.\" $Id: inetd.8,v 1.13 2000/03/19 17:57:05 aaron Exp $ .\" .Dd March 16, 1991 .Dt INETD 8 @@ -50,13 +50,14 @@ should be run at boot time by .Pa /etc/rc (see .Xr rc 8 ) . -It then listens for connections on certain -internet sockets. When a connection is found on one +It then listens for connections on certain internet sockets. +When a connection is found on one of its sockets, it decides what service the socket corresponds to, and invokes a program to service the request. After the program is finished, it continues to listen on the socket (except in some cases which -will be described below). Essentially, +will be described below). +Essentially, .Nm inetd allows running one daemon to invoke several others, reducing load on the system. @@ -78,11 +79,13 @@ file which, by default, is .Pa /etc/inetd.conf . There must be an entry for each field of the configuration file, with entries for each field separated by a tab or -a space. Comments are denoted by a +a space. +Comments are denoted by a .Dq # at the beginning -of a line. There must be an entry for each field. The -fields of the configuration file are as follows: +of a line. +There must be an entry for each field. +The fields of the configuration file are as follows: .Pp .Bd -unfilled -offset indent -compact service name @@ -109,13 +112,17 @@ server program arguments .Pp For internet services, the first field of the line may also have a host address specifier prefixed to it, separated from the service name by a -colon. If this is done, the string before the colon in the first field +colon. +If this is done, the string before the colon in the first field indicates what local address .Nm -should use when listening for that service. Multiple local addresses -can be specified on the same line, separated by commas. Numeric IP +should use when listening for that service. +Multiple local addresses +can be specified on the same line, separated by commas. +Numeric IP addresses in dotted-quad notation can be used as well as symbolic -hostnames. Symbolic hostnames are looked up using +hostnames. +Symbolic hostnames are looked up using .Fn gethostbyname . If a hostname has multiple address mappings, inetd creates a socket to listen on each address. @@ -130,7 +137,8 @@ To avoid repeating an address that occurs frequently, a line with a host address specifier and colon, but no further fields, causes the host address specifier to be remembered and used for all further lines with no explicit host specifier (until another such line or the end of -the file). A line +the file). +A line .Dl *: is implicitly provided at the top of the file; thus, traditional configuration files (which have no host address specifiers) will be @@ -155,8 +163,8 @@ the file .Pa /etc/rpc . The part on the right of the .Dq / -is the RPC version number. This -can simply be a single numeric argument or a range of versions. +is the RPC version number. +This can simply be a single numeric argument or a range of versions. A range is bounded by the low version to the high version - .Dq rusers/1-3 . .Pp @@ -210,7 +218,8 @@ a .Dq multi-threaded server, and should use the .Dq nowait -entry. For datagram servers which process all incoming datagrams +entry. +For datagram servers which process all incoming datagrams on a socket and eventually time out, the server is said to be .Dq single-threaded and should use a @@ -240,7 +249,8 @@ or by a dot) specifies the maximum number of server instances that may be spawned from .Nm inetd -within an interval of 60 seconds. When omitted, +within an interval of 60 seconds. +When omitted, .Dq max defaults to 40. .Pp @@ -250,7 +260,8 @@ but if a single server process is to handle multiple connections, it may be marked as .Dq wait . The master socket will then be passed as fd 0 to the server, which will then -need to accept the incoming connection. The server should eventually time +need to accept the incoming connection. +The server should eventually time out and exit when no more connections are active. .Nm will continue to @@ -262,10 +273,14 @@ is usually the only stream server marked as wait. The .Em user entry should contain the user name of the user as whom the server -should run. This allows for servers to be given less permission -than root. An optional group name can be specified by appending a dot to -the user name followed by the group name. This allows for servers to run with -a different (primary) group ID than specified in the password file. If a group +should run. +This allows for servers to be given less permission +than root. +An optional group name can be specified by appending a dot to +the user name followed by the group name. +This allows for servers to run with +a different (primary) group ID than specified in the password file. +If a group is specified and user is not root, the supplementary groups associated with that user will still be set. .Pp @@ -274,7 +289,8 @@ The entry should contain the pathname of the program which is to be executed by .Nm inetd -when a request is found on its socket. If +when a request is found on its socket. +If .Nm inetd provides this service internally, this entry should be @@ -284,16 +300,16 @@ The .Em server program arguments should be just as arguments normally are, starting with argv[0], which is the name of -the program. If the service is provided internally, the -word +the program. +If the service is provided internally, the word .Dq internal should take the place of this entry. .Pp .Nm inetd provides several .Dq trivial -services internally by use of -routines within itself. These services are +services internally by use of routines within itself. +These services are .Dq echo , .Dq discard , .Dq chargen @@ -303,8 +319,9 @@ routines within itself. These services are .Dq time (machine readable time, in the form of the number of seconds since midnight, January -1, 1900). All of these services are TCP based. For -details of these services, consult the appropriate +1, 1900). +All of these services are TCP based. +For details of these services, consult the appropriate .Tn RFC from the Network Information Center. .Pp @@ -420,11 +437,14 @@ Therefore, it is unwise to rely too much upon the behavior of wildcard bind socket. .Sh BUGS Host address specifiers, while they make conceptual sense for RPC -services, do not work entirely correctly. This is largely because the +services, do not work entirely correctly. +This is largely because the portmapper interface does not provide a way to register different ports -for the same service on different local addresses. Provided you never +for the same service on different local addresses. +Provided you never have more than one entry for a given RPC service, everything should -work correctly. (Note that default host address specifiers do apply to +work correctly. +(Note that default host address specifiers do apply to RPC lines with no explicit specifier.) .Pp .Dq rpc diff --git a/usr.sbin/iostat/iostat.8 b/usr.sbin/iostat/iostat.8 index 8a7dccb61ab..ccdae1e54fa 100644 --- a/usr.sbin/iostat/iostat.8 +++ b/usr.sbin/iostat/iostat.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: iostat.8,v 1.12 1999/09/23 04:12:10 alex Exp $ +.\" $OpenBSD: iostat.8,v 1.13 2000/03/19 17:57:05 aaron Exp $ .\" $NetBSD: iostat.8,v 1.10 1996/10/25 18:21:57 scottr Exp $ .\" .\" Copyright (c) 1985, 1991, 1993 @@ -54,7 +54,8 @@ statistics .Nm iostat displays kernel .Tn I/O -statistics on terminal, disk and CPU operations. By default, +statistics on terminal, disk and CPU operations. +By default, .Nm iostat displays one line of statistics averaged over the machine's run time. The use of @@ -82,20 +83,24 @@ If no .Ar wait interval is specified, the default is 1 second. .It Fl C -Show CPU statistics. This is enabled by default unless the +Show CPU statistics. +This is enabled by default unless the .Fl d, .Fl D, or .Fl T flags are used. .It Fl d -Show disk statistics. This is the default. Displays kilobytes per -transfer, number of transfers, and megabytes transferred. Use of this -flag disables display of CPU and tty statistics. +Show disk statistics. +This is the default. +Displays kilobytes per +transfer, number of transfers, and megabytes transferred. +Use of this flag disables display of CPU and tty statistics. .It Fl D -Show alternate disk statistics. Displays kilobytes transferred, number of -transfers, and time spent in transfers. Use of this flag disables the -default display. +Show alternate disk statistics. +Displays kilobytes transferred, number of +transfers, and time spent in transfers. +Use of this flag disables the default display. .It Fl I Show the running total values, rather than an average. .It Fl M @@ -106,7 +111,8 @@ instead of the default Extract the name list from the specified system instead of the default .Dq Pa /bsd . .It Fl T -Show tty statistics. This is enabled by default unless the +Show tty statistics. +This is enabled by default unless the .Fl C, .Fl d, or diff --git a/usr.sbin/ipftest/ipftest.1 b/usr.sbin/ipftest/ipftest.1 index ba3fc96dd31..795d90559dc 100644 --- a/usr.sbin/ipftest/ipftest.1 +++ b/usr.sbin/ipftest/ipftest.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ipftest.1,v 1.13 2000/03/05 00:28:51 aaron Exp $ +.\" $OpenBSD: ipftest.1,v 1.14 2000/03/19 17:57:05 aaron Exp $ .Dd May 23, 1999 .Dt IPFTEST 1 .Os @@ -19,7 +19,8 @@ operators can see the effects of an .Nm ipf filter ruleset on test packets, rather than having to observe the effects of the -ruleset on live traffic. This can reduce the disruptions experienced +ruleset on live traffic. +This can reduce the disruptions experienced during the development and refinement of secure IP environments. .Pp .Nm @@ -34,18 +35,23 @@ each packet to .Ar stdout . .Pp Captured or handcrafted packets to be tested can be supplied -in a variety of formats. See the options -.Fl P , Fl S , -.Fl T , Fl H +in a variety of formats. +See the options +.Fl P , +.Fl S , +.Fl T , +.Fl H , and .Fl E -for details. In addition the +for details. +In addition the .Fl X option gives .Nm the ability to use its own text description format to generate .Dq fake -packets. The format used is: +packets. +The format used is: .Bd -ragged in|out on .Ar if @@ -58,8 +64,10 @@ in|out on .Ed .Pp This allows for input or output ICMP, TCP, or UDP packets to be generated for -any interface. For TCP or UDP it allows the specification of source and -destination ports. For TCP it allows the specification of TCP flags. +any interface. +For TCP or UDP it allows the specification of source and +destination ports. +For TCP it allows the specification of TCP flags. Some examples are: .Bd -literal -offset indent # a UDP packet coming in on le0 @@ -73,10 +81,12 @@ out on le0 tcp 10.4.12.1,2245 10.1.1.1,23 S The options are as follows: .Bl -tag -width Fl .It Fl v -Verbose mode. This provides more information about which parts of rule +Verbose mode. +This provides more information about which parts of rule matching the packet passes and fails. .It Fl d -Turn on filter rule debugging. Currently, this only shows what caused +Turn on filter rule debugging. +Currently, this only shows what caused the rule to not match in the IP header checking (addresses/netmasks, etc). .It Fl b Cause the output to be a one word description of the result of passing @@ -89,7 +99,8 @@ This is useful with the and .Fl E options, where it is -not otherwise possible to associate a packet with an interface. Normal +not otherwise possible to associate a packet with an interface. +Normal .Dq text packets can override this setting. .It Fl P @@ -97,15 +108,17 @@ The input file is in the binary format produced using libpcap (i.e., .Xr tcpdump -version 3). Packets are read from this file as being input -(for rule purposes). An interface may be specified using +version 3). +Packets are read from this file as being input (for rule purposes). +An interface may be specified using .Fl I . .It Fl S The input file is in .Dq snoop -format (see RFC 1761). Packets are read -from this file and used as input from any interface. This is perhaps the -most useful input type, currently. +format (see RFC 1761). +Packets are read +from this file and used as input from any interface. +This is perhaps the most useful input type, currently. .It Fl T The input file is text output from .Xr tcpdump . @@ -122,12 +135,14 @@ tcpdump -nqte .Ed .It Fl H The input file is hex digits, representing the binary makeup of the -packets. No length correction is made if an incorrect length is put in +packets. +No length correction is made if an incorrect length is put in the IP header. .It Fl X The input file is composed of text descriptions of IP packets. .It Fl E -The input file is text output from etherfind. The text formats which +The input file is text output from etherfind. +The text formats which are currently supported are those which result from the following etherfind option combinations: .Bd -literal -offset indent @@ -135,7 +150,8 @@ etherfind -n etherfind -n -t .Ed .It Fl i Ar filename -Specify the filename from which to take input. Default is stdin. +Specify the filename from which to take input. +Default is stdin. .It Fl r Ar filename Specify the filename from which to read filter rules. .El diff --git a/usr.sbin/ipsend/ipresend/ipresend.1 b/usr.sbin/ipsend/ipresend/ipresend.1 index 85b5245b4a1..96633a6089a 100644 --- a/usr.sbin/ipsend/ipresend/ipresend.1 +++ b/usr.sbin/ipsend/ipresend/ipresend.1 @@ -1,4 +1,4 @@ -.Dd October 9, 1999 +.Dd October 9, 1999 .Dt IPRESEND 1 .Os .Sh NAME @@ -26,19 +26,21 @@ must be run as root. .Ss OPTIONS .Bl -tag -width "d interface " .It Fl d Ar interface -Set the interface name to be the name supplied. This is useful with the +Set the interface name to be the name supplied. +This is useful with the .Fl P , .Fl S , -.Fl T +.Fl T , and .Fl E options, where it is not otherwise possible -to associate a packet with an interface. Normal +to associate a packet with an interface. +Normal .Sq text packets can override this setting. .It Fl g Ar gateway -Specify the hostname of the gateway through which to route packets. This -is required whenever the destination host isn't directly attached to the +Specify the hostname of the gateway through which to route packets. +This is required whenever the destination host isn't directly attached to the same network as the host from which you're sending. .It Fl m Ar mtu Set the MTU used when sending out packets to @@ -47,10 +49,12 @@ This option allows you to set a fake MTU, allowing the simulation of network interfaces with small MTU's. .It Fl r Ar filename -Specify the filename from which to take input. Default is +Specify the filename from which to take input. +Default is .Va stdin . .It Fl E -The input file is to be text output from etherfind. The text formats which +The input file is to be text output from etherfind. +The text formats which are currently supported are those which result from the following etherfind option combinations: .Bd -literal -offset indent @@ -59,7 +63,8 @@ etherfind -n -t .Ed .It Fl H The input file is to be hex digits, representing the binary makeup of the -packet. No length correction is made if an incorrect length is put in +packet. +No length correction is made if an incorrect length is put in the IP header. .It Fl P The input file specified by @@ -67,13 +72,13 @@ The input file specified by is a binary file produced using libpcap (i.e., .Xr tcpdump 8 -version 3). Packets are read from this file as being input -(for rule purposes). +version 3). +Packets are read from this file as being input (for rule purposes). .It Fl R When sending packets out, send them out -.Sq raw -(the way they came in). The -only real significance here is that it will expect the link layer (i.e., +.Sq raw +(the way they came in). +The only real significance here is that it will expect the link layer (i.e., Ethernet) headers to be prepended to the IP packet being output. .It Fl S The input file is to be in @@ -81,8 +86,8 @@ The input file is to be in format (see .Tn RFC 1761 ) . Packets are read -from this file and used as input from any interface. This is perhaps the -most useful input type, currently. +from this file and used as input from any interface. +This is perhaps the most useful input type, currently. .It Fl T The input file is to be text output from .Xr tcpdump 8 . diff --git a/usr.sbin/iteconfig/iteconfig.8 b/usr.sbin/iteconfig/iteconfig.8 index 5760b23b506..997b7bc4242 100644 --- a/usr.sbin/iteconfig/iteconfig.8 +++ b/usr.sbin/iteconfig/iteconfig.8 @@ -103,13 +103,15 @@ is 3 then 8 colors will be used. .It Fl x Ar offset Set the horizontal offset of the console view on the monitor to .Ar offset -pixel columns. The horizontal offset may be a positive or a +pixel columns. +The horizontal offset may be a positive or a negative integer, positive being an offset to the right, negative to the left. .It Fl y Ar offset Set the vertical offset of the console view on the monitor to .Ar offset -pixel rows. The vertical offset may be a positive or a negative +pixel rows. +The vertical offset may be a positive or a negative integer, positive being an offset down, negative up. .It Fl b Ar seconds Set the console screen blanker to kick in after @@ -121,7 +123,8 @@ is 0. .Pp Any additional arguments will be interpreted as colors and will be used to supply the color values for the console view's -color map, starting with the first entry in the map. (See the +color map, starting with the first entry in the map. +(See the .Sx COLOR SPECIFICATION section of this manual page for information on how to specify colors.) @@ -138,7 +141,8 @@ and .Ar BB are taken to be 8-bit values specifying the intensities of the red, green and blue components, respectively, -of the color to be used. For example, +of the color to be used. +For example, .Li 0xff0000 is bright red, .Li 0xffffff @@ -148,7 +152,8 @@ is dark cyan. .It Ar 0xGG .Ar GG is taken to be an 8-bit value specifying the intensity -of grey to be used. A value of +of grey to be used. +A value of .Li 0x00 is black, a value of .Li 0xff diff --git a/usr.sbin/kvm_mkdb/kvm_mkdb.8 b/usr.sbin/kvm_mkdb/kvm_mkdb.8 index eacd754e02c..ed9311aa19e 100644 --- a/usr.sbin/kvm_mkdb/kvm_mkdb.8 +++ b/usr.sbin/kvm_mkdb/kvm_mkdb.8 @@ -30,7 +30,7 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)kvm_mkdb.8 8.1 (Berkeley) 6/9/93 -.\" $Id: kvm_mkdb.8,v 1.6 1999/06/05 22:17:14 aaron Exp $ +.\" $Id: kvm_mkdb.8,v 1.7 2000/03/19 17:57:06 aaron Exp $ .\" .Dd June 9, 1993 .Dt KVM_MKDB 8 @@ -59,7 +59,8 @@ Various library routines consult this database. The only information currently stored is the kernel namelist, which is used by the .Xr kvm_nlist 3 -function. However, in the future the database may contain other static +function. +However, in the future the database may contain other static information about the current system. .Pp The diff --git a/usr.sbin/lpr/lpc/lpc.8 b/usr.sbin/lpr/lpc/lpc.8 index b2b96b31094..ad9f714a552 100644 --- a/usr.sbin/lpr/lpc/lpc.8 +++ b/usr.sbin/lpr/lpc/lpc.8 @@ -1,3 +1,5 @@ +.\" $OpenBSD: lpc.8,v 1.8 2000/03/19 17:57:06 aaron Exp $ +.\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" @@ -69,8 +71,8 @@ will prompt for commands from the standard input. If arguments are supplied, .Nm interprets the first argument as a command and the remaining -arguments as parameters to the command. The standard input -may be redirected causing +arguments as parameters to the command. +The standard input may be redirected causing .Nm to read commands from file. Commands may be abbreviated; @@ -94,8 +96,8 @@ be printed (i.e., do not form a complete printer job) from the specified printer queue(s) on the local machine. .Pp .It Ic disable No {\ all\ |\ printer\ } -Turn the specified printer queues off. This prevents new -printer jobs from being entered into the queue by +Turn the specified printer queues off. +This prevents new printer jobs from being entered into the queue by .Xr lpr . .Pp .It Xo Ic down No {\ all\ |\ printer\ } Ar message @@ -103,7 +105,8 @@ printer jobs from being entered into the queue by .Xc Turn the specified printer queue off, disable printing and put .Em message -in the printer status file. The message doesn't need to be quoted, the +in the printer status file. +The message doesn't need to be quoted, the remaining arguments are treated like .Xr echo 1 . This is normally used to take a printer down and let others know why @@ -144,7 +147,8 @@ printing. Place the jobs in the order listed at the top of the printer queue. .Pp .It Ic up No {\ all\ |\ printer\ } -Enable everything and start a new printer daemon. Undoes the effects of +Enable everything and start a new printer daemon. +Undoes the effects of .Ic down . .El .Sh FILES diff --git a/usr.sbin/lpr/lpd/lpd.8 b/usr.sbin/lpr/lpd/lpd.8 index 96c08f8693d..1bf56259249 100644 --- a/usr.sbin/lpr/lpd/lpd.8 +++ b/usr.sbin/lpr/lpd/lpd.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: lpd.8,v 1.9 1999/10/17 19:59:44 aaron Exp $ +.\" $OpenBSD: lpd.8,v 1.10 2000/03/19 17:57:06 aaron Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -47,16 +47,19 @@ is the line printer daemon (spool area handler) and is normally invoked at boot time from the .Xr rc 8 -file. It makes a single pass through the +file. +It makes a single pass through the .Xr printcap 5 file to find out about the existing printers and -prints any files left after a crash. It then uses the system calls +prints any files left after a crash. +It then uses the system calls .Xr listen 2 and .Xr accept 2 to receive requests to print files in the queue, transfer files to the spooling area, display the queue, -or remove jobs from the queue. In each case, it forks a child to handle +or remove jobs from the queue. +In each case, it forks a child to handle the request so the parent can continue to listen for more requests. .Pp The options are as follows: @@ -64,11 +67,12 @@ The options are as follows: .It Fl l Cause .Nm -to log valid requests received from the network. This can be useful -for debugging purposes. +to log valid requests received from the network. +This can be useful for debugging purposes. .El .Pp -Access control is provided by two means. First, all requests must come from +Access control is provided by two means. +First, all requests must come from one of the machines listed in the file .Pa /etc/hosts.equiv or @@ -99,33 +103,40 @@ for files beginning with Lines in each .Em cf file specify files to be printed or non-printing actions to be -performed. Each such line begins with a key character +performed. +Each such line begins with a key character to specify what to do with the remainder of the line. .Bl -tag -width Ds .It J -Job Name. String to be used for the job name on the burst page. +Job Name. +String to be used for the job name on the burst page. .It C -Classification. String to be used for the classification line -on the burst page. +Classification. +String to be used for the classification line on the burst page. .It L -Literal. The line contains identification info from +Literal. +The line contains identification info from the password file and causes the banner page to be printed. .It T -Title. String to be used as the title for +Title. +String to be used as the title for .Xr pr 1 . .It H -Host Name. Name of the machine where +Host Name. +Name of the machine where .Xr lpr 1 was invoked. .It P -Person. Login name of the person who invoked +Person. +Login name of the person who invoked .Xr lpr 1 . This is used to verify ownership by .Xr lprm 1 . .It M Send mail to the specified user when the current print job completes. .It f -Formatted File. Name of a file to print which is already formatted. +Formatted File. +Name of a file to print which is already formatted. .It l Like .Dq f @@ -135,22 +146,26 @@ Name of a file to print using .Xr pr 1 as a filter. .It t -Troff File. The file contains +Troff File. +The file contains .Xr troff 1 output (cat phototypesetter commands). .It n -Ditroff File. The file contains device independent troff -output. +Ditroff File. +The file contains device independent troff output. .It r -DVI File. The file contains +DVI File. +The file contains .Tn Tex l output DVI format from Standford. .It g -Graph File. The file contains data produced by +Graph File. +The file contains data produced by .Xr plot 3 . .It c -Cifplot File. The file contains data produced by +Cifplot File. +The file contains data produced by .Em cifplot . .It v The file contains a raster image. @@ -158,23 +173,31 @@ The file contains a raster image. The file contains text data with FORTRAN carriage control characters. .It \&1 -Troff Font R. Name of the font file to use instead of the default. +Troff Font R. +Name of the font file to use instead of the default. .It \&2 -Troff Font I. Name of the font file to use instead of the default. +Troff Font I. +Name of the font file to use instead of the default. .It \&3 -Troff Font B. Name of the font file to use instead of the default. +Troff Font B. +Name of the font file to use instead of the default. .It \&4 -Troff Font S. Name of the font file to use instead of the default. +Troff Font S. +Name of the font file to use instead of the default. .It W -Width. Changes the page width (in characters) used by +Width. +Changes the page width (in characters) used by .Xr pr 1 and the text filters. .It I -Indent. The number of characters to indent the output by (in ascii). +Indent. +The number of characters to indent the output by (in ascii). .It U -Unlink. Name of file to remove upon completion of printing. +Unlink. +Name of file to remove upon completion of printing. .It N -File name. The name of the file which is being printed, or a blank +File name. +The name of the file which is being printed, or a blank for the standard input (when .Xr lpr 1 is invoked in a pipeline). @@ -194,15 +217,16 @@ skip the file to be printed. uses .Xr flock 2 to provide exclusive access to the lock file and to prevent multiple -daemons from becoming active simultaneously. If the daemon should be killed +daemons from becoming active simultaneously. +If the daemon should be killed or die unexpectedly, the lock file need not be removed. The lock file is kept in a readable .Tn ASCII form and contains two lines. The first is the process ID of the daemon and the second is the control -file name of the current job being printed. The second line is updated to -reflect the current status of +file name of the current job being printed. +The second line is updated to reflect the current status of .Nm for the programs .Xr lpq 1 diff --git a/usr.sbin/lpr/lpq/lpq.1 b/usr.sbin/lpr/lpq/lpq.1 index 6a2f0cfe450..331d52b9ff6 100644 --- a/usr.sbin/lpr/lpq/lpq.1 +++ b/usr.sbin/lpr/lpq/lpq.1 @@ -1,3 +1,5 @@ +.\" $OpenBSD: lpq.1,v 1.6 2000/03/19 17:57:06 aaron Exp $ +.\" .\" Copyright (c) 1983, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" @@ -47,7 +49,7 @@ .Sh DESCRIPTION .Nm lpq examines the spooling area used by -.Xr lpd 8 +.Xr lpd 8 for printing files on the line printer, and reports the status of the specified jobs or all jobs associated with a user. .Nm lpq @@ -61,7 +63,8 @@ Specify a particular printer, otherwise the default line printer is used (or the value of the .Ev PRINTER variable in the -environment). All other arguments supplied are interpreted as user +environment). +All other arguments supplied are interpreted as user names or job numbers to filter out only those jobs of interest. .It Fl l Information about each of the files comprising the job entry @@ -73,12 +76,12 @@ rather than just the specified printer. .El .Pp For each job submitted (i.e., invocation of -.Xr lpr 1 ) +.Xr lpr 1 ) .Nm lpq reports the user's name, current rank in the queue, the names of files comprising the job, the job identifier (a number which may be supplied to -.Xr lprm 1 +.Xr lprm 1 for removing a specific job), and the total size in bytes. Job ordering is dependent on the algorithm used to scan the spooling directory and is supposed @@ -87,7 +90,7 @@ to be (First In First Out). File names comprising a job may be unavailable (when -.Xr lpr 1 +.Xr lpr 1 is used as a sink in a pipeline) in which case the file is indicated as .Dq (standard input) . @@ -96,7 +99,7 @@ If .Nm lpq warns that there is no daemon present (i.e., due to some malfunction), the -.Xr lpc 8 +.Xr lpc 8 command can be used to restart the printer daemon. .Sh ENVIRONMENT If the following environment variable exists, it is used by @@ -132,6 +135,7 @@ may report unreliably. Output formatting is sensitive to the line length of the terminal; this can result in widely spaced columns. .Sh DIAGNOSTICS -Unable to open various files. The lock file being malformed. Garbage +Unable to open various files. +The lock file being malformed. +Garbage files when there is no daemon active, but files in the spooling directory. - diff --git a/usr.sbin/lpr/lpr/lpr.1 b/usr.sbin/lpr/lpr/lpr.1 index 82eee40ca59..c395e571cd9 100644 --- a/usr.sbin/lpr/lpr/lpr.1 +++ b/usr.sbin/lpr/lpr/lpr.1 @@ -1,3 +1,5 @@ +.\" $OpenBSD: lpr.1,v 1.3 2000/03/19 17:57:06 aaron Exp $ +.\" .\" Copyright (c) 1980, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" @@ -53,10 +55,12 @@ .Sh DESCRIPTION .Nm lpr uses a spooling daemon to print the named files when facilities -become available. If no names appear, the standard input is assumed. +become available. +If no names appear, the standard input is assumed. .Pp The following single letter options are used to notify the line printer -spooler that the files are not standard text files. The spooling daemon will +spooler that the files are not standard text files. +The spooling daemon will use the appropriate filters to print the data accordingly. .Bl -tag -width indent .It Fl c @@ -87,12 +91,12 @@ The files are assumed to contain data from (device independent troff). .It Fl p Use -.Xr pr 1 +.Xr pr 1 to format the files (equivalent to -.Xr print ) . +.Xr print ) . .It Fl t The files are assumed to contain data from -.Xr troff 1 +.Xr troff 1 (cat phototypesetter commands). .It Fl v The files are assumed to contain a raster image for devices like the @@ -103,8 +107,8 @@ These options apply to the handling of the print job: .Bl -tag -width indent .It Fl P -Force output to a specific printer. Normally, -the default printer is used (site dependent), or the value of the +Force output to a specific printer. +Normally, the default printer is used (site dependent), or the value of the environment variable .Ev PRINTER is used. @@ -118,13 +122,15 @@ printing (with the .Fl s option). .It Fl s -Use symbolic links. Usually files are copied to the spool directory. +Use symbolic links. +Usually files are copied to the spool directory. The .Fl s option will use -.Xr symlink 2 +.Xr symlink 2 to link data files rather than trying to copy them so large files can be -printed. This means the files should +printed. +This means the files should not be modified or removed until they have been printed. .El .Pp @@ -133,19 +139,21 @@ The remaining options apply to copies, the page display, and headers: .It Fl \&# Ns Ar num The quantity .Ar num -is the number of copies desired of each file named. For example, +is the number of copies desired of each file named. +For example, .Bd -literal -offset indent lpr \-#3 foo.c bar.c more.c .Ed .Pp would result in 3 copies of the file foo.c, followed by 3 copies -of the file bar.c, etc. On the other hand, +of the file bar.c, etc. +On the other hand, .Bd -literal -offset indent cat foo.c bar.c more.c \&| lpr \-#3 .Ed .Pp -will give three copies of the concatenation of the files. Often -a site will disable this feature to encourage use of a photocopier +will give three copies of the concatenation of the files. +Often a site will disable this feature to encourage use of a photocopier instead. .It Xo .Fl Ns Oo Cm 1234 Oc Ar font @@ -153,7 +161,7 @@ instead. Specifies a .Ar font to be mounted on font position -.Ar i . +.Ar i . The daemon will construct a .Li .railmag @@ -161,13 +169,14 @@ file referencing the font pathname. .It Fl C Ar class Job classification -to use on the burst page. For example, +to use on the burst page. +For example, .Bd -literal -offset indent lpr \-C EECS foo.c .Ed .Pp causes the system name (the name returned by -.Xr hostname 1 ) +.Xr hostname 1 ) to be replaced on the burst page by .Tn EECS , and the file foo.c to be printed. @@ -176,7 +185,7 @@ Job name to print on the burst page. Normally, the first file's name is used. .It Fl T Ar title Title name for -.Xr pr 1 , +.Xr pr 1 , instead of the file name. .It Fl U Ar user User name to print on the burst page, @@ -185,8 +194,8 @@ This option is only honored if the real user ID is daemon (or that specified in the printcap file instead of daemon), and is intended for those instances where print filters wish to requeue jobs. .It Fl i Op numcols -The output is indented. If the next argument -is numeric +The output is indented. +If the next argument is numeric .Pq Ar numcols , it is used as the number of blanks to be printed before each line; otherwise, 8 characters are printed. @@ -257,5 +266,5 @@ Fonts for .Xr troff 1 and .Xr tex -reside on the host with the printer. It is currently not possible to -use local font libraries. +reside on the host with the printer. +It is currently not possible to use local font libraries. diff --git a/usr.sbin/lpr/lprm/lprm.1 b/usr.sbin/lpr/lprm/lprm.1 index 7757666c887..6b629e924dc 100644 --- a/usr.sbin/lpr/lprm/lprm.1 +++ b/usr.sbin/lpr/lprm/lprm.1 @@ -1,3 +1,5 @@ +.\" $OpenBSD: lprm.1,v 1.6 2000/03/19 17:57:07 aaron Exp $ +.\" .\" Copyright (c) 1983, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" @@ -66,19 +68,21 @@ If a single is given, .Nm lprm will remove all jobs which a user -owns. If the super-user employs this flag, the spool queue will +owns. +If the superuser employs this flag, the spool queue will be emptied entirely. .It Ar user Causes .Nm lprm to attempt to remove any jobs queued belonging to that user -(or users). This form of invoking +(or users). +This form of invoking .Nm lprm -is useful only to the super-user. +is useful only to the superuser. .It Ar job\ \&# A user may dequeue an individual job by specifying its job number. This number may be obtained from the -.Xr lpq 1 +.Xr lpq 1 program, e.g., .Pp .Bd -literal -offset indent @@ -94,7 +98,7 @@ If neither arguments or options are given, .Nm lprm will delete the currently active job if it is owned by the user who invoked -.Nm lprm . +.Nm lprm . .Pp .Nm lprm announces the names of any files it removes and is silent if @@ -102,7 +106,8 @@ there are no jobs in the queue which match the request list. .Pp .Nm lprm will kill off an active daemon, if necessary, before removing -any spooling files. If a daemon is killed, a new one is +any spooling files. +If a daemon is killed, a new one is automatically restarted upon completion of file removals. .Sh ENVIRONMENT If the following environment variable exists, it is utilized by diff --git a/usr.sbin/lpr/lptest/lptest.1 b/usr.sbin/lpr/lptest/lptest.1 index ca69df2fb73..b466ea0de0f 100644 --- a/usr.sbin/lpr/lptest/lptest.1 +++ b/usr.sbin/lpr/lptest/lptest.1 @@ -1,3 +1,5 @@ +.\" $OpenBSD: lptest.1,v 1.3 2000/03/19 17:57:07 aaron Exp $ +.\" .\" Copyright (c) 1985, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" diff --git a/usr.sbin/lpr/pac/pac.8 b/usr.sbin/lpr/pac/pac.8 index 545d1d9b461..d593d46d8a5 100644 --- a/usr.sbin/lpr/pac/pac.8 +++ b/usr.sbin/lpr/pac/pac.8 @@ -1,3 +1,5 @@ +.\" $OpenBSD: pac.8,v 1.4 2000/03/19 17:57:07 aaron Exp $ +.\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" @@ -72,8 +74,8 @@ is used. Causes the output to be sorted by cost; usually the output is sorted alphabetically by name. .It Fl m -Causes the host name to be ignored in the accounting file. This -allows for a user on multiple machines to have all of his printing +Causes the host name to be ignored in the accounting file. +This allows for a user on multiple machines to have all of his printing charges grouped together. .It Fl p Ns Ar price The value diff --git a/usr.sbin/mailwrapper/mailer.conf.5 b/usr.sbin/mailwrapper/mailer.conf.5 index a824e09484f..ac094e8fc48 100644 --- a/usr.sbin/mailwrapper/mailer.conf.5 +++ b/usr.sbin/mailwrapper/mailer.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mailer.conf.5,v 1.1 1999/08/02 19:50:07 jakob Exp $ +.\" $OpenBSD: mailer.conf.5,v 1.2 2000/03/19 17:57:07 aaron Exp $ .\" $NetBSD: mailer.conf.5,v 1.1 1999/03/25 16:40:17 is Exp $ .\" .\" Copyright (c) 1998 @@ -42,8 +42,8 @@ .Pp The file .Pa /etc/mailer.conf -contains a series of pairs. The first member of each pair is the name -of a program invoking +contains a series of pairs. +The first member of each pair is the name of a program invoking .Xr mailwrapper 8 which is typically a symbolic link to .Pa /usr/sbin/sendmail . @@ -53,8 +53,8 @@ and .Xr mailq 1 would be set up this way.) The second member of each pair is the name of the program to -actually execute when the first name is invoked. The file may also -contain comments, denoted by a +actually execute when the first name is invoked. +The file may also contain comments, denoted by a .Ql # character in the first column of any line. .Sh EXAMPLES @@ -88,7 +88,8 @@ newaliases /usr/local/libexec/postfix/sendmail .Sh AUTHORS Perry E. Metzger <perry@piermont.com> .Sh BUGS -The entire reason this program exists is a crock. Instead, a command +The entire reason this program exists is a crock. +Instead, a command for how to submit mail should be standardized, and all the "behave differently if invoked with a different name" behavior of things like .Xr mailq 1 diff --git a/usr.sbin/mailwrapper/mailwrapper.8 b/usr.sbin/mailwrapper/mailwrapper.8 index 91478e7a766..ba471760f9b 100644 --- a/usr.sbin/mailwrapper/mailwrapper.8 +++ b/usr.sbin/mailwrapper/mailwrapper.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mailwrapper.8,v 1.1 1999/08/02 19:50:07 jakob Exp $ +.\" $OpenBSD: mailwrapper.8,v 1.2 2000/03/19 17:57:07 aaron Exp $ .\" $NetBSD: mailwrapper.8,v 1.5 1999/03/22 18:44:01 garbled Exp $ .\" .\" Copyright (c) 1998 @@ -38,7 +38,8 @@ .Nm mailwrapper .Nd invoke appropriate MTA software based on configuration file .Sh SYNOPSIS -Special. See below. +Special. +See below. .Sh DESCRIPTION At one time, the only Mail Transfer Agent (MTA) software easily available was @@ -68,13 +69,15 @@ also typically has aliases named .Xr mailq 1 and .Xr newaliases 1 -linked to it. The program knows to behave differently when its +linked to it. +The program knows to behave differently when its .Va argv[0] is .Dq mailq or .Dq newaliases -and behaves appropriately. Typically, replacement MTAs provide similar +and behaves appropriately. +Typically, replacement MTAs provide similar functionality, either through a program that also switches behavior based on calling name, or through a set of programs that provide similar functionality. @@ -132,7 +135,8 @@ was invoked. .Sh AUTHORS Perry E. Metzger <perry@piermont.com> .Sh BUGS -The entire reason this program exists is a crock. Instead, a command +The entire reason this program exists is a crock. +Instead, a command for how to submit mail should be standardized, and all the "behave differently if invoked with a different name" behavior of things like .Xr mailq 1 diff --git a/usr.sbin/map-mbone/map-mbone.8 b/usr.sbin/map-mbone/map-mbone.8 index d2a5a335190..2b848aa3c93 100644 --- a/usr.sbin/map-mbone/map-mbone.8 +++ b/usr.sbin/map-mbone/map-mbone.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: map-mbone.8,v 1.5 1999/07/07 10:50:12 aaron Exp $ +.\" $OpenBSD: map-mbone.8,v 1.6 2000/03/19 17:57:08 aaron Exp $ .\" $NetBSD: map-mbone.8,v 1.2 1995/10/03 23:16:53 thorpej Exp $ .\" .Dd June 13, 1999 @@ -56,7 +56,8 @@ must be run as root. Sets the debug level to .Ar level . When the debug level is greater than -0, additional debugging messages are printed to stderr. Regardless of +0, additional debugging messages are printed to stderr. +Regardless of the debug level, an error condition will always write an error message and will cause .Nm @@ -73,7 +74,8 @@ Print notifications of all packet timeouts, plus level 2 messages. .Pp Default is 0. .It Fl f -Causes a recursive (flooding) search. If no +Causes a recursive (flooding) search. +If no .Ar starting_router is specified, a recursive search is always performed. .It Fl g diff --git a/usr.sbin/memconfig/memconfig.8 b/usr.sbin/memconfig/memconfig.8 index 2b991cba6db..404f1a96638 100644 --- a/usr.sbin/memconfig/memconfig.8 +++ b/usr.sbin/memconfig/memconfig.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: memconfig.8,v 1.1 1999/11/20 11:22:54 matthieu Exp $ +.\" $OpenBSD: memconfig.8,v 1.2 2000/03/19 17:57:08 aaron Exp $ +.\" .\" Copyright (c) 1999 Chris Costello .\" All rights reserved. .\" @@ -61,7 +62,8 @@ provides an interface to this facility, allowing CPU cache behavior to be altered for ranges of system physical memory. .Pp These ranges are typically power-of-2 aligned and sized, however the specific -rules governing their layout vary between architectures. The +rules governing their layout vary between architectures. +The .Nm memconfig program does not attempt to enforce these rules, however the system will reject any attempt to set an illegal combination. @@ -90,8 +92,8 @@ Attributes applied to this range; one of .Ar write-protect .El .It Ar clear -Clear memory range attributes. Ranges may be cleared by owner or by -base/length combination. +Clear memory range attributes. +Ranges may be cleared by owner or by base/length combination. .Pp To clear based on ownership: .Bl -tag -width xxxxxx diff --git a/usr.sbin/mopd/mopd/mopd.8 b/usr.sbin/mopd/mopd/mopd.8 index dab7199baba..0219fc944f0 100644 --- a/usr.sbin/mopd/mopd/mopd.8 +++ b/usr.sbin/mopd/mopd/mopd.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mopd.8,v 1.7 2000/03/14 21:31:43 aaron Exp $ +.\" $OpenBSD: mopd.8,v 1.8 2000/03/19 17:57:08 aaron Exp $ .\" .\" Copyright (c) 1993-96 Mats O Jansson. All rights reserved. .\" @@ -27,7 +27,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" @(#) $OpenBSD: mopd.8,v 1.7 2000/03/14 21:31:43 aaron Exp $ +.\" @(#) $OpenBSD: mopd.8,v 1.8 2000/03/19 17:57:08 aaron Exp $ .\" .Dd September 24, 1995 .Dt MOPD 8 @@ -48,7 +48,8 @@ or all interfaces if is given. In a load request received by .Nm mopd -a filename can be given. This is the normal case for, e.g., terminal servers. +a filename can be given. +This is the normal case for, e.g., terminal servers. If a filename isn't given .Nm mopd must know what image to load. @@ -65,14 +66,17 @@ filename (e.g., and it might be a soft link to another file. .Pp .Nm mopd -supports two kinds of files. The file is first checked to see if it is in +supports two kinds of files. +The file is first checked to see if it is in .Xr a.out 5 -format. If not, a few of Digital's formats are checked. +format. +If not, a few of Digital's formats are checked. .Pp In normal operation, .Nm mopd forks a copy of itself and runs in -the background. Anomalies and errors are reported via +the background. +Anomalies and errors are reported via .Xr syslog 3 . .Pp The options are as follows: @@ -83,8 +87,8 @@ If .Fl a is omitted, an interface must be specified. .It Fl d -Run in debug mode, with all the output to stdout. The process will run in -the foreground. +Run in debug mode, with all the output to stdout. +The process will run in the foreground. .It Fl f Run in the foreground. .El diff --git a/usr.sbin/mopd/mopprobe/mopprobe.1 b/usr.sbin/mopd/mopprobe/mopprobe.1 index 9d859a9f06f..28c7fa51efa 100644 --- a/usr.sbin/mopd/mopprobe/mopprobe.1 +++ b/usr.sbin/mopd/mopprobe/mopprobe.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mopprobe.1,v 1.7 2000/03/14 21:31:43 aaron Exp $ +.\" $OpenBSD: mopprobe.1,v 1.8 2000/03/19 17:57:08 aaron Exp $ .\" .\" Copyright (c) 1996 Mats O Jansson. All rights reserved. .\" @@ -27,7 +27,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" @(#) $OpenBSD: mopprobe.1,v 1.7 2000/03/14 21:31:43 aaron Exp $ +.\" @(#) $OpenBSD: mopprobe.1,v 1.8 2000/03/19 17:57:08 aaron Exp $ .\" .Dd October 2, 1995 .Dt MOPPROBE 1 @@ -56,9 +56,11 @@ or all known interfaces if .Fl a is given. .Sq Fl a -is given. If +is given. +If .Sq Fl o -inhibits all messages but the first from a node. With +inhibits all messages but the first from a node. +With .Sq Fl v all MOP/RC SID messages will be shown (e.g., machines running DECnet). .Sh OPTIONS diff --git a/usr.sbin/mtree/mtree.8 b/usr.sbin/mtree/mtree.8 index 14edbc5d2a9..987fd78b81b 100644 --- a/usr.sbin/mtree/mtree.8 +++ b/usr.sbin/mtree/mtree.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mtree.8,v 1.13 2000/03/15 00:09:46 aaron Exp $ +.\" $OpenBSD: mtree.8,v 1.14 2000/03/19 17:57:09 aaron Exp $ .\" $NetBSD: mtree.8,v 1.4 1995/03/07 21:26:25 cgd Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 @@ -87,20 +87,22 @@ Use the keyword plus the specified (whitespace or comma separated) keywords instead of the current set of keywords. .It Fl n -Do not emit pathname comments when creating a specification. Normally +Do not emit pathname comments when creating a specification. +Normally a comment is emitted before each directory and before the close of that directory when using the .Fl c option. .It Fl p Ar path Use the file hierarchy rooted in -.Ar path , +.Ar path , instead of the current directory. .It Fl q -Quiet mode. Do not complain when a +Quiet mode. +Do not complain when a .Dq missing -directory can not be created because it is already exists. This occurs -when the directory is a symbolic link. +directory can not be created because it is already exists. +This occurs when the directory is a symbolic link. .It Fl r Remove any files in the file hierarchy that are not described in the specification. diff --git a/usr.sbin/named/man/dig.1 b/usr.sbin/named/man/dig.1 index 4375f406144..05e1f1872f2 100644 --- a/usr.sbin/named/man/dig.1 +++ b/usr.sbin/named/man/dig.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dig.1,v 1.17 2000/03/14 21:31:37 aaron Exp $ +.\" $OpenBSD: dig.1,v 1.18 2000/03/19 17:57:09 aaron Exp $ .\" $From: dig.1,v 8.2 1997/06/01 20:34:33 vixie Exp $ .\" .\" ++Copyright++ 1993 @@ -103,8 +103,8 @@ Name System servers. .Nm has two modes: simple interactive mode which makes a single query, and batch which executes a query for -each in a list of several query lines. All query options are -accessible from the command line. +each in a list of several query lines. +All query options are accessible from the command line. .Pp The usual simple use of .Nm @@ -120,24 +120,27 @@ where: .Bl -tag -width "query-class" -offset .It Ar server may be either a domain name or a dot-notation -Internet address. If this optional field is omitted, +Internet address. +If this optional field is omitted, .Nm will attempt to use the default name server for your machine. .Pp .Sy Note: If a domain name is specified, this will be resolved -using the domain name system resolver (i.e., BIND). If your -system does not support DNS, you may +using the domain name system resolver (i.e., BIND). +If your system does not support DNS, you may .Em have to specify a -dot-notation address. Alternatively, if there is a server +dot-notation address. +Alternatively, if there is a server at your disposal somewhere, all that is required is that .Pa /etc/resolv.conf be present and indicate where the default name servers reside, so that .Ar server itself can be -resolved. See +resolved. +See .Xr resolv.conf 5 for information on .Pa /etc/resolv.conf . @@ -158,7 +161,8 @@ is specific to the .Nm resolver and not referenced by the standard -resolver). If the +resolver). +If the .Ev LOCALRES variable is not set or the file is not readable then @@ -173,7 +177,8 @@ for a convenient way to specify inverse address query. .It Ar query-type is the type of information (DNS query type) that -you are requesting. If omitted, the default is +you are requesting. +If omitted, the default is .Dq Li a (T_A = address). The following types are recognized: @@ -193,8 +198,8 @@ txt T_TXT arbitrary number of strings .sp 1 (See RFC 1035 for the complete list.) .It Ar query-class -is the network class requested in the query. If -omitted, the default is +is the network class requested in the query. +If omitted, the default is .Dq Li in (C_IN = Internet). The following classes are recognized: @@ -216,7 +221,8 @@ will parse the first occurrence of .Dq Li any to mean .Ar query-type -= T_ANY. To specify += T_ANY. +To specify .Ar query-class = C_ANY you must either specify .Dq Li any @@ -230,14 +236,17 @@ option (see below). .It Cm % Ns ignored-comment .Dq Li % is used to included an argument that is simply not -parsed. This may be useful if running +parsed. +This may be useful if running .Nm in batch -mode. Instead of resolving every +mode. +Instead of resolving every .Cm @ Ns Ar server-domain-name in a list of queries, you can avoid the overhead of doing so, and still have the domain name on the command line -as a reference. Example: +as a reference. +Example: .D1 Ic "dig @128.9.0.32 %venera.isi.edu mx isi.edu" .\" .It Cm \- Ns dig-option .\" .Dq Li \- @@ -257,30 +266,39 @@ simply .It Fl f Ar file File for .Nm -batch mode. The file contains a list +batch mode. +The file contains a list of query specifications (\fIdig\fP command lines) which -are to be executed successively. Lines beginning -with ';', '#', or '\\n' are ignored. Other options +are to be executed successively. +Lines beginning +with +.Ql \&; , +.Ql # , +or +.Ql \en +are ignored. +Other options may still appear on command line, and will be in effect for each batch query. .It Fl T Ar time Time in seconds between start of successive -queries when running in batch mode. Can be used -to keep two or more batch +queries when running in batch mode. +Can be used to keep two or more batch .Nm commands running -roughly in sync. Default is zero. +roughly in sync. +Default is zero. .It Fl p Ar port -Port number. Query a name server listening to a -non-standard port number. Default is 53. +Port number. +Query a name server listening to a non-standard port number. +Default is 53. .It Fl P Ns Op Ar ping-string After query returns, execute a .Xr ping 1 command -for response time comparison. This rather -inelegantly makes a call to the shell. The last -three lines of statistics are printed for the -command: +for response time comparison. +This rather inelegantly makes a call to the shell. +The last three lines of statistics are printed for the command: .Dl ping -s server_name 56 3 If the optional .Ar ping-string @@ -289,12 +307,14 @@ replaces .Dq Li "ping \-s" in the shell command. .It Fl t Ar query-type -Specify the type of query. This may specify either an +Specify the type of query. +This may specify either an integer value to be included in the type field or use the abbreviated mnemonic as discussed above (i.e., mx = T_MX). .It Fl c Ar query-class -Specify the class of query. This may specify either an +Specify the class of query. +This may specify either an integer value to be included in the class field or use the abbreviated mnemonic as discussed above (i.e., in = C_IN). @@ -320,7 +340,8 @@ If the shell environment variable is set to the name of a file, this is where the default .Nm -environment is saved. If not, the file +environment is saved. +If not, the file .Pa DiG.env is created in the current working directory. .sp 1 @@ -344,7 +365,8 @@ environment is restored from it before any arguments are parsed. .It Fl envset This flag only affects -batch query runs. When +batch query runs. +When .Fl envset is specified on a line in a @@ -387,8 +409,8 @@ default). is used to specify an option to be changed in the query packet or to change .Nm -output specifics. Many -of these are the same parameters accepted by +output specifics. +Many of these are the same parameters accepted by .Xr nslookup 8 . .\" If an option requires a parameter, the form is as .\" follows: @@ -399,10 +421,12 @@ of these are the same parameters accepted by .\" .Oc .\" .Ed .Pp -Most keywords can be abbreviated. Parsing of the +Most keywords can be abbreviated. +Parsing of the .Dq Li "+" options is very simplistic \(em a value must not be -separated from its keyword by whitespace. The following +separated from its keyword by whitespace. +The following .Ar keyword Ns s are currently available: .sp 1 @@ -449,7 +473,8 @@ The and .Ar time keywords affect the retransmission strategy used by resolver -library when sending datagram queries. The algorithm is as follows: +library when sending datagram queries. +The algorithm is as follows: .Bd -literal -offset indent for i = 0 to retry \- 1 for j = 1 to num_servers @@ -468,8 +493,8 @@ always uses a value of 1 for .Nm once required a slightly modified version of the BIND .Xr resolver 3 -library. BIND's resolver has (as of BIND 4.9) been augmented to work -properly with +library. +BIND's resolver has (as of BIND 4.9) been augmented to work properly with .Nm dig . Essentially, .Nm @@ -512,8 +537,9 @@ authored by Andrew Cherenson. has a serious case of .Dq creeping featurism \(em the result of -considering several potential uses during it's development. It would -probably benefit from a rigorous diet. Similarly, the print flags +considering several potential uses during it's development. +It would probably benefit from a rigorous diet. +Similarly, the print flags and granularity of the items they specify make evident their rather ad hoc genesis. .Pp @@ -522,8 +548,9 @@ does not consistently exit nicely (with appropriate status) when a problem occurs somewhere in the resolver. .Sy ( Note: most of the common -exit cases are handled). This is particularly annoying when running in -batch mode. If the resolver exits abnormally (and is not caught), the entire +exit cases are handled). +This is particularly annoying when running in batch mode. +If the resolver exits abnormally (and is not caught), the entire batch aborts; when such an event is trapped, .Nm simply continues with the next query. diff --git a/usr.sbin/ndp/ndp.8 b/usr.sbin/ndp/ndp.8 index fc410e3165c..9c605d03942 100644 --- a/usr.sbin/ndp/ndp.8 +++ b/usr.sbin/ndp/ndp.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ndp.8,v 1.4 2000/02/28 11:56:40 itojun Exp $ +.\" $OpenBSD: ndp.8,v 1.5 2000/03/19 17:57:08 aaron Exp $ .\" .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. .\" All rights reserved. @@ -105,7 +105,8 @@ Harmonize consistency between the routing table and the default router list; install the top entry of the list into the kernel routing table. .It Fl I Op delete \(ba Ar interface Shows or specifies the default interface used as the default route when -there is no default router. If no argument is given to the option, +there is no default router. +If no argument is given to the option, the current deafult interface will be shown. If an .Ar interface diff --git a/usr.sbin/netgroup_mkdb/netgroup_mkdb.8 b/usr.sbin/netgroup_mkdb/netgroup_mkdb.8 index ddda1a9dd6f..1c372d4dfc4 100644 --- a/usr.sbin/netgroup_mkdb/netgroup_mkdb.8 +++ b/usr.sbin/netgroup_mkdb/netgroup_mkdb.8 @@ -27,7 +27,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: netgroup_mkdb.8,v 1.2 1999/06/05 22:17:46 aaron Exp $ +.\" $Id: netgroup_mkdb.8,v 1.3 2000/03/19 17:57:09 aaron Exp $ .\" .Dd February 3, 1994 .Dt NETGROUP_MKDB 8 @@ -43,7 +43,8 @@ .Nm netgroup_mkdb creates .Xr db 3 -style databases for the specified file. If no file is specified, then +style databases for the specified file. +If no file is specified, .Pa /etc/netgroup is used. These databases are then installed into diff --git a/usr.sbin/pkg_install/add/pkg_add.1 b/usr.sbin/pkg_install/add/pkg_add.1 index 48c964d663e..9c846f30760 100644 --- a/usr.sbin/pkg_install/add/pkg_add.1 +++ b/usr.sbin/pkg_install/add/pkg_add.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pkg_add.1,v 1.17 2000/03/02 18:33:30 aaron Exp $ +.\" $OpenBSD: pkg_add.1,v 1.18 2000/03/19 17:57:09 aaron Exp $ .\" .\" FreeBSD install - a package for the installation and maintainance .\" of non-core utilities. @@ -53,8 +53,8 @@ package name itself plus the .Dq .tar.gz , or .Dq .tar -suffix) or an FTP location in the form of an URL. For example, the following -is valid: +suffix) or an FTP location in the form of an URL. +For example, the following is valid: .Pp .Ic pkg_add -v ftp://ftp.openbsd.org/pub/OpenBSD/2.6/packages/i386/m4-1.4.tgz .Pp @@ -109,12 +109,13 @@ If an installation script exists for a given package, do not execute it. Don't actually install a package, just report the steps that would be taken if it was. .It Fl R -Do not record the installation of a package. This means -that you cannot deinstall it later, so only use this option if +Do not record the installation of a package. +This means that you cannot deinstall it later, so only use this option if you know what you are doing! .It Fl f Force installation to proceed even if prerequisite packages are not -installed or the requirements script fails. Although +installed or the requirements script fails. +Although .Nm will still try to find and auto-install missing prerequisite packages, a failure to find one will not be fatal. @@ -123,12 +124,14 @@ Set .Ar prefix as the directory in which to extract files from a package. If a package has set its default directory, it will be overridden -by this flag. Note that only the first +by this flag. +Note that only the first .Cm @cwd directive will be replaced, since .Nm has no way of knowing which directory settings are relative and -which are absolute. It is rare in any case to see more than one +which are absolute. +It is rare in any case to see more than one directory transition made, but when such does happen and you wish to have control over .Em all @@ -153,7 +156,8 @@ By default, this is the string but it may be necessary to override it in the situation where space in your .Pa /var/tmp -directory is limited. Be sure to leave some number of +directory is limited. +Be sure to leave some number of .Dq X characters for .Xr mkdtemp 3 @@ -167,11 +171,13 @@ file installation; often this is .It Fl M Run in .Cm MASTER -mode. This is a very specialized mode for running +mode. +This is a very specialized mode for running .Nm and is meant to be run in conjunction with .Cm SLAVE -mode. When run in this mode, +mode. +When run in this mode, .Nm does no work beyond extracting the package into a temporary staging area (see the @@ -187,15 +193,18 @@ before acting on its contents. .It Fl S Run in .Cm SLAVE -mode. This is a very specialized mode for running +mode. +This is a very specialized mode for running .Nm and is meant to be run in conjunction with .Cm MASTER -mode. When run in this mode, +mode. +When run in this mode, .Nm expects the release contents to be already extracted and waiting in the staging area, the location of which is read as a string -from the standard input. The complete packing list is also read from stdin, +from the standard input. +The complete packing list is also read from stdin, and the contents then acted on as normal. .El .Pp @@ -203,7 +212,8 @@ By default, when adding packages via FTP, the .Xr ftp 1 program operates in .Dq passive -mode. If you wish to use active mode instead, set the +mode. +If you wish to use active mode instead, set the .Ev FTPMODE environment variable to .Qq active . @@ -211,7 +221,8 @@ If .Nm consistently fails to fetch a package from a site known to work, it may be because the site does not support -passive mode ftp correctly. This is very rare since +passive mode ftp correctly. +This is very rare since .Nm will try active mode ftp if the server refuses a passive mode connection. @@ -236,8 +247,8 @@ A check is made to determine if the package conflicts (from .Cm @pkgcfl directives, see .Xr pkg_create 1 ) -with an already recorded as installed package. If it is, -installation is terminated. +with an already recorded as installed package. +If it is, installation is terminated. .It All package dependencies (from .Cm @pkgdep @@ -366,7 +377,8 @@ scripts are called with the environment variable .Ev PKG_PREFIX set to the installation prefix (see the .Fl p -option above). This allows a package author to write a script +option above). +This allows a package author to write a script that reliably performs some action on the directory where the package is installed, even if the user might change it with the .Fl p @@ -379,8 +391,9 @@ If a given package name cannot be found, the directories named by .Ev PKG_PATH are searched. -It should contain a series of entries separated by colons. Each entry -consists of a directory name. The current directory may be indicated +It should contain a series of entries separated by colons. +Each entry consists of a directory name. +The current directory may be indicated implicitly by an empty directory name, or explicitly by a single period .Pq Ql \&. . diff --git a/usr.sbin/pkg_install/create/pkg_create.1 b/usr.sbin/pkg_install/create/pkg_create.1 index 8854b5dc559..879f27e1fa7 100644 --- a/usr.sbin/pkg_install/create/pkg_create.1 +++ b/usr.sbin/pkg_install/create/pkg_create.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pkg_create.1,v 1.11 2000/02/14 12:23:05 espie Exp $ +.\" $OpenBSD: pkg_create.1,v 1.12 2000/03/19 17:57:09 aaron Exp $ .\" .\" FreeBSD install - a package for the installation and maintainance .\" of non-core utilities. @@ -52,11 +52,14 @@ The .Nm command is used to create packages that will subsequently be fed to -one of the package extraction/info utilities. The input description +one of the package extraction/info utilities. +The input description and command line arguments for the creation of a package are not really meant to be human-generated, though it is easy enough to -do so. It is more expected that you will use a front-end tool for -the job rather than muddling through it yourself. Nonetheless, a short +do so. +It is more expected that you will use a front-end tool for +the job rather than muddling through it yourself. +Nonetheless, a short description of the input syntax is included in this document. .Sh OPTIONS The following command line options are supported: @@ -77,7 +80,8 @@ from file .Ar desc or, if preceded by .Dq \&- , -the argument itself. This string should also +the argument itself. +This string should also give some idea of which version of the product (if any) the package represents. .It Fl d [ Ar \&- ] Ns Ar desc @@ -113,8 +117,9 @@ are dumped, rather than the links themselves. .It Fl i Ar iscript Set .Ar iscript -to be the install procedure for the package. This can be any -executable program (or shell script). It will be invoked automatically +to be the install procedure for the package. +This can be any executable program (or shell script). +It will be invoked automatically when the package is later installed. .It Fl P Ar dpkgs Set the initial package dependency list to @@ -144,16 +149,18 @@ the package. .It Fl k Ar dscript Set .Ar dscript -to be the de-install procedure for the package. This can be any -executable program (or shell script). It will be invoked automatically +to be the de-install procedure for the package. +This can be any executable program (or shell script). +It will be invoked automatically when the package is later (if ever) de-installed. .It Fl r Ar rscript Set .Ar rscript to be the .Dq requirements -procedure for the package. This can be any -executable program (or shell script). It will be invoked automatically +procedure for the package. +This can be any executable program (or shell script). +It will be invoked automatically at installation/deinstallation time to determine whether or not installation/deinstallation should proceed. .It Fl t Ar template @@ -166,7 +173,8 @@ By default, this is the string but it may be necessary to override it in the situation where space in your .Pa /tmp -directory is limited. Be sure to leave some number of +directory is limited. +Be sure to leave some number of .Dq X characters for .Xr mktemp 3 @@ -178,7 +186,8 @@ as a .Fl exclude-from argument to .Xr tar -when creating final package. See +when creating final package. +See .Xr tar man page (or run .Xr tar @@ -188,7 +197,8 @@ flag) for further information on using this flag. .It Fl D Ar displayfile Display the file (using .Xr more 1 ) -after installing the package. Useful for things like +after installing the package. +Useful for things like legal notices on almost-free software, etc. .It Fl m Ar mtreefile Run @@ -217,12 +227,15 @@ format (see .Fl f ) is fairly simple, being nothing more than a single column of filenames to include in the -package. However, since absolute pathnames are generally a bad idea +package. +However, since absolute pathnames are generally a bad idea for a package that could be installed potentially anywhere, there is another method of specifying where things are supposed to go and, optionally, what ownership and mode information they should be -installed with. This is done by imbedding specialized command sequences -in the packing list. Briefly described, these sequences are: +installed with. +This is done by imbedding specialized command sequences +in the packing list. +Briefly described, these sequences are: .Bl -tag -width indent .It Cm @cwd Ar directory Set the internal directory pointer to point to @@ -242,10 +255,12 @@ for package creation but not extraction. .It Cm @exec Ar command Execute .Ar command -as part of the unpacking process. If +as part of the unpacking process. +If .Ar command contains any of the following sequences somewhere in it, they will -be expanded inline. For the following examples, assume that +be expanded inline. +For the following examples, assume that .Cm @cwd is set to .Pa /usr/local @@ -265,7 +280,8 @@ Expands to the .Dq basename of the fully qualified filename, that is the current directory prefix, plus the last filespec, minus -the trailing filename. In the example case, that would be +the trailing filename. +In the example case, that would be .Pa /usr/local/bin . .It Cm "%f" Expands to the @@ -279,17 +295,20 @@ in the example case, .It Cm @unexec Ar command Execute .Ar command -as part of the deinstallation process. Expansion of special +as part of the deinstallation process. +Expansion of special .Cm % sequences is the same as for .Cm @exec . This command is not executed during the package add, as .Cm @exec -is, but rather when the package is deleted. This is useful +is, but rather when the package is deleted. +This is useful for deleting links and other ancillary files that were created as a result of adding the package, but not directly known to the package's table of contents (and hence not automatically -removable). The advantage of using +removable). +The advantage of using .Cm @unexec over a deinstallation script is that you can use the .Dq special sequence expansion @@ -302,8 +321,8 @@ Set default permission for all subsequently extracted files to Format is the same as that used by the .Cm chmod command (well, considering that it's later handed off to it, that's -no surprise). Use without an arg to set back to default (extraction) -permissions. +no surprise). +Use without an arg to set back to default (extraction) permissions. .It Cm @option Ar option Set internal package options, the only two currently supported ones being @@ -332,8 +351,8 @@ Set default group ownership for all subsequently extracted files to Use without an arg to set back to default (extraction) group ownership. .It Cm @comment Ar string -Imbed a comment in the packing list. Useful in -trying to document some particularly hairy sequence that +Imbed a comment in the packing list. +Useful in trying to document some particularly hairy sequence that may trip someone up later. .It Cm @ignore Used internally to tell extraction to ignore the next file (don't @@ -341,27 +360,31 @@ copy it anywhere), as it's used for some special purpose. .It Cm @ignore_inst Similar to .Cm @ignore , -but the ignoring of the next file is delayed one evaluation cycle. This -makes it possible to use this directive in the +but the ignoring of the next file is delayed one evaluation cycle. +This makes it possible to use this directive in the .Ar packinglist file, so you can pack a specialized datafile in with a distribution for your install script (or something) yet have the installer ignore it. .It Cm @name Ar name -Set the name of the package. This is mandatory and is usually -put at the top. This name is potentially different than the name of +Set the name of the package. +This is mandatory and is usually put at the top. +This name is potentially different than the name of the file it came in, and is used when keeping track of the package -for later deinstallation. Note that +for later deinstallation. +Note that .Nm will derive this field from the package name and add it automatically if none is given. .It Cm @dirrm Ar name Declare directory .Pa name -to be deleted at deinstall time. By default, directories created by a +to be deleted at deinstall time. +By default, directories created by a package installation are not deleted when the package is deinstalled; -this provides an explicit directory cleanup method. This directive -should appear at the end of the package list. If more than one +this provides an explicit directory cleanup method. +This directive should appear at the end of the package list. +If more than one .Cm @dirrm directive is used, the directories are removed in the order specified. The @@ -374,7 +397,8 @@ as an .Xr mtree 8 input file to be used at install time (see .Fl m -above). Only the first +above). +Only the first .Cm @mtree directive is honored. .It Cm @display Ar name @@ -386,18 +410,21 @@ above). .It Cm @pkgdep Ar pkgname Declare a dependency on the .Ar pkgname -package. The +package. +The .Ar pkgname package must be installed before this package may be installed, and this package must be deinstalled before the .Ar pkgname -package is deinstalled. Multiple +package is deinstalled. +Multiple .Cm @pkgdep directives may be used if the package depends on multiple other packages. .It Cm @pkgcfl Ar pkgcflname Declare a conflict to the .Ar pkgcflname -package. The +package. +The .Ar pkgcflname package must .Em not @@ -426,7 +453,8 @@ refined it for NetBSD Hard links between files in a distribution must be bracketed by .Cm @cwd directives in order to be preserved as hard links when the package is -extracted. They additionally must not end up being split between +extracted. +They additionally must not end up being split between .Xr tar invocations due to exec argument-space limitations (this depends on the value returned by diff --git a/usr.sbin/pkg_install/delete/pkg_delete.1 b/usr.sbin/pkg_install/delete/pkg_delete.1 index a8b25315ffc..aab877ee3cf 100644 --- a/usr.sbin/pkg_install/delete/pkg_delete.1 +++ b/usr.sbin/pkg_install/delete/pkg_delete.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pkg_delete.1,v 1.8 2000/03/06 21:46:55 aaron Exp $ +.\" $OpenBSD: pkg_delete.1,v 1.9 2000/03/19 17:57:10 aaron Exp $ .\" .\" FreeBSD install - a package for the installation and maintainance .\" of non-core utilities. @@ -52,7 +52,8 @@ your system may be susceptible to ``trojan horses'' or other subtle attacks from miscreants who create dangerous package files. .Pp You are advised to verify the competence and identity of those who -provide installable package files. For extra protection, examine all +provide installable package files. +For extra protection, examine all the package control files in the package record directory .Pq Pa /var/db/pkg/<pkg-name>/ . Pay particular @@ -85,15 +86,18 @@ would be taken if it were. Set .Ar prefix as the directory in which to delete files from any installed packages -which do not explicitly set theirs. For most packages, the prefix will +which do not explicitly set theirs. +For most packages, the prefix will be set automatically to the installed location by .Xr pkg_add 1 . .It Fl d -Remove empty directories created by file cleanup. By default, only +Remove empty directories created by file cleanup. +By default, only files/directories explicitly listed in a package's contents (either as normal files/directories or with the .Cm @dirrm -directive) will be removed at deinstallation time. This option tells +directive) will be removed at deinstallation time. +This option tells .Nm to also remove any directories that were emptied as a result of removing the package. @@ -103,7 +107,8 @@ deinstall or require script fails. .El .Sh TECHNICAL DETAILS .Nm -does pretty much what it says. It examines installed package records in +does pretty much what it says. +It examines installed package records in .Pa /var/db/pkg/<pkg-name> , deletes the package contents, and finally removes the package records. .Pp @@ -130,8 +135,8 @@ then this is executed first as is the name of the package in question and .Ar DEINSTALL is a keyword denoting that this is a deinstallation) -to see whether or not deinstallation should continue. A non-zero exit -status means no, unless the +to see whether or not deinstallation should continue. +A non-zero exit status means no, unless the .Fl f option is specified. .Pp @@ -160,7 +165,8 @@ All scripts are called with the environment variable .Ev PKG_PREFIX set to the installation prefix (see the .Fl p -option above). This allows a package author to write a script +option above). +This allows a package author to write a script that reliably performs some action on the directory where the package is installed, even if the user might have changed it by specifying the .Fl p diff --git a/usr.sbin/pkg_install/info/pkg_info.1 b/usr.sbin/pkg_install/info/pkg_info.1 index 3d34be8a70d..9ad1c1883e1 100644 --- a/usr.sbin/pkg_install/info/pkg_info.1 +++ b/usr.sbin/pkg_install/info/pkg_info.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pkg_info.1,v 1.6 1999/06/05 01:29:39 aaron Exp $ +.\" $OpenBSD: pkg_info.1,v 1.7 2000/03/19 17:57:11 aaron Exp $ .\" .\" FreeBSD install - a package for the installation and maintainance .\" of non-core utilities. @@ -102,7 +102,8 @@ Show the install script (if any) for each package. .It Fl k Show the de-install script (if any) for each package. .It Fl L -Show the files within each package. This is different from just +Show the files within each package. +This is different from just viewing the packing list, since full pathnames for everything are generated. .It Fl l Ar str @@ -113,8 +114,8 @@ shown with This is primarily of use to front-end programs that want to request a lot of different information fields at once for a package, but don't necessary want the output intermingled in such a way that they can't -organize it. This lets you add a special token to the start of -each field. +organize it. +This lets you add a special token to the start of each field. .It Fl m Show the mtree file (if any) for each package. .It Fl p @@ -141,9 +142,11 @@ can be overridden by specifying an alternative directory in the environment variable. .It Ev PKG_PATH This can be used to specify a colon-separated list of paths to search for -package files. The current directory is always searched first, even if +package files. +The current directory is always searched first, even if .Ev PKG_PATH -is set. If +is set. +If .Ev PKG_PATH is used, the suffix .Dq .tgz @@ -158,7 +161,8 @@ to create a .Dq staging area for any files extracted by .Nm -from package files. If neither +from package files. +If neither .Ev PKG_TMPDIR nor .Ev TMPDIR @@ -167,7 +171,8 @@ yields a suitable scratch directory, .Pa /tmp , and .Pa /usr/tmp -are tried in turn. Note that +are tried in turn. +Note that .Pa /usr/tmp may be created, if it doesn't already exist. .Pp diff --git a/usr.sbin/pkg_install/sign/pkg_sign.1 b/usr.sbin/pkg_install/sign/pkg_sign.1 index 4b021c92956..99b3c98d3fe 100644 --- a/usr.sbin/pkg_install/sign/pkg_sign.1 +++ b/usr.sbin/pkg_install/sign/pkg_sign.1 @@ -1,4 +1,5 @@ -.\" $OpenBSD: pkg_sign.1,v 1.3 1999/10/05 22:30:49 espie Exp $ +.\" $OpenBSD: pkg_sign.1,v 1.4 2000/03/19 17:57:11 aaron Exp $ +.\" .\" Copyright (c) 1999 Marc Espie. .\" .\" Redistribution and use in source and binary forms, with or without @@ -51,7 +52,7 @@ embeds a cryptographic signature within a gzip file can be .Li pgp (default) or -.Li sha1 . +.Li sha1 . If .Ar type is @@ -68,9 +69,11 @@ which will be recorded as the name of the package, and printed as the SHA1 checksum. .Pp .Nm pkg_check -checks that cryptographic signature. It currently disregards +checks that cryptographic signature. +It currently disregards .Ar type -and checks only the topmost signature. For sha1, it checksums the file +and checks only the topmost signature. +For sha1, it checksums the file and verifies that the result matches the list of checksums recorded in .Pa /var/db/pkg/SHA1 . .Pp @@ -106,7 +109,7 @@ eight bytes long). and .Nm pkg_check return with an exit code > 0 if anything went wrong for any -.Ar file . +.Ar file . For .Nm pkg_check , this usually indicates that the package is not signed, or that the diff --git a/usr.sbin/ppp/ppp/ppp.8 b/usr.sbin/ppp/ppp/ppp.8 index 3e3f58d52fa..371764b1952 100644 --- a/usr.sbin/ppp/ppp/ppp.8 +++ b/usr.sbin/ppp/ppp/ppp.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ppp.8,v 1.80 2000/03/19 10:33:33 brian Exp $ +.\" $OpenBSD: ppp.8,v 1.81 2000/03/19 17:57:11 aaron Exp $ .Dd 20 September 1995 .nr XX \w'\fC00' .Dt PPP 8 @@ -17,7 +17,8 @@ .Sh DESCRIPTION This is a user process .Em PPP -software package. Normally, +software package. +Normally, .Em PPP is implemented as a part of the kernel (e.g., as managed by .Xr pppd 8 ) @@ -35,10 +36,12 @@ flag for backwards compatability) does the equivalent of a .Dq nat enable yes , enabling .Nm Ns No 's -network address translation features. This allows +network address translation features. +This allows .Nm to act as a NAT or masquerading engine for all machines on an internal -LAN. Refer to +LAN. +Refer to .Xr libalias 3 for details. .Pp @@ -61,7 +64,8 @@ will start with a value of 0 for .Ar N , and keep trying to open a tunnel device by incrementing the value of .Ar N -by one each time until it succeeds. If it fails three times in a row +by one each time until it succeeds. +If it fails three times in a row because the device file is missing, it gives up. .Pp The following @@ -75,11 +79,12 @@ opens the tun interface, configures it then goes into the background. The link isn't brought up until outgoing data is detected on the tun interface at which point .Nm -attempts to bring up the link. Packets received (including the first one) -while +attempts to bring up the link. +Packets received (including the first one) while .Nm is trying to bring the link up will remain queued for a default of -2 minutes. See the +2 minutes. +See the .Dq set choked command below. .Pp @@ -90,9 +95,11 @@ mode, at least one must be given on the command line (see below) and a .Dq set ifaddr must be done in the system profile that specifies a peer IP address to -use when configuring the interface. Something like +use when configuring the interface. +Something like .Dq 10.0.0.1/0 -is usually appropriate. See the +is usually appropriate. +See the .Dq pmdemand system in .Pa /etc/ppp/ppp.conf.sample @@ -100,19 +107,21 @@ for an example. .It Fl background Here, .Nm -attempts to establish a connection with the peer immediately. If it -succeeds, +attempts to establish a connection with the peer immediately. +If it succeeds, .Nm goes into the background and the parent process returns an exit code -of 0. If it fails, +of 0. +If it fails, .Nm exits with a non-zero result. .It Fl foreground In foreground mode, .Nm attempts to establish a connection with the peer immediately, but never -becomes a daemon. The link is created in background mode. This is useful -if you wish to control +becomes a daemon. +The link is created in background mode. +This is useful if you wish to control .Nm Ns No 's invocation from another process. .It Fl direct @@ -161,16 +170,17 @@ at startup, followed by each of the systems specified on the command line. .It Provides an interactive user interface. Using its command mode, the user can easily enter commands to establish the connection with the remote end, check -the status of connection and close the connection. All functions can -also be optionally password protected for security. +the status of connection and close the connection. +All functions can also be optionally password protected for security. .It Supports both manual and automatic dialing. Interactive mode has a .Dq term -command which enables you to talk to the device directly. When you -are connected to the remote peer and it starts to talk +command which enables you to talk to the device directly. +When you are connected to the remote peer and it starts to talk .Em PPP , .Nm -detects it and switches to packet mode automatically. Once you have +detects it and switches to packet mode automatically. +Once you have determined the proper sequence for connecting with the remote host, you can write a chat script to define the necessary dialing and login procedure for later convenience. @@ -181,23 +191,27 @@ mode, .Nm will act as a daemon and wait for a packet to be sent over the .Em PPP -link. When this happens, the daemon automatically dials and establishes the +link. +When this happens, the daemon automatically dials and establishes the connection. In almost the same manner .Fl ddial mode (direct-dial mode) also automatically dials and establishes the -connection. However, it differs in that it will dial the remote site +connection. +However, it differs in that it will dial the remote site any time it detects the link is down, even if there are no packets to be -sent. This mode is useful for full-time connections where we worry less +sent. +This mode is useful for full-time connections where we worry less about line charges and more about being connected full time. A third .Fl dedicated -mode is also available. This mode is targeted at a dedicated link -between two machines. +mode is also available. +This mode is targeted at a dedicated link between two machines. .Nm will never voluntarily quit from dedicated mode - you must send it the .Dq quit all -command via its diagnostic socket. A +command via its diagnostic socket. +A .Dv SIGHUP will force an LCP renegotiation, and a .Dv SIGTERM @@ -208,16 +222,19 @@ can use either the standard LCP callback protocol or the Microsoft CallBack Control Protocol (ftp://ftp.microsoft.com/developr/rfc/cbcp.txt). .It Supports NAT or packet aliasing. Packet aliasing (a.k.a. IP masquerading) allows computers on a -private, unregistered network to access the Internet. The +private, unregistered network to access the Internet. +The .Em PPP -host acts as a masquerading gateway. IP addresses as well as TCP and +host acts as a masquerading gateway. +IP addresses as well as TCP and UDP port numbers are aliased for outgoing packets and de-aliased for returning packets. .It Supports background PPP connections. In background mode, if .Nm successfully establishes the connection, it will become a daemon. -Otherwise, it will exit with an error. This allows the setup of +Otherwise, it will exit with an error. +This allows the setup of scripts that wish to execute certain commands only if the connection is successfully established. .It Supports server-side PPP connections. @@ -231,8 +248,8 @@ With PAP or CHAP, it is possible to skip the Unix style .Xr login 1 procedure, and use the .Em PPP -protocol for authentication instead. If the peer requests Microsoft -CHAP authentication and +protocol for authentication instead. +If the peer requests Microsoft CHAP authentication and .Nm is compiled with DES support, an appropriate MD4/DES response will be made. @@ -246,7 +263,8 @@ An extension to PAP and CHAP, .Em \&S Ns No ervice allows authentication information to be stored in a central or distributed database along with various per-user framed connection -characteristics. If +characteristics. +If .Pa libradius is available at compile time, .Nm @@ -256,7 +274,8 @@ requests when configured to do so. .It Supports Proxy Arp. .Nm can be configured to make one or more proxy arp entries on behalf of -the peer. This allows routing from the peer to the LAN without +the peer. +This allows routing from the peer to the LAN without configuring each machine on that LAN. .It Supports packet filtering. User can define four kinds of filters: the @@ -282,7 +301,8 @@ If a device name is specified as .Xc .Nm will open a TCP or UDP connection for transporting data rather than using a -conventional serial device. UDP connections force +conventional serial device. +UDP connections force .Nm into synchronous mode. .It Supports PPP over ISDN. @@ -318,8 +338,8 @@ may receive higher data rates from it as a result of such compression. While this is generally a good thing in most other situations, this higher speed data imposes a penalty on the system by increasing the number of serial interrupts the system has to process in talking to the -modem and also increases latency. Unlike VJ-compression, Predictor-1 and -DEFLATE compression pre-compresses +modem and also increases latency. +Unlike VJ-compression, Predictor-1 and DEFLATE compression pre-compresses .Em all network traffic flowing through the link, thus reducing overheads to a minimum. @@ -344,16 +364,16 @@ with permissions .Dv 04554 . By default, .Nm -will not run if the invoking user id is not zero. This may be overridden -by using the +will not run if the invoking user id is not zero. +This may be overridden by using the .Dq allow users command in .Pa /etc/ppp/ppp.conf . When running as a normal user, .Nm switches to user id 0 in order to alter the system routing table, set up -system lock files and read the ppp configuration files. All -external commands (executed via the "shell" or "!bg" commands) are executed +system lock files and read the ppp configuration files. +All external commands (executed via the "shell" or "!bg" commands) are executed as the user id that invoked .Nm ppp . Refer to the @@ -367,7 +387,8 @@ you may need to deal with some initial configuration details. .Bl -bullet .It Your kernel must include a tunnel device (the GENERIC kernel includes -one by default). If it doesn't, or if you require more than one tun +one by default). +If it doesn't, or if you require more than one tun interface, you'll need to rebuild your kernel with the following line in your kernel configuration file: .Pp @@ -398,8 +419,8 @@ file and that the group contains the names of all users expected to use .Nm ppp . Refer to the .Xr group 5 -manual page for details. Each of these users must also be given access -using the +manual page for details. +Each of these users must also be given access using the .Dq allow users command in .Pa /etc/ppp/ppp.conf . @@ -408,7 +429,8 @@ Create a log file. .Nm uses .Xr syslog 3 -to log information. A common log file name is +to log information. +A common log file name is .Pa /var/log/ppp.log . To make output go to this file, put the following lines in the .Pa /etc/syslog.conf @@ -460,7 +482,8 @@ Alternatively, if the peer supports it, can be configured to ask the peer for the nameserver address(es) and to update .Pa /etc/resolv.conf -automatically. Refer to the +automatically. +Refer to the .Dq enable dns and .Dq resolv @@ -480,10 +503,11 @@ ppp ON awfulhak> .Pp The .Sq ON -part of your prompt should always be in upper case. If it is in lower -case, it means that you must supply a password using the +part of your prompt should always be in upper case. +If it is in lower case, it means that you must supply a password using the .Dq passwd -command. This only ever happens if you connect to a running version of +command. +This only ever happens if you connect to a running version of .Nm and have not authenticated yourself using the correct password. .Pp @@ -493,13 +517,15 @@ ppp ON awfulhak> set device /dev/cua00 ppp ON awfulhak> set speed 38400 .Ed .Pp -Normally, hardware flow control (CTS/RTS) is used. However, under +Normally, hardware flow control (CTS/RTS) is used. +However, under certain circumstances (as may happen when you are connected directly to certain PPP-capable terminal servers), this may result in .Nm hanging as soon as it tries to write data to your communications link as it is waiting for the CTS (clear to send) signal - which will never -come. Thus, if you have a direct line and can't seem to make a +come. +Thus, if you have a direct line and can't seem to make a connection, try turning CTS/RTS off with .Dq set ctsrts off . If you need to do this, check the @@ -511,21 +537,24 @@ Usually, parity is set to .Dq none , and this is .Nm Ns No 's -default. Parity is a rather archaic error checking mechanism that is no +default. +Parity is a rather archaic error checking mechanism that is no longer used because modern modems do their own error checking, and most link-layer protocols (that's what .Nm -is) use much more reliable checking mechanisms. Parity has a relatively +is) use much more reliable checking mechanisms. +Parity has a relatively huge overhead (a 12.5% increase in traffic) and as a result, it is always disabled .Pq set to Dq none when .Dv PPP -is opened. However, some ISPs (Internet Service Providers) may use +is opened. +However, some ISPs (Internet Service Providers) may use specific parity settings at connection time (before .Dv PPP -is opened). Notably, Compuserve insist -on even parity when logging in: +is opened). +Notably, Compuserve insist on even parity when logging in: .Bd -literal -offset indent ppp ON awfulhak> set parity even .Ed @@ -575,7 +604,8 @@ PPP ON awfulhak> # We've agreed IP numbers .Ed .Pp If it does not, it's probable that the peer is waiting for your end to -start negotiating. To force +start negotiating. +To force .Nm to start sending .Em PPP @@ -585,7 +615,8 @@ command to drop out of terminal mode and enter packet mode. .Pp If you never even receive a login prompt, it is quite likely that the peer wants to use PAP or CHAP authentication instead of using Unix-style -login/password authentication. To set things up properly, drop back to +login/password authentication. +To set things up properly, drop back to the prompt and set your authentication name and key, then reconnect: .Bd -literal -offset indent ~. @@ -607,23 +638,28 @@ PPp ON awfulhak> # We've authenticated PPP ON awfulhak> # We've agreed IP numbers .Ed .Pp -You are now connected! Note that +You are now connected! +Note that .Sq PPP in the prompt has changed to capital letters to indicate that you have -a peer connection. If only some of the three Ps go uppercase, wait until -either everything is uppercase or lowercase. If they revert to lowercase, -it means that +a peer connection. +If only some of the three Ps go uppercase, wait until +either everything is uppercase or lowercase. +If they revert to lowercase, it means that .Nm -couldn't successfully negotiate with the peer. A good first step -for troubleshooting at this point would be to +couldn't successfully negotiate with the peer. +A good first step for troubleshooting at this point would be to .Bd -literal -offset indent ppp ON awfulhak> set log local phase lcp ipcp .Ed .Pp -and try again. Refer to the +and try again. +Refer to the .Dq set log -command description below for further details. If things fail at this point, -it is quite important that you turn logging on and try again. It is also +command description below for further details. +If things fail at this point, +it is quite important that you turn logging on and try again. +It is also important that you note any prompt changes and report them to anyone trying to help you. .Pp @@ -644,9 +680,11 @@ PPP ON awfulhak> show bundle * Logical (high level) connection related information is shown here * .Ed .Pp -At this point, your machine has a host route to the peer. This means +At this point, your machine has a host route to the peer. +This means that you can only make a connection with the host on the other side -of the link. If you want to add a default route entry (telling your +of the link. +If you want to add a default route entry (telling your machine to send all packets without another routing entry to the other side of the .Em PPP @@ -672,8 +710,8 @@ If a new IP address is negotiated at connection time, will update your default route accordingly. .Pp You can now use your network applications (ping, telnet, ftp etc.) -in other windows or terminals on your machine. If you wish to reuse -the current terminal, you can put +in other windows or terminals on your machine. +If you wish to reuse the current terminal, you can put .Nm into the background using your standard shell suspend and background commands (usually @@ -696,12 +734,13 @@ Each line contains one comment, inclusion, label or command: .It A line starting with a .Pq Dq # -character is treated as a comment line. Leading whitespace are ignored -when identifying comment lines. +character is treated as a comment line. +Leading whitespace are ignored when identifying comment lines. .It An inclusion is a line beginning with the word .Sq !include . -It must have one argument - the file to include. You may wish to +It must have one argument - the file to include. +You may wish to .Dq !include ~/.ppp.conf for compatibility with older versions of .Nm ppp . @@ -717,7 +756,9 @@ The .Pa /etc/ppp/ppp.conf file should consist of at least a .Dq default -section. This section is always executed. It should also contain +section. +This section is always executed. +It should also contain one or more sections, named according to their purpose, for example, .Dq MyISP would represent your ISP, and @@ -730,12 +771,13 @@ You can now specify the destination label name when you invoke Commands associated with the .Dq default label are executed, followed by those associated with the destination -label provided. When +label provided. +When .Nm is started with no arguments, the .Dq default -section is still executed. The load command can be used to manually -load a section from the +section is still executed. +The load command can be used to manually load a section from the .Pa /etc/ppp/ppp.conf file: .Bd -literal -offset indent @@ -747,8 +789,10 @@ Note, no action is taken by after a section is loaded, whether it's the result of passing a label on the command line or using the .Dq load -command. Only the commands specified for that label in the configuration -file are executed. However, when invoking +command. +Only the commands specified for that label in the configuration +file are executed. +However, when invoking .Nm with the .Fl background , @@ -757,7 +801,8 @@ or .Fl dedicated switches, the link mode tells .Nm -to establish a connection. Refer to the +to establish a connection. +Refer to the .Dq set mode command below for further details. .Pp @@ -776,9 +821,11 @@ PPP ON awfulhak> .Pp The Ppp prompt indicates that .Nm -has entered the authentication phase. The PPp prompt indicates that +has entered the authentication phase. +The PPp prompt indicates that .Nm -has entered the network phase. The PPP prompt indicates that +has entered the network phase. +The PPP prompt indicates that .Nm has successfully negotiated a network layer protocol and is in a usable state. @@ -788,7 +835,8 @@ If the file is available, its contents are executed when the .Em PPP -connection is established. See the provided +connection is established. +See the provided .Dq pmdemand example in .Pa /etc/ppp/ppp.conf.sample @@ -797,10 +845,11 @@ which runs a script in the background after the connection is established .Dq shell and .Dq bg -commands below for a description of possible substitution strings). Similarly, -when a connection is closed, the contents of the +commands below for a description of possible substitution strings). +Similarly, when a connection is closed, the contents of the .Pa /etc/ppp/ppp.linkdown -file are executed. Both of these files have the same format as +file are executed. +Both of these files have the same format as .Pa /etc/ppp/ppp.conf . .Pp In previous versions of @@ -834,9 +883,10 @@ When .Fl background is specified, .Nm -attempts to establish the connection immediately. If multiple phone -numbers are specified, each phone number will be tried once. If the -attempt fails, +attempts to establish the connection immediately. +If multiple phone +numbers are specified, each phone number will be tried once. +If the attempt fails, .Nm exits immediately with a non-zero exit code. If it succeeds, then @@ -851,9 +901,11 @@ Demand dialing is enabled with the .Fl auto or .Fl ddial -options. You must also specify the destination label in +options. +You must also specify the destination label in .Pa /etc/ppp/ppp.conf -to use. It must contain the +to use. +It must contain the .Dq set ifaddr command to define the remote peers IP address. (refer to @@ -886,7 +938,8 @@ The .Dq show who command lists users that are currently connected to .Nm -itself. If the diagnostic socket is closed or changed to a different +itself. +If the diagnostic socket is closed or changed to a different socket, all connections are immediately dropped. .Pp In @@ -894,7 +947,8 @@ In mode, when an outgoing packet is detected, .Nm will perform the dialing action (chat script) and try to connect -with the peer. In +with the peer. +In .Fl ddial mode, the dialing action is performed any time the line is found to be down. @@ -921,10 +975,11 @@ the delay period is a random value between 1 and 30 seconds inclusive. .It Ar inc is the number of seconds that .Ar secs -should be incremented each time a new dial attempt is made. The timeout -reverts to +should be incremented each time a new dial attempt is made. +The timeout reverts to .Ar secs -only after a successful connection is established. The default value for +only after a successful connection is established. +The default value for .Ar inc is zero. .It Ar max @@ -939,14 +994,16 @@ is 10. is the number of seconds to wait before attempting to dial the next number in a list of numbers (see the .Dq set phone -command). The default is 3 seconds. Again, if the argument is the literal -string +command). +The default is 3 seconds. +Again, if the argument is the literal string .Sq Li random , the delay period is a random value between 1 and 30 seconds. .It Ar attempts is the maximum number of times to try to connect for each outgoing packet -that triggers a dial. The previous value is unchanged if this parameter -is omitted. If a value of zero is specified for +that triggers a dial. +The previous value is unchanged if this parameter is omitted. +If a value of zero is specified for .Ar attempts , .Nm will keep trying until a connection is made. @@ -959,7 +1016,8 @@ set redial 10.3 4 .Pp will attempt to connect 4 times for each outgoing packet that causes a dial attempt with a 3 second delay between each number and a 10 second -delay after all numbers have been tried. If multiple phone numbers +delay after all numbers have been tried. +If multiple phone numbers are specified, the total number of attempts is still 4 (it does not attempt each number 4 times). .Pp @@ -971,11 +1029,14 @@ set redial 10+10-5.3 20 .Pp tells .Nm -to attempt to connect 20 times. After the first attempt, +to attempt to connect 20 times. +After the first attempt, .Nm -pauses for 10 seconds. After the next attempt it pauses for 20 seconds -and so on until after the sixth attempt it pauses for 1 minute. The next -14 pauses will also have a duration of one minute. If +pauses for 10 seconds. +After the next attempt it pauses for 20 seconds +and so on until after the sixth attempt it pauses for 1 minute. +The next 14 pauses will also have a duration of one minute. +If .Nm connects, disconnects and fails to connect again, the timeout starts again at 10 seconds. @@ -989,7 +1050,8 @@ If each end has the same timeout, both ends wind up calling each other at the same time if the link drops and both ends have packets queued. At some locations, the serial link may not be reliable, and carrier -may be lost at inappropriate times. It is possible to have +may be lost at inappropriate times. +It is possible to have .Nm redial should carrier be unexpectedly lost during a session. .Bd -literal -offset indent @@ -1002,7 +1064,8 @@ to re-establish the connection .Ar ntries times on loss of carrier with a pause of .Ar timeout -seconds before each try. For example, +seconds before each try. +For example, .Bd -literal -offset indent set reconnect 3 5 .Ed @@ -1011,24 +1074,28 @@ tells .Nm that on an unexpected loss of carrier, it should wait .Ar 3 -seconds before attempting to reconnect. This may happen up to +seconds before attempting to reconnect. +This may happen up to .Ar 5 times before .Nm -gives up. The default value of ntries is zero (no reconnect). Care -should be taken with this option. If the local timeout is slightly +gives up. +The default value of ntries is zero (no reconnect). +Care should be taken with this option. +If the local timeout is slightly longer than the remote timeout, the reconnect feature will always be triggered (up to the given number of times) after the remote side times out and hangs up. -NOTE: In this context, losing too many LQRs constitutes a loss of +NOTE: In this context, losing too many LQRs constitutes a loss of carrier and will trigger a reconnect. If the .Fl background flag is specified, all phone numbers are dialed at most once until -a connection is made. The next number redial period specified with -the +a connection is made. +The next number redial period specified with the .Dq set redial -command is honoured, as is the reconnect tries value. If your redial +command is honoured, as is the reconnect tries value. +If your redial value is less than the number of phone numbers specified, not all the specified numbers will be tried. To terminate the program, type @@ -1075,7 +1142,7 @@ to enable a on the port where the modem is attached. For example: .Pp -.Dl ttyd1 "/usr/libexec/getty std.38400" dialup on secure +.Dl ttyd1 "/usr/libexec/getty std.38400" dialup on secure .Pp Don't forget to send a .Dv HUP @@ -1098,7 +1165,8 @@ Direct mode .Pq Fl direct lets .Nm -work with stdin and stdout. You can also use +work with stdin and stdout. +You can also use .Xr pppctl 8 to connect to a configured diagnostic port, in the same manner as with client-side @@ -1131,7 +1199,8 @@ can be enabled using the .Dq accept dns and .Dq set nbns -commands. Refer to their descriptions below. +commands. +Refer to their descriptions below. .El .Pp .Sh RECEIVING INCOMING PPP CONNECTIONS (Method 2) @@ -1187,17 +1256,19 @@ detects a ppp connection (by recognising the HDLC frame headers), it runs .Pp It is .Em VITAL -that either PAP or CHAP are enabled as above. If they are not, you are +that either PAP or CHAP are enabled as above. +If they are not, you are allowing anybody to establish ppp session with your machine .Em without a password, opening yourself up to all sorts of potential attacks. .Sh AUTHENTICATING INCOMING CONNECTIONS Normally, the receiver of a connection requires that the peer -authenticates itself. This may be done using +authenticates itself. +This may be done using .Xr login 1 , -but alternatively, you can use PAP or CHAP. CHAP is the more secure -of the two, but some clients may not support it. Once you decide which -you wish to use, add the command +but alternatively, you can use PAP or CHAP. +CHAP is the more secure of the two, but some clients may not support it. +Once you decide which you wish to use, add the command .Sq enable chap or .Sq enable pap @@ -1206,7 +1277,8 @@ to the relevant section of .Pp You must then configure the .Pa /etc/ppp/ppp.secret -file. This file contains one line per possible client, each line +file. +This file contains one line per possible client, each line containing up to five fields: .Pp .Ar name Ar key Oo @@ -1217,7 +1289,8 @@ The .Ar name and .Ar key -specify the client username and password. If +specify the client username and password. +If .Ar key is .Dq \&* @@ -1225,8 +1298,8 @@ and PAP is being used, .Nm will look up the password database .Pq Xr passwd 5 -when authenticating. If the client does not offer a suitable -response based on any +when authenticating. +If the client does not offer a suitable response based on any .Ar name Ns No / Ns Ar key combination in .Pa ppp.secret , @@ -1235,7 +1308,8 @@ authentication fails. If authentication is successful, .Ar hisaddr .Pq if specified -is used when negotiating IP numbers. See the +is used when negotiating IP numbers. +See the .Dq set ifaddr command for details. .Pp @@ -1255,13 +1329,15 @@ is specified and .Dq set callback has been used in .Pa ppp.conf , -the client will be called back on the given number. If CBCP is being used, +the client will be called back on the given number. +If CBCP is being used, .Ar callback-number may also contain a list of numbers or a .Dq \&* , as if passed to the .Dq set cbcp -command. The value will be used in +command. +The value will be used in .Nm Ns No 's subsequent CBCP phase. .Sh PPP OVER TCP and UDP (a.k.a Tunnelling) @@ -1276,13 +1352,15 @@ device: Instead of opening a serial device, .Nm will open a TCP connection to the given machine on the given -socket. It should be noted however that +socket. +It should be noted however that .Nm doesn't use the telnet protocol and will be unable to negotiate -with a telnet server. You should set up a port for receiving this +with a telnet server. +You should set up a port for receiving this .Em PPP -connection on the receiving machine (ui-gate). This is -done by first updating +connection on the receiving machine (ui-gate). +This is done by first updating .Pa /etc/services to name the service: .Pp @@ -1314,8 +1392,8 @@ ppp-in: add 10.0.1.0/24 10.0.4.2 .Ed .Pp -You may also want to enable PAP or CHAP for security. To enable PAP, add -the following line: +You may also want to enable PAP or CHAP for security. +To enable PAP, add the following line: .Bd -literal -offset indent enable PAP .Ed @@ -1375,15 +1453,18 @@ The major disadvantage of this mechanism is that there are two "guaranteed delivery" mechanisms in place - the underlying TCP stream and whatever protocol is used over the .Em PPP -link - probably TCP again. If packets are lost, both levels will +link - probably TCP again. +If packets are lost, both levels will get in each others way trying to negotiate sending of the missing packet. .Pp To avoid this overhead, it is also possible to do all this using UDP instead of TCP as the transport by simply changing the protocol -from "tcp" to "udp". When using UDP as a transport, +from "tcp" to "udp". +When using UDP as a transport, .Nm -will operate in synchronous mode. This is another gain as the incoming +will operate in synchronous mode. +This is another gain as the incoming data does not have to be rearranged into packets. .Pp .Sh NETWORK ADDRESS TRANSLATION (PACKET ALIASING) @@ -1391,11 +1472,12 @@ The .Fl nat .Pq \&or Fl alias command line option enables network address translation (a.k.a. packet -aliasing). This allows the +aliasing). +This allows the .Nm host to act as a masquerading gateway for other computers over -a local area network. Outgoing IP packets are aliased so that -they appear to come from the +a local area network. +Outgoing IP packets are aliased so that they appear to come from the .Nm host, and incoming packets are de-aliased so that they are routed to the correct machine on the local area network. @@ -1414,13 +1496,15 @@ option should be switched on, and network applications (web browser, .Xr traceroute 8 ) should be checked on the .Nm -host. Finally, the same or similar applications should be checked on other +host. +Finally, the same or similar applications should be checked on other computers in the LAN. If network applications work correctly on the .Nm host, but not on other machines in the LAN, then the masquerading software is working properly, but the host is either not forwarding -or possibly receiving IP packets. Check that IP forwarding is enabled in +or possibly receiving IP packets. +Check that IP forwarding is enabled in .Pa /etc/rc.conf and that other machines have designated the .Nm @@ -1436,7 +1520,8 @@ filter, the .Em dial filter and the .Em alive -filter. Here are the basics: +filter. +Here are the basics: .Bl -bullet .It A filter definition has the following syntax: @@ -1472,7 +1557,8 @@ is a numeric value between .Sq 0 and .Sq 39 -specifying the rule number. Rules are specified in numeric order according to +specifying the rule number. +Rules are specified in numeric order according to .Ar rule-no , but only if rule .Sq 0 @@ -1489,7 +1575,8 @@ is taken immediately. can also be specified as .Sq clear to clear the action associated with that particular rule, or as a new -rule number greater than the current rule. In this case, if a given +rule number greater than the current rule. +In this case, if a given packet matches the current rule, the packet will next be matched against the new rule number (rather than the next rule number). .Pp @@ -1504,7 +1591,8 @@ to reverse the sense of the following match. .Op Ar src_addr Ns Op / Ns Ar width and .Op Ar dst_addr Ns Op / Ns Ar width -are the source and destination IP number specifications. If +are the source and destination IP number specifications. +If .Op / Ns Ar width is specified, it gives the number of relevant netmask bits, allowing the specification of an address range. @@ -1519,9 +1607,10 @@ or .Dv HISADDR (refer to the description of the .Dq bg -command for a description of these values). When these values are used, -the filters will be updated any time the values change. This is similar -to the behaviour of the +command for a description of these values). +When these values are used, +the filters will be updated any time the values change. +This is similar to the behaviour of the .Dq add command below. .It @@ -1582,7 +1671,7 @@ commands: ppp ON awfulhak> set timeout 600 .Ed .Pp -The timeout period is measured in seconds, the default value for which +The timeout period is measured in seconds, the default value for which is 180 seconds .Pq or 3 min . To disable the idle timer function, use the command @@ -1594,15 +1683,16 @@ In .Fl ddial and .Fl dedicated -modes, the idle timeout is ignored. In +modes, the idle timeout is ignored. +In .Fl auto mode, when the idle timeout causes the .Em PPP session to be closed, the .Nm -program itself remains running. Another trigger packet will cause it to -attempt to re-establish the link. +program itself remains running. +Another trigger packet will cause it to attempt to re-establish the link. .Sh PREDICTOR-1 and DEFLATE COMPRESSION .Nm supports both Predictor type 1 and deflate compression. @@ -1628,13 +1718,16 @@ and .Pp By default, when negotiating DEFLATE, .Nm -will use a window size of 15. Refer to the +will use a window size of 15. +Refer to the .Dq set deflate command if you wish to change this behaviour. .Pp A special algorithm called DEFLATE24 is also available, and is disabled -and denied by default. This is exactly the same as DEFLATE except that -it uses CCP ID 24 to negotiate. This allows +and denied by default. +This is exactly the same as DEFLATE except that +it uses CCP ID 24 to negotiate. +This allows .Nm to successfully negotiate DEFLATE with .Nm pppd @@ -1646,7 +1739,8 @@ Each side of the connection specifies the IP address that it's willing to use, and if the requested IP address is acceptable then .Nm -returns ACK to the requester. Otherwise, +returns ACK to the requester. +Otherwise, .Nm returns NAK to suggest that the peer use a different IP address. When @@ -1684,7 +1778,8 @@ defaults to whatever mask is appropriate for .Sq src_addr . It is only possible to make .Sq netmask -smaller than the default. The usual value is 255.255.255.255, as +smaller than the default. +The usual value is 255.255.255.255, as most kernels ignore the netmask of a POINTOPOINT interface. .Pp Some incorrect @@ -1694,7 +1789,8 @@ address instead of .Sq src_addr . If this is the case, .Sq trigger_addr -may be used to specify this IP number. This will not affect the +may be used to specify this IP number. +This will not affect the routing table unless the other side agrees with this proposed number. .Bd -literal -offset indent set ifaddr 192.244.177.38 192.244.177.2 255.255.255.255 0.0.0.0 @@ -1717,8 +1813,8 @@ The routing table entry will have a netmask of 0xffffffff. .Pp This is all fine when each side has a pre-determined IP address, however it is often the case that one side is acting as a server which controls -all IP addresses and the other side should go along with it. In order -to allow more flexible behaviour, the +all IP addresses and the other side should go along with it. +In order to allow more flexible behaviour, the .Dq set ifaddr command allows the user to specify IP addresses more loosely: .Pp @@ -1726,8 +1822,8 @@ command allows the user to specify IP addresses more loosely: .Pp A number followed by a slash .Pq Dq / -represents the number of bits significant in the IP address. The above -example means: +represents the number of bits significant in the IP address. +The above example means: .Pp .Bl -bullet -compact .It @@ -1742,8 +1838,8 @@ As you may have already noticed, 192.244.177.2 is equivalent to saying 192.244.177.2/32. .It As an exception, 0 is equivalent to 0.0.0.0/0, meaning that I have no -preferred IP address and will obey the remote peers selection. When -using zero, no routing table entries will be made until a connection +preferred IP address and will obey the remote peers selection. +When using zero, no routing table entries will be made until a connection is established. .It 192.244.177.2/0 means that I'll accept/permit any IP address but I'll @@ -1756,7 +1852,8 @@ The following steps should be taken when connecting to your ISP: .It Describe your providers phone number(s) in the dial script using the .Dq set phone -command. This command allows you to set multiple phone numbers for +command. +This command allows you to set multiple phone numbers for dialing and redialing separated by either a pipe .Pq Dq \&| or a colon @@ -1770,22 +1867,29 @@ or a colon .Ed .Pp Numbers after the first in a pipe-separated list are only used if the -previous number was used in a failed dial or login script. Numbers +previous number was used in a failed dial or login script. +Numbers separated by a colon are used sequentially, irrespective of what happened -as a result of using the previous number. For example: +as a result of using the previous number. +For example: .Bd -literal -offset indent set phone "1234567|2345678:3456789|4567890" .Ed .Pp -Here, the 1234567 number is attempted. If the dial or login script fails, +Here, the 1234567 number is attempted. +If the dial or login script fails, the 2345678 number is used next time, but *only* if the dial or login script -fails. On the dial after this, the 3456789 number is used. The 4567890 -number is only used if the dial or login script using the 3456789 fails. If -the login script of the 2345678 number fails, the next number is still the -3456789 number. As many pipes and colons can be used as are necessary +fails. +On the dial after this, the 3456789 number is used. +The 4567890 +number is only used if the dial or login script using the 3456789 fails. +If the login script of the 2345678 number fails, the next number is still the +3456789 number. +As many pipes and colons can be used as are necessary (although a given site would usually prefer to use either the pipe or the -colon, but not both). The next number redial timeout is used between all -numbers. When the end of the list is reached, the normal redial period is +colon, but not both). +The next number redial timeout is used between all numbers. +When the end of the list is reached, the normal redial period is used before starting at the beginning again. The selected phone number is substituted for the \\\\T string in the .Dq set dial @@ -1807,7 +1911,8 @@ Describe your login procedure using the .Dq set dial and .Dq set login -commands. The +commands. +The .Dq set dial command is used to talk to your modem and establish a link with your ISP, for example: @@ -1827,7 +1932,8 @@ Expect nothing. .It Send ATZ. .It -Expect OK. If that's not received within the 4 second timeout, send ATZ +Expect OK. +If that's not received within the 4 second timeout, send ATZ and expect OK. .It Send ATDTxxxxxxx where xxxxxxx is the next number in the phone list from @@ -1838,8 +1944,8 @@ Set the timeout to 60. Wait for the CONNECT string. .El .Pp -Once the connection is established, the login script is executed. This -script is written in the same style as the dial script, but care should +Once the connection is established, the login script is executed. +This script is written in the same style as the dial script, but care should be taken to avoid having your password logged: .Bd -literal -offset indent set authkey MySecret @@ -1852,7 +1958,8 @@ This login "chat" string means: .It Set the timeout to 15 seconds. .It -Expect "login:". If it's not received, send a carriage return and expect +Expect "login:". +If it's not received, send a carriage return and expect "login:" again. .It Send "awfulhak" @@ -1872,7 +1979,8 @@ Expect "HELLO". .Pp The .Dq set authkey -command is logged specially. When +command is logged specially. +When .Ar command or .Ar chat @@ -1880,8 +1988,8 @@ logging is enabled, the actual password is not logged; .Sq ******** Ns is logged instead. .Pp -Login scripts vary greatly between ISPs. If you're setting one up -for the first time, +Login scripts vary greatly between ISPs. +If you're setting one up for the first time, .Em ENABLE CHAT LOGGING so that you can see if your script is behaving as you expect. .It @@ -1895,11 +2003,16 @@ set device /dev/cua00 set speed 115200 .Ed .Pp -Cuaa0 is the first serial port on FreeBSD. If you're running +Cuaa0 is the first serial port on +.Fx . +If you're running .Nm -on OpenBSD, cua00 is the first. A speed of 115200 should be specified -if you have a modem capable of bit rates of 28800 or more. In general, -the serial speed should be about four times the modem speed. +on +.Ox , +cua00 is the first. +A speed of 115200 should be specified +if you have a modem capable of bit rates of 28800 or more. +In general, the serial speed should be about four times the modem speed. .It Use the .Dq set ifaddr @@ -1913,15 +2026,17 @@ If your provider has assigned a particular IP address to you, then use it as your address (src_addr). .It If your provider assigns your address dynamically, choose a suitably -unobtrusive and unspecific IP number as your address. 10.0.0.1/0 would -be appropriate. The bit after the / specifies how many bits of the +unobtrusive and unspecific IP number as your address. +10.0.0.1/0 would be appropriate. +The bit after the / specifies how many bits of the address you consider to be important, so if you wanted to insist on something in the class C network 1.2.3.0, you could specify 1.2.3.1/24. .It If you find that your ISP accepts the first IP number that you suggest, specify third and forth arguments of .Dq 0.0.0.0 . -This will force your ISP to assign a number. (The third argument will +This will force your ISP to assign a number. +(The third argument will be ignored as it is less restrictive than the default mask for your .Sq src_addr . .El @@ -1933,8 +2048,8 @@ set ifaddr 10.0.0.1/0 10.0.0.2/0 0.0.0.0 0.0.0.0 .Ed .Pp .It -In most cases, your ISP will also be your default router. If this is -the case, add the line +In most cases, your ISP will also be your default router. +If this is the case, add the line .Bd -literal -offset indent add default HISADDR .Ed @@ -1956,7 +2071,8 @@ Previous versions of .Nm required a similar entry in the .Pa /etc/ppp/ppp.linkup -file. Since the advent of +file. +Since the advent of .Sq sticky routes , this is no longer required. .It @@ -1999,8 +2115,8 @@ Please refer to .Pa /etc/ppp/ppp.conf.sample and .Pa /etc/ppp/ppp.linkup.sample -for some real examples. The pmdemand label should be appropriate for most -ISPs. +for some real examples. +The pmdemand label should be appropriate for most ISPs. .Sh LOGGING FACILITY .Nm is able to generate the following log info either via @@ -2054,7 +2170,8 @@ Log timer manipulation. .It Li TUN Include the tun device on each log line. .It Li Warning -Output to the terminal device. If there is currently no terminal, +Output to the terminal device. +If there is currently no terminal, output is sent to the log file using syslogs .Dv LOG_WARNING . .It Li Error @@ -2068,12 +2185,13 @@ Output to the log file using .Pp The .Dq set log -command allows you to set the logging output level. Multiple levels -can be specified on a single command line. The default is equivalent to +command allows you to set the logging output level. +Multiple levels can be specified on a single command line. +The default is equivalent to .Dq set log Phase . .Pp -It is also possible to log directly to the screen. The syntax is -the same except that the word +It is also possible to log directly to the screen. +The syntax is the same except that the word .Dq local should immediately follow .Dq set log . @@ -2115,7 +2233,8 @@ deals with the following signals: .Bl -tag -width XX .It INT Receipt of this signal causes the termination of the current connection -(if any). This will cause +(if any). +This will cause .Nm to exit unless it is in .Fl auto @@ -2138,29 +2257,32 @@ If you wish to use more than one physical link to connect to a .Em PPP peer, that peer must also understand the .Em MULTI-LINK PPP -protocol. Refer to RFC 1990 for specification details. +protocol. +Refer to RFC 1990 for specification details. .Pp The peer is identified using a combination of his .Dq endpoint discriminator and his .Dq authentication id . -Either or both of these may be specified. It is recommended that +Either or both of these may be specified. +It is recommended that at least one is specified, otherwise there is no way of ensuring that all links are actually connected to the same peer program, and some -confusing lock-ups may result. Locally, these identification variables -are specified using the +confusing lock-ups may result. +Locally, these identification variables are specified using the .Dq set enddisc and .Dq set authname -commands. The +commands. +The .Sq authname .Pq and Sq authkey must be agreed in advance with the peer. .Pp Multi-link capabilities are enabled using the .Dq set mrru -command (set maximum reconstructed receive unit). Once multi-link -is enabled, +command (set maximum reconstructed receive unit). +Once multi-link is enabled, .Nm will attempt to negotiate a multi-link connection with the peer. .Pp @@ -2170,7 +2292,8 @@ is available .Pq called Sq deflink . To create more links, the .Dq clone -command is used. This command will clone existing links, where all +command is used. +This command will clone existing links, where all characteristics are the same except: .Bl -enum .It @@ -2180,7 +2303,8 @@ command line. .It The new link is an .Sq interactive -link. It's mode may subsequently be changed using the +link. +Its mode may subsequently be changed using the .Dq set mode command. .It @@ -2193,11 +2317,11 @@ A summary of all available links can be seen using the .Dq show links command. .Pp -Once a new link has been created, command usage varies. All link -specific commands must be prefixed with the +Once a new link has been created, command usage varies. +All link specific commands must be prefixed with the .Dq link Ar name -command, specifying on which link the command is to be applied. When -only a single link is available, +command, specifying on which link the command is to be applied. +When only a single link is available, .Nm is smart enough not to require the .Dq link Ar name @@ -2206,7 +2330,8 @@ prefix. Some commands can still be used without specifying a link - resulting in an operation at the .Sq bundle -level. For example, once two or more links are available, the command +level. +For example, once two or more links are available, the command .Dq show ccp will show CCP configuration and statistics at the multi-link level, and .Dq link deflink show ccp @@ -2234,8 +2359,9 @@ mp: link deflink remove .Ed .Pp -Note how all cloning is done at the end of the configuration. Usually, -the link will be configured first, then cloned. If you wish all links +Note how all cloning is done at the end of the configuration. +Usually, the link will be configured first, then cloned. +If you wish all links to be up all the time, you can add the following line to the end of your configuration. .Pp @@ -2274,10 +2400,12 @@ has negotiated .Em MULTI-LINK mode with the peer, it creates a local domain socket in the .Pa /var/run -directory. This socket is used to pass link information (including +directory. +This socket is used to pass link information (including the actual link file descriptor) between different .Nm -invocations. This facilitates +invocations. +This facilitates .Nm Ns No 's ability to be run from a .Xr getty 8 @@ -2286,16 +2414,18 @@ or directly from (using the .Sq pp= capability), without needing to have initial control of the serial -line. Once +line. +Once .Nm negotiates multi-link mode, it will pass its open link to any -already running process. If there is no already running process, +already running process. +If there is no already running process, .Nm will act as the master, creating the socket and listening for new connections. .Sh PPP COMMAND LIST -This section lists the available commands and their effect. They are -usable either from an interactive +This section lists the available commands and their effect. +They are usable either from an interactive .Nm session, from a configuration file or from a .Xr pppctl 8 @@ -2306,7 +2436,8 @@ session. .It accept|deny|enable|disable Ar option.... These directives tell .Nm -how to negotiate the initial connection with the peer. Each +how to negotiate the initial connection with the peer. +Each .Dq option has a default of either accept or deny and enable or disable. .Dq Accept @@ -2322,10 +2453,12 @@ means that the option will not be requested by us. may be one of the following: .Bl -tag -width XX .It acfcomp -Default: Enabled and Accepted. ACFComp stands for Address and Control -Field Compression. Non LCP packets will usually have an address +Default: Enabled and Accepted. +ACFComp stands for Address and Control Field Compression. +Non LCP packets will usually have an address field of 0xff (the All-Stations address) and a control field of -0x03 (the Unnumbered Information command). If this option is +0x03 (the Unnumbered Information command). +If this option is negotiated, these two bytes are simply not sent, thus minimising traffic. .Pp @@ -2333,16 +2466,18 @@ See .Pa rfc1662 for details. .It chap Ns Op \&05 -Default: Disabled and Accepted. CHAP stands for Challenge Handshake -Authentication Protocol. Only one of CHAP and PAP (below) may be -negotiated. With CHAP, the authenticator sends a "challenge" message -to its peer. The peer uses a one-way hash function to encrypt the -challenge and sends the result back. The authenticator does the same, -and compares the results. The advantage of this mechanism is that no +Default: Disabled and Accepted. +CHAP stands for Challenge Handshake Authentication Protocol. +Only one of CHAP and PAP (below) may be negotiated. +With CHAP, the authenticator sends a "challenge" message to its peer. +The peer uses a one-way hash function to encrypt the +challenge and sends the result back. +The authenticator does the same, and compares the results. +The advantage of this mechanism is that no passwords are sent across the connection. -A challenge is made when the connection is first made. Subsequent -challenges may occur. If you want to have your peer authenticate -itself, you must +A challenge is made when the connection is first made. +Subsequent challenges may occur. +If you want to have your peer authenticate itself, you must .Dq enable chap . in .Pa /etc/ppp/ppp.conf , @@ -2360,12 +2495,15 @@ CHAP is accepted by default. Some .Em PPP implementations use "MS-CHAP" rather than MD5 when encrypting the -challenge. MS-CHAP is a combination of MD4 and DES. If +challenge. +MS-CHAP is a combination of MD4 and DES. +If .Nm was built on a machine with DES libraries available, it will respond to MS-CHAP authentication requests, but will never request them. .It deflate -Default: Enabled and Accepted. This option decides if deflate +Default: Enabled and Accepted. +This option decides if deflate compression will be used by the Compression Control Protocol (CCP). This is the same algorithm as used by the .Xr gzip 1 @@ -2402,16 +2540,20 @@ is and .Ar accept Ns No ed . .It deflate24 -Default: Disabled and Denied. This is a variance of the +Default: Disabled and Denied. +This is a variance of the .Ar deflate option, allowing negotiation with the .Xr pppd 8 -program. Refer to the +program. +Refer to the .Ar deflate -section above for details. It is disabled by default as it violates +section above for details. +It is disabled by default as it violates .Pa rfc1975 . .It dns -Default: Disabled and Denied. This option allows DNS negotiation. +Default: Disabled and Denied. +This option allows DNS negotiation. .Pp If .Dq enable Ns No d, @@ -2426,22 +2568,27 @@ If .Dq accept Ns No ed, .Nm will answer any DNS queries requested by the peer rather than rejecting -them. The answer is taken from +them. +The answer is taken from .Pa /etc/resolv.conf unless the .Dq set dns command is used as an override. .It enddisc -Default: Enabled and Accepted. This option allows control over whether we -negotiate an endpoint discriminator. We only send our discriminator if +Default: Enabled and Accepted. +This option allows control over whether we +negotiate an endpoint discriminator. +We only send our discriminator if .Dq set enddisc is used and .Ar enddisc -is enabled. We reject the peers discriminator if +is enabled. +We reject the peers discriminator if .Ar enddisc is denied. .It LANMan|chap80lm -Default: Disabled and Accepted. The use of this authentication protocol +Default: Disabled and Accepted. +The use of this authentication protocol is discouraged as it partially violates the authentication protocol by implementing two different mechanisms (LANMan & NT) under the guise of a single CHAP type (0x80). @@ -2453,41 +2600,50 @@ Refer to the .Dq MSChap description below for more details. .It lqr -Default: Disabled and Accepted. This option decides if Link Quality -Requests will be sent or accepted. LQR is a protocol that allows +Default: Disabled and Accepted. +This option decides if Link Quality Requests will be sent or accepted. +LQR is a protocol that allows .Nm to determine that the link is down without relying on the modems -carrier detect. When LQR is enabled, +carrier detect. +When LQR is enabled, .Nm sends the .Em QUALPROTO option (see .Dq set lqrperiod -below) as part of the LCP request. If the peer agrees, both sides will +below) as part of the LCP request. +If the peer agrees, both sides will exchange LQR packets at the agreed frequency, allowing detailed link -quality monitoring by enabling LQM logging. If the peer doesn't agree, -ppp will send ECHO LQR requests instead. These packets pass no -information of interest, but they +quality monitoring by enabling LQM logging. +If the peer doesn't agree, +.Nm +will send ECHO LQR requests instead. +These packets pass no information of interest, but they .Em MUST be replied to by the peer. .Pp Whether using LQR or ECHO LQR, .Nm will abruptly drop the connection if 5 unacknowledged packets have been -sent rather than sending a 6th. A message is logged at the +sent rather than sending a 6th. +A message is logged at the .Em PHASE level, and any appropriate .Dq reconnect values are honoured as if the peer were responsible for dropping the connection. .It MSChap|chap80nt -Default: Disabled and Accepted. The use of this authentication protocol +Default: Disabled and Accepted. +The use of this authentication protocol is discouraged as it partially violates the authentication protocol by implementing two different mechanisms (LANMan & NT) under the guise of -a single CHAP type (0x80). It is very similar to standard CHAP (type 0x05) +a single CHAP type (0x80). +It is very similar to standard CHAP (type 0x05) except that it issues challenges of a fixed 8 bytes in length and uses a combination of MD4 and DES to encrypt the challenge rather than using the -standard MD5 mechanism. CHAP type 0x80 for LANMan is also supported - see +standard MD5 mechanism. +CHAP type 0x80 for LANMan is also supported - see .Dq enable LANMan for details. .Pp @@ -2499,8 +2655,8 @@ use CHAP type 0x80, when acting as authenticator with both .Dq enable Ns No d , .Nm will rechallenge the peer up to three times if it responds using the wrong -one of the two protocols. This gives the peer a chance to attempt using -both protocols. +one of the two protocols. +This gives the peer a chance to attempt using both protocols. .Pp Conversely, when .Nm @@ -2508,18 +2664,20 @@ acts as the authenticatee with both protocols .Dq accept Ns No ed , the protocols are used alternately in response to challenges. .Pp -Note: If only LANMan is enabled, +Note: If only LANMan is enabled, .Xr pppd 8 -(version 2.3.5) misbehaves when acting as authenticatee. It provides both +(version 2.3.5) misbehaves when acting as authenticatee. +It provides both the NT and the LANMan answers, but also suggests that only the NT answer should be used. .It pap -Default: Disabled and Accepted. PAP stands for Password Authentication -Protocol. Only one of PAP and CHAP (above) may be negotiated. With -PAP, the ID and Password are sent repeatedly to the peer until -authentication is acknowledged or the connection is terminated. This -is a rather poor security mechanism. It is only performed when the -connection is first established. +Default: Disabled and Accepted. +PAP stands for Password Authentication Protocol. +Only one of PAP and CHAP (above) may be negotiated. +With PAP, the ID and Password are sent repeatedly to the peer until +authentication is acknowledged or the connection is terminated. +This is a rather poor security mechanism. +It is only performed when the connection is first established. If you want to have your peer authenticate itself, you must .Dq enable pap . in @@ -2540,29 +2698,33 @@ in .Pa /etc/ppp/ppp.conf . PAP is accepted by default. .It pred1 -Default: Enabled and Accepted. This option decides if Predictor 1 +Default: Enabled and Accepted. +This option decides if Predictor 1 compression will be used by the Compression Control Protocol (CCP). .It protocomp -Default: Enabled and Accepted. This option is used to negotiate +Default: Enabled and Accepted. +This option is used to negotiate PFC (Protocol Field Compression), a mechanism where the protocol field number is reduced to one octet rather than two. .It shortseq -Default: Enabled and Accepted. This option determines if +Default: Enabled and Accepted. +This option determines if .Nm will request and accept requests for short .Pq 12 bit -sequence numbers when negotiating multi-link mode. This is only -applicable if our MRRU is set (thus enabling multi-link). +sequence numbers when negotiating multi-link mode. +This is only applicable if our MRRU is set (thus enabling multi-link). .It vjcomp -Default: Enabled and Accepted. This option determines if Van Jacobson -header compression will be used. +Default: Enabled and Accepted. +This option determines if Van Jacobson header compression will be used. .El .Pp The following options are not actually negotiated with the peer. Therefore, accepting or denying them makes no sense. .Bl -tag -width XX .It idcheck -Default: Enabled. When +Default: Enabled. +When .Nm exchanges low-level LCP, CCP and IPCP configuration traffic, the .Em Identifier @@ -2570,17 +2732,20 @@ field of any replies is expected to be the same as that of the request. By default, .Nm drops any reply packets that do not contain the expected identifier -field, reporting the fact at the respective log level. If +field, reporting the fact at the respective log level. +If .Ar idcheck is disabled, .Nm will ignore the identifier field. .It keep-session -Default: Disabled. When +Default: Disabled. +When .Nm runs as a Multi-link server, a different .Nm -instance initially receives each connection. After determining that +instance initially receives each connection. +After determining that the link belongs to an already existing bundle (controlled by another .Nm invocation), @@ -2606,42 +2771,50 @@ from being started, and for program links such as .Xr sshd 8 , it prevents .Xr sshd 8 -from exiting due to the death of its child. As +from exiting due to the death of its child. +As .Nm cannot determine its parents requirements (except for the tty case), this option must be enabled manually depending on the circumstances. .It loopback -Default: Enabled. When +Default: Enabled. +When .Ar loopback is enabled, .Nm will automatically loop back packets being sent out with a destination address equal to that of the .Em PPP -interface. If disabled, +interface. +If disabled, .Nm will send the packet, probably resulting in an ICMP redirect from -the other end. It is convenient to have this option enabled when +the other end. +It is convenient to have this option enabled when the interface is also the default route as it avoids the necessity of a loopback route. .It passwdauth -Default: Disabled. Enabling this option will tell the PAP authentication +Default: Disabled. +Enabling this option will tell the PAP authentication code to use the password database (see .Xr passwd 5 ) to authenticate the caller if they cannot be found in the .Pa /etc/ppp/ppp.secret file. .Pa /etc/ppp/ppp.secret -is always checked first. If you wish to use passwords from +is always checked first. +If you wish to use passwords from .Xr passwd 5 , but also to specify an IP number or label for a given client, use .Dq \&* as the client password in .Pa /etc/ppp/ppp.secret . .It proxy -Default: Disabled. Enabling this option will tell +Default: Disabled. +Enabling this option will tell .Nm -to proxy ARP for the peer. This means that +to proxy ARP for the peer. +This means that .Nm will make an entry in the ARP table using .Dv HISADDR @@ -2649,11 +2822,13 @@ and the .Dv MAC address of the local network in which .Dv HISADDR -appears. The proxy entry cannot be made unless +appears. +The proxy entry cannot be made unless .Dv HISADDR is an address from a LAN. .It proxyall -Default: Disabled. Enabling this will tell +Default: Disabled. +Enabling this will tell .Nm to add proxy arp entries for every IP address in all class C or smaller subnets routed via the tun interface. @@ -2661,12 +2836,14 @@ smaller subnets routed via the tun interface. Proxy arp entries are only made for sticky routes that are added using the .Dq add -command. No proxy arp entries are made for the interface address itself +command. +No proxy arp entries are made for the interface address itself (as created by the .Dq set ifaddr command). .It sroutes -Default: Enabled. When the +Default: Enabled. +When the .Dq add command is used with the .Dv HISADDR @@ -2674,7 +2851,8 @@ or .Dv MYADDR values, entries are stored in the .Sq stick route -list. Each time +list. +Each time .Dv HISADDR or .Dv MYADDR @@ -2685,34 +2863,39 @@ although the .Sq stick route list will still be maintained. .It throughput -Default: Enabled. This option tells +Default: Enabled. +This option tells .Nm -to gather throughput statistics. Input and output is sampled over -a rolling 5 second window, and current, best and total figures are -retained. This data is output when the relevant +to gather throughput statistics. +Input and output is sampled over +a rolling 5 second window, and current, best and total figures are retained. +This data is output when the relevant .Em PPP layer shuts down, and is also available using the .Dq show -command. Throughput statistics are available at the +command. +Throughput statistics are available at the .Dq IPCP and .Dq physical levels. .It utmp -Default: Enabled. Normally, when a user is authenticated using PAP or -CHAP, and when +Default: Enabled. +Normally, when a user is authenticated using PAP or CHAP, and when .Nm is running in .Fl direct -mode, an entry is made in the utmp and wtmp files for that user. Disabling -this option will tell +mode, an entry is made in the utmp and wtmp files for that user. +Disabling this option will tell .Nm -not to make any utmp or wtmp entries. This is usually only necessary if +not to make any utmp or wtmp entries. +This is usually only necessary if you require the user to both login and authenticate themselves. .It iface-alias Default: Enabled if .Fl nat -is specified. This option simply tells +is specified. +This option simply tells .Nm to add new interface addresses to the interface rather than replacing them. The option can only be enabled if network address translation is enabled @@ -2740,23 +2923,24 @@ will also disable .Op Ar gateway .Xc .Ar Dest -is the destination IP address. The netmask is specified either as a -number of bits with +is the destination IP address. +The netmask is specified either as a number of bits with .Ar /nn or as an IP number using .Ar mask . .Ar 0 0 or simply .Ar 0 -with no mask refers to the default route. It is also possible to use the -literal name +with no mask refers to the default route. +It is also possible to use the literal name .Sq default instead of .Ar 0 . .Ar Gateway is the next hop gateway to get to the given .Ar dest -machine/network. Refer to the +machine/network. +Refer to the .Xr route 8 command for further details. .Pp @@ -2799,16 +2983,18 @@ to see the list), and each time the value of .Dv DNS0 , or .Dv DNS1 -changes, the appropriate routing table entries are updated. This facility -may be disabled using +changes, the appropriate routing table entries are updated. +This facility may be disabled using .Dq disable sroutes . .It allow Ar command Op Ar args This command controls access to .Nm -and its configuration files. It is possible to allow user-level access, +and its configuration files. +It is possible to allow user-level access, depending on the configuration file label and on the mode that .Nm -is being run in. For example, you may wish to configure +is being run in. +For example, you may wish to configure .Nm so that only user .Sq fred @@ -2829,10 +3015,12 @@ By default, only user id 0 is allowed access to If this command is used, all of the listed users are allowed access to the section in which the .Dq allow users -command is found. The +command is found. +The .Sq default section is always checked first (even though it is only ever automatically -loaded at startup). Each successive +loaded at startup). +Each successive .Dq allow users command overrides the previous one, so it's possible to allow users access to everything except a given label by specifying default users in the @@ -2848,7 +3036,8 @@ is specified, access is allowed to all users. .Xc By default, access using any .Nm -mode is possible. If this command is used, it restricts the access +mode is possible. +If this command is used, it restricts the access .Ar modes allowed to load the label under which this command is specified. Again, as with the @@ -2940,8 +3129,8 @@ is either or .Dq udp . .Pp -A range of port numbers may be specified as shown above. The ranges -must be of the same size. +A range of port numbers may be specified as shown above. +The ranges must be of the same size. .Pp If .Ar remoteIP @@ -2965,7 +3154,8 @@ to translate any .Pq Dv IPPROTO_GRE packets using .Ar addr -rather than the local interface address. This allows the uses of the +rather than the local interface address. +This allows the uses of the .Em P Ns No oint to .Em P Ns No oint @@ -2981,15 +3171,16 @@ address translation is disabled. .It "nat proxy cmd" Ar arg Ns No ... This command tells .Nm -to proxy certain connections, redirecting them to a given server. Refer -to the description of +to proxy certain connections, redirecting them to a given server. +Refer to the description of .Fn PacketAliasProxyRule in .Xr libalias 3 for details of the available commands. .It nat same_ports yes|no When enabled, this command will tell the network address translation engine to - attempt to avoid changing the port number on outgoing packets. This is useful +attempt to avoid changing the port number on outgoing packets. +This is useful if you want to support protocols such as RPC and LPD which require connections to come from a well known port. .It nat use_sockets yes|no @@ -2997,8 +3188,8 @@ When enabled, this option tells the network address translation engine to create a socket so that it can guarantee a correct incoming ftp data or IRC connection. .It nat unregistered_only yes|no -Only alter outgoing packets with an unregistered source ad- -dress. According to RFC 1918, unregistered source addresses +Only alter outgoing packets with an unregistered source address. +According to RFC 1918, unregistered source addresses are 10.0.0.0/8, 172.16.0.0/12 and 192.168.0.0/16. .El .Pp @@ -3016,11 +3207,13 @@ is executed in the background with the following words replaced: .It Li AUTHNAME This is replaced with the local .Ar authname -value. See the +value. +See the .Dq set authname command below. .It Li ENDDISC -This is replaced with the local endpoint discriminator value. See the +This is replaced with the local endpoint discriminator value. +See the .Dq set enddisc command below. .It Li HISADDR @@ -3028,8 +3221,8 @@ This is replaced with the peers IP number. .It Li INTERFACE This is replaced with the name of the interface that's in use. .It Li LABEL -This is replaced with the last label name used. A label may be specified -on the +This is replaced with the last label name used. +A label may be specified on the .Nm command line, via the .Dq load @@ -3046,11 +3239,12 @@ This is replaced with the value of the peers endpoint discriminator. This is replaced with the current process id. .It Li USER This is replaced with the username that has been authenticated with PAP or -CHAP. Normally, this variable is assigned only in -direct mode. This value -is available irrespective of whether utmp logging is enabled. +CHAP. +Normally, this variable is assigned only in -direct mode. +This value is available irrespective of whether utmp logging is enabled. .It Li DNS0 No " & " Li DNS1 -These are replaced with the primary and secondary nameserver IP numbers. If -nameservers are negotiated by IPCP, the values of these macros will change. +These are replaced with the primary and secondary nameserver IP numbers. +If nameservers are negotiated by IPCP, the values of these macros will change. .El .Pp These substitutions are also done by the @@ -3067,22 +3261,25 @@ Clear the specified throughput values at either the .Dq physical or .Dq ipcp -level. If +level. +If .Dq physical is specified, context must be given (see the .Dq link -command below). If no second argument is given, all values are -cleared. +command below). +If no second argument is given, all values are cleared. .It clone Ar name Ns Xo .Op \&, Ns Ar name Ns .No ... .Xc Clone the specified link, creating one or more new links according to the .Ar name -argument(s). This command must be used from the +argument(s). +This command must be used from the .Dq link command below unless you've only got a single link (in which case that -link becomes the default). Links may be removed using the +link becomes the default). +Links may be removed using the .Dq remove command below. .Pp @@ -3090,23 +3287,27 @@ The default link name is .Dq deflink . .It close Op lcp|ccp Ns Op \&! If no arguments are given, the relevant protocol layers will be brought -down and the link will be closed. If +down and the link will be closed. +If .Dq lcp is specified, the LCP layer is brought down, but .Nm -will not bring the link offline. It is subsequently possible to use +will not bring the link offline. +It is subsequently possible to use .Dq term .Pq see below to talk to the peer machine if, for example, something like .Dq slirp -is being used. If +is being used. +If .Dq ccp -is specified, only the relevant compression layer is closed. If the +is specified, only the relevant compression layer is closed. +If the .Dq \&! is used, the compression layer will remain in the closed state, otherwise it will re-enter the STOPPED state, waiting for the peer to initiate -further CCP negotiation. In any event, this command does not disconnect -the user from +further CCP negotiation. +In any event, this command does not disconnect the user from .Nm or exit .Nm ppp . @@ -3119,14 +3320,16 @@ command below. .Xc This command deletes the route with the given .Ar dest -IP address. If +IP address. +If .Ar dest is specified as .Sq ALL , all non-direct entries in the routing table for the current interface, and all .Sq sticky route -entries are deleted. If +entries are deleted. +If .Ar dest is specified as .Sq default , @@ -3148,19 +3351,24 @@ followed by and is provided for backwards compatibility. .It down Op Ar lcp|ccp Bring the relevant layer down ungracefully, as if the underlying layer -had become unavailable. It's not considered polite to use this command on -a Finite State Machine that's in the OPEN state. If no arguments are +had become unavailable. +It's not considered polite to use this command on +a Finite State Machine that's in the OPEN state. +If no arguments are supplied, the entire link is closed (or if no context is given, all links -are terminated). If +are terminated). +If .Sq lcp is specified, the .Em LCP layer is terminated but the device is not brought offline and the link -is not closed. If +is not closed. +If .Sq ccp is specified, only the relevant compression layer(s) are terminated. .It help|? Op Ar command -Show a list of available commands. If +Show a list of available commands. +If .Ar command is specified, show the usage string for that command. .It iface Ar command Op args @@ -3182,7 +3390,8 @@ may be one of the following: .Xc Add the given .Ar addr mask peer -combination to the interface. Instead of specifying +combination to the interface. +Instead of specifying .Ar mask , .Ar /bits can be used @@ -3211,7 +3420,8 @@ If this command is used while is in the OPENED state or while in .Fl auto mode, all addresses except for the IPCP negotiated address are deleted -from the interface. If +from the interface. +If .Nm is not in the OPENED state and is not in .Fl auto @@ -3224,20 +3434,22 @@ mode, all interface addresses are deleted. .Xc This command deletes the given .Ar addr -from the interface. If the +from the interface. +If the .Dq \&! is used, no error is given if the address isn't currently assigned to the interface (and no deletion takes place). .It iface show -Shows the current state and current addresses for the interface. It is -much the same as running +Shows the current state and current addresses for the interface. +It is much the same as running .Dq ifconfig INTERFACE . .It iface help Op Ar sub-command This command, when invoked without .Ar sub-command , will show a list of possible .Dq iface -sub-commands and a brief synopsis for each. When invoked with +sub-commands and a brief synopsis for each. +When invoked with .Ar sub-command , only the synopsis for the given sub-command is shown. .El @@ -3247,18 +3459,20 @@ only the synopsis for the given sub-command is shown. .No ... Ar command Op Ar args .Xc This command may prefix any other command if the user wishes to -specify which link the command should affect. This is only -applicable after multiple links have been created in Multi-link +specify which link the command should affect. +This is only applicable after multiple links have been created in Multi-link mode using the .Dq clone command. .Pp .Ar Name -specifies the name of an existing link. If +specifies the name of an existing link. +If .Ar name is a comma separated list, .Ar command -is executed on each link. If +is executed on each link. +If .Ar name is .Dq * , @@ -3271,7 +3485,8 @@ Load the given .Ar label Ns No (s) from the .Pa ppp.conf -file. If +file. +If .Ar label is not given, the .Ar default @@ -3290,8 +3505,8 @@ will not attempt to make an immediate connection. .It open Op lcp|ccp|ipcp This is the opposite of the .Dq close -command. All closed links are immediately brought up apart from second -and subsequent +command. +All closed links are immediately brought up apart from second and subsequent .Ar demand-dial links - these will come up based on the .Dq set autoload @@ -3300,15 +3515,17 @@ command that has been used. If the .Dq lcp argument is used while the LCP layer is already open, LCP will be -renegotiated. This allows various LCP options to be changed, after which +renegotiated. +This allows various LCP options to be changed, after which .Dq open lcp -can be used to put them into effect. After renegotiating LCP, +can be used to put them into effect. +After renegotiating LCP, any agreed authentication will also take place. .Pp If the .Dq ccp -argument is used, the relevant compression layer is opened. Again, -if it is already open, it will be renegotiated. +argument is used, the relevant compression layer is opened. +Again, if it is already open, it will be renegotiated. .Pp If the .Dq ipcp @@ -3324,14 +3541,15 @@ however useful as a way of forcing the CCP or VJ dictionaries to be reset. .It passwd Ar pass Specify the password required for access to the full .Nm -command set. This password is required when connecting to the diagnostic -port (see the +command set. +This password is required when connecting to the diagnostic port (see the .Dq set server command). .Ar Pass is specified on the .Dq set server -command line. The value of +command line. +The value of .Ar pass is not logged when .Ar command @@ -3342,7 +3560,8 @@ is logged. If .Dq quit is executed from the controlling connection or from a command file, -ppp will exit after closing all connections. Otherwise, if the user +ppp will exit after closing all connections. +Otherwise, if the user is connected to a diagnostic socket, the connection is simply dropped. .Pp If the @@ -3352,9 +3571,9 @@ argument is given, will exit despite the source of the command after closing all existing connections. .It remove|rm -This command removes the given link. It is only really useful in -multi-link mode. A link must be -in the +This command removes the given link. +It is only really useful in multi-link mode. +A link must be in the .Dv CLOSED state before it is removed. .It rename|mv Ar name @@ -3377,7 +3596,8 @@ This command controls .Nm Ns No 's manipulation of the .Xr resolv.conf 5 -file. When +file. +When .Nm starts up, it loads the contents of this file into memory and retains this image for future use. @@ -3387,7 +3607,8 @@ is one of the following: .It Em readonly Treat .Pa /etc/resolv.conf -as read only. If +as read only. +If .Dq dns is enabled, .Nm @@ -3396,28 +3617,33 @@ available via the .Dv DNS0 and .Dv DNS1 -macros. This is the opposite of the +macros. +This is the opposite of the .Dq resolv writable command. .It Em reload Reload .Pa /etc/resolv.conf -into memory. This may be necessary if for example a DHCP client overwrote +into memory. +This may be necessary if for example a DHCP client overwrote .Pa /etc/resolv.conf . .It Em restore Replace .Pa /etc/resolv.conf with the version originally read at startup or with the last .Dq resolv reload -command. This is sometimes a useful command to put in the +command. +This is sometimes a useful command to put in the .Pa /etc/ppp/ppp.linkdown file. .It Em rewrite Rewrite the .Pa /etc/resolv.conf -file. This command will work even if the +file. +This command will work even if the .Dq resolv readonly -command has been used. It may be useful as a command in the +command has been used. +It may be useful as a command in the .Pa /etc/ppp/ppp.linkup file if you wish to defer updating .Pa /etc/resolv.conf @@ -3431,7 +3657,8 @@ if .Dq dns is enabled and .Nm -successfully negotiates a DNS. This is the opposite of the +successfully negotiates a DNS. +This is the opposite of the .Dq resolv readonly command. .El @@ -3444,7 +3671,8 @@ This option is not (yet) implemented. This option allows the setting of any of the following variables: .Bl -tag -width XX .It set accmap Ar hex-value -ACCMap stands for Asynchronous Control Character Map. This is always +ACCMap stands for Asynchronous Control Character Map. +This is always negotiated with the peer, and defaults to a value of 00000000 in hex. This protocol is required to defeat hardware that depends on passing certain characters from end to end (such as XON/XOFF etc). @@ -3455,10 +3683,12 @@ For the XON/XOFF scenario, use .No key Ar value .Xc This sets the authentication key (or password) used in client mode -PAP or CHAP negotiation to the given value. It also specifies the +PAP or CHAP negotiation to the given value. +It also specifies the password to be used in the dial or login scripts in place of the .Sq \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\P -sequence, preventing the actual password from being logged. If +sequence, preventing the actual password from being logged. +If .Ar command or .Ar chat @@ -3485,7 +3715,8 @@ Ignoring the .Ar value is parsed as a program to execute in the same was as the .Dq !bg -command above, substituting special names in the same manner. Once executed, +command above, substituting special names in the same manner. +Once executed, .Nm will feed the program three lines of input, each terminated by a newline character: @@ -3515,7 +3746,8 @@ in the CHAP response packet. When configuring .Nm in this manner, it's expected that the host challenge is a series of ASCII -digits or characters. An encryption device or Secure ID card is usually +digits or characters. +An encryption device or Secure ID card is usually required to calculate the secret appropriate for the given challenge. .It set authname Ar id This sets the authentication id used in client mode PAP or CHAP negotiation. @@ -3536,13 +3768,15 @@ When more than one .Pq also known as Fl auto mode link is available, only the first link is made active when .Nm -first reads data from the tun device. The next +first reads data from the tun device. +The next .Ar demand-dial link will be opened only when the current bundle throughput is at least .Ar max-percent percent of the total bundle bandwidth for .Ar period -seconds. When the current bundle throughput decreases to +seconds. +When the current bundle throughput decreases to .Ar min-percent percent or less of the total bundle bandwidth for .Ar period @@ -3565,7 +3799,8 @@ work correctly. .It set bandwidth Ar value This command sets the connection bandwidth in bits per second. .Ar value -must be greater than zero. It is currently only used by the +must be greater than zero. +It is currently only used by the .Dq set autoload command above. .It set callback Ar option Ns No ... @@ -3591,7 +3826,8 @@ In server mode, .Nm will accept any of the given protocols - but the client .Em must -request one of them. If you wish callback to be optional, you must include +request one of them. +If you wish callback to be optional, you must include .Ar none as an option. .Pp @@ -3602,13 +3838,15 @@ are as follows (in this order of preference): .Bl -tag -width Ds .It auth The callee is expected to decide the callback number based on -authentication. If +authentication. +If .Nm is the callee, the number should be specified as the fifth field of the peers entry in .Pa /etc/ppp/ppp.secret . .It cbcp -Microsoft's callback control protocol is used. See +Microsoft's callback control protocol is used. +See .Dq set cbcp below. .Pp @@ -3632,7 +3870,8 @@ is the callee, .Ar number should be either a comma separated list of allowable numbers or a .Dq \&* , -meaning any number is permitted. If +meaning any number is permitted. +If .Nm is the caller, only a single number should be specified. .Pp @@ -3646,7 +3885,8 @@ themselves. If the peer does not wish to do callback at all, .Nm will accept the fact and continue without callback rather than terminating -the connection. This is required (in addition to one or more other callback +the connection. +This is required (in addition to one or more other callback options) if you wish callback to be optional. .El .Pp @@ -3694,8 +3934,8 @@ checks for the existence of carrier depending on the type of device that has been opened: .Bl -tag -width XXX -offset XXX .It Terminal Devices -Carrier is checked one second after the login script is complete. If it's -not set, +Carrier is checked one second after the login script is complete. +If it's not set, .Nm assumes that this is because the device doesn't support carrier (which is true for most @@ -3706,20 +3946,26 @@ for carrier. As ptys don't support the TIOCMGET ioctl, the tty device will switch all carrier detection off when it detects that the device is a pty. .It ISDN (i4b) Devices -Carrier is checked once per second for 6 seconds. If it's not set after +Carrier is checked once per second for 6 seconds. +If it's not set after the sixth second, the connection attempt is considered to have failed and -the device is closed. Carrier is always required for i4b devices. +the device is closed. +Carrier is always required for i4b devices. .It PPPoE (netgraph) Devices -Carrier is checked once per second for 5 seconds. If it's not set after +Carrier is checked once per second for 5 seconds. +If it's not set after the fifth second, the connection attempt is considered to have failed and -the device is closed. Carrier is always required for PPPoE devices. +the device is closed. +Carrier is always required for PPPoE devices. .El .Pp -All other device types don't support carrier. Setting a carrier value will +All other device types don't support carrier. +Setting a carrier value will result in a warning when the device is opened. .Pp Some modems take more than one second after connecting to assert the carrier -signal. If this delay isn't increased, this will result in +signal. +If this delay isn't increased, this will result in .Nm Ns No 's inability to detect when the link is dropped, as .Nm @@ -3757,7 +4003,8 @@ is followed immediately by an exclaimation mark .Nm will .Em require -carrier. If carrier is not detected after +carrier. +If carrier is not detected after .Ar seconds seconds, the link will be disconnected. .It set choked Op Ar timeout @@ -3776,7 +4023,8 @@ A choked output queue occurs when has read a certain number of packets from the local network for transmission, but cannot send the data due to link failure (the peer is busy etc.). .Nm -will not read packets indefinitely. Instead, it reads up to +will not read packets indefinitely. +Instead, it reads up to .Em 30 packets (or .Em 30 No + @@ -3791,12 +4039,14 @@ If .Ar timeout seconds pass, all pending output packets are dropped. .It set ctsrts|crtscts on|off -This sets hardware flow control. Hardware flow control is +This sets hardware flow control. +Hardware flow control is .Ar on by default. .It set deflate Ar out-winsize Op Ar in-winsize This sets the DEFLATE algorithms default outgoing and incoming window -sizes. Both +sizes. +Both .Ar out-winsize and .Ar in-winsize @@ -3813,10 +4063,11 @@ values from the peer. .It set dns Op Ar primary Op Ar secondary This command specifies DNS overrides for the .Dq accept dns -command. Refer to the +command. +Refer to the .Dq accept -command description above for details. This command does not affect the -IP numbers requested using +command description above for details. +This command does not affect the IP numbers requested using .Dq enable dns . .It set device|line Xo .Ar value Ns No ... @@ -3850,7 +4101,8 @@ or be of the format .Pp If it begins with an exclamation mark, the rest of the device name is treated as a program name, and that program is executed when the device -is opened. Standard input, output and error are fed back to +is opened. +Standard input, output and error are fed back to .Nm and are read and written as if they were a regular device. .Pp @@ -3864,10 +4116,13 @@ will attempt to create a .Em PPP over Ethernet connection using the given .Ar iface -interface. The given +interface. +The given .Ar provider is passed as the service name in the PPPoE Discovery Initiation (PADI) -packet. If no provider is given, an empty value will be used. Refer to +packet. +If no provider is given, an empty value will be used. +Refer to .Xr netgraph 4 and .Xr ng_pppoe 8 @@ -3901,9 +4156,11 @@ will attempt to open each one in turn until it succeeds or runs out of devices. .It set dial Ar chat-script This specifies the chat script that will be used to dial the other -side. See also the +side. +See also the .Dq set login -command below. Refer to +command below. +Refer to .Xr chat 8 and to the example configuration files for details of the chat script format. @@ -3965,7 +4222,8 @@ directed to the open device (see the .Dq set device command), and standard error is read by .Nm -and substituted as the expect or send string. If +and substituted as the expect or send string. +If .Nm is running in interactive mode, file descriptor 3 is attached to .Pa /dev/tty . @@ -4002,13 +4260,16 @@ login OK! .Ed .Pp Note (again) the use of the escape character, allowing many levels of -nesting. Here, there are four parsers at work. The first parses the -original line, reading it as three arguments. The second parses the -third argument, reading it as 11 arguments. At this point, it is +nesting. +Here, there are four parsers at work. +The first parses the original line, reading it as three arguments. +The second parses the third argument, reading it as 11 arguments. +At this point, it is important that the .Dq \&- signs are escaped, otherwise this parser will see them as constituting -an expect-send-expect sequence. When the +an expect-send-expect sequence. +When the .Dq \&! character is seen, the execution parser reads the first command as three arguments, and then @@ -4023,7 +4284,8 @@ which is attached directly to the modem. .Pp This, of course means that it is possible to execute an entirely external .Dq chat -command rather than using the internal one. See +command rather than using the internal one. +See .Xr chat 8 for a good alternative. .Pp @@ -4032,26 +4294,30 @@ word expansions as the .Dq !bg command. .It set enddisc Op label|IP|MAC|magic|psn value -This command sets our local endpoint discriminator. If set prior to -LCP negotiation, and if no +This command sets our local endpoint discriminator. +If set prior to LCP negotiation, and if no .Dq disable enddisc command has been used, .Nm will send the information to the peer using the LCP endpoint discriminator -option. The following discriminators may be set: +option. +The following discriminators may be set: .Bd -unfilled -offset indent .It Li label The current label is used. .It Li IP -Our local IP number is used. As LCP is negotiated prior to IPCP, it is -possible that the IPCP layer will subsequently change this value. If +Our local IP number is used. +As LCP is negotiated prior to IPCP, it is +possible that the IPCP layer will subsequently change this value. +If it does, the endpoint discriminator stays at the old value unless manually reset. .It Li MAC This is similar to the .Ar IP option above, except that the MAC address associated with the local IP -number is used. If the local IP number is not resident on any Ethernet +number is used. +If the local IP number is not resident on any Ethernet interface, the command will fail. .Pp As the local IP number defaults to whatever the machine host name is, @@ -4060,14 +4326,14 @@ is usually done prior to any .Dq set ifaddr commands. .It Li magic -A 20 digit random number is used. Care should be taken when using magic -numbers as restarting +A 20 digit random number is used. +Care should be taken when using magic numbers as restarting .Nm or creating a link using a different .Nm invocation will also use a different magic number and will therefore not -be recognised by the peer as belonging to the same bundle. This makes it -unsuitable for +be recognised by the peer as belonging to the same bundle. +This makes it unsuitable for .Fl direct connections. .It Li psn Ar value @@ -4083,8 +4349,8 @@ If no arguments are given, the endpoint discriminator is reset. .It set escape Ar value... This option is similar to the .Dq set accmap -option above. It allows the user to specify a set of characters that -will be +option above. +It allows the user to specify a set of characters that will be .Sq escaped as they travel across the link. .It set filter dial|alive|in|out Ar rule-no Xo @@ -4101,16 +4367,19 @@ as they travel across the link. .Oc .Xc .Nm -supports four filter sets. The +supports four filter sets. +The .Em alive filter specifies packets that keep the connection alive - resetting the -idle timer. The +idle timer. +The .Em dial filter specifies packets that cause .Nm to dial when in .Fl auto -mode. The +mode. +The .Em in filter specifies packets that are allowed to travel into the machine and the @@ -4119,29 +4388,35 @@ filter specifies packets that are allowed out of the machine. .Pp Filtering is done prior to any IP alterations that might be done by the NAT engine on outgoing packets and after any IP alterations that might -be done by the NAT engine on incoming packets. By default all filter -sets allow all packets to pass. Rules are processed in order according to +be done by the NAT engine on incoming packets. +By default all filter sets allow all packets to pass. +Rules are processed in order according to .Ar rule-no (unless skipped by specifying a rule number as the .Ar action ) . -Up to 40 rules may be given for each set. If a packet doesn't match -any of the rules in a given set, it is discarded. In the case of +Up to 40 rules may be given for each set. +If a packet doesn't match +any of the rules in a given set, it is discarded. +In the case of .Em in and .Em out -filters, this means that the packet is dropped. In the case of +filters, this means that the packet is dropped. +In the case of .Em alive filters it means that the packet will not reset the idle timer and in the case of .Em dial -filters it means that the packet will not trigger a dial. A packet failing -to trigger a dial will be dropped rather than queued. Refer to the +filters it means that the packet will not trigger a dial. +A packet failing to trigger a dial will be dropped rather than queued. +Refer to the section on .Sx PACKET FILTERING above for further details. .It set hangup Ar chat-script This specifies the chat script that will be used to reset the device -before it is closed. It should not normally be necessary, but can +before it is closed. +It should not normally be necessary, but can be used for devices that fail to reset themselves properly on close. .It set help|? Op Ar command This command gives a summary of available set commands, or if @@ -4155,7 +4430,8 @@ is specified, the command usage is shown. .Oc Oc .Oc This command specifies the IP addresses that will be used during -IPCP negotiation. Addresses are specified using the format +IPCP negotiation. +Addresses are specified using the format .Pp .Dl a.b.c.d/nn .Pp @@ -4163,7 +4439,8 @@ Where .Dq a.b.c.d is the preferred IP, but .Ar nn -specifies how many bits of the address we will insist on. If +specifies how many bits of the address we will insist on. +If .No / Ns Ar nn is omitted, it defaults to .Dq /32 @@ -4188,10 +4465,12 @@ for example: will only negotiate .Dq 10.0.0.1 as the local IP number, but may assign any of the given 10 IP -numbers to the peer. If the peer requests one of these numbers, +numbers to the peer. +If the peer requests one of these numbers, and that number is not already in use, .Nm -will grant the peers request. This is useful if the peer wants +will grant the peers request. +This is useful if the peer wants to re-establish a link using the same IP number as was previously allocated (thus maintaining any existing tcp or udp connections). .Pp @@ -4204,9 +4483,11 @@ If .Ar triggeraddr is specified, it is used in place of .Ar myaddr -in the initial IPCP negotiation. However, only an address in the +in the initial IPCP negotiation. +However, only an address in the .Ar myaddr -range will be accepted. This is useful when negotiating with some +range will be accepted. +This is useful when negotiating with some .Dv PPP implementations that will not assign an IP number unless their peer requests @@ -4218,7 +4499,8 @@ mode, .Nm will configure the interface immediately upon reading the .Dq set ifaddr -line in the config file. In any other mode, these values are just +line in the config file. +In any other mode, these values are just used for IPCP negotiations, and the interface isn't configured until the IPCP layer is up. .Pp @@ -4263,7 +4545,8 @@ If is specified, it tells .Nm how many configuration request attempts it should make while receiving -no reply from the peer before giving up. The default is 5 attempts for +no reply from the peer before giving up. +The default is 5 attempts for CCP, LCP and IPCP and 3 attempts for PAP and CHAP. .Pp If @@ -4271,7 +4554,9 @@ If is specified, it tells .Nm how many terminate requests should be sent before giving up waiting for the -peers response. The default is 3 attempts. Authentication protocols are +peers response. +The default is 3 attempts. +Authentication protocols are not terminated and it is therefore invalid to specify .Ar trmtries for PAP or CHAP. @@ -4286,17 +4571,19 @@ in any given negotiation session before giving up and closing that layer. .Op +|- Ns .Ar value Ns No ... .Xc -This command allows the adjustment of the current log level. Refer -to the Logging Facility section for further details. +This command allows the adjustment of the current log level. +Refer to the Logging Facility section for further details. .It set login Ar chat-script This .Ar chat-script -compliments the dial-script. If both are specified, the login -script will be executed after the dial script. Escape sequences -available in the dial script are also available here. +compliments the dial-script. +If both are specified, the login +script will be executed after the dial script. +Escape sequences available in the dial script are also available here. .It set logout Ar chat-script This specifies the chat script that will be used to logout -before the hangup script is called. It should not normally be necessary. +before the hangup script is called. +It should not normally be necessary. .It set lqrperiod Ar frequency This command sets the .Ar frequency @@ -4304,13 +4591,16 @@ in seconds at which .Em LQR or .Em ECHO LQR -packets are sent. The default is 30 seconds. You must also use the +packets are sent. +The default is 30 seconds. +You must also use the .Dq enable lqr command if you wish to send LQR requests to the peer. .It set mode Ar interactive|auto|ddial|background This command allows you to change the .Sq mode -of the specified link. This is normally only useful in multi-link mode, +of the specified link. +This is normally only useful in multi-link mode, but may also be used in uni-link mode. .Pp It is not possible to change a link that is @@ -4322,33 +4612,37 @@ Note: If you issue the command .Dq set mode auto , and have network address translation enabled, it may be useful to .Dq enable iface-alias -afterwards. This will allow +afterwards. +This will allow .Nm to do the necessary address translations to enable the process that triggers the connection to connect once the link is up despite the peer assigning us a new (dynamic) IP address. .It set mrru Op Ar value Setting this option enables Multi-link PPP negotiations, also known as -Multi-link Protocol or MP. There is no default MRRU (Maximum -Reconstructed Receive Unit) value. If no argument is given, multi-link -mode is disabled. +Multi-link Protocol or MP. +There is no default MRRU (Maximum Reconstructed Receive Unit) value. +If no argument is given, multi-link mode is disabled. .It set mru Op Ar value -The default MRU (Maximum Receive Unit) is 1500. If it is increased, the -other side *may* increase its mtu. There is no point in decreasing the -MRU to below the default as the +The default MRU (Maximum Receive Unit) is 1500. +If it is increased, the other side *may* increase its MTU. +There is no point in decreasing the MRU to below the default as the .Em PPP -protocol *must* be able to accept packets of at least 1500 octets. If -no argument is given, 1500 is assumed. +protocol *must* be able to accept packets of at least 1500 octets. +If no argument is given, 1500 is assumed. .It set mtu Op Ar value -The default MTU is 1500. At negotiation time, +The default MTU is 1500. +At negotiation time, .Nm will accept whatever MRU or MRRU that the peer wants (assuming it's -not less than 296 bytes). If the MTU is set, +not less than 296 bytes). +If the MTU is set, .Nm will not accept MRU/MRRU values less than .Ar value . When negotiations are complete, the MTU is assigned to the interface, even -if the peer requested a higher value MRU/MRRU. This can be useful for +if the peer requested a higher value MRU/MRRU. +This can be useful for limiting your packet size (giving better bandwidth sharing at the expense of more header data). .Pp @@ -4357,7 +4651,8 @@ If no is given, 1500, or whatever the peer asks for is used. .It set nbns Op Ar x.x.x.x Op Ar y.y.y.y This option allows the setting of the Microsoft NetBIOS name server -values to be returned at the peers request. If no values are given, +values to be returned at the peers request. +If no values are given, .Nm will reject any such requests. .It set openmode active|passive Op Ar delay @@ -4370,7 +4665,8 @@ with a one second That is, .Nm will always initiate LCP/IPCP/CCP negotiation one second after the line -comes up. If you want to wait for the peer to initiate negotiations, you +comes up. +If you want to wait for the peer to initiate negotiations, you can use the value .Ar passive . If you want to initiate negotiations immediately or after more than one @@ -4378,7 +4674,8 @@ second, the appropriate .Ar delay may be specified here in seconds. .It set parity odd|even|none|mark -This allows the line parity to be set. The default value is +This allows the line parity to be set. +The default value is .Ar none . .It set phone Ar telno Ns Xo .Oo \&| Ns Ar backupnumber @@ -4403,7 +4700,8 @@ If multiple numbers are given, will dial them according to these rules until a connection is made, retrying the maximum number of times specified by .Dq set redial -below. In +below. +In .Fl background mode, each number is attempted at most once. .It set Op proc Ns Xo @@ -4415,7 +4713,8 @@ is changed according to .Ar value . If .Ar value -is not specified, the original process title is restored. All the +is not specified, the original process title is restored. +All the word replacements done by the shell commands (see the .Dq bg command above) are done here too. @@ -4506,8 +4805,8 @@ would result in a default route to .Dv HISADDR . .Pp All RADIUS routes are applied after any sticky routes are applied, making -RADIUS routes override configured routes. This also applies for RADIUS -routes that don't include the +RADIUS routes override configured routes. +This also applies for RADIUS routes that don't include the .Dv MYADDR or .Dv HISADDR @@ -4524,14 +4823,16 @@ The line will be re-connected at most .Ar ntries times. .Ar Ntries -defaults to zero. A value of +defaults to zero. +A value of .Ar random for .Ar timeout will result in a variable pause, somewhere between 1 and 30 seconds. .It set recvpipe Op Ar value -This sets the routing table RECVPIPE value. The optimum value is -just over twice the MTU value. If +This sets the routing table RECVPIPE value. +The optimum value is just over twice the MTU value. +If .Ar value is unspecified or zero, the default kernel controlled value is used. .It set redial Ar secs Ns Xo @@ -4543,13 +4844,16 @@ is unspecified or zero, the default kernel controlled value is used. .Nm can be instructed to attempt to redial .Ar attempts -times. If more than one phone number is specified (see +times. +If more than one phone number is specified (see .Dq set phone above), a pause of .Ar next -is taken before dialing each number. A pause of +is taken before dialing each number. +A pause of .Ar secs -is taken before starting at the first number again. A literal value of +is taken before starting at the first number again. +A literal value of .Dq Li random may be used here in place of .Ar secs @@ -4576,16 +4880,19 @@ Note, the delay will be effective, even after .Ar attempts has been exceeded, so an immediate manual dial may appear to have -done nothing. If an immediate dial is required, a +done nothing. +If an immediate dial is required, a .Dq \&! should immediately follow the .Dq open -keyword. See the +keyword. +See the .Dq open description above for further details. .It set sendpipe Op Ar value -This sets the routing table SENDPIPE value. The optimum value is -just over twice the MTU value. If +This sets the routing table SENDPIPE value. +The optimum value is just over twice the MTU value. +If .Ar value is unspecified or zero, the default kernel controlled value is used. .It set server|socket Ar TcpPort|LocalName|none password Op Ar mask @@ -4604,23 +4911,27 @@ to close any existing socket. If you wish to specify a local domain socket, .Ar LocalName must be specified as an absolute file name, otherwise it is assumed -to be the name or number of a TCP port. You must specify the octal umask -to be used with a local domain socket. Refer to +to be the name or number of a TCP port. +You must specify the octal umask to be used with a local domain socket. +Refer to .Xr umask 2 -for umask details. Refer to +for umask details. +Refer to .Xr services 5 for details of how to translate TCP port names. .Pp You must also specify the password that must be entered by the client (using the .Dq passwd -command above) when connecting to this socket. If the password is +command above) when connecting to this socket. +If the password is specified as an empty string, no password is required for connecting clients. .Pp When specifying a local domain socket, the first .Dq %d sequence found in the socket name will be replaced with the current -interface unit number. This is useful when you wish to use the same +interface unit number. +This is useful when you wish to use the same profile for more than one connection. .Pp In a similar manner TCP sockets may be prefixed with the @@ -4632,19 +4943,22 @@ When using .Nm with a server socket, the .Xr pppctl 8 -command is the preferred mechanism of communications. Currently, +command is the preferred mechanism of communications. +Currently, .Xr telnet 1 can also be used, but link encryption may be implemented in the future, so .Xr telnet 1 should not be relied upon. .It set speed Ar value -This sets the speed of the serial device. If speed is specified as +This sets the speed of the serial device. +If speed is specified as .Dq sync , .Nm treats the device as a synchronous device. .Pp Certain device types will know whether they should be specified as -synchronous or asynchronous. These devices will override incorrect +synchronous or asynchronous. +These devices will override incorrect settings and log a warning to this effect. .It set stopped Op Ar LCPseconds Op Ar CCPseconds If this option is set, @@ -4654,10 +4968,12 @@ the stopped state for the given number of .Dq seconds . This option may be useful if the peer sends a terminate request, but never actually closes the connection despite our sending a terminate -acknowledgement. This is also useful if you wish to +acknowledgement. +This is also useful if you wish to .Dq set openmode passive and time out if the peer doesn't send a Configure Request within the -given time. Use +given time. +Use .Dq set log +lcp +ccp to make .Nm @@ -4671,8 +4987,8 @@ This value should not be set to less than the openmode delay (see .Dq set openmode above). .It set timeout Ar idleseconds Op Ar mintimeout -This command allows the setting of the idle timer. Refer to the -section titled +This command allows the setting of the idle timer. +Refer to the section titled .Sx SETTING THE IDLE TIMER for further details. .Pp @@ -4690,9 +5006,11 @@ of seconds. .Xc This command controls the ports that .Nm -prioritizes when transmitting data. The default priority TCP ports +prioritizes when transmitting data. +The default priority TCP ports are ports 21 (ftp control), 22 (ssh), 23 (telnet), 513 (login), 514 (shell), -543 (klogin) and 544 (kshell). There are no priority UDP ports by default. +543 (klogin) and 544 (kshell). +There are no priority UDP ports by default. See .Xr services 5 for details. @@ -4711,7 +5029,8 @@ are given, the priority port lists are cleared (although if .Dq tcp or .Dq udp -is specified, only that list is cleared). If the first +is specified, only that list is cleared). +If the first .Ar port argument is prefixed with a plus .Pq Dq \&+ @@ -4725,15 +5044,16 @@ prefixed with a minus are removed from the list. .It set vj slotcomp on|off This command tells .Nm -whether it should attempt to negotiate VJ slot compression. By default, -slot compression is turned +whether it should attempt to negotiate VJ slot compression. +By default, slot compression is turned .Ar on . .It set vj slots Ar nslots This command sets the initial number of slots that .Nm will try to negotiate with the peer when VJ compression is enabled (see the .Sq enable -command above). It defaults to a value of 16. +command above). +It defaults to a value of 16. .Ar Nslots must be between .Ar 4 @@ -4747,17 +5067,20 @@ If .Ar command is not specified a shell is invoked according to the .Dv SHELL -environment variable. Otherwise, the given +environment variable. +Otherwise, the given .Ar command -is executed. Word replacement is done in the same way as for the +is executed. +Word replacement is done in the same way as for the .Dq !bg command as described above. .Pp Use of the ! character -requires a following space as with any of the other commands. You should -note that this command is executed in the foreground - +requires a following space as with any of the other commands. +You should note that this command is executed in the foreground; .Nm -will not continue running until this process has exited. Use the +will not continue running until this process has exited. +Use the .Dv bg command if you wish processing to happen in the background. .It show Ar var @@ -4772,7 +5095,8 @@ Show the current VJ compression statistics. .It show escape Show the current escape characters. .It show filter Op Ar name -List the current rules for the given filter. If +List the current rules for the given filter. +If .Ar name is not specified, all filters are shown. .It show hdlc @@ -4816,9 +5140,10 @@ Show the current version number of .El .Pp .It term -Go into terminal mode. Characters typed at the keyboard are sent to -the device. Characters read from the device are displayed on the -screen. When a remote +Go into terminal mode. +Characters typed at the keyboard are sent to the device. +Characters read from the device are displayed on the screen. +When a remote .Em PPP peer is detected, .Nm @@ -4828,7 +5153,8 @@ automatically enables Packet Mode and goes back into command mode. .Sh MORE DETAILS .Bl -bullet .It -Read the example configuration files. They are a good source of information. +Read the example configuration files. +They are a good source of information. .It Use .Dq help , @@ -4874,13 +5200,15 @@ A file to check when .Nm closes a network level connection. .It Pa /var/log/ppp.log -Logging and debugging information file. Note, this name is specified in +Logging and debugging information file. +Note, this name is specified in .Pa /etc/syslogd.conf . See .Xr syslog.conf 5 for further details. .It Pa /var/spool/lock/LCK..* -tty port locking file. Refer to +tty port locking file. +Refer to .Xr uucplock 3 for further details. .It Pa /var/run/tunN.pid @@ -4890,7 +5218,8 @@ program connected to the tunN device, where .Sq N is the number of the device. .It Pa /var/run/ttyXX.if -The tun interface used by this port. Again, this file is only created in +The tun interface used by this port. +Again, this file is only created in .Fl background , .Fl auto and diff --git a/usr.sbin/ppp/pppctl/pppctl.8 b/usr.sbin/ppp/pppctl/pppctl.8 index 33b8909d793..7384d00cc94 100644 --- a/usr.sbin/ppp/pppctl/pppctl.8 +++ b/usr.sbin/ppp/pppctl/pppctl.8 @@ -1,4 +1,4 @@ -.\" $Id: pppctl.8,v 1.6 1999/07/07 10:50:14 aaron Exp $ +.\" $Id: pppctl.8,v 1.7 2000/03/19 17:57:11 aaron Exp $ .Dd 26 June 1997 .Dt PPPCTL 8 .Os @@ -19,24 +19,29 @@ PPP control program .Sh DESCRIPTION This program provides command line control of the .Xr ppp 8 -daemon. Its primary use is to facilitate simple scripts that +daemon. +Its primary use is to facilitate simple scripts that control a running daemon. .Pp .Nm is passed at least one argument, specifying the socket on which .Nm ppp -is listening. Refer to the +is listening. +Refer to the .Ic set server command of .Nm ppp -for details. If the socket contains a leading +for details. +If the socket contains a leading .Sq / , it is taken as an .Dv AF_LOCAL -socket. If it contains a colon, it is treated as a +socket. +If it contains a colon, it is treated as a .Ar host : Ns Ar port pair, otherwise it is treated as a TCP port specification on the -local machine (127.0.0.1). Both the +local machine (127.0.0.1). +Both the .Ar host and .Ar port @@ -47,7 +52,8 @@ or don't have an entry for the given port in All remaining arguments are concatenated to form the command(s) that will be sent to the .Nm ppp -daemon. If any semi-colon characters are found, they are treated as +daemon. +If any semi-colon characters are found, they are treated as .Ar command delimiters, allowing more than one .Ar command @@ -71,27 +77,30 @@ When reading commands, the .Xr editline 3 library is used, allowing command-line editing (with .Xr editrc 5 -defining editing behaviour). The history size -defaults to 20 lines. +defining editing behaviour). +The history size defaults to 20 lines. .Pp The following command line options are available: .Bl -tag -width Ds .It Fl v Display all data sent to and received from the .Nm ppp -daemon. Normally, +daemon. +Normally, .Nm -displays only non-prompt lines received. This option is ignored in -interactive mode. +displays only non-prompt lines received. +This option is ignored in interactive mode. .It Fl t Ar n Use a timeout of .Ar n -instead of the default 2 seconds when connecting. This may be required +instead of the default 2 seconds when connecting. +This may be required if you wish to control a daemon over a slow (or even a dialup) link. .It Fl p Ar passwd Specify the password required by the .Nm ppp -daemon. If this switch is not used, +daemon. +If this switch is not used, .Nm will prompt for a password once it has successfully connected to .Nm ppp . @@ -105,7 +114,8 @@ mode, .Nm can be used to automate many frequent tasks (you can actually control .Nm ppp -in any mode except interactive mode). Use of the +in any mode except interactive mode). +Use of the .Fl p option is discouraged (even in scripts that aren't readable by others) as a @@ -130,7 +140,8 @@ Refer to the .Xr ppp 8 man page for further details. .Pp -You can now create some easy-access scripts. To connect to the internet: +You can now create some easy-access scripts. +To connect to the Internet: .Bd -literal -offset indent #! /bin/sh test $# -eq 0 && time=300 || time=$1 @@ -165,14 +176,17 @@ The following environment variables are understood by when in interactive mode: .Bl -tag -width XXXXXXXXXX .It Ev EL_SIZE -The number of history lines. The default is 20. +The number of history lines. +The default is 20. .It Ev EL_EDITOR -The edit mode. Only values of +The edit mode. +Only values of .Dq emacs and .Dq vi -are accepted. Other values -are silently ignored. This environment variable will override the +are accepted. +Other values are silently ignored. +This environment variable will override the .Nm bind -v and .Nm bind -e diff --git a/usr.sbin/pstat/pstat.8 b/usr.sbin/pstat/pstat.8 index 9096739b925..a39eb3063e9 100644 --- a/usr.sbin/pstat/pstat.8 +++ b/usr.sbin/pstat/pstat.8 @@ -1,3 +1,4 @@ +.\" $OpenBSD: pstat.8,v 1.14 2000/03/19 17:57:12 aaron Exp $ .\" $NetBSD: pstat.8,v 1.9.4.1 1996/06/02 09:08:17 mrg Exp $ .\" .\" Copyright (c) 1980, 1991, 1993, 1994 @@ -63,7 +64,8 @@ The options are as follows: .Bl -tag -width Ds .It Fl T Prints the number of used and free slots for open files, used vnodes, and swap -space. It is useful for checking to see how large system tables become +space. +It is useful for checking to see how large system tables become if the system is under heavy load. .It Fl f Print the open file table with these headings: @@ -106,10 +108,12 @@ Print devices by major/minor number rather than by name. .It Fl s Print information about swap space usage on all the swap areas compiled into the kernel. -The first column is the device name of the partition. The next column is -the total space available in the partition. The +The first column is the device name of the partition. +The next column is the total space available in the partition. +The .Ar Used -column indicates the total blocks used so far; the +column indicates the total blocks used so far; +the .Ar Available column indicates how much space is remaining on each partition. The @@ -197,9 +201,10 @@ for PPPDISC (see for STRIPDISC (see .Xr strip 4 ) . .It Fl v -Print the active vnodes. Each group of vnodes corresponding -to a particular filesystem is preceded by a two line header. The -first line consists of the following: +Print the active vnodes. +Each group of vnodes corresponding +to a particular filesystem is preceded by a two line header. +The first line consists of the following: .Pp .Df I .No *** MOUNT Em fstype from @@ -226,7 +231,8 @@ of optional flags applied to the mount (see .Xr mount 8 ) . .The second line is a header for the individual fields , the first part of which are fixed, and the second part are filesystem -type specific. The headers common to all vnodes are: +type specific. +The headers common to all vnodes are: .Bl -tag -width indent .It ADDR Location of this vnode. diff --git a/usr.sbin/pwd_mkdb/pwd_mkdb.8 b/usr.sbin/pwd_mkdb/pwd_mkdb.8 index 0701e731362..545286da8c6 100644 --- a/usr.sbin/pwd_mkdb/pwd_mkdb.8 +++ b/usr.sbin/pwd_mkdb/pwd_mkdb.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pwd_mkdb.8,v 1.8 1999/06/05 22:17:59 aaron Exp $ +.\" $OpenBSD: pwd_mkdb.8,v 1.9 2000/03/19 17:57:12 aaron Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -65,8 +65,8 @@ different from the historic Version 7 style format. The options are as follows: .Bl -tag -width flag .It Fl c -Check if the password file is in the correct format. Do not -change, add, or remove any files. +Check if the password file is in the correct format. +Do not change, add, or remove any files. .It Fl p Create a Version 7 style password file and install it into .Pa /etc/passwd . diff --git a/usr.sbin/quot/quot.8 b/usr.sbin/quot/quot.8 index ea04b9703a5..c11145ea874 100644 --- a/usr.sbin/quot/quot.8 +++ b/usr.sbin/quot/quot.8 @@ -27,7 +27,7 @@ .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: quot.8,v 1.8 1999/09/23 04:12:12 alex Exp $ +.\" $Id: quot.8,v 1.9 2000/03/19 17:57:12 aaron Exp $ .\" .Dd February 8, 1994 .Dt QUOT 8 @@ -66,8 +66,8 @@ options causes the numbers to be reported in kilobyte counts. .It Fl n Given a list of inodes (plus some optional data on each line) in the standard input, for each file print out the owner (plus -the remainder of the input line). This is traditionally used -in the pipe: +the remainder of the input line). +This is traditionally used in the pipe: .Bd -literal -offset indent ncheck filesystem | sort +0n | quot -n filesystem .Ed diff --git a/usr.sbin/quotaon/quotaon.8 b/usr.sbin/quotaon/quotaon.8 index 63eb08f4d86..b8cc8ff582f 100644 --- a/usr.sbin/quotaon/quotaon.8 +++ b/usr.sbin/quotaon/quotaon.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: quotaon.8,v 1.3 1999/05/23 14:11:36 aaron Exp $ +.\" $OpenBSD: quotaon.8,v 1.4 2000/03/19 17:57:12 aaron Exp $ +.\" .\" Copyright (c) 1983, 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" @@ -33,7 +34,7 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)quotaon.8 8.2 (Berkeley) 12/11/93 -.\" $Id: quotaon.8,v 1.3 1999/05/23 14:11:36 aaron Exp $ +.\" $Id: quotaon.8,v 1.4 2000/03/19 17:57:12 aaron Exp $ .\" .Dd December 11, 1993 .Dt QUOTAON 8 diff --git a/usr.sbin/rarpd/rarpd.8 b/usr.sbin/rarpd/rarpd.8 index 4b39c59d410..273d8e48fe9 100644 --- a/usr.sbin/rarpd/rarpd.8 +++ b/usr.sbin/rarpd/rarpd.8 @@ -1,4 +1,5 @@ .\" $NetBSD: rarpd.8,v 1.7 1998/04/15 15:06:06 mrg Exp $ +.\" .\" Copyright (c) 1988-1990 The Regents of the University of California. .\" All rights reserved. .\" @@ -17,7 +18,7 @@ .\" 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. -.\" @(#) $Id: rarpd.8,v 1.8 1999/12/03 01:25:44 millert Exp $ +.\" @(#) $Id: rarpd.8,v 1.9 2000/03/19 17:57:12 aaron Exp $ .\" .Dd October 26, 1990 .Dt RARPD 8 @@ -54,8 +55,8 @@ proceed and a reply will not be sent. .Pp In normal operation, .Nm -forks a copy of itself and runs in -the background. Anomalies and errors are reported via +forks a copy of itself and runs in the background. +Anomalies and errors are reported via .Xr syslog 3 . .Pp The options are as follows: @@ -93,7 +94,7 @@ process id of .Xr bpf 4 , .Xr diskless 8 .Rs -.%R A Reverse Address Resolution Protocol +.%R A Reverse Address Resolution Protocol .%N RFC 903 .%A Finlayson, R. .%A Mann, T. diff --git a/usr.sbin/rdate/rdate.8 b/usr.sbin/rdate/rdate.8 index 1dcdfa3b7d4..6328382f46a 100644 --- a/usr.sbin/rdate/rdate.8 +++ b/usr.sbin/rdate/rdate.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rdate.8,v 1.10 1999/10/17 20:35:47 aaron Exp $ +.\" $OpenBSD: rdate.8,v 1.11 2000/03/19 17:57:13 aaron Exp $ .\" $NetBSD: rdate.8,v 1.4 1996/04/08 20:55:17 jtc Exp $ .\" .\" Copyright (c) 1994 Christos Zoulas @@ -42,7 +42,8 @@ .Sh DESCRIPTION .Nm displays and sets the local date and time from the -host name or address given as the argument. It uses the RFC868 +host name or address given as the argument. +It uses the RFC868 protocol which is usually implemented as a built-in service of .Xr inetd 8 . .Pp diff --git a/usr.sbin/rdconfig/rdconfig.8 b/usr.sbin/rdconfig/rdconfig.8 index c8c88251a9b..ed8ed0c2952 100644 --- a/usr.sbin/rdconfig/rdconfig.8 +++ b/usr.sbin/rdconfig/rdconfig.8 @@ -1,4 +1,4 @@ -.\" +.\" $OpenBSD: rdconfig.8,v 1.5 2000/03/19 17:57:13 aaron Exp $ .\" $NetBSD: rdconfig.8,v 1.1.1.1 1995/10/08 22:40:41 gwr Exp $ .\" .\" Copyright (c) 1995 Gordon W. Ross @@ -45,7 +45,8 @@ It will associate the special file .Ar special_file with a range of user-virtual memory allocated by the .Nm rdconfig -process itself. The +process itself. +The .Nm rdconfig command should be run in the background. If successful, the command will not return. diff --git a/usr.sbin/repquota/repquota.8 b/usr.sbin/repquota/repquota.8 index 9e9faeded3f..109fec1929e 100644 --- a/usr.sbin/repquota/repquota.8 +++ b/usr.sbin/repquota/repquota.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: repquota.8,v 1.3 1999/05/23 14:11:37 aaron Exp $ +.\" $OpenBSD: repquota.8,v 1.4 2000/03/19 17:57:13 aaron Exp $ +.\" .\" Copyright (c) 1983, 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" @@ -34,7 +35,7 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)repquota.8 8.1 (Berkeley) 6/6/93 -.\" $Id: repquota.8,v 1.3 1999/05/23 14:11:37 aaron Exp $ +.\" $Id: repquota.8,v 1.4 2000/03/19 17:57:13 aaron Exp $ .\" .Dd June 6, 1993 .Dt REPQUOTA 8 diff --git a/usr.sbin/rmt/rmt.8 b/usr.sbin/rmt/rmt.8 index 41401fdf4e7..e323bbe05d6 100644 --- a/usr.sbin/rmt/rmt.8 +++ b/usr.sbin/rmt/rmt.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: rmt.8,v 1.6 1999/06/05 22:18:04 aaron Exp $ +.\" $OpenBSD: rmt.8,v 1.7 2000/03/19 17:57:13 aaron Exp $ +.\" .\" Copyright (c) 1983, 1991 The Regents of the University of California. .\" All rights reserved. .\" @@ -31,7 +32,7 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)rmt.8 6.5 (Berkeley) 3/16/91 -.\" $Id: rmt.8,v 1.6 1999/06/05 22:18:04 aaron Exp $ +.\" $Id: rmt.8,v 1.7 2000/03/19 17:57:13 aaron Exp $ .\" .Dd March 16, 1991 .Dt RMT 8 @@ -57,7 +58,8 @@ The .Nm program accepts requests specific to the manipulation of magnetic tapes, performs the commands, then responds with -a status indication. All responses are in +a status indication. +All responses are in .Tn ASCII and in one of two forms. @@ -117,7 +119,8 @@ If a device had already been opened, it is closed before a new open is performed. .It Xo Sy C Ar device No \en .Xc -Close the currently open device. The +Close the currently open device. +The .Ar device specified is ignored. .It Xo Sy L @@ -163,8 +166,8 @@ and responds with .Sm on if the read was successful; otherwise an error in the -standard format is returned. If the read -was successful, the data read is then sent. +standard format is returned. +If the read was successful, the data read is then sent. .Sm off .It Xo Sy I Ar operation .No \en Ar count No \en @@ -183,7 +186,8 @@ and .Ar mt_count fields of the structure used in the .Fn ioctl -call. The return value is the +call. +The return value is the .Ar count parameter when the operation is successful. .It Sy S @@ -191,9 +195,10 @@ Return the status of the open device, as obtained with a .Dv MTIOCGET .Xr ioctl -call. If the operation was successful, -an ``ack'' is sent with the size of the -status buffer, then the status buffer is +call. +If the operation was successful, an +.Dq ack +is sent with the size of the status buffer, then the status buffer is sent (in binary). .El .Sm on diff --git a/usr.sbin/rpc.bootparamd/bootparams.5 b/usr.sbin/rpc.bootparamd/bootparams.5 index 8d8dfd03b7b..2baf5ee6fa3 100644 --- a/usr.sbin/rpc.bootparamd/bootparams.5 +++ b/usr.sbin/rpc.bootparamd/bootparams.5 @@ -1,5 +1,4 @@ -.\" $OpenBSD: bootparams.5,v 1.6 2000/01/03 20:04:34 pjanzen Exp $ - +.\" $OpenBSD: bootparams.5,v 1.7 2000/03/19 17:57:13 aaron Exp $ .\" .\" Copyright (c) 1994 Gordon W. Ross .\" All rights reserved. diff --git a/usr.sbin/rpc.bootparamd/rpc.bootparamd.8 b/usr.sbin/rpc.bootparamd/rpc.bootparamd.8 index 23513b62fe2..566e542da04 100644 --- a/usr.sbin/rpc.bootparamd/rpc.bootparamd.8 +++ b/usr.sbin/rpc.bootparamd/rpc.bootparamd.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rpc.bootparamd.8,v 1.11 1999/07/03 02:11:10 aaron Exp $ +.\" $OpenBSD: rpc.bootparamd.8,v 1.12 2000/03/19 17:57:13 aaron Exp $ .\" @(#)bootparamd.8 .Dd January 8, 1994 .Dt BOOTPARAMD 8 @@ -16,14 +16,16 @@ .Sh DESCRIPTION .Nm is a server process that provides information to diskless clients -necessary for booting. It consults the file +necessary for booting. +It consults the file .Pa /etc/bootparams . It should normally be started from .Pa /etc/rc . .Pp This version will allow the use of aliases on the hostname in the .Pa /etc/bootparams -file. The hostname returned in response to the booting client's whoami request +file. +The hostname returned in response to the booting client's whoami request will be the name that appears in the config file, not the canonical name. In this way you can keep the answer short enough so that machines that cannot handle long hostnames won't fail during boot. @@ -33,18 +35,20 @@ While parsing, if a line containing just is found, and the YP subsystem is active, the YP map .Pa bootparams will be searched immediately. -.Sh OPTIONS +.Pp +The options are as follows: .Bl -tag -width indent .It Fl d -Display the debugging information. The daemon does not fork in this -case. +Display the debugging information. +The daemon does not fork in this case. .It Fl s Log the debugging information with syslog. .It Fl r Set the default router (a hostname or IP address). This defaults to the machine running the server. .It Fl f -Specify the file to read boot parameters from. Defaults to +Specify the file to read boot parameters from. +Defaults to .Pa /etc/bootparams . .El .Sh FILES @@ -55,14 +59,14 @@ default configuration file .Sh SEE ALSO .Xr bootparams 5 , .Xr diskless 8 -.Sh WARNINGS -If -.Nm rpc.bootparamd -is run on a system which is also running YP, your YP -domainname will be made public information. +.Sh AUTHOR +Originally written by Klas Heggemann <klas@nada.kth.se> .Sh BUGS You may find the syslog loggings too verbose. .Pp It's not clear if the non-canonical hack mentioned above is a good idea. -.Sh AUTHOR -Originally written by Klas Heggemann <klas@nada.kth.se> +.Sh WARNING +If +.Nm rpc.bootparamd +is run on a system which is also running YP, your YP +domainname will be made public information. diff --git a/usr.sbin/rpc.lockd/rpc.lockd.8 b/usr.sbin/rpc.lockd/rpc.lockd.8 index 4c9b777af2c..9d648d7b1cd 100644 --- a/usr.sbin/rpc.lockd/rpc.lockd.8 +++ b/usr.sbin/rpc.lockd/rpc.lockd.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rpc.lockd.8,v 1.7 2000/03/04 20:02:24 aaron Exp $ +.\" $OpenBSD: rpc.lockd.8,v 1.8 2000/03/19 17:57:14 aaron Exp $ .\" .\" Copyright (c) 1995 A.R.Gordon, andrew.gordon@net-tel.co.uk .\" All rights reserved. @@ -50,15 +50,16 @@ The options are as follows: .Bl -tag -width Ds .It Fl d Op Ar debug_level Write debugging information to syslog, recording -all RPC transactions to the daemon. These messages are logged with level +all RPC transactions to the daemon. +These messages are logged with level .Dv LOG_DEBUG and facility .Dv LOG_DAEMON . If .Ar debug_level is not specified, -level 1 is assumed, giving one log line per protocol operation. Higher -debug levels can be specified, causing display of operation arguments +level 1 is assumed, giving one log line per protocol operation. +Higher debug levels can be specified, causing display of operation arguments and internal operations of the daemon. .El .Pp @@ -94,7 +95,8 @@ but there is currently no means for an .Ox client to establish locks). .Pp -Versions 1, 2 and 3 of the protocol are supported. However, only versions +Versions 1, 2 and 3 of the protocol are supported. +However, only versions 2 (Unix systems) and 3 (PC-NFS clients) seem to be in common use - the version 1 support has not been tested due to the lack of version 1 clients against which to test. diff --git a/usr.sbin/rtadvd/rtadvd.8 b/usr.sbin/rtadvd/rtadvd.8 index 1c86af430c9..4ded93091d6 100644 --- a/usr.sbin/rtadvd/rtadvd.8 +++ b/usr.sbin/rtadvd/rtadvd.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rtadvd.8,v 1.8 2000/03/13 06:16:11 itojun Exp $ +.\" $OpenBSD: rtadvd.8,v 1.9 2000/03/19 17:57:14 aaron Exp $ .\" .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. .\" All rights reserved. @@ -36,12 +36,12 @@ .Nm rtadvd .Nd router advertisement daemon .Sh SYNOPSIS -.Nm +.Nm rtadvd .Op Fl c Ar configfile .Op Fl dDfRs .Ar interface ... .Sh DESCRIPTION -.Nm Rtadvd +.Nm advertises router advertisement packet to the specified .Ar interfaces . .Pp @@ -62,7 +62,7 @@ In particular, reads all the interface routes from the routing table and advertises them as on-link prefixes. .Pp -.Nm Rtadvd +.Nm also watches the routing table. By default, if an interface direct route is added/deleted on an advertising interface, diff --git a/usr.sbin/rtsold/rtsold.8 b/usr.sbin/rtsold/rtsold.8 index 560399c06fb..d28d80eea3a 100644 --- a/usr.sbin/rtsold/rtsold.8 +++ b/usr.sbin/rtsold/rtsold.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rtsold.8,v 1.6 2000/01/02 06:28:16 itojun Exp $ +.\" $OpenBSD: rtsold.8,v 1.7 2000/03/19 17:57:14 aaron Exp $ .\" .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. .\" All rights reserved. @@ -38,7 +38,7 @@ .Nd router solicitation daemon .\" .Sh SYNOPSIS -.Nm +.Nm rtsold .Op Fl dDfm1 .Ar interface ... .Nm rtsol @@ -46,7 +46,7 @@ .Ar interface ... .\" .Sh DESCRIPTION -.Nm Rtsold +.Nm is the daemon program to send ICMPv6 Router Solicitation messages on the specified interfaces. If a node (re)attaches to a link, @@ -81,7 +81,7 @@ Just after invocation of daemon. .It The interface is up after a temporary interface failure. -.Nm Rtsold +.Nm detects such failures by periodically probing to see if the status of the interface is active or not. Note that some network cards and drivers do not allow the extraction diff --git a/usr.sbin/rwhod/rwhod.8 b/usr.sbin/rwhod/rwhod.8 index a7021504b5d..a63d41b3001 100644 --- a/usr.sbin/rwhod/rwhod.8 +++ b/usr.sbin/rwhod/rwhod.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: rwhod.8,v 1.10 1999/06/05 22:18:07 aaron Exp $ +.\" $OpenBSD: rwhod.8,v 1.11 2000/03/19 17:57:14 aaron Exp $ +.\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" @@ -31,7 +32,7 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)rwhod.8 8.2 (Berkeley) 12/11/93 -.\" $OpenBSD: rwhod.8,v 1.10 1999/06/05 22:18:07 aaron Exp $ +.\" $OpenBSD: rwhod.8,v 1.11 2000/03/19 17:57:14 aaron Exp $ .\" .Dd December 11, 1993 .Dt RWHOD 8 @@ -47,7 +48,8 @@ is the server which maintains the database used by the .Xr rwho 1 and .Xr ruptime 1 -programs. Its operation is predicated on the ability to +programs. +Its operation is predicated on the ability to .Em broadcast messages on a network. .Pp @@ -90,17 +92,18 @@ struct whod { .Ed .Pp All fields are converted to network byte order prior to -transmission. The load averages are as calculated by the +transmission. +The load averages are as calculated by the .Xr w 1 program, and represent load averages over the 5, 10, and 15 minute intervals prior to a server's transmission; they are multiplied by 100 -for representation in an integer. The host name -included is that returned by +for representation in an integer. +The host name included is that returned by .Xr gethostname 3 with any trailing domain name omitted. The array at the end of the message contains information about -the users logged in to the sending machine. This information -includes the contents of the +the users logged in to the sending machine. +This information includes the contents of the .Xr utmp 5 entry for each non-idle terminal line and a value indicating the time in seconds since a character was last received on the terminal line. @@ -109,11 +112,13 @@ Messages received by the .Xr rwho server are discarded unless they originated at an .Xr rwho -server's port. In addition, if the host's name, as specified +server's port. +In addition, if the host's name, as specified in the message, contains any unprintable .Tn ASCII characters, the -message is discarded. Valid messages received by +message is discarded. +Valid messages received by .Nm are placed in files named .Pa whod.hostname diff --git a/usr.sbin/sa/sa.8 b/usr.sbin/sa/sa.8 index 1b843ac850e..6bc2ebd36f4 100644 --- a/usr.sbin/sa/sa.8 +++ b/usr.sbin/sa/sa.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sa.8,v 1.8 2000/03/05 00:28:57 aaron Exp $ +.\" $OpenBSD: sa.8,v 1.9 2000/03/19 17:57:14 aaron Exp $ .\" .\" Copyright (c) 1994 Christopher G. Demetriou .\" All rights reserved. @@ -28,7 +28,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: sa.8,v 1.8 2000/03/05 00:28:57 aaron Exp $ +.\" $Id: sa.8,v 1.9 2000/03/19 17:57:14 aaron Exp $ .\" .Dd February 25, 1994 .Dt SA 8 @@ -69,8 +69,8 @@ If file names are supplied, they are read instead of .Pa /var/account/acct . After each file is read, if the summary files are being updated, an updated summary will -be saved to disk. Only one report is printed, -after the last file is processed. +be saved to disk. +Only one report is printed, after the last file is processed. .Pp The labels used in the output indicate the following, except where otherwise specified by individual options: @@ -101,7 +101,8 @@ The options are as follows: .Bl -tag -width Ds .It Fl a List all command names, including those containing unprintable -characters and those used only once. By default, +characters and those used only once. +By default, .Nm places all names containing unprintable characters and those used only once under the name @@ -114,7 +115,8 @@ In addition to the number of calls and the user, system and real times for each command, print their percentage of the total over all commands. .It Fl d If printing command statistics, sort by the average number of disk -I/O operations. If printing user statistics, print the average number of +I/O operations. +If printing user statistics, print the average number of disk I/O operations per user. .It Fl D If printing command statistics, sort and print by the total number @@ -129,8 +131,8 @@ Do not read in the summary files. Instead of the total minutes per category, give seconds per call. .It Fl k If printing command statistics, sort by the CPU time average memory -usage. If printing user statistics, print the CPU time average -memory usage. +usage. +If printing user statistics, print the CPU time average memory usage. .It Fl K If printing command statistics, print and sort by the CPU-storage integral. .It Fl l @@ -161,22 +163,26 @@ command name. For each command used .Ar cutoff times or fewer, print the command name and await a reply -from the terminal. If the reply begins with +from the terminal. +If the reply begins with .Dq y , add the command to the category .Dq **junk** . This flag is used to strip garbage from the report. .El .Pp -By default, per-command statistics will be printed. The number of +By default, per-command statistics will be printed. +The number of calls, the total elapsed time in minutes, total CPU and user time in minutes, average number of I/O operations, and CPU time -averaged core usage will be printed. If the +averaged core usage will be printed. +If the .Fl m option is specified, per-user statistics will be printed, including the user name, the number of commands invoked, total CPU time used (in minutes), total number of I/O operations, and CPU storage integral -for each user. If the +for each user. +If the .Fl u option is specified, the uid, user and system time (in seconds), CPU storage integral, I/O usage, and command name will be printed @@ -186,7 +192,8 @@ If the .Fl u flag is specified, all flags other than .Fl q -are ignored. If the +are ignored. +If the .Fl m flag is specified, only the .Fl b , @@ -226,8 +233,8 @@ OpenBSD's VM system does not record the CPU storage integral. While the behavior of the options in this version of .Nm was modeled after the original version, there are some intentional -differences and undoubtedly some unintentional ones as well. In -particular, the +differences and undoubtedly some unintentional ones as well. +In particular, the .Fl q option has been added, and the .Fl m diff --git a/usr.sbin/screenblank/screenblank.1 b/usr.sbin/screenblank/screenblank.1 index e23a67b26f2..941c0d8517c 100644 --- a/usr.sbin/screenblank/screenblank.1 +++ b/usr.sbin/screenblank/screenblank.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: screenblank.1,v 1.4 1999/04/02 15:12:21 aaron Exp $ +.\" $OpenBSD: screenblank.1,v 1.5 2000/03/19 17:57:15 aaron Exp $ .\" $NetBSD: screenblank.1,v 1.2 1996/02/28 01:18:32 thorpej Exp $ .\" .\" Copyright (c) 1996 The NetBSD Foundation, Inc. @@ -59,7 +59,8 @@ When killed with a or .Dv SIGTERM , .Nm -will re-enable the framebuffer. The PID can be found in the file +will re-enable the framebuffer. +The PID can be found in the file .Pa /var/run/screenblank.pid . .Pp The options are as follows: @@ -72,12 +73,14 @@ Do not check the mouse for activity. Wait the number of seconds specified by .Ar timeout , expressed in the format `xxx.xxx', before disabling the framebuffer due to -inactivity. The default is 600 seconds (10 minutes). +inactivity. +The default is 600 seconds (10 minutes). .It Fl e Ar timeout Wait the number of seconds specified by .Ar timeout , expressed in the format `xxx.xxx', before re-enabling the framebuffer once -activity resumes. The default is .25 seconds. +activity resumes. +The default is .25 seconds. .It Fl f Ar framebuffer Use the framebuffer device .Ar framebuffer diff --git a/usr.sbin/sesd/sesd/sesd.8 b/usr.sbin/sesd/sesd/sesd.8 index 110b25e964e..f23d849993f 100644 --- a/usr.sbin/sesd/sesd/sesd.8 +++ b/usr.sbin/sesd/sesd/sesd.8 @@ -1,6 +1,4 @@ -.\" $NetBSD: $ -.\" $OpenBSD: sesd.8,v 1.2 2000/03/05 00:28:51 aaron Exp $ -.\" $FreeBSD: $ +.\" $OpenBSD: sesd.8,v 1.3 2000/03/19 17:57:15 aaron Exp $ .\" .\" Copyright (c) 2000 Matthew Jacob .\" All rights reserved. diff --git a/usr.sbin/sliplogin/sliplogin.8 b/usr.sbin/sliplogin/sliplogin.8 index 463ea89dcf5..f3d2ec6d355 100644 --- a/usr.sbin/sliplogin/sliplogin.8 +++ b/usr.sbin/sliplogin/sliplogin.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: sliplogin.8,v 1.4 2000/03/04 22:19:30 aaron Exp $ +.\" $OpenBSD: sliplogin.8,v 1.5 2000/03/19 17:57:15 aaron Exp $ +.\" .\" Copyright (c) 1990, 1991 The Regents of the University of California. .\" All rights reserved. .\" @@ -31,7 +32,7 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)sliplogin.8 5.4 (Berkeley) 8/5/91 -.\" $Id: sliplogin.8,v 1.4 2000/03/04 22:19:30 aaron Exp $ +.\" $Id: sliplogin.8,v 1.5 2000/03/19 17:57:15 aaron Exp $ .\" .Dd August 5, 1991 .Dt SLIPLOGIN 8 @@ -47,8 +48,8 @@ is used to turn the terminal line on standard input into a Serial Line IP .Pq Tn SLIP -link to a remote host. To do this, the program -searches the file +link to a remote host. +To do this, the program searches the file .Pa /etc/sliphome/slip.hosts for an entry matching .Ar loginname @@ -56,8 +57,8 @@ for an entry matching If a matching entry is found, the line is configured appropriately for slip (8-bit transparent I/O) and converted to .Tn SLIP -line -discipline. Then a shell script is invoked to initialize the slip +line discipline. +Then a shell script is invoked to initialize the slip interface with the appropriate local and remote .Tn IP address, @@ -71,7 +72,8 @@ will be executed instead if it exists. The script is invoked with the parameters .Bl -tag -width slipunit .It Em slipunit -The unit number of the slip interface assigned to this line. E.g., +The unit number of the slip interface assigned to this line. +e.g., .Sy 0 for .Sy sl0 . @@ -84,23 +86,26 @@ entry, in order starting with .Ar loginname . .El .Pp -Only the super-user may attach a network interface. The interface is -automatically detached when the other end hangs up or the +Only the superuser may attach a network interface. +The interface is automatically detached when the other end hangs up or the .Nm -process dies. If the kernel slip +process dies. +If the kernel slip module has been configured for it, all routes through that interface will -also disappear at the same time. If there is other processing a site +also disappear at the same time. +If there is other processing a site would like done on hangup, the file .Pa /etc/sliphome/slip.logout or .Pa /etc/sliphome/slip.logout. Ns Ar loginname -is executed if it exists. It is given the same arguments as the login script. +is executed if it exists. +It is given the same arguments as the login script. .Ss Format of /etc/sliphome/slip.hosts Comments (lines starting with a `#') and blank lines are ignored. Other lines must start with a .Ar loginname but the remaining arguments can be whatever is appropriate for the -.Pa slip.login +.Pa slip.login file that will be executed for that name. Arguments are separated by whitespace and follow normal .Xr sh 1 @@ -119,8 +124,8 @@ and are the IP host names or addresses of the local and remote ends of the slip line and .Em netmask -is the appropriate IP netmask. These arguments are passed -directly to +is the appropriate IP netmask. +These arguments are passed directly to .Xr ifconfig 8 . .Em Opt-args are optional arguments used to configure the line. @@ -131,7 +136,8 @@ is to create a .Pa /etc/passwd entry for each legal, remote slip site with .Nm -as the shell for that entry. E.g., +as the shell for that entry. +e.g., .Bd -literal Sfoo:ikhuy6:2010:1:slip line to foo:/tmp:/usr/sbin/sliplogin .Ed @@ -160,8 +166,8 @@ Note that .Nm must be setuid to root and, while not a security hole, moral defectives can use it to place terminal lines in an unusable state and/or deny -access to legitimate users of a remote slip line. To prevent this, -a site can create a group, say +access to legitimate users of a remote slip line. +To prevent this a site can create a group, say .Em slip , that only the slip login accounts are put in then make sure that .Pa /usr/sbin/sliplogin diff --git a/usr.sbin/slstats/slstats.8 b/usr.sbin/slstats/slstats.8 index 4b3f485d92e..1f7d35b4478 100644 --- a/usr.sbin/slstats/slstats.8 +++ b/usr.sbin/slstats/slstats.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: slstats.8,v 1.7 1999/10/07 06:41:35 ericj Exp $ +.\" $OpenBSD: slstats.8,v 1.8 2000/03/19 17:57:15 aaron Exp $ .\" $NetBSD: slstats.8,v 1.2.6.1 1996/06/07 01:42:24 thorpej Exp $ .Dd July 5, 1993 .Dt SLSTATS 8 @@ -21,18 +21,19 @@ utility reports slip-related statistics for the .So .Ar unit-number .Sc -interface. If the +interface. +If the .Nm unit-number -is unspecified, it defaults to 0. These statistics are displayed at -regular intervals. +is unspecified, it defaults to 0. +These statistics are displayed at regular intervals. .Pp The display is split horizontally into input and output sections containing columns of statistics describing the properties and volume of packets received and transmitted by the specified interface. .Pp The first report will consist of a snapshot of the interface's present -statistics. All further output will describe activity between report -intervals. +statistics. +All further output will describe activity between report intervals. .Pp The options are as follows: .Bl -tag -width "system " @@ -41,7 +42,8 @@ Display additional statistics demonstrating the efficacy of VJ header compression and providing more explicit information on failure distribution. .It Fl i -Specifies the interval between reports. The default interval is 5 seconds. +Specifies the interval between reports. +The default interval is 5 seconds. .It Fl M Ar core Extract values associated with the name list from the specified. .It Fl N Ar system @@ -62,13 +64,13 @@ The number of uncompressed TCP packets received by this interface. .It Li ERR The number of packets received by this interface of unknown type. .It Li TOSS -The number of packets dropped on reception by this interface. Only -reported when the +The number of packets dropped on reception by this interface. +Only reported when the .Fl v option is specified. .It Li IP -The total number of non-TCP packets received by this interface. Only -reported when the +The total number of non-TCP packets received by this interface. +Only reported when the .Fl v option is specified. .El @@ -87,12 +89,14 @@ The number of uncompressed TCP packets transmitted from this interface. The total number of non-TCP packets transmitted from this interface. .It Li SEARCH The number of searches for the cached header entry for a compressed -packet. Only reported when the +packet. +Only reported when the .Fl v option is specified. .It Li MISS The number of failed searches for the cached header entry for a -compressed packet. Only reported when the +compressed packet. +Only reported when the .Fl v option is specified. .El diff --git a/usr.sbin/syslogd/syslog.conf.5 b/usr.sbin/syslogd/syslog.conf.5 index e33893c06aa..b54ebe07203 100644 --- a/usr.sbin/syslogd/syslog.conf.5 +++ b/usr.sbin/syslogd/syslog.conf.5 @@ -30,7 +30,7 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)syslog.conf.5 8.1 (Berkeley) 6/9/93 -.\" $OpenBSD: syslog.conf.5,v 1.6 2000/03/04 22:19:29 aaron Exp $ +.\" $OpenBSD: syslog.conf.5,v 1.7 2000/03/19 17:57:16 aaron Exp $ .\" $NetBSD: syslog.conf.5,v 1.4 1996/01/02 17:41:46 perry Exp $ .\" .Dd June 9, 1993 @@ -68,7 +68,9 @@ The function are encoded as a .Em facility , -a period (``.''), and a +a period +.Pq Ql \&. , +and a .Em level , with no intervening whitespace. Both the @@ -103,8 +105,8 @@ values specified to the .Xr syslog library routine. .Pp -Each block of lines is separated from the previous block by a tag. The tag -is a line beginning with +Each block of lines is separated from the previous block by a tag. +The tag is a line beginning with .Em #!prog or .Em !prog @@ -119,12 +121,13 @@ for a further descriptions of both the .Em facility and .Em level -keywords and their significance. It's preferred that selections be made on +keywords and their significance. +It's preferred that selections be made on .Em facility rather than .Em program , -since the latter can easily vary in a networked environment. In some cases, -though, an appropriate +since the latter can easily vary in a networked environment. +In some cases, though, an appropriate .Em facility simply doesn't exist. .Pp @@ -143,7 +146,9 @@ Multiple .Em selectors may be specified for a single .Em action -by separating them with semicolon (``;'') characters. +by separating them with semicolon +.Pq Ql \&; +characters. It is important to note, however, that each .Em selector can modify the ones preceding it. @@ -152,9 +157,13 @@ Multiple .Em facilities may be specified for a single .Em level -by separating them with comma (``,'') characters. +by separating them with comma +.Pq Ql \&, +characters. .Pp -An asterisk (``*'') can be used to specify all +An asterisk +.Pq Ql * +can be used to specify all .Em facilities , all .Em levels @@ -163,8 +172,10 @@ or all .Pp The special .Em facility -``mark'' receives a message at priority ``info'' every 20 minutes -(see +.Dq mark +receives a message at priority +.Dq info +every 20 minutes (see .Xr syslogd 8 ) . This is not enabled by a .Em facility @@ -172,7 +183,8 @@ field containing an asterisk. .Pp The special .Em level -``none'' disables a particular +.Dq none +disables a particular .Em facility . .Pp The @@ -186,7 +198,9 @@ There are four forms: A pathname (beginning with a leading slash). Selected messages are appended to the file. .It -A hostname (preceded by an at (``@'') sign). +A hostname (preceded by an at +.Pq Ql @ +sign). Selected messages are forwarded to the .Xr syslogd program on the named host. @@ -199,12 +213,18 @@ An asterisk. Selected messages are written to all logged-in users. .El .Pp -Blank lines and lines whose first non-blank character is a hash (``#'') -character are ignored with the exception of lines beginning with (``#!''). +Blank lines and lines whose first non-blank character is a hash +.Pq Ql # +character are ignored with the exception of lines beginning with +.Ql #! . These lines are treated as section headers in the same way as lines -beginning with (``!''). This allows +beginning with +.Ql ! . +This allows .Nm -files to be shared with systems that don't recognise the (``!'') syntax. +files to be shared with systems that don't recognise the +.Ql ! +syntax. .Sh EXAMPLES A configuration file might appear as follows: .Bd -literal @@ -249,8 +269,15 @@ configuration file. .El .Sh BUGS The effects of multiple selectors are sometimes not intuitive. -For example ``mail.crit,*.err'' will select ``mail'' facility messages at -the level of ``err'' or higher, not at the level of ``crit'' or higher. +For example +.Dq mail.crit,*.err +will select +.Dq mail +facility messages at the level of +.Dq err +or higher, not at the level of +.Dq crit +or higher. .Sh SEE ALSO .Xr syslog 3 , .Xr syslogd 8 diff --git a/usr.sbin/syslogd/syslogd.8 b/usr.sbin/syslogd/syslogd.8 index 576f2da6b65..22d5fcd6592 100644 --- a/usr.sbin/syslogd/syslogd.8 +++ b/usr.sbin/syslogd/syslogd.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: syslogd.8,v 1.10 1999/05/23 14:11:38 aaron Exp $ +.\" $OpenBSD: syslogd.8,v 1.11 2000/03/19 17:57:16 aaron Exp $ +.\" .\" Copyright (c) 1983, 1986, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" diff --git a/usr.sbin/tcpdump/tcpdump.8 b/usr.sbin/tcpdump/tcpdump.8 index e0d8e97101f..891b70bf8d2 100644 --- a/usr.sbin/tcpdump/tcpdump.8 +++ b/usr.sbin/tcpdump/tcpdump.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tcpdump.8,v 1.20 2000/03/14 21:31:44 aaron Exp $ +.\" $OpenBSD: tcpdump.8,v 1.21 2000/03/19 17:57:16 aaron Exp $ .\" .\" Copyright (c) 1987, 1988, 1989, 1990, 1991, 1992, 1994, 1995, 1996 .\" The Regents of the University of California. All rights reserved. @@ -86,8 +86,8 @@ lowest numbered, configured interface (excluding loopback). Ties are broken by choosing the earliest match. .It Fl l -Make stdout line buffered. Useful if you want to see the data -while capturing it. E.g., +Make stdout line buffered. +Useful if you want to see the data while capturing it. e.g., .Bd -ragged -offset indent .Nm .Fl l @@ -106,37 +106,37 @@ dat Do not convert addresses (i.e., host addresses, port numbers, etc.) to names. .It Fl N -Do not print domain name qualification of host names. For example, -if you specify this flag then +Do not print domain name qualification of host names. +For example, if you specify this flag then .Nm will print .Dq nic instead of .Dq nic.ddn.mil . .It Fl O -Do not run the packet-matching code optimizer. This is useful only -if you suspect a bug in the optimizer. +Do not run the packet-matching code optimizer. +This is useful only if you suspect a bug in the optimizer. .It Fl p -Do not put the interface -into promiscuous mode. The interface might be in promiscuous -mode for some other reason; hence, +Do not put the interface into promiscuous mode. +The interface might be in promiscuous mode for some other reason; hence, .Fl p cannot be used as an abbreviation for .Dq ether host "{local\&-hw\&-addr}" or .Dq ether broadcast . .It Fl q -Quick (quiet?) output. Print less protocol information so output -lines are shorter. +Quick (quiet?) output. +Print less protocol information so output lines are shorter. .It Fl r Ar file Read packets from a .Ar file which was created with the .Fl w -option. Standard input is used if +option. +Standard input is used if .Ar file is -.Ql - . +.Ql - . .It Fl s Ar snaplen Analyze at most the first .Ar snaplen @@ -160,8 +160,9 @@ where is the name of the protocol level at which the truncation has occurred. Taking larger snapshots both increases the amount of time it takes to process packets and, effectively, -decreases the amount of packet buffering. This may cause packets to be -lost. You should limit +decreases the amount of packet buffering. +This may cause packets to be lost. +You should limit .Ar snaplen to the smallest number that will capture the protocol information you're interested in. @@ -197,20 +198,22 @@ Do not print a timestamp on each dump line. .It Fl tt Print an unformatted timestamp on each dump line. .It Fl v -(Slightly more) verbose output. For example, the time to live +(Slightly more) verbose output. +For example, the time to live and type of service information in an .Tn IP packet is printed. .It Fl vv -Even more verbose output. For example, additional fields are -printed from +Even more verbose output. +For example, additional fields are printed from .Tn NFS reply packets. .It Fl w Ar file Write the raw packets to .Ar file rather than parsing and printing -them out. They can be analyzed later with the +them out. +They can be analyzed later with the .Fl r option. Standard output is used if @@ -228,20 +231,22 @@ Like .Fl x but dumps the packet in emacs-hexl like format. .It Ar expression -selects which packets will be dumped. If no +selects which packets will be dumped. +If no .Ar expression -is given, all packets on the net will be dumped. Otherwise, -only packets satisfying +is given, all packets on the net will be dumped. +Otherwise, only packets satisfying .Ar expression will be dumped. .Pp The .Ar expression -consists of one or more primitives. Primitives usually consist of an +consists of one or more primitives. +Primitives usually consist of an .Ar id (name or number) -preceded by one or more qualifiers. There are three -different kinds of qualifiers: +preceded by one or more qualifiers. +There are three different kinds of qualifiers: .Bl -tag -width "proto" .It Fa type Specify which kind of address component the @@ -285,8 +290,8 @@ and .Cm outbound qualifiers can be used to specify a desired direction. .It Ar proto -Restrict the match to a particular protocol. Possible -protocols are: +Restrict the match to a particular protocol. +Possible protocols are: .Cm ether , .Cm fddi , .Cm ip , @@ -305,7 +310,7 @@ E.g., .Dq tcp port 21 . If there is no protocol qualifier, all protocols consistent with the type are -assumed. E.g., +assumed. e.g., .Dq src foo means .Do @@ -351,18 +356,21 @@ keywords that don't follow the pattern: .Cm broadcast , .Cm less , .Cm greater , -and arithmetic expressions. All of these are described below. +and arithmetic expressions. +All of these are described below. .Pp More complex filter expressions are built up by using the words .Cm and , .Cm or , and .Cm not -to combine primitives. E.g., +to combine primitives. +e.g., .Do host foo and not port ftp and not port ftp-data .Dc . -To save typing, identical qualifier lists can be omitted. E.g., +To save typing, identical qualifier lists can be omitted. +e.g., .Dq tcp dst port ftp or ftp-data or domain is exactly the same as .Do @@ -473,13 +481,13 @@ True if the source address of the packet has a network number of .Ar net . -.It Cm net Ar net +.It Cm net Ar net True if either the .Tn IP source or destination address of the packet has a network number of .Ar net . -.It Cm dst port Ar port +.It Cm dst port Ar port True if the packet is ip/tcp or ip/udp and has a destination port value of .Ar port . @@ -492,8 +500,8 @@ can be a number or a name used in and .Xr udp 4 ) . If a name is used, both the port -number and protocol are checked. If a number or ambiguous name is used -only the port number is checked; +number and protocol are checked. +If a number or ambiguous name is used only the port number is checked; e.g., .Dq Cm dst port No 513 will print both @@ -558,17 +566,20 @@ and .Cm icmp are also shell keywords and must be escaped. .It Cm ether broadcast -True if the packet is an Ethernet broadcast packet. The +True if the packet is an Ethernet broadcast packet. +The .Cm ether keyword is optional. .It Cm ip broadcast True if the packet is an .Tn IP -broadcast packet. It checks for both +broadcast packet. +It checks for both the all-zeroes and all-ones broadcast conventions and looks up the local subnet mask. .It Cm ether multicast -True if the packet is an Ethernet multicast packet. The +True if the packet is an Ethernet multicast packet. +The .Cm ether keyword is optional. This is shorthand for @@ -589,7 +600,8 @@ can be a number or a name like or .Cm rarp . These identifiers are also shell keywords -and must be escaped. In the case of +and must be escaped. +In the case of .Tn FDDI (e.g., .Dq Cm fddi protocol arp ) , @@ -724,7 +736,8 @@ The expression .Dq Cm ip Ns [0] \&& 0xf !\&= 5 catches all .Tn IP -packets with options. The expression +packets with options. +The expression .Dq Cm ip Ns [6:2] \&& 0x1fff \&= 0 catches only unfragmented datagrams and frag zero of fragmented datagrams. This check is implicitly applied to the @@ -744,8 +757,8 @@ intervening fragment. .Pp Primitives may be combined using a parenthesized group of primitives and operators. -Parentheses are special to the shell and must be escaped. Allowed -primitives and operators are: +Parentheses are special to the shell and must be escaped. +Allowed primitives and operators are: .Bd -ragged -offset indent Negation .Po @@ -771,13 +784,15 @@ or .Pp Negation has highest precedence. Alternation and concatenation have equal precedence and associate -left to right. Explicit +left to right. +Explicit .Cm and tokens, not juxtaposition, are now required for concatenation. .Pp If an identifier is given without a keyword, the most recent keyword -is assumed. For example, +is assumed. +For example, .Bd -ragged -offset indent .Cm not host vs @@ -923,8 +938,8 @@ packets that are not echo requests/replies (i.e., not ping packets): .Pp The output of .Nm -is protocol dependent. The following -gives a brief description and examples of most of the formats. +is protocol dependent. +The following gives a brief description and examples of most of the formats. .Pp .Em Link Level Headers .Pp @@ -941,11 +956,11 @@ networks, the option causes .Nm to print the frame control -field, the source and destination addresses, +field, the source and destination addresses, and the packet length. The frame control field governs the -interpretation of the rest of the packet. Normal packets (such as those -containing +interpretation of the rest of the packet. +Normal packets (such as those containing .Tn IP datagrams) are @@ -1005,7 +1020,8 @@ where .Ar n is the amount by which the sequence number (or sequence number and ack) -has changed. If it is not a special case, zero or more changes are printed. +has changed. +If it is not a special case, zero or more changes are printed. A change is indicated by .Sq U .Pq urgent pointer , @@ -1043,8 +1059,8 @@ O .Pp .Tn Em ARP\&/ Ns Tn Em RARP Packets .Pp -arp/rarp output shows the type of request and its arguments. The -format is intended to be self-explanatory. +arp/rarp output shows the type of request and its arguments. +The format is intended to be self-explanatory. Here is a short sample taken from the start of an rlogin from host rtsg to host csam: .Bd -literal -offset indent @@ -1142,8 +1158,8 @@ are tcp options enclosed in angle brackets (e.g., .Ar src , Ar dst and .Ar flags -are always present. The other fields -depend on the contents of the packet's tcp protocol header and +are always present. +The other fields depend on the contents of the packet's tcp protocol header and are output only if appropriate. .Pp Here is the opening portion of an rlogin from host rtsg to host csam. @@ -1160,7 +1176,8 @@ csam.login > rtsg.1023: P 3:4(1) ack 21 win 4077 urg 1 .Ed .Pp The first line says that tcp port 1023 on rtsg sent a packet -to port login on host csam. The +to port login on host csam. +The .Ql S indicates that the .Tn SYN @@ -1196,13 +1213,14 @@ The .Ql \&. means no flags were set. The packet contained no data so there is no data sequence number. -The ack sequence number is a 32-bit integer. The first time +The ack sequence number is a 32-bit integer. +The first time .Nm sees a tcp connection, it prints the sequence number from the packet. On subsequent packets of the connnection, the difference between the current packet's sequence number and this initial sequence number -is printed. This means that sequence numbers after the -first can be interpreted +is printed. +This means that sequence numbers after the first can be interpreted as relative byte positions in the connection's data stream .Po with the first data byte each direction being 1 @@ -1220,7 +1238,8 @@ The .Tn PUSH flag is set in the packet. On the 7th line, csam says it's received data sent by rtsg up to -but not including byte 21. Most of this data is apparently sitting in the +but not including byte 21. +Most of this data is apparently sitting in the socket buffer since csam's receive window has gotten 19 bytes smaller. Csam also sends one byte of data to rtsg in this packet. On the 8th and 9th lines, @@ -1236,7 +1255,8 @@ actinide.who \&> broadcast.who: udp 84 .Pp This says that port who on host actinide sent a udp datagram to port who on host broadcast, the Internet -broadcast address. The packet contained 84 bytes of user data. +broadcast address. +The packet contained 84 bytes of user data. .Pp Some .Tn UDP @@ -1283,16 +1303,18 @@ The query was 3. The .Ql + -indicates the recursion desired flag -was set. The query length was 37 bytes, not including the +indicates the recursion desired flag was set. +The query length was 37 bytes, not including the .Tn UDP and .Tn IP -protocol headers. The query operation was the normal one +protocol headers. +The query operation was the normal one .Pq Query so the .Ar op -field was omitted. If +field was omitted. +If .Ar op had been anything else, it would have been printed between the @@ -1302,12 +1324,13 @@ Similarly, the .Ar qclass was the normal one .Pq Tn C_IN -and was omitted. Any other +and was omitted. +Any other .Ar qclass would have been printed immediately after the A. .Pp A few anomalies are checked and may result in extra fields enclosed in -square brackets: If a query contains an answer, name server or +square brackets: if a query contains an answer, name server or authority section, .Ar ancount , .Ar nscount , @@ -1361,12 +1384,13 @@ In the first example, helios responds to query with 3 answer records, 3 name server records and 7 authority records. The first answer record is type A .Pq address and its data is internet -address 128.32.137.3. The total size of the response was 273 bytes, -excluding +address 128.32.137.3. +The total size of the response was 273 bytes, excluding .Tn UDP and .Tn IP -headers. The +headers. +The .Ar op .Pq Query and @@ -1385,10 +1409,11 @@ helios responds to query of non-existent domain .Pq NXDomain with no answers, -one name server and no authority records. The +one name server and no authority records. +The .Ql * -indicates that the authoritative answer -bit was set. Since there were no answers, no +indicates that the authoritative answer bit was set. +Since there were no answers, no .Ar type , .Ar class or @@ -1414,7 +1439,8 @@ Name server requests and responses tend to be large and the default .Ar snaplen of 68 bytes may not capture enough of the packet -to print. Use the +to print. +Use the .Fl s flag to increase the .Ar snaplen @@ -1454,11 +1480,13 @@ In the first line, host sushi sends a transaction with ID 6709 to wrl. The number following the src host is a transaction ID, .Em not -the source port. The request was 112 bytes, excluding the +the source port. +The request was 112 bytes, excluding the .Tn UDP and .Tn IP -headers. The +headers. +The .Ar op was a readlink (read symbolic link) on fh @@ -1473,8 +1501,9 @@ of ok and the contents of the link. .Pp In the third line, sushi asks wrl to lookup the name .Dq xcolors -in directory file 9,74/4096.6878. The data printed -depends on the operation type. The format is intended to be self-explanatory +in directory file 9,74/4096.6878. +The data printed depends on the operation type. +The format is intended to be self-explanatory if read in conjunction with an .Tn NFS protocol spec. @@ -1497,7 +1526,8 @@ also prints the and fragmentation fields, which have been omitted from this example. In the first line, sushi asks wrl to read 8192 bytes from file 21,11/12.195, -at byte offset 24576. Wrl replies with a +at byte offset 24576. +Wrl replies with a .Ar stat of ok; the packet shown on the @@ -1530,7 +1560,8 @@ flag is given more than once, even more details are printed. requests are very large and much of the detail won't be printed unless .Ar snaplen -is increased. Try using +is increased. +Try using .Dq Fl s No 192 to watch .Tn NFS @@ -1539,7 +1570,8 @@ traffic. .Tn NFS reply packets do not explicitly identify the .Tn RPC -operation. Instead, +operation. +Instead, .Nm keeps track of .Dq recent @@ -1577,8 +1609,8 @@ Lines in this file have the form 1.254.110 ace .Ed .Pp -The first two lines give the names of AppleTalk networks. The third -line gives the name of a particular host +The first two lines give the names of AppleTalk networks. +The third line gives the name of a particular host (a host is distinguished from a net by the 3rd octet in the number; a net number .Em must @@ -1621,7 +1653,8 @@ is known The third line is a send from port 235 on net jssmag node 149 to broadcast on the icsd-net .Tn NBP -port. The broadcast address (255) is indicated by a net name with no host +port. +The broadcast address (255) is indicated by a net name with no host number; for this reason it is a good idea to keep node names and net names distinct in .Pa /etc/atalk.names . @@ -1631,8 +1664,8 @@ net names distinct in and .Tn ATP .Pq AppleTalk transaction protocol -packets have their contents interpreted. Other protocols just dump -the protocol name +packets have their contents interpreted. +Other protocols just dump the protocol name .Po or number if no name is registered for the protocol @@ -1649,11 +1682,13 @@ techpit.2 > icsd-net.112.220: nbp-reply 190: "techpit:LaserWriter@*" 186 .Pp The first line is a name lookup request for laserwriters sent by net icsdi-net host -112 and broadcast on net jssmag. The nbp ID for the lookup is 190. +112 and broadcast on net jssmag. +The nbp ID for the lookup is 190. The second line shows a reply for this request .Pq note that it has the same id from host jssmag.209 saying that it has a laserwriter -resource named RM1140 registered on port 250. The third line is +resource named RM1140 registered on port 250. +The third line is another reply to the same request saying host techpit has laserwriter techpit registered on port 186. .Pp @@ -1691,15 +1726,17 @@ The following the transaction id gives the packet sequence number in the transaction and the number in parentheses is the amount of data in the packet, -excluding the atp header. The +excluding the atp header. +The .Ql * on packet 7 indicates that the .Tn EOM bit was set. .Pp -Jssmag.209 then requests that packets 3 & 5 be retransmitted. Helios -resends them then jssmag.209 releases the transaction. Finally, -jssmag.209 initiates the next request. The +Jssmag.209 then requests that packets 3 & 5 be retransmitted. +Helios resends them then jssmag.209 releases the transaction. +Finally, jssmag.209 initiates the next request. +The .Ql * on the request indicates that XO .Pq exactly once @@ -1723,7 +1760,8 @@ Fragmented Internet datagrams are printed as .Pp A .Ql + -indicates there are more fragments. The last fragment will have no +indicates there are more fragments. +The last fragment will have no .Ql + . .Pp .Ar id @@ -1739,10 +1777,10 @@ is this fragment's offset .Pq in bytes in the original datagram. .Pp -The fragment information is output for each fragment. The first -fragment contains the higher level protocol header and the fragment -info is printed after the protocol info. Fragments -after the first contain no higher level protocol header and the +The fragment information is output for each fragment. +The first fragment contains the higher level protocol header and the fragment +info is printed after the protocol info. +Fragments after the first contain no higher level protocol header and the fragment info is printed after the source and destination addresses. For example, here is part of an ftp from arizona.edu to lbl\(enrtsg.arpa over a @@ -1754,8 +1792,9 @@ arizona > rtsg: (frag 595a:204@328) rtsg.1170 > arizona.ftp-data: . ack 1536 win 2560 .Ed .Pp -There are a couple of things to note here: First, addresses in the -2nd line don't include port numbers. This is because the +There are a couple of things to note here: first, addresses in the +2nd line don't include port numbers. +This is because the .Tn TCP protocol information is all in the first fragment and we have no idea what the port or sequence numbers are when we print the later fragments. @@ -1777,14 +1816,14 @@ trailing .Pp .Em Timestamps .Pp -By default, all output lines are preceded by a timestamp. The timestamp -is the current clock time in the form +By default, all output lines are preceded by a timestamp. +The timestamp is the current clock time in the form .Sm off .Ar hh : mm : ss . frac .Sm on and is as accurate as the kernel's clock. -The timestamp reflects the time the kernel first saw the packet. No attempt -is made to account for the time lag between when the +The timestamp reflects the time the kernel first saw the packet. +No attempt is made to account for the time lag between when the Ethernet interface removed the packet from the wire and when the kernel serviced the .Dq new packet @@ -1813,7 +1852,8 @@ to compute the right length for the higher level protocol. Name server inverse queries are not dumped correctly: The .Pq empty question section is printed rather than real query in the answer -section. Some believe that inverse queries are themselves a bug and +section. +Some believe that inverse queries are themselves a bug and prefer to fix the program generating them rather than .Nm tcpdump . .Pp @@ -1835,7 +1875,8 @@ Filter expressions that manipulate .Tn FDDI headers assume that all .Tn FDDI -packets are encapsulated Ethernet packets. This is true for +packets are encapsulated Ethernet packets. +This is true for .Tn IP , .Tn ARP , and diff --git a/usr.sbin/timed/timed/timed.8 b/usr.sbin/timed/timed/timed.8 index cabd693f2c7..c857a0414a4 100644 --- a/usr.sbin/timed/timed/timed.8 +++ b/usr.sbin/timed/timed/timed.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: timed.8,v 1.5 1999/06/05 22:18:17 aaron Exp $ +.\" $OpenBSD: timed.8,v 1.6 2000/03/19 17:57:16 aaron Exp $ +.\" .\" Copyright (c) 1980, 1991 Regents of the University of California. .\" All rights reserved. .\" @@ -164,9 +165,10 @@ Messages printed by the kernel on the system console occur with interrupts disabled. This means that the clock stops while they are printing. A machine with many disk or network hardware problems and consequent -messages cannot keep good time by itself. Each message typically causes -the clock to lose a dozen milliseconds. A time daemon can -correct the result. +messages cannot keep good time by itself. +Each message typically causes +the clock to lose a dozen milliseconds. +A time daemon can correct the result. .Pp Messages in the system log about machines that failed to respond usually indicate machines that crashed or were turned off. @@ -189,7 +191,8 @@ flag is used, so that .Nm never attempts to adjust the local clock. .Pp -The protocol is based on UDP/IP broadcasts. All machines within +The protocol is based on UDP/IP broadcasts. +All machines within the range of a broadcast that are using the TSP protocol must cooperate. There cannot be more than a single administrative domain using the .Fl F diff --git a/usr.sbin/timed/timedc/timedc.8 b/usr.sbin/timed/timedc/timedc.8 index 5f51c7aed32..134083df3f8 100644 --- a/usr.sbin/timed/timedc/timedc.8 +++ b/usr.sbin/timed/timedc/timedc.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: timedc.8,v 1.6 1999/07/04 19:25:20 aaron Exp $ +.\" $OpenBSD: timedc.8,v 1.7 2000/03/19 17:57:16 aaron Exp $ +.\" .\" Copyright (c) 1980, 1991 Regents of the University of California. .\" All rights reserved. .\" @@ -69,8 +70,8 @@ will prompt for commands from the standard input. If arguments are supplied, .Nm interprets the first argument as a command and the remaining -arguments as parameters to the command. The standard input -may be redirected causing +arguments as parameters to the command. +The standard input may be redirected causing .Nm to read commands from a file. Commands may be abbreviated; diff --git a/usr.sbin/traceroute/traceroute.8 b/usr.sbin/traceroute/traceroute.8 index 3836bed9eb4..d1d733c1a75 100644 --- a/usr.sbin/traceroute/traceroute.8 +++ b/usr.sbin/traceroute/traceroute.8 @@ -1,3 +1,4 @@ +.\" $OpenBSD: traceroute.8,v 1.17 2000/03/19 17:57:16 aaron Exp $ .\" $NetBSD: traceroute.8,v 1.6 1995/10/12 03:05:50 mycroft Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 @@ -80,7 +81,7 @@ The default probe datagram length is 38 bytes, but this may be increased by specifying a packet size (in bytes) after the destination host name. .Pp -Other options are: +The options are as follows: .Bl -tag -width Ds .It Fl d Turn on socket-level debugging. @@ -90,13 +91,15 @@ Dump the packet data to standard error before transmitting it. Add .Ar gateway_addr to the list of addresses in the IP Loose Source Record Route (LSRR) -option. If no gateways are specified, the LSRR option is omitted. +option. +If no gateways are specified, the LSRR option is omitted. .It Fl l -Display the ttl value of the returned packet. This is useful for -checking for asymmetric routing. +Display the ttl value of the returned packet. +This is useful for checking for asymmetric routing. .It Fl m Ar max_ttl Set the max time-to-live (max number of hops) used in outgoing probe -packets. The default is 30 hops (the same default used for +packets. +The default is 30 hops (the same default used for .Tn TCP connections). .It Fl n @@ -132,7 +135,8 @@ at the destination host (so an .Tn ICMP .Dv PORT_UNREACHABLE message will -be returned to terminate the route tracing). If something is +be returned to terminate the route tracing). +If something is listening on a port in the default range, this option can be used to pick an unused port range. .It Fl c @@ -156,19 +160,21 @@ that has no route through it (e.g., after the interface was dropped by .It Fl s Ar src_addr Use the following IP address (which must be given as an IP number, not -a hostname) as the source address in outgoing probe packets. On -hosts with more than one IP address, this option can be used to +a hostname) as the source address in outgoing probe packets. +On hosts with more than one IP address, this option can be used to force the source address to be something other than the IP address -of the interface the probe packet is sent on. If the IP address +of the interface the probe packet is sent on. +If the IP address is not one of this machine's interface addresses and the user is not the superuser, an error is returned and nothing is sent. .It Fl t Ar tos Set the .Em type-of-service -in probe packets to the following value (default zero). The value must be -a decimal integer in the range 0 to 255. This option can be used to -see if different types-of-service result in different paths. (If you -are not running a +in probe packets to the following value (default zero). +The value must be a decimal integer in the range 0 to 255. +This option can be used to +see if different types-of-service result in different paths. +(If you are not running a .Bx 4.3 tahoe or later system, this may be academic since the normal network services like telnet and ftp don't let you control the @@ -176,14 +182,15 @@ services like telnet and ftp don't let you control the Not all values of .Dv TOS are legal or -meaningful \- see the IP spec for definitions. Useful values are -probably +meaningful \- see the IP spec for definitions. +Useful values are probably .Ql \-t 16 (low delay) and .Ql \-t 8 (high throughput). .It Fl v -Verbose output. Received +Verbose output. +Received .Tn ICMP packets other than .Dv TIME_EXCEEDED @@ -200,21 +207,23 @@ internet host by launching probe packets with a small ttl (time to live) then listening for an .Tn ICMP -"time exceeded" reply from a gateway. We start our probes -with a ttl of one and increase by one until we get an +"time exceeded" reply from a gateway. +We start out probes with a ttl of one and increase by one until we get an .Tn ICMP "port unreachable" (which means we got to "host") or hit a max (which defaults to 30 hops & can be changed with the .Fl m -flag). Three -probes (changed with +flag). +Three probes (changed with .Fl q flag) are sent at each ttl setting and a line is printed showing the ttl, address of the gateway and -round trip time of each probe. If the probe answers come from +round trip time of each probe. +If the probe answers come from different gateways, the address of each responding system will -be printed. If there is no response within a 5 sec. timeout +be printed. +If there is no response within a 5 sec. timeout interval (changed with the .Fl w flag), a "*" is printed for that @@ -246,7 +255,8 @@ traceroute to nis.nsf.net (35.1.1.48), 30 hops max, 56 byte packet 11 nic.merit.edu (35.1.1.48) 239 ms 239 ms 239 ms .Ed -Note that lines 2 & 3 are the same. This is due to a buggy +Note that lines 2 & 3 are the same. +This is due to a buggy kernel on the 2nd hop system \- lbl-csam.arpa \- that forwards packets with a zero ttl (a bug in the distributed version of 4.3 @@ -286,21 +296,22 @@ Note that the gateways 12, 14, 15, 16 & 17 hops away either don't send .Tn ICMP "time exceeded" messages or send them -with a ttl too small to reach us. 14 \- 17 are running the +with a ttl too small to reach us. +14 \- 17 are running the .Tn MIT -C Gateway code that doesn't send "time exceeded"s. God -only knows what's going on with 12. +C Gateway code that doesn't send "time exceeded"s. +God only knows what's going on with 12. .Pp The silent gateway 12 in the above may be the result of a bug in the 4.[23] .Tn BSD network code (and its derivatives): 4.x (x <= 3) sends an unreachable message using whatever ttl remains in the -original datagram. Since, for gateways, the remaining ttl is -zero, the +original datagram. +Since, for gateways, the remaining ttl is zero, the .Tn ICMP -"time exceeded" is guaranteed to not make it back -to us. The behavior of this bug is slightly more interesting +"time exceeded" is guaranteed to not make it back to us. +The behavior of this bug is slightly more interesting when it appears on the destination system: .Bd -literal 1 helios.ee.lbl.gov (128.3.112.1) 0 ms 0 ms 0 ms @@ -323,14 +334,16 @@ destination) and exactly the last half of them are "missing". What's really happening is that rip (a Sun-3 running Sun OS3.5) is using the ttl from our arriving datagram as the ttl in its .Tn ICMP -reply. So, the reply will time out on the return path +reply. +So, the reply will time out on the return path (with no notice sent to anyone since .Tn ICMP's aren't sent for .Tn ICMP's ) until we probe with a ttl that's at least twice the path -length. I.e., rip is really only 7 hops away. A reply that -returns with a ttl of 1 is a clue this problem exists. +length. +i.e., rip is really only 7 hops away. +A reply that returns with a ttl of 1 is a clue this problem exists. .Nm prints a "!" after the time if the ttl is <= 1. Since vendors ship a lot of obsolete @@ -353,8 +366,8 @@ Other possible annotations after the time are or .Sy !F (source route failed or fragmentation needed \- neither of these should -ever occur and the associated gateway is busted if you see one). If -almost all the probes result in some kind of unreachable, +ever occur and the associated gateway is busted if you see one). +If almost all the probes result in some kind of unreachable, .Nm will give up and exit. .Pp @@ -377,7 +390,8 @@ Because of the load it could impose on the network, it is unwise to use .Nm during normal operations or from automated scripts. .Sh AUTHOR -Implemented by Van Jacobson from a suggestion by Steve Deering. Debugged +Implemented by Van Jacobson from a suggestion by Steve Deering. +Debugged by a cast of thousands with particularly cogent suggestions or fixes from C. Philip Wood, Tim Seaver and Ken Adelman. .Sh SEE ALSO diff --git a/usr.sbin/trsp/trsp.8 b/usr.sbin/trsp/trsp.8 index 2f774d6b171..4cf1a0d204b 100644 --- a/usr.sbin/trsp/trsp.8 +++ b/usr.sbin/trsp/trsp.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: trsp.8,v 1.9 2000/03/05 00:28:51 aaron Exp $ +.\" $OpenBSD: trsp.8,v 1.10 2000/03/19 17:57:17 aaron Exp $ .\" .\" Copyright (c) 1985, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -118,8 +118,8 @@ Then run with the .Fl p option, supplying the associated -protocol control block addresses. If there are -many sockets using the debugging option, the +protocol control block addresses. +If there are many sockets using the debugging option, the .Fl j option may be useful in checking to see if any trace records are present for the socket in diff --git a/usr.sbin/vipw/vipw.8 b/usr.sbin/vipw/vipw.8 index 58ea7d8b8d1..d54295ed55f 100644 --- a/usr.sbin/vipw/vipw.8 +++ b/usr.sbin/vipw/vipw.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: vipw.8,v 1.5 1999/05/23 14:11:39 aaron Exp $ +.\" $OpenBSD: vipw.8,v 1.6 2000/03/19 17:57:17 aaron Exp $ .\" $NetBSD: vipw.8,v 1.4 1995/01/20 19:19:56 mycroft Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -49,7 +49,8 @@ and does any necessary processing after the password file is unlocked. If the password file is already locked for editing by another user, .Nm will ask you -to try again later. The default editor for +to try again later. +The default editor for .Nm is .Xr vi 1 . @@ -69,8 +70,10 @@ Once the information has been verified, .Nm uses .Xr pwd_mkdb 8 -to update the user database. This is run in the background, and, -at very large sites could take several minutes. Until this update +to update the user database. +This is run in the background, and, +at very large sites could take several minutes. +Until this update is completed, the password file is unavailable for other updates and the new information is not available to programs. .Pp diff --git a/usr.sbin/vnconfig/vnconfig.8 b/usr.sbin/vnconfig/vnconfig.8 index b107ced09e4..c40c4aa4aa1 100644 --- a/usr.sbin/vnconfig/vnconfig.8 +++ b/usr.sbin/vnconfig/vnconfig.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: vnconfig.8,v 1.11 2000/02/13 01:04:54 aaron Exp $ +.\" $OpenBSD: vnconfig.8,v 1.12 2000/03/19 17:57:17 aaron Exp $ .\ .\" Copyright (c) 1993 University of Utah. .\" Copyright (c) 1980, 1989, 1991, 1993 @@ -62,8 +62,8 @@ with the regular file .Ar regular_file allowing the latter to be accessed as though it were a disk. Hence a regular file within the filesystem can be used for swapping -or can contain a filesystem that is mounted in the name space. Both -traditional devices, +or can contain a filesystem that is mounted in the name space. +Both traditional devices, .Pa vnd , and the cache-coherent devices, .Pa svnd , diff --git a/usr.sbin/ypbind/ypbind.8 b/usr.sbin/ypbind/ypbind.8 index 77397826ba5..94e227cfe7c 100644 --- a/usr.sbin/ypbind/ypbind.8 +++ b/usr.sbin/ypbind/ypbind.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ypbind.8,v 1.13 2000/01/22 02:17:51 aaron Exp $ +.\" $OpenBSD: ypbind.8,v 1.14 2000/03/19 17:57:17 aaron Exp $ .\" $NetBSD: ypbind.8,v 1.2 1996/02/28 01:21:00 thorpej Exp $ .\" .\" Copyright (c) 1996 The NetBSD Foundation, Inc. @@ -52,8 +52,8 @@ finds the server for a particular YP domain and stores information about it in a .Pa binding file. This binding information includes the IP address of the server associated with -that particular domain and which port the server is using. This information -is stored in the directory +that particular domain and which port the server is using. +This information is stored in the directory .Pa /var/yp/binding in a file named with the convention .Pa DOMAINNAME.version. @@ -75,10 +75,12 @@ assumes it will need to use broadcasts to find a valid server. Using either of these techniques, .Nm will search for a server willing to serve maps for the -client's domain. Once a binding is established, +client's domain. +Once a binding is established, .Nm maintains this binding by periodically communicating with the server to which -it is bound. If the binding is somehow lost, e.g by server reboot, +it is bound. +If the binding is somehow lost, e.g by server reboot, .Nm marks the domain as unbound and attempts to re-establish the binding. When the binding is once again successful, @@ -97,8 +99,8 @@ to which a domain is bound. .It Fl insecure permit binding to a .Xr ypserv 8 -on a non-reserved port. This is needed if receiving maps from -SunOS 3.x or Ultrix. +on a non-reserved port. +This is needed if receiving maps from SunOS 3.x or Ultrix. .El .Pp The diff --git a/usr.sbin/ypserv/makedbm/makedbm.8 b/usr.sbin/ypserv/makedbm/makedbm.8 index 8201bd83aa5..d54aed296fa 100644 --- a/usr.sbin/ypserv/makedbm/makedbm.8 +++ b/usr.sbin/ypserv/makedbm/makedbm.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: makedbm.8,v 1.7 1999/06/05 22:18:23 aaron Exp $ +.\" $OpenBSD: makedbm.8,v 1.8 2000/03/19 17:57:18 aaron Exp $ +.\" .\" Copyright (c) 1994-97 Mats O Jansson <moj@stacken.kth.se> .\" All rights reserved. .\" @@ -63,14 +64,17 @@ but also try .Xr db 3 hash format. .It Fl b -Interdomain. Include an entry in the database informing a YP server to use -DNS to get information about unknown hosts. This option will only have +Interdomain. +Include an entry in the database informing a YP server to use +DNS to get information about unknown hosts. +This option will only have effect on the two maps hosts.byname and hosts.byaddr. .It Fl l -Lowercase. Convert all keys to lower case before adding them to the YP -database. +Lowercase. +Convert all keys to lower case before adding them to the YP database. .It Fl s -Secure map. Include an entry in the database informing +Secure map. +Include an entry in the database informing .Xr ypxfr 8 and .Xr ypserv 8 diff --git a/usr.sbin/ypserv/mkalias/mkalias.8 b/usr.sbin/ypserv/mkalias/mkalias.8 index 333edf91e62..d9c948483ab 100644 --- a/usr.sbin/ypserv/mkalias/mkalias.8 +++ b/usr.sbin/ypserv/mkalias/mkalias.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: mkalias.8,v 1.3 1999/06/05 22:18:24 aaron Exp $ +.\" $OpenBSD: mkalias.8,v 1.4 2000/03/19 17:57:18 aaron Exp $ +.\" .\" Copyright (c) 1997 Mats O Jansson <moj@stacken.kth.se> .\" All rights reserved. .\" @@ -46,8 +47,8 @@ .Op Ar output .Sh DESCRIPTION .Nm -is used to convert a mail.aliases map to a mail.byaddr map. This is -an inverse map of user@host (or user!host) back to alias. +is used to convert a mail.aliases map to a mail.byaddr map. +This is an inverse map of user@host (or user!host) back to alias. .Pp .Pp The options are as follows: @@ -61,21 +62,24 @@ Same as .Fl e , but also check for any MX-record. .It Fl d -Assume Domain names are OK. Only useful together with +Assume Domain names are OK. +Only useful together with .Fl e or .Fl E . .It Fl u -Assume UUCP names are OK. Only useful together with +Assume UUCP names are OK. +Only useful together with .Fl e or .Fl E . .It Fl n -Capitalize name. eg mats.o.jansson becomes Mats.O.Jansson. +Capitalize name. e.g., mats.o.jansson becomes Mats.O.Jansson. .It Ar input Use this map as input. .It Ar output -Use this map as output. If the output map isn't given don't create database. +Use this map as output. +If the output map isn't given don't create database. Can be useful together with .Fl e or @@ -85,7 +89,8 @@ or .Nm on SunOS 4.1.x seems to have a .Fl s . -Since I don't know what it is supposed to do I haven't implemented it. But it is accepted by the program. +Since I don't know what it is supposed to do I haven't implemented it. +But it is accepted by the program. .Sh SEE ALSO .Xr yp 8 , .Xr ypserv 8 diff --git a/usr.sbin/ypserv/mknetid/mknetid.8 b/usr.sbin/ypserv/mknetid/mknetid.8 index f624915e659..f17b6718b44 100644 --- a/usr.sbin/ypserv/mknetid/mknetid.8 +++ b/usr.sbin/ypserv/mknetid/mknetid.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: mknetid.8,v 1.6 1999/06/05 22:18:25 aaron Exp $ +.\" $OpenBSD: mknetid.8,v 1.7 2000/03/19 17:57:18 aaron Exp $ +.\" .\" Copyright (c) 1996 Mats O Jansson <moj@stacken.kth.se> .\" All rights reserved. .\" @@ -60,26 +61,31 @@ The options are as follows: .It Fl d Ar domain Which yp-domain if not default yp-domain. .It Fl q -Keep quiet about multiple occurrences of a UID. Ignore all but the first. +Keep quiet about multiple occurrences of a UID. +Ignore all but the first. .It Fl p Ar passwdfile Alternate .Xr passwd 5 -file. Default is +file. +Default is .Pa /etc/passwd . .It Fl g Ar groupfile Alternate .Xr group 5 -file. Default is +file. +Default is .Pa /etc/group . .It Fl h Ar hostfile Alternate .Xr hosts 5 -file. Default is +file. +Default is .Pa /etc/hosts . .It Fl m Ar netidfile Alternate .Xr netid 5 -file. Default is +file. +Default is .Pa /etc/netid . file. .El diff --git a/usr.sbin/ypserv/revnetgroup/revnetgroup.8 b/usr.sbin/ypserv/revnetgroup/revnetgroup.8 index 3ef4ecc376e..799014fa2f1 100644 --- a/usr.sbin/ypserv/revnetgroup/revnetgroup.8 +++ b/usr.sbin/ypserv/revnetgroup/revnetgroup.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: revnetgroup.8,v 1.4 1999/07/03 02:11:11 aaron Exp $ +.\" $OpenBSD: revnetgroup.8,v 1.5 2000/03/19 17:57:18 aaron Exp $ +.\" .\" Copyright (c) 1995 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. .\" @@ -48,22 +49,25 @@ processes the contents of a file in .Xr netgroup 5 format into what is called .Pa reverse netgroup -form. That is, where the original file shows +form. +That is, where the original file shows netgroup memberships in terms of which members reside in a particular group, the reverse netgroup format specifies what groups are associated -with a particular member. This information is used to generate the +with a particular member. +This information is used to generate the .Nm netgroup.byuser and .Nm netgroup.byhosts -YP maps. These reverse netgroup maps are used to help speed up +YP maps. +These reverse netgroup maps are used to help speed up netgroup lookups, particularly for the .Fn innetgr library function. .Pp For example, the standard .Nm /etc/netgroup -file may list a netgroup and a list of its members. Here, the -netgroup is considered the +file may list a netgroup and a list of its members. +Here, the netgroup is considered the .Pa key and the member names are the .Pa data . @@ -71,7 +75,8 @@ By contrast, the reverse .Nm netgroup.byusers database lists each unique member as the key and the netgroups to which the members belong become -the data. Separate databases are created to hold information pertaining +the data. +Separate databases are created to hold information pertaining to users and hosts; this allows netgroup username lookups and netgroup hostname lookups to be performed using independent keyspaces. .Pp @@ -79,14 +84,15 @@ By constructing these reverse netgroup databases (and the corresponding YP maps) in advance, the .Xr getnetgrent 3 library functions are spared from having to work out the dependencies -themselves on the fly. This is important on networks with large numbers +themselves on the fly. +This is important on networks with large numbers of users and hosts, since it can take a considerable amount of time to process very large netgroup databases. .Pp The .Nm revnetgroup -command prints its results on the standard output. It is usually called -only by +command prints its results on the standard output. +It is usually called only by .Nm /var/yp/\<domain\>/Makefile when rebuilding the YP netgroup maps. .Sh OPTIONS @@ -109,9 +115,12 @@ The .Nm revnetgroup command uses .Nm /etc/netgroup -as its default input file. The +as its default input file. +The .Fl f -flag allows the user to specify an alternate input file. Specifying ``-'' +flag allows the user to specify an alternate input file. +Specifying +.Dq - as the input file causes .Nm revnetgroup to read from the standard input. @@ -125,8 +134,8 @@ and .Nm revnetgroup to build the YP databases. .It Pa /etc/netgroup -The default netgroup database file. This file is most often found -only on the YP master server. +The default netgroup database file. +This file is most often found only on the YP master server. .El .Sh SEE ALSO .Xr getnetgrent 3 , diff --git a/usr.sbin/ypserv/stdethers/stdethers.8 b/usr.sbin/ypserv/stdethers/stdethers.8 index 7d166defe5b..eff0ff6988f 100644 --- a/usr.sbin/ypserv/stdethers/stdethers.8 +++ b/usr.sbin/ypserv/stdethers/stdethers.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: stdethers.8,v 1.6 1999/07/03 02:11:11 aaron Exp $ +.\" $OpenBSD: stdethers.8,v 1.7 2000/03/19 17:57:18 aaron Exp $ +.\" .\" Copyright (c) 1995 Mats O Jansson <moj@stacken.kth.se> .\" All rights reserved. .\" @@ -43,7 +44,8 @@ is used to get rid of unwanted information in .Ar file , or the standard input if no .Ar file -argument is given. This utility is used by YP when creating YP maps. +argument is given. +This utility is used by YP when creating YP maps. .Sh SEE ALSO .Xr yp 8 , .Xr ypserv 8 diff --git a/usr.sbin/ypserv/stdhosts/stdhosts.8 b/usr.sbin/ypserv/stdhosts/stdhosts.8 index e709bfe44d5..0e00c8c7849 100644 --- a/usr.sbin/ypserv/stdhosts/stdhosts.8 +++ b/usr.sbin/ypserv/stdhosts/stdhosts.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: stdhosts.8,v 1.7 1999/07/03 02:11:11 aaron Exp $ +.\" $OpenBSD: stdhosts.8,v 1.8 2000/03/19 17:57:18 aaron Exp $ +.\" .\" Copyright (c) 1994 Mats O Jansson <moj@stacken.kth.se> .\" All rights reserved. .\" @@ -43,7 +44,8 @@ is used to get rid of unwanted information from .Ar file , or the standard input if no .Ar file -argument is given. This utility is used by YP when creating YP maps. +argument is given. +This utility is used by YP when creating YP maps. .Sh SEE ALSO .Xr yp 8 , .Xr ypserv 8 diff --git a/usr.sbin/ypserv/ypinit/ypinit.8 b/usr.sbin/ypserv/ypinit/ypinit.8 index ef8b9bfc569..4bac2dc1d1e 100644 --- a/usr.sbin/ypserv/ypinit/ypinit.8 +++ b/usr.sbin/ypserv/ypinit/ypinit.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: ypinit.8,v 1.3 1999/06/05 22:18:30 aaron Exp $ +.\" $OpenBSD: ypinit.8,v 1.4 2000/03/19 17:57:19 aaron Exp $ +.\" .\" Copyright (c) 1997 Mats O Jansson <moj@stacken.kth.se> .\" All rights reserved. .\" @@ -48,17 +49,20 @@ may be used to setup a YP server, or to change the ypserver map. The options are as follows: .Bl -tag -width indent .It Fl m Ar domainname -Setup a master YP server. If +Setup a master YP server. +If .Ar domainname is not given the default domainname will be used. .It Fl s Ar master_server Op Ar domainname -Setup a slave YP server. If +Setup a slave YP server. +If .Ar domainname is not given the default domainname will be used. .Ar master_server must be a running YP master server. .It Fl u Op Ar domainname -Update the ypserver map on a YP master server. If +Update the ypserver map on a YP master server. +If .Ar domainname is not given the default domainname will be used. .El diff --git a/usr.sbin/ypserv/yppush/yppush.8 b/usr.sbin/ypserv/yppush/yppush.8 index 0c6296c9c2f..61f82ba6798 100644 --- a/usr.sbin/ypserv/yppush/yppush.8 +++ b/usr.sbin/ypserv/yppush/yppush.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: yppush.8,v 1.5 1999/06/05 22:18:31 aaron Exp $ +.\" $OpenBSD: yppush.8,v 1.6 2000/03/19 17:57:19 aaron Exp $ +.\" .\" Copyright (c) 1995 Mats O Jansson <moj@stacken.kth.se> .\" All rights reserved. .\" @@ -45,8 +46,8 @@ .Sh DESCRIPTION .Nm yppush is used to distribute an YP map from a master server to any -slave server in the domain. All servers of the domain is fetched from the YP -map ypservers. +slave server in the domain. +All servers of the domain is fetched from the YP map ypservers. .Pp The options are as follows: .Bl -tag -width indent @@ -59,7 +60,8 @@ Distribute map only to one host and not to the hosts in the ypserver map. .\".It Fl t Ar timeout .\"Set the amount of time to elapse before a timeout is registered. .It Fl v -Verbose. Announce what the program is doing. +Verbose. +Announce what the program is doing. .El .Sh SEE ALSO .Xr yp 8 , diff --git a/usr.sbin/ypserv/ypserv/ypserv.8 b/usr.sbin/ypserv/ypserv/ypserv.8 index fbf58c4ac83..efcbc4a2ee3 100644 --- a/usr.sbin/ypserv/ypserv/ypserv.8 +++ b/usr.sbin/ypserv/ypserv/ypserv.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: ypserv.8,v 1.13 1999/06/05 22:18:33 aaron Exp $ +.\" $OpenBSD: ypserv.8,v 1.14 2000/03/19 17:57:19 aaron Exp $ +.\" .\" Copyright (c) 1994 Mats O Jansson <moj@stacken.kth.se> .\" All rights reserved. .\" @@ -48,18 +49,21 @@ on the network. .Pp A YP map is stored on the server as a .Xr db 3 -database. A number of YP maps is grouped together in a domain. +database. +A number of YP maps is grouped together in a domain. .Nm determines the domains it serves by looking for a directory with the domain name in .Pa /var/yp . .Pp -YP hasn't been known for high security through the years. In recent years -security has improved by restricting access to the server. In SunOS 4.1 +YP hasn't been known for high security through the years. +In recent years +security has improved by restricting access to the server. +In SunOS 4.1 has a new file occurred named .Pa /var/yp/securenet . -It contains networks the server can assume is secure. For information about -file format see +It contains networks the server can assume is secure. +For information about file format see .Xr securenet 5 . .Pp Before the author of this server had seen @@ -68,8 +72,8 @@ another format, .Xr ypserv.acl 5 , was implemented. This file format makes it possible to allow and deny hosts and networks -access to the server. This file can have any name since it's given by -the argument to +access to the server. +This file can have any name since it's given by the argument to .Fl a (use full path). .Pp @@ -107,10 +111,12 @@ to answer old YP version 1 requests. .It Fl a Ar aclfile Don't use .Pa /var/yp/securenet . -Use another file with a different file format. For further information see +Use another file with a different file format. +For further information see .Xr ypserv.acl 5 . .It Fl d -Use Internet Domain Name System. If a query to map +Use Internet Domain Name System. +If a query to map .Dq hosts.byname or .Dq hosts.byaddr diff --git a/usr.sbin/ypserv/yptest/yptest.8 b/usr.sbin/ypserv/yptest/yptest.8 index 469897e0b59..9548f7cd072 100644 --- a/usr.sbin/ypserv/yptest/yptest.8 +++ b/usr.sbin/ypserv/yptest/yptest.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: yptest.8,v 1.6 1999/06/05 22:18:35 aaron Exp $ +.\" $OpenBSD: yptest.8,v 1.7 2000/03/19 17:57:19 aaron Exp $ +.\" .\" Copyright (c) 1994 Mats O Jansson <moj@stacken.kth.se> .\" All rights reserved. .\" diff --git a/usr.sbin/ypserv/ypxfr/ypxfr.8 b/usr.sbin/ypserv/ypxfr/ypxfr.8 index 7d1092569a9..f0815df3292 100644 --- a/usr.sbin/ypserv/ypxfr/ypxfr.8 +++ b/usr.sbin/ypserv/ypxfr/ypxfr.8 @@ -1,4 +1,5 @@ -.\" $OpenBSD: ypxfr.8,v 1.8 1999/06/05 22:18:36 aaron Exp $ +.\" $OpenBSD: ypxfr.8,v 1.9 2000/03/19 17:57:19 aaron Exp $ +.\" .\" Copyright (c) 1994 Mats O Jansson <moj@stacken.kth.se> .\" All rights reserved. .\" @@ -28,7 +29,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $OpenBSD: ypxfr.8,v 1.8 1999/06/05 22:18:36 aaron Exp $ +.\" $OpenBSD: ypxfr.8,v 1.9 2000/03/19 17:57:19 aaron Exp $ .\" .Dd August 18, 1994 .Dt YPXFR 8 @@ -49,7 +50,8 @@ is the utiliy in YP that transfers maps to the local host. .Pp Since the YP master transfers a map when it has changed, an YP slave should -check for missed maps regulary. This can be done via an entry in +check for missed maps regulary. +This can be done via an entry in .Xr crontab 5 . The scripts .Ar ypxfr_1perhour , ypxfr_2perday @@ -61,11 +63,12 @@ The options are as follows: .Bl -tag -width indent .It Fl b Preserve the entry in the database informing a YP server to use -DNS to get information about unknown hosts. This option will only have +DNS to get information about unknown hosts. +This option will only have effect on the two maps hosts.byname and hosts.byaddr. .It Fl c -Don't send a "Clear current map" to local ypserv process. Useful if ypserv -isn't running localy to avoid timeout message. +Don't send a "Clear current map" to local ypserv process. +Useful if ypserv isn't running localy to avoid timeout message. .It Fl f Force map transfer, even if version of master is older than local copy. .It Fl d Ar domain @@ -75,8 +78,8 @@ Get map from host instead of the maps master host. .It Fl s Ar domain Specify a source domain other than the target domain. .It Fl C Ar tid prog ipadd port -This option is only used by ypserv. This is to open communication with -an yppush on another host. +This option is only used by ypserv. +This is to open communication with a yppush on another host. .El .Sh FILES .Bl -tag -width /usr/sbin/ypxfr_1perhour -compact |