vorbis-tools/README

   1 WHAT'S HERE:
   2
   3 This source distribution includes the vorbis-tools and nothing else.
   4 The audio codec libraries for use with Ogg bitstreams are contained in
   5 other modules: vorbis, speex and flac.
   6
   7
   8 DIRECTORIES:
   9
  10 debian/         debian packaging stuff
  11 include/        header files shared between the tools
  12 intl/           GNU gettext library from gettext-0.10.40 (for i18n support)
  13 ogg123/         an ogg vorbis command line audio player
  14 oggenc/         the ogg vorbis encoder
  15 oggdec/         a simple, portable command line decoder (to wav and raw)
  16 ogginfo/        provides information (tags, bitrate, length, etc.) about
  17                 an ogg vorbis file
  18 po/             translations for non-English languages
  19 share/          code shared between the tools
  20 vcut/           cuts an ogg vorbis file into two parts at a particular point
  21 vorbiscomment/  edits the comments in an ogg vorbis file
  22 win32/          Win32 build stuff
  23
  24
  25 DEPENDENCIES:
  26
  27 All of the tools require libogg and libvorbis to be installed (along
  28 with the header files).  Additionally, ogg123 requires libao, libcurl,
  29 and a POSIX-compatible thread library.  Ogg123 can optionally compiled
  30 to use libFLAC, and libspeex.  Oggenc can be optionally compiled with
  31 libFLAC, and libkate.  The libraries libogg, libvorbis, and libao are
  32 all available at
  33   http://www.vorbis.com/download.psp
  34
  35 The libcurl library is packaged with most Linux distributions.  The
  36 source code can also be downloaded from:
  37   http://curl.haxx.se/libcurl/
  38
  39 FLAC is available at:
  40   http://flac.sourceforge.net
  41
  42 Speex is available at:
  43   http://www.speex.org/
  44
  45 libkate is available at:
  46   http://libkate.googlecode.com/
  47
  48
  49 CONTACT:
  50
  51 The Ogg Vorbis homepage is located at 'http://www.vorbis.com'. Up to
  52 date technical documents, contact information, source code and
  53 pre-built utilities may be found there.
  54
  55 Developer information is available from http://www.xiph.org/. Check
  56 there for bug reporting information, mailing lists and other resources.
  57
  58
  59 BUILDING FROM SUBVERSION (see the file HACKING for details):
  60
  61 ./autogen.sh
  62 make
  63
  64 and as root if desired :
  65
  66 make install
  67
  68 This will install the tools into /usr/local/bin and manpages into
  69 /usr/local/man.
  70
  71
  72 BUILDING FROM TARBALL DISTRIBUTIONS:
  73
  74 ./configure
  75 make
  76
  77 and as root if desired :
  78
  79 make install
  80
  81 BUILDING RPMS:
  82
  83 RPMs may be built by:
  84
  85 after autogen.sh or configure
  86
  87 make dist
  88 rpm -ta vorbis-tools-<version>.tar.gz
  89
  90
  91 KNOWN BUGS:
  92
  93 #1321
  94   First noticed in non-English versions of the application, ogg123 has a major
  95   bug when it comes to status messages in the shell: any output bigger than
  96   the console's width will break and start spamming that message infinitely
  97   until the console is resized.
  98
  99   Different attempts to fix this bug have ended up causing bigger problems,
 100   leading to the conclusion that it simply can't be fixed without a large
 101   re-write of the application, which will not happen any time soon.  If you
 102   come across this issue, please augment your terminal window size.