tumblr.1 in tumblr-rb-2.0.0.alpha

- old
+ new
@@ -1,159 +1,161 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "TUMBLR" "1" "March 2010" "Mark Wunsch" "Tumblr Manual"
+.TH "TUMBLR" "1" "October 2012" "Mark Wunsch" "Tumblr Manual"
 .
 .SH "NAME"
-\fBtumblr\fR \-\- publish to tumblr.com
+\fBtumblr\fR \- publish to tumblr\.com
 .
 .SH "SYNOPSIS"
-\fBtumblr\fR [\fIOPTIONS\fR] \fIFILE OR URL\fR
+\fBtumblr\fR COMMAND [ARGS]
 .
 .SH "DESCRIPTION"
-\fBtumblr\fR is a command line utility and Ruby library for working with Tumblr.com. It can read plain\-text files and publish them to Tumblr.
+\fBtumblr\fR is a command line utility and Ruby library for working with Tumblr\.com\. It can read plain\-text and binary files and publish them to Tumblr\.
 .
 .P
-The \fBtumblr\fR command will publish a named input \fIFILE\fR (or Standard Input if no file is given), or if a \fIURL\fR is given it will publish that URL as a Link post (or a Video post if the url is a YouTube or Vimeo post).
+\fBtumblr\fR is driven through a group of \fICOMMANDS\fR (similar to \fBgit\fR or \fBrbenv\fR)\.
 .
 .P
-If you preface your \fIFILE\fR with a bit of YAML (<yaml.org>) frontmatter, you can give \fBtumblr\fR more explicit instructions for publishing your post. See tumblr(5) for available YAML parameters.
+If you preface your plaintext file with a bit of YAML (<yaml\.org>) frontmatter, you can give \fBtumblr\fR more explicit instructions for how to publish your post\. See tumblr(5) for available YAML parameters\.
 .
-.SH "OPTIONS"
+.SH "COMMANDS"
 .
 .TP
-\fB\-a\fR,\fB\-\-auth\fR \fIEMAIL:PASSWORD\fR
-  Provide Email Address and Password, to authenticate to Tumblr, separated by a colon.
-  If these are not provided, you will be prompted for them.
-  You \fBmust\fR provide this or the \fB\-\-credentials\fR argument if the post comes from standard input.
+\fBtumblr post\fR \fIPOST\fR | \fIFILE\fR | \fIURL\fR
+Post to tumblr\. A \fIPOST\fR is a piece of plaintext, assumed to be formatted as \fBtumblr(5)\fR\. \fIFILE\fR is a path to a \fIPOST\fR\. If \fIFILE\fR has a binary extension, that file will be uploaded as an image, audio, or video post\. \fIURL\fR will create a link\-type post, or a video or audio post, depending on the location of the url\.
 .
 .TP
-\fB\-e\fR, \fB\-\-email\fR \fIEMAIL\fR
-  Email Address associated with your Tumblr account.
-  You will be prompted for a password.
+\fBtumblr pipe\fR
+Read from STDIN and post to tumblr\.
 .
 .TP
-\fB\-\-credentials\fR \fIFILE\fR
-  A YAML file with the user credentials. Should have keys \fBemail\fR and \fBpassword\fR.
+\fBtumblr edit\fR \fIPOST_ID\fR
+Edit \fIPOST_ID\fR on tumblr\. Will open the serialized post in the foreground with $TUMBLREDITOR then $EDITOR\.
 .
 .TP
-\fB\-p\fR,\fB\-\-publish\fR
-  Publish the post immediately. This will ignore the \fBstate\fR parameter set in the post.
+\fBtumblr fetch\fR \fIPOST_ID\fR
+Fetch \fIPOST_ID\fR from tumblr and write out its serialized form\.
 .
 .TP
-\fB\-q\fR,\fB\-\-queue\fR
-  Add the post to the queue.
+\fBtumblr delete\fR \fIPOST_ID\fR
+Delete \fIPOST_ID\fR from tumblr\.
 .
 .TP
-\fB\-d\fR,\fB\-\-draft\fR
-  Save the post as a draft.
+\fBtumblr help\fR [\fITASK\fR]
+Print the help message and the description for \fITASK\fR\.
 .
 .TP
-\fB\-\-group\fR=\fIGROUP\fR
-  Publish the post to a \fIGROUP\fR tumblelog.
+\fBtumblr authorize\fR
+Start a web server and application to authenticate to tumblr and authorize the cli\. See \fIAUTHORIZATION\fR
 .
-.P
-Other:
+.TP
+\fBtumblr version\fR
+Print the \fBtumblr\fR version and quit\.
 .
+.SH "POSTING OPTIONS"
+These options are used when posting to tumblr, i\.e\. when using \fBtumblr post\fR or \fBtumblr pipe\fR\.
+.
 .TP
-\fB\-h\fR, \fB\-\-help\fR
-  Print the help message and quit.
+\fB\-p\fR,\fB\-\-publish\fR
+Publish this post (ignoring the \fBstate\fR parameter set in the post)\.
 .
 .TP
-\fB\-v\fR, \fB\-\-version\fR
-  Print the \fBtumblr\fR version and quit.
+\fB\-q\fR,\fB\-\-queue\fR
+Add this post to the queue\.
 .
-.SH "EXAMPLES"
-Publish a file to Tumblr.com:
+.TP
+\fB\-d\fR,\fB\-\-draft\fR
+Save this post as a draft\.
 .
-.IP "" 4
+.SH "COMMON OPTIONS"
 .
-.nf
-$ tumblr my_post.txt
+.TP
+\fB\-\-credentials\fR=\fIPATH\fR
+The file where your OAuth keys are stored\. When authenticating, this path is where the keys should be stored\.
 .
-.fi
+.TP
+\fB\-\-host\fR=\fIHOST\fR
+The hostname of the Tumblr account your posting to\. Posting and fetching posts require the hostname\.
 .
-.IP "" 0
+.SH "AUTHORIZATION"
+Most actions of the cli require authorization to Tumblr\. \fBtumblr authorize\fR provides a mechanism to authenticate and authorize the cli\.
 .
 .P
-Or from standard input:
+In order to use \fBtumblr\fR, you first need to register \fIhttp://www\.tumblr\.com/oauth/apps\fR an OAuth application with tumblr\.
 .
-.IP "" 4
-.
-.nf
-$ cat data.yml my_post.txt | tumblr \-a tumblr_user@foobar.com:p4ssw0rd
-.
-.fi
-.
-.IP "" 0
-.
 .P
-Make a Link post:
+Run \fBtumblr authorize\fR to start up server, and type in the consumer key and secret\. You\'ll then be asked to authorize the app\. These keys are saved to the file noted in \fB\-\-credentials\fR, defaulting to \fB~/\.tumblr\fR\. If you choose not to use this default, you will need to enter the \fB\-\-credentials\fR option every time you post\. Alternatively, use the \fB$TUMBLRCRED\fR environment variable\.
 .
+.SH "EXAMPLES"
+Publish a file to Tumblr\.com:
+.
 .IP "" 4
 .
 .nf
-$ tumblr http://github.com/mwunsch/tumblr
+
+$ tumblr post my_post\.txt
 .
 .fi
 .
 .IP "" 0
 .
 .P
-Or a Video post:
+Or from standard input:
 .
 .IP "" 4
 .
 .nf
-$ tumblr http://www.youtube.com/watch?v=CW0DUg63lqU
+
+$ cat data\.yml my_post\.txt | tumblr \-\-host=mwunsch\.tumblr\.com
 .
 .fi
 .
 .IP "" 0
 .
 .P
-Save it as a draft:
+Make a Link post:
 .
 .IP "" 4
 .
 .nf
-$ tumblr \-d http://www.youtube.com/watch?v=CW0DUg63lqU
+
+$ tumblr post http://github\.com/mwunsch/tumblr
 .
 .fi
 .
 .IP "" 0
 .
 .P
-Authenticate with credentials given from a file:
+Or a Video post:
 .
 .IP "" 4
 .
 .nf
-$ cat ~/.tumblrlogin
-email: tumblruser@generic\-email.com
-password: myvoiceismypassport
-$ cat data.yml my_post.txt | tumblr \-\-credentials ~/.tumblrlogin
+
+$ tumblr post http://www\.youtube\.com/watch?v=CW0DUg63lqU
 .
 .fi
 .
 .IP "" 0
 .
-.SH "INSTALLATION"
-If you have RubyGems installed:
+.P
+Save it as a draft:
 .
 .IP "" 4
 .
 .nf
-gem install tumblr\-rb
+
+$ tumblr post \-d http://www\.youtube\.com/watch?v=CW0DUg63lqU
 .
 .fi
 .
 .IP "" 0
 .
 .SH "COPYRIGHT"
-Tumblr (the gem) is Copyright (C) 2010 Mark Wunsch
+Tumblr (the gem) is Copyright (C) 2010 \- 2012 Mark Wunsch
 .
 .P
-Tumblr is Copyright (c) Tumblr, Inc. The Tumblr gem is NOT affiliated with Tumblr, Inc.
+Tumblr is Copyright (c) Tumblr, Inc\. The Tumblr gem is NOT affiliated with Tumblr, Inc\.
 .
 .SH "SEE ALSO"
 tumblr(5), gem(1)