Return to catman.8 CVS log

Up to [CSRG BSD Unix] / 43BSDReno / old / catman

Annotation of 43BSDReno/old/catman/catman.8, revision 1.1

1.1     ! root        1: .\" Copyright (c) 1980 Regents of the University of California.
        !             2: .\" All rights reserved.  The Berkeley software License Agreement
        !             3: .\" specifies the terms and conditions for redistribution.
        !             4: .\"
        !             5: .\"    @(#)catman.8    6.5 (Berkeley) 5/28/86
        !             6: .\"
        !             7: .TH CATMAN 8 "May 28, 1986"
        !             8: .UC 4
        !             9: .SH NAME
        !            10: catman \- create the cat files for the manual
        !            11: .SH SYNOPSIS
        !            12: .B /etc/catman
        !            13: [
        !            14: .B \-p
        !            15: ] [
        !            16: .B \-n
        !            17: ] [
        !            18: .B \-w
        !            19: ] [
        !            20: .B \-M
        !            21: .I path
        !            22: ]
        !            23: [ sections ]
        !            24: .SH DESCRIPTION
        !            25: .I Catman
        !            26: creates the preformatted versions of the on-line manual from the nroff
        !            27: input files.
        !            28: Each manual page is examined and those whose preformatted versions are
        !            29: missing or out of date are recreated.
        !            30: If any changes are made,
        !            31: .I catman
        !            32: will recreate the
        !            33: .B whatis
        !            34: database.
        !            35: .PP
        !            36: If there is one parameter not starting with a `\-',
        !            37: it is taken to be a list of manual sections to look in.
        !            38: For example
        !            39: .IP
        !            40: .B catman 123
        !            41: .LP
        !            42: will cause the updating to only happen to manual sections
        !            43: 1, 2, and 3.
        !            44: .PP
        !            45: Options:
        !            46: .TP
        !            47: .B \-n
        !            48: prevents creations of the
        !            49: .B whatis
        !            50: database.
        !            51: .TP
        !            52: .B \-p
        !            53: prints what would be done instead of doing it.
        !            54: .TP
        !            55: .B \-w
        !            56: causes only the 
        !            57: .B whatis
        !            58: database to be created.
        !            59: No manual reformatting is done.
        !            60: .TP
        !            61: .B \-M
        !            62: updates manual pages located in the set of directories specified by
        !            63: .I path
        !            64: (/usr/man by default).
        !            65: .I Path
        !            66: has the form of a colon (`:') separated list of directory names,
        !            67: for example `/usr/local/man:/usr/man'.
        !            68: If the environment variable `MANPATH' is set,
        !            69: its value is used for the default path.
        !            70: .PP
        !            71: If the nroff source file contains only a line of the form `.so manx/yyy.x',
        !            72: a symbolic link is made in the catx directory to the appropriate
        !            73: preformatted manual page.
        !            74: This feature allows easy distribution of the preformatted manual pages
        !            75: among a group of associated machines with
        !            76: .I rdist(1).
        !            77: The nroff sources need not be distributed to all machines,
        !            78: thus saving the associated disk space.
        !            79: As an example, consider a local network with 5 machines,
        !            80: called mach1 through mach5.
        !            81: Suppose mach3 has the manual page nroff sources.
        !            82: Every night, mach3 runs
        !            83: .I catman
        !            84: via
        !            85: .I cron(8)
        !            86: and later runs
        !            87: .I rdist
        !            88: with a distfile that looks like:
        !            89: .IP
        !            90: .nf
        !            91: .ta \w'${MANUAL'u
        !            92: 
        !            93: MANSLAVES = ( mach1 mach2 mach4 mach5 )
        !            94: 
        !            95: MANUALS = (/usr/man/cat[1-8no] /usr/man/whatis)
        !            96: 
        !            97: ${MANUALS} -> ${MANSLAVES}
        !            98:        install -R;
        !            99:        notify root;
        !           100: 
        !           101: .fi
        !           102: .SH FILES
        !           103: .nf
        !           104: .ta \w'/usr/lib/makewhatis   'u
        !           105: /usr/man       default manual directory location
        !           106: /usr/man/man?/*.*      raw (nroff input) manual sections
        !           107: /usr/man/cat?/*.*      preformatted manual pages
        !           108: /usr/man/whatis        whatis database
        !           109: /usr/lib/makewhatis    command script to make whatis database
        !           110: .fi
        !           111: .DT
        !           112: .SH "SEE ALSO"
        !           113: man(1), cron(8), rdist(1)
        !           114: .SH BUGS
        !           115: Acts oddly on nights with full moons.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.