Permalink
Browse files

gPodder 3.0.4 "Weekend Vampire" released

The usual release updates. Add release name to
the metadata info of the gPodder module. Write
a proper manpage for the "gpo" utility.
  • Loading branch information...
1 parent 0430858 commit 094bb32de14fa34c7324105e2f7df15d1cc96581 @thp thp committed Jan 24, 2012
Showing with 80 additions and 12 deletions.
  1. +1 −1 bin/gpo
  2. +75 −8 data/man/gpo.1
  3. +1 −1 data/man/gpodder.1
  4. +3 −2 src/gpodder/__init__.py
View
@@ -536,7 +536,7 @@ class gPodderCli(object):
def _shell(self):
print '\n'.join(x.strip() for x in ("""
- gPodder %(__version__)s (%(__date__)s) - %(__url__)s
+ gPodder %(__version__)s "%(__relname__)s" (%(__date__)s) - %(__url__)s
%(__copyright__)s
License: %(__license__)s
View
@@ -1,15 +1,82 @@
-.TH GPO "1" "January 2012" "gpodder 3.0.3" "User Commands"
+.TH GPO "1" "January 2012" "gpodder 3.0.4" "User Commands"
.SH NAME
-gpo \- Command\-line frontend to gPodder
+gpo \- Text mode interface of gPodder
.SH SYNOPSIS
.B gpo
-\fICOMMAND\fR [\fIparams...\fR]
+[\fI--verbose|-v\fR]
+[\fICOMMAND\fR] [\fIparams...\fR]
+
.SH DESCRIPTION
.PP
-This is the command\-line frontend to gPodder. Run the command without
-parameters to show an overview of possible options and sub\-commands.
+gpo is the text mode interface of gPodder. Run it without any arguments to
+start the interactive shell (see below). Use "gpo help" to get a list of
+supported commands.
+.PP
+gpo can be used to manage podcasts from the command line without having to
+start gPodder. It can also be used to automate tasks such as downloading or
+updating feeds.
+.PP
+The database and files are the same as used by \fIgpodder(1)\fR.
+
+.SH INTERACTIVE SHELL MODE
+.PP
+If you run "gpo" without \fICOMMAND\fR it will enter its interactive shell
+mode. From there, you can type commands directly. When readline is available,
+this shell supports completion using <Tab>. Podcast feed URLs are also
+completed for commands that take the URL of a podcast as argument.
+.PP
+Some commands (e.g. \fIsearch\fR and \fItoplist\fR) will provide a query in
+interactive shell mode (to subscribe to podcasts). These queries will not be
+shown when started directly from the command line.
+
+.SH COMMAND PREFIXES
+.PP
+For all commands, you can use only the first few characters instead of the
+full command, as long as the command is unique. If not, gpo will show you all
+matching commands and the shortest prefix of each.
+.PP
+Please note that future additions to the command set could change the shortest
+prefix of any given command, so usage of the full command in scripts is
+recommended (e.g. use "gpo update" and not "gpo up" in scripts and cronjobs).
+The short command prefixes are mostly useful for interactive usage.
+
+.SH EXAMPLES
+
+.PP
+.B gpo
+.RS 4
+Enter interactive shell mode
+.RE
+.PP
+.B gpo update && gpo download
+.RS 4
+Check for new episodes, then download all new episodes
+.RE
+
+.PP
+.B gpo search linux outlaws
+.RS 4
+Search the directory for podcasts named "linux outlaws"
+.RE
+
+.PP
+.B gpo youtube http://youtube.com/watch?v=oHg5SJYRHA0
+.RS 4
+Print download URL of a YouTube video to stdout
+.RE
+
+.PP
+.B gpo webui
+.RS 4
+Start a web server serving the gPodder Web UI on localhost
+.RE
+
+.SH SEE ALSO
+.PP
+gpodder(1)
+
.SH BUGS
.PP
-Some commands are not yet implemented. Also, this manual page is quite empty.
-Feel free to contribute documentation and/or code for this utility. See the
-gPodder website at http://gpodder.org for more information.
+If you find bugs, don't keep them for yourself!
+.PP
+Report bugs and feature requests at \fIhttp://bugs.gpodder.org/\fR
View
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.5.
-.TH GPODDER "1" "January 2012" "gpodder 3.0.3" "User Commands"
+.TH GPODDER "1" "January 2012" "gpodder 3.0.4" "User Commands"
.SH NAME
gpodder \- A Media aggregator and Podcast catcher
.SH SYNOPSIS
View
@@ -18,8 +18,9 @@
#
__author__ = 'Thomas Perl <thp@gpodder.org>'
-__version__ = '3.0.3'
-__date__ = '2012-01-09'
+__version__ = '3.0.4'
+__date__ = '2012-01-24'
+__relname__ = 'Weekend Vampire'
__copyright__ = '© 2005-2012 Thomas Perl and the gPodder Team'
__license__ = 'GNU General Public License, version 3 or later'
__url__ = 'http://gpodder.org/'

0 comments on commit 094bb32

Please sign in to comment.