shithub: sox

Download patch

ref: 544b7d532e75aa3b4690fc7b72c44646065f2907
parent: b944867d473bf74869e282e28fdc25f134b6d6d9
author: cbagwell <cbagwell>
date: Thu Apr 8 22:38:02 EDT 1999

Updated docs

--- a/INSTALL
+++ b/INSTALL
@@ -2,7 +2,7 @@
 
 This distribution will compile and run on most Unix systems.
 It was originally developed on a Unix/386 machine running AT&T V.3.2
-but it currently developed under Linux.  With little work it should
+but its currently developed under Linux.  With little work it should
 work with most SVR4 systems, BSD-derived Unix's and DOS systems that
 use the GNU tool set.
 
@@ -10,7 +10,7 @@
 ---------
 
 The perfered method for compiling sox is to use the "configure" scripts
-compatible with most unix systems that contain "/bin/sh" or equivelent
+compatible with most unix systems that contain "/bin/sh" or equivalent
 (even the Win95/NT Cygwin setup will work with this).
 
 To compile SoX on these platforms run the following commands:
@@ -19,9 +19,10 @@
     make
     make install
 
-You should then have a working version of sox in sox directory.
-If your actively developing SoX, you may optionally wish to run 
-"make depend" after configure to create a detailed dependiency list.
+You should then have a working version of sox in the directory.  There
+are several optional parameters that you may pass to the configure
+script to customize SoX for your applications.  Run "./configure --help"
+for a complete list of options.
 
 If your system works with the "configure" script then you may skip
 to the Testing section.
@@ -31,7 +32,7 @@
 have a canned Makefile:
 
     AMIGA      Makefile.ami (hasn't been verified lately)
-    DOS        Makefile.dos (Borland and Turbo C, almost Microsoft C++)
+    DOS        Makefile.dos (Borland and Turbo C)
 	    or Makefile.unx (using GCC compatible compiler)
     OS/2       Makefile.unx (using EMX GCC compiler)
     OS9        Makefile.os9
@@ -44,7 +45,7 @@
 command line:
 
 make -f Makefile.name      or
-make -fmakefile.name
+make -fMakefile.name
 
 Before compiling with a canned Makefile you will need to edit the 
 Makefile and uncomment the compiler define section related to your 
@@ -52,8 +53,7 @@
 
 There are a few additional defines available for your operating 
 system to add things such as sound playing support.  This is 
-generally documented in the Makefiles.  Look at Makefile.unx for
-the most complete set of optional defines that Sox supports.
+generally documented in the Makefiles
 
 There is optional GSM support as a data type but you must first
 install the GSM library on your system.  More information on it
--- a/README
+++ b/README
@@ -57,22 +57,16 @@
 changes using real signal theory.  Yes, it's very slow.  There seems
 to be a small problem with aliasing with 'resample' currently.
 
-More big news!  Sample loops are now supported in a few
-file formats: SMP and AIFF.  WAV and VOC needs it.  I don't know
-what other formats actually know about sampler notes & loops.
-(To make a loop, you need a waveform editor that knows about
-them and has special features.)
-
 History:
 
 This is the 12th release, Patchlevel 16 of the Sound Tools.
-Sox was originally written and maintained by Lance Norskog but
+SoX was originally written and maintained by Lance Norskog but
 unfortunetly he has stopped maintaining it since 1995.  I, Chris
 Bagwell (cbagwell@sprynet.com), have started maintaining it since
-1996 to the present.  Lance may take supporting it back up in the future
-but until that time I will keep pushing its development forward.
+1996 to the present.
 
 Caveats:
+
 SoX is intended as the Swiss Army knife of sound processing tools.  It 
 doesn't do anything very well, but sooner or later it comes in very handy.
 SoX is really only usable day-to-day if you hide the wacky options with 
@@ -79,6 +73,7 @@
 one-line shell scripts.
 
 Installing:
+
 Unless your using a precompiled binary version, you will need to compile
 SoX as described in the INSTALL file.  Please read that file for further
 instructions.
@@ -85,8 +80,7 @@
 
 Now, read TIPS, CHEAT.eft and CHEAT.  These give a background on how
 SoX deals with sound files and how to convert this format
-to that format, and apply various effects with examples for the most 
-popular formats.
+to that format, and apply various effects.
 
 SoX uses file suffices to determine the nature of a sound sample file.
 If it finds the suffix in its list, it uses the appropriate read
@@ -96,7 +90,7 @@
 
 SoX has an auto-detect feature that attempts to figure out
 the nature of an unmarked sound sample.  It works very well.
-This is the 'auto' file format.
+This feature is used if you specify '-t auto' for the file type.
 
 I hope to inspire the creation of a common base of sound processing
 tools for computer multimedia work, similar to the PBM toolkit for 
@@ -144,12 +138,6 @@
 			AIFF Loop/MIDI support
 		David Sanderson		dws@ssec.wisc.edu
 			AIX3.1 fixes
-			(Note that to my knowledge AIX on RS/6000s has
-			NO SUPPORT for playing any sort of sound file,
-			so please don't write to me any more to ask
-			"how do I play sound files on my AIX box".  I
-			ported sox to AIX solely to use it to translate
-			between sound file formats.)
 		Glenn Lewis		glewis@pcocd2.intel.com
 			AIFF chunking fixes
 		Brian Campbell		brianc@quantum.qnx.com