root/trunk/doc/mesk.1.in

Revision 606, 2.5 kB (checked in by nicfit, 2 years ago)

Added dbus interface for raising the main window (--raise-window); closes #299

Line 
1 .TH MESK "1" "@MANPAGE_DATE@" "Mesk @PACKAGE_VERSION@" ""
2 .SH "NAME"
3 .B mesk
4 \- Gtk+ audio player
5 .SH "SYNOPSIS"
6 .B mesk
7 .RI [ options ]
8 .br
9
10 .SH "DESCRIPTION"
11 .B mesk
12 A Gtk+ GUI audio player written in python.
13
14 .SH "OPTIONS"
15 \fB\-h\fR, \fB\-\-help\fR
16 Display program usage and exit.
17 .TP
18 \fB\-\-version\fR
19 Display program version and exit.
20 .TP
21 \fB-p \fRNAME, \fB\-\-profile\fR=NAME
22 Run with profile NAME.  If the profile does not exist it is created.
23
24 .SH "REMOTE CONTROL OPTIONS"
25 \fB\-\-stop\fR
26 Stop playback.
27 .TP
28 \fB\-\-play\fR
29 Start playback.
30 .TP
31 \fB\-\-pause\fR
32 Pause playback.
33 .TP
34 \fB\-\-play-pause\fR
35 If playing, playback is paused. Otherwise the player is started.
36 .TP
37 \fB\-\-prev\fR
38 Move to previous track.
39 .TP
40 \fB\-\-next\fR
41 Move to next track.
42 .TP
43 \fB\-\-toggle-mute\fR
44 Mute or unmute depending on the current state.
45 .TP
46 \fB\-\-vol-up\fR=N
47 Increase the volume by N% (0.0 <= n <= 1.0)
48 .TP
49 \fB\-\-vol-down\fR=N
50 Decrease the volume by N% (0.0 <= n <= 1.0)
51 .TP
52 \fB\-\-get-state\fR
53 Returns the current state of the audio player (stopped, playing, paused).
54 .TP
55 \fB\-\-get-current-uri\fR
56 Returns the URI of the current audio source.
57 .TP
58 \fB\-\-get-current-title\fR
59 Returns the title of the current audio source.
60 .TP
61 \fB\-\-get-current-artist\fR
62 Returns the artist of the current audio source.
63 .TP
64 \fB\-\-get-current-album\fR
65 Returns the album name of the current audio source.
66 .TP
67 \fB\-\-get-current-year\fR
68 Returns the year of the current audio source.
69 .TP
70 \fB\-\-get-current-length\fR
71 Returns the length (in seconds) of the current audio source.
72 .TP
73 \fB\-\-list-playlists\fR
74 List all playlists.
75 .TP
76 \fB\-\-get-active-playlist\fR
77 List the name of the active PlaylistControl.  This value may be empty if no
78 playlists are active (e.g. a CDROM is active).
79 .TP
80 \fB\-\-set-active-playlist\fR=NAME
81 Set the active playlist.
82 .TP
83 \fB\-\-enqueue\fR=URI
84 Enqueue URI to the active playlist.
85 .TP
86 \fB\-\-toggle\-visible\fR
87 If the main window is not hidden it will be minimized to the system tray,
88 otherwise the window is shown.
89 .TP
90 \fB\-\-raise\-window\fR
91 Raise the main window (i.e., bring to front).
92
93 .SH "ADVANCED OPTIONS"
94 .TP
95 \fB-l \fRLEVEL, \fB\-\-log-level\fR=LEVEL
96 Run with a specific logging level: CRITICAL, ERROR, WARNING, INFO, VERBOSE, or
97 DEBUG.  The default log level is INFO.  Level names are case insensitive.
98 \fB\-\-debug\fR
99 Break in python debugger on unhandled exceptions.
100 .TP
101 \fB\-\-run-profiler\fR
102 Run using the Python profiler.
103 .TP
104 \fB\-\-gst-help\fR
105 Display GStreamer command line options.
106
107 .SH SEE ALSO
108 http://mesk.nicfit.net/
109
110 .SH AUTHOR
111 Mesk is written by Travis Shirk <travis@pobox.com>.
Note: See TracBrowser for help on using the browser.