binman 5.0.1 → 5.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/README.markdown +471 -238
  3. data/VERSION.markdown +40 -8
  4. data/bin/binman +17 -71
  5. data/bin/binman-help +208 -0
  6. data/bin/binman-html +28 -0
  7. data/bin/binman-rake +11 -8
  8. data/bin/binman-roff +28 -0
  9. data/bin/binman-show +193 -0
  10. data/bin/binman-text +105 -0
  11. data/binman.gemspec +4 -4
  12. data/lib/binman.rb +8 -8
  13. data/lib/binman/rakefile.rb +2 -2
  14. data/lib/binman/version.rb +1 -1
  15. data/man/index.html +3 -3
  16. data/man/man0/README.html +488 -253
  17. data/man/man0/VERSION.html +44 -23
  18. data/man/man1/binman-help.1 +215 -0
  19. data/man/man1/binman-help.1.html +106 -0
  20. data/man/man1/binman-html.1 +18 -0
  21. data/man/man1/binman-html.1.html +12 -0
  22. data/man/man1/binman-rake.1 +9 -10
  23. data/man/man1/binman-rake.1.html +8 -8
  24. data/man/man1/binman-roff.1 +23 -0
  25. data/man/man1/binman-roff.1.html +12 -0
  26. data/man/man1/binman-show.1 +219 -0
  27. data/man/man1/binman-show.1.html +104 -0
  28. data/man/man1/binman-text.1 +129 -0
  29. data/man/man1/binman-text.1.html +55 -0
  30. data/man/man1/binman.1 +22 -111
  31. data/man/man1/binman.1.html +7 -47
  32. data/man/man5/md2man.5 +219 -0
  33. data/man/man5/md2man.5.html +140 -0
  34. data/man/man5/md2man.5.markdown +190 -0
  35. data/man/style.css +217 -1
  36. metadata +28 -7
  37. data/EXAMPLE.png +0 -0
  38. data/man/man0/EXAMPLE.png +0 -1
data/man/man1/binman-text.1 ADDED
@@ -0,0 +1,129 @@
1
+ .TH BINMAN\-TEXT 1 2016\-02\-28 5.1.0
2
+ .SH NAME
3
+ .PP
4
+ binman\-text \- extract embedded manpage sources
5
+ .SH SYNOPSIS
6
+ .PP
7
+ \fB\fCbinman\-text\fR [\fIOPTION\fP]... [\fIFILE\fP]
8
+ .SH DESCRIPTION
9
+ .PP
10
+ Prints the "embedded manpage source" extracted from the given \fIFILE\fP or STDIN.
11
+ .SS Embedded manpage sources
12
+ .PP
13
+ An "embedded manpage source" is an
14
+ .BR md2man (5)
15
+ document that is embedded in your
16
+ script, typically inside a multi\-line block comment or "here document"; or in
17
+ a header comment composed of single\-line comments near the top of your script.
18
+ .SS In multi\-line comments
19
+ .PP
20
+ In the former case, where it's possible to write a freeform block of text, the
21
+ embedded manpage source must be delimited by \fB\fC=begin\fR and \fB\fC=end\fR lines, which
22
+ start with their respective delimiters and, optionally, continue with a single
23
+ space followed by any amount and kind of characters until the end of line.
24
+ .PP
25
+ To illustrate, here is the simplest case:
26
+ .PP
27
+ .RS
28
+ .nf
29
+ =begin
30
+ This is an embedded manpage source!
31
+ =end
32
+ .fi
33
+ .RE
34
+ .PP
35
+ Next, we can add decorations after the delimiters:
36
+ .PP
37
+ .RS
38
+ .nf
39
+ =begin \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
40
+ This is an embedded manpage source!
41
+ =end //////////////////////////////
42
+ .fi
43
+ .RE
44
+ .PP
45
+ Similarly, using different characters this time:
46
+ .PP
47
+ .RS
48
+ .nf
49
+ =begin abcdefghijklmnopqrstuvwxyz'"
50
+ This is an embedded manpage source!
51
+ =end 0123456789!@#$%^&*()=+\-_:;,\\/?
52
+ .fi
53
+ .RE
54
+ .SS In single\-line comments
55
+ .PP
56
+ In the latter case, the embedded manpage source is expected to be found in a
57
+ contiguous block of single\-line comments that begins at the top of the script
58
+ (optionally after a \fB\fC#!\fR line, \fB\fCcoding:\fR line, and any number of blank lines)
59
+ and ends at the first blank line. Each single\-line comment inside this block
60
+ must begin with a \fB\fC#\fR character and may, optionally, continue with a single
61
+ space followed by any amount and kind of characters until the end of line.
62
+ .PP
63
+ To illustrate, here is the simplest case:
64
+ .PP
65
+ .RS
66
+ .nf
67
+ # This is an embedded manpage source!
68
+ .fi
69
+ .RE
70
+ .PP
71
+ Next, we can add a \fB\fC#!\fR line at the top:
72
+ .PP
73
+ .RS
74
+ .nf
75
+ #!/bin/sh
76
+ # This is an embedded manpage source!
77
+ .fi
78
+ .RE
79
+ .PP
80
+ Next, we can add a \fB\fCcoding:\fR line after \fB\fC#!\fR:
81
+ .PP
82
+ .RS
83
+ .nf
84
+ #!/bin/sh
85
+ # coding: utf\-8
86
+ # This is an embedded manpage source!
87
+ .fi
88
+ .RE
89
+ .PP
90
+ Or, using the Emacs coding system syntax:
91
+ .PP
92
+ .RS
93
+ .nf
94
+ #!/bin/sh
95
+ # \-*\- encoding: utf\-8 \-*\-
96
+ # This is an embedded manpage source!
97
+ .fi
98
+ .RE
99
+ .PP
100
+ Next, we can add blank lines between them:
101
+ .PP
102
+ .RS
103
+ .nf
104
+ #!/bin/sh
105
+ # coding: utf\-8
106
+
107
+ # This is an embedded manpage source!
108
+ .fi
109
+ .RE
110
+ .PP
111
+ Here is another permutation of the above:
112
+ .PP
113
+ .RS
114
+ .nf
115
+ #!/bin/sh
116
+
117
+ # This is an embedded manpage source!
118
+ .fi
119
+ .RE
120
+ .SH OPTIONS
121
+ .TP
122
+ \fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
123
+ Show this help manual and optionally search for \fIPATTERN\fP regular expression.
124
+ .SH SEE ALSO
125
+ .PP
126
+ .BR md2man (5),
127
+ .BR binman-roff (1),
128
+ .BR binman-html (1),
129
+ .BR binman (1)
data/man/man1/binman-text.1.html ADDED
@@ -0,0 +1,55 @@
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>binman-text(1) &mdash; extract embedded manpage sources</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#man1">man1</a>/binman-text.1</span></div></div><div class="container-fluid"><h1 id="binman-text-1-2016-02-28-5-1-0"><span class="md2man-title">BINMAN-TEXT</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="binman-text-1-2016-02-28-5-1-0" href="#binman-text-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>binman-text - extract embedded manpage sources</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>binman-text</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>Prints the &quot;embedded manpage source&quot; extracted from the given <em>FILE</em> or STDIN.</p><h3 id="embedded-manpage-sources">Embedded manpage sources<a name="embedded-manpage-sources" href="#embedded-manpage-sources" class="md2man-permalink" title="permalink"></a></h3><p>An &quot;embedded manpage source&quot; is an <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> document that is embedded in your
11
+ script, typically inside a multi-line block comment or &quot;here document&quot;; or in
12
+ a header comment composed of single-line comments near the top of your script.</p><h4 id="in-multi-line-comments">In multi-line comments<a name="in-multi-line-comments" href="#in-multi-line-comments" class="md2man-permalink" title="permalink"></a></h4><p>In the former case, where it&#39;s possible to write a freeform block of text, the
13
+ embedded manpage source must be delimited by <code>=begin</code> and <code>=end</code> lines, which
14
+ start with their respective delimiters and, optionally, continue with a single
15
+ space followed by any amount and kind of characters until the end of line.</p><p>To illustrate, here is the simplest case:</p><pre class="highlight plaintext"><code>=begin
16
+ This is an embedded manpage source!
17
+ =end
18
+ </code></pre>
19
+ <p>Next, we can add decorations after the delimiters:</p><pre class="highlight plaintext"><code>=begin \\\\\\\\\\\\\\\\\\\\\\\\\\\\
20
+ This is an embedded manpage source!
21
+ =end //////////////////////////////
22
+ </code></pre>
23
+ <p>Similarly, using different characters this time:</p><pre class="highlight plaintext"><code>=begin abcdefghijklmnopqrstuvwxyz'"
24
+ This is an embedded manpage source!
25
+ =end 0123456789!@#$%^&amp;*()=+-_:;,\/?
26
+ </code></pre>
27
+ <h4 id="in-single-line-comments">In single-line comments<a name="in-single-line-comments" href="#in-single-line-comments" class="md2man-permalink" title="permalink"></a></h4><p>In the latter case, the embedded manpage source is expected to be found in a
28
+ contiguous block of single-line comments that begins at the top of the script
29
+ (optionally after a <code>#!</code> line, <code>coding:</code> line, and any number of blank lines)
30
+ and ends at the first blank line. Each single-line comment inside this block
31
+ must begin with a <code>#</code> character and may, optionally, continue with a single
32
+ space followed by any amount and kind of characters until the end of line.</p><p>To illustrate, here is the simplest case:</p><pre class="highlight plaintext"><code># This is an embedded manpage source!
33
+ </code></pre>
34
+ <p>Next, we can add a <code>#!</code> line at the top:</p><pre class="highlight shell"><code><span class="c">#!/bin/sh</span>
35
+ <span class="c"># This is an embedded manpage source!</span>
36
+ </code></pre>
37
+ <p>Next, we can add a <code>coding:</code> line after <code>#!</code>:</p><pre class="highlight shell"><code><span class="c">#!/bin/sh</span>
38
+ <span class="c"># coding: utf-8</span>
39
+ <span class="c"># This is an embedded manpage source!</span>
40
+ </code></pre>
41
+ <p>Or, using the Emacs coding system syntax:</p><pre class="highlight shell"><code><span class="c">#!/bin/sh</span>
42
+ <span class="c"># -*- encoding: utf-8 -*-</span>
43
+ <span class="c"># This is an embedded manpage source!</span>
44
+ </code></pre>
45
+ <p>Next, we can add blank lines between them:</p><pre class="highlight shell"><code><span class="c">#!/bin/sh</span>
46
+ <span class="c"># coding: utf-8</span>
47
+
48
+ <span class="c"># This is an embedded manpage source!</span>
49
+ </code></pre>
50
+ <p>Here is another permutation of the above:</p><pre class="highlight shell"><code><span class="c">#!/bin/sh</span>
51
+
52
+ <span class="c"># This is an embedded manpage source!</span>
53
+ </code></pre>
54
+ <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="../man5/md2man.5.html">md2man(5)</a>, <a class="md2man-reference" href="../man1/binman-roff.1.html">binman-roff(1)</a>, <a class="md2man-reference" href="../man1/binman-html.1.html">binman-html(1)</a>, <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a></p></div></body>
55
+ </html>
data/man/man1/binman.1 CHANGED
@@ -1,132 +1,43 @@
1
- .TH BINMAN 1 2016\-02\-13 5.0.1
1
+ .TH BINMAN 1 2016\-02\-28 5.1.0
2
2
  .SH NAME
3
3
  .PP
4
- binman \- man pages for bin scripts
4
+ binman \- deprecated; use binman\-* instead
5
5
  .SH SYNOPSIS
6
6
  .PP
7
7
  \fB\fCbinman\fR [\fIOPTION\fP]... \fICOMMAND\fP
8
8
  .SH DESCRIPTION
9
9
  .PP
10
- binman
11
- \[la]https://github.com/sunaku/binman\[ra] produces UNIX manual pages for your executable scripts. It can
12
- extract their leading comment headers (defined below), convert them from
13
- .BR markdown (7)
14
- into
15
- .BR roff (7)
16
- using md2man
17
- \[la]https://github.com/sunaku/md2man\[ra], and display them using
18
- .BR man (1).
19
- .SS Leading comment headers
10
+ Runs the fellow "\fB\fCbinman\fR\-\fICOMMAND\fP" programs listed under "Commands" below.
20
11
  .PP
21
- A leading comment header can be one of the following two things:
22
- .nr step0 0 1
23
12
  .RS
24
- .IP \n+[step0]
25
- A contiguous sequence of single\-line comments (which begin with \fB\fC#\fR
26
- and optionally continue with a single space followed by any number of
27
- characters until the end of the line) starting at the beginning of the
28
- file (after shebang and encoding comments plus optional blank lines) and
29
- ending at the first single blank line.
30
- .IP \n+[step0]
31
- The first embedded document delimited by \fB\fC=begin\fR and \fB\fC=end\fR lines, which
32
- begin with the respective delimiters and optionally continue with a single
33
- space followed by any number of characters until the end of the line.
34
- .RE
35
- .SS Markdown processing divergence
36
- .PP
37
- Although your leading comment headers are written in
38
- .BR markdown (7),
39
- \fB\fCbinman
40
- conv\fR inherits the following additions to
41
- .BR markdown (7)
42
- syntax from
43
- .BR md2man (5):
44
- .RS
45
- .IP \(bu 2
46
- There can be at most one top\-level heading (H1). It is emitted as \fB\fC\&.TH\fR
47
- in the
48
- .BR roff (7)
49
- output to define the UNIX manual page's header and footer.
50
- .IP \(bu 2
51
- Paragraphs whose lines are all uniformly indented by two spaces are
52
- considered to be "indented paragraphs". They are unindented accordingly
53
- before emission as \fB\fC\&.IP\fR in the
54
- .BR roff (7)
55
- output.
56
- .IP \(bu 2
57
- Paragraphs whose subsequent lines (all except the first) are uniformly
58
- indented by two spaces are considered to be a "tagged paragraphs". They
59
- are unindented accordingly before emission as \fB\fC\&.TP\fR in the
60
- .BR roff (7)
61
- output.
62
- .RE
63
- .SS Markdown processing extensions
64
- .PP
65
- The following Redcarpet
66
- \[la]https://github.com/vmg/redcarpet\[ra] extensions are enabled while processing
67
- .BR markdown (7):
68
- .RS
69
- .IP \(bu 2
70
- tables
71
- .IP \(bu 2
72
- autolink
73
- .IP \(bu 2
74
- superscript
75
- .IP \(bu 2
76
- strikethrough
77
- .IP \(bu 2
78
- fenced_code_blocks
13
+ Note: This program is deprecated for removal in the next major version. To
14
+ prepare yourself, please run the fellow binman\-* programs directly instead.
79
15
  .RE
80
16
  .SH OPTIONS
81
17
  .TP
82
18
  \fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
83
- Show this help manual and search for \fIPATTERN\fP regular expression therein.
19
+ Show this help manual and optionally search for \fIPATTERN\fP regular expression.
84
20
  .SH COMMANDS
85
21
  .TP
86
- \fB\fCtext\fR [\fIFILE\fP]
87
- Print the leading comment header extracted from the given \fIFILE\fP or STDIN.
22
+ \fB\fCtext\fR ...
23
+ Runs
24
+ .BR binman-text (1).
88
25
  .TP
89
- \fB\fCroff\fR [\fIFILE\fP]
90
- Print the
91
- .BR roff (7)
92
- conversion of the leading comment header extracted from
93
- the given \fIFILE\fP or STDIN.
26
+ \fB\fCroff\fR ...
27
+ Runs
28
+ .BR binman-roff (1).
94
29
  .TP
95
- \fB\fChtml\fR [\fIFILE\fP]
96
- Print the HTML conversion of the leading comment header extracted from
97
- the given \fIFILE\fP or STDIN.
30
+ \fB\fChtml\fR ...
31
+ Runs
32
+ .BR binman-html (1).
98
33
  .TP
99
- \fB\fCshow\fR [\fIFILE\fP] [\fIPATTERN\fP]
100
- Use
101
- .BR man (1)
102
- to display the
103
- .BR roff (7)
104
- conversion of the leading comment header
105
- extracted from the given \fIFILE\fP or STDIN. If \fIPATTERN\fP is given, search for
106
- it within the output displayed by
107
- .BR man (1)
108
- and jump to first match if found.
109
- If
110
- .BR man (1)
111
- cannot display the
112
- .BR roff (1)
113
- conversion, fall back to the showing
114
- the HTML conversion; if that fails too, display the extracted text as\-is.
34
+ \fB\fCshow\fR ...
35
+ Runs
36
+ .BR binman-show (1).
115
37
  .TP
116
- \fB\fChelp\fR \fIFILE\fP ... [\fB\fC\-h\fR|\fB\fC\-\-help\fR [\fIPATTERN\fP]] ... [\fB\fC\-\-\fR] ...
117
- If the given argument sequence contains \fB\fC\-h\fR or \fB\fC\-\-help\fR, except after
118
- \fB\fC\-\-\fR, optionally followed by a \fIPATTERN\fP regular expression that specifies
119
- text to search for and, if found, jump to inside the displayed man page,
120
- then this program extracts the given \fIFILE\fP\&'s leading comment header,
121
- converts it into
122
- .BR roff (7),
123
- displays it using
124
- .BR man (1),
125
- and finally exits with
126
- status code \fB\fC0\fR\&. Otherwise, this program exits with status code \fB\fC111\fR\&.
38
+ \fB\fChelp\fR ...
39
+ Runs
40
+ .BR binman-help (1).
127
41
  .SH SEE ALSO
128
42
  .PP
129
- .BR binman-rake (1),
130
- .BR man (1),
131
- .BR roff (7),
132
- .BR markdown (7)
43
+ .BR binman-rake (1)
data/man/man1/binman.1.html CHANGED
@@ -2,54 +2,14 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8" />
5
- <meta name="generator" content="md2man 5.0.1 https://github.com/sunaku/md2man" />
6
- <title>binman(1) &mdash; man pages for bin scripts</title>
5
+ <meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" />
6
+ <title>binman(1) &mdash; deprecated; use binman-* instead</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>/binman.1</span></div></div><div class="container-fluid"><h1 id="binman-1-2016-02-13-5-0-1"><span class="md2man-title">BINMAN</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">5.0.1</span><a name="binman-1-2016-02-13-5-0-1" href="#binman-1-2016-02-13-5-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>binman - man pages for bin scripts</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>binman</code> [<em>OPTION</em>]... <em>COMMAND</em></p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p><a href="https://github.com/sunaku/binman">binman</a> produces UNIX manual pages for your executable scripts. It can
11
- extract their leading comment headers (defined below), convert them from
12
- <a class="md2man-reference">markdown(7)</a> into <a class="md2man-reference">roff(7)</a> using <a href="https://github.com/sunaku/md2man">md2man</a>, and display them using <a class="md2man-reference">man(1)</a>.</p><h3 id="leading-comment-headers">Leading comment headers<a name="leading-comment-headers" href="#leading-comment-headers" class="md2man-permalink" title="permalink"></a></h3><p>A leading comment header can be one of the following two things:</p>
13
- <ol>
14
- <li><p> A contiguous sequence of single-line comments (which begin with <code>#</code>
15
- and optionally continue with a single space followed by any number of
16
- characters until the end of the line) starting at the beginning of the
17
- file (after shebang and encoding comments plus optional blank lines) and
18
- ending at the first single blank line.</p></li>
19
- <li><p> The first embedded document delimited by <code>=begin</code> and <code>=end</code> lines, which
20
- begin with the respective delimiters and optionally continue with a single
21
- space followed by any number of characters until the end of the line.</p></li>
22
- </ol>
23
- <h3 id="markdown-processing-divergence">Markdown processing divergence<a name="markdown-processing-divergence" href="#markdown-processing-divergence" class="md2man-permalink" title="permalink"></a></h3><p>Although your leading comment headers are written in <a class="md2man-reference">markdown(7)</a>, <code>binman
24
- conv</code> inherits the following additions to <a class="md2man-reference">markdown(7)</a> syntax from <a class="md2man-reference">md2man(5)</a>:</p>
25
- <ul>
26
- <li><p>There can be at most one top-level heading (H1). It is emitted as <code>.TH</code>
27
- in the <a class="md2man-reference">roff(7)</a> output to define the UNIX manual page&#39;s header and footer.</p></li>
28
- <li><p>Paragraphs whose lines are all uniformly indented by two spaces are
29
- considered to be &quot;indented paragraphs&quot;. They are unindented accordingly
30
- before emission as <code>.IP</code> in the <a class="md2man-reference">roff(7)</a> output.</p></li>
31
- <li><p>Paragraphs whose subsequent lines (all except the first) are uniformly
32
- indented by two spaces are considered to be a &quot;tagged paragraphs&quot;. They
33
- are unindented accordingly before emission as <code>.TP</code> in the <a class="md2man-reference">roff(7)</a> output.</p></li>
34
- </ul>
35
- <h3 id="markdown-processing-extensions">Markdown processing extensions<a name="markdown-processing-extensions" href="#markdown-processing-extensions" class="md2man-permalink" title="permalink"></a></h3><p>The following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> extensions are enabled while processing <a class="md2man-reference">markdown(7)</a>:</p>
36
- <ul>
37
- <li>tables</li>
38
- <li>autolink</li>
39
- <li>superscript</li>
40
- <li>strikethrough</li>
41
- <li>fenced_code_blocks</li>
42
- </ul>
43
- <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 therein.</dd></dl><h2 id="commands">COMMANDS<a name="commands" href="#commands" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>text</code> [<em>FILE</em>]</dt><dd>Print the leading comment header extracted from the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>roff</code> [<em>FILE</em>]</dt><dd>Print the <a class="md2man-reference">roff(7)</a> conversion of the leading comment header extracted from
44
- the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>html</code> [<em>FILE</em>]</dt><dd>Print the HTML conversion of the leading comment header extracted from
45
- the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>show</code> [<em>FILE</em>] [<em>PATTERN</em>]</dt><dd>Use <a class="md2man-reference">man(1)</a> to display the <a class="md2man-reference">roff(7)</a> conversion of the leading comment header
46
- extracted from the given <em>FILE</em> or STDIN. If <em>PATTERN</em> is given, search for
47
- it within the output displayed by <a class="md2man-reference">man(1)</a> and jump to first match if found.
48
- If <a class="md2man-reference">man(1)</a> cannot display the <a class="md2man-reference">roff(1)</a> conversion, fall back to the showing
49
- the HTML conversion; if that fails too, display the extracted text as-is.</dd></dl><dl><dt><code>help</code> <em>FILE</em> ... [<code>-h</code>|<code>--help</code> [<em>PATTERN</em>]] ... [<code>--</code>] ...</dt><dd>If the given argument sequence contains <code>-h</code> or <code>--help</code>, except after
50
- <code>--</code>, optionally followed by a <em>PATTERN</em> regular expression that specifies
51
- text to search for and, if found, jump to inside the displayed man page,
52
- then this program extracts the given <em>FILE</em>&#39;s leading comment header,
53
- converts it into <a class="md2man-reference">roff(7)</a>, displays it using <a class="md2man-reference">man(1)</a>, and finally exits with
54
- status code <code>0</code>. Otherwise, this program exits with status code <code>111</code>.</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/binman-rake.1.html">binman-rake(1)</a>, <a class="md2man-reference">man(1)</a>, <a class="md2man-reference">roff(7)</a>, <a class="md2man-reference">markdown(7)</a></p></div></body>
10
+ <body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman.1</span></div></div><div class="container-fluid"><h1 id="binman-1-2016-02-28-5-1-0"><span class="md2man-title">BINMAN</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="binman-1-2016-02-28-5-1-0" href="#binman-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>binman - deprecated; use binman-* instead</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>binman</code> [<em>OPTION</em>]... <em>COMMAND</em></p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>Runs the fellow &quot;<code>binman</code>-<em>COMMAND</em>&quot; programs listed under &quot;Commands&quot; below.</p>
11
+ <blockquote>
12
+ <p>Note: This program is deprecated for removal in the next major version. To
13
+ prepare yourself, please run the fellow binman-* programs directly instead.</p></blockquote>
14
+ <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="commands">COMMANDS<a name="commands" href="#commands" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>text</code> ...</dt><dd>Runs <a class="md2man-reference" href="../man1/binman-text.1.html">binman-text(1)</a>.</dd></dl><dl><dt><code>roff</code> ...</dt><dd>Runs <a class="md2man-reference" href="../man1/binman-roff.1.html">binman-roff(1)</a>.</dd></dl><dl><dt><code>html</code> ...</dt><dd>Runs <a class="md2man-reference" href="../man1/binman-html.1.html">binman-html(1)</a>.</dd></dl><dl><dt><code>show</code> ...</dt><dd>Runs <a class="md2man-reference" href="../man1/binman-show.1.html">binman-show(1)</a>.</dd></dl><dl><dt><code>help</code> ...</dt><dd>Runs <a class="md2man-reference" href="../man1/binman-help.1.html">binman-help(1)</a>.</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/binman-rake.1.html">binman-rake(1)</a></p></div></body>
55
15
  </html>
data/man/man5/md2man.5 ADDED
@@ -0,0 +1,219 @@
1
+ .TH MD2MAN 5 2016\-02\-28 5.1.0
2
+ .SH NAME
3
+ .PP
4
+ md2man \- UNIX manual page flavoring for Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra]
5
+ .SH DESCRIPTION
6
+ .PP
7
+ md2man makes the Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] format more friendly for writing UNIX manual
8
+ pages by extending its syntax, semantics, and assumed processing extensions.
9
+ .SS Syntax
10
+ .PP
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).
14
+ .SS Normal paragraphs
15
+ .PP
16
+ Paragraphs whose lines are all indented by exactly zero or one additional
17
+ space are considered "normal paragraphs", analogous to \fB\fC\&.PP\fR in
18
+ .BR roff (7):
19
+ .PP
20
+ .RS
21
+ .nf
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
+ .fi
36
+ .RE
37
+ .SS Tagged paragraphs
38
+ .PP
39
+ Paragraphs whose first line is indented by less than two additional spaces and
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):
43
+ .PP
44
+ .RS
45
+ .nf
46
+ This is a
47
+ tagged
48
+ paragraph.
49
+ .fi
50
+ .RE
51
+ .SS Indented paragraphs
52
+ .PP
53
+ Paragraphs whose lines are all uniformly indented by exactly two additional
54
+ spaces are considered "indented paragraphs", analogous to \fB\fC\&.IP\fR in
55
+ .BR roff (7):
56
+ .PP
57
+ .RS
58
+ .nf
59
+ This is an
60
+ indented
61
+ paragraph.
62
+ .fi
63
+ .RE
64
+ .SS Semantics
65
+ .PP
66
+ md2man extends Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] semantics by treating top\-level headings specially.
67
+ .SS Top\-level headings
68
+ .PP
69
+ The first top\-level \fB\fC<h1>\fR heading found in the input is considered to be the
70
+ \fB\fC\&.TH\fR directive in
71
+ .BR roff (7),
72
+ described under "Title line" in
73
+ .BR man-pages (7)
74
+ thus:
75
+ .PP
76
+ .RS
77
+ .RS
78
+ .nf
79
+ \&.TH title section date source manual
80
+ .fi
81
+ .RE
82
+ .TP
83
+ title
84
+ The title of the man page, written in all caps (e.g., \fB\fCMAN\-PAGES\fR).
85
+ .TP
86
+ section
87
+ The section number in which the man page should be placed (e.g., \fB\fC7\fR).
88
+ .TP
89
+ date
90
+ The date of the last revision, written in the form YYYY\-MM\-DD.
91
+ .TP
92
+ source
93
+ The source of the command, function, or system call (e.g., \fB\fCLinux\fR).
94
+ .TP
95
+ manual
96
+ The title of the manual (e.g., \fB\fCLinux Programmer's Manual\fR).
97
+ .RE
98
+ .PP
99
+ Any subsequent top\-level headings are treated as second\-level \fB\fC<h2>\fR headings.
100
+ .SS Extensions
101
+ .PP
102
+ md2man enables the following [Redcarpet] extensions while reading Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra]:
103
+ .RS
104
+ .IP \(bu 2
105
+ tables
106
+ .IP \(bu 2
107
+ autolink
108
+ .IP \(bu 2
109
+ superscript
110
+ .IP \(bu 2
111
+ strikethrough
112
+ .IP \(bu 2
113
+ fenced_code_blocks
114
+ .RE
115
+ .SS Examples
116
+ .PP
117
+ Below is a complete example of an
118
+ .BR md2man (5)
119
+ formatted manual page adapted from
120
+ the Linux Man Page Howto \[la]http://www.schweikhardt.net/man_page_howto.html\[ra]
121
+ guide by Jens Schweikhardt. The result of processing \[la]../man0/EXAMPLE.html\[ra]
122
+ this example with
123
+ .BR md2man-html (1)
124
+ has been bundled along with this manual page.
125
+ .PP
126
+ .RS
127
+ .nf
128
+ FOO 1 "MARCH 1995" Linux "User Manuals"
129
+ =======================================
130
+
131
+ NAME
132
+ \-\-\-\-
133
+
134
+ foo \- frobnicate the bar library
135
+
136
+ SYNOPSIS
137
+ \-\-\-\-\-\-\-\-
138
+
139
+ `foo` [`\-bar`] [`\-c` *config\-file*] *file* ...
140
+
141
+ DESCRIPTION
142
+ \-\-\-\-\-\-\-\-\-\-\-
143
+
144
+ `foo` frobnicates the bar library by tweaking internal symbol tables. By
145
+ default it parses all baz segments and rearranges them in reverse order by
146
+ time for the xyzzy(1) linker to find them. The symdef entry is then compressed
147
+ using the WBG (Whiz\-Bang\-Gizmo) algorithm. All files are processed in the
148
+ order specified.
149
+
150
+ OPTIONS
151
+ \-\-\-\-\-\-\-
152
+
153
+ `\-b`
154
+ Do not write "busy" to stdout while processing.
155
+
156
+ `\-c` *config\-file*
157
+ Use the alternate system wide *config\-file* instead of */etc/foo.conf*. This
158
+ overrides any `FOOCONF` environment variable.
159
+
160
+ `\-a`
161
+ In addition to the baz segments, also parse the blurfl headers.
162
+
163
+ `\-r`
164
+ Recursive mode. Operates as fast as lightning at the expense of a megabyte
165
+ of virtual memory.
166
+
167
+ FILES
168
+ \-\-\-\-\-
169
+
170
+ */etc/foo.conf*
171
+ The system wide configuration file. See foo(5) for further details.
172
+
173
+ *~/.foorc*
174
+ Per user configuration file. See foo(5) for further details.
175
+
176
+ ENVIRONMENT
177
+ \-\-\-\-\-\-\-\-\-\-\-
178
+
179
+ `FOOCONF`
180
+ If non\-null the full pathname for an alternate system wide */etc/foo.conf*.
181
+ Overridden by the `\-c` option.
182
+
183
+ DIAGNOSTICS
184
+ \-\-\-\-\-\-\-\-\-\-\-
185
+
186
+ The following diagnostics may be issued on stderr:
187
+
188
+ **Bad magic number.**
189
+ The input file does not look like an archive file.
190
+
191
+ **Old style baz segments.**
192
+ `foo` can only handle new style baz segments. COBOL object libraries are not
193
+ supported in this version.
194
+
195
+ BUGS
196
+ \-\-\-\-
197
+
198
+ The command name should have been chosen more carefully to reflect its
199
+ purpose.
200
+
201
+ AUTHOR
202
+ \-\-\-\-\-\-
203
+
204
+ Jens Schweikhardt <howto@schweikhardt.net>
205
+
206
+ SEE ALSO
207
+ \-\-\-\-\-\-\-\-
208
+
209
+ bar(1), foo(5), xyzzy(1), [Linux Man Page Howto](
210
+ http://www.schweikhardt.net/man_page_howto.html)
211
+ .fi
212
+ .RE
213
+ .SH SEE ALSO
214
+ .PP
215
+ Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra],
216
+ .BR man-pages (7),
217
+ .BR roff (7),
218
+ .BR md2man-roff (1),
219
+ .BR md2man-html (1)