about summary refs log tree commit homepage
path: root/Documentation/dtas-archive.pod
diff options
authorEric Wong <e@80x24.org>2016-01-18 05:18:09 +0000
committerEric Wong <e@80x24.org>2016-01-18 07:02:39 +0000
commit3083b7fbe2bc6e8dcd935b10bb7a165257c5252b (patch)
treeaf5d87ea9a2ea161df619c2305ef951cb18d087a /Documentation/dtas-archive.pod
parent0699498e5eb717a351c223e6a5a6a3bd3d3c6cde (diff)
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.
Diffstat (limited to 'Documentation/dtas-archive.pod')
1 files changed, 74 insertions, 0 deletions
diff --git a/Documentation/dtas-archive.pod b/Documentation/dtas-archive.pod
new file mode 100644
index 0000000..38f5570
--- /dev/null
+++ b/Documentation/dtas-archive.pod
@@ -0,0 +1,74 @@
+% dtas-archive(1) dtas user manual
+=head1 NAME
+dtas-archive - paranoid audio file copy
+=head1 SYNOPSYS
+dtas-archive is intended for archiving audio data to/from laptops,
+marginal USB ports, and computers without ECC memory, attempting
+to read data multiple times in an attempt to detect memory or
+bus corruption.  dtas-archive may only be effective on machines
+running the Linux kernel where L<posix_fadvise(2)> can be used to
+drop caches for a particular file after L<fsync(2)>.
+dtas-archive spawns L<sox(1)> to archive audio data (likely uncompressed
+WAVE) to FLAC and verifies the result using L<sndfile-cmp(1)>, a tool
+implemented by different than sox and less likely to share the same bugs
+(if any) as sox.
+=head1 OPTIONS
+=item -j, --jobs [JOBS]
+Number of jobs to run in parallel.  Incrementing this may hurt
+performance on slow storage devices.  Default: 1
+=item -n, --dry-run
+Print, but do not run the commands to be executed
+=item -s, --quiet, --silent
+Silent operation, commands are not printed as executed
+=item -S, --stats
+Run and save the text output of the sox "stats" effect as
+$DESTINATION_FILE_WITHOUT_SUFFIX.stats next to the output file
+=item -k, --keep-going
+Continue after error
+=item -r, --repeat [COUNT]
+Number of times to repeat the L<sndfile-cmp(1)> check.  Default: 1
+Copyright 2013-2016 all contributors L<mailto:dtas-all@nongnu.org>
+License: GPL-3.0+ L<http://www.gnu.org/licenses/gpl-3.0.txt>
+=head1 CONTACT
+All feedback welcome via plain-text mail to: L<mailto:dtas-all@nongnu.org>
+Mailing list archives available at L<http://80x24.org/dtas-all/>
+and L<ftp://lists.gnu.org/dtas-all/>
+No subscription is necessary to post to the mailing list.
+=head1 SEE ALSO
+L<sndfile-cmp(1)>, L<sox(1)>