Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

linking to rdoc

  • Loading branch information...
commit 8672df2f3eab725972ea3c597558f84cd22edead 1 parent 0bd4d46
@davetron5000 authored
Showing with 50 additions and 0 deletions.
  1. +50 −0 rtm.rdoc
View
50 rtm.rdoc
@@ -0,0 +1,50 @@
+= <tt>rtm</tt>
+
+ rtm [global options] command_name [command-specific options] [--] arguments...
+
+* Use the command +help+ to get a summary of commands
+* Use the command <tt>help command_name</tt> to get a help for +command_name+
+* Use <tt>--</tt> to stop command line argument processing; useful if your arguments have dashes in them
+
+== Global Options
+These options are available for any command and are specified before the name of the command
+
+[<tt>--keys-file=arg</tt>] Location of your API keys file <i>( default: <tt>~/.rtmapi.yaml</tt>)</i>
+== Commands
+[<tt>any</tt>] executes any RTM method. Do not include the "rtm." in the method name
+[<tt>auth</tt>] Prints out the auth URL to authorize your api key/ruby client and the frob that was used. Do not do this after getting a token
+[<tt>chktoken</tt>] Checks that your token is valid
+[<tt>help</tt>] Shows list of commands or help for one command
+[<tt>ls</tt>] Lists incomplete tasks
+[<tt>token</tt>] Gets your token; do this only once and put it in your API keys file
+
+=== <tt>any method.call</tt>
+
+executes any RTM method. Do not include the "rtm." in the method name
+
+=== <tt>auth </tt>
+
+Prints out the auth URL to authorize your api key/ruby client and the frob that was used. Do not do this after getting a token
+
+=== <tt>chktoken </tt>
+
+Checks that your token is valid
+
+=== <tt>help [command]</tt>
+
+Shows list of commands or help for one command
+
+Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function
+
+==== Options
+These options are specified *after* the command.
+
+[<tt>-c, --completion</tt>] List all commands one line at a time, for use with shell completion ([command] argument is partial command to match)
+=== <tt>ls list_name</tt>
+
+Lists incomplete tasks
+
+=== <tt>token frob</tt>
+
+Gets your token; do this only once and put it in your API keys file
+
Please sign in to comment.
Something went wrong with that request. Please try again.