{ "content": [ { "type": "text", "text": "# catman (man)\n\n## NAME\n\ncatman - create or update the pre-formatted manual pages\n\n## SYNOPSIS\n\ncatman [-d?V] [-M path] [-C file] [section] ...\n\n## DESCRIPTION\n\ncatman is used to create an up to date set of pre-formatted manual pages known as cat pages.\nCat pages are generally much faster to display than the original manual pages, but require\nextra storage space. The decision to support cat pages is that of the local administrator,\nwho must provide suitable directories to contain them.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (5 subsections)\n- **ENVIRONMENT**\n- **FILES**\n- **SEE ALSO**\n- **AUTHOR**\n- **BUGS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "catman", "section": "", "mode": "man", "summary": "catman - create or update the pre-formatted manual pages", "synopsis": "catman [-d?V] [-M path] [-C file] [section] ...", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "-d", "long": "--debug", "arg": null, "description": "Print debugging information." }, { "flag": "-M", "long": null, "arg": null, "description": "Specify an alternate colon-delimited manual page hierarchy search path. By default, this is all paths indicated as system hierarchies in the man-db configuration file." }, { "flag": "-C", "long": null, "arg": null, "description": "Use this user configuration file rather than the default of ~/.manpath. -?, --help Print a help message and exit." }, { "flag": "", "long": "--usage", "arg": null, "description": "Print a short usage message and exit." }, { "flag": "-V", "long": "--version", "arg": null, "description": "Display version information." } ], "examples": [], "see_also": [ { "name": "man", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/man/1/json" }, { "name": "manpath", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/manpath/5/json" }, { "name": "mandb", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/mandb/8/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 14, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-d --debug", "lines": 2, "flag": "-d", "long": "--debug" }, { "name": "-M --manpath=", "lines": 3, "flag": "-M" }, { "name": "-C --config-file=", "lines": 5, "flag": "-C" }, { "name": "--usage", "lines": 2, "long": "--usage" }, { "name": "-V --version", "lines": 2, "flag": "-V", "long": "--version" } ] }, { "name": "ENVIRONMENT", "lines": 13, "subsections": [] }, { "name": "FILES", "lines": 9, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "AUTHOR", "lines": 4, "subsections": [] }, { "name": "BUGS", "lines": 6, "subsections": [] } ], "sections": { "NAME": { "content": "catman - create or update the pre-formatted manual pages\n", "subsections": [] }, "SYNOPSIS": { "content": "catman [-d?V] [-M path] [-C file] [section] ...\n", "subsections": [] }, "DESCRIPTION": { "content": "catman is used to create an up to date set of pre-formatted manual pages known as cat pages.\nCat pages are generally much faster to display than the original manual pages, but require\nextra storage space. The decision to support cat pages is that of the local administrator,\nwho must provide suitable directories to contain them.\n\nThe options available to catman are the manual page hierarchies and sections to pre-format.\nThe default hierarchies are those specified as system hierarchies in the man-db configuration\nfile, and the default sections are either the colon-delimited contents of the environment\nvariable $MANSECT or the standard set compiled into man if $MANSECT is undefined. Supplying\ncatman with a set of whitespace-delimited section names will override both of the above.\n\ncatman makes use of the index database cache associated with each hierarchy to determine\nwhich files need to be formatted.\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "-d --debug", "content": "Print debugging information.\n", "flag": "-d", "long": "--debug" }, { "name": "-M --manpath=", "content": "Specify an alternate colon-delimited manual page hierarchy search path. By default,\nthis is all paths indicated as system hierarchies in the man-db configuration file.\n", "flag": "-M" }, { "name": "-C --config-file=", "content": "Use this user configuration file rather than the default of ~/.manpath.\n\n-?, --help\nPrint a help message and exit.\n", "flag": "-C" }, { "name": "--usage", "content": "Print a short usage message and exit.\n", "long": "--usage" }, { "name": "-V --version", "content": "Display version information.\n", "flag": "-V", "long": "--version" } ] }, "ENVIRONMENT": { "content": "MANSECT\nIf $MANSECT is set, its value is a colon-delimited list of sections and it is used to\ndetermine which manual sections to search and in what order. The default is \"1 n l 8\n3 0 2 3posix 3pm 3perl 3am 5 4 9 6 7\", unless overridden by the SECTION directive in\n/etc/manpath.config.\n\nMANPATH\nIf $MANPATH is set, its value is interpreted as the colon-delimited manual page hier‐\narchy search path to use.\n\nSee the SEARCH PATH section of manpath(5) for the default behaviour and details of how\nthis environment variable is handled.\n", "subsections": [] }, "FILES": { "content": "/etc/manpath.config\nman-db configuration file.\n\n/usr/man/index.(bt|db|dir|pag)\nA traditional global index database cache.\n\n/var/catman/index.(bt|db|dir|pag)\nAn alternate or FSSTND compliant global index database cache.\n", "subsections": [] }, "SEE ALSO": { "content": "man(1), manpath(5), mandb(8)\n", "subsections": [] }, "AUTHOR": { "content": "Wilf. (G.Wilford@ee.surrey.ac.uk).\nFabrizio Polacco (fpolacco@debian.org).\nColin Watson (cjwatson@debian.org).\n", "subsections": [] }, "BUGS": { "content": "https://gitlab.com/cjwatson/man-db/-/issues\nhttps://savannah.nongnu.org/bugs/?group=man-db\n\n\n\n2.10.2 2022-03-17 CATMAN(8)", "subsections": [] } } } }