From 2f472588c7bbe140ec7d25040d1d00fc9b153746 Mon Sep 17 00:00:00 2001 From: Doug Torrance Date: Fri, 22 Jun 2018 16:21:06 -0400 Subject: [PATCH] wmusic: Add manpage (adapted from Debian) --- wmusic/Makefile.am | 1 + wmusic/wmusic.1 | 57 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 wmusic/wmusic.1 diff --git a/wmusic/Makefile.am b/wmusic/Makefile.am index 3acd4d5..c7e6310 100644 --- a/wmusic/Makefile.am +++ b/wmusic/Makefile.am @@ -1,5 +1,6 @@ bin_PROGRAMS = wmusic wmusic_SOURCES = src/wmusic.c src/wmusic-digits.xpm src/wmusic-master.xpm +dist_man_MANS = wmusic.1 AM_CFLAGS = $(X11_CFLAGS) $(DOCKAPP_CFLAGS) $(PLAYERCTL_CFLAGS) LIBS += $(X11_LIBS) $(DOCKAPP_LIBS) $(PLAYERCTL_LIBS) diff --git a/wmusic/wmusic.1 b/wmusic/wmusic.1 new file mode 100644 index 0000000..238b924 --- /dev/null +++ b/wmusic/wmusic.1 @@ -0,0 +1,57 @@ +.TH WMUSIC 1 "June 22, 2018" +.SH NAME +wmusic \- a remote-control DockApp for MPRIS-compatible media players +.SH SYNOPSIS +.B wmusic +.RI [ options ] +.SH DESCRIPTION +This manual page documents briefly the +.B wmusic command. +\fBwmusic\fP is a dockapp that remote-controls MPRIS-compatible media players. +Features include VCR-style controls, Time and Playlist display, supa stylee +rotating arrow. +.SH OPTIONS +These programs follow the usual GNU command line syntax, with long +options starting with two dashes (`-'). +A summary of options is included below. +For a complete description, see the Info files. +.TP +.B \-h, \-\-help +Show summary of options. +.TP +.B \-v, \-\-version +Show version of program. +.TP +.B \-c, \-\-command +Use as the command to launch the media player. You can start it +by a double-click into the status part of \fBwmusic\fP. +.TP +.B \-d, \-\-display host:display[.screen] +specifies the X server to contact; see X(1). +.TP +.B \-r, \-\-run +Run the media player on startup. +.TP +.B \-R, \-\-run\-exclusive +Run the media player on startup, exit when it exits. +.TP +.B \-V, \-\-volume +Stepping of the wheel volume control (in percent). +.TP +.B \-w, \-\-windowed +Run in windowed mode. Use this, if you want to run \fBwmusic\fP in +the AfterStep wharf. +.TP +.B \-a, \-\-rotate-arrow +Stop the rotating arrow when \fBwmusic\fP is paused. +.TP +.B \-l, \-\-time-left +Start \fBwmusic\fP with the display showing time left instead of time +elapsed. +.SH SEE ALSO +.BR wmaker (1) +.SH AUTHOR +wmusic was originally written by Bastien Nocera and +it is now maintained by the Window Maker Team . +This manual page was written by Alain Schroeder , +for the Debian GNU/Linux system (but may be used by others).