Commit 39ab9022f339a986fb3c366e61132129f854a703

Authored by Georg Hopp
1 parent f64f92e8

More information in README.md

Showing 1 changed file with 67 additions and 1 deletions
... ... @@ -13,7 +13,72 @@ A small script to rip and encode audio from a CD.
13 13
14 14 ## Description
15 15
16   -To be written....
  16 +### Options
  17 +
  18 + * ``-h | --help`` : online help
  19 + * ``-v`` : set verbosity level.
  20 + * ``-q`` : make the script silent. Equivalent to -v0
  21 + * ``-t | --encoding`` : encoding type
  22 + * ``-p | --path`` : base path
  23 + * ``-e | --encoder`` : encoder
  24 + * ``-c`` : CDDB entry selection
  25 + * ``-I | --interface`` : specifies cdda2wav interface to use
  26 + * ``-D | --device`` : specifies device to use with cdda2wav.
  27 + * ``-s`` : sampler indicator
  28 +
  29 +#### Verbosity settings (``-v``)
  30 +
  31 + * ``-v0`` : disable all output
  32 + * ``-v`` : be more verbose
  33 + * ``-vv`` : enables debug
  34 +
  35 +#### Encoding type (``-t | --encoding``)
  36 +
  37 +You can specify either m for encoding to mp3 using lame, or f for making
  38 +lossless encoding using flac, or o for making ogg/vorbis, or w for
  39 +uncompressed wav. Omitting this results in encoding to flac. Mp3s will be
  40 +placed under a subfolder mp3 and flacs under a subfolder flac.
  41 +
  42 +#### Base path (``-p | --path``)
  43 +
  44 +Specifies the path to save the encoded data.
  45 +Defaults to the users home directory.
  46 +
  47 +#### Encoder (``-e | --encoder``)
  48 +
  49 +Specifies the mp3 encoder to use. Valid encoders are actually:
  50 +
  51 + * lame
  52 + * bladeenc
  53 +
  54 +Defaults to lame.
  55 +
  56 +#### CDDB entry selection (``-c``)
  57 +
  58 +Specifies the CDDB-Entry to use.
  59 +
  60 +Sometimes there is more than 1 entry for a cd in cddb. Then you can specify
  61 +wich one to use by this option. You can checkout all entries using cddb.pl.
  62 +
  63 +#### Cdda2wav interface selection (``-I | --interface``)
  64 +
  65 +Valid interfaces are ``generic_scsi`` and ``cooked_ioctl``. Please note that
  66 +``cooked_ioctl`` is not available on all systems. Defaults to ``cooked_ioctl``
  67 +if device begins with /dev else to ``generic_scsi``
  68 +
  69 +#### Cdda2wav device selection (``-D | --device``)
  70 +
  71 +All values that are valid for cdda2wav are valid here.
  72 +
  73 +Defaults to /dev/cdrom
  74 +
  75 +#### sampler indicator (``-s``)
  76 +
  77 +If set indicates that this disk contains various artists (is a sampler). In
  78 +this case the artist is written in the title information of cddb most likely.
  79 +Giving this option the script will show a title list and give the oppotunity
  80 +to enter a delimiting string so that title and artist information can be split
  81 +properly and fill the mp3id or whatever correctly.
17 82
18 83 ## Requirements
19 84
... ... @@ -25,6 +90,7 @@ To be written....
25 90 * cdrtools
26 91 * cdrdao
27 92 * lame
  93 + * other...
28 94
29 95 ## Contributing
30 96
... ...
Please register or login to post a comment