/man/google.1
Unknown | 373 lines | 367 code | 6 blank | 0 comment | 0 complexity | 971351d67b71bb40e284fba109f5aabc MD5 | raw file
- .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.11.
- .TH GOOGLE "1" "December 2012" "google ./google0.9.14" "User Commands"
- .SH NAME
- google \- command-line access to (some) Google services
- .SH SYNOPSIS
- .B google
- [\fIhelp|picasa|blogger|youtube|docs|contacts|calendar|finance|sites\fR] \fITASK \fR[\fIoptions\fR]
- .SH DESCRIPTION
- This program provides command\-line access to
- (some) google services via their gdata APIs.
- Called without a service name, it starts an interactive session.
- .PP
- NOTE: GoogleCL will interpret arguments as required options in the
- order they appear in the descriptions below, excluding options
- set in the configuration file and non\-primary terms in parenthesized
- OR groups. For example:
- .IP
- \f(CW$ google picasa get my_album .\fR
- .PP
- is interpreted as "google picasa get \fB\-\-title\fR=\fImy_album\fR \fB\-\-dest=\fR.
- .IP
- \f(CW$ google contacts list john\fR
- .PP
- is interpreted as "$ google contacts list \fB\-\-fields=\fR<config file def> \fB\-\-title\fR=\fIjohn\fR \fB\-\-delimiter=\fR,"
- (only true if you have not removed the default definition in the config file!)
- .IP
- \f(CW$ google docs get my_doc .\fR
- .PP
- is interpreted as "$ google docs get \fB\-\-title\fR=\fImy_doc\fR \fB\-\-dest=\fR.
- (folder is NOT set, since the title option is satisfied first.)
- .PP
- Available tasks for service picasa: 'get', 'create', 'list', 'list\-albums', 'tag', 'post', 'delete'
- .IP
- get: Download albums
- .IP
- Requires: title AND dest Optional: owner, format, photo
- .IP
- create: Create an album
- .IP
- Requires: title Optional: src, date, summary, tags, access
- .IP
- list: List photos
- .IP
- Requires: fields AND delimiter Optional: title, query, owner, photo
- .IP
- list\-albums: List albums
- .IP
- Requires: fields AND delimiter Optional: title, owner
- .IP
- tag: Tag/caption photos
- .IP
- Requires: (title OR query) AND (tags OR summary) Optional: owner, photo
- .IP
- post: Post photos to an album
- .IP
- Requires: title AND src Optional: tags, owner, photo, summary
- .IP
- delete: Delete photos or albums
- .IP
- Requires: (title OR query) Optional: photo
- .PP
- Available tasks for service blogger: 'post', 'tag', 'list', 'delete'
- .IP
- post: Post content.
- .IP
- Requires: src AND blog Optional: title, tags, access
- .IP
- tag: Label posts
- .IP
- Requires: blog AND title AND tags
- .IP
- list: List posts in a blog
- .IP
- Requires: fields AND blog AND delimiter Optional: title, owner
- .IP
- delete: Delete a post.
- .IP
- Requires: blog AND title
- .PP
- Available tasks for service youtube: 'post', 'tag', 'list', 'delete'
- .IP
- post: Post a video.
- .IP
- Requires: src AND category AND devkey Optional: title, summary, tags, access
- .IP
- tag: Add tags to a video and/or change its category.
- .IP
- Requires: title AND (tags OR category) AND devkey
- .IP
- list: List videos by user.
- .IP
- Requires: fields AND delimiter Optional: title, owner
- .IP
- delete: Delete videos.
- .IP
- Requires: title AND devkey
- .PP
- Available tasks for service docs: 'edit', 'delete', 'list', 'upload', 'get'
- .IP
- edit: Edit a document
- .IP
- Requires: title Optional: format, editor, folder
- .IP
- delete: Delete documents
- .IP
- Requires: title Optional: folder
- .IP
- list: List documents
- .IP
- Requires: fields AND delimiter Optional: title, folder
- .IP
- upload: Upload a document
- .IP
- Requires: src Optional: title, folder, format
- .IP
- get: Download a document
- .IP
- Requires: (title OR folder) AND dest Optional: format
- .PP
- Available tasks for service contacts: 'list', 'list\-groups', 'add', 'add\-groups', 'delete\-groups', 'delete'
- .IP
- list: List contacts
- .IP
- Requires: fields AND title AND delimiter
- .IP
- list\-groups: List contact groups
- .IP
- Requires: title
- .IP
- add: Add contacts
- .IP
- Requires: src
- .IP
- add\-groups: Add contact group(s)
- .IP
- Requires: title
- .IP
- delete\-groups: Delete contact group(s)
- .IP
- Requires: title
- .IP
- delete: Delete contacts
- .IP
- Requires: title
- .PP
- Available tasks for service calendar: 'add', 'list', 'today', 'delete'
- .IP
- add: Add event to a calendar
- .IP
- Requires: src Optional: cal
- .IP
- list: List events on a calendar
- .IP
- Requires: fields AND delimiter Optional: title, query, date, cal
- .IP
- today: List events for the next 24 hours
- .IP
- Requires: fields AND delimiter Optional: title, query, cal
- .IP
- delete: Delete event from a calendar
- .IP
- Requires: (title OR query) Optional: date, cal
- .PP
- Available tasks for service finance: 'list\-txn', 'delete\-pos', 'create\-pos', 'delete\-txn', 'create', 'create\-txn', 'list', 'list\-pos', 'delete'
- .IP
- list\-txn: List transactions
- .IP
- Requires: title AND ticker
- .IP
- delete\-pos: Delete positions
- .IP
- Requires: title Optional: ticker
- .IP
- create\-pos: Create position
- .IP
- Requires: title AND ticker
- .IP
- delete\-txn: Delete transactions
- .IP
- Requires: title AND ticker Optional: txnid
- .IP
- create: Create a portfolio
- .IP
- Requires: title AND currency
- .IP
- create\-txn: Create transaction
- .IP
- Requires: title AND ticker AND ttype AND shares AND price Optional: shares, price, date, commission, currency, notes
- .IP
- list: List portfolios
- .IP
- Requires: none Optional: fields
- .IP
- list\-pos: List positions
- .IP
- Requires: title Optional: fields
- .IP
- delete: Delete portfolios
- .IP
- Requires: title
- .SH OPTIONS
- .TP
- \fB\-\-version\fR
- show program's version number and exit
- .TP
- \fB\-h\fR, \fB\-\-help\fR
- show this help message and exit
- .TP
- \fB\-\-access\fR=\fIACCESS\fR
- Specify access/visibility level of an upload
- .TP
- \fB\-\-blog\fR=\fIBLOG\fR
- Blogger only \- specify a blog other than your primary.
- .TP
- \fB\-\-cal\fR=\fICAL\fR
- Calendar only \- specify a calendar other than your
- primary.
- .TP
- \fB\-c\fR CATEGORY, \fB\-\-category\fR=\fICATEGORY\fR
- YouTube only \- specify video categories as a commaseparated list, e.g. "Film, Travel"
- .TP
- \fB\-\-commission\fR=\fICOMMISSION\fR
- Finance only \- specify commission for transaction
- .TP
- \fB\-\-config\fR=\fICONFIG\fR
- Specify location of config file.
- .TP
- \fB\-\-currency\fR=\fICURRENCY\fR
- Finance only \- specify currency for portfolio
- .TP
- \fB\-\-devtags\fR=\fIDEVTAGS\fR
- YouTube only \- specify developer tags as a commaseparated list.
- .TP
- \fB\-\-devkey\fR=\fIDEVKEY\fR
- YouTube only \- specify a developer key
- .TP
- \fB\-d\fR DATE, \fB\-\-date\fR=\fIDATE\fR
- Calendar only \- date of the event to add/look for. Can
- also specify a range with a comma. Picasa only \- sets
- the date of the album Finance only \- transaction
- creation date
- .TP
- \fB\-\-debug\fR
- Enable all debugging output, including HTTP data
- .TP
- \fB\-\-delimiter\fR=\fIDELIMITER\fR
- Specify a delimiter for the output of the list task.
- .TP
- \fB\-\-dest\fR=\fIDEST\fR
- Destination. Typically, where to save data being
- downloaded.
- .TP
- \fB\-\-domain\fR=\fIDOMAIN\fR
- Sites only \- Specify domain for enterprise customers.
- .TP
- \fB\-\-draft\fR
- Blogger only \- post as a draft. Shorthand for
- \fB\-\-access\fR=\fIdraft\fR
- .TP
- \fB\-\-editor\fR=\fIEDITOR\fR
- Docs only \- editor to use on a file.
- .TP
- \fB\-\-fields\fR=\fIFIELDS\fR
- Fields to list with list task.
- .TP
- \fB\-f\fR FOLDER, \fB\-\-folder\fR=\fIFOLDER\fR
- Sites \- sites page (folder) to upload under.
- Docs \- specify folder(s) to upload to / search
- in.
- .TP
- \fB\-\-force\-auth\fR
- Force validation step for re\-used access tokens
- (Overrides \fB\-\-skip\-auth\fR).
- .TP
- \fB\-\-format\fR=\fIFORMAT\fR
- Sites \- sites page type to upload as.
- Docs \- format to download documents as.
- .TP
- \fB\-\-hostid\fR=\fIHOSTID\fR
- Label the machine being used.
- .TP
- \fB\-n\fR TITLE, \fB\-\-title\fR=\fITITLE\fR
- Title of the item
- .TP
- \fB\-\-max_results\fR=\fIMAX_RESULTS\fR
- Sites: max results to return for list. Overrides config param.
- .TP
- \fB\-\-no\-convert\fR
- Google Apps Premier only \- do not convert the file on
- upload. (Else converts to native Google Docs format)
- .TP
- \fB\-\-notes\fR=\fINOTES\fR
- Finance only \- specify notes for transaction
- .TP
- \fB\-o\fR OWNER, \fB\-\-owner\fR=\fIOWNER\fR
- Username or ID of the owner of the resource. For
- example, 'picasa list\-albums \fB\-o\fR bob' to list bob's
- albums
- .TP
- \fB\-\-photo\fR=\fIPHOTO\fR
- Picasa only \- specify title or name of photo(s)
- .TP
- \fB\-\-price\fR=\fIPRICE\fR
- Finance only \- specify price for transaction
- .TP
- \fB\-q\fR QUERY, \fB\-\-query\fR=\fIQUERY\fR
- Sites, Picasa: Full text query string for specifying items.
- Picasa: Searches on titles, captions, and tags.
- .TP
- \fB\-\-quiet\fR
- Print only prompts and error messages
- .TP
- \fB\-\-reminder\fR=\fIREMINDER\fR
- Calendar only \- specify time for added event's
- reminder, e.g. "10m", "3h", "1d"
- .TP
- \fB\-\-shares\fR=\fISHARES\fR
- Finance only \- specify amount of shares for
- transaction
- .TP
- \fB\-\-site\fR=\fISITE\fR
- Sites only \- specify site to act on.
- .TP
- \fB\-\-skip\-auth\fR
- Skip validation step for re\-used access tokens.
- .TP
- \fB\-\-src\fR=\fISRC\fR
- Source. Typically files to upload.
- .TP
- \fB\-s\fR SUMMARY, \fB\-\-summary\fR=\fISUMMARY\fR
- Description of the upload, or file containing the
- description.
- .TP
- \fB\-t\fR TAGS, \fB\-\-tags\fR=\fITAGS\fR
- Tags for item, e.g. "Sunsets, Earth Day"
- .TP
- \fB\-\-ticker\fR=\fITICKER\fR
- Finance only \- specify ticker
- .TP
- \fB\-\-ttype\fR=\fITTYPE\fR
- Finance only \- specify transaction type, e.g. "Bye",
- "Sell", "Buy to Cover", "Sell Short"
- .TP
- \fB\-\-txnid\fR=\fITXNID\fR
- Finance only \- specify transaction id
- .TP
- \fB\-u\fR USER, \fB\-\-user\fR=\fIUSER\fR
- Username to log in with for the service. If not
- provided full email address (e.g. "foo"), than it is
- assumed to be in gmail.com domain (e.g.
- "foo@gmail.com"). If you want to use another domain,
- provide full email address like "foo@bar.com"
- .TP
- \fB\-v\fR, \fB\-\-verbose\fR
- Print all messages.
- .TP
- \fB\-\-yes\fR
- Answer "yes" to all prompts
- .SH EXAMPLES
- .nf
- google blogger post \-\-title 'foo' 'command line posting'
- google calendar add 'Lunch with Jim at noon tomorrow'
- google contacts list \-\-title '.*' \-\-fields name,email,phone > contacts.csv
- google docs edit \-\-title 'Shopping list'
- google picasa create \-\-title 'Cat Photos' ~/photos/cats/*.jpg
- google sites upload \-\-site mysite \-\-src myfile \-\-folder myparent
- google youtube post \-\-category Education killer_robots.avi