RubyGems - binman - Versions diffs - 5.0.1 → 5.1.0 - Mend

binman 5.0.1 → 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.

Files changed (38) hide show

checksums.yaml +4 -4
data/README.markdown +471 -238
data/VERSION.markdown +40 -8
data/bin/binman +17 -71
data/bin/binman-help +208 -0
data/bin/binman-html +28 -0
data/bin/binman-rake +11 -8
data/bin/binman-roff +28 -0
data/bin/binman-show +193 -0
data/bin/binman-text +105 -0
data/binman.gemspec +4 -4
data/lib/binman.rb +8 -8
data/lib/binman/rakefile.rb +2 -2
data/lib/binman/version.rb +1 -1
data/man/index.html +3 -3
data/man/man0/README.html +488 -253
data/man/man0/VERSION.html +44 -23
data/man/man1/binman-help.1 +215 -0
data/man/man1/binman-help.1.html +106 -0
data/man/man1/binman-html.1 +18 -0
data/man/man1/binman-html.1.html +12 -0
data/man/man1/binman-rake.1 +9 -10
data/man/man1/binman-rake.1.html +8 -8
data/man/man1/binman-roff.1 +23 -0
data/man/man1/binman-roff.1.html +12 -0
data/man/man1/binman-show.1 +219 -0
data/man/man1/binman-show.1.html +104 -0
data/man/man1/binman-text.1 +129 -0
data/man/man1/binman-text.1.html +55 -0
data/man/man1/binman.1 +22 -111
data/man/man1/binman.1.html +7 -47
data/man/man5/md2man.5 +219 -0
data/man/man5/md2man.5.html +140 -0
data/man/man5/md2man.5.markdown +190 -0
data/man/style.css +217 -1
metadata +28 -7
data/EXAMPLE.png +0 -0
data/man/man0/EXAMPLE.png +0 -1

data/man/man1/binman-html.1.html ADDED

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" />
+  <title>binman-html(1) &mdash; HTML manpage from header comment</title>
+  <link rel="stylesheet" href="../style.css"/>
+  <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
+</head>
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman-html.1</span></div></div><div class="container-fluid"><h1 id="binman-html-1-2016-02-28-5-1-0"><span class="md2man-title">BINMAN-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="binman-html-1-2016-02-28-5-1-0" href="#binman-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>binman-html - HTML manpage from header comment</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>binman-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>Extracts the &quot;embedded manpage source&quot;, described in <a class="md2man-reference" href="../man1/binman-text.1.html">binman-text(1)</a>, from the
+given <em>FILE</em> or STDIN and transforms it into HTML for use in a web browser.</p><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-text.1.html">binman-text(1)</a>, <a class="md2man-reference" href="../man1/binman-roff.1.html">binman-roff(1)</a>, <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a></p></div></body>
+</html>

data/man/man1/binman-rake.1 CHANGED

@@ -1,10 +1,9 @@
-.TH BINMAN\-RAKE 1 2016\-02\-13 5.0.1
+.TH BINMAN\-RAKE 1                   2016\-02\-28                            5.1.0
 .SH NAME
 .PP
 binman\-rake \- run
 .BR rake (1)
-tasks from
-.BR binman (1)
+tasks from command line
 .SH SYNOPSIS
 .PP
 \fB\fCbinman\-rake\fR [\fIOPTION\fP]... [\fITASK\fP]...
@@ -27,15 +26,15 @@ If no \fITASK\fP is specified, then the \fB\fCbinman\fR task is run by default.
 .SH TASKS
 .TP
 \fB\fCbinman\fR
-Runs the \fB\fCbinman:man\fR and \fB\fCbinman:web\fR tasks, in that order.
+Runs the \fB\fCbinman:mkd\fR, \fB\fCbinman:man\fR, and \fB\fCbinman:web\fR tasks, in that order.
 .TP
-\fB\fCbinman:mkd\fR
+\fB\fCbinman:mkd\fR or \fB\fCmkd\fR
 Extracts manual page sources embedded in scripts found in your \fB\fCbin/\fR
 directory and saves them as \fB\fCman/man1/*.1.markdown\fR files, which can
 then be rendered as HTML or UNIX manual pages using
 .BR md2man-rake (1).
 .TP
-\fB\fCbinman:man\fR
+\fB\fCbinman:man\fR or \fB\fCman\fR
 Builds UNIX manual pages from scripts found in your \fB\fCbin/\fR directory.
 It also runs the \fB\fCmd2man:man\fR task, provided by
 .BR md2man-rake (1),
@@ -43,7 +42,7 @@ which
 builds UNIX manual pages from \fB\fC*.markdown\fR, \fB\fC*.mkd\fR, and \fB\fC*.md\fR files
 found in or beneath the \fB\fCman/\fR subdirectory in your working directory.
 .TP
-\fB\fCbinman:web\fR
+\fB\fCbinman:web\fR or \fB\fCweb\fR
 Builds HTML manual pages from scripts found in your \fB\fCbin/\fR directory.
 It also runs the \fB\fCmd2man:web\fR task, provided by
 .BR md2man-rake (1),
@@ -52,8 +51,8 @@ builds HTML manual pages from \fB\fC*.markdown\fR, \fB\fC*.mkd\fR, and \fB\fC*.m
 found in or beneath the \fB\fCman/\fR subdirectory in your working directory.
 .SH OPTIONS
 .TP
-\fB\fC\-h\fR [\fIREGEXP\fP], \fB\fC\-\-help\fR [\fIREGEXP\fP]
-Show this help manual and search for \fIREGEXP\fP regular expression therein.
+\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
+Show this help manual and optionally search for \fIPATTERN\fP regular expression.
 .TP
 \&...
 Anything else is passed to
@@ -63,4 +62,4 @@ run \fB\fCrake \-\-help\fR for documentation.
 .PP
 .BR rake (1),
 .BR binman (1),
-.BR md2man-rake (1)
+.BR md2man-rake (1)

data/man/man1/binman-rake.1.html CHANGED

@@ -2,21 +2,21 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 5.0.1 https://github.com/sunaku/md2man" />
-  <title>binman-rake(1) &mdash; run rake(1) tasks from binman(1)</title>
+  <meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" />
+  <title>binman-rake(1) &mdash; run rake(1) tasks from command line</title>
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman-rake.1</span></div></div><div class="container-fluid"><h1 id="binman-rake-1-2016-02-13-5-0-1"><span class="md2man-title">BINMAN-RAKE</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-rake-1-2016-02-13-5-0-1" href="#binman-rake-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-rake - run <a class="md2man-reference">rake(1)</a> tasks from <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a></p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>binman-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" href="../man1/binman.1.html">binman(1)</a> without having
-to create a special file named <code>Rakefile</code> that contains the following snippet:</p><pre><code>require &#39;binman/rakefile&#39;
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman-rake.1</span></div></div><div class="container-fluid"><h1 id="binman-rake-1-2016-02-28-5-1-0"><span class="md2man-title">BINMAN-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="binman-rake-1-2016-02-28-5-1-0" href="#binman-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>binman-rake - run <a class="md2man-reference">rake(1)</a> tasks from command line</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>binman-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" href="../man1/binman.1.html">binman(1)</a> without having
+to create a special file named <code>Rakefile</code> that contains the following snippet:</p><pre class="highlight plaintext"><code>require 'binman/rakefile'
 </code></pre>
-<p>If no <em>TASK</em> is specified, then the <code>binman</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>binman</code></dt><dd>Runs the <code>binman:man</code> and <code>binman:web</code> tasks, in that order.</dd></dl><dl><dt><code>binman:mkd</code></dt><dd>Extracts manual page sources embedded in scripts found in your <code>bin/</code>
+<p>If no <em>TASK</em> is specified, then the <code>binman</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>binman</code></dt><dd>Runs the <code>binman:mkd</code>, <code>binman:man</code>, and <code>binman:web</code> tasks, in that order.</dd></dl><dl><dt><code>binman:mkd</code> or <code>mkd</code></dt><dd>Extracts manual page sources embedded in scripts found in your <code>bin/</code>
 directory and saves them as <code>man/man1/*.1.markdown</code> files, which can
-then be rendered as HTML or UNIX manual pages using <a class="md2man-reference">md2man-rake(1)</a>.</dd></dl><dl><dt><code>binman:man</code></dt><dd>Builds UNIX manual pages from scripts found in your <code>bin/</code> directory.
+then be rendered as HTML or UNIX manual pages using <a class="md2man-reference">md2man-rake(1)</a>.</dd></dl><dl><dt><code>binman:man</code> or <code>man</code></dt><dd>Builds UNIX manual pages from scripts found in your <code>bin/</code> directory.
 It also runs the <code>md2man:man</code> task, provided by <a class="md2man-reference">md2man-rake(1)</a>, which
 builds UNIX manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
-found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><dl><dt><code>binman:web</code></dt><dd>Builds HTML manual pages from scripts found in your <code>bin/</code> directory.
+found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><dl><dt><code>binman:web</code> or <code>web</code></dt><dd>Builds HTML manual pages from scripts found in your <code>bin/</code> directory.
 It also runs the <code>md2man:web</code> task, provided by <a class="md2man-reference">md2man-rake(1)</a>, which
 builds HTML manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
-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>REGEXP</em>], <code>--help</code> [<em>REGEXP</em>]</dt><dd>Show this help manual and search for <em>REGEXP</em> regular expression therein.</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/binman.1.html">binman(1)</a>, <a class="md2man-reference">md2man-rake(1)</a></p></div></body>
+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/binman.1.html">binman(1)</a>, <a class="md2man-reference">md2man-rake(1)</a></p></div></body>
 </html>

data/man/man1/binman-roff.1 ADDED

@@ -0,0 +1,23 @@
+.TH BINMAN\-ROFF 1                   2016\-02\-28                            5.1.0
+.SH NAME
+.PP
+binman\-roff \- UNIX manpage from header comment
+.SH SYNOPSIS
+.PP
+\fB\fCbinman\-roff\fR [\fIOPTION\fP]... [\fIFILE\fP]
+.SH DESCRIPTION
+.PP
+Extracts the "embedded manpage source", described in
+.BR binman-text (1),
+from the
+given \fIFILE\fP or STDIN and transforms it into
+.BR roff (7)
+for display by
+.BR man (1).
+.SH SEE ALSO
+.PP
+.BR binman-text (1),
+.BR binman-html (1),
+.BR binman (1),
+.BR roff (7),
+.BR man (1)

data/man/man1/binman-roff.1.html ADDED

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" />
+  <title>binman-roff(1) &mdash; UNIX manpage from header comment</title>
+  <link rel="stylesheet" href="../style.css"/>
+  <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
+</head>
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman-roff.1</span></div></div><div class="container-fluid"><h1 id="binman-roff-1-2016-02-28-5-1-0"><span class="md2man-title">BINMAN-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="binman-roff-1-2016-02-28-5-1-0" href="#binman-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>binman-roff - UNIX manpage from header comment</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>binman-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>Extracts the &quot;embedded manpage source&quot;, described in <a class="md2man-reference" href="../man1/binman-text.1.html">binman-text(1)</a>, from the
+given <em>FILE</em> or STDIN and transforms it into <a class="md2man-reference">roff(7)</a> for display by <a class="md2man-reference">man(1)</a>.</p><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-text.1.html">binman-text(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>, <a class="md2man-reference">roff(7)</a>, <a class="md2man-reference">man(1)</a></p></div></body>
+</html>

data/man/man1/binman-show.1 ADDED

@@ -0,0 +1,219 @@
+.TH BINMAN\-SHOW 1                 2016\-02\-28                            5.1.0
+.SH NAME
+.PP
+binman\-show \- show manpage from header comment
+.SH SYNOPSIS
+.PP
+\fB\fCbinman\-show\fR [\fIOPTION\fP]... [\fIFILE\fP] [\fIPATTERN\fP]
+.SH DESCRIPTION
+.PP
+Extracts the "embedded manpage source", described in
+.BR binman-text (1),
+from the
+given \fIFILE\fP or STDIN, transforms it into
+.BR roff (7),
+and displays it in
+.BR man (1).
+.PP
+If the optional \fIPATTERN\fP regular expression is specified, searches for it
+inside the output displayed by
+.BR man (1)
+and jumps to the first match if found.
+.PP
+If
+.BR man (1)
+cannot display the
+.BR roff (7)
+conversion, falls back to the displaying
+the HTML conversion. And if that fails too, displays the manpage source as\-is.
+.SS Examples
+.PP
+See "Embedded manpage sources" in
+.BR binman-text (1)
+for header comment syntax.
+.SS From a shell script
+.PP
+.RS
+.nf
+#!/usr/bin/sh
+# your program's manual page goes here
+binman\-show "$0"
+.fi
+.RE
+.SS From a Ruby script
+.PP
+.RS
+.nf
+#!/usr/bin/env ruby
+# your program's manual page goes here
+require 'binman'
+BinMan.show
+.fi
+.RE
+.PP
+You can also specify your program's source file encoding above the manual:
+.PP
+.RS
+.nf
+#!/usr/bin/env ruby
+# \-*\- coding: utf\-8 \-*\-
+# your program's manual page goes here
+.fi
+.RE
+.PP
+You can also write the manual as a multi\-line Ruby comment:
+.PP
+.RS
+.nf
+#!/usr/bin/env ruby
+=begin
+your program's manual page goes here
+=end
+.fi
+.RE
+.PP
+You can also specify your program's source file encoding above the manual:
+.PP
+.RS
+.nf
+#!/usr/bin/env ruby
+# \-*\- coding: utf\-8 \-*\-
+=begin
+your program's manual page goes here
+=end
+.fi
+.RE
+.SS From a Perl script
+.PP
+.RS
+.nf
+#!/usr/bin/env perl
+# your program's manual page goes here
+system('binman\-show', __FILE__);
+.fi
+.RE
+.PP
+You can also write the manual as a multi\-line Ruby comment after \fB\fC__END__\fR:
+.PP
+.RS
+.nf
+#!/usr/bin/env perl
+print "your program's code goes here";
+__END__
+=begin
+your program's manual page goes here
+=end
+.fi
+.RE
+.SS From a Python script
+.PP
+.RS
+.nf
+#!/usr/bin/env python
+# your program's manual page goes here
+import subprocess
+subprocess.call(['binman\-show', __file__])
+.fi
+.RE
+.PP
+You can also specify your program's source file encoding above the manual:
+.PP
+.RS
+.nf
+#!/usr/bin/env python
+# \-*\- coding: utf\-8 \-*\-
+# your program's manual page goes here
+.fi
+.RE
+.PP
+You can also write the manual as a multi\-line Ruby comment inside a docstring:
+.PP
+.RS
+.nf
+#!/usr/bin/env python
+"""
+=begin
+your program's manual page goes here
+=end
+"""
+.fi
+.RE
+.PP
+You can also specify your program's source file encoding above the manual:
+.PP
+.RS
+.nf
+#!/usr/bin/env python
+# \-*\- coding: utf\-8 \-*\-
+"""
+=begin
+your program's manual page goes here
+=end
+"""
+.fi
+.RE
+.SS From an AWK script
+.PP
+The technique for determining current AWK script file name comes from here \[la]http://www.mombu.com/programming/programming/t-the-name-of-script-itself-2040784-print.html\[ra]\&.
+.PP
+.RS
+.nf
+#!/usr/bin/awk \-f
+# your program's manual page goes here
+BEGIN {getline c <"/proc/self/cmdline"; sub(".*\-f\\0"," ",c); sub("\\0.*","",c);
+       system("binman\-show" c)}
+.fi
+.RE
+.SS From a Tcl script
+.PP
+.RS
+.nf
+#!/usr/bin/env tclsh
+# your program's manual page goes here
+exec >/dev/tty binman\-show $argv0
+.fi
+.RE
+.PP
+You can also write the manual as a multi\-line Ruby comment inside an \fB\fCif 0\fR:
+.PP
+.RS
+.nf
+#!/usr/bin/env tclsh
+if 0 {
+=begin
+your program's manual page goes here
+=end
+}
+.fi
+.RE
+.SS From a Node.js script
+.PP
+.RS
+.nf
+/*
+=begin
+your program's manual page goes here
+=end
+*/
+require('child_process').exec(['>/dev/tty', 'binman\-show', __filename].join(' '));
+.fi
+.RE
+.SH OPTIONS
+.TP
+\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
+Show this help manual and optionally search for \fIPATTERN\fP regular expression.
+.SH SEE ALSO
+.PP
+.BR binman-text (1),
+.BR binman-roff (1),
+.BR binman-html (1),
+.BR binman-help (1),
+.BR binman (1)

data/man/man1/binman-show.1.html ADDED

@@ -0,0 +1,104 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" />
+  <title>binman-show(1) &mdash; show manpage from header comment</title>
+  <link rel="stylesheet" href="../style.css"/>
+  <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
+</head>
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman-show.1</span></div></div><div class="container-fluid"><h1 id="binman-show-1-2016-02-28-5-1-0"><span class="md2man-title">BINMAN-SHOW</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-show-1-2016-02-28-5-1-0" href="#binman-show-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-show - show manpage from header comment</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>binman-show</code> [<em>OPTION</em>]... [<em>FILE</em>] [<em>PATTERN</em>]</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>Extracts the &quot;embedded manpage source&quot;, described in <a class="md2man-reference" href="../man1/binman-text.1.html">binman-text(1)</a>, from the
+given <em>FILE</em> or STDIN, transforms it into <a class="md2man-reference">roff(7)</a>, and displays it in <a class="md2man-reference">man(1)</a>.</p><p>If the optional <em>PATTERN</em> regular expression is specified, searches for it
+inside the output displayed by <a class="md2man-reference">man(1)</a> and jumps to the first match if found.</p><p>If <a class="md2man-reference">man(1)</a> cannot display the <a class="md2man-reference">roff(7)</a> conversion, falls back to the displaying
+the HTML conversion. And if that fails too, displays the manpage source as-is.</p><h3 id="examples">Examples<a name="examples" href="#examples" class="md2man-permalink" title="permalink"></a></h3><p>See &quot;Embedded manpage sources&quot; in <a class="md2man-reference" href="../man1/binman-text.1.html">binman-text(1)</a> for header comment syntax.</p><h4 id="from-a-shell-script">From a shell script<a name="from-a-shell-script" href="#from-a-shell-script" class="md2man-permalink" title="permalink"></a></h4><pre class="highlight shell"><code><span class="c">#!/usr/bin/sh</span>
+<span class="c"># your program's manual page goes here</span>
+binman-show <span class="s2">"</span><span class="nv">$0</span><span class="s2">"</span>
+</code></pre>
+<h4 id="from-a-ruby-script">From a Ruby script<a name="from-a-ruby-script" href="#from-a-ruby-script" class="md2man-permalink" title="permalink"></a></h4><pre class="highlight ruby"><code><span class="c1">#!/usr/bin/env ruby</span>
+<span class="c1"># your program's manual page goes here</span>
+<span class="nb">require</span> <span class="s1">'binman'</span>
+<span class="no">BinMan</span><span class="p">.</span><span class="nf">show</span>
+</code></pre>
+<p>You can also specify your program&#39;s source file encoding above the manual:</p><pre class="highlight ruby"><code><span class="c1">#!/usr/bin/env ruby</span>
+<span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="c1"># your program's manual page goes here</span>
+</code></pre>
+<p>You can also write the manual as a multi-line Ruby comment:</p><pre class="highlight ruby"><code><span class="c1">#!/usr/bin/env ruby</span>
+<span class="cm">=begin
+your program's manual page goes here
+=end</span>
+</code></pre>
+<p>You can also specify your program&#39;s source file encoding above the manual:</p><pre class="highlight ruby"><code><span class="c1">#!/usr/bin/env ruby</span>
+<span class="c1"># -*- coding: utf-8 -*-</span>
+<span class="cm">=begin
+your program's manual page goes here
+=end</span>
+</code></pre>
+<h4 id="from-a-perl-script">From a Perl script<a name="from-a-perl-script" href="#from-a-perl-script" class="md2man-permalink" title="permalink"></a></h4><pre class="highlight perl"><code><span class="c1">#!/usr/bin/env perl</span>
+<span class="c1"># your program's manual page goes here</span>
+<span class="nb">system</span><span class="p">(</span><span class="s">'binman-show'</span><span class="p">,</span> <span class="nv">__FILE__</span><span class="p">);</span>
+</code></pre>
+<p>You can also write the manual as a multi-line Ruby comment after <code>__END__</code>:</p><pre class="highlight perl"><code><span class="c1">#!/usr/bin/env perl</span>
+<span class="k">print</span> <span class="s">"your program's code goes here"</span><span class="p">;</span>
+<span class="cp">__END__
+=begin
+your program's manual page goes here
+=end
+</span></code></pre>
+<h4 id="from-a-python-script">From a Python script<a name="from-a-python-script" href="#from-a-python-script" class="md2man-permalink" title="permalink"></a></h4><pre class="highlight python"><code><span class="c">#!/usr/bin/env python</span>
+<span class="c"># your program's manual page goes here</span>
+<span class="kn">import</span> <span class="nn">subprocess</span>
+<span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">([</span><span class="s">'binman-show'</span><span class="p">,</span> <span class="n">__file__</span><span class="p">])</span>
+</code></pre>
+<p>You can also specify your program&#39;s source file encoding above the manual:</p><pre class="highlight python"><code><span class="c">#!/usr/bin/env python</span>
+<span class="c"># -*- coding: utf-8 -*-</span>
+<span class="c"># your program's manual page goes here</span>
+</code></pre>
+<p>You can also write the manual as a multi-line Ruby comment inside a docstring:</p><pre class="highlight python"><code><span class="c">#!/usr/bin/env python</span>
+<span class="s">"""
+=begin
+your program's manual page goes here
+=end
+"""</span>
+</code></pre>
+<p>You can also specify your program&#39;s source file encoding above the manual:</p><pre class="highlight python"><code><span class="c">#!/usr/bin/env python</span>
+<span class="c"># -*- coding: utf-8 -*-</span>
+<span class="s">"""
+=begin
+your program's manual page goes here
+=end
+"""</span>
+</code></pre>
+<h4 id="from-an-awk-script">From an AWK script<a name="from-an-awk-script" href="#from-an-awk-script" class="md2man-permalink" title="permalink"></a></h4><p>The technique for determining current AWK script file name <a href="http://www.mombu.com/programming/programming/t-the-name-of-script-itself-2040784-print.html">comes from here</a>.</p><pre class="highlight plaintext"><code>#!/usr/bin/awk -f
+# your program's manual page goes here
+BEGIN {getline c &lt;"/proc/self/cmdline"; sub(".*-f\0"," ",c); sub("\0.*","",c);
+       system("binman-show" c)}
+</code></pre>
+<h4 id="from-a-tcl-script">From a Tcl script<a name="from-a-tcl-script" href="#from-a-tcl-script" class="md2man-permalink" title="permalink"></a></h4><pre class="highlight tcl"><code><span class="c1">#!/usr/bin/env tclsh</span>
+<span class="c1"># your program's manual page goes here</span>
+<span class="nb">exec</span> &gt;/dev/tty binman-show <span class="nv">$argv0</span>
+</code></pre>
+<p>You can also write the manual as a multi-line Ruby comment inside an <code>if 0</code>:</p><pre class="highlight tcl"><code><span class="c1">#!/usr/bin/env tclsh</span>
+<span class="k">if</span> 0 <span class="p">{</span>
+=begin
+your program's manual page goes here
+=end
+<span class="p">}</span>
+</code></pre>
+<h4 id="from-a-node-js-script">From a Node.js script<a name="from-a-node-js-script" href="#from-a-node-js-script" class="md2man-permalink" title="permalink"></a></h4><pre class="highlight javascript"><code><span class="cm">/*
+=begin
+your program's manual page goes here
+=end
+*/</span>
+<span class="nx">require</span><span class="p">(</span><span class="s1">'child_process'</span><span class="p">).</span><span class="nx">exec</span><span class="p">([</span><span class="s1">'&gt;/dev/tty'</span><span class="p">,</span> <span class="s1">'binman-show'</span><span class="p">,</span> <span class="nx">__filename</span><span class="p">].</span><span class="nx">join</span><span class="p">(</span><span class="s1">' '</span><span class="p">));</span>
+</code></pre>
+<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/binman-text.1.html">binman-text(1)</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-help.1.html">binman-help(1)</a>, <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a></p></div></body>
+</html>