binman 3.2.1 → 3.3.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 (20) hide show
  1. checksums.yaml +7 -0
  2. data/README.markdown +15 -4
  3. data/{HISTORY.markdown → VERSION.markdown} +16 -0
  4. data/bin/binman +3 -3
  5. data/bin/binman-rake +62 -0
  6. data/binman.gemspec +5 -1
  7. data/lib/binman.rb +19 -6
  8. data/lib/binman/rakefile.rb +0 -2
  9. data/lib/binman/version.rb +1 -1
  10. data/man/index.html +11 -0
  11. data/man/man0/README.html +198 -0
  12. data/man/man0/README.markdown +254 -0
  13. data/man/man0/VERSION.html +157 -0
  14. data/man/man0/VERSION.markdown +199 -0
  15. data/man/man1/binman-rake.1 +57 -0
  16. data/man/man1/binman-rake.1.html +21 -0
  17. data/man/man1/binman.1 +3 -3
  18. data/man/man1/binman.1.html +51 -0
  19. data/man/style.css +57 -0
  20. metadata +43 -24
data/man/man1/binman.1.html ADDED
@@ -0,0 +1,51 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <meta name="generator" content="md2man 2.0.0 https://github.com/sunaku/md2man" />
6
+ <title>binman(1) &mdash; man pages for bin scripts</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.1</span></div></div><div class="container-fluid"><h1 id="BINMAN-1-2013-05-08-3-3-0">BINMAN 1 2013-05-08 3.3.0</h1><h2 id="NAME">NAME</h2><p>binman - man pages for bin scripts</p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>binman</code> [<em>OPTION</em>]... <em>COMMAND</em></p><h2 id="DESCRIPTION">DESCRIPTION</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-xref">markdown(7)</a> into <a class="md2man-xref">roff(7)</a> using <a href="https://github.com/sunaku/md2man">md2man</a>, and display them using <a class="md2man-xref">man(1)</a>.</p><h3 id="Leading-comment-headers">Leading comment headers</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</h3><p>Although your leading comment headers are written in <a class="md2man-xref">markdown(7)</a>, <code>binman
24
+ conv</code> inherits the following additions to <a class="md2man-xref">markdown(7)</a> syntax from <a href="https://github.com/sunaku/md2man">md2man</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-xref">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-xref">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-xref">roff(7)</a> output.</p></li>
34
+ </ul>
35
+ <h3 id="Markdown-processing-extensions">Markdown processing extensions</h3><p>The following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> extensions are enabled while processing <a class="md2man-xref">markdown(7)</a>:</p>
36
+ <ul>
37
+ <li>tables</li>
38
+ <li>autolink</li>
39
+ <li>superscript</li>
40
+ <li>strikethrough</li>
41
+ <li>no_intra_emphasis</li>
42
+ <li>fenced_code_blocks</li>
43
+ </ul>
44
+ <h2 id="OPTIONS">OPTIONS</h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><h2 id="COMMANDS">COMMANDS</h2><dl><dt><code>help</code> <em>FILE</em> [<em>ARGUMENT</em>]...</dt><dd>If the given <em>ARGUMENT</em> sequence contains <code>-h</code> or <code>--help</code> except after
45
+ <code>--</code>, then this program extracts the given <em>FILE</em>&#39;s leading comment header,
46
+ converts it into <a class="md2man-xref">roff(7)</a>, and displays it using <a class="md2man-xref">man(1)</a> before exiting with
47
+ status code <code>0</code>. Otherwise, this program exits with status code <code>111</code>.</dd></dl><dl><dt><code>show</code> [<em>FILE</em>]</dt><dd>Use <a class="md2man-xref">man(1)</a> to display the <a class="md2man-xref">roff(7)</a> conversion of the leading comment header
48
+ extracted from the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>load</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>dump</code> [<em>FILE</em>]</dt><dd>Print the <a class="md2man-xref">roff(7)</a> conversion of the leading comment header extracted from
49
+ the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>conv</code> [<em>FILE</em>]</dt><dd>Print the <a class="md2man-xref">roff(7)</a> conversion of the <a class="md2man-xref">markdown(7)</a> document read from the given
50
+ <em>FILE</em> or STDIN.</dd></dl><h2 id="SEE-ALSO">SEE ALSO</h2><p><a class="md2man-xref">man(1)</a>, <a class="md2man-xref">roff(7)</a>, <a class="md2man-xref">markdown(7)</a></p></div></body>
51
+ </html>
data/man/style.css ADDED
@@ -0,0 +1,57 @@
1
+ @import url('http://twitter.github.com/bootstrap/assets/css/bootstrap.css');
2
+
3
+ @media all {
4
+ h1,
5
+ h2,
6
+ h3,
7
+ h4,
8
+ h5,
9
+ h6 {
10
+ margin-top: 1em;
11
+ }
12
+
13
+ /* deactivate external manual page cross-references */
14
+ a.md2man-xref:not([href]) {
15
+ color: inherit;
16
+ text-decoration: none;
17
+ }
18
+ }
19
+
20
+ @media screen {
21
+ body {
22
+ font-family: monospace;
23
+ text-align: justify;
24
+ max-width: 83ex; /* allots 78ex width for manpage */
25
+ margin: auto;
26
+ }
27
+
28
+ h1:first-child {
29
+ margin-top: -5em;
30
+ font-weight: normal;
31
+ font-size: smaller;
32
+ text-align: right;
33
+ }
34
+ }
35
+
36
+ @media print {
37
+ .navbar:first-child {
38
+ display: none;
39
+ }
40
+
41
+ /* improve readability of revealed hyperlink URLs */
42
+ a:after {
43
+ font-family: monospace;
44
+ }
45
+
46
+ /* internal links and manual page cross-references */
47
+ a[href^='#'], a[href^='../man'] {
48
+ color: inherit;
49
+ font-weight: bolder;
50
+ text-decoration: none;
51
+ }
52
+
53
+ /* undo bootstrap's revealing of those hyperlinks */
54
+ a[href^='#']:after, a[href^='../man']:after {
55
+ content: none;
56
+ }
57
+ }
metadata CHANGED
@@ -1,38 +1,54 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: binman
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.2.1
5
- prerelease:
4
+ version: 3.3.0
6
5
  platform: ruby
7
6
  authors:
8
7
  - Suraj N. Kurapati
9
8
  autorequire:
10
9
  bindir: bin
11
10
  cert_chain: []
12
- date: 2013-05-05 00:00:00.000000000 Z
11
+ date: 2013-05-08 00:00:00.000000000 Z
13
12
  dependencies:
14
13
  - !ruby/object:Gem::Dependency
15
14
  name: md2man
16
15
  requirement: !ruby/object:Gem::Requirement
17
- none: false
18
16
  requirements:
19
17
  - - ~>
20
18
  - !ruby/object:Gem::Version
21
- version: '1.4'
19
+ version: '2.0'
22
20
  type: :development
23
21
  prerelease: false
24
22
  version_requirements: !ruby/object:Gem::Requirement
25
- none: false
26
23
  requirements:
27
24
  - - ~>
28
25
  - !ruby/object:Gem::Version
29
- version: '1.4'
26
+ version: '2.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: opener
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - '>='
32
+ - !ruby/object:Gem::Version
33
+ version: 0.1.0
34
+ - - <
35
+ - !ruby/object:Gem::Version
36
+ version: '1'
37
+ type: :runtime
38
+ prerelease: false
39
+ version_requirements: !ruby/object:Gem::Requirement
40
+ requirements:
41
+ - - '>='
42
+ - !ruby/object:Gem::Version
43
+ version: 0.1.0
44
+ - - <
45
+ - !ruby/object:Gem::Version
46
+ version: '1'
30
47
  - !ruby/object:Gem::Dependency
31
48
  name: rake
32
49
  requirement: !ruby/object:Gem::Requirement
33
- none: false
34
50
  requirements:
35
- - - ! '>='
51
+ - - '>='
36
52
  - !ruby/object:Gem::Version
37
53
  version: 0.9.2.2
38
54
  - - <
@@ -41,9 +57,8 @@ dependencies:
41
57
  type: :development
42
58
  prerelease: false
43
59
  version_requirements: !ruby/object:Gem::Requirement
44
- none: false
45
60
  requirements:
46
- - - ! '>='
61
+ - - '>='
47
62
  - !ruby/object:Gem::Version
48
63
  version: 0.9.2.2
49
64
  - - <
@@ -54,49 +69,53 @@ email:
54
69
  - sunaku@gmail.com
55
70
  executables:
56
71
  - binman
72
+ - binman-rake
57
73
  extensions: []
58
74
  extra_rdoc_files: []
59
75
  files:
60
76
  - .gitignore
61
77
  - Gemfile
62
- - HISTORY.markdown
63
78
  - LICENSE
64
79
  - README.markdown
65
80
  - Rakefile
81
+ - VERSION.markdown
66
82
  - bin/binman
83
+ - bin/binman-rake
67
84
  - binman.gemspec
68
85
  - lib/binman.rb
69
86
  - lib/binman/rakefile.rb
70
87
  - lib/binman/version.rb
88
+ - man/man0/README.markdown
89
+ - man/man0/VERSION.markdown
90
+ - man/man1/binman-rake.1
71
91
  - man/man1/binman.1
92
+ - man/index.html
93
+ - man/man0/VERSION.html
94
+ - man/man0/README.html
95
+ - man/man1/binman.1.html
96
+ - man/man1/binman-rake.1.html
97
+ - man/style.css
72
98
  homepage: http://github.com/sunaku/binman
73
99
  licenses: []
100
+ metadata: {}
74
101
  post_install_message:
75
102
  rdoc_options: []
76
103
  require_paths:
77
104
  - lib
78
105
  required_ruby_version: !ruby/object:Gem::Requirement
79
- none: false
80
106
  requirements:
81
- - - ! '>='
107
+ - - '>='
82
108
  - !ruby/object:Gem::Version
83
109
  version: '0'
84
- segments:
85
- - 0
86
- hash: 4129154958439912478
87
110
  required_rubygems_version: !ruby/object:Gem::Requirement
88
- none: false
89
111
  requirements:
90
- - - ! '>='
112
+ - - '>='
91
113
  - !ruby/object:Gem::Version
92
114
  version: '0'
93
- segments:
94
- - 0
95
- hash: 4129154958439912478
96
115
  requirements: []
97
116
  rubyforge_project:
98
- rubygems_version: 1.8.25
117
+ rubygems_version: 2.0.0
99
118
  signing_key:
100
- specification_version: 3
119
+ specification_version: 4
101
120
  summary: man pages for bin scripts
102
121
  test_files: []