.TH RIPIT "1" "June 16th, 2007" "ripit" "RipIT audio convertor"
.SH "NAME:"
.PP
ripit \- Perl script to create .flac .ogg .mp3 or .m4a (aac) files from
an audio CD.
.SH "SYNOPSIS:"
.PP
ripit [options]
.SH "DESCRIPTION:"
.PP
This Perl script makes it a lot easier to create "mp3" files from an
audio CD. RipIT supports Flac, Lame, Oggenc and Faac. It tries to find
the artist and song titles with the CDDB_get.pm. One can submit and edit
CDDB entries @ freedb.org. Hidden tracks and ghost songs are detected
and splitted into chunks of sound, a toc (cue) file permits to burn the
wavs with text and no gaps in DAO mode.
.SH "VERSION:"
.PP
RipIT Version 3.6.0
.SH "OPTIONS:"
.TP
[track_selection]
Tracks to rip from.
If not specified,  all tracks will be ripped. Specify a single
track by using a single number, or a selection of tracks using
numbers separated by commas or hyphens, e. g. 2,6,10, or 3,5,7\-9.
Using a number followed by a comma or hyphen will rip from
that track to the end of the CD i. e. 3,5\- rips track 3 and
from track 5 to the last one. Default: not set.
.TP
\fB\-\-merge\fR ordered list of comma separated intervals
Place a hyphen (-) or a plus (+) between first and last tracknumber to
be merged. Separate several intervals with commas. Default: not set.
.TP
\fB\-o,\fR \fB\-\-outputdir\fR dir
Where the sound should go, default: not set.
.TP
\fB\-d,\fR \fB\-\-device\fR cddevice
Path of audio CD device, default: /dev/cdrom.
.TP
\fB\-r,\fR \fB\-\-ripper\fR \fInumber\fP
CDripper to use,
.I 0
\- dagrab,
.I 1
\- cdparanoia,
.I 2
\- cdda2wav,
.I 3
\- tosha,
.I 4
\- cdd. Because cdparanoia and dagrab
are the only rippers in this list, that immediately fail on data tracks,
RipIT can create an error.log if problems are encountered and continues
to rip and code without endless looping! Please use dagrab or cdparanoia
except if you know what you're doing (know that you will wait)!
Default:
.I 1
\- cdparanoia.
.TP
\fB\-\-ripopt\fR \fIoptions\fP
User definable
.I options
for specific ripper. Quote them if necessary. Default: not set.
.TP
\fB\-\-nicerip\fR \fInumber\fP
Set niceness of ripping process, default: 0.
.TP
\fB\-Z,\fR \fB\-\-disable\-paranoia\fR
When using dagrab, the number of retries will be set to 3, with
cdparanoia this option is equal to the \fB\-Z\fR option. Default: off.
.TP
\fB\-\-ghost\fR
Analyze each wav for gaps and split it into chunks if gaps are detected.
Default: off.
.TP
\fB\-\-extend\fR \fIseconds\fP
Enlarge chunk by amount of
.I seconds
at end, if possible. Default: 6.
.TP
\fB\-\-prepend\fR \fIseconds\fP
Enlarge chunk by amount of
.I seconds
at beginning, if possible. Default: 6.
.TP
\fB\-c,\fR \fB\-\-coder\fR \fInumber\fP
Encoder(s) to use,
.I 0
\- Lame,
.I 1
\- Oggenc,
.I 2
\- Flac,
.I 3
\- Faac, a comma separated list.  Default:
.IR 0 .
.TP
\fB\-\-faacopt\fR Faac\-options
Pass other options to the encoder, quote them with double quotes if
needed; default: not set.
.TP
\fB\-\-flacopt\fR Flac\-options
Pass other options to the encoder, quote them with double quotes if
needed; default: not set.
.TP
\fB\-\-lameopt\fR Lame\-options
Pass other options to the encoder, quote them with double quotes if
needed; default: not set.
.TP
\fB\-\-oggencopt\fR Oggenc\-options
Pass other options to the encoder, quote them with double quotes if
needed; default: not set.
.TP
\fB\-q,\fR \fB\-\-quality\fR \fIquality\fP
A comma separated list of values or the word "off", passed in the same
order as the list of encoders! If no encoders passed, follow the order
of the config file! Quality for oggenc: (1\-10), highest = 10;
compression level for Flac: (0\-8), lowest compression = 0;
quality for Lame in vbr mode: (0\-9),  best quality = 0;
or quality for Faac: (10\-500), highest = 500; default: 5,3,5,100.
The value "off" turns option quality off.
.br
E. g. \fB\-\-coder\fR 2,0,1,3 \fB\-\-quality\fR 3,4,5,300 sets
compression level for Flac to 3, Lame\-quality to 4, Oggenc\-quality to
5 and Faac quality to 300. Lame\-quality may be omitted, if
constant\-bitrate is used. In vbr\-mode it assumes the lame\-default
value of 5.
.TP
\fB\-v,\fR \fB\-\-vbrmode\fR \fImode\fP
Variable bitrate, only used with Lame, mode is
.I new
or
.IR old ,
see the Lame manpage. The Lame\-option quality will be
changed to \fB\-V\fR instead of \fB\-q\fR if vbr\-mode is used;
default: not set.
.TP
\fB\-b,\fR \fB\-\-bitrate\fR \fIrate\fP
Encode "mp3" at this bitrate for Lame. If option \fB\-\-vbrmode\fR used,
bitrate is equal to the \fB\-b\fR option, so one might want to set it
"off", default: 128.
.TP
\fB\-B,\fR \fB\-\-maxrate\fR \fIrate\fP
maxrate (Bitrate) for Lame using \fB\-\-vbrmode\fR is equal to the
\fB\-B\fR option in Lame or the \fB\-M\fR option in Oggenc, default: 0.
.TP
\fB\-S,\fR \fB\-\-preset\fR \fImode\fP
Use the preset switch when encoding with Lame. Combined with otpion
\fB\-\-vbrmode\fR new the preset fast will be used.
Use \fB\-\-vbrmode\fR old not to use fast VBR.
.I Mode
is one of:
insane (320 kbps @ CBR), extreme (256 kbps), standard (192 kbps) or
medium (160 kbps) or any other valid bitrate. Default: off.
.TP
\fB\-W,\fR \fB\-\-chars\fR [list]
Exclude special characters and (ending!) periods in file names. The
argument is optional. Following characters will be erased, if no
argument stated: :*#?$! else only ending periods and all passed ones.
Pass the word "off" as argument to set it off again. One might escape
the characters or use double quotes to pass them on the command line.
Default: off.
.TP
\fB\-\-comment\fR \fIcomment\fP
Specify a
.I comment
for the comment-tag for Lame and Faac, or the description-tag for
Oggenc or Flac. Default: not set.
.TP
\fB\-g,\fR \fB\-\-genre\fR \fIgenre\fP
Specify (and override CDDB)
.IR genre ,
must be a valid ID3\-genre if using Lame, can (but shouldn't) be
anything if using other encoders, default: not set.
.TP
\fB\-y,\fR \fB\-\-year\fR \fIyear\fP
Specify (and override CDDB) the
.I year
of year-tag for Lame and Faac, or the date-tag for Oggenc and Flac.
Default: not set.
.TP
\fB\-D,\fR \fB\-\-dirtemplate\fR '" foo \fIparameters\fR "'
Use single AND double quotes to pass the parameters of the templates!
Allowed are following
.IR parameters :
$album, $artist, $genre, $trackname, $tracknum and $year;
e. g. \&'"$artist \- $year"'. Default: '"$artist \- $album"'.
.TP
\fB\-T,\fR \fB\-\-tracktemplate\fR '" foo parameters "'
See above, default: '"$tracknum $trackname"'.
.TP
\fB\-\-sshlist\fR \fIlist\fP
Comma separated
.I list
of remote machines where RipIT should encode. The output path must be
the same for all machines. Specify the login (login@machine) only if not
the same for the remote machine. Else just state the machine names. See
EXAMPLES for more informtation, default: not set.
.TP
\fB\-\-scp\fR
If the filesystem can not be accessed on the remote machines, copy the
wavs to the remote machines, default: off.
.TP
\fB\-\-local\fR
Only used with option \fB\-\-sshlist\fR; if all encodings shall be
done on remote machines, use \fB\-\-nolocal\fR, default: on.
.TP
\fB\-t,\fR \fB\-\-transfer\fR \fImode\fP
Transfer
.IR mode ,
cddb or http, will set default port to 8880 or 80 (for
http), default: cddb.
.TP
\fB\-C,\fR \fB\-\-cddbserver\fR server
CDDB server, default freedb.org. Note, the full address is
"mirror".freedb.org, i. e. default is freedb.freedb.org.
.TP
\fB\-m,\fR \fB\-\-mirror\fR \fImirror\fP
Choose "freedb" or one of the possible freedb
.IR mirrors ,
default: freedb. For more information check the webpage www.freedb.org.
There is no list of mirrors available these days. This option might be
obsolet as freedb uses random servers, but the default setting is
mandatory.
.TP
\fB\-L,\fR \fB\-\-protocol\fR \fIlevel\fP
CDDB protocol
.I level
for CDDB query.
.IR Level =6
supports UTF\-8 and
.IR level =5
not. Use
.IR level =5
to suppress UTF\-8. Cf. option \fB\-\-utftag\fR below. Default: 6.
.TP
\fB\-P,\fR \fB\-\-proxy\fR address
The http proxy to use when accessing the cddb server. The CDDB protocol
must be http! Default: not set.
.TP
\fB\-n,\fR \fB\-\-nice\fR \fInumber\fP
Set niceness of encoding process, default: 0.
.TP
\fB\-a,\fR \fB\-\-archive\fR
Read and save CDDB files in $HOME/.cddb/"category" directory, where the
"category" is one of the 11 CDDB categories. Default: off.
.TP
\fB\-e,\fR \fB\-\-eject\fR
Ejects the CD when finished, if hardware supports it. Use --noeject
to switch it off. Default: off.
.TP
\fB\-\-ejectcmd\fR \fIcommand\fR
.I Command
to be used for ejection or loading of CD tray. Should be specified
within FreeBSD even if option --eject is not used to enable RipIT
to load the CD tray. One does not need to mention the words close or
eject or options like -t, RipIT does it. Default: eject.
.TP
\fB\-\-ejectopt\fR \fIoptions\fR
.I Options
for ejection command to be used for ejection or loading of CD tray.
Default: the path to the CD device.
.TP
\fB\-\-halt\fR
Powers off the machine when finished if configuration supports it,
default: off.
.TP
\fB\-s,\fR \fB\-\-submission\fR
Specify \fB\-\-nosubmission\fR if the computer is offline and the
created file cddb.toc shall be saved in the home directory instead of
being submitted. With option  \fB\-\-archive\fR it will also be saved
in the $HOME/.cddb directory. Note: it is really easy to resubmit
incomplete CDDB entries! One can confirm each existing field with Enter
and add a missing genre or year. The purpose of this option is also to
permit the user to edit the CDDB data for the own filenames & tags and
not to overwrite the original CDDB entry! Default: on.
.TP
\fB\-M,\fR \fB\-\-mail\fR \fIaddress\fP
Users return email
.IR address ,
needed for submitting an entry to freedb.org. Default: not set.
.TP
\fB\-p,\fR \fB\-\-playlist\fR \fInumber\fR
Create the m3u playlist file, or use \fB\-\-playlist\fR
.IR 0 .
For filenames without full path use \fB\-\-playlist\fR
.IR 2 .
Default is full path for filenames. Default 1 \- on.
.TP
\fB\-i,\fR \fB\-\-interaction\fR
Specify \fB\-\-nointeraction\fR if ripit shall take the first CDDB
entry found and rip without any questioning. Default: on.
.TP
\fB\-\-lcd\fR
Use lcdproc to display status, default: not set.
.TP
\fB\-\-lcdhost\fR
Specify the lcdproc host, default: localhost.
.TP
\fB\-\-lcdport\fR
Specify the lcdport, default: 13666.
.TP
\fB\-\-infolog\fR \fIfile\fP
Log operations (system calls, file/directory creation) to
.I file
given with full path; default: not set.
.TP
\fB\-l,\fR \fB\-\-lowercase\fR
Lowercase filenames, default: off.
.TP
\fB\-u,\fR \fB\-\-underscore\fR
Use underscores _ instead of spaces in filenames, default: off.
.TP
\fB\-U,\fR \fB\-\-utftag\fR
Keep Lame\-tags in UTF-8 or decode them (but not the filenames) from
UTF\-8 to ISO8859\-1. Applies only to mp3 (Lame). May be useful for
tags with special characters and if mp3\-player doesn't support Unicode.
Default: off.
.TP
\fB\-\-rip\fR
Rip the CD, to be used as \-\-norip if wav-files are present. This might
be useful to encode the same format in different qualities. Default:
not set.
.TP
\fB\-\-encode\fR
Do encode the wavs. If only the wav\-files shall be created, prevent
encoding with \fB\-\-noencode\fR (and use option \fB\-\-wav\fR, see
below). Default: on.
.TP
\fB\-w,\fR \fB\-\-wav\fR
Keep the wav files after encoding instead of deleting them,
default: off.
.TP
\fB\-N,\fR \fB\-\-normalize\fR
Normalizes the wave-files to a given dB-value (default: -12dB). Default:
off.
.br
This is useful when encoding
.RS 7
.IP "*" 3
for hardware or software that doesn't support the
replaygain-feature
.IP "*" 3
to audio formats without replaygain capabilities.
.RE
.TP
\fB\-z,\fR \fB\-\-normopt\fR
Options to pass to normalize.
Possible values:
.TS
tab (@);
l l l.
 @-a -nndB   :@Normalize to -nn dB, default is -12dB,
 @Value range:@All values <= 0dB
 @Example    :@normalize -a -20dB *.wav
 @-b         :@Batch mode - loudness differences between
 @            @individual tracks of a CD are maintained
 @-m         :@Mix mode - all track are normalized to the
 @            @same loudness
 @-v         :@Verbose operation
 @-q         :@Quiet operation
.TE

For further options see normalize documentation
(http://normalize.nongnu.org).
Please note that normalizing to a high dB value, e.g. -6dB or less
will lead to severe compression of the audio signal, thus losing sound
quality. Keeping the default value of -12dB is recommended.
.br
Default: -bv
.TP
\fB\-\-cdtoc\fR \fInumber\fP
Number
.I n
= 1 to create a toc (cue) file to burn the wavs with CD-Text
using cdrdao. Default: off.
.TP
\fB\-h,\fR \fB\-\-help\fR
Print this and exit.
.TP
\fB\-V,\fR \fB\-\-version\fR
Print version and exit.
.TP
\fB\-x,\fR \fB\-\-verbose\fR \fInumber\fP
Run silent (do not output comments, status etc.) (
.I n
= 0), with minimal output (
.I n
= 1), normal without encoder msgs (
.I n
= 2), normal (
.I n
= 3), verbose (
.I n
= 4), extremly verbose (
.I n
= 5). Default 3.
.TP
\fB\-\-config\fR
Read parameters from config file or specify \fB\-\-noconfig\fR to
prevent reading it; default: on.
.TP
\fB\-\-save\fR
Add parameters passed on command line to config file. This option does
not overwrite other settings. An existing config file will be saved as
config.old. Default: off.
.TP
\fB\-\-savenew\fR
Save all parameters passed on command line to a new config file, backup
an existing file to config.old. Default: off.
.TP
\fB\-\-loop\fR
Continue ripping and encoding as soon as a new CD is inserted. This
option implies that the CD is ejected when done (\fB\-\-eject\fR).
.\" You may need to run as root:
.\" .br
.\" cd /usr/include/sys; h2ph ioctl.h
.br
Default: off.
.TP
\fB\-\-resume\fR
Resume a previously started session.
.TP
\fB\-\-md5sum\fR
Create a MD5-sum file for each type of sound files.
.TP
\fB\-\-core\fR \fInumber\fP
Comma separated list of numbers giving maximum of allowed
encoders to run at the same time. In conjunction with option sshlist
the number for the local machine is mandatory and must be stated first.
Default: 1.
.PP
.SH "EXAMPLES"
To specify a CD device, type
.IP
ripit \fB\-\-device\fR /dev/sr1
.PP
To specify the output directory, type
.IP
ripit \fB\-\-outputdir\fR /foo/paths/
.PP
To rip'n'code a special track selection, type
.IP
ripit 1,3\-6,8\-11
.PP
To use several encoders in the same run, type
.IP
ripit \fB\-\-coder\fR 1,0,2 \fB\-\-quality\fR 3,6
.PP
Note:
in this case, RipIT assumes that  Lame (encoder 0) is used in CBR mode
wihtout quality option, so Oggenc (encoder 1) will get quality 3 and
Flac (encoder 2) quality 6.
.PP
To use Lame with variable bitrate (VBR), type
.IP
ripit \fB\-\-vbrmode\fR new \fB\-\-bitrate\fR 0
.PP
Note, one should reset the \fB\-\-bitrate\fR to 0 (zero) if the \fB\
-b\fR option of Lame is not desired. According to VBR mode in Lame, use
"new" or "old".
.PP
It is recommended to use the preset switches for Lame,
(see Lame man\-page) and specify fast encoding with \fB\-\-vbrmode\fR
new (use \fB\-\-vbrmode\fR old to switch off the fast encoding)
.IP
ripit \fB\-\-preset\fR extreme \fB\-\-vbrmode\fR new
.PP
To pass options related to the encoder either use \fB\-\-encopt\fR,
or directly the according encoder option switch: e.g. to use the managed
mode with oggenc:
.IP
ripit \fB\-c\fR 1 \fB\-\-oggencopt\fR "--managed -b 192 -M 224 -m 96"
\fB\-\-qualoggenc\fR ""
.PP
Normalize your wave-files prior to encoding:
.IP
ripit --normalize
.PP
Normalize your files to -18dB using "mix mode" (see normalize
documentation)
.IP
ripit --normalize --normopt "-m -a -18dB"
.PP
To define a directory template
where the sound files should  go, type
.IP
ripit \fB\-\-dirtemplate\fR '"$artist \- $year"'
.PP
To create 2 directory levels, as used in other environments, type
.IP
ripit \fB\-\-dirtemplate\fR '"$artist/$album"'
.PP
To save a config file in ~/home/.ripit/ with options: to use Lame
and Oggenc, don't create a m3u file, archive the CDDB entry files in
~/.cddb/"category"/ and to eject CD when done, type
.IP
ripit \fB\-\-coder\fR 0,1 \fB\-\-playlist\fR 0 \fB\-\-archive\fR
\fB\-\-eject\fR \fB\-\-save\fR
.PP
To do the job without any interaction, type
.IP
ripit \fB\-\-nointeraction\fR
.PP
To use a network for encoding, make sure that the paths are equal
on all machines!
.IP
ripit \fB\-\-sshlist\fR sun,saturn,earth
.PP
where sun, saturn and earth
are remote machines on which a user
can login via ssh without entering a password or passphrase! Note
that the paths must be equal for the user on all remote machines!
If the login is different on some machines, try
.IP
ripit \fB\-\-sshlist\fR login1@sun,login2@saturn,login3@earth
.PP
If there is "no" identical path on the remote machines,
then the user might enter e.g. /tmp/ as output directory.
If the file\-system is not mounted on each remote machine, one can
try to copy the wavs to the remote machines using option \fB\-\-scp\fR.
.IP
ripit \fB\-\-sshlist\fR sun,saturn,earth \fB\-\-scp\fR
.PP
.SH "FILES"
User config file:
.IP
\&$HOME/.ripit/config
.br
\&/etc/ripit/config
.IP
/usr/share/doc/packages/ripit/README
.br
/usr/share/doc/packages/ripit/HISTORY
.br
/usr/share/doc/packages/ripit/LICENSE
.PP
.SH "BUGS"
Probably there are more than some.
.PP
.SH "SEE ALSO"
cdparanoia(1), lame(1), oggenc(1), flac(1), normalize(1), cdda2wav(1)
.PP
.SH "AUTHORS"
RipIT is now maintained by Felix Suwald, please send bugs, wishes
comments to ripit_[at]_suwald_[dot]_com with a concise subject.
.br
For bugs, wishes and comments about lcdproc, please contact
.br
max.kaesbauer_[at]_gmail_[dot]_com.
.br
Former maintainer:  Mads Martin Joergensen;  RipIT was originally
developed by Simon Quinn.
.PP
This manpage was originally created for the Debian GNU/Linux system by
help2man 1.36 and optimized by Elimar Riesebieter <riesebie@lxtec.de>,
enhanced and updated by Felix Suwald.