.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH YARET 1 "June 2004" "YaRET 2.1.0 (Jul 10, 2003)" "User Commands"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
YaRET \- Yet another Ripper Encoder Tagger 
.SH SYNOPSIS
.B yaret
.RI [ options ]
.br
.B yaret
.RI [--help|--version|--option_only]
.SH DESCRIPTION
This manual page documents briefly the
.B yaret
command.
This manual page was written for the Debian distribution
because the original program does not have a manual page.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
.\" respectively.
.B YaRET
is a Perl script that automates the ripping, normalization, and
encoding of CDs. It supports CDDB very well via the Perl Audio::CD
module, and also can work with your favorite ripper/normalizer/encoder
(e.g., cdparanoia, cdda2wav, normalize, etc.) It supports useful
features like multiple concurrent encoders and an easy to use
configuration file that lets you customize YaRET to your taste (such as
file naming based on the CDDB information).
.PP
Please see your ~/.yaretrc file (auto-generated at the first time
execution) as well as the /usr/share/doc/yaret/README and yaretrc
files that came with YaRET (perhaps located in
/usr/share/yaret/dot-yaretrc) for more information about configuring
the many features that YaRET comes with.
.SH OPTIONS
These programs follow the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
.PP
[General]
.TP
\fB\-h\fR, \fB\-\-help\fR
Display this help (also -?)
.TP
\fB\-v\fR, \fB\-\-version\fR
Display the version
.TP
\fB\-\-option_only\fR
Display configuration data
.TP
\fB\-f\fR, \fB\-\-include=\fR<file>
Include this file as configuration
data (in addition to ~/.yaretrc and
any command line options)
(also \fB\-\-conf_file\fR)
.TP
\fB\-\-cddb_file=\fR<file>
Include this CDDB information in
addition to that obtained from the
CDDB query (in same format as both
\fB\-\-cddb_dump\fR and \fB\-\-cddb_out\fR produce)
.TP
\fB\-\-max_fork=\fR<value>
Maximum number of normalizers and
encoders forked (per type)
.TP
\fB\-\-size_order\fR
Sorts tracks in order of size,
completing smaller ones first.
.PP
[Display]
.TP
\fB\-\-date\fR
Display the start/end times
.TP
\fB\-\-color\fR
Use color
.TP
\fB\-\-alarm\fR
Send beeps when completed
.TP
\fB\-\-clear\fR
Clear the screen
.TP
\fB\-\-quiet\fR
Do not display anything except errors
.PP
[Paths and Filenames]
.TP
\fB\-\-root_final=\fR<path>
Where to place the results
.TP
\fB\-\-root_work=\fR<path>
Where to work on the results
.TP
\fB\-\-output_name=\fR<pattern>
How to name the final file
.TP
\fB\-\-output_path=\fR<pattern>
Path under root_final to place file
.TP
\fB\-\-output_track_num_format=\fR<format>
Specifies a printf format for the track
numbering, e.g. "%02d"
.TP
\fB\-\-output_trans=\fR<regexp>
Specifies a regular expression
that effects the output of what
filename is generated, e.g. "tr/ /_/"
.PP
[CDDB Overrides]
.TP
\fB\-\-global\fR==<attr>=<val>
e.g. ARTIST=Bare Naked Ladies
(Make sure to use escapes or quotes)
(also \fB\-\-cddb_global\fR)
.TP
\fB\-\-track\fR==<tracknum>=[<attr>=<val> ]*
e.g. 14=TRACK=Alone ARTIST=Heart
(Make sure to use escapes or quotes)
.TP
\fB\-\-cddb_dump=\fR<file>
Dump cddb information to <file>
then exit (no editing, encoding, etc.)
.TP
\fB\-\-cddb_out=\fR<pattern>
After the entire process is completed,
output the cddb information to
<pattern>.  This filename works with
the same pattern rules as the other
output files, however some keyword may
may not be available. The information
saved will reflect any editing.
.TP
\fB\-\-confirm\fR
Confirm cddb information
(also \fB\-\-cddb_confirm\fR)
Use \fB\-\-noconfirm\fR to turn off.
.PP
[Ripper]
.TP
\fB\-r\fR, \fB\-\-ripper=\fR<label>
Which ripper to use (cdparanoia and
cddawav have already been defined)
(also \fB\-\-ripper_use\fR)
.TP
\fB\-\-ripper_command\fR==<label>=<command>
The <command> associated with <label>
.TP
\fB\-d\fR, \fB\-\-device=\fR<device>
CDROM Device to use, default is
/dev/cdrom (also \fB\-\-ripper_device\fR)
.TP
\fB\-\-skip=\fR<tracknumlist>
Skip these tracks, e.g. 3,10-13
(also \fB\-\-ripper_skip\fR)
.TP
\fB\-\-auto_skip=\fR<seconds>
Auto skip tracks that do not grow
after <seconds>
(also \fB\-\-ripper_auto_skip\fR)
.TP
\fB\-\-min_space=\fR<megabytes>
Do not start ripping a new track
unless this much space is free
(also \fB\-\-ripper_min_space\fR)
.TP
\fB\-\-ripper_nice=\fR<nice>
Nice the ripper process to <nice>
.PP
[Normalize]
.TP
\fB\-\-normalize=\fR<label>
As \fB\-\-ripper\fR (normalize has already
been defined)
.TP
\fB\-\-normalize_type=\fR<value>
TRACK/ALBUM normalization, ALBUM
uses a larger amount of work space,
and cannot start working until all
ripping is done.
.TP
\fB\-\-normalize_command\fR==<label>=<command>
As \fB\-\-ripper_command\fR
.TP
\fB\-\-normalize_nice=\fR<nice>
As \fB\-\-ripper_nice\fR
.PP
[Encoder]
.TP
\fB\-e\fR, \fB\-\-encoder=\fR<label>
As \fB\-\-ripper\fR except you may enable
multiple (but make sure you use the
ENCODE keyword in \fB\-\-output\fR options)
(lame and bladeenc have already been
defined)
.TP
\fB\-\-encoder_command\fR==<label>=<command>
As \fB\-\-ripper_command\fR
.TP
\fB\-\-bitrate\fR==<label>=<bitrate>
Set bitrate for <label> encoder
(also \fB\-\-encoder_bitrate\fR)
.TP
\fB\-\-quality\fR==<label>=<quality>
Set quality for <label> encoder
(also \fB\-\-encoder_quality\fR)
.TP
\fB\-\-extension\fR==<label>=<value>
Set extension for <label> encoder,
default is ".mp3"
(also \fB\-\-encoder_extension\fR)
.TP
\fB\-\-encoder_nice=\fR<nice>
As \fB\-\-ripper_nice\fR
.SH SEE ALSO
.BR cdparanoia (1),
.BR cdda2wav (1),
.BR oggenc (1),
.BR flac (1),
.BR metaflac (1),
.BR normalize (1).
.SH AUTHOR
This manual page was written by Marco Nenciarini <mnencia@debian.org>,
for the Debian project (but may be used by others).