about summary refs log tree commit homepage
path: root/Documentation/dtas-sourceedit.pod
blob: 67ecabfb3ac586adf782d658e37f5f302c8816a4 (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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
% dtas-sourceedit(1) dtas user manual

=head1 NAME

dtas-sourceedit - edit parameters of a source decoder

=head1 SYNOPSYS

dtas-sourceedit {sox | av | ff}

=head1 DESCRIPTION

dtas-sourceedit spawns an editor to allow editing of a source as a YAML file.
See L<dtas-player_protocol(7)> for details on SOURCEARGS.  If standard input is
a pipe or file, it is parsed as YAML and fed to the L<dtas-player(1)> instance
non-interactively.  This is useful for loading various profiles from the
filesystem.

On Linux machines, L<inotify(7)>
is used to monitor the file for changes while the text editor is running.
Each time a user finishes saving a file, changes are committed immediately.
This behavior may be disabled by using the -N or --no-watch command-line
switch.

=head1 OPTIONS

=over

=item -N, --no-watch

Disable L<inotify(7)> support on Linux systems

=item -n, --dry-run

Only print commands which would be sent to dtas-player

=item -V, --verbose

Print out commands as they are sent to dtas-player

=back

=head1 EXAMPLES

Invoking dtas-sourceedit will spawn your favorite text editor on "sox":

	$ dtas-sourceedit sox

To load an existing YAML profile for sox.  saved.yml could be the output
of a previous "dtas-ctl source cat sox" invocation:

	$ dtas-sourceedit sox < saved.yml

To change the way dtas-player calls avconv (part of libav):

	$ dtas-sourceedit av

To change the way dtas-player calls ffmpeg (lightly-tested):

	$ dtas-sourceedit ff

=head1 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

=head1 CONTACT

All feedback welcome via plain-text mail to: L<mailto:dtas-all@nongnu.org>

Mailing list archives available at L<https://80x24.org/dtas-all/>
and L<https://lists.gnu.org/archive/html/dtas-all/>

No subscription is necessary to post to the mailing list.

=head1 COPYRIGHT

Copyright 2013-2020 all contributors L<mailto:dtas-all@nongnu.org>

License: GPL-3.0+ L<https://www.gnu.org/licenses/gpl-3.0.txt>

=head1 SEE ALSO

L<dtas-player(1)>, L<dtas-player_protocol(7)>, L<dtas-ctl(1)>