Permalink
Browse files

Updated man page for -d option

  • Loading branch information...
1 parent 230e846 commit 50dc67dce9ec2235ad1c43f11364c0880eda6c2d sam7wx committed Jun 11, 2011
Showing with 17 additions and 7 deletions.
  1. +6 −2 man/gist.1
  2. +5 −3 man/gist.1.html
  3. +6 −2 man/gist.1.ron
View
8 man/gist.1
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "GIST" "1" "May 2011" "GITHUB" "Gist Manual"
+.TH "GIST" "1" "June 2011" "GITHUB" "Gist Manual"
.
.SH "NAME"
\fBgist\fR \- gist on the command line
@@ -19,7 +19,7 @@ If standard input is supplied, it will be used as the content of the new gist\.
Once your gist is successfully created, the URL will be copied to your clipboard\. If you are on OS X, \fBgist\fR will open the gist in your browser, too\.
.
.SH "OPTIONS"
-\fBgist\fR\'s default mode of operation is to read content from standard input and create a public, text gist from it, tied to your GitHub account if you user and token are provided (see \fBCONFIGURATION\fR)\.
+\fBgist\fR\'s default mode of operation is to read content from standard input and create a public, text gist without description from it, tied to your GitHub account if you user and token are provided (see \fBCONFIGURATION\fR)\.
.
.P
These options can be used to change this behavior:
@@ -33,6 +33,10 @@ Create a private gist instead of a public gist\.
Set the file extension explicitly\. Passing a type of \fBrb\fR ensures the gist is created as a Ruby file\.
.
.TP
+\fB\-d\fR, \fB\-\-description\fR
+Set a description\.
+.
+.TP
\fB\-o\fR, \fB\-\-[no\-]open\fR
Open the gist in your browser after creation\. Or don\'t\. Defaults to \-\-open
.
View
8 man/gist.1.html
@@ -98,15 +98,17 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<h2 id="OPTIONS">OPTIONS</h2>
<p><code>gist</code>'s default mode of operation is to read content from standard
-input and create a public, text gist from it, tied to your GitHub
-account if you user and token are provided (see <code>CONFIGURATION</code>).</p>
+input and create a public, text gist without description from it, tied
+to your GitHub account if you user and token are provided (see
+<code>CONFIGURATION</code>).</p>
<p>These options can be used to change this behavior:</p>
<dl>
<dt><code>-p</code>, <code>--private</code></dt><dd><p>Create a private gist instead of a public gist.</p></dd>
<dt><code>-t</code>, <code>--type</code></dt><dd><p>Set the file extension explicitly. Passing a type of <code>rb</code> ensures
the gist is created as a Ruby file.</p></dd>
+<dt><code>-d</code>, <code>--description</code></dt><dd><p>Set a description.</p></dd>
<dt><code>-o</code>, <code>--[no-]open</code></dt><dd><p>Open the gist in your browser after creation. Or don't. Defaults
to --open</p></dd>
</dl>
@@ -198,7 +200,7 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
<ol class='man-decor man-foot man foot'>
<li class='tl'>GITHUB</li>
- <li class='tc'>May 2011</li>
+ <li class='tc'>June 2011</li>
<li class='tr'>gist(1)</li>
</ol>
View
8 man/gist.1.ron
@@ -22,8 +22,9 @@ browser, too.
## OPTIONS
`gist`'s default mode of operation is to read content from standard
-input and create a public, text gist from it, tied to your GitHub
-account if you user and token are provided (see `CONFIGURATION`).
+input and create a public, text gist without description from it, tied
+to your GitHub account if you user and token are provided (see
+`CONFIGURATION`).
These options can be used to change this behavior:
@@ -34,6 +35,9 @@ These options can be used to change this behavior:
Set the file extension explicitly. Passing a type of `rb` ensures
the gist is created as a Ruby file.
+ * `-d`, `--description`:
+ Set a description.
+
* `-o`, `--[no-]open`:
Open the gist in your browser after creation. Or don't. Defaults
to --open

0 comments on commit 50dc67d

Please sign in to comment.