summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenjamin Franzke <benjaminfranzke@googlemail.com>2012-01-05 01:16:26 +0100
committerBenjamin Franzke <benjaminfranzke@googlemail.com>2012-01-05 10:27:32 +0100
commitf04d759a3fa1f14d8b8779f4cf6855db4c6f8d8f (patch)
tree53f4df75ff8c3bf95d62fea21cb05cff97eace99
parentb87627e11f6845e2db24d60702ce681b5910742b (diff)
downloadpa-sink-ctl-f04d759a3fa1f14d8b8779f4cf6855db4c6f8d8f.tar.gz
pa-sink-ctl-f04d759a3fa1f14d8b8779f4cf6855db4c6f8d8f.tar.bz2
pa-sink-ctl-f04d759a3fa1f14d8b8779f4cf6855db4c6f8d8f.zip
Add a manpage using asciidoc
-rw-r--r--.gitignore3
-rw-r--r--src/Makefile.am9
-rw-r--r--src/pa-sink-ctl-manpage.css21
-rw-r--r--src/pa-sink-ctl.1.txt72
4 files changed, 105 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index d1a3a13..1dd4620 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,9 @@
# executable
pa-sink-ctl
+# man
+pa-sink-ctl.1
+pa-sink-ctl.1.html
# objects
*.o
diff --git a/src/Makefile.am b/src/Makefile.am
index 4401bfa..3579dc0 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -12,3 +12,12 @@ AM_CPPFLAGS = $(PULSE_CFLAGS) $(PULSE_MAINLOOP_CFLAGS) $(GLIB_CFLAGS) \
pa_sink_ctl_LDADD = $(GLIB_LIBS) $(PULSE_LIBS) $(PULSE_MAINLOOP_LIBS) $(CURSES_LIBS)
noinst_HEADERS = interface.h command.h config.h pa-sink-ctl.h ctl.h unix_signal.h
+
+dist_man_MANS = pa-sink-ctl.1
+EXTRA_DIST = pa-sink-ctl.1.txt
+
+%: %.txt
+ a2x -f manpage $<
+
+%.html: %.txt
+ a2x -f xhtml -d manpage --stylesheet=pa-sink-ctl-manpage.css $<
diff --git a/src/pa-sink-ctl-manpage.css b/src/pa-sink-ctl-manpage.css
new file mode 100644
index 0000000..f6ff151
--- /dev/null
+++ b/src/pa-sink-ctl-manpage.css
@@ -0,0 +1,21 @@
+/* Overrides for manpage documents */
+h1 {
+ padding-top: 0.5em;
+ padding-bottom: 0.5em;
+ border-top: 2px solid silver;
+ border-bottom: 2px solid silver;
+}
+h2 {
+ border-style: none;
+}
+div.sectionbody {
+ margin-left: 5%;
+}
+
+@media print {
+ div#toc { display: none; }
+}
+
+table,tr,td,th {
+ border: 1px solid black !important;
+}
diff --git a/src/pa-sink-ctl.1.txt b/src/pa-sink-ctl.1.txt
new file mode 100644
index 0000000..59c6f22
--- /dev/null
+++ b/src/pa-sink-ctl.1.txt
@@ -0,0 +1,72 @@
+pa-sink-ctl(1)
+==============
+
+
+NAME
+----
+pa-sink-ctl - NCurses based PulseAudio control client
+
+SYNOPSIS
+--------
+*pa-sink-ctl*
+
+DESCRIPTION
+-----------
+*pa-sink-ctl* is a ncurses PulseAudio control utitilty that lets you change
+volume, set mute state and change assigned stream output of PulseAudio
+controls.
+
+This program takes no command line options.
+
+DEFAULT KEYBINDINGS
+-------------------
+
+[frame="all", options="header", valign="top"]
+|==============================================================
+|up |down |volume-down |volume-up |mute |switch |quit
+|KEY_UP |KEY_DOWN |KEY_LEFT |KEY_RIGHT |m |TAB |ESCAPE
+|k |j |h |l |M |SPACE |q
+|w |s |a |d |x |RETURN |
+|==============================================================
+
+CONFIGURATION
+-------------
+The configuration is read either from '/etc/xdg/pa-sink-ctl/config'
+or '$XDG_CONFIG_HOME/pa-sink-ctl/config' if available.
+The configuration file corresponds to the Desktop Entry Specification.
+Key files consists of groups of key-value pairs, interspersed with comments.
+Value list elements are seperated by '';''.
+
+See '/etc/xdg/pa-sink-ctl/config' for an example config.
+
+Available Config Groups
+~~~~~~~~~~~~~~~~~~~~~~~
+pa-sink-ctl
+^^^^^^^^^^^
+ name-properties - Properties tried in order as control name
+
+input
+^^^^^
+Input values are a list of keys for an action.
+
+ up - Select next control
+ down - Select previous control
+ volume-down - Increase volume
+ volume-up - Decrease Volume
+ mute - Mute currently selected control
+ switch - Move a input / output to next sink / source
+ quit - Quit pa-sink-ctl
+
+priority *
+^^^^^^^^^^
+ match - PulseAudio property to match against
+ value - Value to compare against 'match'
+ priority - Priority to assign to device with matched value
+
+AUTHOR
+------
+Benjamin Franzke & Jan Klemkow
+
+SEE ALSO
+--------
+'pactl(1)', 'pacmd(1)'