back to world-writable dirs and cat? files. Hwoever, if a dirs

[unix-history] / usr / src / old / catman / catman.8

diff --git a/usr/src/old/catman/catman.8 b/usr/src/old/catman/catman.8
index 68a431d..d50ea6f 100644 (file)
--- a/usr/src/old/catman/catman.8
+++ b/usr/src/old/catman/catman.8
@@ -2,9 +2,9 @@
 .\" All rights reserved.  The Berkeley software License Agreement
 .\" specifies the terms and conditions for redistribution.
 .\"
 .\" All rights reserved.  The Berkeley software License Agreement
 .\" specifies the terms and conditions for redistribution.
 .\"

-.\"    @(#)catman.8    4.1 (Berkeley) %G%
+.\"    @(#)catman.8    6.4 (Berkeley) %G%

 .\"
 .\"

-.TH CATMAN 8 "4/3/81"
+.TH CATMAN 8 ""

 .UC 4
 .SH NAME
 catman \- create the cat files for the manual
 .UC 4
 .SH NAME
 catman \- create the cat files for the manual


@@ -16,6 +16,9 @@ catman \- create the cat files for the manual
 .B \-n
 ] [
 .B \-w
 .B \-n
 ] [
 .B \-w

+] [
+.B \-M
+.I path

 ]
 [ sections ]
 .SH DESCRIPTION
 ]
 [ sections ]
 .SH DESCRIPTION


@@ -27,11 +30,11 @@ missing or out of date are recreated.
 If any changes are made,
 .I catman
 will recreate the
 If any changes are made,
 .I catman
 will recreate the

-.B /usr/lib/whatis
+.B whatis

 database.
 .PP
 If there is one parameter not starting with a `\-',
 database.
 .PP
 If there is one parameter not starting with a `\-',

-it is take to be a list of manual sections to look in.
+it is taken to be a list of manual sections to look in.

 For example
 .IP
 .B catman 123
 For example
 .IP
 .B catman 123


@@ -42,26 +45,71 @@ will cause the updating to only happen to manual sections
 Options:
 .TP
 .B \-n
 Options:
 .TP
 .B \-n

-prevents creations of
-.BR /usr/lib/whatis .
+prevents creations of the
+.B whatis
+database.

 .TP
 .B \-p
 prints what would be done instead of doing it.
 .TP
 .B \-w
 causes only the 
 .TP
 .B \-p
 prints what would be done instead of doing it.
 .TP
 .B \-w
 causes only the 

-.B /usr/lib/whatis
+.B whatis

 database to be created.
 No manual reformatting is done.
 database to be created.
 No manual reformatting is done.

+.TP
+.B \-M
+updates manual pages located in the set of directories specified by
+.I path
+(/usr/man by default).
+.I Path
+has the form of a colon (`:') separated list of directory names,
+for example `/usr/local/man:/usr/man'.
+If the environment variable `MANPATH' is set,
+its value is used for the default path.
+.PP
+If the nroff source file contains only a line of the form `.so manx/yyy.x',
+a link is made in the catx directory to the appropriate preformatted manual
+page.
+This feature allows easy distribution of the preformatted manual pages
+among a group of associated machines with
+.I rdist(1).
+The nroff sources need not be distributed to all machines,
+thus saving the associated disk space.
+As an example, consider a local network with 5 machines,
+called mach1 through mach5.
+Suppose mach3 has the manual page nroff sources.
+Every night, mach3 runs
+.I catman
+via
+.I cron(8)
+and later runs
+.I rdist
+with a distfile that looks like:
+.IP
+.nf
+.ta \w'${MANUAL'u
+
+MANSLAVES = ( mach1 mach2 mach4 mach5 )
+
+MANUALS = (/usr/man/cat[1-8no] /usr/man/whatis)
+
+${MANUALS} -> ${MANSLAVES}
+       install -R;
+       notify root;
+
+.fi

 .SH FILES
 .SH FILES

-.ta 2i
+.nf
+.ta \w'/usr/lib/makewhatis   'u
+/usr/man       default manual directory location

 /usr/man/man?/*.*      raw (nroff input) manual sections
 /usr/man/man?/*.*      raw (nroff input) manual sections

-.br

 /usr/man/cat?/*.*      preformatted manual pages
 /usr/man/cat?/*.*      preformatted manual pages

-.br
-/usr/lib/makewhatis    commands to make whatis database
+/usr/man/whatis        whatis database
+/usr/lib/makewhatis    command script to make whatis database
+.fi

 .DT
 .SH "SEE ALSO"
 .DT
 .SH "SEE ALSO"

-man(1)
+man(1), cron(8), rdist(1)

 .SH BUGS
 Acts oddly on nights with full moons.
 .SH BUGS
 Acts oddly on nights with full moons.