From f468d58468b224ea3fb468c9543d8631164f8c55 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sun, 25 Aug 2013 00:47:13 +0000 Subject: manpage installation updates We should be compatible with "gem-man", as well as allowing installation to prefix ($HOME by default) via: make -C Documentation install-man --- Documentation/dtas-sinkedit.txt | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 Documentation/dtas-sinkedit.txt (limited to 'Documentation/dtas-sinkedit.txt') diff --git a/Documentation/dtas-sinkedit.txt b/Documentation/dtas-sinkedit.txt new file mode 100644 index 0000000..892320a --- /dev/null +++ b/Documentation/dtas-sinkedit.txt @@ -0,0 +1,41 @@ +% dtas-sinkedit(1) dtas user manual +% + +# NAME + +dtas-sinkedit - edit the command and environment of a sink + +# SYNOPSYS + +dtas-sinkedit SINKNAME + +# DESCRIPTION + +dtas-sinkedit spawns an editor to allow editing of a sink as a YAML file. +See dtas-player_protocol(7) for details on SINKARGS. + +# EXAMPLES + +To get a list of existing sink names + + $ dtas-ctl ls + +Invoking dtas-sinkedit will spawn your favorite text editor on a +given SINKNAME: + + $ dtas-sinkedit SINKNAME + +If SINKNAME was not listed, it will be created (in an inactive state). +Successfully exiting your text editor will send the changes to the +running dtas-player. + +# ENVIRONMENT + +VISUAL / EDITOR - your favorite *nix text editor, defaults to 'vi' if unset. + +DTAS_PLAYER_SOCK - the path to the dtas-player control socket. +This defaults to ~/.dtas/player.sock + +# SEE ALSO + +dtas-player(1), dtas-player_protocol(7), dtas-ctl(1) -- cgit v1.2.3-24-ge0c7