Date: Mon, 2 Dec 1996 16:08:10 +0100 (MET) From: Sandro Sigala <sandro@cat.local.net> To: FreeBSD-gnats-submit@freebsd.org Subject: docs/2134: Some fixes to man pages (typos, mdoc style, etc.) Message-ID: <199612021508.QAA04996@cat.local.net> Resent-Message-ID: <199612021420.GAA23005@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 2134
>Category: docs
>Synopsis: man pages with typos
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-bugs
>State: open
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Mon Dec 2 06:20:01 PST 1996
>Last-Modified:
>Originator: Sandro Sigala
>Organization:
>Release: FreeBSD 2.1-STABLE i386
>Environment:
FreeBSD cat.local.net 2.1.5-RELEASE \
FreeBSD 2.1.5-RELEASE #0: Sun Nov 17 13:36:52 MET 1996 \
sandro@cat.local.net:/usr/src/sys/compile/ARGENTO i386
The patch is -current relative.
>Description:
Some FreeBSD man pages contain typos or are wrongly written.
I have included a patch.
>How-To-Repeat:
>Fix:
Index: sbin/i386/comcontrol/comcontrol.8
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/sbin/i386/comcontrol/comcontrol.8,v
retrieving revision 1.8
diff -u -r1.8 comcontrol.8
--- comcontrol.8 1996/01/30 16:32:10 1.8
+++ comcontrol.8 1996/12/02 13:33:22
@@ -44,7 +44,7 @@
startup script.
.Sh SEE ALSO
.Xr sio 4 ,
-.Xr stty 1 .
+.Xr stty 1
.Sh FILES
.Bl -tag -width Pa
.It Pa /dev/ttyd?
@@ -57,7 +57,6 @@
.Nm comcontrol
should be named
.Nm siocontrol .
-.
.Sh HISTORY
Originally part of cgd's com package patches, version 0.2.1, to 386BSD 0.1.
Once controlled bidirectional capabilities. Little is left to control now
Index: sbin/i386/nextboot/nextboot.8
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/sbin/i386/nextboot/nextboot.8,v
retrieving revision 1.3
diff -u -r1.3 nextboot.8
--- nextboot.8 1996/09/23 22:23:15 1.3
+++ nextboot.8 1996/12/02 13:36:50
@@ -11,8 +11,7 @@
.Ar filename bootstring ...
.Pp
.Nm
-.Op Fl e
-.Op Fl d
+.Op Fl ed
.Ar filename
.Bl -tag -width time
.It Fl b
@@ -74,8 +73,6 @@
the nameblock be non-existant, then the name compiled into the boot blocks
will be used for the boot rather than the next name in the nameblock. The
nameblock is only consulted ONCE per boot.
-
-
.Sh SEE ALSO
.Xr boot 8 ,
.Xr disklabel 8 ,
@@ -85,8 +82,7 @@
The option of whether to write back or not should be stored on the
disk and not a compile time option. I want to rethink this at some
later stage to make it co-exist with disks that do not have
-a fdisk partitioning table (i.e. purely disklabel'd systems)
-
+a fdisk partitioning table (i.e. purely disklabel'd systems).
.Pp
Whether to write back or not should be specified at run-time in the nameblock
so that the boot blocks need not be altered to get this feature.
Index: sbin/modload/modload.c
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/sbin/modload/modload.c,v
retrieving revision 1.13
diff -u -r1.13 modload.c
--- modload.c 1996/08/13 00:50:59 1.13
+++ modload.c 1996/11/28 13:24:30
@@ -120,11 +120,8 @@
void
usage()
{
-
- fprintf(stderr, "usage:\n");
- fprintf(stderr, "modload [-d] [-v] [-q] [-u] [-A <kernel>] [-e <entry]\n");
- fprintf(stderr,
- "[-p <postinstall>] [-o <output file>] <input file>\n");
+ fprintf(stderr, "usage: modload [-dquv] [-A kernel] [-e entry] [-p postinstall]\n");
+ fprintf(stderr, " [-o output_file] input_file\n");
exit(1);
}
Index: sbin/modunload/modunload.8
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/sbin/modunload/modunload.8,v
retrieving revision 1.4
diff -u -r1.4 modunload.8
--- modunload.8 1995/10/26 21:44:11 1.4
+++ modunload.8 1996/11/28 13:28:00
@@ -33,27 +33,27 @@
.Nd unload a kernel module
.Sh SYNOPSIS
.Nm modunload
-.Op Fl i Ar id
-.Op Fl n Ar name
+.Op Fl i Ar module_id
+.Op Fl n Ar module_name
.Sh DESCRIPTION
The
.Nm
utility unloads a loadable kernel module from a running system.
The
-.Ar id
+.Ar module_id
or
-.Ar name
+.Ar module_name
is the ID or name of the module as shown by
.Xr modstat 8 .
.Pp
One of the following options must be specified:
.Bl -tag -width indent
-.It Fl i Ar id
+.It Fl i Ar module_id
Unload the module with the ID
-.Ar id .
-.It Fl n Ar name
+.Ar module_id .
+.It Fl n Ar module_name
Unload the module with the name
-.Ar name .
+.Ar module_name .
.El
.Sh DIAGNOSTICS
The
Index: sbin/modunload/modunload.c
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/sbin/modunload/modunload.c,v
retrieving revision 1.1
diff -u -r1.1 modunload.c
--- modunload.c 1994/08/19 12:07:21 1.1
+++ modunload.c 1996/11/28 13:25:34
@@ -50,8 +50,7 @@
usage()
{
- fprintf(stderr, "usage:\n");
- fprintf(stderr, "modunload [-i <module id>] [-n <module name>]\n");
+ fprintf(stderr, "usage: modunload [-i module_id] [-n module_name]\n");
exit(1);
}
Index: sbin/reboot/boot_i386.8
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/sbin/reboot/boot_i386.8,v
retrieving revision 1.4
diff -u -r1.4 boot_i386.8
--- boot_i386.8 1996/01/29 23:52:33 1.4
+++ boot_i386.8 1996/12/02 13:39:21
@@ -158,7 +158,7 @@
.Xr halt 8 ,
.Xr reboot 8 ,
.Xr shutdown 8 ,
-.Xr disklabel 8 .
+.Xr disklabel 8
.Sh BUGS
The disklabel format used by this version of
.Bx
Index: usr.bin/at/at.man
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/usr.bin/at/at.man,v
retrieving revision 1.4
diff -u -r1.4 at.man
--- at.man 1995/10/05 06:18:48 1.4
+++ at.man 1996/12/02 13:51:52
@@ -241,7 +241,7 @@
.Xr umask 2 ,
.Xr sh 1 ,
.Xr sendmail 8 ,
-.Xr atrun 8 .
+.Xr atrun 8
.El
.Sh BUGS
.Pp
Index: usr.bin/finger/finger.1
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/usr.bin/finger/finger.1,v
retrieving revision 1.5
diff -u -r1.5 finger.1
--- finger.1 1996/03/15 16:41:47 1.5
+++ finger.1 1996/11/28 13:31:08
@@ -196,7 +196,7 @@
.Xr chpass 1 ,
.Xr w 1 ,
.Xr who 1 ,
-.Xr ttcp 4 .
+.Xr ttcp 4
.Sh HISTORY
The
.Nm finger
Index: usr.bin/man/apropos/apropos.man
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/gnu/usr.bin/man/apropos/apropos.man,v
retrieving revision 1.3
diff -u -r1.3 apropos.man
--- apropos.man 1996/07/08 20:03:17 1.3
+++ apropos.man 1996/12/02 14:04:38
@@ -12,25 +12,29 @@
.\" The University of Texas at Austin
.\" Austin, Texas 78712
.\"
-.TH apropos 1 "Jan 15, 1991"
-.LO 1
-.SH NAME
-apropos, whatis \- search the whatis database
-.SH SYNOPSIS
-.BI apropos
-keyword ...
-
-.BI whatis
-keyword ...
-.SH DESCRIPTION
-.B apropos
+.Dd Jan 15, 1991
+.Dt APROPOS 1
+.Os
+.Sh NAME
+.Nm apropos , whatis
+.Nd search the whatis database
+.Sh SYNOPSIS
+.Nm apropos
+.Ar keyword ...
+.br
+.Nm whatis
+.Ar keyword ...
+.Sh DESCRIPTION
+.Nm apropos
searches a set of database files containing short descriptions
of system commands for keywords and displays the result on the
standard output.
-.B whatis
+.Nm whatis
display only complete word matches.
+.Sh RETURN VALUES
The
-.B apropos
+.Nm apropos
utility exits 0 on success, and 1 if no keyword matched.
-.SH "SEE ALSO"
-man(1), makewhatis(1).
+.Sh SEE ALSO
+.Xr man 1 ,
+.Xr makewhatis 1
Index: usr.bin/man/catman/catman.1
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/gnu/usr.bin/man/catman/catman.1,v
retrieving revision 1.8
diff -u -r1.8 catman.1
--- catman.1 1996/08/27 20:03:59 1.8
+++ catman.1 1996/12/02 14:33:15
@@ -25,14 +25,12 @@
.\" /usr/bin/catman - preformat man pages
.\"
.\" $Id: catman.1,v 1.8 1996/08/27 20:03:59 wosch Exp $
-
.Dd Mar 12, 1995
.Dt CATMAN 1
.Os
.Sh NAME
.Nm catman
.Nd preformat man pages
-
.Sh SYNOPSIS
.Nm catman
.Op Fl f | Fl force
@@ -41,7 +39,6 @@
.Op Fl r | Fl remove
.Op Fl v | Fl verbose
.Op Ar directories...
-
.Sh DESCRIPTION
.Nm Catman
format man pages to ASCII. It's like typing
@@ -56,29 +53,21 @@
if no
.Ar directories
defined.
-
.Sh OPTIONS
.Bl -tag -width Ds
-
.It Fl f , Fl force
Force overwriting old cat pages. Normally only those pages will be formatted
which are not up to date. This option is a waste of time, CPU and RAM.
-
.It Fl h , Fl help
Print options and exit.
-
.It Fl p , Fl print
Don't actually format man pages. Show what would be done.
-
.It Fl r , Fl remove
Remove garbage, e.\& g. catpage without manpage, uncompressed catpage but
a compressed catpage exist, filenames with non-alphanumeric
characters, uncompressed manpage but a compressed manpage exist.
-
.It Fl v , Fl verbose
More warnings.
-
-
.Sh EXAMPLES
.Pp
.Dl $ catman
@@ -86,12 +75,10 @@
Format man pages in
.Ar /usr/share/man
if neccessary.
-
.Pp
.Dl $ catman $MANPATH
.Pp
Format all your man pages if neccessary.
-
.Pp
.Dl $ catman -f /usr/local/man/man1 /usr/local/man/manl
.Pp
@@ -99,12 +86,10 @@
.Pa /usr/local/man/man1
and
.Pa /usr/local/man/manl .
-
.Pp
.Dl $ catman -p /usr/X11/man
.Pp
Show only.
-
.Sh FILES
.Bl -tag -width /etc/master.passwdxx -compact
.Pa /etc/weekly :
@@ -114,10 +99,8 @@
.Pa /etc/daily
.Pc
.El
-
.Sh FEATURES
Very fast if all man pages already formatted.
-
Does not support the
.Fl w
option as some other systems do. Use
@@ -130,23 +113,20 @@
is a setuid program. Be careful that user
.Sq man
has write permissions to the catman directories.
-
.Nm Catman
does not check for any
.Sq .so
in man page sources. Use hard or symlinks
to avoid redundant formatted man pages.
-
.Sh SEE ALSO
.Xr man 1 ,
.Xr manpath 1 ,
-.Xr makewhatis 1 .
-
+.Xr makewhatis 1
.Sh HISTORY
This version of
.Nm catman
-command appeared in FreeBSD 2.1
-
+command appeared in
+.Fx 2.1 .
.Sh AUTHOR
Wolfram Schneider
.Aq wosch@FreeBSD.org ,
Index: usr.bin/man/makewhatis/makewhatis.1
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/gnu/usr.bin/man/makewhatis/makewhatis.1,v
retrieving revision 1.6
diff -u -r1.6 makewhatis.1
--- makewhatis.1 1996/08/27 20:04:05 1.6
+++ makewhatis.1 1996/12/02 14:01:58
@@ -23,15 +23,12 @@
.\" SUCH DAMAGE.
.\"
.\" $Id: makewhatis.1,v 1.6 1996/08/27 20:04:05 wosch Exp $
-
-
.Dd Jan, 12, 1995
.Dt MAKEWHATIS 1
.Os FreeBSD 2.1
.Sh NAME
.Nm makewhatis
.Nd create whatis database
-
.Sh SYNOPSIS
.Nm
.Op Fl a | Fl append
@@ -41,7 +38,6 @@
.Op Fl o | Fl outfile Ar file
.Op Fl v | Fl verbose
.Op Ar directories ...
-
.Sh DESCRIPTION
.Nm
extracts the name and a short description from unformatted manpages
@@ -50,7 +46,6 @@
database.
.Nm
can read gzip'ed manpages.
-
.Ar Directory
names a directory containing manpage subdirectories
.Pq named Pa man.+ .
@@ -59,7 +54,6 @@
or
.Ic makewhatis `manpath`
are allowed.
-
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl a , Fl append
@@ -67,26 +61,21 @@
the new database will be sorted without repeated lines and
.Nm
does not check if old entries are valid.
-
.It Fl h , Fl help
Print options and exit.
-
.It Fl i , Fl indent Ar column
Justify description strings to
.Ar column Pq default 24 .
-
.It Fl n , Fl name Ar name
Use
.Ar name
instead of
.Pa whatis Ns .
-
.It Fl o , Fl outfile Ar file
Write all output to
.Ar file
instead of
.Pa dirname/whatis Ns .
-
.It Fl v, Fl verbose
Issue more warnings
.Pq to stderr .
@@ -98,8 +87,6 @@
.Ql +
for a link.
.El
-
-
.Sh EXAMPLES
.Pp
.Ic makewhatis $MANPATH
@@ -127,7 +114,6 @@
instead of
.Pa whatis Ns .
May be useful for Solaris.
-
.Sh FILES
.Bl -tag -width /etc/master.passwdxx -compact
.It Pa */man/whatis
@@ -137,7 +123,6 @@
.Nm makewhatis.local
every week
.El
-
.Sh SEE ALSO
.Xr apropos 1 ,
.Xr catman 1 ,
@@ -147,12 +132,11 @@
.Xr manpath 1 ,
.Xr sort 1 ,
.Xr uniq 1 ,
-.Xr whatis 1 .
-
+.Xr whatis 1
.Sh HISTORY
This
.Nm
-command appeared in FreeBSD 2.1.
-
+command appeared in
+.Fx 2.1 .
.Sh AUTHOR
Wolfram Schneider, Berlin.
Index: usr.bin/man/makewhatis/makewhatis.local.8
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/gnu/usr.bin/man/makewhatis/makewhatis.local.8,v
retrieving revision 1.2
diff -u -r1.2 makewhatis.local.8
--- makewhatis.local.8 1996/08/27 20:04:06 1.2
+++ makewhatis.local.8 1996/12/02 14:02:41
@@ -23,15 +23,12 @@
.\" SUCH DAMAGE.
.\"
.\" $Id: makewhatis.local.8,v 1.2 1996/08/27 20:04:06 wosch Exp $
-
.Dd April, 26, 1996
.Dt MAKEWHATIS.LOCAL 8
.Os FreeBSD 2.2
-
.Sh NAME
.Nm makewhatis.local , catman.local
.Nd start makewhatis for local file systems
-
.Sh SYNOPSIS
.Nm /usr/libexec/makewhatis.local
.Op options
@@ -39,8 +36,6 @@
.Nm /usr/libexec/catman.local
.Op options
.Ar directories ...
-
-
.Sh DESCRIPTION
.Nm
start
@@ -56,7 +51,6 @@
So use this wrapper for
.Xr cron 8
instead calling makewhatis directly.
-
.Sh FILES
.Bl -tag -width /etc/weekly.XXX -compact
.It Pa /etc/weekly
@@ -64,14 +58,13 @@
.Nm
every week
.El
-
.Sh SEE ALSO
.Xr makewhatis 1 ,
.Xr catman 1 ,
.Xr find 1 ,
-.Xr cron 8 .
-
+.Xr cron 8
.Sh HISTORY
The
.Nm
-command appeared in FreeBSD 2.2.
+command appeared in
+.Fx 2.2 .
Index: usr.bin/man/man/man.man
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/gnu/usr.bin/man/man/man.man,v
retrieving revision 1.3
diff -u -r1.3 man.man
--- man.man 1996/01/22 09:25:45 1.3
+++ man.man 1996/12/02 14:37:48
@@ -12,16 +12,29 @@
.\" The University of Texas at Austin
.\" Austin, Texas 78712
.\"
-.TH man 1 "Jan 5, 1991"
-.LO 1
-.SH NAME
-man \- format and display the on-line manual pages
-.SH SYNOPSIS
-man [\-adfhktw] [\-m system] [\-p string] [\-M path] [\-P pager]
-[\-S list] [section] name ...
-.SH DESCRIPTION
-man formats and displays the on-line manual pages. This version knows
-about the MANPATH and PAGER environment variables, so you can have
+.Dd Jan 5, 1991
+.Dt MAN 1
+.Sh NAME
+.Nm man
+.Nd format and display the on-line manual pages
+.Sh SYNOPSIS
+.Nm man
+.Op Fl adfhktw
+.Op Fl m Ar system
+.Op Fl p Ar string
+.Op Fl M Ar path
+.Op Fl P Ar pager
+.Op Fl S Ar list
+.Op Ar section
+.Ar name ...
+.Sh DESCRIPTION
+.Nm Man
+formats and displays the on-line manual pages. This version knows
+about the
+.Va MANPATH
+and
+.Va PAGER
+environment variables, so you can have
your own set(s) of personal man pages and choose whatever program you
like to display the formatted pages. If section is specified, man
only looks in that section of the manual. You may also specify the
@@ -30,105 +43,97 @@
variables. If enabled by the system administrator, formatted man
pages will also be compressed with the `%compress%' command to save
space.
-.SH OPTIONS
-.TP
-.B \-\^M " path"
+.Pp
+The options are as follows:
+.Bl -tag -width Fl
+.It Fl M Ar path
Specify an alternate manpath. By default, man uses
-.B manpath
+.Nm manpath
to determine the path to search. This option overrides the
-.B MANPATH
+.Va MANPATH
environment variable.
-.TP
-.B \-\^P " pager"
+.It Fl P Ar pager
Specify which pager to use. By default, man uses
-.B %pager%,
+.Nm %pager% ,
This option overrides the
-.B PAGER
+.Va PAGER
environment variable.
-.TP
-.B \-\^S " list"
+.It Fl S Ar list
List is a colon separated list of manual sections to search.
This option overrides the
-.B MANSECT
+.Va MANSECT
environment variable.
-.TP
-.B \-\^a
+.It Fl a
By default, man will exit after displaying the first manual page it
finds. Using this option forces man to display all the manual pages
that match
-.B name,
-not just the first.
-.TP
-.B \-\^d
+.Ar name ,
+not just the first.
+.It Fl d
Don't actually display the man pages, but do print gobs of debugging
information.
-.TP
-.B \-\^f
+.It Fl f
Equivalent to
-.B whatis.
-.TP
-.B \-\^h
+.Nm whatis .
+.It Fl h
Print a one line help message and exit.
-.TP
-.B \-\^k
+.It Fl k
Equivalent to
-.B apropos.
-.TP
-.B \-\^m " system"
+.Nm apropos .
+.It Fl m Ar system
Specify an alternate set of man pages to search based on the system
name given.
-.TP
-.B \-\^p " string"
+.It Fl p Ar string
Specify the sequence of preprocessors to run before nroff or troff.
Not all installations will have a full set of preprocessors.
Some of the preprocessors and the letters used to designate them are:
eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r).
This option overrides the
-.B MANROFFSEQ
+.Va MANROFFSEQ
environment variable.
-.TP
-.B \-\^t
+.It Fl t
Use
-.B %troff%
-to format the manual page, passing the output to
-.B stdout.
+.Nm %troff%
+to format the manual page, passing the output to stdout.
The output from
-.B %troff%
+.Nm %troff%
may need to be passed through some filter or another before being
printed.
-.TP
-.B \-\^w
+.It Fl w
Don't actually display the man pages, but do print the location(s) of
the files that would be formatted or displayed.
-.SH ENVIRONMENT
-.TP \w'MANROFFSEQ\ \ 'u
-.B MANPATH
+.El
+.Sh ENVIRONMENT
+.Bl -tag -width MANROFFSEQ -compact
+.It Va MANPATH
If
-.B MANPATH
+.Va MANPATH
is set, its value is used as the path to search for manual pages.
-.TP
-.B MANROFFSEQ
+.It Va MANROFFSEQ
If
-.B MANROFFSEQ
+.Va MANROFFSEQ
is set, its value is used to determine the set of preprocessors run
before running nroff or troff. By default, pages are passed through
the table preprocessor before nroff.
-.TP
-.B MANSEC
+.It Va MANSEC
If
-.B MANSEC
+.Va MANSEC
is set, its value is used to determine which manual sections to search.
-.TP
-.B PAGER
+.It Va PAGER
If
-.B PAGER
+.Va PAGER
is set, its value is used as the name of the program to use to display
the man page. By default,
-.B %pager%
+.Nm %pager%
is used.
-.SH "SEE ALSO"
-apropos(1), whatis(1), manpath(1), more(1), groff(1).
-.SH BUGS
+.El
+.Sh SEE ALSO
+.Xr apropos 1 ,
+.Xr whatis 1 ,
+.Xr manpath 1 ,
+.Xr more 1 ,
+.Xr groff 1
+.Sh BUGS
The
-.B \-t
+.Fl t
option only works if a troff-like program is installed.
Index: usr.bin/man/manpath/manpath.man
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/gnu/usr.bin/man/manpath/manpath.man,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 manpath.man
--- manpath.man 1993/07/07 23:07:01 1.1.1.1
+++ manpath.man 1996/12/02 14:36:37
@@ -12,45 +12,57 @@
.\" The University of Texas at Austin
.\" Austin, Texas 78712
.\"
-.TH manpath 1 "Jan 5, 1991"
-.LO 1
-.SH NAME
-manpath \- determine user's search path for man pages
-.SH SYNOPSIS
-manpath [\-q]
-.SH DESCRIPTION
-manpath tries to determine the user's manpath from a set of system
+.Dd Jan 5, 1991
+.Dt MANPATH 1
+.Os
+.Sh NAME
+.Nm manpath
+.Nd determine user's search path for man pages
+.Sh SYNOPSIS
+.Nm
+.Op Fl q
+.Sh DESCRIPTION
+.Nm manpath
+tries to determine the user's manpath from a set of system
defaults and the user's
-.B PATH ,
+.Va PATH ,
echoing the result to the standard output. Warnings and errors are
written to the standard error.
If a directory in the user's path is not listed in the manpath.config
file, manpath looks for the subdirectories man or MAN. If they exist,
they are added to the search path.
-.PP
-manpath is used by
-.B man
+.Pp
+.Nm
+manpath
+is used by
+.Nm man
to determine the search path, so user's normally don't need to set the
-.B MANPATH
+.Va MANPATH
environment variable directly.
-.SH OPTIONS
-.TP
-.B \-\^q
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl q
Operate quietly. Only echo the final manpath.
-.SH ENVIRONMENT
-.TP \w'MANPATH\ \ 'u
-.B MANPATH
+.El
+.Sh ENVIRONMENT
+.Bl -tag -width MANPATH -compact
+.It Va MANPATH
If
-.B MANPATH
+.Va MANPATH
is set,
-.B manpath
+.Nm manpath
echoes its value on the standard output and issues a warning on the
standard error.
-.SH FILES
-.TP \w'%manpath_config_file%'u+2n
-.BI %manpath_config_file%
+.El
+.Sh FILES
+.Bl -tag -width %manpath_config_file% -compact
+.It Pa %manpath_config_file%
System configuration file.
-.SH "SEE ALSO"
-apropos(1), whatis(1), man(1).
-.SH BUGS
+.El
+.Sh SEE ALSO
+.Xr apropos 1 ,
+.Xr whatis 1 ,
+.Xr man 1
+.Sh BUGS
None known.
Index: usr.bin/w/w.1
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/usr.bin/w/w.1,v
retrieving revision 1.2
diff -u -r1.2 w.1
--- w.1 1994/08/05 09:13:34 1.2
+++ w.1 1996/11/28 13:30:31
@@ -91,7 +91,7 @@
.Xr who 1 ,
.Xr finger 1 ,
.Xr ps 1 ,
-.Xr uptime 1 ,
+.Xr uptime 1
.Sh BUGS
The notion of the
.Dq current process
Index: usr.sbin/ctm/ctm/ctm.1
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/usr.sbin/ctm/ctm/ctm.1,v
retrieving revision 1.9
diff -u -r1.9 ctm.1
--- ctm.1 1996/09/21 15:08:10 1.9
+++ ctm.1 1996/11/28 13:39:10
@@ -35,16 +35,14 @@
.Dq Cvs Through eMail ,
but now instead it seems more fitting to call it
.Dq Current Through eMail .
-
+.br
.Nm Ctm
is now meant to be the definitive way to make and apply a delta between
two versions of a directory tree.
-
+.br
There are two parts to this, making the delta and applying it. These are two
entirely different things.
-
.Ss Usage
-
To apply a CTM delta, you pass it to the
.Nm ctm
command. You can pass a CTM delta on stdin, or you can give the
@@ -53,12 +51,12 @@
since it will not have to make a temporary copy of your file. You can
specify multiple deltas at one time, they will be proccessed one at a
time. Deltas that are already applied will be ignored.
-
+.Pp
The
.Nm ctm
command runs in a number of passes. It will process the entire
input file in each pass, before commencing with the next pass.
-
+.Pp
Before working on a file
.Ar name
.Nm ctm
@@ -67,16 +65,16 @@
If this file exists,
.Nm ctm
works on it instead.
-
+.Pp
Pass 1 will verify that the input file is OK. The syntax, the data
and the global MD5 checksum will be checked. If any of these fail,
.Nm ctm
will simply reject the input file.
-
+.Pp
Pass 2 will validate that the directory tree is in the state expected by
the CTM delta. This is done by looking for files and directories which
should/should not exist and by checking the MD5 checksums of files.
-
+.Pp
If a
.Ar backup-file
had been specified using the
@@ -88,9 +86,9 @@
.Fl t
option. The default archiver command is
.Nm "tar -rf %s -T -" .
-
+.Pp
Pass 3 will actually apply the delta.
-
+.br
The list of files that would be modified by
.Nm ctm
is subject to filtering regular expressions specified
@@ -107,7 +105,7 @@
filter that matched a given file name determines whether the file would be
operated on or left alone by
.Nm ctm .
-
+.Pp
.Nm Ctm
will extract the file hierarchy below its working directory. Absolute
filenames or filenames containing references through
@@ -115,16 +113,12 @@
and
.Sq \&.\&.
are explicitly prohibited as a security measure.
-
.Ss Options
-
-.Bl -tag -width indent -compact
-
+.Bl -tag -width Ds
.It Fl b Ar basedir
Prepend the path
.Ar basedir
to every filename.
-
.It Fl B Ar backup-file
Backup all files that would be modified by this CTM run to
.Ar backup-file .
@@ -134,10 +128,8 @@
.Fl x
options, then the final set of files backed up are those that would be
modified by CTM after the filters are applied.
-
.It Fl c
Check it out, don't do anything.
-
.It Fl e Ar regular_expression
Match each name in the CTM file against
.Ar regular_expression ,
@@ -149,20 +141,16 @@
for example, will select the
.Nm usr.sbin/ctm
source directory and all pathnames under it.
-
Pathnames can be disabled from being considered by CTM using the
.Fl x
option.
-
.It Fl F
Force.
-
.It Fl k
Keep files and directories and don't remove them even if the CTM file
specifies they are to be removed. If the
.Fl B
option is specified, these files and directories will not be backed up.
-
.It Fl l
List files that would be modified by this invocation of CTM and the
actions that would be performed on them. Use of the
@@ -177,11 +165,8 @@
.Fl x
options to determine which files would be modified by the given set of
command line options.
-
-
.It Fl q
Tell us less.
-
.It Fl t Ar tar-command
Use
.Ar tar-command
@@ -191,24 +176,18 @@
.Fl B
option. A %s in the tar command will be replaced by the name of the backup
file.
-
-
.It Fl T Ar tmpdir
Put temporary files under
.Ar tmpdir .
-
.It Fl u
Set modification time of created and modified files to the CTM delta
creation time.
-
.It Fl v
Tell us more.
-
.It Fl V Ar level
Tell us more.
.Ar Level
is the level of verbosity.
-
.It Fl x Ar regular_expression
Match each name in the CTM file against
.Ar regular_expression
@@ -216,13 +195,10 @@
options. Use of this option disables the
.Pa .ctm_status
sequence number checks.
-
Pathnames can be selected for CTM's consideration using the
.Fl e
option.
-
.El
-
.Sh ENVIRONMENT
.Ev TMPDIR,
if set to a pathname, will cause ctm to use that pathname
@@ -233,14 +209,11 @@
The same effect may be achieved with the
.Fl T
flag.
-
.Sh FILES
-
.Pa .ctm_status
contains the sequence number of the last CTM delta applied. Changing
or removing this file will greatly confuse
.Nm ctm .
-
Using the
.Fl e
and
@@ -248,23 +221,18 @@
options can update a partial subset of the source tree and causes sources
to be in an inconsistent state. It is assumed that you know what you are
doing when you use these options.
-
.Sh EXAMPLES
-
.Bd -literal
-
cd ~cvs
/usr/sbin/ctm ~ctm/cvs-*
-
.Ed
-
+.Pp
To extract and patch all sources under `lib'
.Bd -literal
cd ~/lib-srcs
/usr/sbin/ctm -e '^lib' ~ctm/src-cur*
.Ed
.Sh DIAGNOSTICS
-
Numerous messages, hopefully self-explanatory. The
.Dq noise level
can be adjusted with the
@@ -273,25 +241,21 @@
and
.Fl V
options.
-
.Sh SEE ALSO
.Xr ctm 5 ,
.Xr ctm_rmail 1
-
.Sh HISTORY
-
Initial trials were run during the work on FreeBSD 1.1.5, and many bugs and
methods were hashed out.
-
+.br
The
.Nm ctm
command appeared in FreeBSD 2.1.
-
.Sh AUTHORS
-
The CTM system has been designed and implemented by
Poul-Henning Kamp
.Aq phk@FreeBSD.org .
-
-Joerg Wunsch wrote this man-page.
-.Aq joerg@FreeBSD.org .
+.br
+Joerg Wunsch
+.Aq joerg@FreeBSD.org
+wrote this man-page.
Index: usr.sbin/ctm/ctm/ctm.5
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/usr.sbin/ctm/ctm/ctm.5,v
retrieving revision 1.3
diff -u -r1.3 ctm.5
--- ctm.5 1996/05/27 22:46:22 1.3
+++ ctm.5 1996/11/28 13:40:50
@@ -18,29 +18,26 @@
.Sh NAME
.Nm ctm
.Nd source code mirror system
-
.Sh DESCRIPTION
The
.Nm ctm
transfers data in a specific file format, called a CTM delta.
-
+.Pp
CTM deltas consist of control lines and data chunks. Each control
line starts with the letters
.Dq CTM ,
followed by a CTM statement and control data, and ends with a '\en'
character.
-
+.Pp
Data chunks always belong to the preceeding control line, and the
last field on that control line is the number of bytes in the data
chunk.
A trailing newline '\en' character follows each data chunk, this
newline is not part of the chunk and isn't included in the count.
-
+.Pp
The CTM statements are as follows.
.Bl -tag -width indent
-
.It _BEGIN Ar version name number timestamp prefix
-
This is the overall begin of a CTM delta file. The
.Ar version
field must match the program version
@@ -62,16 +59,12 @@
The
.Ar prefix
This field is currently not implemented.
-
.It _END Ar md5
-
This statement ends the CTM delta, the global
.Ar md5
checksum is matched against the MD5 checksum of the entire delta, up to
and including the space (0x20) character following ``_END''.
-
.It \&FM Ar name uid gid mode md5 count
-
Make the file
.Ar name ,
the original file had the uid
@@ -85,13 +78,10 @@
.Pq numerical, octal ,
and the MD5 checksum
.Ar md5 .
-
The following
.Ar count
bytes data are the contents of the new file.
-
.It \&FS Ar name uid gid mode md5before md5after count
-
Substitute the contents of file
.Ar name ,
the original file had the new uid
@@ -107,31 +97,23 @@
.Ar md5before ,
and the new MD5 checksum
.Ar md5after .
-
The following
.Ar count
bytes data are the contents of the new file.
-
File substitution is used if the commands to edit a file would exceed
the total file length, so substituting it is more efficient.
-
.It \&FN Ar name uid gid mode md5before md5after count
-
Edit the file
.Ar name .
The arguments are as above, but the data sections contains an
.Xr diff 1
-n script which should be applied to the file in question.
-
.It \&FR Ar name md5
-
Remove the file
.Ar name ,
which must match the MD5 checksum
.Ar md5 .
-
.It \&AS Ar name uid gid mode
-
The original file
.Ar name
changed its owner to
@@ -140,9 +122,7 @@
.Ar gid ,
and/or its mode to
.Ar mode .
-
.It \&DM Ar name uid gid mode
-
The directory
.Ar name
is to be created, it had originally the owner
@@ -151,23 +131,16 @@
.Ar gid ,
and mode
.Ar mode .
-
.It \&DR name
-
The directory
.Ar name
is to be removed.
-
.El
-
.Sh EXAMPLES
-
In the following example, long lines have been folded to make them
printable
.Pq marked by backslashes .
-
.Bd -literal
-
CTM_BEGIN 2.0 cvs-cur 485 19950324214652Z .
CTMFR src/sys/gnu/i386/isa/scd.c,v 5225f13aa3c7e458f9dd0d4bb637b18d
CTMFR src/sys/gnu/i386/isa/scdreg.h,v e5af42b8a06f2c8030b93a7d71afb223
@@ -185,26 +158,21 @@
Log:
[...]
CTM_END 74ddd298d76215ae45a077a4b6a74e9c
-
.Ed
-
.Sh SEE ALSO
-
.Xr ctm 1 ,
.Xr ctm_rmail 1 ,
-.Xr ed 1 .
-
+.Xr ed 1
.Sh HISTORY
-
Initial trials ran during the FreeBSD 1.1.5, and many bugs and
methods were hashed out.
+.br
The CTM system has been made publically available in FreeBSD 2.1.
-
.Sh AUTHORS
-
The CTM system has been designed and implemented by
Poul-Henning Kamp
.Aq phk@FreeBSD.org .
-
-Joerg Wunsch wrote this man-page.
-.Aq joerg@FreeBSD.org .
+.br
+Joerg Wunsch
+.Aq joerg@FreeBSD.org
+wrote this man-page.
Index: usr.sbin/fdcontrol/fdcontrol.8
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/usr.sbin/fdcontrol/fdcontrol.8,v
retrieving revision 1.2
diff -u -r1.2 fdcontrol.8
--- fdcontrol.8 1996/01/30 13:48:45 1.2
+++ fdcontrol.8 1996/11/30 17:58:09
@@ -44,7 +44,7 @@
.Ar device .
.Ar Device
should be a character device.
-
+.Pp
.Nm Fdcontrol
currently supports the specification of device parameters for the
floppy disk drive
@@ -57,39 +57,36 @@
.Em DEBUG
option set
.Pq Fl d .
-
+.Pp
Since the implications of such actions are considered harmful, the
underlying
.Xr ioctl 2
command is restricted to the super-user.
-
+.Pp
When requesting a new parameter specification, the command asks the
user for each individual tunable parameter, defaulting to the
currently used value.
-
.Sh DIAGNOSTICS
Error codes for the underlying
.Xr ioctl 2
commands are printed by the
.Xr perror 3
facility.
-
.Sh BUGS
The
.Nm
command is currently under development. It's user interface is rather
silly and likely to change in future, options should be provided to
allow anything being modified from the command line.
-
+.Pp
The driver does actually support only two debug levels
.Pq 0 and 1 ,
where debug level 1 will generate huge amounts of output. It is likely
to overflow the syslog if not used with extreme care.
-
.Sh SEE ALSO
.Xr fdc 4 ,
.Xr ioctl 2 ,
-.Xr perror 3 .
+.Xr perror 3
.Sh HISTORY
.Nm Fdcontrol
is currently under development. It's user interface and overall
Index: usr.sbin/quot/quot.8
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/usr.sbin/quot/quot.8,v
retrieving revision 1.3
diff -u -r1.3 quot.8
--- quot.8 1996/01/30 13:50:19 1.3
+++ quot.8 1996/11/28 13:50:29
@@ -94,7 +94,7 @@
.Xr quota 1 ,
.Xr getmntinfo 3 ,
.Xr fstab 5 ,
-.Xr mount 8 ,
+.Xr mount 8
.Sh HISTORY
This implementation of
.Nm quot
Index: usr.sbin/vidcontrol/vidcontrol.1
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/usr.sbin/vidcontrol/vidcontrol.1,v
retrieving revision 1.8
diff -u -r1.8 vidcontrol.1
--- vidcontrol.1 1996/06/21 07:20:12 1.8
+++ vidcontrol.1 1996/12/02 14:57:53
@@ -12,103 +12,97 @@
.\"
.\" @(#)vidcontrol.1
.\"
-.TH vidcontrol 1 "May 22, 1994" "" "FreeBSD"
-
-.SH NAME
-vidcontrol - a utility for manipulating the syscons video driver.
-.SH SYNOPSIS
-.na
-.B vidcontrol
-.RB [options]
-.SH DESCRIPTION
+.Dd May 22, 1994
+.Dt VIDCONTROL 1
+.Os
+.Sh NAME
+.Nm vidcontrol
+.Nd a utility for manipulating the syscons video driver.
+.Sh SYNOPSIS
+.Nm
+.Ar options ...
+.Sh DESCRIPTION
The
-.B vidcontrol
+.Nm vidcontrol
command is used to set various options for the syscons video driver,
such as video mode, colors, cursors, scrnmaps, font and screensaver timeout.
-
+.Pp
A new video mode is selected by specifying its name as an argument to
-.B vidcontrol
-eg. "
-.B vidcontrol VGA_80x25
-".
-
-The modes currently supported: VGA_40x25, VGA_80x25, VGA_80x50, EGA_80x25, EGA_80x43.
-On some laptops the modes VGA_80x30 and VGA_80x60 can be used.
-The graphic mode VGA_320x200 can also be chosen.
-
+.Nm vidcontrol
+e.g.:
+.Bd -literal
+vidcontrol VGA_80x25
+.Ed
+.Pp
+The modes currently supported:
+.Ar VGA_40x25 ,
+.Ar VGA_80x25 ,
+.Ar VGA_80x50 ,
+.Ar EGA_80x25 ,
+.Ar EGA_80x43 .
+On some laptops the modes
+.Ar VGA_80x30
+and
+.Ar VGA_80x60
+can be used.
+The graphic mode
+.Ar VGA_320x200
+can also be chosen.
+.Pp
The colors used when displaying text can be changed by specifying the
-foreground color (eg. "
-.B vidcontrol white
-"), or both a foreground & background
-color (eg. "
-.B vidcontrol yellow blue
-").
-
-To see the supported colors on a given platform use "
-.B vidcontrol show
-".
-
-.SH OPTIONS
-.TP
-The following command line options are supported.
-.TP
-.BI "\-r\ " foreground\ background
+foreground color (e.g. "vidcontrol white"), or both a foreground & background
+color (e.g. "vidcontrol yellow blue").
+.Pp
+To see the supported colors on a given platform use "vidcontrol show".
+.Pp
+The following command line options are supported:
+.Bl -tag -width Fl
+.It Fl r Ar foreground Ar background
Change reverse mode colors to
-.B foreground
+.Ar foreground
and
-.B background
-.
-.TP
-.BI "\-b\ " color
+.Ar background
+.It Fl b Ar color
Set border color to
-.B color
-(only supported on VGA hardware):
-.TP
-.BI "\-c\ " normal | blink | destructive
+.Ar color
+(only supported on VGA hardware).
+.It Fl c Ar normal|blink|destructive
Change the cursor appearance. The cursor is either an inverting block
(normal) that eventually can "blink". Or it can be like the old hardware cursor
(destructive). The latter is actually a simulation.
-.TP
-.BI "\-d\ "
+.It Fl d
Print out current screen output map.
-.TP
-.BI "\-l\ " scrmap
+.It Fl l Ar scrmap
Install screen output map file from
-.I scrmap
-.TP
-.BI "\-L\ "
+.Ar scrmap
+.It Fl L
Install default screen output map.
-.TP
-.BI "\-m\ " on|off
+.It Fl m Ar on|off
Switches the mousepointer on or off. Used together with the moused
daemon for textmode cut & paste functionality.
-.TP
-.BI "\-f\ " size\ file
+.It Fl f Ar size Ar file
Load font
-.I file
+.Ar file
for
-.I size
+.Ar size
(currently, only 8x8, 8x14 or 8x16).
The fontfile can be either uuencoded or in raw binary format.
-.TP
-.BI "\-t\ " N|off
+.It Fl t Ar N|off
Sets the screensaver timeout to
-.I N
+.Ar N
seconds, or turns it
-.I off
-.TP
-.BI "\-x\ "
+.Ar off .
+.It Fl x
Use hexadecimal digits for output.
-.PP
-.SH FILES
-/usr/share/syscons/fonts
-/usr/share/syscons/scrnmaps
-.SH BUGS
-Report when found.
-.SH "SEE ALSO"
-.BR kbdcontrol(1) ,
-.BR keyboard (4) ,
-.BR screen (4) ,
-.SH AUTHORS
+.El
+.Sh FILES
+.Bl -tag -width /usr/share/syscons/scrnmaps -compact
+.It Pa /usr/share/syscons/fonts
+.It Pa /usr/share/syscons/scrnmaps
+.El
+.Sh SEE ALSO
+.Xr kbdcontrol 1 ,
+.Xr keyboard 4 ,
+.Xr screen 4
+.Sh AUTHORS
Søren Schmidt (sos@FreeBSD.org)
-
Index: usr.sbin/ypbind/ypbind.8
===================================================================
RCS file: /usr/local/FreeBSD-CVS/src/usr.sbin/ypbind/ypbind.8,v
retrieving revision 1.5
diff -u -r1.5 ypbind.8
--- ypbind.8 1996/10/05 22:27:30 1.5
+++ ypbind.8 1996/11/28 13:32:39
@@ -155,7 +155,7 @@
.Sh SEE ALSO
.Xr domainname 1 ,
.Xr syslog 3 ,
-.Xr yp 4
+.Xr yp 4 ,
.Xr ypserv 8 ,
.Xr ypset 8
.Sh AUTHOR
>Audit-Trail:
>Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?199612021508.QAA04996>