about summary refs log tree commit homepage
path: root/Documentation/dtas-sinkedit.txt
blob: 892320a9232a8447da56558d978121a076e54a43 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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)