SECTION(1MAN) COMMAND REFERENCE SECTION(1MAN)
NAME
section - print sections of manual entries
SYNOPSIS
section [ -h ] [ -n ] [ -{qv} ] [ -{rt} ] [ -s section-list
] [ section ] title ...
DESCRIPTION
Like help(1man), section executes man(1man) with the given
section and title arguments in order to obtain the names of
the files containing the manual entries. The data generated
by buildif(1man) must be present in the manual page entry
for section to be used on that entry.
The section-list is a list of abbreviations for sections
separated by commas, tabs, and spaces. The following table
shows the known abbreviations and the manual page sections
they correspond to. The abbreviations are listed in the
order that section with no -s option uses.
na NAME
sy SYNOPSIS
de DESCRIPTION
op OPTIONS
e xEXAMPLES
fi FILES
di DIAGNOSTICS
va VARIABLES
rv RETURN VALUE
ca CAVEATS
se SEE ALSO
re REFERENCES
no The contents of the notes file in $HOME/.helpnotes
See the manual page for help(1man) for a description of
manual page notes.
There are three output formats produced by section : raw,
squeezed, and full. The raw format is used when the -r
option is given, or when no formatting options are given and
the standard output is not a terminal. With raw formatting,
the text is printed on the standard output exactly as it
appears in the manual page file. The squeezed format is
used whenever the -t option is given. This format causes
all sequences containing backspaces to be squeezed into just
the text that would be seen, and all multiple blank lines to
be squeezed into a single blank line. When no formatting
options are given and the standard output is a terminal,
full formatting is used. Full formatting acts like squeezed
formatting, except that bold and underlined terminal
sequences are printed so that the text looks like it has
been piped through more(1) or ul(1).
Printed 4/6/89 1
SECTION(1MAN) COMMAND REFERENCE SECTION(1MAN)
Unless the -h option is given, the title and section of the
manual page is printed on a line before any text. For
example, the command ``section csh'' would print the header
``csh(1csh):'' before the text.
OPTIONS
-h Do not print header line.
-n Do not print the first line of the text. This first line
contains the section header, such as SYNOPSIS.
-q Print only urgent error messages. This option can not be
used with -v.
-r Raw format. No processing of backspaces or multiple
blank lines is done.
-s section-list
Use the given section list as the ordering for printing
the sections. The list is as described above.
-t Squeeze format. Multiple blank lines are squeezed into
single blank lines, and backspace sequences are turned
into the characters to be printed.
-v Verbose. Print error messages when a manual entry does
not contain the requested section.
EXAMPLES
The following example shows a csh(1csh) alias which will
print the SYNOPSIS and OPTIONS sections for the given
arguments. Note that no header or section name is printed,
and only urgent messages are printed.
alias ops 'section -qnh -s sy,op \!$'
The following is the same example done as a sh(1sh)
function.
ops()
{
section -qnh -s sy,op "$@"
}
FILES
$HOME/.helpnotes
Directory in which to search for the notes on
the manual entry when the ``no'' section is
requested.
VARIABLES
HOME The user's home directory.
Printed 4/6/89 2
SECTION(1MAN) COMMAND REFERENCE SECTION(1MAN)
TERM The user's terminal type.
TERMCAP The name of the terminal capability database
or the terminal entry itself.
RETURN VALUE
[NO_ERRS] Command completed without error.
[USAGE] Incorrect command line syntax. Execution
terminated.
[NP_WARN] An error warranting a warning message
occurred. Execution continues.
[NP_ERR] An error occurred that was not a system
error. Execution terminated.
[P_WARN] A system error occurred. Execution continues.
See intro(2) for more information on system
errors.
[NP_WARN] An error warranting a warning message
occurred. Execution continues.
CAVEATS
The bold terminal sequence is determined by looking in the
termcap entry for ``md'' and ``me''. If those do not exist,
``so'' and ``se'' are used. If those do not exist, nothing
is printed for bold mode.
The underlining terminal sequence is determined by looking
in the termcap entry for ``uc''. If that does not exist,
``us'' and ``ue'' are used. If those do not exist, ``so''
and ``se'' are used. If those do not exist, nothing is
printed for underline mode.
SEE ALSO
apropos(1man), buildif(1man), help(1man), makewhatis(1man),
manintro(1man), more(1), ul(1), whatis(1man), man(5man),
manindex(5man), termcap(5t), whatis(5man), and catman(8man).
Printed 4/6/89 3
%%index%%
na:384,94;
sy:478,460;
de:938,2514;3908,248;
op:4156,1027;
ex:5183,543;
fi:5726,262;
va:5988,147;6591,163;
rv:6754,773;
ca:7527,591;
se:8118,528;
%%index%%000000000179