Update ronn

This commit is contained in:
Rico Sta. Cruz 2015-04-18 04:05:27 +08:00
parent cdb6135103
commit 82370f7da7
1 changed files with 101 additions and 56 deletions

97
ronn.md
View File

@ -1,24 +1,44 @@
--- ---
title: Ronn title: Ronn
layout: default
--- ---
### Generating 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), [rtomayko/ronn](https://github.com/rtomayko/ronn).
{:.center.brief-intro}
$ ronn foo.ronn ```sh
gem install ronn
```
{:.light}
$ ronn -r foo.ronn # Creates foo.7 ```sh
ronn foo.1.md # creates foo.1.html
ronn -r foo.1.md # creates foo.1 (--roff)
ronn -m foo.1.md # view as manpage
```
{:.light}
$ ronn --html --style toc,80c foo.ronn ### Other options
# manual - top center ```sh
# org - bottom left --pipe # write to stdout
$ ronn --manual="MY MANUAL" --organization="RONN 0.7.0" --server, -S # serve in http://localhost:1207
See [ronn.1](http://rtomayko.github.com/ronn/ronn.1.html). --html, -5 # default
--fragment, -f # html without header/title/footer
### Format --style toc,80c # toc (table of contents)
# 80c (use 80c instead of 100c)
# print (include print stylesheet)
# dark
--manual="MY MANUAL" # shown on top-center
--organization="RONN 0.7.0" # shown on bottom-left
--date="YYYY-MM-DD" # shown on bottom-center
```
## Basic template
```markdown
name(1) -- short, single-sentence description name(1) -- short, single-sentence description
============================================= =============================================
@ -29,30 +49,42 @@ See [ronn.1](http://rtomayko.github.com/ronn/ronn.1.html).
## DESCRIPTION ## DESCRIPTION
A normal paragraph. This can span multiple lines and is terminated with two A normal paragraph. This can span multiple lines and is terminated with two
or more line endings -- just like Markdown. or more line endings just like Markdown.
Inline markup for `code`, `user input`, and **strong** are displayed ## OPTIONS
boldface; <variable>, _emphasis_, *emphasis*, are displayed in italics
(HTML) or underline (roff).
### Linking * `-R`, `--reporter`=[<name>] :
Use the reporter <name>.
Manual references like sh(1), markdown(7), roff(7), etc. are hyperlinked in ## EXAMPLES
HTML output.
Link to sections like [STANDARDS][], [SEE ALSO][], or [WITH A DIFFERENT LINK Indent examples with 4 spaces.
TEXT][#SEE-ALSO].
### Definition lists $ ls
$ ls -la
* `-a`, `--argument`=[<value>]: ## SEE ALSO
One or more paragraphs describing the argument.
* You can put whatever you *want* here, really: ronn-format(7), ronn(1)
Nesting and paragraph spacing are respected. ```
### Frequently used sections ## Formatting tags
```
## FORMATTING
* Bold: `code` **strong**
* Underline: <variable> _emphasis_ *emphasis*
* Linking manual references: sh(1) markdown(7)
* Linking sections: [STANDARDS][], [SEE ALSO][], [DIFFERENT TEXT][#SEE-ALIA]
```
## Frequently-used sections
```markdown
## NAME
## SYNOPSIS
## DESCRIPTION
## OPTIONS ## OPTIONS
## SYNTAX ## SYNTAX
## ENVIRONMENT ## ENVIRONMENT
@ -64,5 +96,18 @@ See [ronn.1](http://rtomayko.github.com/ronn/ronn.1.html).
## AUTHOR ## AUTHOR
## COPYRIGHT ## COPYRIGHT
## SEE ALSO ## SEE ALSO
```
See [ronn-format.7](http://rtomayko.github.com/ronn/ronn-format.7.html). ## Sections
See [Man page sections](http://www.december.com/unix/ref/mansec.html) (december.com).
| Section | Description |
| --- | --- |
| `1` | General commands |
| `2` | System calls |
| `3` | C standard lib |
| `4` | Special files (/dev) and drivers |
| `5` | File formats |
| `6` | Games |
| `7` | Misc |
| `8` | System administration commands and procedures |