Browse Source

More information in README.md

master
Georg Hopp 10 years ago
parent
commit
39ab9022f3
  1. 68
      README.md

68
README.md

@ -13,7 +13,72 @@ A small script to rip and encode audio from a CD.
## Description
To be written....
### Options
* ``-h | --help`` : online help
* ``-v`` : set verbosity level.
* ``-q`` : make the script silent. Equivalent to -v0
* ``-t | --encoding`` : encoding type
* ``-p | --path`` : base path
* ``-e | --encoder`` : encoder
* ``-c`` : CDDB entry selection
* ``-I | --interface`` : specifies cdda2wav interface to use
* ``-D | --device`` : specifies device to use with cdda2wav.
* ``-s`` : sampler indicator
#### Verbosity settings (``-v``)
* ``-v0`` : disable all output
* ``-v`` : be more verbose
* ``-vv`` : enables debug
#### Encoding type (``-t | --encoding``)
You can specify either m for encoding to mp3 using lame, or f for making
lossless encoding using flac, or o for making ogg/vorbis, or w for
uncompressed wav. Omitting this results in encoding to flac. Mp3s will be
placed under a subfolder mp3 and flacs under a subfolder flac.
#### Base path (``-p | --path``)
Specifies the path to save the encoded data.
Defaults to the users home directory.
#### Encoder (``-e | --encoder``)
Specifies the mp3 encoder to use. Valid encoders are actually:
* lame
* bladeenc
Defaults to lame.
#### CDDB entry selection (``-c``)
Specifies the CDDB-Entry to use.
Sometimes there is more than 1 entry for a cd in cddb. Then you can specify
wich one to use by this option. You can checkout all entries using cddb.pl.
#### Cdda2wav interface selection (``-I | --interface``)
Valid interfaces are ``generic_scsi`` and ``cooked_ioctl``. Please note that
``cooked_ioctl`` is not available on all systems. Defaults to ``cooked_ioctl``
if device begins with /dev else to ``generic_scsi``
#### Cdda2wav device selection (``-D | --device``)
All values that are valid for cdda2wav are valid here.
Defaults to /dev/cdrom
#### sampler indicator (``-s``)
If set indicates that this disk contains various artists (is a sampler). In
this case the artist is written in the title information of cddb most likely.
Giving this option the script will show a title list and give the oppotunity
to enter a delimiting string so that title and artist information can be split
properly and fill the mp3id or whatever correctly.
## Requirements
@ -25,6 +90,7 @@ To be written....
* cdrtools
* cdrdao
* lame
* other...
## Contributing

Loading…
Cancel
Save