README.sh

   1 #!/bin/sh
   2
   3 cat > README << .
   4                               SoX: Sound eXchange
   5                               ===================
   6
   7 SoX (Sound eXchange) is the Swiss Army knife of sound processing tools: it
   8 can convert sound files between many different file formats & audio devices,
   9 and can apply many sound effects & transformations, as well as doing basic
  10 analysis and providing input to more capable analysis and plotting tools.
  11
  12 SoX is licensed under the GNU GPL and GNU LGPL.  To be precise, the 'sox'
  13 and 'soxi' programs are distributed under the GPL, while the library
  14 'libsox' (in which most of SoX's functionality resides) is dual-licensed.
  15 Note that some optional components of libsox are GPL only: if you use these,
  16 you must use libsox under the GPL.  See INSTALL for the list of optional
  17 components and their licences.
  18
  19 If this distribution is of source code (as opposed to pre-built binaries),
  20 then you will need to compile and install SoX as described in the 'INSTALL'
  21 file.
  22
  23 Changes between this release and previous releases of SoX can be found in
  24 the 'ChangeLog' file; a summary of the file formats and effects supported in
  25 this release can be found below.  Detailed documentation for using SoX can
  26 be found in the distributed 'man' pages:
  27
  28   o  sox(1)
  29   o  soxi(1)
  30   o  soxformat(7)
  31   o  libsox(3)
  32
  33 or in plain text or PDF files for those systems without man.
  34
  35 The majority of SoX features and fixes are contributed by SoX users - thank
  36 you very much for making SoX a success!  There are several new features
  37 wanted for SoX, listed on the feature request tracker at the SoX project
  38 home-page:
  39
  40                     http://sourceforge.net/projects/sox
  41
  42 users are encouraged to implement them!
  43
  44 Please submit bug reports, new feature requests, and patches to the relevant
  45 tracker at the above address, or by email:
  46
  47                    mailto:sox-devel@lists.sourceforge.net
  48
  49 Also accessible via the project home-page is the SoX users' discussion
  50 mailing list which you can join to discuss all matters SoX with other SoX
  51 users; the mail address for this list is:
  52
  53                    mailto:sox-users@lists.sourceforge.net
  54
  55 .
  56 cat FEATURES.in \
  57         | sed "s/!!/                    /" \
  58         | sed "s/^\*\*/    o /" \
  59         | sed "s/^\*/  o /" \
  60         | sed "s/(:[a-zA-Z0-9_= -]*:)//g" \
  61         >> README
  62
  63 echo version=pmwiki-2.2.0-beta65 ordered=1 urlencoded=1 > Docs.Features
  64 echo -n text= >> Docs.Features
  65 cat FEATURES.in|sed "s/%/%25/g"|sed "s/$/%0a/"|tr -d '\n' >> Docs.Features