man/kramdown-man.1 in kramdown-man-0.1.9 vs man/kramdown-man.1 in kramdown-man-1.0.0
- old
+ new
@@ -1,204 +1,285 @@
-.\" Generated by kramdown-man 0.1.9
+.\" Generated by kramdown-man 1.0.0
.\" https://github.com/postmodern/kramdown-man#readme
-.TH kramdown-man.1 "April 2013" kramdown-man "User Manuals"
-.LP
+.TH kramdown-man 1 "April 2013" kramdown-man "User Manuals"
.SH SYNOPSIS
-.LP
.PP
-\fBkramdown-man\fR \[lB]\fIoptions\fP\[rB] <\fIINPUT\fP >\fIOUTPUT\fP
-.LP
+\fBkramdown-man\fR \[lB]\fIoptions\fP\[rB] \fIMARKDOWN\[ru]FILE\fP
.SH DESCRIPTION
-.LP
.PP
A Kramdown
.UR http:\[sl]\[sl]kramdown\.gettalong\.org\[sl]
-.UE plugin for converting Markdown files into man pages\.
-.LP
+.UE
+plugin for converting Markdown files into man pages\.
.SH ARGUMENTS
-.LP
.TP
-\fIINPUT\fP
+\fIMARKDOWN\[ru]FILE\fP
The input markdown file to convert\.
-.LP
-.TP
-\fIOUTPUT\fP
-The output file for the man page\.
-.LP
.SH OPTIONS
-.LP
.TP
+\fB-o\fR, \fB--output\fR \fIOUTPUT\fP
+The file to write the man page output to\.
+.TP
+\fB-V\fR, \fB--version\fR
+Prints the \fBkramdown-man\fR version\.
+.TP
\fB-h\fR, \fB--help\fR
Prints the usage for \fBkramdown-man\fR\.
-.LP
.SH EXAMPLE
-.LP
-.nf
+.PP
+Render a man page from markdown:
+.PP
+.RS 4
+.EX
+\[Do] kramdown\-man \-o man\[sl]myprogram\.1 man\[sl]myprogram\.1\.md
+.EE
+.RE
+.PP
+Preview the rendered man page:
+.PP
+.RS 4
+.EX
+\[Do] kramdown\-man man\[sl]myprogram\.1\.md
+.EE
+.RE
+.SS RUBY
+.PP
+.RS 4
+.EX
require \(aqkramdown\(aq
require \(aqkramdown\[sl]man\(aq
doc \[eq] Kramdown::Document\.new(File\.read(\(aqman\[sl]kramdown\-man\.1\.md\(aq))
File\.write(\(aqman\[sl]kramdown\-man\.1\(aq,doc\.to\[ru]man)
system \(aqman\(aq, \(aqman\[sl]kramdown\-man\.1\(aq
-.fi
-.LP
+.EE
+.RE
+.SS RAKE TASK
+.PP
+Define a \fBman\fR and files tasks which render all \fB*.md\fR files within the
+\fBman/\fR directory:
+.PP
+.RS 4
+.EX
+require \(aqkramdown\[sl]man\[sl]task\(aq
+Kramdown::Man::Task\.new
+.EE
+.RE
.SH SYNTAX
-.LP
-.SS FORMATTING
-.LP
-.nf
+.SS Code
+.PP
+.RS 4
+.EX
\`code\`
-.fi
-.LP
+.EE
+.RE
.PP
\fBcode\fR
-.LP
-.nf
+.SS Emphasis
+.PP
+.RS 4
+.EX
*emphasis*
-.fi
-.LP
+.EE
+.RE
.PP
\fIemphasis\fP
-.LP
-.nf
+.SS Strong
+.PP
+.RS 4
+.EX
**strong**
-.fi
-.LP
+.EE
+.RE
.PP
\fBstrong\fP
-.LP
-.SS PARAGRAPHS
-.LP
-.nf
+.SS Paragraph
+.PP
+.RS 4
+.EX
Normal paragraph\.
-.fi
-.LP
+.EE
+.RE
.PP
Normal paragraph\.
-.LP
-.nf
+.SS Usage String
+.PP
+.RS 4
+.EX
\`command\` \[lB]\`\-\-foo\`\[rB] **FILE**
-.fi
-.LP
+.EE
+.RE
.PP
\fBcommand\fR \[lB]\fB--foo\fR\[rB] \fBFILE\fP
-.LP
-.nf
-\`\-\-tagged\`
- Text here\.
-.fi
-.LP
+.SS Argument Definitions
+.PP
+.RS 4
+.EX
+*ARG*
+: Description here\.
+.EE
+.RE
.TP
-\fB--tagged\fR
-Text here\.
-.LP
-.SS LINKS
-.LP
-.nf
+\fIARG\fP
+Description here\.
+.SS Option Definitions
+.PP
+.RS 4
+.EX
+\`\-o\`, \`\-\-option\` *VALUE*
+: Description here\.
+.EE
+.RE
+.TP
+\fB-o\fR, \fB--option\fR \fIVALUE\fP
+Description here\.
+.SS Links
+.PP
+.RS 4
+.EX
\[lB]website\[rB](http:\[sl]\[sl]example\.com\[sl])
-.fi
-.LP
+.EE
+.RE
.PP
website
.UR http:\[sl]\[sl]example\.com\[sl]
.UE
-.LP
-.nf
+.SS Man Pages
+.PP
+Link to other man pages in a project:
+.PP
+.RS 4
+.EX
+\[lB]kramdown\-man\[rB](kramdown\-man\.1\.md)
+.EE
+.RE
+.PP
+.BR kramdown\-man (1)
+.PP
+Link to other system man page:
+.PP
+.RS 4
+.EX
\[lB]bash\[rB](man:bash(1))
-.fi
-.LP
+.EE
+.RE
.PP
.BR bash (1)
-.LP
-.nf
+.PP
+\fBNote:\fP only works on firefox
+.UR https:\[sl]\[sl]www\.mozilla\.org\[sl]en\-US\[sl]firefox\[sl]new\[sl]
+.UE
+on Linux\.
+.SS Email Addresses
+.PP
+.RS 4
+.EX
Email <bob\[at]example\.com>
-.fi
-.LP
+.EE
+.RE
.PP
Email
.MT bob\[at]example\.com
.ME
-.LP
-.SS LISTS
-.LP
-.nf
+.SS Lists
+.PP
+.RS 4
+.EX
* one
* two
* three
-
- extra paragraph
-.fi
-.LP
+.EE
+.RE
.RS
.IP \(bu 2
one
.IP \(bu 2
two
.IP \(bu 2
three
-.IP \( 2
-extra paragraph
.RE
-.LP
+.SS Numbered Lists
+.PP
+.RS 4
+.EX
+1\. one
+2\. two
+3\. three
+.EE
+.RE
.nr step1 0 1
.RS
.IP \n+[step1]
one
.IP \n+[step1]
two
.IP \n+[step1]
three
-.IP \n
-extra paragraph
.RE
-.LP
-.SS HORIZONTAL RULE
-.LP
-.nf
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
-.fi
-.LP
-.ti 0
-\l'\n(.lu'
-.LP
-.SS BLOCKQUOTES
-.LP
-.nf
+.SS Definition Lists
+.PP
+.RS 4
+.EX
+ex\[pc]am\[pc]ple
+: a thing characteristic of its kind or illustrating a general rule\.
+
+: a person or thing regarded in terms of their fitness to be imitated or the
+ likelihood of their being imitated\.
+.EE
+.RE
+.TP
+ex\[pc]am\[pc]ple
+a thing characteristic of its kind or illustrating a general rule\.
+.RS
+.PP
+a person or thing regarded in terms of their fitness to be imitated or the
+likelihood of their being imitated\.
+.RE
+.SS Blockquotes
+.PP
+.RS 4
+.EX
> Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away\.
>
> \-\-Antoine de Saint\-Exup\['e]ry
-.fi
-.LP
-.PP
+.EE
+.RE
.RS
+.PP
Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away\.
-.LP
+.PP
\-\-Antoine de Saint\-Exup\['e]ry
.RE
-.LP
-.SS CODE BLOCKS
-.LP
-.nf
+.SS Code Blocks
+.PP
+.RS 4
+.EX
+Source code:
+
\[sh]include <stdio\.h>
int main()
\[lC]
- printf(\[dq]hello world\en\[dq]);
- return 0;
+ printf(\[dq]hello world\en\[dq]);
+ return 0;
\[rC]
-
+.EE
+.RE
+.PP
+Source code:
+.PP
+.RS 4
+.EX
\[sh]include <stdio\.h>
int main()
\[lC]
printf(\[dq]hello world\en\[dq]);
return 0;
\[rC]
-.fi
-.LP
+.EE
+.RE
.SH AUTHOR
-.LP
.PP
Postmodern
.MT postmodern\.mod3\[at]gmail\.com
.ME
-.LP
\ No newline at end of file