Minor formatting fixes.

Submitted by:	Sandro Sigala <sandro@cat.local.net> as part of PR # 2134.
This commit is contained in:
Mike Pritchard 1996-12-09 07:26:04 +00:00
parent 9e9e968a54
commit 5a2964f7c9
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=20241
4 changed files with 19 additions and 69 deletions

View File

@ -24,15 +24,13 @@
.\" .\"
.\" /usr/bin/catman - preformat man pages .\" /usr/bin/catman - preformat man pages
.\" .\"
.\" $Id: catman.1,v 1.7 1996/01/23 21:27:39 joerg Exp $ .\" $Id: catman.1,v 1.8 1996/08/27 20:03:59 wosch Exp $
.Dd Mar 12, 1995 .Dd Mar 12, 1995
.Dt CATMAN 1 .Dt CATMAN 1
.Os .Os
.Sh NAME .Sh NAME
.Nm catman .Nm catman
.Nd preformat man pages .Nd preformat man pages
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm catman .Nm catman
.Op Fl f | Fl force .Op Fl f | Fl force
@ -41,7 +39,6 @@
.Op Fl r | Fl remove .Op Fl r | Fl remove
.Op Fl v | Fl verbose .Op Fl v | Fl verbose
.Op Ar directories... .Op Ar directories...
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm Catman .Nm Catman
format man pages to ASCII. It's like typing format man pages to ASCII. It's like typing
@ -56,29 +53,21 @@ Use
if no if no
.Ar directories .Ar directories
defined. defined.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width Ds .Bl -tag -width Ds
.It Fl f , Fl force .It Fl f , Fl force
Force overwriting old cat pages. Normally only those pages will be formatted 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. which are not up to date. This option is a waste of time, CPU and RAM.
.It Fl h , Fl help .It Fl h , Fl help
Print options and exit. Print options and exit.
.It Fl p , Fl print .It Fl p , Fl print
Don't actually format man pages. Show what would be done. Don't actually format man pages. Show what would be done.
.It Fl r , Fl remove .It Fl r , Fl remove
Remove garbage, e.\& g. catpage without manpage, uncompressed catpage but Remove garbage, e.\& g. catpage without manpage, uncompressed catpage but
a compressed catpage exist, filenames with non-alphanumeric a compressed catpage exist, filenames with non-alphanumeric
characters, uncompressed manpage but a compressed manpage exist. characters, uncompressed manpage but a compressed manpage exist.
.It Fl v , Fl verbose .It Fl v , Fl verbose
More warnings. More warnings.
.Sh EXAMPLES .Sh EXAMPLES
.Pp .Pp
.Dl $ catman .Dl $ catman
@ -86,12 +75,10 @@ More warnings.
Format man pages in Format man pages in
.Ar /usr/share/man .Ar /usr/share/man
if neccessary. if neccessary.
.Pp .Pp
.Dl $ catman $MANPATH .Dl $ catman $MANPATH
.Pp .Pp
Format all your man pages if neccessary. Format all your man pages if neccessary.
.Pp .Pp
.Dl $ catman -f /usr/local/man/man1 /usr/local/man/manl .Dl $ catman -f /usr/local/man/man1 /usr/local/man/manl
.Pp .Pp
@ -99,25 +86,21 @@ Force reformatting of all man pages in
.Pa /usr/local/man/man1 .Pa /usr/local/man/man1
and and
.Pa /usr/local/man/manl . .Pa /usr/local/man/manl .
.Pp .Pp
.Dl $ catman -p /usr/X11/man .Dl $ catman -p /usr/X11/man
.Pp .Pp
Show only. Show only.
.Sh FILES .Sh FILES
.Bl -tag -width /etc/master.passwdxx -compact .Bl -tag -width /etc/weeklyxxx -compact
.Pa /etc/weekly : .Pa /etc/weekly
start this program Starts this program
.Po .Po
or or
.Pa /etc/daily .Pa /etc/daily
.Pc .Pc
.El .El
.Sh FEATURES .Sh FEATURES
Very fast if all man pages already formatted. Very fast if all man pages already formatted.
Does not support the Does not support the
.Fl w .Fl w
option as some other systems do. Use option as some other systems do. Use
@ -130,23 +113,20 @@ database.
is a setuid program. Be careful that user is a setuid program. Be careful that user
.Sq man .Sq man
has write permissions to the catman directories. has write permissions to the catman directories.
.Nm Catman .Nm Catman
does not check for any does not check for any
.Sq .so .Sq .so
in man page sources. Use hard or symlinks in man page sources. Use hard or symlinks
to avoid redundant formatted man pages. to avoid redundant formatted man pages.
.Sh SEE ALSO .Sh SEE ALSO
.Xr man 1 , .Xr man 1 ,
.Xr manpath 1 , .Xr manpath 1 ,
.Xr makewhatis 1 . .Xr makewhatis 1 .
.Sh HISTORY .Sh HISTORY
This version of This version of
.Nm catman .Nm catman
command appeared in FreeBSD 2.1 command appeared in
.Fx 2.1 .
.Sh AUTHOR .Sh AUTHOR
Wolfram Schneider Wolfram Schneider
.Aq wosch@FreeBSD.org , .Aq wosch@FreeBSD.org ,

View File

@ -22,16 +22,13 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.\" $Id: makewhatis.1,v 1.5 1996/07/08 20:18:28 wosch Exp $ .\" $Id: makewhatis.1,v 1.6 1996/08/27 20:04:05 wosch Exp $
.Dd Jan, 12, 1995 .Dd Jan, 12, 1995
.Dt MAKEWHATIS 1 .Dt MAKEWHATIS 1
.Os FreeBSD 2.1 .Os FreeBSD 2.1
.Sh NAME .Sh NAME
.Nm makewhatis .Nm makewhatis
.Nd create whatis database .Nd create whatis database
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Op Fl a | Fl append .Op Fl a | Fl append
@ -41,7 +38,6 @@
.Op Fl o | Fl outfile Ar file .Op Fl o | Fl outfile Ar file
.Op Fl v | Fl verbose .Op Fl v | Fl verbose
.Op Ar directories ... .Op Ar directories ...
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
extracts the name and a short description from unformatted manpages extracts the name and a short description from unformatted manpages
@ -50,7 +46,6 @@ and creates the
database. database.
.Nm .Nm
can read gzip'ed manpages. can read gzip'ed manpages.
.Ar Directory .Ar Directory
names a directory containing manpage subdirectories names a directory containing manpage subdirectories
.Pq named Pa man.+ . .Pq named Pa man.+ .
@ -59,7 +54,6 @@ Colons are treated as spaces, hence
or or
.Ic makewhatis `manpath` .Ic makewhatis `manpath`
are allowed. are allowed.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width Ds .Bl -tag -width Ds
.It Fl a , Fl append .It Fl a , Fl append
@ -67,26 +61,21 @@ Append mode. Don't delete old entries in whatis database. Note:
the new database will be sorted without repeated lines and the new database will be sorted without repeated lines and
.Nm .Nm
does not check if old entries are valid. does not check if old entries are valid.
.It Fl h , Fl help .It Fl h , Fl help
Print options and exit. Print options and exit.
.It Fl i , Fl indent Ar column .It Fl i , Fl indent Ar column
Justify description strings to Justify description strings to
.Ar column Pq default 24 . .Ar column Pq default 24 .
.It Fl n , Fl name Ar name .It Fl n , Fl name Ar name
Use Use
.Ar name .Ar name
instead of instead of
.Pa whatis Ns . .Pa whatis Ns .
.It Fl o , Fl outfile Ar file .It Fl o , Fl outfile Ar file
Write all output to Write all output to
.Ar file .Ar file
instead of instead of
.Pa dirname/whatis Ns . .Pa dirname/whatis Ns .
.It Fl v, Fl verbose .It Fl v, Fl verbose
Issue more warnings Issue more warnings
.Pq to stderr . .Pq to stderr .
@ -98,8 +87,6 @@ for a compressed page, and
.Ql + .Ql +
for a link. for a link.
.El .El
.Sh EXAMPLES .Sh EXAMPLES
.Pp .Pp
.Ic makewhatis $MANPATH .Ic makewhatis $MANPATH
@ -127,7 +114,6 @@ Create whatis database
instead of instead of
.Pa whatis Ns . .Pa whatis Ns .
May be useful for Solaris. May be useful for Solaris.
.Sh FILES .Sh FILES
.Bl -tag -width /etc/master.passwdxx -compact .Bl -tag -width /etc/master.passwdxx -compact
.It Pa */man/whatis .It Pa */man/whatis
@ -137,7 +123,6 @@ run
.Nm makewhatis.local .Nm makewhatis.local
every week every week
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr apropos 1 , .Xr apropos 1 ,
.Xr catman 1 , .Xr catman 1 ,
@ -148,11 +133,10 @@ every week
.Xr sort 1 , .Xr sort 1 ,
.Xr uniq 1 , .Xr uniq 1 ,
.Xr whatis 1 . .Xr whatis 1 .
.Sh HISTORY .Sh HISTORY
This This
.Nm .Nm
command appeared in FreeBSD 2.1. command appeared in
.Fx 2.1 .
.Sh AUTHOR .Sh AUTHOR
Wolfram Schneider, Berlin. Wolfram Schneider, Berlin.

View File

@ -22,16 +22,13 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.\" $Id: makewhatis.local.8,v 1.1 1996/05/22 00:57:40 wosch Exp $ .\" $Id: makewhatis.local.8,v 1.2 1996/08/27 20:04:06 wosch Exp $
.Dd April, 26, 1996 .Dd April, 26, 1996
.Dt MAKEWHATIS.LOCAL 8 .Dt MAKEWHATIS.LOCAL 8
.Os FreeBSD 2.2 .Os FreeBSD 2.2
.Sh NAME .Sh NAME
.Nm makewhatis.local , catman.local .Nm makewhatis.local , catman.local
.Nd start makewhatis for local file systems .Nd start makewhatis for local file systems
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm /usr/libexec/makewhatis.local .Nm /usr/libexec/makewhatis.local
.Op options .Op options
@ -39,8 +36,6 @@
.Nm /usr/libexec/catman.local .Nm /usr/libexec/catman.local
.Op options .Op options
.Ar directories ... .Ar directories ...
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
start start
@ -55,8 +50,7 @@ for rw nfs-mounted /usr may kill
your NFS server -- all NFS clients start makewhatis at the same time! your NFS server -- all NFS clients start makewhatis at the same time!
So use this wrapper for So use this wrapper for
.Xr cron 8 .Xr cron 8
instead calling makewhatis directly. instead of calling makewhatis directly.
.Sh FILES .Sh FILES
.Bl -tag -width /etc/weekly.XXX -compact .Bl -tag -width /etc/weekly.XXX -compact
.It Pa /etc/weekly .It Pa /etc/weekly
@ -64,14 +58,13 @@ run
.Nm .Nm
every week every week
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr makewhatis 1 ,
.Xr catman 1 , .Xr catman 1 ,
.Xr find 1 , .Xr find 1 ,
.Xr makewhatis 1 ,
.Xr cron 8 . .Xr cron 8 .
.Sh HISTORY .Sh HISTORY
The The
.Nm .Nm
command appeared in FreeBSD 2.2. command appeared in
.Fx 2.2 .

View File

@ -22,16 +22,13 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.\" $Id: makewhatis.local.8,v 1.1 1996/05/22 00:57:40 wosch Exp $ .\" $Id: makewhatis.local.8,v 1.2 1996/08/27 20:04:06 wosch Exp $
.Dd April, 26, 1996 .Dd April, 26, 1996
.Dt MAKEWHATIS.LOCAL 8 .Dt MAKEWHATIS.LOCAL 8
.Os FreeBSD 2.2 .Os FreeBSD 2.2
.Sh NAME .Sh NAME
.Nm makewhatis.local , catman.local .Nm makewhatis.local , catman.local
.Nd start makewhatis for local file systems .Nd start makewhatis for local file systems
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm /usr/libexec/makewhatis.local .Nm /usr/libexec/makewhatis.local
.Op options .Op options
@ -39,8 +36,6 @@
.Nm /usr/libexec/catman.local .Nm /usr/libexec/catman.local
.Op options .Op options
.Ar directories ... .Ar directories ...
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
start start
@ -55,8 +50,7 @@ for rw nfs-mounted /usr may kill
your NFS server -- all NFS clients start makewhatis at the same time! your NFS server -- all NFS clients start makewhatis at the same time!
So use this wrapper for So use this wrapper for
.Xr cron 8 .Xr cron 8
instead calling makewhatis directly. instead of calling makewhatis directly.
.Sh FILES .Sh FILES
.Bl -tag -width /etc/weekly.XXX -compact .Bl -tag -width /etc/weekly.XXX -compact
.It Pa /etc/weekly .It Pa /etc/weekly
@ -64,14 +58,13 @@ run
.Nm .Nm
every week every week
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr makewhatis 1 ,
.Xr catman 1 , .Xr catman 1 ,
.Xr find 1 , .Xr find 1 ,
.Xr makewhatis 1 ,
.Xr cron 8 . .Xr cron 8 .
.Sh HISTORY .Sh HISTORY
The The
.Nm .Nm
command appeared in FreeBSD 2.2. command appeared in
.Fx 2.2 .