md2man 5.0.3 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.markdown +5 -5
- data/VERSION.markdown +24 -0
- data/bin/md2man-html +29 -19
- data/bin/md2man-rake +8 -5
- data/bin/md2man-roff +6 -5
- data/lib/md2man/html.rb +7 -1
- data/lib/md2man/rakefile.rb +15 -3
- data/lib/md2man/version.rb +1 -1
- data/man/index.html +3 -3
- data/man/man0/EXAMPLE.html +1 -1
- data/man/man0/README.html +58 -58
- data/man/man0/VERSION.html +30 -16
- data/man/man1/md2man-html.1 +7 -10
- data/man/man1/md2man-html.1.html +18 -18
- data/man/man1/md2man-rake.1 +9 -6
- data/man/man1/md2man-rake.1.html +6 -6
- data/man/man1/md2man-roff.1 +7 -10
- data/man/man1/md2man-roff.1.html +4 -4
- data/man/man5/md2man.5 +18 -22
- data/man/man5/md2man.5.html +55 -54
- data/man/man5/md2man.5.markdown +13 -13
- data/man/style.css +209 -0
- data/md2man.gemspec +5 -4
- data/test/md2man/html_test.rb +28 -4
- metadata +18 -6
- data/EXAMPLE.png +0 -0
- data/man/man0/EXAMPLE.png +0 -1
data/man/man0/VERSION.html
CHANGED
|
@@ -2,13 +2,27 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man 5.0
|
|
6
|
-
<title>VERSION</title>
|
|
5
|
+
<meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" />
|
|
6
|
+
<title>VERSION — md2man</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/VERSION</span></div></div><div class="container-fluid"><h2 id="version-5-0-
|
|
11
|
-
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/VERSION</span></div></div><div class="container-fluid"><h2 id="version-5-1-0-2016-02-28">Version 5.1.0 (2016-02-28)<a name="version-5-1-0-2016-02-28" href="#version-5-1-0-2016-02-28" class="md2man-permalink" title="permalink"></a></h2><h3 id="minor">Minor:<a name="minor" href="#minor" class="md2man-permalink" title="permalink"></a></h3>
|
|
11
|
+
<ul>
|
|
12
|
+
<li><p><a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>: add syntax highlighting to fenced code blocks.</p></li>
|
|
13
|
+
<li><p><a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>: add directory name to README and "man/index" title.</p><p>Fallback to adding directory name for standalone titles, such as "README"
|
|
14
|
+
and "man/index", so that users know what project those manuals belong to.</p></li>
|
|
15
|
+
<li><p><a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>: allow running task names without namespace.</p><p>You can now run <code>md2man-rake man</code> instead of <code>md2man-rake md2man:man</code>,
|
|
16
|
+
and similarly <code>md2man-rake web</code> instead of <code>md2man-rake md2man:web</code>.</p></li>
|
|
17
|
+
</ul>
|
|
18
|
+
<h3 id="patch">Patch:<a name="patch" href="#patch" class="md2man-permalink" title="permalink"></a></h3>
|
|
19
|
+
<ul>
|
|
20
|
+
<li><p>Clarify optionalness of PATTERN in <code>--help</code> option.</p></li>
|
|
21
|
+
<li><p><a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a>: paragraph types reflect .PP, .TP, .IP.</p></li>
|
|
22
|
+
<li><p>Link to Markdown website instead of <a class="md2man-reference">markdown(7)</a>.</p></li>
|
|
23
|
+
</ul>
|
|
24
|
+
<h2 id="version-5-0-3-2016-02-21">Version 5.0.3 (2016-02-21)<a name="version-5-0-3-2016-02-21" href="#version-5-0-3-2016-02-21" class="md2man-permalink" title="permalink"></a></h2><p>This release fixes a crash, fixes roff bugs, improves CSS styling for HTML
|
|
25
|
+
output, and adds a complete manual page example in <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> documentation.</p><h3 id="patch-1">Patch:<a name="patch-1" href="#patch-1" class="md2man-permalink" title="permalink"></a></h3>
|
|
12
26
|
<ul>
|
|
13
27
|
<li><p>Fix crash upon encountering a sole space <code> </code> or tab <code> </code> in a codespan.</p></li>
|
|
14
28
|
<li><p><a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>: fix sorting of manual pages in <code>man/index.html</code> listing.
|
|
@@ -63,14 +77,14 @@ call <code>super()</code> therein to trigger these methods' original impleme
|
|
|
63
77
|
<li><code>Md2Man::Document#codespan(code)</code></li>
|
|
64
78
|
</ul></li>
|
|
65
79
|
</ul>
|
|
66
|
-
<h2 id="version-3-0-2-2014-10-26">Version 3.0.2 (2014-10-26)<a name="version-3-0-2-2014-10-26" href="#version-3-0-2-2014-10-26" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-
|
|
80
|
+
<h2 id="version-3-0-2-2014-10-26">Version 3.0.2 (2014-10-26)<a name="version-3-0-2-2014-10-26" href="#version-3-0-2-2014-10-26" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-2">Patch:<a name="patch-2" href="#patch-2" class="md2man-permalink" title="permalink"></a></h3>
|
|
67
81
|
<ul>
|
|
68
82
|
<li>Update bootstrap 2.3.2 CDN URL; previous one died.</li>
|
|
69
83
|
</ul>
|
|
70
|
-
<h2 id="version-3-0-1-2014-07-16">Version 3.0.1 (2014-07-16)<a name="version-3-0-1-2014-07-16" href="#version-3-0-1-2014-07-16" class="md2man-permalink" title="permalink"></a></h2><p>This release restores Mac OS X support and fixes a permalink generation bug.</p><h3 id="patch-
|
|
84
|
+
<h2 id="version-3-0-1-2014-07-16">Version 3.0.1 (2014-07-16)<a name="version-3-0-1-2014-07-16" href="#version-3-0-1-2014-07-16" class="md2man-permalink" title="permalink"></a></h2><p>This release restores Mac OS X support and fixes a permalink generation bug.</p><h3 id="patch-3">Patch:<a name="patch-3" href="#patch-3" class="md2man-permalink" title="permalink"></a></h3>
|
|
71
85
|
<ul>
|
|
72
86
|
<li><p>GH-13: <a class="md2man-reference">man(1)</a> on Mac OS X could not display URLs.</p><p>The version of groff on Mac OS X is too old: it lacks the an-ext.tmac
|
|
73
|
-
macro package that defines styles for email addresses and general URLs.</p><pre><code>$ groff --version
|
|
87
|
+
macro package that defines styles for email addresses and general URLs.</p><pre class="highlight plaintext"><code>$ groff --version
|
|
74
88
|
...
|
|
75
89
|
GNU grops (groff) version 1.19.2
|
|
76
90
|
GNU troff (groff) version 1.19.2
|
|
@@ -89,7 +103,7 @@ have for jumping to specific locations in your HTML manuals after upgrading.</p>
|
|
|
89
103
|
<li><p>Make permalink anchors unique by appending a count in <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>.</p></li>
|
|
90
104
|
<li><p>Rename <code>md2man-xref</code> CSS class to <code>md2man-reference</code> in <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>.</p></li>
|
|
91
105
|
</ul>
|
|
92
|
-
<h2 id="version-2-1-1-2014-06-21">Version 2.1.1 (2014-06-21)<a name="version-2-1-1-2014-06-21" href="#version-2-1-1-2014-06-21" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-
|
|
106
|
+
<h2 id="version-2-1-1-2014-06-21">Version 2.1.1 (2014-06-21)<a name="version-2-1-1-2014-06-21" href="#version-2-1-1-2014-06-21" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-4">Patch:<a name="patch-4" href="#patch-4" class="md2man-permalink" title="permalink"></a></h3>
|
|
93
107
|
<ul>
|
|
94
108
|
<li><p>Bootstrap CSS failed to load for HTML manuals served under HTTPS.
|
|
95
109
|
See <a href="https://github.com/sunaku/readably/pull/3">https://github.com/sunaku/readably/pull/3</a> for the details.</p></li>
|
|
@@ -100,17 +114,17 @@ See <a href="https://github.com/sunaku/readably/pull/3">https://github.com/sunak
|
|
|
100
114
|
<li><p>GitHub now supports relative links from the README.</p></li>
|
|
101
115
|
<li><p>README: add links to package, manuals, and GitHub.</p></li>
|
|
102
116
|
</ul>
|
|
103
|
-
<h2 id="version-2-1-0-2014-05-04">Version 2.1.0 (2014-05-04)<a name="version-2-1-0-2014-05-04" href="#version-2-1-0-2014-05-04" class="md2man-permalink" title="permalink"></a></h2><h3 id="minor">Minor:<a name="minor" href="#minor" class="md2man-permalink" title="permalink"></a></h3>
|
|
117
|
+
<h2 id="version-2-1-0-2014-05-04">Version 2.1.0 (2014-05-04)<a name="version-2-1-0-2014-05-04" href="#version-2-1-0-2014-05-04" class="md2man-permalink" title="permalink"></a></h2><h3 id="minor-1">Minor:<a name="minor-1" href="#minor-1" class="md2man-permalink" title="permalink"></a></h3>
|
|
104
118
|
<ul>
|
|
105
119
|
<li><p><a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> now adds anchors and permalinks to all headings. This
|
|
106
120
|
makes it easy for readers to bookmark and share direct links to specific
|
|
107
121
|
sections of your HTML manual pages.</p></li>
|
|
108
122
|
<li><p><a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> now wraps individual components of the special <code>.TH</code>
|
|
109
|
-
top-level heading in HTML <code><span></code> elements with stylable CSS classes:</p><pre><code><span class
|
|
110
|
-
<span class
|
|
111
|
-
<span class
|
|
112
|
-
<span class
|
|
113
|
-
<span class
|
|
123
|
+
top-level heading in HTML <code><span></code> elements with stylable CSS classes:</p><pre class="highlight plaintext"><code><span class="md2man-title">...</span>
|
|
124
|
+
<span class="md2man-section">...</span>
|
|
125
|
+
<span class="md2man-date">...</span>
|
|
126
|
+
<span class="md2man-source">...</span>
|
|
127
|
+
<span class="md2man-manual">...</span>
|
|
114
128
|
</code></pre>
|
|
115
129
|
<p>Thanks to Nick Fagerlund for requesting this feature in <a href="https://github.com/sunaku/md2man/issues/15">GH-15</a>.</p></li>
|
|
116
130
|
</ul>
|
|
@@ -118,7 +132,7 @@ top-level heading in HTML <code><span></code> elements with stylable CSS c
|
|
|
118
132
|
<ul>
|
|
119
133
|
<li><p><a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> now documents the special <code>.TH</code> format of top-level headings.</p><p>Thanks to Nick Fagerlund for requesting this documentation in <a href="https://github.com/sunaku/md2man/issues/15">GH-15</a>.</p></li>
|
|
120
134
|
</ul>
|
|
121
|
-
<h2 id="version-2-0-4-2014-04-26">Version 2.0.4 (2014-04-26)<a name="version-2-0-4-2014-04-26" href="#version-2-0-4-2014-04-26" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-
|
|
135
|
+
<h2 id="version-2-0-4-2014-04-26">Version 2.0.4 (2014-04-26)<a name="version-2-0-4-2014-04-26" href="#version-2-0-4-2014-04-26" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-5">Patch:<a name="patch-5" href="#patch-5" class="md2man-permalink" title="permalink"></a></h3>
|
|
122
136
|
<ul>
|
|
123
137
|
<li><p>GH-16: Redcarpet 3.1 added a third parameter to its <code>header()</code> method.
|
|
124
138
|
This raised an ArgumentError on "wrong number of arguments (3 for 2)".</p><p>Thanks to zimbatm for contributing this patch.</p></li>
|
|
@@ -126,7 +140,7 @@ This raised an ArgumentError on "wrong number of arguments (3 for 2)".
|
|
|
126
140
|
This fixes a bug where lines beginning with periods or single quotes
|
|
127
141
|
did not appear when <a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a> output was rendered using <a class="md2man-reference">man(1)</a>.</p><p>Thanks to zimbatm for reporting this bug and suggesting how to fix it.</p></li>
|
|
128
142
|
</ul>
|
|
129
|
-
<h2 id="version-2-0-3-2014-01-16">Version 2.0.3 (2014-01-16)<a name="version-2-0-3-2014-01-16" href="#version-2-0-3-2014-01-16" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-
|
|
143
|
+
<h2 id="version-2-0-3-2014-01-16">Version 2.0.3 (2014-01-16)<a name="version-2-0-3-2014-01-16" href="#version-2-0-3-2014-01-16" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-6">Patch:<a name="patch-6" href="#patch-6" class="md2man-permalink" title="permalink"></a></h3>
|
|
130
144
|
<ul>
|
|
131
145
|
<li><p>Use CSS3 <code>-ch</code> suffix for accurate 80-character width in HTML output.</p><p><a href="http://www.w3.org/TR/css3-values/#font-relative-lengths">http://www.w3.org/TR/css3-values/#font-relative-lengths</a></p></li>
|
|
132
146
|
</ul>
|
data/man/man1/md2man-html.1
CHANGED
|
@@ -1,21 +1,17 @@
|
|
|
1
|
-
.TH MD2MAN\-HTML 1 2016\-02\-
|
|
1
|
+
.TH MD2MAN\-HTML 1 2016\-02\-28 5.1.0
|
|
2
2
|
.SH NAME
|
|
3
3
|
.PP
|
|
4
4
|
md2man\-html \- convert
|
|
5
5
|
.BR md2man (5)
|
|
6
|
-
flavored
|
|
7
|
-
.BR markdown (7)
|
|
8
|
-
into HTML
|
|
6
|
+
flavored Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] text into HTML
|
|
9
7
|
.SH SYNOPSIS
|
|
10
8
|
.PP
|
|
11
9
|
\fB\fCmd2man\-html\fR [\fIOPTION\fP]... [\fIFILE\fP]
|
|
12
10
|
.SH DESCRIPTION
|
|
13
11
|
.PP
|
|
14
|
-
This program converts
|
|
12
|
+
This program converts the
|
|
15
13
|
.BR md2man (5)
|
|
16
|
-
flavored
|
|
17
|
-
.BR markdown (7)
|
|
18
|
-
input from the given
|
|
14
|
+
flavored Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] text from the given
|
|
19
15
|
\fIFILE\fP into HTML and then prints the result to the standard output stream.
|
|
20
16
|
If \fIFILE\fP is not given, then the standard input stream is read in its place.
|
|
21
17
|
.SS Top\-level headings
|
|
@@ -81,9 +77,10 @@ For example, the \fB\fCprintf(3)\fR cross reference would be emitted as this HTM
|
|
|
81
77
|
.SH OPTIONS
|
|
82
78
|
.TP
|
|
83
79
|
\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
|
|
84
|
-
Show this help manual and search for \fIPATTERN\fP regular expression
|
|
80
|
+
Show this help manual and optionally search for \fIPATTERN\fP regular expression.
|
|
85
81
|
.SH SEE ALSO
|
|
86
82
|
.PP
|
|
87
83
|
.BR md2man-roff (1),
|
|
88
84
|
.BR md2man-rake (1),
|
|
89
|
-
.BR md2man (5)
|
|
85
|
+
.BR md2man (5),
|
|
86
|
+
Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra]
|
data/man/man1/md2man-html.1.html
CHANGED
|
@@ -2,37 +2,37 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man 5.0
|
|
6
|
-
<title>md2man-html(1) — convert md2man(5) flavored
|
|
5
|
+
<meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" />
|
|
6
|
+
<title>md2man-html(1) — convert md2man(5) flavored Markdown text into HTML</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-html.1</span></div></div><div class="container-fluid"><h1 id="md2man-html-1-2016-02-
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-html.1</span></div></div><div class="container-fluid"><h1 id="md2man-html-1-2016-02-28-5-1-0"><span class="md2man-title">MD2MAN-HTML</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-28</span> <span class="md2man-source">5.1.0</span><a name="md2man-html-1-2016-02-28-5-1-0" href="#md2man-html-1-2016-02-28-5-1-0" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man-html - convert <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> text into HTML</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>md2man-html</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program converts the <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> text from the given
|
|
11
11
|
<em>FILE</em> into HTML and then prints the result to the standard output stream.
|
|
12
12
|
If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="top-level-headings">Top-level headings<a name="top-level-headings" href="#top-level-headings" class="md2man-permalink" title="permalink"></a></h3><p>Each component of the <code>.TH</code> directive in <a class="md2man-reference">roff(7)</a>, described under "Top-level
|
|
13
|
-
headings" in <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a>, is wrapped in stylable <code><span></code> elements as follows:</p><pre><code><span class
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
13
|
+
headings" in <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a>, is wrapped in stylable <code><span></code> elements as follows:</p><pre class="highlight html"><code><span class="nt"><span</span> <span class="na">class=</span><span class="s">"md2man-title"</span><span class="nt">></span>...<span class="nt"></span></span>
|
|
14
|
+
<span class="nt"><span</span> <span class="na">class=</span><span class="s">"md2man-section"</span><span class="nt">></span>...<span class="nt"></span></span>
|
|
15
|
+
<span class="nt"><span</span> <span class="na">class=</span><span class="s">"md2man-date"</span><span class="nt">></span>...<span class="nt"></span></span>
|
|
16
|
+
<span class="nt"><span</span> <span class="na">class=</span><span class="s">"md2man-source"</span><span class="nt">></span>...<span class="nt"></span></span>
|
|
17
|
+
<span class="nt"><span</span> <span class="na">class=</span><span class="s">"md2man-manual"</span><span class="nt">></span>...<span class="nt"></span></span>
|
|
18
18
|
</code></pre>
|
|
19
19
|
<h3 id="heading-permalinks">Heading permalinks<a name="heading-permalinks" href="#heading-permalinks" class="md2man-permalink" title="permalink"></a></h3><p>Self-referencing hyperlinks (for permanent linking) are added to headings by
|
|
20
20
|
converting their labels into URI fragments that are unique (using a counter),
|
|
21
|
-
lowercase, and squeezed and stripped of HTML tags and non-word characters.</p><p>For example, a heading labeled <code>Ver<s>iON 3(2</s>!4)))</code> would be emitted as:</p><pre><code><h2 id
|
|
22
|
-
href
|
|
21
|
+
lowercase, and squeezed and stripped of HTML tags and non-word characters.</p><p>For example, a heading labeled <code>Ver<s>iON 3(2</s>!4)))</code> would be emitted as:</p><pre class="highlight html"><code><span class="nt"><h2</span> <span class="na">id=</span><span class="s">"ver-ion-3-2-4"</span><span class="nt">></span>Ver<span class="nt"><s></span>iON 3(2<span class="nt"></s></span>!4)))<span class="nt"><a</span> <span class="na">name=</span><span class="s">"ver-ion-3-2-4"</span>
|
|
22
|
+
<span class="na">href=</span><span class="s">"#ver-ion-3-2-4"</span> <span class="na">class=</span><span class="s">"md2man-permalink"</span> <span class="na">title=</span><span class="s">"permalink"</span><span class="nt">></a></h2></span>
|
|
23
23
|
</code></pre>
|
|
24
|
-
<p>For example, multiple headings labeled <code>Hello, world!</code> would be emitted as:</p><pre><code><h2 id
|
|
25
|
-
href
|
|
24
|
+
<p>For example, multiple headings labeled <code>Hello, world!</code> would be emitted as:</p><pre class="highlight html"><code><span class="nt"><h2</span> <span class="na">id=</span><span class="s">"hello-world"</span><span class="nt">></span>Hello, world!<span class="nt"><a</span> <span class="na">name=</span><span class="s">"hello-world"</span>
|
|
25
|
+
<span class="na">href=</span><span class="s">"#hello-world"</span> <span class="na">class=</span><span class="s">"md2man-permalink"</span> <span class="na">title=</span><span class="s">"permalink"</span><span class="nt">></a></h2></span>
|
|
26
26
|
|
|
27
|
-
|
|
28
|
-
href
|
|
27
|
+
<span class="nt"><h2</span> <span class="na">id=</span><span class="s">"hello-world-1"</span><span class="nt">></span>Hello, world!<span class="nt"><a</span> <span class="na">name=</span><span class="s">"hello-world-1"</span>
|
|
28
|
+
<span class="na">href=</span><span class="s">"#hello-world-1"</span> <span class="na">class=</span><span class="s">"md2man-permalink"</span> <span class="na">title=</span><span class="s">"permalink"</span><span class="nt">></a></h2></span>
|
|
29
29
|
|
|
30
|
-
|
|
31
|
-
href
|
|
30
|
+
<span class="nt"><h2</span> <span class="na">id=</span><span class="s">"hello-world-2"</span><span class="nt">></span>Hello, world!<span class="nt"><a</span> <span class="na">name=</span><span class="s">"hello-world-2"</span>
|
|
31
|
+
<span class="na">href=</span><span class="s">"#hello-world-2"</span> <span class="na">class=</span><span class="s">"md2man-permalink"</span> <span class="na">title=</span><span class="s">"permalink"</span><span class="nt">></a></h2></span>
|
|
32
32
|
</code></pre>
|
|
33
33
|
<h3 id="cross-references">Cross references<a name="cross-references" href="#cross-references" class="md2man-permalink" title="permalink"></a></h3><p>Cross references to manual pages are emitted as HTML hyperlinks that have
|
|
34
34
|
<code>class="md2man-reference"</code> and <code>href="../man$SECTION/$PAGE.$SECTION.html"</code>
|
|
35
|
-
attributes.</p><p>For example, the <code>printf(3)</code> cross reference would be emitted as this HTML:</p><pre><code><a class
|
|
35
|
+
attributes.</p><p>For example, the <code>printf(3)</code> cross reference would be emitted as this HTML:</p><pre class="highlight html"><code><span class="nt"><a</span> <span class="na">class=</span><span class="s">"md2man-reference"</span> <span class="na">href=</span><span class="s">"../man3/printf.3.html"</span><span class="nt">></span>printf(3)<span class="nt"></a></span>
|
|
36
36
|
</code></pre>
|
|
37
|
-
<h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression
|
|
37
|
+
<h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and optionally search for <em>PATTERN</em> regular expression.</dd></dl><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a>, <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a></p></div></body>
|
|
38
38
|
</html>
|
data/man/man1/md2man-rake.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH MD2MAN\-RAKE 1 2016\-02\-
|
|
1
|
+
.TH MD2MAN\-RAKE 1 2016\-02\-28 5.1.0
|
|
2
2
|
.SH NAME
|
|
3
3
|
.PP
|
|
4
4
|
md2man\-rake \- run
|
|
@@ -29,19 +29,22 @@ If no \fITASK\fP is specified, then the \fB\fCmd2man\fR task is run by default.
|
|
|
29
29
|
\fB\fCmd2man\fR
|
|
30
30
|
Runs the \fB\fCmd2man:man\fR and \fB\fCmd2man:web\fR tasks, in that order.
|
|
31
31
|
.TP
|
|
32
|
-
\fB\fCmd2man:man\fR
|
|
32
|
+
\fB\fCmd2man:man\fR or \fB\fCman\fR
|
|
33
33
|
Builds UNIX manual pages from \fB\fC*.markdown\fR, \fB\fC*.mkd\fR, and \fB\fC*.md\fR files
|
|
34
34
|
found in or beneath the \fB\fCman/\fR subdirectory in your working directory.
|
|
35
35
|
.TP
|
|
36
|
-
\fB\fCmd2man:web\fR
|
|
36
|
+
\fB\fCmd2man:web\fR or \fB\fCweb\fR
|
|
37
37
|
Builds HTML manual pages from \fB\fC*.markdown\fR, \fB\fC*.mkd\fR, and \fB\fC*.md\fR files
|
|
38
38
|
found in or beneath the \fB\fCman/\fR subdirectory in your working directory.
|
|
39
39
|
.SH OPTIONS
|
|
40
40
|
.TP
|
|
41
41
|
\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
|
|
42
|
-
Show this help manual and search for \fIPATTERN\fP regular expression
|
|
43
|
-
.
|
|
44
|
-
|
|
42
|
+
Show this help manual and optionally search for \fIPATTERN\fP regular expression.
|
|
43
|
+
.TP
|
|
44
|
+
\&...
|
|
45
|
+
Anything else is passed to
|
|
46
|
+
.BR rake (1);
|
|
47
|
+
run \fB\fCrake \-\-help\fR for documentation.
|
|
45
48
|
.SH SEE ALSO
|
|
46
49
|
.PP
|
|
47
50
|
.BR rake (1),
|
data/man/man1/md2man-rake.1.html
CHANGED
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man 5.0
|
|
5
|
+
<meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>md2man-rake(1) — run rake(1) tasks from md2man(1)</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-rake.1</span></div></div><div class="container-fluid"><h1 id="md2man-rake-1-2016-02-
|
|
11
|
-
to create a special file named <code>Rakefile</code> that contains the following snippet:</p><pre><code>require
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-rake.1</span></div></div><div class="container-fluid"><h1 id="md2man-rake-1-2016-02-28-5-1-0"><span class="md2man-title">MD2MAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-28</span> <span class="md2man-source">5.1.0</span><a name="md2man-rake-1-2016-02-28-5-1-0" href="#md2man-rake-1-2016-02-28-5-1-0" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man-rake - run <a class="md2man-reference">rake(1)</a> tasks from <a class="md2man-reference">md2man(1)</a></p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>md2man-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program lets you run <a class="md2man-reference">rake(1)</a> tasks provided by <a class="md2man-reference">md2man(1)</a> without having
|
|
11
|
+
to create a special file named <code>Rakefile</code> that contains the following snippet:</p><pre class="highlight plaintext"><code>require 'md2man/rakefile'
|
|
12
12
|
</code></pre>
|
|
13
|
-
<p>If no <em>TASK</em> is specified, then the <code>md2man</code> task is run by default.</p><h2 id="tasks">TASKS<a name="tasks" href="#tasks" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>md2man</code></dt><dd>Runs the <code>md2man:man</code> and <code>md2man:web</code> tasks, in that order.</dd></dl><dl><dt><code>md2man:man</code></dt><dd>Builds UNIX manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
|
|
14
|
-
found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><dl><dt><code>md2man:web</code></dt><dd>Builds HTML manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
|
|
15
|
-
found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression
|
|
13
|
+
<p>If no <em>TASK</em> is specified, then the <code>md2man</code> task is run by default.</p><h2 id="tasks">TASKS<a name="tasks" href="#tasks" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>md2man</code></dt><dd>Runs the <code>md2man:man</code> and <code>md2man:web</code> tasks, in that order.</dd></dl><dl><dt><code>md2man:man</code> or <code>man</code></dt><dd>Builds UNIX manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
|
|
14
|
+
found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><dl><dt><code>md2man:web</code> or <code>web</code></dt><dd>Builds HTML manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
|
|
15
|
+
found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and optionally search for <em>PATTERN</em> regular expression.</dd></dl><dl><dt>...</dt><dd>Anything else is passed to <a class="md2man-reference">rake(1)</a>; run <code>rake --help</code> for documentation.</dd></dl><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference">rake(1)</a>, <a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
|
|
16
16
|
</html>
|
data/man/man1/md2man-roff.1
CHANGED
|
@@ -1,22 +1,18 @@
|
|
|
1
|
-
.TH MD2MAN\-ROFF 1 2016\-02\-
|
|
1
|
+
.TH MD2MAN\-ROFF 1 2016\-02\-28 5.1.0
|
|
2
2
|
.SH NAME
|
|
3
3
|
.PP
|
|
4
4
|
md2man\-roff \- convert
|
|
5
5
|
.BR md2man (5)
|
|
6
|
-
flavored
|
|
7
|
-
.BR markdown (7)
|
|
8
|
-
into
|
|
6
|
+
flavored Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] text into
|
|
9
7
|
.BR roff (7)
|
|
10
8
|
.SH SYNOPSIS
|
|
11
9
|
.PP
|
|
12
10
|
\fB\fCmd2man\-roff\fR [\fIOPTION\fP]... [\fIFILE\fP]
|
|
13
11
|
.SH DESCRIPTION
|
|
14
12
|
.PP
|
|
15
|
-
This program converts
|
|
13
|
+
This program converts the
|
|
16
14
|
.BR md2man (5)
|
|
17
|
-
flavored
|
|
18
|
-
.BR markdown (7)
|
|
19
|
-
input from the given
|
|
15
|
+
flavored Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] text from the given
|
|
20
16
|
\fIFILE\fP into
|
|
21
17
|
.BR roff (7)
|
|
22
18
|
and then prints the result to the standard output stream.
|
|
@@ -42,9 +38,10 @@ It issues a warning when it encounters these instead. Patches are welcome!
|
|
|
42
38
|
.SH OPTIONS
|
|
43
39
|
.TP
|
|
44
40
|
\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
|
|
45
|
-
Show this help manual and search for \fIPATTERN\fP regular expression
|
|
41
|
+
Show this help manual and optionally search for \fIPATTERN\fP regular expression.
|
|
46
42
|
.SH SEE ALSO
|
|
47
43
|
.PP
|
|
48
44
|
.BR md2man-html (1),
|
|
49
45
|
.BR md2man-rake (1),
|
|
50
|
-
.BR md2man (5)
|
|
46
|
+
.BR md2man (5),
|
|
47
|
+
Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra]
|
data/man/man1/md2man-roff.1.html
CHANGED
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man 5.0
|
|
6
|
-
<title>md2man-roff(1) — convert md2man(5) flavored
|
|
5
|
+
<meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" />
|
|
6
|
+
<title>md2man-roff(1) — convert md2man(5) flavored Markdown text into roff(7)</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-roff.1</span></div></div><div class="container-fluid"><h1 id="md2man-roff-1-2016-02-
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-roff.1</span></div></div><div class="container-fluid"><h1 id="md2man-roff-1-2016-02-28-5-1-0"><span class="md2man-title">MD2MAN-ROFF</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-28</span> <span class="md2man-source">5.1.0</span><a name="md2man-roff-1-2016-02-28-5-1-0" href="#md2man-roff-1-2016-02-28-5-1-0" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man-roff - convert <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> text into <a class="md2man-reference">roff(7)</a></p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>md2man-roff</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program converts the <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> text from the given
|
|
11
11
|
<em>FILE</em> into <a class="md2man-reference">roff(7)</a> and then prints the result to the standard output stream.
|
|
12
12
|
If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="limitations">Limitations<a name="limitations" href="#limitations" class="md2man-permalink" title="permalink"></a></h3><p>This program does not convert the following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> nodes into <a class="md2man-reference">roff(7)</a>:</p>
|
|
13
13
|
<ul>
|
|
@@ -17,5 +17,5 @@ If <em>FILE</em> is not given, then the standard input stream is read in its pla
|
|
|
17
17
|
<li><code>image</code></li>
|
|
18
18
|
<li><code>raw_html</code></li>
|
|
19
19
|
</ul>
|
|
20
|
-
<p>It issues a warning when it encounters these instead. Patches are welcome!</p><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression
|
|
20
|
+
<p>It issues a warning when it encounters these instead. Patches are welcome!</p><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and optionally search for <em>PATTERN</em> regular expression.</dd></dl><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a>, <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a></p></div></body>
|
|
21
21
|
</html>
|
data/man/man5/md2man.5
CHANGED
|
@@ -1,24 +1,21 @@
|
|
|
1
|
-
.TH MD2MAN 5 2016\-02\-
|
|
1
|
+
.TH MD2MAN 5 2016\-02\-28 5.1.0
|
|
2
2
|
.SH NAME
|
|
3
3
|
.PP
|
|
4
|
-
md2man \- UNIX manual page flavoring for
|
|
5
|
-
.BR markdown (7)
|
|
6
|
-
file format
|
|
4
|
+
md2man \- UNIX manual page flavoring for Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra]
|
|
7
5
|
.SH DESCRIPTION
|
|
8
6
|
.PP
|
|
9
|
-
md2man \[la]
|
|
10
|
-
.BR markdown (7)
|
|
11
|
-
file format friendly for writing UNIX manual
|
|
7
|
+
md2man makes the Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] format more friendly for writing UNIX manual
|
|
12
8
|
pages by extending its syntax, semantics, and assumed processing extensions.
|
|
13
9
|
.SS Syntax
|
|
14
10
|
.PP
|
|
15
|
-
md2man extends
|
|
16
|
-
|
|
17
|
-
|
|
11
|
+
md2man extends Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] syntax by recognizing three kinds of paragraphs,
|
|
12
|
+
analogous to the underlying \fB\fC\&.PP\fR, \fB\fC\&.TP\fR, and \fB\fC\&.IP\fR directives in
|
|
13
|
+
.BR roff (7).
|
|
18
14
|
.SS Normal paragraphs
|
|
19
15
|
.PP
|
|
20
16
|
Paragraphs whose lines are all indented by exactly zero or one additional
|
|
21
|
-
|
|
17
|
+
space are considered "normal paragraphs", analogous to \fB\fC\&.PP\fR in
|
|
18
|
+
.BR roff (7):
|
|
22
19
|
.PP
|
|
23
20
|
.RS
|
|
24
21
|
.nf
|
|
@@ -40,8 +37,9 @@ this
|
|
|
40
37
|
.SS Tagged paragraphs
|
|
41
38
|
.PP
|
|
42
39
|
Paragraphs whose first line is indented by less than two additional spaces and
|
|
43
|
-
whose subsequent lines are uniformly indented by exactly two additional
|
|
44
|
-
are considered
|
|
40
|
+
whose subsequent lines are all uniformly indented by exactly two additional
|
|
41
|
+
spaces are considered "tagged paragraphs", analogous to \fB\fC\&.TP\fR in
|
|
42
|
+
.BR roff (7):
|
|
45
43
|
.PP
|
|
46
44
|
.RS
|
|
47
45
|
.nf
|
|
@@ -53,7 +51,8 @@ This is a
|
|
|
53
51
|
.SS Indented paragraphs
|
|
54
52
|
.PP
|
|
55
53
|
Paragraphs whose lines are all uniformly indented by exactly two additional
|
|
56
|
-
spaces are considered
|
|
54
|
+
spaces are considered "indented paragraphs", analogous to \fB\fC\&.IP\fR in
|
|
55
|
+
.BR roff (7):
|
|
57
56
|
.PP
|
|
58
57
|
.RS
|
|
59
58
|
.nf
|
|
@@ -64,9 +63,7 @@ spaces are considered to be "indented paragraphs". For example:
|
|
|
64
63
|
.RE
|
|
65
64
|
.SS Semantics
|
|
66
65
|
.PP
|
|
67
|
-
md2man extends
|
|
68
|
-
.BR markdown (7)
|
|
69
|
-
semantics by treating top\-level headings specially.
|
|
66
|
+
md2man extends Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] semantics by treating top\-level headings specially.
|
|
70
67
|
.SS Top\-level headings
|
|
71
68
|
.PP
|
|
72
69
|
The first top\-level \fB\fC<h1>\fR heading found in the input is considered to be the
|
|
@@ -102,8 +99,7 @@ The title of the manual (e.g., \fB\fCLinux Programmer's Manual\fR).
|
|
|
102
99
|
Any subsequent top\-level headings are treated as second\-level \fB\fC<h2>\fR headings.
|
|
103
100
|
.SS Extensions
|
|
104
101
|
.PP
|
|
105
|
-
md2man enables the following Redcarpet \[la]
|
|
106
|
-
.BR markdown (7):
|
|
102
|
+
md2man enables the following [Redcarpet] extensions while reading Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra]:
|
|
107
103
|
.RS
|
|
108
104
|
.IP \(bu 2
|
|
109
105
|
tables
|
|
@@ -216,8 +212,8 @@ http://www.schweikhardt.net/man_page_howto.html)
|
|
|
216
212
|
.RE
|
|
217
213
|
.SH SEE ALSO
|
|
218
214
|
.PP
|
|
219
|
-
.
|
|
215
|
+
Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra],
|
|
220
216
|
.BR man-pages (7),
|
|
217
|
+
.BR roff (7),
|
|
221
218
|
.BR md2man-roff (1),
|
|
222
|
-
.BR md2man-html (1)
|
|
223
|
-
.BR md2man-rake (1)
|
|
219
|
+
.BR md2man-html (1)
|
data/man/man5/md2man.5.html
CHANGED
|
@@ -2,14 +2,15 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man 5.0
|
|
6
|
-
<title>md2man(5) — UNIX manual page flavoring for
|
|
5
|
+
<meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" />
|
|
6
|
+
<title>md2man(5) — UNIX manual page flavoring for Markdown</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man5">man5</a>/md2man.5</span></div></div><div class="container-fluid"><h1 id="md2man-5-2016-02-
|
|
11
|
-
pages by extending its syntax, semantics, and assumed processing extensions.</p><h3 id="syntax">Syntax<a name="syntax" href="#syntax" class="md2man-permalink" title="permalink"></a></h3><p>md2man extends <a
|
|
12
|
-
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man5">man5</a>/md2man.5</span></div></div><div class="container-fluid"><h1 id="md2man-5-2016-02-28-5-1-0"><span class="md2man-title">MD2MAN</span> <span class="md2man-section">5</span> <span class="md2man-date">2016-02-28</span> <span class="md2man-source">5.1.0</span><a name="md2man-5-2016-02-28-5-1-0" href="#md2man-5-2016-02-28-5-1-0" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man - UNIX manual page flavoring for <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a></p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>md2man makes the <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> format more friendly for writing UNIX manual
|
|
11
|
+
pages by extending its syntax, semantics, and assumed processing extensions.</p><h3 id="syntax">Syntax<a name="syntax" href="#syntax" class="md2man-permalink" title="permalink"></a></h3><p>md2man extends <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> syntax by recognizing three kinds of paragraphs,
|
|
12
|
+
analogous to the underlying <code>.PP</code>, <code>.TP</code>, and <code>.IP</code> directives in <a class="md2man-reference">roff(7)</a>.</p><h4 id="normal-paragraphs">Normal paragraphs<a name="normal-paragraphs" href="#normal-paragraphs" class="md2man-permalink" title="permalink"></a></h4><p>Paragraphs whose lines are all indented by exactly zero or one additional
|
|
13
|
+
space are considered "normal paragraphs", analogous to <code>.PP</code> in <a class="md2man-reference">roff(7)</a>:</p><pre class="highlight plaintext"><code>This is a normal paragraph.
|
|
13
14
|
|
|
14
15
|
This is also
|
|
15
16
|
a normal
|
|
@@ -24,23 +25,23 @@ this
|
|
|
24
25
|
too.
|
|
25
26
|
</code></pre>
|
|
26
27
|
<h4 id="tagged-paragraphs">Tagged paragraphs<a name="tagged-paragraphs" href="#tagged-paragraphs" class="md2man-permalink" title="permalink"></a></h4><p>Paragraphs whose first line is indented by less than two additional spaces and
|
|
27
|
-
whose subsequent lines are uniformly indented by exactly two additional
|
|
28
|
-
are considered
|
|
28
|
+
whose subsequent lines are all uniformly indented by exactly two additional
|
|
29
|
+
spaces are considered "tagged paragraphs", analogous to <code>.TP</code> in <a class="md2man-reference">roff(7)</a>:</p><pre class="highlight plaintext"><code>This is a
|
|
29
30
|
tagged
|
|
30
31
|
paragraph.
|
|
31
32
|
</code></pre>
|
|
32
33
|
<h4 id="indented-paragraphs">Indented paragraphs<a name="indented-paragraphs" href="#indented-paragraphs" class="md2man-permalink" title="permalink"></a></h4><p>Paragraphs whose lines are all uniformly indented by exactly two additional
|
|
33
|
-
spaces are considered
|
|
34
|
+
spaces are considered "indented paragraphs", analogous to <code>.IP</code> in <a class="md2man-reference">roff(7)</a>:</p><pre class="highlight plaintext"><code> This is an
|
|
34
35
|
indented
|
|
35
36
|
paragraph.
|
|
36
37
|
</code></pre>
|
|
37
|
-
<h3 id="semantics">Semantics<a name="semantics" href="#semantics" class="md2man-permalink" title="permalink"></a></h3><p>md2man extends <a
|
|
38
|
+
<h3 id="semantics">Semantics<a name="semantics" href="#semantics" class="md2man-permalink" title="permalink"></a></h3><p>md2man extends <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> semantics by treating top-level headings specially.</p><h4 id="top-level-headings">Top-level headings<a name="top-level-headings" href="#top-level-headings" class="md2man-permalink" title="permalink"></a></h4><p>The first top-level <code><h1></code> heading found in the input is considered to be the
|
|
38
39
|
<code>.TH</code> directive in <a class="md2man-reference">roff(7)</a>, described under "Title line" in <a class="md2man-reference">man-pages(7)</a> thus:</p>
|
|
39
40
|
<blockquote>
|
|
40
|
-
<pre><code>.TH title section date source manual
|
|
41
|
+
<pre class="highlight plaintext"><code>.TH title section date source manual
|
|
41
42
|
</code></pre>
|
|
42
43
|
<dl><dt>title</dt><dd>The title of the man page, written in all caps (e.g., <code>MAN-PAGES</code>).</dd></dl><dl><dt>section</dt><dd>The section number in which the man page should be placed (e.g., <code>7</code>).</dd></dl><dl><dt>date</dt><dd>The date of the last revision, written in the form YYYY-MM-DD.</dd></dl><dl><dt>source</dt><dd>The source of the command, function, or system call (e.g., <code>Linux</code>).</dd></dl><dl><dt>manual</dt><dd>The title of the manual (e.g., <code>Linux Programmer's Manual</code>).</dd></dl></blockquote>
|
|
43
|
-
<p>Any subsequent top-level headings are treated as second-level <code><h2></code> headings.</p><h3 id="extensions">Extensions<a name="extensions" href="#extensions" class="md2man-permalink" title="permalink"></a></h3><p>md2man enables the following
|
|
44
|
+
<p>Any subsequent top-level headings are treated as second-level <code><h2></code> headings.</p><h3 id="extensions">Extensions<a name="extensions" href="#extensions" class="md2man-permalink" title="permalink"></a></h3><p>md2man enables the following [Redcarpet] extensions while reading <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a>:</p>
|
|
44
45
|
<ul>
|
|
45
46
|
<li>tables</li>
|
|
46
47
|
<li>autolink</li>
|
|
@@ -51,89 +52,89 @@ spaces are considered to be "indented paragraphs". For example:</p><p
|
|
|
51
52
|
<h3 id="examples">Examples<a name="examples" href="#examples" class="md2man-permalink" title="permalink"></a></h3><p>Below is a complete example of an <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> formatted manual page adapted from
|
|
52
53
|
the <a href="http://www.schweikhardt.net/man_page_howto.html">Linux Man Page Howto</a>
|
|
53
54
|
guide by Jens Schweikhardt. <a href="../man0/EXAMPLE.html">The result of processing</a>
|
|
54
|
-
this example with <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> has been bundled along with this manual page.</p><pre><code>FOO 1
|
|
55
|
+
this example with <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> has been bundled along with this manual page.</p><pre class="highlight markdown"><code><span class="gu">FOO 1 "MARCH 1995" Linux "User Manuals"
|
|
55
56
|
=======================================
|
|
56
|
-
|
|
57
|
-
NAME
|
|
57
|
+
</span>
|
|
58
|
+
<span class="gh">NAME
|
|
58
59
|
----
|
|
59
|
-
|
|
60
|
+
</span>
|
|
60
61
|
foo - frobnicate the bar library
|
|
61
62
|
|
|
62
|
-
SYNOPSIS
|
|
63
|
+
<span class="gh">SYNOPSIS
|
|
63
64
|
--------
|
|
65
|
+
</span>
|
|
66
|
+
<span class="sb">`foo` [`-bar`] [`-c`</span> <span class="ge">*config-file*</span>] <span class="ge">*file*</span> ...
|
|
64
67
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
DESCRIPTION
|
|
68
|
+
<span class="gh">DESCRIPTION
|
|
68
69
|
-----------
|
|
69
|
-
|
|
70
|
-
|
|
70
|
+
</span>
|
|
71
|
+
<span class="sb">`foo`</span> frobnicates the bar library by tweaking internal symbol tables. By
|
|
71
72
|
default it parses all baz segments and rearranges them in reverse order by
|
|
72
73
|
time for the xyzzy(1) linker to find them. The symdef entry is then compressed
|
|
73
74
|
using the WBG (Whiz-Bang-Gizmo) algorithm. All files are processed in the
|
|
74
75
|
order specified.
|
|
75
76
|
|
|
76
|
-
OPTIONS
|
|
77
|
+
<span class="gh">OPTIONS
|
|
77
78
|
-------
|
|
79
|
+
</span>
|
|
80
|
+
<span class="sb">`-b`</span>
|
|
81
|
+
Do not write "busy" to stdout while processing.
|
|
78
82
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
`-c` *config-file*
|
|
83
|
-
Use the alternate system wide *config-file* instead of */etc/foo.conf*. This
|
|
84
|
-
overrides any `FOOCONF` environment variable.
|
|
83
|
+
<span class="sb">`-c`</span> <span class="ge">*config-file*</span>
|
|
84
|
+
Use the alternate system wide <span class="ge">*config-file*</span> instead of <span class="ge">*/etc/foo.conf*</span>. This
|
|
85
|
+
overrides any <span class="sb">`FOOCONF`</span> environment variable.
|
|
85
86
|
|
|
86
|
-
|
|
87
|
+
<span class="sb">`-a`</span>
|
|
87
88
|
In addition to the baz segments, also parse the blurfl headers.
|
|
88
89
|
|
|
89
|
-
|
|
90
|
+
<span class="sb">`-r`</span>
|
|
90
91
|
Recursive mode. Operates as fast as lightning at the expense of a megabyte
|
|
91
92
|
of virtual memory.
|
|
92
93
|
|
|
93
|
-
FILES
|
|
94
|
+
<span class="gh">FILES
|
|
94
95
|
-----
|
|
95
|
-
|
|
96
|
-
|
|
96
|
+
</span>
|
|
97
|
+
<span class="ge">*/etc/foo.conf*</span>
|
|
97
98
|
The system wide configuration file. See foo(5) for further details.
|
|
98
99
|
|
|
99
|
-
|
|
100
|
+
<span class="ge">*~/.foorc*</span>
|
|
100
101
|
Per user configuration file. See foo(5) for further details.
|
|
101
102
|
|
|
102
|
-
ENVIRONMENT
|
|
103
|
+
<span class="gh">ENVIRONMENT
|
|
103
104
|
-----------
|
|
105
|
+
</span>
|
|
106
|
+
<span class="sb">`FOOCONF`</span>
|
|
107
|
+
If non-null the full pathname for an alternate system wide <span class="ge">*/etc/foo.conf*</span>.
|
|
108
|
+
Overridden by the <span class="sb">`-c`</span> option.
|
|
104
109
|
|
|
105
|
-
|
|
106
|
-
If non-null the full pathname for an alternate system wide */etc/foo.conf*.
|
|
107
|
-
Overridden by the `-c` option.
|
|
108
|
-
|
|
109
|
-
DIAGNOSTICS
|
|
110
|
+
<span class="gh">DIAGNOSTICS
|
|
110
111
|
-----------
|
|
111
|
-
|
|
112
|
+
</span>
|
|
112
113
|
The following diagnostics may be issued on stderr:
|
|
113
114
|
|
|
114
|
-
|
|
115
|
+
<span class="gs">**Bad magic number.**</span>
|
|
115
116
|
The input file does not look like an archive file.
|
|
116
117
|
|
|
117
|
-
|
|
118
|
-
|
|
118
|
+
<span class="gs">**Old style baz segments.**</span>
|
|
119
|
+
<span class="sb">`foo`</span> can only handle new style baz segments. COBOL object libraries are not
|
|
119
120
|
supported in this version.
|
|
120
121
|
|
|
121
|
-
BUGS
|
|
122
|
+
<span class="gh">BUGS
|
|
122
123
|
----
|
|
123
|
-
|
|
124
|
+
</span>
|
|
124
125
|
The command name should have been chosen more carefully to reflect its
|
|
125
126
|
purpose.
|
|
126
127
|
|
|
127
|
-
AUTHOR
|
|
128
|
+
<span class="gh">AUTHOR
|
|
128
129
|
------
|
|
130
|
+
</span>
|
|
131
|
+
Jens Schweikhardt <span class="nv"><howto@schweikhardt.net></span>
|
|
129
132
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
SEE ALSO
|
|
133
|
+
<span class="gh">SEE ALSO
|
|
133
134
|
--------
|
|
134
|
-
|
|
135
|
-
bar(1), foo(5), xyzzy(1), [Linux Man Page Howto](
|
|
136
|
-
http://www.schweikhardt.net/man_page_howto.html)
|
|
135
|
+
</span>
|
|
136
|
+
bar(1), foo(5), xyzzy(1), <span class="p">[</span><span class="nv">Linux Man Page Howto</span><span class="p">](</span>
|
|
137
|
+
<span class="sx">http://www.schweikhardt.net/man_page_howto.html</span><span class="p">)</span>
|
|
137
138
|
</code></pre>
|
|
138
|
-
<h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a
|
|
139
|
+
<h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a>, <a class="md2man-reference">man-pages(7)</a>, <a class="md2man-reference">roff(7)</a>, <a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a></p></div></body>
|
|
139
140
|
</html>
|