101 lines
2.4 KiB
JSON
101 lines
2.4 KiB
JSON
{
|
||
"name": "man",
|
||
"section": 1,
|
||
"title": "display on-line manual pages",
|
||
"synopsis": [
|
||
"man [-k keyword] [-f name] [-l] [[section] name]",
|
||
"man reads /share/man/man.json on the system drive."
|
||
],
|
||
"description": "Displays manual pages from the merged JSON database. Section 1: /bin and git/shell pages. Section 7: handbook (man handbook), user manual (man users-manual), developer guide (man devguide), and docs/ (man docs), merged at build from handbook/*.md, users-manual/*.md, developer-guide/*.md, and docs/**/*.md.",
|
||
"options": [
|
||
{
|
||
"flag": "-k, --apropos",
|
||
"meaning": "Search keywords and titles (substring)"
|
||
},
|
||
{
|
||
"flag": "-f, --whatis",
|
||
"meaning": "One-line description for exact name"
|
||
},
|
||
{
|
||
"flag": "-l, --list",
|
||
"meaning": "List pages grouped by category (/bin, git/shell, handbook, user manual, developer guide, docs/), then alphabetically"
|
||
}
|
||
],
|
||
"keywords": [
|
||
"man",
|
||
"manual",
|
||
"help",
|
||
"documentation",
|
||
"apropos",
|
||
"whatis",
|
||
"cheat",
|
||
"examples"
|
||
],
|
||
"environment": [
|
||
"MANWIDTH — if set, wrap width (clamped 40–200); overrides auto width",
|
||
"COLUMNS — when stdout is not a TTY (or output is captured), used if MANWIDTH unset",
|
||
"NO_COLOR — disable bold headings on TTY"
|
||
],
|
||
"seeAlso": [
|
||
{
|
||
"name": "help",
|
||
"section": 1
|
||
},
|
||
{
|
||
"name": "bare-os-handbook",
|
||
"section": 7
|
||
},
|
||
{
|
||
"name": "bare-os-developer-guide",
|
||
"section": 7
|
||
},
|
||
{
|
||
"name": "bare-os-docs",
|
||
"section": 7
|
||
},
|
||
{
|
||
"name": "bare-os-users-manual",
|
||
"section": 7
|
||
}
|
||
],
|
||
"bareOsNotes": "No troff; no embedded DB fallback in v1.",
|
||
"examples": [
|
||
{
|
||
"caption": "open page",
|
||
"code": "man sed"
|
||
},
|
||
{
|
||
"caption": "handbook TOC (section 7)",
|
||
"code": "man handbook"
|
||
},
|
||
{
|
||
"caption": "handbook chapter by section",
|
||
"code": "man 7 handbook-01-introduction"
|
||
},
|
||
{
|
||
"caption": "docs hub (section 7)",
|
||
"code": "man docs"
|
||
},
|
||
{
|
||
"caption": "user manual TOC (section 7)",
|
||
"code": "man users-manual"
|
||
},
|
||
{
|
||
"caption": "apropos",
|
||
"code": "man -k copy"
|
||
},
|
||
{
|
||
"caption": "whatis",
|
||
"code": "man -f grep"
|
||
},
|
||
{
|
||
"caption": "all pages",
|
||
"code": "man -l"
|
||
},
|
||
{
|
||
"caption": "fixed width (overrides TTY auto width)",
|
||
"code": "MANWIDTH=64 man awk"
|
||
}
|
||
]
|
||
}
|