diff options
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | src/Makefile.am | 9 | ||||
| -rw-r--r-- | src/pa-sink-ctl-manpage.css | 25 | ||||
| -rw-r--r-- | src/pa-sink-ctl.1.txt | 74 |
4 files changed, 111 insertions, 0 deletions
@@ -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..d75c4a6 --- /dev/null +++ b/src/pa-sink-ctl-manpage.css @@ -0,0 +1,25 @@ +/* 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; +} + +pre.literallayout { + margin-left: 15px; +} diff --git a/src/pa-sink-ctl.1.txt b/src/pa-sink-ctl.1.txt new file mode 100644 index 0000000..d05aa3d --- /dev/null +++ b/src/pa-sink-ctl.1.txt @@ -0,0 +1,74 @@ +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 outputs/inputs of PulseAudio controls. + +This program takes no command line options. + +DEFAULT KEYBINDINGS +------------------- + + up -- [ UP, k, w ] + down -- [ DOWN, j, s ] + left -- [ LEFT, h, a ] + right -- [ RIGHT, l, d ] + mute -- [ M, m, x ] + switch -- [ RETURN, SPACE, TAB ] + quit -- [ ESCAPE, q ] + +See `input' section of `Available Config Groups' for an explanation of these +commands. + +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)' |