binman 5.0.1 → 5.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,140 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" />
6
+ <title>md2man(5) &mdash; UNIX manual page flavoring for Markdown</title>
7
+ <link rel="stylesheet" href="../style.css"/>
8
+ <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
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-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 &quot;normal paragraphs&quot;, analogous to <code>.PP</code> in <a class="md2man-reference">roff(7)</a>:</p><pre class="highlight plaintext"><code>This is a normal paragraph.
14
+
15
+ This is also
16
+ a normal
17
+ paragraph.
18
+
19
+ And
20
+ this
21
+ is
22
+ a
23
+ normal
24
+ paragraph
25
+ too.
26
+ </code></pre>
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
28
+ whose subsequent lines are all uniformly indented by exactly two additional
29
+ spaces are considered &quot;tagged paragraphs&quot;, analogous to <code>.TP</code> in <a class="md2man-reference">roff(7)</a>:</p><pre class="highlight plaintext"><code>This is a
30
+ tagged
31
+ paragraph.
32
+ </code></pre>
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
34
+ spaces are considered &quot;indented paragraphs&quot;, analogous to <code>.IP</code> in <a class="md2man-reference">roff(7)</a>:</p><pre class="highlight plaintext"><code> This is an
35
+ indented
36
+ paragraph.
37
+ </code></pre>
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>&lt;h1&gt;</code> heading found in the input is considered to be the
39
+ <code>.TH</code> directive in <a class="md2man-reference">roff(7)</a>, described under &quot;Title line&quot; in <a class="md2man-reference">man-pages(7)</a> thus:</p>
40
+ <blockquote>
41
+ <pre class="highlight plaintext"><code>.TH title section date source manual
42
+ </code></pre>
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&#39;s Manual</code>).</dd></dl></blockquote>
44
+ <p>Any subsequent top-level headings are treated as second-level <code>&lt;h2&gt;</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>
45
+ <ul>
46
+ <li>tables</li>
47
+ <li>autolink</li>
48
+ <li>superscript</li>
49
+ <li>strikethrough</li>
50
+ <li>fenced_code_blocks</li>
51
+ </ul>
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
53
+ the <a href="http://www.schweikhardt.net/man_page_howto.html">Linux Man Page Howto</a>
54
+ guide by Jens Schweikhardt. <a href="../man0/EXAMPLE.html">The result of processing</a>
55
+ this example with <a class="md2man-reference">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"
56
+ =======================================
57
+ </span>
58
+ <span class="gh">NAME
59
+ ----
60
+ </span>
61
+ foo - frobnicate the bar library
62
+
63
+ <span class="gh">SYNOPSIS
64
+ --------
65
+ </span>
66
+ <span class="sb">`foo` [`-bar`] [`-c`</span> <span class="ge">*config-file*</span>] <span class="ge">*file*</span> ...
67
+
68
+ <span class="gh">DESCRIPTION
69
+ -----------
70
+ </span>
71
+ <span class="sb">`foo`</span> frobnicates the bar library by tweaking internal symbol tables. By
72
+ default it parses all baz segments and rearranges them in reverse order by
73
+ time for the xyzzy(1) linker to find them. The symdef entry is then compressed
74
+ using the WBG (Whiz-Bang-Gizmo) algorithm. All files are processed in the
75
+ order specified.
76
+
77
+ <span class="gh">OPTIONS
78
+ -------
79
+ </span>
80
+ <span class="sb">`-b`</span>
81
+ Do not write "busy" to stdout while processing.
82
+
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.
86
+
87
+ <span class="sb">`-a`</span>
88
+ In addition to the baz segments, also parse the blurfl headers.
89
+
90
+ <span class="sb">`-r`</span>
91
+ Recursive mode. Operates as fast as lightning at the expense of a megabyte
92
+ of virtual memory.
93
+
94
+ <span class="gh">FILES
95
+ -----
96
+ </span>
97
+ <span class="ge">*/etc/foo.conf*</span>
98
+ The system wide configuration file. See foo(5) for further details.
99
+
100
+ <span class="ge">*~/.foorc*</span>
101
+ Per user configuration file. See foo(5) for further details.
102
+
103
+ <span class="gh">ENVIRONMENT
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.
109
+
110
+ <span class="gh">DIAGNOSTICS
111
+ -----------
112
+ </span>
113
+ The following diagnostics may be issued on stderr:
114
+
115
+ <span class="gs">**Bad magic number.**</span>
116
+ The input file does not look like an archive file.
117
+
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
120
+ supported in this version.
121
+
122
+ <span class="gh">BUGS
123
+ ----
124
+ </span>
125
+ The command name should have been chosen more carefully to reflect its
126
+ purpose.
127
+
128
+ <span class="gh">AUTHOR
129
+ ------
130
+ </span>
131
+ Jens Schweikhardt <span class="nv">&lt;howto@schweikhardt.net&gt;</span>
132
+
133
+ <span class="gh">SEE ALSO
134
+ --------
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>
138
+ </code></pre>
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">md2man-roff(1)</a>, <a class="md2man-reference">md2man-html(1)</a></p></div></body>
140
+ </html>
@@ -0,0 +1,190 @@
1
+ # MD2MAN 5 2016-02-28 5.1.0
2
+
3
+ ## NAME
4
+
5
+ md2man - UNIX manual page flavoring for [Markdown]
6
+
7
+ ## DESCRIPTION
8
+
9
+ md2man makes the [Markdown] format more friendly for writing UNIX manual
10
+ pages by extending its syntax, semantics, and assumed processing extensions.
11
+
12
+ ### Syntax
13
+
14
+ md2man extends [Markdown] syntax by recognizing three kinds of paragraphs,
15
+ analogous to the underlying `.PP`, `.TP`, and `.IP` directives in roff(7).
16
+
17
+ #### Normal paragraphs
18
+
19
+ Paragraphs whose lines are all indented by exactly zero or one additional
20
+ space are considered "normal paragraphs", analogous to `.PP` in roff(7):
21
+
22
+ This is a normal paragraph.
23
+
24
+ This is also
25
+ a normal
26
+ paragraph.
27
+
28
+ And
29
+ this
30
+ is
31
+ a
32
+ normal
33
+ paragraph
34
+ too.
35
+
36
+ #### Tagged paragraphs
37
+
38
+ Paragraphs whose first line is indented by less than two additional spaces and
39
+ whose subsequent lines are all uniformly indented by exactly two additional
40
+ spaces are considered "tagged paragraphs", analogous to `.TP` in roff(7):
41
+
42
+ This is a
43
+ tagged
44
+ paragraph.
45
+
46
+ #### Indented paragraphs
47
+
48
+ Paragraphs whose lines are all uniformly indented by exactly two additional
49
+ spaces are considered "indented paragraphs", analogous to `.IP` in roff(7):
50
+
51
+ This is an
52
+ indented
53
+ paragraph.
54
+
55
+ ### Semantics
56
+
57
+ md2man extends [Markdown] semantics by treating top-level headings specially.
58
+
59
+ #### Top-level headings
60
+
61
+ The first top-level `<h1>` heading found in the input is considered to be the
62
+ `.TH` directive in roff(7), described under "Title line" in man-pages(7) thus:
63
+
64
+ > .TH title section date source manual
65
+ >
66
+ > title
67
+ > The title of the man page, written in all caps (e.g., `MAN-PAGES`).
68
+ >
69
+ > section
70
+ > The section number in which the man page should be placed (e.g., `7`).
71
+ >
72
+ > date
73
+ > The date of the last revision, written in the form YYYY-MM-DD.
74
+ >
75
+ > source
76
+ > The source of the command, function, or system call (e.g., `Linux`).
77
+ >
78
+ > manual
79
+ > The title of the manual (e.g., `Linux Programmer's Manual`).
80
+
81
+ Any subsequent top-level headings are treated as second-level `<h2>` headings.
82
+
83
+ ### Extensions
84
+
85
+ md2man enables the following [Redcarpet] extensions while reading [Markdown]:
86
+
87
+ * tables
88
+ * autolink
89
+ * superscript
90
+ * strikethrough
91
+ * fenced\_code\_blocks
92
+
93
+ ### Examples
94
+
95
+ Below is a complete example of an md2man(5) formatted manual page adapted from
96
+ the [Linux Man Page Howto](http://www.schweikhardt.net/man_page_howto.html)
97
+ guide by Jens Schweikhardt. [The result of processing](../man0/EXAMPLE.html)
98
+ this example with md2man-html(1) has been bundled along with this manual page.
99
+
100
+ ```markdown
101
+ FOO 1 "MARCH 1995" Linux "User Manuals"
102
+ =======================================
103
+
104
+ NAME
105
+ ----
106
+
107
+ foo - frobnicate the bar library
108
+
109
+ SYNOPSIS
110
+ --------
111
+
112
+ `foo` [`-bar`] [`-c` *config-file*] *file* ...
113
+
114
+ DESCRIPTION
115
+ -----------
116
+
117
+ `foo` frobnicates the bar library by tweaking internal symbol tables. By
118
+ default it parses all baz segments and rearranges them in reverse order by
119
+ time for the xyzzy(1) linker to find them. The symdef entry is then compressed
120
+ using the WBG (Whiz-Bang-Gizmo) algorithm. All files are processed in the
121
+ order specified.
122
+
123
+ OPTIONS
124
+ -------
125
+
126
+ `-b`
127
+ Do not write "busy" to stdout while processing.
128
+
129
+ `-c` *config-file*
130
+ Use the alternate system wide *config-file* instead of */etc/foo.conf*. This
131
+ overrides any `FOOCONF` environment variable.
132
+
133
+ `-a`
134
+ In addition to the baz segments, also parse the blurfl headers.
135
+
136
+ `-r`
137
+ Recursive mode. Operates as fast as lightning at the expense of a megabyte
138
+ of virtual memory.
139
+
140
+ FILES
141
+ -----
142
+
143
+ */etc/foo.conf*
144
+ The system wide configuration file. See foo(5) for further details.
145
+
146
+ *~/.foorc*
147
+ Per user configuration file. See foo(5) for further details.
148
+
149
+ ENVIRONMENT
150
+ -----------
151
+
152
+ `FOOCONF`
153
+ If non-null the full pathname for an alternate system wide */etc/foo.conf*.
154
+ Overridden by the `-c` option.
155
+
156
+ DIAGNOSTICS
157
+ -----------
158
+
159
+ The following diagnostics may be issued on stderr:
160
+
161
+ **Bad magic number.**
162
+ The input file does not look like an archive file.
163
+
164
+ **Old style baz segments.**
165
+ `foo` can only handle new style baz segments. COBOL object libraries are not
166
+ supported in this version.
167
+
168
+ BUGS
169
+ ----
170
+
171
+ The command name should have been chosen more carefully to reflect its
172
+ purpose.
173
+
174
+ AUTHOR
175
+ ------
176
+
177
+ Jens Schweikhardt <howto@schweikhardt.net>
178
+
179
+ SEE ALSO
180
+ --------
181
+
182
+ bar(1), foo(5), xyzzy(1), [Linux Man Page Howto](
183
+ http://www.schweikhardt.net/man_page_howto.html)
184
+ ```
185
+
186
+ ## SEE ALSO
187
+
188
+ [Markdown], man-pages(7), roff(7), md2man-roff(1), md2man-html(1)
189
+
190
+ [Markdown]: http://daringfireball.net/projects/markdown/syntax
@@ -29,9 +29,16 @@
29
29
  margin-top: -5em;
30
30
  font-weight: normal;
31
31
  font-size: smaller;
32
- text-align: right;
32
+ text-align: center;
33
33
  }
34
34
 
35
+ h1:first-child > span.md2man-source {
36
+ float: right;
37
+ }
38
+
39
+ h1:first-child > span.md2man-title,
40
+ h1:first-child > span.md2man-section,
41
+ h1:first-child > span.md2man-manual,
35
42
  h1:first-child > a.md2man-permalink {
36
43
  display: none;
37
44
  }
@@ -79,3 +86,212 @@
79
86
  content: none;
80
87
  }
81
88
  }
89
+ .highlight table td { padding: 5px; }
90
+ .highlight table pre { margin: 0; }
91
+ .highlight .cm {
92
+ color: #999988;
93
+ font-style: italic;
94
+ }
95
+ .highlight .cp {
96
+ color: #999999;
97
+ font-weight: bold;
98
+ }
99
+ .highlight .c1 {
100
+ color: #999988;
101
+ font-style: italic;
102
+ }
103
+ .highlight .cs {
104
+ color: #999999;
105
+ font-weight: bold;
106
+ font-style: italic;
107
+ }
108
+ .highlight .c, .highlight .cd {
109
+ color: #999988;
110
+ font-style: italic;
111
+ }
112
+ .highlight .err {
113
+ color: #a61717;
114
+ background-color: #e3d2d2;
115
+ }
116
+ .highlight .gd {
117
+ color: #000000;
118
+ background-color: #ffdddd;
119
+ }
120
+ .highlight .ge {
121
+ color: #000000;
122
+ font-style: italic;
123
+ }
124
+ .highlight .gr {
125
+ color: #aa0000;
126
+ }
127
+ .highlight .gh {
128
+ color: #999999;
129
+ }
130
+ .highlight .gi {
131
+ color: #000000;
132
+ background-color: #ddffdd;
133
+ }
134
+ .highlight .go {
135
+ color: #888888;
136
+ }
137
+ .highlight .gp {
138
+ color: #555555;
139
+ }
140
+ .highlight .gs {
141
+ font-weight: bold;
142
+ }
143
+ .highlight .gu {
144
+ color: #aaaaaa;
145
+ }
146
+ .highlight .gt {
147
+ color: #aa0000;
148
+ }
149
+ .highlight .kc {
150
+ color: #000000;
151
+ font-weight: bold;
152
+ }
153
+ .highlight .kd {
154
+ color: #000000;
155
+ font-weight: bold;
156
+ }
157
+ .highlight .kn {
158
+ color: #000000;
159
+ font-weight: bold;
160
+ }
161
+ .highlight .kp {
162
+ color: #000000;
163
+ font-weight: bold;
164
+ }
165
+ .highlight .kr {
166
+ color: #000000;
167
+ font-weight: bold;
168
+ }
169
+ .highlight .kt {
170
+ color: #445588;
171
+ font-weight: bold;
172
+ }
173
+ .highlight .k, .highlight .kv {
174
+ color: #000000;
175
+ font-weight: bold;
176
+ }
177
+ .highlight .mf {
178
+ color: #009999;
179
+ }
180
+ .highlight .mh {
181
+ color: #009999;
182
+ }
183
+ .highlight .il {
184
+ color: #009999;
185
+ }
186
+ .highlight .mi {
187
+ color: #009999;
188
+ }
189
+ .highlight .mo {
190
+ color: #009999;
191
+ }
192
+ .highlight .m, .highlight .mb, .highlight .mx {
193
+ color: #009999;
194
+ }
195
+ .highlight .sb {
196
+ color: #d14;
197
+ }
198
+ .highlight .sc {
199
+ color: #d14;
200
+ }
201
+ .highlight .sd {
202
+ color: #d14;
203
+ }
204
+ .highlight .s2 {
205
+ color: #d14;
206
+ }
207
+ .highlight .se {
208
+ color: #d14;
209
+ }
210
+ .highlight .sh {
211
+ color: #d14;
212
+ }
213
+ .highlight .si {
214
+ color: #d14;
215
+ }
216
+ .highlight .sx {
217
+ color: #d14;
218
+ }
219
+ .highlight .sr {
220
+ color: #009926;
221
+ }
222
+ .highlight .s1 {
223
+ color: #d14;
224
+ }
225
+ .highlight .ss {
226
+ color: #990073;
227
+ }
228
+ .highlight .s {
229
+ color: #d14;
230
+ }
231
+ .highlight .na {
232
+ color: #008080;
233
+ }
234
+ .highlight .bp {
235
+ color: #999999;
236
+ }
237
+ .highlight .nb {
238
+ color: #0086B3;
239
+ }
240
+ .highlight .nc {
241
+ color: #445588;
242
+ font-weight: bold;
243
+ }
244
+ .highlight .no {
245
+ color: #008080;
246
+ }
247
+ .highlight .nd {
248
+ color: #3c5d5d;
249
+ font-weight: bold;
250
+ }
251
+ .highlight .ni {
252
+ color: #800080;
253
+ }
254
+ .highlight .ne {
255
+ color: #990000;
256
+ font-weight: bold;
257
+ }
258
+ .highlight .nf {
259
+ color: #990000;
260
+ font-weight: bold;
261
+ }
262
+ .highlight .nl {
263
+ color: #990000;
264
+ font-weight: bold;
265
+ }
266
+ .highlight .nn {
267
+ color: #555555;
268
+ }
269
+ .highlight .nt {
270
+ color: #000080;
271
+ }
272
+ .highlight .vc {
273
+ color: #008080;
274
+ }
275
+ .highlight .vg {
276
+ color: #008080;
277
+ }
278
+ .highlight .vi {
279
+ color: #008080;
280
+ }
281
+ .highlight .nv {
282
+ color: #008080;
283
+ }
284
+ .highlight .ow {
285
+ color: #000000;
286
+ font-weight: bold;
287
+ }
288
+ .highlight .o {
289
+ color: #000000;
290
+ font-weight: bold;
291
+ }
292
+ .highlight .w {
293
+ color: #bbbbbb;
294
+ }
295
+ .highlight {
296
+ background-color: #f8f8f8;
297
+ }