gem-man 0.1.1 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
data/README.md CHANGED
@@ -18,6 +18,13 @@ installed RubyGem. The man page must be included with the gem -
18
18
  For an introduction to man pages, see `man(1)` (or type `man man` in
19
19
  your shell).
20
20
 
21
+ ## QUICKSTART
22
+
23
+ gem install gem-man
24
+ gem man gem-man
25
+
26
+ Metalicious.
27
+
21
28
  ## GEM
22
29
 
23
30
  `gem man` expects to be passed the name of an installed gem. If there
@@ -69,6 +76,13 @@ See `gem help man` to view the options at any time.
69
76
  gem man 1 ron
70
77
  gem man -a
71
78
 
79
+ ## AUTHORING
80
+
81
+ For information on authoring man pages, see [`ron(7)`][r7]:
82
+
83
+ gem install ron
84
+ gem man 7 ron
85
+
72
86
  ## BUGS
73
87
 
74
88
  Requires the `man(1)` script to be in your path, executable, and to
@@ -76,7 +90,7 @@ accept a full path to a manual.
76
90
 
77
91
  Requires Ruby and RubyGems 1.3.2 (or higher).
78
92
 
79
- Please report other bugs at <http://github.com/defunkt/gem-man>
93
+ Please report other bugs at <http://github.com/defunkt/gem-man/issues>
80
94
 
81
95
  ## THANKS
82
96
 
@@ -90,6 +104,8 @@ Sanderson.
90
104
 
91
105
  ## SEE ALSO
92
106
 
93
- ron(5), man(1), less(1), roff(7), groff(1),
107
+ ron(7), man(1), less(1), roff(7), groff(1),
94
108
  <http://en.wikipedia.org/wiki/Man_page>,
95
109
  <http://github.com/defunkt/gem-man>
110
+
111
+ [r7]: http://rtomayko.github.com/ron/
data/Rakefile CHANGED
@@ -14,3 +14,19 @@ begin
14
14
  rescue Loaderror
15
15
  warn "gem install mg to get gem tasks"
16
16
  end
17
+
18
+ desc "Ship to GitHub pages"
19
+ task :pages => :build_man do
20
+ `rm -rf htmls`
21
+ mkdir "htmls"
22
+ `cp man/*.html htmls`
23
+ `git checkout gh-pages`
24
+ `mv htmls/* .`
25
+ rm_rf "htmls"
26
+ `mv gem-man.1.html index.html`
27
+ `git add .`
28
+ `git commit -m updated`
29
+ `git push origin gh-pages`
30
+ `git checkout master`
31
+ puts :done
32
+ end
@@ -1,4 +1,5 @@
1
1
  require 'rubygems/command_manager'
2
+ require "rubygems/version_option"
2
3
  require 'rubygems/gem/specification'
3
4
 
4
5
  Gem::CommandManager.instance.register_command :man
@@ -26,6 +26,18 @@ installed RubyGem. The man page must be included with the gem \- \fBgem-man\fR d
26
26
  For an introduction to man pages, see \fBman(1)\fR (or type \fBman man\fR in
27
27
  your shell).
28
28
  .
29
+ .SH "QUICKSTART"
30
+ .
31
+ .nf
32
+
33
+ \fBgem install gem-man
34
+ gem man gem-man \fR
35
+ .
36
+ .fi
37
+ .
38
+ .P
39
+ Metalicious.
40
+ .
29
41
  .SH "GEM"
30
42
  \fBgem man\fR expects to be passed the name of an installed gem. If there
31
43
  are multiple man pages found for the gem, you will be asked which
@@ -89,6 +101,20 @@ gem man -a \fR
89
101
  .
90
102
  .fi
91
103
  .
104
+ .SH "AUTHORING"
105
+ For information on authoring man pages, see \fI\fBron(7)\fR\fR:
106
+ .
107
+ .IP "" 4
108
+ .
109
+ .nf
110
+
111
+ \fBgem install ron
112
+ gem man 7 ron \fR
113
+ .
114
+ .fi
115
+ .
116
+ .IP "" 0
117
+ .
92
118
  .SH "BUGS"
93
119
  Requires the \fBman(1)\fR script to be in your path, executable, and to
94
120
  accept a full path to a manual.
@@ -97,7 +123,7 @@ accept a full path to a manual.
97
123
  Requires Ruby and RubyGems 1.3.2 (or higher).
98
124
  .
99
125
  .P
100
- Please report other bugs at \fIhttp://github.com/defunkt/gem\-man\fR
126
+ Please report other bugs at \fIhttp://github.com/defunkt/gem\-man/issues\fR
101
127
  .
102
128
  .SH "THANKS"
103
129
  .
@@ -114,4 +140,4 @@ gem\-man is Copyright (C) 2010 Chris Wanstrath with parts from Adam
114
140
  Sanderson.
115
141
  .
116
142
  .SH "SEE ALSO"
117
- ron(5), man(1), less(1), roff(7), groff(1),\fIhttp://en.wikipedia.org/wiki/Man_page\fR, \fIhttp://github.com/defunkt/gem\-man\fR
143
+ ron(7), man(1), less(1), roff(7), groff(1),\fIhttp://en.wikipedia.org/wiki/Man_page\fR, \fIhttp://github.com/defunkt/gem\-man\fR
@@ -82,6 +82,14 @@ installed RubyGem. The man page must be included with the gem -
82
82
  <p>For an introduction to man pages, see <code>man(1)</code> (or type <code>man man</code> in
83
83
  your shell).</p>
84
84
 
85
+ <h2>QUICKSTART</h2>
86
+
87
+ <pre><code>gem install gem-man
88
+ gem man gem-man
89
+ </code></pre>
90
+
91
+ <p>Metalicious.</p>
92
+
85
93
  <h2>GEM</h2>
86
94
 
87
95
  <p><code>gem man</code> expects to be passed the name of an installed gem. If there
@@ -143,6 +151,14 @@ gem man 1 ron
143
151
  gem man -a
144
152
  </code></pre>
145
153
 
154
+ <h2>AUTHORING</h2>
155
+
156
+ <p>For information on authoring man pages, see <a href="http://rtomayko.github.com/ron/"><code>ron(7)</code></a>:</p>
157
+
158
+ <pre><code>gem install ron
159
+ gem man 7 ron
160
+ </code></pre>
161
+
146
162
  <h2>BUGS</h2>
147
163
 
148
164
  <p>Requires the <code>man(1)</code> script to be in your path, executable, and to
@@ -150,7 +166,7 @@ accept a full path to a manual.</p>
150
166
 
151
167
  <p>Requires Ruby and RubyGems 1.3.2 (or higher).</p>
152
168
 
153
- <p>Please report other bugs at <a href="http://github.com/defunkt/gem-man">http://github.com/defunkt/gem-man</a></p>
169
+ <p>Please report other bugs at <a href="http://github.com/defunkt/gem-man/issues">http://github.com/defunkt/gem-man/issues</a></p>
154
170
 
155
171
  <h2>THANKS</h2>
156
172
 
@@ -167,7 +183,7 @@ Sanderson.</p>
167
183
 
168
184
  <h2>SEE ALSO</h2>
169
185
 
170
- <p>ron(5), man(1), less(1), roff(7), groff(1),
186
+ <p>ron(7), man(1), less(1), roff(7), groff(1),
171
187
  <a href="http://en.wikipedia.org/wiki/Man_page">http://en.wikipedia.org/wiki/Man_page</a>,
172
188
  <a href="http://github.com/defunkt/gem-man">http://github.com/defunkt/gem-man</a></p>
173
189
 
@@ -18,6 +18,13 @@ installed RubyGem. The man page must be included with the gem -
18
18
  For an introduction to man pages, see `man(1)` (or type `man man` in
19
19
  your shell).
20
20
 
21
+ ## QUICKSTART
22
+
23
+ gem install gem-man
24
+ gem man gem-man
25
+
26
+ Metalicious.
27
+
21
28
  ## GEM
22
29
 
23
30
  `gem man` expects to be passed the name of an installed gem. If there
@@ -69,6 +76,13 @@ See `gem help man` to view the options at any time.
69
76
  gem man 1 ron
70
77
  gem man -a
71
78
 
79
+ ## AUTHORING
80
+
81
+ For information on authoring man pages, see [`ron(7)`][r7]:
82
+
83
+ gem install ron
84
+ gem man 7 ron
85
+
72
86
  ## BUGS
73
87
 
74
88
  Requires the `man(1)` script to be in your path, executable, and to
@@ -76,7 +90,7 @@ accept a full path to a manual.
76
90
 
77
91
  Requires Ruby and RubyGems 1.3.2 (or higher).
78
92
 
79
- Please report other bugs at <http://github.com/defunkt/gem-man>
93
+ Please report other bugs at <http://github.com/defunkt/gem-man/issues>
80
94
 
81
95
  ## THANKS
82
96
 
@@ -90,6 +104,8 @@ Sanderson.
90
104
 
91
105
  ## SEE ALSO
92
106
 
93
- ron(5), man(1), less(1), roff(7), groff(1),
107
+ ron(7), man(1), less(1), roff(7), groff(1),
94
108
  <http://en.wikipedia.org/wiki/Man_page>,
95
109
  <http://github.com/defunkt/gem-man>
110
+
111
+ [r7]: http://rtomayko.github.com/ron/
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gem-man
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Chris Wanstrath