| Skip Navigation Links | |
| Exit Print View | |
 | man pages section 1M: System Administration Commands Oracle Solaris 11 Information Library |
| Skip Navigation Links | |
| Exit Print View | |
| man pages section 1M: System Administration Commands Oracle Solaris 11 Information Library |
- create the formatted files for the reference manual
/usr/bin/catman [-c] [-n] [-p] [-t] [-w] [-Mdirectory] [-Tmacro-package] [sections]
/usr/bin/catman [-Mdirectory]-w
Thecatman utility creates the preformatted versions of the on-line manual fromthenroff(1) orsgml(5) input files. This feature allows easy distribution ofthe preformatted manual pages among a group of associated machines, since itmakes the directories of preformatted manual pages self-contained and independent of the unformattedentries.
With the-w option,catman also creates index files, in the directoriesspecified by theMANPATH or the-M option. If there is noMANPATH or-M option specified, unless-n is specified,catman creates index filesat the/usr/share/man/ and/usr/gnu/share/man/ directories by default. When any specified ordefault directory is read-only,catman fails and displays an error message tostderr, indicating that writing is not allowed to the directory.
Each manual page is examined and those whose preformatted versions are missingor out of date are recreated. If any changes are made,catmanrecreates the index files.
If a manual page is ashadow page, that is, it sourcesanother manual page for its contents, a symbolic link is made inthecatx orfmtx directory to the appropriate preformatted manual page.
Shadow files in an unformatted nroff source file are identified by thefirst line being of the form.so manx/yyy.x.
Shadow files in the SGML sources are identified by the stringSHADOW_PAGE.The file entity declared in the shadow file identifies the file tobe sourced.
The following options are supported:
Create unformatted nroff source files in the appropriateman subdirectories from the SGML sources. This option will overwrite any existing file in theman directory of the same name as the SGML file.
Do not create (or recreate) the index files. If the-n option is specified, the index files are not created and theapropos(1) andwhatis(1) commands might run more slowly than otherwise.
Dry—run option. That is, display what would be done instead of doing it.
Createtroffed entries in the appropriatefmt subdirectories instead ofnroffing into thecat subdirectories.
Create the index files that are used byapropos(1),whatis(1) and theman(1)-f,-k, and-K options, in the directories specified by theMANPATH environment variable or the-M option. If noMANPATH or-M option is specified, index files are created in the/usr/share/man/ and/usr/gnu/share/man/ directories by default. No manual reformatting is done.
Update manual pages located in the specifieddirectory, (/usr/share/man by default). If the-M option is specified, the directory argument must not contain a `,' (comma), since a comma is used to delineate section numbers. Seeman(1).
Usemacro-package in place of the standard manual page macros, (man(5) by default).
The following operand is supported:
If there is one parameter not starting with a `-', it is taken to be a space separated list of manual sections to be processed bycatman. If this operand is specified, only the manual sections in the list will be processed. For example,
catman 1 2 3
only updates manual sections1,2, and3. If specific sections are not listed, all sections in theman directory specified by the environment variableMANPATH are processed.
The name of the formatter to use when the-t flag is given. If not set,troff(1) is used.
A colon-separated list of directories that are processed bycatman andman(1). Each directory can be followed by a comma-separated list of sections. If set, its value overrides/usr/share/man as the default directory search path, and theman.cf file as the default section search path. The-M and-s flags, in turn, override these values.
Example 1 Creating an Index File
The following command creates an index file in the/usr/local/share/man directory.
#catman -M /usr/local/share/man -w
default manual directory location
raw nroff input files
raw SGML input files
preformattednroffed manual pages
preformattedtroffed manual pages
default macro package
index file for-K query
Seeattributes(5) for descriptions of the following attributes:
|
apropos(1),man(1),nroff(1),rm(1),troff(1),whatis(1),attributes(5),man(5),sgml(5)
The file outside the parentheses is missing, and is referred to by the file inside them.
catman only allows references to filenames that are relative to the directory/usr/man.
A harmless warning message indicating that one of the directoriescatman normally looks for is missing.
A harmless warning message indicatingcatman came across an empty directory.
If a user, who has previously runcatman to install thecat*directories, upgrades the operating system, the entirecat* directory structure should beremoved prior to runningcatman. Seerm(1).
Do not re-runcatman to rebuild the index files unless the completeset ofman* directories is present.catman builds the index files basedon theman* directories.
Thewindex database has been replaced by index files. Unlike the casewithwindex, index file generation does not pose any specific restrictions orprerequisites on what can be indexed.
Copyright © 2011, Oracle and/or its affiliates. All rights reserved.Legal Notices |   |