From 3083b7fbe2bc6e8dcd935b10bb7a165257c5252b Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Mon, 18 Jan 2016 05:18:09 +0000 Subject: doc: convert to perlpod(1) from Markdown perlpod(1) is already installed by default on Debian and RedHat-based systems; and probably most modern *nixes; pandoc(1) (and Haskell) are not. POD also more standardized than Markdown (which flavor? :P), especially for generating manpages. So save any potential documentation editors some disk space by not forcing them to install Haskell and pandoc. Finally, I'm a mildly proficient in Perl and do not know Haskell at all and have a better chance at reading/hacking the source if the document generator breaks. --- Documentation/dtas-env.pod | 75 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 Documentation/dtas-env.pod (limited to 'Documentation/dtas-env.pod') diff --git a/Documentation/dtas-env.pod b/Documentation/dtas-env.pod new file mode 100644 index 0000000..b16da35 --- /dev/null +++ b/Documentation/dtas-env.pod @@ -0,0 +1,75 @@ +% dtas-env(7) dtas user manual + +=head1 NAME + +dtas-env - environment variables used through DTAS + +=head1 DESCRIPTION + +As dtas uses Bourne shell and exposes it to users, dtas should have +a cohesive set of common environment variables across its audio +production and playback environments. This attempts to document +them. Most of these environments are set and managed by dtas +itself, but users editing commands (e.g. via L +should be aware of them. + +=head1 ENVIRONMENT + +=over + +=item ECAFMT + +A snippet of command-line switches for ecasound describing +audio format parameters (such as word length, channels, sample rate), +see L for more info. (e.g. "-fs32_le,2,44100") + +=item INFILE + +The primary input file for playback or processing. (e.g. "/path/to/ex.flac") + +=item RGFX + +The sox effect used for applying ReplayGain compensation. +Only used during playback in dtas-player. (e.g. "gain -6.0"). +Removing this prevents ReplayGain from working and may damage +playback equipment with loudly mastered music. + +=item SOXFMT + +A snippet of command-line switches for sox describing +audio format parameters (such as word length, channels, sample rate), +see L for more info. (e.g. "-ts32 -c2 -r44100") + +=item TRIMFX + +The sox effect used for seeking during playback with dtas-player +and track offsets for dtas-splitfx. (e.g. "trim 36000s") + +Additionally, L documents more environment variables +which are not used elsewhere. + +=back + +=head1 ENVIRONMENT FOR OTHER EXECUTABLES + +By virtue of running other programs, dtas indirectly uses many +commonly-accepted environment variables such as EDITOR / VISUAL for +selecting a text editor, and SOX_OPTS, AUDIODEV, AUDIODRIVER for L +and L commands and LADSPA_PATH for anything using LADSPA plugins +(including sox). The TMPDIR environment variable controls where +temporary files are placed for most programs. + +=head1 CONTACT + +All feedback welcome via plain-text mail to: L + +Mailing list archives available at L +and L + +No subscription is necessary to post to the mailing list. + +=head1 COPYRIGHT + +Copyright 2013-2016 all contributors L + +License: GPL-3.0+ L -- cgit v1.2.3-24-ge0c7