From fe5aad0bdfe8e12d4cf92f9555273276fddf1aae Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Fri, 25 Dec 2015 08:32:25 +0000 Subject: doc: various wording fixes and doc enhancements English grammar is not easy :x While we're at it, dtas-archive.txt is expanded to document things like: http://80x24.org/dtas-all/20150918085401.GA8610@dcvr.yhbt.net/ (bus failure). --- Documentation/dtas-archive.txt | 11 ++++++----- Documentation/dtas-player_protocol.txt | 2 +- Documentation/dtas-player_sink_examples.txt | 2 -- INSTALL | 9 ++++----- README | 6 +++--- 5 files changed, 14 insertions(+), 16 deletions(-) diff --git a/Documentation/dtas-archive.txt b/Documentation/dtas-archive.txt index f701a5e..c78e1c4 100644 --- a/Documentation/dtas-archive.txt +++ b/Documentation/dtas-archive.txt @@ -11,11 +11,12 @@ dtas-archive [OPTIONS] SOURCE DESTINATION # DESCRIPTION -dtas-archive is intended for archiving audio data to/from laptops and -computers without ECC memory, attempting to read data multiple times in -an attempt to detect memory 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 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 diff --git a/Documentation/dtas-player_protocol.txt b/Documentation/dtas-player_protocol.txt index 18dc2ab..54b87ca 100644 --- a/Documentation/dtas-player_protocol.txt +++ b/Documentation/dtas-player_protocol.txt @@ -20,7 +20,7 @@ This must stay over Unix sockets because filesystem permissions are needed to enforce code execution permissions. dtas-player is really a shell in disguise, after all. -Protocol feedback greatly appreciated email us at dtas-all@nongnu.org +Protocol feedback greatly appreciated, email us at dtas-all@nongnu.org ********************************************************* diff --git a/Documentation/dtas-player_sink_examples.txt b/Documentation/dtas-player_sink_examples.txt index e9d28a9..d7ea73e 100644 --- a/Documentation/dtas-player_sink_examples.txt +++ b/Documentation/dtas-player_sink_examples.txt @@ -11,8 +11,6 @@ dtas-sinkedit SINKNAME # EXAMPLES - - ## Streaming Ogg-Vorbis to Icecast To use oggfwd(1) and Icecast, the following sink works. diff --git a/INSTALL b/INSTALL index 6fce79f..04c2bf9 100644 --- a/INSTALL +++ b/INSTALL @@ -1,19 +1,18 @@ Uncommon for audio software, dtas is implemented in Ruby. The latest stable release or development snapshot of Ruby is recommended. -However, Ruby 1.9.3 should work, too. Older versions of Ruby are not -recommended. +However, Ruby 1.9.3 and later works, but older versions of Ruby do not. -SoX is a dependency of dtas-player. While not _strictly_ required, the +SoX is a dependency of dtas-player. While not _strictly_ required, dtas-player uses SoX by default and you will need it unless you've reconfigured dtas-player to use something else. -mp3gain is required if you use ReplayGain with MP3s +mp3gain is required if you want to use ReplayGain with MP3s If you only intend to use dtas-cueedit, you will need metaflac(1) from the FLAC package. -Debian 7 users can install dependencies easily: +Debian 7+ users can install dependencies easily: sudo apt-get install sox libsox-fmt-all mp3gain flac ruby-dev diff --git a/README b/README index f4119e9..5cf155e 100644 --- a/README +++ b/README @@ -75,7 +75,7 @@ pull-requests) via plain-text mail to the mailing list is very much appreciated. Please send plain-text mail to the list at \ -HTML will not be read. dtas is for GUI-phobes, by GUI-phobes.\ +HTML mail will not be read. dtas is for GUI-phobes, by GUI-phobes.\ Mailing list archives available at or No subscription is necessary to post to the mailing list. @@ -105,6 +105,6 @@ You should have received a copy of the GNU General Public License along with this program; if not, see https://www.gnu.org/licenses/gpl-3.0.txt Note: The GPL does not and can not apply to external commands run by -dtas scripts, so users _may_ run any non-Free Software you want via dtas +dtas scripts, so users _may_ run any non-Free Software they want via dtas (just like one may do so via bash). However, the dtas project does not -endorse nor support the use of any non-Free Software. +endorse or support the use of any non-Free Software. -- cgit v1.2.3-24-ge0c7