PageRenderTime 9ms CodeModel.GetById 2ms app.highlight 3ms RepoModel.GetById 1ms app.codeStats 0ms

/man/google.1

http://googlecl.googlecode.com/
Unknown | 373 lines | 367 code | 6 blank | 0 comment | 0 complexity | 971351d67b71bb40e284fba109f5aabc MD5 | raw file
  1.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.11.
  2.TH GOOGLE "1" "December 2012" "google ./google0.9.14" "User Commands"
  3.SH NAME
  4google \- command-line access to (some) Google services
  5.SH SYNOPSIS
  6.B google
  7[\fIhelp|picasa|blogger|youtube|docs|contacts|calendar|finance|sites\fR] \fITASK \fR[\fIoptions\fR]
  8.SH DESCRIPTION
  9This program provides command\-line access to
 10(some) google services via their gdata APIs.
 11Called without a service name, it starts an interactive session.
 12.PP
 13NOTE: GoogleCL will interpret arguments as required options in the
 14order they appear in the descriptions below, excluding options
 15set in the configuration file and non\-primary terms in parenthesized
 16OR groups. For example:
 17.IP
 18\f(CW$ google picasa get my_album .\fR
 19.PP
 20is interpreted as "google picasa get \fB\-\-title\fR=\fImy_album\fR \fB\-\-dest=\fR.
 21.IP
 22\f(CW$ google contacts list john\fR
 23.PP
 24is interpreted as "$ google contacts list \fB\-\-fields=\fR<config file def> \fB\-\-title\fR=\fIjohn\fR \fB\-\-delimiter=\fR,"
 25(only true if you have not removed the default definition in the config file!)
 26.IP
 27\f(CW$ google docs get my_doc .\fR
 28.PP
 29is interpreted as "$ google docs get \fB\-\-title\fR=\fImy_doc\fR \fB\-\-dest=\fR.
 30(folder is NOT set, since the title option is satisfied first.)
 31.PP
 32Available tasks for service picasa: 'get', 'create', 'list', 'list\-albums', 'tag', 'post', 'delete'
 33.IP
 34get: Download albums
 35.IP
 36Requires: title AND dest Optional: owner, format, photo
 37.IP
 38create: Create an album
 39.IP
 40Requires: title Optional: src, date, summary, tags, access
 41.IP
 42list: List photos
 43.IP
 44Requires: fields AND delimiter Optional: title, query, owner, photo
 45.IP
 46list\-albums: List albums
 47.IP
 48Requires: fields AND delimiter Optional: title, owner
 49.IP
 50tag: Tag/caption photos
 51.IP
 52Requires: (title OR query) AND (tags OR summary) Optional: owner, photo
 53.IP
 54post: Post photos to an album
 55.IP
 56Requires: title AND src Optional: tags, owner, photo, summary
 57.IP
 58delete: Delete photos or albums
 59.IP
 60Requires: (title OR query) Optional: photo
 61.PP
 62Available tasks for service blogger: 'post', 'tag', 'list', 'delete'
 63.IP
 64post: Post content.
 65.IP
 66Requires: src AND blog Optional: title, tags, access
 67.IP
 68tag: Label posts
 69.IP
 70Requires: blog AND title AND tags
 71.IP
 72list: List posts in a blog
 73.IP
 74Requires: fields AND blog AND delimiter Optional: title, owner
 75.IP
 76delete: Delete a post.
 77.IP
 78Requires: blog AND title
 79.PP
 80Available tasks for service youtube: 'post', 'tag', 'list', 'delete'
 81.IP
 82post: Post a video.
 83.IP
 84Requires: src AND category AND devkey Optional: title, summary, tags, access
 85.IP
 86tag: Add tags to a video and/or change its category.
 87.IP
 88Requires: title AND (tags OR category) AND devkey
 89.IP
 90list: List videos by user.
 91.IP
 92Requires: fields AND delimiter Optional: title, owner
 93.IP
 94delete: Delete videos.
 95.IP
 96Requires: title AND devkey
 97.PP
 98Available tasks for service docs: 'edit', 'delete', 'list', 'upload', 'get'
 99.IP
100edit: Edit a document
101.IP
102Requires: title Optional: format, editor, folder
103.IP
104delete: Delete documents
105.IP
106Requires: title Optional: folder
107.IP
108list: List documents
109.IP
110Requires: fields AND delimiter Optional: title, folder
111.IP
112upload: Upload a document
113.IP
114Requires: src Optional: title, folder, format
115.IP
116get: Download a document
117.IP
118Requires: (title OR folder) AND dest Optional: format
119.PP
120Available tasks for service contacts: 'list', 'list\-groups', 'add', 'add\-groups', 'delete\-groups', 'delete'
121.IP
122list: List contacts
123.IP
124Requires: fields AND title AND delimiter
125.IP
126list\-groups: List contact groups
127.IP
128Requires: title
129.IP
130add: Add contacts
131.IP
132Requires: src
133.IP
134add\-groups: Add contact group(s)
135.IP
136Requires: title
137.IP
138delete\-groups: Delete contact group(s)
139.IP
140Requires: title
141.IP
142delete: Delete contacts
143.IP
144Requires: title
145.PP
146Available tasks for service calendar: 'add', 'list', 'today', 'delete'
147.IP
148add: Add event to a calendar
149.IP
150Requires: src Optional: cal
151.IP
152list: List events on a calendar
153.IP
154Requires: fields AND delimiter Optional: title, query, date, cal
155.IP
156today: List events for the next 24 hours
157.IP
158Requires: fields AND delimiter Optional: title, query, cal
159.IP
160delete: Delete event from a calendar
161.IP
162Requires: (title OR query) Optional: date, cal
163.PP
164Available tasks for service finance: 'list\-txn', 'delete\-pos', 'create\-pos', 'delete\-txn', 'create', 'create\-txn', 'list', 'list\-pos', 'delete'
165.IP
166list\-txn: List transactions
167.IP
168Requires: title AND ticker
169.IP
170delete\-pos: Delete positions
171.IP
172Requires: title Optional: ticker
173.IP
174create\-pos: Create position
175.IP
176Requires: title AND ticker
177.IP
178delete\-txn: Delete transactions
179.IP
180Requires: title AND ticker Optional: txnid
181.IP
182create: Create a portfolio
183.IP
184Requires: title AND currency
185.IP
186create\-txn: Create transaction
187.IP
188Requires: title AND ticker AND ttype AND shares AND price Optional: shares, price, date, commission, currency, notes
189.IP
190list: List portfolios
191.IP
192Requires: none Optional: fields
193.IP
194list\-pos: List positions
195.IP
196Requires: title Optional: fields
197.IP
198delete: Delete portfolios
199.IP
200Requires: title
201.SH OPTIONS
202.TP
203\fB\-\-version\fR
204show program's version number and exit
205.TP
206\fB\-h\fR, \fB\-\-help\fR
207show this help message and exit
208.TP
209\fB\-\-access\fR=\fIACCESS\fR
210Specify access/visibility level of an upload
211.TP
212\fB\-\-blog\fR=\fIBLOG\fR
213Blogger only \- specify a blog other than your primary.
214.TP
215\fB\-\-cal\fR=\fICAL\fR
216Calendar only \- specify a calendar other than your
217primary.
218.TP
219\fB\-c\fR CATEGORY, \fB\-\-category\fR=\fICATEGORY\fR
220YouTube only \- specify video categories as a commaseparated list, e.g. "Film, Travel"
221.TP
222\fB\-\-commission\fR=\fICOMMISSION\fR
223Finance only \- specify commission for transaction
224.TP
225\fB\-\-config\fR=\fICONFIG\fR
226Specify location of config file.
227.TP
228\fB\-\-currency\fR=\fICURRENCY\fR
229Finance only \- specify currency for portfolio
230.TP
231\fB\-\-devtags\fR=\fIDEVTAGS\fR
232YouTube only \- specify developer tags as a commaseparated list.
233.TP
234\fB\-\-devkey\fR=\fIDEVKEY\fR
235YouTube only \- specify a developer key
236.TP
237\fB\-d\fR DATE, \fB\-\-date\fR=\fIDATE\fR
238Calendar only \- date of the event to add/look for. Can
239also specify a range with a comma. Picasa only \- sets
240the date of the album Finance only \- transaction
241creation date
242.TP
243\fB\-\-debug\fR
244Enable all debugging output, including HTTP data
245.TP
246\fB\-\-delimiter\fR=\fIDELIMITER\fR
247Specify a delimiter for the output of the list task.
248.TP
249\fB\-\-dest\fR=\fIDEST\fR
250Destination. Typically, where to save data being
251downloaded.
252.TP
253\fB\-\-domain\fR=\fIDOMAIN\fR
254Sites only \- Specify domain for enterprise customers.
255.TP
256\fB\-\-draft\fR
257Blogger only \- post as a draft. Shorthand for
258\fB\-\-access\fR=\fIdraft\fR
259.TP
260\fB\-\-editor\fR=\fIEDITOR\fR
261Docs only \- editor to use on a file.
262.TP
263\fB\-\-fields\fR=\fIFIELDS\fR
264Fields to list with list task.
265.TP
266\fB\-f\fR FOLDER, \fB\-\-folder\fR=\fIFOLDER\fR
267Sites \-  sites page (folder) to upload under.
268Docs \- specify folder(s) to upload to / search
269in.
270.TP
271\fB\-\-force\-auth\fR
272Force validation step for re\-used access tokens
273(Overrides \fB\-\-skip\-auth\fR).
274.TP
275\fB\-\-format\fR=\fIFORMAT\fR
276Sites \- sites page type to upload as.
277Docs \- format to download documents as.
278.TP
279\fB\-\-hostid\fR=\fIHOSTID\fR
280Label the machine being used.
281.TP
282\fB\-n\fR TITLE, \fB\-\-title\fR=\fITITLE\fR
283Title of the item
284.TP
285\fB\-\-max_results\fR=\fIMAX_RESULTS\fR
286Sites: max results to return for list. Overrides config param.
287.TP
288\fB\-\-no\-convert\fR
289Google Apps Premier only \- do not convert the file on
290upload. (Else converts to native Google Docs format)
291.TP
292\fB\-\-notes\fR=\fINOTES\fR
293Finance only \- specify notes for transaction
294.TP
295\fB\-o\fR OWNER, \fB\-\-owner\fR=\fIOWNER\fR
296Username or ID of the owner of the resource. For
297example, 'picasa list\-albums \fB\-o\fR bob' to list bob's
298albums
299.TP
300\fB\-\-photo\fR=\fIPHOTO\fR
301Picasa only \- specify title or name of photo(s)
302.TP
303\fB\-\-price\fR=\fIPRICE\fR
304Finance only \- specify price for transaction
305.TP
306\fB\-q\fR QUERY, \fB\-\-query\fR=\fIQUERY\fR
307Sites, Picasa: Full text query string for specifying items.
308Picasa: Searches on titles, captions, and tags.
309.TP
310\fB\-\-quiet\fR
311Print only prompts and error messages
312.TP
313\fB\-\-reminder\fR=\fIREMINDER\fR
314Calendar only \- specify time for added event's
315reminder, e.g. "10m", "3h", "1d"
316.TP
317\fB\-\-shares\fR=\fISHARES\fR
318Finance only \- specify amount of shares for
319transaction
320.TP
321\fB\-\-site\fR=\fISITE\fR
322Sites only \- specify site to act on.
323.TP
324\fB\-\-skip\-auth\fR
325Skip validation step for re\-used access tokens.
326.TP
327\fB\-\-src\fR=\fISRC\fR
328Source. Typically files to upload.
329.TP
330\fB\-s\fR SUMMARY, \fB\-\-summary\fR=\fISUMMARY\fR
331Description of the upload, or file containing the
332description.
333.TP
334\fB\-t\fR TAGS, \fB\-\-tags\fR=\fITAGS\fR
335Tags for item, e.g. "Sunsets, Earth Day"
336.TP
337\fB\-\-ticker\fR=\fITICKER\fR
338Finance only \- specify ticker
339.TP
340\fB\-\-ttype\fR=\fITTYPE\fR
341Finance only \- specify transaction type, e.g. "Bye",
342"Sell", "Buy to Cover", "Sell Short"
343.TP
344\fB\-\-txnid\fR=\fITXNID\fR
345Finance only \- specify transaction id
346.TP
347\fB\-u\fR USER, \fB\-\-user\fR=\fIUSER\fR
348Username to log in with for the service. If not
349provided full email address (e.g. "foo"), than it is
350assumed to be in gmail.com domain (e.g.
351"foo@gmail.com"). If you want to use another domain,
352provide full email address like "foo@bar.com"
353.TP
354\fB\-v\fR, \fB\-\-verbose\fR
355Print all messages.
356.TP
357\fB\-\-yes\fR
358Answer "yes" to all prompts
359.SH EXAMPLES
360.nf
361google blogger post \-\-title 'foo' 'command line posting'
362
363google calendar add 'Lunch with Jim at noon tomorrow'
364
365google contacts list \-\-title '.*' \-\-fields name,email,phone > contacts.csv
366
367google docs edit \-\-title 'Shopping list'
368
369google picasa create \-\-title 'Cat Photos' ~/photos/cats/*.jpg
370
371google sites upload \-\-site mysite \-\-src myfile \-\-folder myparent
372
373google youtube post \-\-category Education killer_robots.avi