wmusic: Add manpage (adapted from Debian)
[dockapps.git] / wmusic / wmusic.1
blob238b924eb4ccb9435651cb38e368ac8f2be53ea8
1 .TH WMUSIC 1 "June 22, 2018"
2 .SH NAME
3 wmusic \- a remote-control DockApp for MPRIS-compatible media players
4 .SH SYNOPSIS
5 .B wmusic
6 .RI [ options ]
7 .SH DESCRIPTION
8 This manual page documents briefly the
9 .B wmusic command.
10 \fBwmusic\fP is a dockapp that remote-controls MPRIS-compatible media players.
11 Features include VCR-style controls, Time and Playlist display, supa stylee
12 rotating arrow.
13 .SH OPTIONS
14 These programs follow the usual GNU command line syntax, with long
15 options starting with two dashes (`-').
16 A summary of options is included below.
17 For a complete description, see the Info files.
18 .TP
19 .B \-h, \-\-help
20 Show summary of options.
21 .TP
22 .B \-v, \-\-version
23 Show version of program.
24 .TP
25 .B \-c, \-\-command <program>
26 Use <program> as the command to launch the media player. You can start it
27 by a double-click into the status part of \fBwmusic\fP.
28 .TP
29 .B \-d, \-\-display host:display[.screen]
30 specifies the X server to contact; see X(1).
31 .TP
32 .B \-r, \-\-run
33 Run the media player on startup.
34 .TP
35 .B \-R, \-\-run\-exclusive
36 Run the media player on startup, exit when it exits.
37 .TP
38 .B \-V, \-\-volume
39 Stepping of the wheel volume control (in percent).
40 .TP
41 .B \-w, \-\-windowed
42 Run in windowed mode. Use this, if you want to run \fBwmusic\fP in
43 the AfterStep wharf.
44 .TP
45 .B \-a, \-\-rotate-arrow
46 Stop the rotating arrow when \fBwmusic\fP is paused.
47 .TP
48 .B \-l, \-\-time-left
49 Start \fBwmusic\fP with the display showing time left instead of time
50 elapsed.
51 .SH SEE ALSO
52 .BR wmaker (1)
53 .SH AUTHOR
54 wmusic was originally written by Bastien Nocera <hadess@hadess.net> and
55 it is now maintained by the Window Maker Team <wmaker-dev@googlegroups.com>.
56 This manual page was written by Alain Schroeder <alain@debian.org>,
57 for the Debian GNU/Linux system (but may be used by others).