manual

manual
======

Functions and constants for man page generation.

.

Used by the command module and the mdp program.

Install

``
npm i manual
`

Constants are shown below see index.js for function definitions.

`javascript
{
"NAME": "name",
"SYNOPSIS": "synopsis",
"DESCRIPTION": "description",
"COMMANDS": "commands",
"OPTIONS": "options",
"ENVIRONMENT": "environment",
"FILES": "files",
"EXAMPLES": "examples",
"EXIT": "exit",
"HISTORY": "history",
"AUTHOR": "author",
"BUGS": "bugs",
"COPYRIGHT": "copyright",
"SEE": "see",
"SECTION": 1,
"constants": {
"NAME": "name",
"SYNOPSIS": "synopsis",
"DESCRIPTION": "description",
"COMMANDS": "commands",
"OPTIONS": "options",
"ENVIRONMENT": "environment",
"FILES": "files",
"EXAMPLES": "examples",
"EXIT": "exit",
"HISTORY": "history",
"AUTHOR": "author",
"BUGS": "bugs",
"COPYRIGHT": "copyright",
"SEE": "see"
},
"sections": [
"User Commands",
"System Calls",
"Library Functions",
"Special Files",
"File Formats",
"Games",
"Miscellanea",
"System Administration"
],
"layout": [
"name",
"synopsis",
"description",
"commands",
"options",
"environment",
"files",
"examples",
"exit",
"history",
"author",
"bugs",
"copyright",
"see"
],
"headers": {
"synopsis": "usage",
"arguments": "arguments",
"see": "see also"
},
"elements": {
"th": ".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"\n",
"sh": ".SH \"%s\"\n",
"ss": ".SS \"%s\"\n",
"sp": ".SP\n",
"b": ".B ",
"pp": ".PP\n%s\n",
"tp": ".TP\n",
"ti": ".TI\n",
"fb": "\\fB",
"fi": "\\fI",
"fr": "\\fR",
"lt": ".LT\n%s\n",
"bl": ".BL\n",
"it": ".IP \"\\[ci]\" 4\n%s\n",
"el": ".EL\n",
"br": ".br\n",
"comment": ".\\\" %s\n"
}
}
`

Developer

Clone the repository, install project and global dependencies (mdp, jshint and jscs):

`
npm i && npm i -g mdp jshint jscs
`

$3

Run the test specifications:

`
npm test
`

$3

Generate code coverage:

`
npm run cover
`

$3

Run the source tree through jshint and jscs:

`
npm run lint
`

$3

Remove generated files:

`
npm run clean
`

$3

Generate the readme file (requires mdp):

`
npm run readme
``

License

Everything is MIT. Read the license if you feel inclined.

Generated by mdp(1).

[mdp]: https://github.com/tmpfs/mdp
[command]: https://github.com/cli-kit/cli-command
[jshint]: http://jshint.com
[jscs]: http://jscs.info