89 lines
2.1 KiB
JSON
89 lines
2.1 KiB
JSON
{
|
|
"name": "man",
|
|
"section": 1,
|
|
"title": "display on-line manual pages",
|
|
"synopsis": [
|
|
"man [-k keyword] [-f name] [-l] [-w] [[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) and developer guide (man devguide), merged at build from handbook/*.md and developer-guide/*.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, developer guide), then alphabetically"
|
|
},
|
|
{
|
|
"flag": "-w, --where, --path",
|
|
"meaning": "Print logical path to the manual database (/share/man/man.json)"
|
|
}
|
|
],
|
|
"keywords": [
|
|
"man",
|
|
"manual",
|
|
"help",
|
|
"documentation",
|
|
"apropos",
|
|
"whatis",
|
|
"cheat",
|
|
"examples"
|
|
],
|
|
"environment": [
|
|
"MANWIDTH — wrap width (default 72, min 40)",
|
|
"NO_COLOR — disable bold headings on TTY",
|
|
"PAGER=bare-slice — insert section breaks in long pages (optional MAN_SLICE lines per chunk, default 24)"
|
|
],
|
|
"seeAlso": [
|
|
{
|
|
"name": "help",
|
|
"section": 1
|
|
},
|
|
{
|
|
"name": "bare-os-handbook",
|
|
"section": 7
|
|
},
|
|
{
|
|
"name": "bare-os-developer-guide",
|
|
"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": "apropos",
|
|
"code": "man -k copy"
|
|
},
|
|
{
|
|
"caption": "whatis",
|
|
"code": "man -f grep"
|
|
},
|
|
{
|
|
"caption": "all pages",
|
|
"code": "man -l"
|
|
},
|
|
{
|
|
"caption": "narrow terminal",
|
|
"code": "MANWIDTH=64 man awk"
|
|
}
|
|
]
|
|
}
|