share/man/man1/gpo.1

   1 .TH GPO "1" "October 2014" "gpodder 3.8.2" "User Commands"
   2 .SH NAME
   3 gpo \- Text mode interface of gPodder
   4 .SH SYNOPSIS
   5 .B gpo
   6 [\fI--verbose|-v\fR]
   7 [\fICOMMAND\fR] [\fIparams...\fR]
   8
   9 .SH DESCRIPTION
  10 .PP
  11 gpo is the text mode interface of gPodder. Run it without any arguments to
  12 start the interactive shell (see below). Use "gpo help" to get a list of
  13 supported commands.
  14 .PP
  15 gpo can be used to manage podcasts from the command line without having to
  16 start gPodder. It can also be used to automate tasks such as downloading or
  17 updating feeds.
  18 .PP
  19 The database and files are the same as used by \fIgpodder(1)\fR.
  20
  21 .SH INTERACTIVE SHELL MODE
  22 .PP
  23 If you run "gpo" without \fICOMMAND\fR it will enter its interactive shell
  24 mode. From there, you can type commands directly. When readline is available,
  25 this shell supports completion using <Tab>. Podcast feed URLs are also
  26 completed for commands that take the URL of a podcast as argument.
  27 .PP
  28 Some commands (e.g. \fIsearch\fR and \fItoplist\fR) will provide a query in
  29 interactive shell mode (to subscribe to podcasts). These queries will not be
  30 shown when started directly from the command line.
  31
  32 .SH COMMAND PREFIXES
  33 .PP
  34 For all commands, you can use only the first few characters instead of the
  35 full command, as long as the command is unique. If not, gpo will show you all
  36 matching commands and the shortest prefix of each.
  37 .PP
  38 Please note that future additions to the command set could change the shortest
  39 prefix of any given command, so usage of the full command in scripts is
  40 recommended (e.g. use "gpo update" and not "gpo up" in scripts and cronjobs).
  41 The short command prefixes are mostly useful for interactive usage.
  42
  43 .SH EXAMPLES
  44
  45 .PP
  46 .B gpo
  47 .RS 4
  48 Enter interactive shell mode
  49 .RE
  50 .PP
  51 .B gpo update && gpo download
  52 .RS 4
  53 Check for new episodes, then download all new episodes
  54 .RE
  55
  56 .PP
  57 .B gpo search linux outlaws
  58 .RS 4
  59 Search the directory for podcasts named "linux outlaws"
  60 .RE
  61
  62 .PP
  63 .B gpo youtube http://youtube.com/watch?v=oHg5SJYRHA0
  64 .RS 4
  65 Print download URL of a YouTube video to stdout
  66 .RE
  67
  68 .PP
  69 .B gpo webui
  70 .RS 4
  71 Start a web server serving the gPodder Web UI on localhost
  72 .RE
  73
  74 .PP
  75 .B gpo pipe
  76 .RS 4
  77 Start in pipe mode (useful for GUI frontends that want to use the
  78 gpodder backend using a JSON-esque request/response protocol)
  79 .RE
  80
  81 .SH SEE ALSO
  82 .PP
  83 gpodder(1)
  84
  85 .SH BUGS
  86 .PP
  87 If you find bugs, don't keep them for yourself!
  88 .PP
  89 Report bugs and feature requests at \fIhttp://bugs.gpodder.org/\fR