README

Description:

        cplay is a curses front-end for various audio players. It aims
        to provide a power-user-friendly interface with simple filelist
        and playlist control. cplay is written in Python and can use
        either pyncurses or the standard curses module.

Requirements:

        - cplay                   http://www.tf.hut.fi/~flu/cplay/
        - python                  http://www.python.org/
        - python-oss  (optional)  http://net.indra.com/~tim/ossmodule/
        - mpg321      (optional)  http://sourceforge.net/projects/mpg321/
        - ogg123      (optional)  http://www.vorbis.com/
        - mpg123      (optional)  http://www.mpg123.org/
        - splay       (optional)  http://splay.sourceforge.net/
        - madplay     (optional)  http://www.mars.org/home/rob/proj/mpeg/
        - mikmod      (optional)  http://www.mikmod.org/
        - fintl       (optional)  http://www.python.org/sigs/i18n-sig/
        - pyncurses   (optional)  http://pyncurses.sourceforge.net/
        - ID3-py      (optional)  http://id3-py.sourceforge.net/
        - pyvorbis    (optional)  http://www.duke.edu/~ahc4/pyogg/
        - xmp         (optional)  http://xmp.sf.net/
        - sox         (optional)  http://sox.sf.net/
        - speex       (optional)  http://www.speex.org/

Installation:

        make install

Usage:

        cplay [-nrRv] [ file | dir | playlist ] ...

        When in doubt, press 'h' for a friendly help page.

Configuration:

        If you would like to change options passed to the actual players
        just edit the PLAYERS list in the cplay script or put the PLAYERS
        definition in either ~/.cplayrc or /etc/cplayrc. If one of these
        files is available, it is executed by cplay before initialization.

        Note, currently there is no version control for the rc-file!

Miscellaneous:

        In order for either mp3info (ID3) or ogginfo to work,
        both corresponding python modules have to be installed.
        This will probably change someday.

        A playlist can contain URLs, but the playlist itself will
        have to be local. For mpeg streaming, splay is recommended.

        It is also possible to pipe a playlist to cplay, as stdin
        will be reopened on startup unless it is attached to a tty.

        Remote control via /var/tmp/cplay_control; see lircrc.