Merge pull request defunkt#51 from sam7wx/master

Updated man page for an option
ku1ik · Jun 11, 2011 · 627ac48 · 627ac48
2 parents 0790ed6 + 50dc67d
commit 627ac48
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 11 deletions.
diff --git a/man/gist.1 b/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
 .

diff --git a/man/gist.1.html b/man/gist.1.html
diff --git a/man/gist.1.ron b/man/gist.1.ron
@@ -22,18 +22,22 @@ 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:
 
   * `-p`, `--private`:
     Create a private gist instead of a public gist.
 
   * `-t`, `--type`:
-    Set the file extension explicitly. Passing a type of `rb` ensure
+    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
@@ -50,7 +54,7 @@ You may additionally ask for help:
 
 There are two ways to set GitHub user and token info:
 
-  * Using env vars GITHUB_USER and GITHUB_TOKEN
+  * Using environment vars GITHUB_USER and GITHUB_TOKEN
 
     $ export GITHUB_USER=johndoe  
     $ export GITHUB_TOKEN=mysecretgithubtoken