Update man renderer api docs.

mkdoc · Apr 18, 2016 · 7e0ecc1 · 7e0ecc1
1 parent cc9b097
commit 7e0ecc1
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -356,6 +356,20 @@ specified.
 Adds macros for headings level 1-6 (.h1-.h6), a macro for the thematic
 break (.hr) and the newline macro (.nl) after the preamble.
 
+A standard list uses the .BL, .IP and .EL macros rendering a circle as
+the list bullet.
+
+Lists that use the bullet character `+` are treated differently; they are
+rendered using the .TP macro and the first softbreak in the list item
+paragraph causes a newline in the output. This is intended for listing
+options and commands in the idiomatic format:
+
+```troff
+.TP
+\fB\-\-version\fR
+Print version and exit
+```
+
 * `opts` Object processing options.
 
 #### Options

diff --git a/lib/man.js b/lib/man.js
@@ -35,6 +35,20 @@ var macros = {
  *  Adds macros for headings level 1-6 (.h1-.h6), a macro for the thematic 
  *  break (.hr) and the newline macro (.nl) after the preamble.
  *
+ *  A standard list uses the .BL, .IP and .EL macros rendering a circle as 
+ *  the list bullet.
+ *
+ *  Lists that use the bullet character `+` are treated differently; they are 
+ *  rendered using the .TP macro and the first softbreak in the list item 
+ *  paragraph causes a newline in the output. This is intended for listing 
+ *  options and commands in the idiomatic format:
+ *
+ *  ```troff
+ *  .TP
+ *  \fB\-\-version\fR
+ *  Print version and exit
+ *  ```
+ *
  *  @constructor ManRenderer
  *  @param {Object} [opts] processing options.
  *