README for BBCD -- a CD player for BlackBox / X11

What is BBCD ?
--------------

  BBCD is a CD player that offers the minimum features to play your favourite
  CDs. It works with X11 and can integrate with BlackBox, copying its style.
  However, if you don't use BlackBox, you may still edit the appearance that
  BBCD will show.

  In its normal configuration, BBCD has 4 buttons: backward, play/pause, stop
  and forward.
  
  Beside this, BBCD supports a `compact' configuration in which it only has 2
  buttons: play/pause and stop. The behaviour of these buttons depends on the
  mouse button you use to click:
    o Play/Pause button: left -> previous track, right -> next track,
      middle -> play/pause.
    o Stop button: currently stops the drive, whichever button you use.

  BBCD supports docking/wharfing/sliting.

  Bbcd runs on Linux, NetBSD and FreeBSD.
  If you get to compile it on other platforms, please, send me an email (and
  a patch?).


How to compile BBCD ?
---------------------

  You will need X11 and cdaudio libraries in order to compile BBCD
  (see Related links below).
  
  BBCD support automake/autoconf. So, you just need to enter the source
  directory and type:

      % ./configure
      % make
      % su -c "make install"

  configure script accepts several options (see INSTALL).

  You should then copy bbcd.bb and bbcd.nobb to $HOME/.bbtools. Supposing that
  you used the default installation directory, these files are located in
  /usr/local/share/bbtools. If you use Blackbox, edit bbcd.bb; otherwise edit
  bbcd.nobb.

  Several default parameters are already set in these files, read README.bbcd
  and below for more information.


  Users reported compile problems on other platforms (NetBSD and FreeBSD) due
  to inclusion of header files (unistd.h and select.h). They are fixed with
  patch bbcd-0.3.0_0.3.1.diff.
  Bbcd requires the last version of the cdaudio library (0.99.6); it seems
  that version 0.99.4 installed with FreeBSD is not working with Bbcd.


  How to apply a patch ?
  - - - - - - - - - - -

  Uncompress patch if necessary, go to source directory of Bbcd and then
  type:

      % patch -Np1 </path/to/file/bbcd-old_new.diff



How to use BBCD ?
-----------------

  BBCD accepts several command line options and parameters. They are
  described below.

    -b          No BlackBox support. If you don't have a BlackBox configuration
                file, it is the default.

    -bbrc file  Specifies an alternate location of BlackBox configuration
                file. Default is $HOME/.blackboxrc.

    -rc file    Specifies an alternate BBCD configuration file.
                Default is $HOME/.bbtools/bbcd.{bb,nobb}.

    -w          Withdrawn state. Puts BBCD on/in the dock/wharf/slit.

    -c          Compact mode.
    
    -s          Transparent background. Useful when run on/in the dock/wharf/
                slit.

    -z size     Size of buttons (pixels). Default is 10.

    -l layout   Layout of buttons (Horizontal, Vertical, or Box).
                Default is Horizontal.

    -d dev      Alternate CD-ROM device. Default is /dev/cdrom.

    -display d  X server display name. Default is $DISPLAY.

    -geometry g Position of window, when not withdrawn.
                

  If you set -b or if BlackBox configuration file is not found (either the one
  you specfied with option -bbrc or the default one), BBCD runs without
  BlackBox and the configuration filename is bbcd.nobb. Otherwise it is
  bbcd.bb, unless a different name is specified with the option -rc.

  BBCD has no option to remove WM decoration when running in normal state.
  That is a planned feature.

  When BBCD is running, depending on the chosen options, it runs in a small
  window or in the dock/wharf/slit, displaying 2 or 4 buttons.
  You can now play your CDs !

  See TODO for information on current work, BUGS for know bugs.



Related Links
-------------

  Since version 0.3.0, BBCD uses libcdaudio to manage CD drive.
  See http://libcdaudio.sf.net for download/information.

