OS Manuals

/usr/bin/man

The man command and related utilities for examining on-line help files

From man-db 2.13.1-r57 (os), captured 2026-11-05 by running man --help (exit 0). permalink

Usage: man [OPTION...] [SECTION] PAGE...

  -C, --config-file=FILE     use this user configuration file
  -d, --debug                emit debugging messages
  -D, --default              reset all options to their default values
      --warnings[=WARNINGS]  enable warnings from groff

 Main modes of operation:
  -f, --whatis               equivalent to whatis
  -k, --apropos              equivalent to apropos
  -K, --global-apropos       search for text in all pages
  -l, --local-file           interpret PAGE argument(s) as local filename(s)
  -w, --where, --path, --location
                             print physical location of man page(s)
  -W, --where-cat, --location-cat
                             print physical location of cat file(s)

  -c, --catman               used by catman to reformat out of date cat pages
  -R, --recode=ENCODING      output source page encoded in ENCODING

 Finding manual pages:
  -L, --locale=LOCALE        define the locale for this particular man search
  -m, --systems=SYSTEM       use manual pages from other systems
  -M, --manpath=PATH         set search path for manual pages to PATH

  -S, -s, --sections=LIST    use colon separated section list

  -e, --extension=EXTENSION  limit search to extension type EXTENSION

  -i, --ignore-case          look for pages case-insensitively (default)
  -I, --match-case           look for pages case-sensitively

      --regex                show all pages matching regex
      --wildcard             show all pages matching wildcard

      --names-only           make --regex and --wildcard match page names only,
                             not descriptions

  -a, --all                  find all matching manual pages
  -u, --update               force a cache consistency check

      --no-subpages          don't try subpages, e.g. 'man foo bar' => 'man
                             foo-bar'

 Controlling formatted output:
  -P, --pager=PAGER          use program PAGER to display output
  -r, --prompt=STRING        provide the `less' pager with a prompt

  -7, --ascii                display ASCII translation of certain latin1 chars
  -E, --encoding=ENCODING    use selected output encoding
      --no-hyphenation, --nh turn off hyphenation
      --no-justification,                              --nj   turn off justification
  -p, --preprocessor=STRING  STRING indicates which preprocessors to run:
                             e - [n]eqn, p - pic, t - tbl,
g - grap, r - refer, v - vgrind

  -t, --troff                use groff to format pages
  -T, --troff-device[=DEVICE]   use groff with selected device

  -H, --html[=BROWSER]       use  or BROWSER to display HTML output
  -X, --gxditview[=RESOLUTION]   use groff and display through gxditview
                             (X11):
                             -X = -TX75, -X100 = -TX100, -X100-12 = -TX100-12
  -Z, --ditroff              use groff and force it to produce ditroff

  -?, --help                 give this help list
      --usage                give a short usage message
  -V, --version              print program version

Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options.

Report bugs to cjwatson@debian.org.
Options (40)
OptionDescriptionSource
-C, --config-file FILEUse this user configuration file rather than the default of ~/.manpath.help + man
-d, --debugPrint debugging information.help + man
-D, --defaultThis option is normally issued as the very first option and resets man's behaviour to its default.help + man
--warnings WARNINGSenable warnings from groffhelp
-f, --whatisApproximately equivalent to whatis.help + man
-k, --aproposApproximately equivalent to apropos.help + man
-K, --global-aproposSearch for text in all manual pages.help + man
-l, --local-fileinterpret PAGE argument(s) as local filename(s)help + man
-w, --where, --path, --locationDon't actually display the manual page, but do print the location of the source nroff file that would be formatted.help + man
-W, --where-cat, --location-catDon't actually display the manual page, but do print the location of the preformatted cat file that would be displayed.help + man
-c, --catmanThis option is not for general use and should only be used by the catman program.help + man
-R, --recode ENCODINGInstead of formatting the manual page in the usual way, output its source converted to the specified encoding.help + man
-L, --locale LOCALEman will normally determine your current locale by a call to the C function setlocale(3) which interrogates various environment variables, possibly including $LC_MESSAGES and $LANG.help + man
-m, --systems SYSTEMuse manual pages from other systemshelp
-M, --manpath PATHset search path for manual pages to PATHhelp + man
-S, -s, --sections LISTThe given list is a colon- or comma-separated list of sections, used to determine which manual sections to search and in what order.help + man
-e, --extension EXTENSIONSome systems incorporate large packages of manual pages, such as those that accompany the Tcl package, into the main manual page hierarchy.help + man
-i, --ignore-caseIgnore case when searching for manual pages.help + man
-I, --match-caseSearch for manual pages case-sensitively.help + man
--regexShow all pages with any part of either their names or their descriptions matching each page argument as a regular expression, as with apropos(1).help + man
--wildcardShow all pages with any part of either their names or their descriptions matching each page argument using shell-style wildcards, as with apropos(1) --wildcard.help + man
--names-onlyIf the --regex or --wildcard option is used, match only page names, not page descriptions, as with whatis(1).help + man
-a, --allBy default, man will exit after displaying the most suitable manual page it finds.help + man
-u, --updateThis option causes man to update its database caches of installed manual pages.help + man
--no-subpagesBy default, man will try to interpret pairs of manual page names given on the command line as equivalent to a single manual page name containing a hyphen or an underscore.help + man
-P, --pager PAGERuse program PAGER to display outputhelp + man
-r, --prompt STRINGIf a recent version of less is used as the pager, man will attempt to set its prompt and some sensible options.help + man
-7, --asciiWhen viewing a pure ascii(7) manual page on a 7 bit terminal or terminal emulator, some characters may not display correctly when using the latin1(7) device description with GNU nroff.help + man
-E, --encoding ENCODINGGenerate output for a character encoding other than the default.help + man
--no-justification, --njNormally, nroff will automatically justify text to both margins.help + man
-p, --preprocessor STRINGSTRING indicates which preprocessors to run: e - [n]eqn, p - pic, t - tbl,help + man
-t, --troffUse groff -mandoc to format the manual page to stdout.help + man
-T, --troff-device DEVICEuse groff with selected devicehelp
-H, --html BROWSERuse or BROWSER to display HTML outputhelp
-X, --gxditview RESOLUTIONuse groff and display through gxditview (X11):help
-Z, --ditroffgroff will run troff and then use an appropriate post-processor to produce output suitable for the chosen device.help + man
-?, --helpPrint a help message and exit.help + man
--usagePrint a short usage message and exit.help + man
-V, --versionDisplay version information.help + man
--no-hyphenation, --nhNormally, nroff will automatically hyphenate text at line breaks even in words that do not contain hyphens, if it is necessary to do so to lay out words on a line without excessive spacing. (in the manual page but not in --help)man
Exit status (5) from the manual page
0Successful program execution.
1Usage, syntax or configuration file error.
2Operational error.
3A child process returned a non-zero exit status.
16At least one of the pages/files/keywords didn't exist or wasn't matched.

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.