[rhythmbox] Add man pages, originally from Debian packaging



commit 228fbdabc3d23005df7467928b3092165626efbf
Author: Jonathan Matthew <jonathan d14n org>
Date:   Sun Dec 20 21:30:27 2009 +1000

    Add man pages, originally from Debian packaging

 data/Makefile.am        |    2 +
 data/rhythmbox-client.1 |  171 +++++++++++++++++++++++++++++++++++++++++++++++
 data/rhythmbox.1        |   87 ++++++++++++++++++++++++
 3 files changed, 260 insertions(+), 0 deletions(-)
---
diff --git a/data/Makefile.am b/data/Makefile.am
index db4e236..be8efda 100644
--- a/data/Makefile.am
+++ b/data/Makefile.am
@@ -14,6 +14,8 @@ playlists_in_files = playlists.xml.in
 playlists_DATA = playlists.xml
 playlistsdir = $(datadir)/rhythmbox
 
+man_MANS = rhythmbox.1 rhythmbox-client.1
+
 # Dbus service file
 servicedir = $(datadir)/dbus-1/services
 service_in_files = org.gnome.Rhythmbox.service.in
diff --git a/data/rhythmbox-client.1 b/data/rhythmbox-client.1
new file mode 100644
index 0000000..e477916
--- /dev/null
+++ b/data/rhythmbox-client.1
@@ -0,0 +1,171 @@
+.\" Copyright (C) 2006 Sven Arvidsson <sa whiz se>
+.\"
+.\" This is free software; you may redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as
+.\" published by the Free Software Foundation; either version 2,
+.\" or (at your option) any later version.
+.\"
+.\" This is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\"
+.\"You should have received a copy of the GNU General Public License along
+.\"with this program; if not, write to the Free Software Foundation, Inc.,
+.\"51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+.TH rhythmbox 1 "2007\-06\-28" "GNOME"
+.SH NAME
+rhythmbox-client \- controls a running instance of rhythmbox
+.SH SYNOPSIS
+.B rhythmbox-client
+.RI [ option... ] [ file... ]
+.SH DESCRIPTION
+.B rhythmbox-client
+is a tool for controlling an already running instance of
+.B rhythmbox. 
+It's useful for remote control scripting, adding specific files to the library
+from the shell, or printing details of what's playing. Any files specified after
+the option arguments will be added to the library.  If the
+.B \-\-enqueue
+option is given, the files will also be added to the play queue.
+.SH OPTIONS
+.TP
+.B \-?,\-\-help
+Show help options
+.TP
+.B \-\-debug
+Enable debug output
+.TP
+.B \-\-no-start
+Do not start a new instance of rhythmbox
+.TP
+.B \-\-quit
+Quit rhythmbox
+.TP
+.B \-\-no-present
+Don't present an existing rhythmbox window
+.TP
+.B \-\-hide
+Hide the rhythmbox window
+.TP
+.B \-\-next
+Jump to next song
+.TP
+.B \-\-previous
+Jump to previous song
+.TP
+.B \-\-notify
+Show notification of the playing song
+.TP
+.B \-\-play
+Resume playback if currently paused
+.TP
+.B \-\-pause
+Pause playback if currently playing
+.TP
+.B \-\-play-pause
+Toggle play/pause mode
+.TP
+.BI "\-\-play-uri="URI
+Play a specified URI, importing it if necessary
+.TP
+.BI \-\-enqueue
+Add specified tracks already in the library to the play queue
+.TP
+.B \-\-clear-queue
+Empty the play queue before adding new tracks
+.TP
+.B \-\-print-playing
+Print the title and artist of the playing song
+.TP
+.BI "\-\-print-playing-format="format
+Print formatted details of the song (see
+.SM
+.B FORMAT OPTIONS
+below).
+.TP
+.B \-\-set-volume
+Set the playback volume
+.TP
+.B \-\-volume-up
+Increase the playback volume
+.TP
+.B \-\-volume-down
+Decrease the playback volume
+.TP
+.B \-\-print-volume
+Print the current playback volume
+.TP
+.B \-\-mute
+Mute playback
+.TP
+.B \-\-unmute
+Unmute playback
+.SH FORMAT OPTIONS
+.TP
+%at
+album title
+.TP
+%aa
+album artist
+.TP
+%aA
+album artist (lowercase)
+.TP
+%as
+album artist sortname
+.TP
+%aS
+album artist sortname (lowercase)
+.TP
+%ay
+album year
+.TP
+%ag
+album genre
+.TP
+%aG
+album genre (lowercase)
+.TP
+%an
+album disc number
+.TP
+%aN
+album disc number, zero padded
+.TP
+%st
+stream title
+.TP
+%tn
+track number (i.e 8)
+.TP
+%tN
+track number, zero padded (i.e 08)
+.TP
+%tt
+track title
+.TP
+%ta
+track artist
+.TP
+%tA
+track artist (lowercase)
+.TP
+%ts
+track artist sortname
+.TP
+%tS
+track artist sortname (lowercase)
+.TP
+%td
+track duration
+.TP
+%te
+track elapsed time
+.TP
+Variables can be combined using quotes. For example "%tn %aa %tt", will print the track number followed by the artist and the title of the track.
+.SH AUTHOR
+This manual page was written by Sven Arvidsson <sa whiz se>,
+for the Debian system (but may be used by others).
+.SH SEE ALSO
+.BR "rhythmbox" (1).
diff --git a/data/rhythmbox.1 b/data/rhythmbox.1
new file mode 100644
index 0000000..2ce5b11
--- /dev/null
+++ b/data/rhythmbox.1
@@ -0,0 +1,87 @@
+.\" Copyright (C) 2006 Sven Arvidsson <sa whiz se>
+.\"
+.\" This is free software; you may redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as
+.\" published by the Free Software Foundation; either version 2,
+.\" or (at your option) any later version.
+.\"
+.\" This is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\"
+.\"You should have received a copy of the GNU General Public License along
+.\"with this program; if not, write to the Free Software Foundation, Inc.,
+.\"51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+.TH rhythmbox 1 "2006\-12\-24" "GNOME"
+.SH NAME
+rhythmbox \- music player and library for tagged files using GStreamer
+.SH SYNOPSIS
+.B rhythmbox
+.RI [ option... ]
+.SH DESCRIPTION
+.B rhythmbox
+is a very easy to use music playing and management program which
+supports a wide range of audio formats (including mp3 and
+ogg). Originally inspired by Apple's iTunes, the current version also
+supports Internet Radio and Last.fm integration, iPod syncing and
+generic portable audio player support. Audio CD playback, ripping and encoding, music sharing, and Podcasts.
+.P
+For performance reasons, the remote control abilities have been moved
+from the rhythmbox binary to a separate program. See
+.BR rhythmbox-client
+and the corresponding man page for documentation.
+.SH OPTIONS
+.TP
+.B \-d, \-\-debug
+Enable debug output
+.TP
+.BI "\-D, \-\-debug-match="match
+Enable debug output matching a specified string
+.TP
+.B \-\-no-update
+Do not update the library with file changes
+.TP
+.B \-n, \-\-no-registration
+Do not register the shell
+.TP
+.B \-\-dry-run
+Don't save any data permanently (implies \-\-no-registration)
+.TP
+.BI "\-\-rhythmdb-file="file
+Path for database file to use
+.TP
+.BI "\-\-playlists-file="file
+Path for playlists file to use
+.TP
+.B \-q, \-\-quit
+Quit rhythmbox
+.TP
+.BI "\-\-display="DISPLAY
+X display to use
+.TP
+.B \-?, \-\-help
+Show help options
+.TP
+.B \-\-help-all
+Show all help options
+.TP
+.B \-\-help-gst
+Show GStreamer Options
+.TP
+.B \-\-help-gtk
+Show GTK+ Options
+.TP
+.B \-\-help-sm-client
+Show session management options
+.SH AUTHOR
+This manual page was written by Sven Arvidsson <sa whiz se>,
+for the Debian system (but may be used by others).
+.SH SEE ALSO
+.BR "rhythmbox-client" (1).
+.P
+The online documentation available through the program's
+.I Help
+menu.
+
+



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]