about summary refs log tree commit homepage
path: root/Documentation/dtas-archive.txt
diff options
context:
space:
mode:
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.txt
parent0699498e5eb717a351c223e6a5a6a3bd3d3c6cde (diff)
downloaddtas-3083b7fbe2bc6e8dcd935b10bb7a165257c5252b.tar.gz
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.txt')
-rw-r--r--Documentation/dtas-archive.txt62
1 files changed, 0 insertions, 62 deletions
diff --git a/Documentation/dtas-archive.txt b/Documentation/dtas-archive.txt
deleted file mode 100644
index fdc818d..0000000
--- a/Documentation/dtas-archive.txt
+++ /dev/null
@@ -1,62 +0,0 @@
-% dtas-archive(1) dtas user manual
-%
-
-# NAME
-
-dtas-archive - paranoid audio file copy
-
-# SYNOPSYS
-
-dtas-archive [OPTIONS] SOURCE DESTINATION
-
-# DESCRIPTION
-
-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 posix_fadvise(2) can be used to
-drop caches for a particular file after fsync(2).
-
-dtas-archive spawns sox(1) to archive audio data (likely uncompressed
-WAVE) to FLAC and verifies the result using sndfile-cmp(1), a tool
-implemented by different than sox and less likely to share the same bugs
-(if any) as sox.
-
-# OPTIONS
-
--j, \--jobs [JOBS]
-:    Number of jobs to run in parallel.  Incrementing this may hurt
-     performance on slow storage devices.  Default: 1
-
--n, \--dry-run
-:    Print, but do not run the commands to be executed
-
--s, \--quiet, \--silent
-:    Silent operation, commands are not printed as executed
-
--S, \--stats
-:    Run and save the text output of the sox "stats" effect as
-     $DESTINATION_FILE_WITHOUT_SUFFIX.stats next to the output file
-
--k, \--keep-going
-:    Continue after error
-
--r, \--repeat [COUNT]
-:    Number of times to repeat the sndfile-cmp(1) check.  Default: 1
-
-# COPYRIGHT
-
-Copyright 2015-2016 all contributors <dtas-all@nongnu.org>.\
-License: GPL-3.0+ <http://www.gnu.org/licenses/gpl-3.0.txt>
-
-# CONTACT
-
-All feedback welcome via plain-text mail to: <dtas-all@nongnu.org>\
-Mailing list archives available at <http://80x24.org/dtas-all/> and
-<ftp://lists.gnu.org/dtas-all/>\
-No subscription is necessary to post to the mailing list.
-
-# SEE ALSO
-
-sndfile-cmp(1), sox(1)