Changeset e83b2d7

Timestamp:

Oct 2, 2010, 10:42:45 PM (14 years ago)

Author:

Jessica B. Hamrick <jhamrick@…>

Branches:

master, debian, mac, no-cups

Children:

618236b, 1c3f290

Parents:

43ddb7a

git-author:

Jessica B. Hamrick <jhamrick@…> (10/02/10 22:42:45)

git-committer:

Jessica B. Hamrick <jhamrick@…> (10/02/10 22:42:45)

Message:

Updated manpages to reflect recent client script changes

Location:

client/bin

Files:

• gbq.1 (modified) (2 diffs)
• gbr.1 (modified) (1 diff)
• gbrm.1 (modified) (2 diffs)
• gutenbach-client-config.1 (modified) (2 diffs)

client/bin/gbq.1

@@ -1 @@
-.TH gbq 1 "27 June 2010"
+.TH gbq 1 "02 October 2010"
 .SH NAME
 gbq \- displays a remote Gutenbach queue
@@ -9 +9 @@
 the current jobs, along with ID numbers, owners, and filenames.  The
 Gutenbach queue must have previously been added with
-.B gutenbach-client-config
-so that gbq knows which host to use.  If no queue is specified,
-.B gbq
-will try to use the default queue, if one is configured.
+\fBgutenbach-client-config\fR so that gbq knows which host to use.  If
+no queue is specified, \fBgbq\fR will try to use the default queue, if
+one is configured.
+.TP
+\fB\-q\fR, \fB\-\-queue\fR
+Specify a queue other than the default
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print the help message
 .SH SEE ALSO
 gbr(1), gbrm(1), gutenbach-client-config(1)

client/bin/gbr.1

@@ -1 @@
-.TH gbr 1 "27 June 2010"
+.TH gbr 1 "02 October 2010"
 .SH NAME
 gbr \- sends a file to a Gutenbach queue
 .SH SYNOPSIS
 .B gbr 
-[-q \fIQUEUE\fR] \fIFILES\fR
+[options] [-q \fIQUEUE\fR] \fIFILES\fR
 .SH DESCRIPTION
 Prints files to a Gutenbach queue, given the queue name and the path
-to the files.  gbr correctly handles pathname expansion, so (for
-example), if you wish to play all .mp3 files in a directory, the
-command `gbr $queue *.mp3` will send each .mp3 as a separate job.  The
-path may also be a URL to a
-.B YouTube 
-video (e.g. http://www.youtube.com/watch?v=foo).  The Gutenbach queue
-must have previously been added with
-.B gutenbach-client-config
-so that gbr knows which host to use.  If no queue is specified,
-.B gbr
-will try to use the default queue, if one is configured.
+to the files.  If no queue is specified with the \fB\-q\fR option,
+then the default queue will be used (which should be specified with
+\fBgutenbach-client-config\fR).  gbr correctly handles pathname
+expansion, so (for example), if you wish to play all .mp3 files in a
+directory, the command `gbr $queue *.mp3` will send each .mp3 as a
+separate job.  The path may also be a URL to a \fBYouTube\fR video
+(e.g. http://www.youtube.com/watch?v=foo).  The Gutenbach queue must
+have previously been added with gutenbach-client-config so that gbr
+knows which host to use.  If no queue is specified, gbr will try to
+use the default queue, if one is configured.
+.TP
+\fB\-q\fR, \fB\-\-queue\fR
+Specify a queue other than the default
+.TP
+\fB\-d\fR, \fB\-\-dryrun\fR
+Just list what would be done
+.TP
+\fB\-s\fR, \fB\-\-shuffle\fR
+Randomize the order that the songs are queued in
+.TP
+\fB\-r\fR, \fB\-\-recursive\fR
+Recursively find files if a directory is passed in
+.TP
+\fB\-n\fR, \fB\-\-number\fR \fINUMBER\fR
+Only print NUMBER files, if more than NUMBER are given (this will
+print the first NUMBER files if -s is not given)
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print the help message
 .SH SEE ALSO
 gbq(1), gbrm(1), gutenbach-client-config(1)

client/bin/gbrm.1

@@ -1 @@
-.TH gbrm 1 "27 June 2010"
+.TH gbrm 1 "02 October 2010"
 .SH NAME
 gbrm \- removes jobs from a Gutenbach queue
@@ -7 +7 @@
 .SH DESCRIPTION
 Removes a single job from a Gutenbach queue, given the job id, which
-can be obtained with the 
-.B gbq
-command.  If 
-.B all
-is used in place of an id, then all jobs are removed from the queue.  If
-.B current 
-is used in place of an id, then the current (top) job is removed from
-the queue.  If
-.B last
-is used in place of an id, then the last job is removed from the
-queue.  The queue must have previously been added with
-.B gutenbach-client-config
-so that gbrm knows which host to use.  If no queue is specified,
-.B gbr
-will try to use the default queue, if one is configured.
+can be obtained with the \fBgbq\fR command.  If no queue is specified
+with the \fB\-q\fR option, then the default queue will be used (which
+should be specified with \fBgutenbach-client-config\fR).  If \fBall\fR
+is used in place of an id, then all jobs are removed from the queue.
+If \fBcurrent\fR is used in place of an id, then the current (top) job
+is removed from the queue.  If \fBlast\fR is used in place of an id,
+then the last job is removed from the queue.  The queue must have
+previously been added with gutenbach-client-config so that gbrm knows
+which host to use.
+.TP
+\fB\-q\fR, \fB\-\-queue\fR
+Specify a queue other than the default
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print the help message
 .SH SEE ALSO
 gbr(1), gbq(1), gutenbach-client-config(1)

client/bin/gutenbach-client-config.1

@@ -1 @@
-.TH gutenbach-client-config 1 "27 June 2010"
+.TH gutenbach-client-config 1 "02 October 2010"
 .SH NAME
 gutenbach-client-config \- displays a remote Gutenbach queue
 .SH SYNOPSIS
 .B gutenbach-client-config 
-[-l|--list|-a|--add|-d|--delete|-s|--set-default] [\fIQUEUE\fR] [--host \fIHOST\fR]
+[options]
 .SH DESCRIPTION
 Provides options to add, remove, or list remote Gutenbach queues.  The
@@ -25 +25 @@
 \fB\-a\fR, \fB\-\-add\fR QUEUE
 Add a remote queue.  Must be used in conjunction with
-.B --host
+.B \fB\-\-host\fR
 .TP
-\fB\-d\fR, \fB\-\-delete\fR QUEUE
-Delete a remote queue.  Must be used in conjunction with
-.B --host
-.
+\fB\-d\fR, \fB\-\-delete\fR QUEUE Delete a remote queue.
+.TP
+\fB\-s\fR, \fB\-\-set\-default\fR QUEUE
+Set the default queue
 .TP
 \fB\-h\fR, \fB\-\-host\fR HOST
 Hostname for the queue
 .TP
-\fB\-s\fR, \fB\-\-set\-default\fR QUEUE
-Set the default queue
+\fB\-H\fR, \fB\-\-help\fR
+Print a help message
 .SH SEE ALSO
 gbr(1), gbrm(1), gbq(1)