.\" Generated by kramdown-man 1.0.0
.\" https://github.com/postmodern/kramdown-man#readme
.TH kramdown-man 1 "April 2013" kramdown-man "User Manuals"
.SH SYNOPSIS
.PP
\fBkramdown-man\fR \[lB]\fIoptions\fP\[rB] \fIMARKDOWN\[ru]FILE\fP
.SH DESCRIPTION
.PP
A Kramdown
.UR http:\[sl]\[sl]kramdown\.gettalong\.org\[sl]
.UE
plugin for converting Markdown files into man pages\.
.SH ARGUMENTS
.TP
\fIMARKDOWN\[ru]FILE\fP
The input markdown file to convert\.
.SH OPTIONS
.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\.
.SH EXAMPLE
.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
.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
.SS Code
.PP
.RS 4
.EX
\`code\`
.EE
.RE
.PP
\fBcode\fR
.SS Emphasis
.PP
.RS 4
.EX
*emphasis*
.EE
.RE
.PP
\fIemphasis\fP
.SS Strong
.PP
.RS 4
.EX
**strong**
.EE
.RE
.PP
\fBstrong\fP
.SS Paragraph
.PP
.RS 4
.EX
Normal paragraph\.
.EE
.RE
.PP
Normal paragraph\.
.SS Usage String
.PP
.RS 4
.EX
\`command\` \[lB]\`\-\-foo\`\[rB] **FILE**
.EE
.RE
.PP
\fBcommand\fR \[lB]\fB--foo\fR\[rB] \fBFILE\fP
.SS Argument Definitions
.PP
.RS 4
.EX
*ARG*
: Description here\.
.EE
.RE
.TP
\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])
.EE
.RE
.PP
website
.UR http:\[sl]\[sl]example\.com\[sl]
.UE
.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))
.EE
.RE
.PP
.BR bash (1)
.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>
.EE
.RE
.PP
Email 
.MT bob\[at]example\.com
.ME
.SS Lists
.PP
.RS 4
.EX
* one
* two
* three
.EE
.RE
.RS
.IP \(bu 2
one
.IP \(bu 2
two
.IP \(bu 2
three
.RE
.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
.RE
.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
.EE
.RE
.RS
.PP
Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away\.
.PP
\-\-Antoine de Saint\-Exup\['e]ry
.RE
.SS Code Blocks
.PP
.RS 4
.EX
Source code:

    \[sh]include <stdio\.h>

    int main()
    \[lC]
        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]
.EE
.RE
.SH AUTHOR
.PP
Postmodern 
.MT postmodern\.mod3\[at]gmail\.com
.ME