Return to Toolkit CVS log

Up to [Research Unix] / researchv10dc / man / adm

Annotation of researchv10dc/man/adm/Toolkit, revision 1.1

1.1     ! root        1: makelinks full-path-name [other-path]
        !             2: goes through all the files in the [other]
        !             3: directory ([full] by default) for a manual section and
        !             4: creates files containg an appropriate link
        !             5: creates links within [full]
        !             6: for everything mentioned under a .SH NAME
        !             7: that doesn't already have a file.
        !             8: (Two directories are used for making links in the man cache)
        !             9: 
        !            10: cachelinks does makelinks throughout the manual cache
        !            11: 
        !            12: breaklinks
        !            13: removes all cache links whose names are not in the 
        !            14: manual source directories.  for cleaning up trash.
        !            15: A more delicate equivalent is rm `spoolref`
        !            16: 
        !            17: cache goes thru the cache of formatted pages and updates all files whose
        !            18: source postdates the cached version
        !            19: 
        !            20: secindex directory-name
        !            21: produces a list of all NAMES mentioned in the
        !            22: directory with the file in which each occurs
        !            23: output on standard output
        !            24: 
        !            25: secindexes does all the man sections,
        !            26: putting the results in adm/man?.index
        !            27: 
        !            28: checkrefs
        !            29: goes through all the manual pages looking for cross-references
        !            30: and checks them against the names of all manual sections
        !            31: troubles may be seen in files, "nonref, needblank,
        !            32: badref"
        !            33: other incidental files created are "ref, def, xref, misref"
        !            34: 
        !            35: checkSH
        !            36: produces files /usr/man/adm.n containing all
        !            37: .SH lines in the nth directory, /usr/man/man1, man2, ...
        !            38: use sort -c +0 -1 +2n repeatedly to find files in which subheads are
        !            39: out of order
        !            40: 
        !            41: 
        !            42: checkfilref >badfil
        !            43: looks thru all files mentioned in the manual
        !            44: and puts a list of those that don't occur on the system,
        !            45: with the name of the manual section in which they are mentioned,
        !            46: in badfil
        !            47: 
        !            48: makind
        !            49: produces ptx input
        !            50: in file  permindex for troffing thus
        !            51:        troff ptxmac # no further file args
        !            52: 
        !            53: makcont
        !            54: produces table of contents info in file contents
        !            55: for troffing with contmac
        !            56: (Obsoleted by topic index)
        !            57: 
        !            58: libcontents library
        !            59: produces for the named library a list of externally
        !            60: define symbols; results in library basename.list
        !            61: 
        !            62: checklib
        !            63: compares the section indexes for sections 2 and 3 (see secindex)
        !            64: with the external symbols in various libraries
        !            65: and puts a comm listing of differences in man23.comm
        !            66: 
        !            67: maketopic
        !            68: produces a topic index of the manual in file topindex
        !            69: it creates a directory tjunk for workspace
        !            70: each manual page should have a .CT command before the .SH NAME
        !            71: maketopic extracts the page name, .CT arguments and name line
        !            72: the order of the index is the same as /usr/man/adm/categories
        !            73: to typeset use troff topmacs
        !            74: 
        !            75: numbertopind
        !            76: joins page numbers from "pagenumbers" to "topindex" and
        !            77: puts result in ntopindex to typeset with troff topmacs
        !            78: 
        !            79: cktopic
        !            80: checks that all manual pages contain a .CT line
        !            81: 
        !            82: spoolref >dead
        !            83: reads the indexes made by secindexes and puts on "dead" a
        !            84: list of obsolete files in the spool directory.
        !            85: these files have no source, or broken links, or mistaken links
        !            86: 
        !            87: pagecount -f
        !            88: Under option -f, typesets (discarding output) all of man[1-9]
        !            89: and produces file "pagesizes" that tells number of physical
        !            90: pages for each man page.
        !            91: Regardless of options, it uses file "pagelist", a hand-prepared
        !            92: file listing file names of all pages together with "pagesizes"
        !            93: to produce "pagenumbers" that tells where pages begin.
        !            94: All three files have lines of the form
        !            95:        man1/cat.1 optional-size optional-pagenumber
        !            96: The size from "pagesizes" takes precedence over that from "pagelist",
        !            97: but pagelist may list files (such as front matter) that are missing
        !            98: from pagesizes.  Lines in "pagelist" and "pagenumbers" having the form
        !            99:        odd
        !           100: force the next physical page to have an odd number.
        !           101: 
        !           102: preprocess man?/page.?
        !           103: returns a pipeline that tells how to preprocess the given
        !           104: man page for troff.  use it with "eval"
        !           105: 
        !           106: troffit [-a] man?/page.? ...
        !           107: runs troff on the specified pages, getting the page number
        !           108: from the file pagenumbers, and putting on stderr entries
        !           109: suitable for the file pagesizes.
        !           110: 
        !           111: numberpermind
        !           112: takes the file "permindex" made by "makind" plus
        !           113: the file "pagenumbers" made by "pagecount" and produces
        !           114: "npermindex", which has page numbers attached, suitable
        !           115: for typesetting by "troff nptxmac #no further args"
        !           116: 
        !           117: cachindex
        !           118: goes thru all the NAME lines and puts them in /usr/spool/man/index
        !           119: for the benefit of man -k.  it should be run occasionally by cron

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