- 论坛徽章:
- 8
|
- man(1) man(1)
- NAME
- man - format and display the on-line manual pages
- SYNOPSIS
- man [-acdfFhkKtwW] [--path] [-m system] [-p string] [-C config_file]
- [-M pathlist] [-P pager] [-S section_list] [section] name ...
- DESCRIPTION
- man formats and displays the on-line manual pages. If you specify
- section, man only looks in that section of the manual. name is nor-
- mally the name of the manual page, which is typically the name of a
- command, function, or file. However, if name contains a slash (/)
- then man interprets it as a file specification, so that you can do man
- ./foo.5 or even man /cd/foo/bar.1.gz.
- See below for a description of where man looks for the manual page
- files.
- OPTIONS
- -C config_file
- Specify the configuration file to use; the default is
- /etc/man.config. (See man.config(5).)
- -M path
- Specify the list of directories to search for man pages. Sepa-
- rate the directories with colons. An empty list is the same as
- not specifying -M at all. See SEARCH PATH FOR MANUAL PAGES.
- -P pager
- Specify which pager to use. This option overrides the MANPAGER
- environment variable, which in turn overrides the PAGER vari-
- able. By default, man uses /usr/bin/less -iRs.
- -S section_list
- List is a colon separated list of manual sections to search.
- This option overrides the MANSECT environment variable.
- -a By default, man will exit after displaying the first manual
- page it finds. Using this option forces man to display all the
- manual pages that match name, not just the first.
- -b Disable any reference to color in the roff source. NOCOLOR in
- the configuration file will have the same effect.
- -c Reformat the source man page, even when an up-to-date cat page
- exists. This can be meaningful if the cat page was formatted
- for a screen with a different number of columns, or if the pre-
- formatted page is corrupted.
- -d Don't actually display the man pages, but do print gobs of
- debugging information.
- -D Both display and print debugging info.
- -f Equivalent to whatis.
- -F or --preformat
- Format only - do not display.
- -h Print a one-line help message and exit.
- -k Equivalent to apropos.
- -K Search for the specified string in *all* man pages. Warning:
- this is probably very slow! It helps to specify a section.
- (Just to give a rough idea, on my machine this takes about a
- minute per 500 man pages.)
- -m system
- Specify an alternate set of man pages to search based on the
- system name given.
- -p string
- Specify the sequence of preprocessors to run before nroff or
- troff. Not all installations will have a full set of prepro-
- cessors. Some of the preprocessors and the letters used to
- designate them are: eqn (e), grap (g), pic (p), tbl (t), vgrind
- (v), refer (r). This option overrides the MANROFFSEQ environ-
- ment variable.
- -t Use groff -Tps -man to format the manual page, passing the out-
- put to stdout. The output from groff -Tps -man may need to be
- passed through some filter or another before being printed.
- -w or --path
- Don't actually display the man pages, but do print the loca-
- tion(s) of the files that would be formatted or displayed. If
- no argument is given: display (on stdout) the list of directo-
- ries that is searched by man for man pages. If manpath is a
- link to man, then "manpath" is equivalent to "man --path".
- -W Like -w, but print file names one per line, without additional
- information. This is useful in shell commands like man -aW man
- | xargs ls -l
- CAT PAGES
- Man will try to save the formatted man pages, in order to save format-
- ting time the next time these pages are needed. Traditionally, for-
- matted versions of pages in DIR/manX are saved in DIR/catX, but other
- mappings from man dir to cat dir can be specified in /etc/man.config.
- No cat pages are saved when the required cat directory does not exist.
- No cat pages are saved when they are formatted for a line length dif-
- ferent from 80. No cat pages are saved when man.conf contains the
- line NOCACHE.
- It is possible to make man suid to a user man. Then, if a cat direc-
- tory has owner man and mode 0755 (only writable by man), and the cat
- files have owner man and mode 0644 or 0444 (only writable by man, or
- not writable at all), no ordinary user can change the cat pages or put
- other files in the cat directory. If man is not made suid, then a cat
复制代码 |
|