3 category: Ruby libraries
7 prism_languages: [bash, ruby, json, markdown]
9 Ronn generates Man pages. See [ronn(1)](http://rtomayko.github.io/ronn/ronn.1.html), [ronn-format(7)](http://rtomayko.github.com/ronn/ronn-format.7.html). Also see it on GitHub: [rtomayko/ronn](https://github.com/rtomayko/ronn).
26 ronn foo.1.md # creates foo.1.html
27 ronn -r foo.1.md # creates foo.1 (--roff)
28 ronn -r -h foo.1.md # builds --roff and --html
29 ronn -m foo.1.md # view as manpage
37 name(1) -- short, single-sentence description
38 =============================================
42 `name` [<optional>...] <flags>
46 A normal paragraph. This can span multiple lines and is terminated with two
47 or more line endings just like Markdown.
52 Displays the help screen.
55 Displays version information.
59 Indent examples with 4 spaces.
66 **PROJECTNAME** is copyright (c) 2015, Rico Sta. Cruz. Released under the MIT
71 ronn-format(7), ronn(1)
95 #### Manual references
107 [DIFFERENT TEXT][#SEE-ALSO]
113 [URL link](http://github.com/rstacruz)
117 ## Frequently-used sections
129 - `## SECURITY CONSIDERATIONS`
142 --pipe # write to stdout
143 --server, -S # serve in http://localhost:1207
148 --fragment, -f # html without header/title/footer
152 --style=toc,80c # toc (table of contents)
153 # 80c (use 80c instead of 100c)
154 # print (include print stylesheet)
159 --manual="MY MANUAL" # shown on top-center
160 --organization="RONN 0.7.0" # shown on bottom-left
161 --date="YYYY-MM-DD" # shown on bottom-center
166 | Section | Description |
168 | `1` | General commands |
169 | `2` | System calls |
170 | `3` | C standard lib |
171 | `4` | Special files (/dev) and drivers |
172 | `5` | File formats |
175 | `8` | System administration commands and procedures |
177 See [Man page sections](http://www.december.com/unix/ref/mansec.html) (december.com).
183 Place manual files in `man/xxx.1.md`, then in package.json:
188 "prepublish": "npm run build-man",
189 "build-man": "if which ronn; then ronn man/*.md --html --roff --style=toc,80c --organization=\"@rstacruz\"; fi"
199 npm install -g marked-man
200 marked-man foo.1.md > foo.1
205 * No definition lists
208 See [marked-man](https://github.com/kapouer/marked-man).