[mp3roaster-commit] SF.net SVN: mp3roaster: [246] trunk/mp3roaster/mp3roaster.1

[<lor...@us...>]

Revision: 246
          http://svn.sourceforge.net/mp3roaster/?rev=246&view=rev
Author:   lorenzo1
Date:     2006-10-26 13:37:42 -0700 (Thu, 26 Oct 2006)

Log Message:
-----------
The MAN page has been updated.

Added Paths:
-----------
    trunk/mp3roaster/mp3roaster.1

Added: trunk/mp3roaster/mp3roaster.1
===================================================================
--- trunk/mp3roaster/mp3roaster.1	                        (rev 0)
+++ trunk/mp3roaster/mp3roaster.1	2006-10-26 20:37:42 UTC (rev 246)
@@ -0,0 +1,289 @@
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+'br\}
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.if \nF \{\
+.    de IX
+.    tm Index:\\$1\t\\n%\t"\\$2"
+..
+.    nr % 0
+.    rr F
+.\}
+.\"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "MP3ROASTER 1"
+.TH MP3ROASTER 1 "2006-10-25" "perl v5.8.8" "User Contributed Perl Documentation"
+.SH "NAME"
+mp3roaster \- A Perl hack for burning audio CDs out of MP3/OGG/FLAC/WAVs
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+\&\fBmp3roaster\fR [\s-1OPTION\s0]... \f(CW\*(C`MP3/OGG/FLAC/WAV files\*(C'\fR
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+\&\fBmp3roaster\fR
+A Perl hack for burning audio CDs out of \s-1MP3\s0, \s-1OGG\s0 \s-1VORBIS\s0 and \s-1FLAC\s0 files.
+The main highlights of this application are an easy to use command line syntax
+and automatic volume leveling support for best audio \s-1CD\s0 quality.
+.SH "ENVIRONMENT"
+.IX Header "ENVIRONMENT"
+MP3Roaster should run on all Unix like operating systems which have Perl and
+cdrecord installed. It has been developed on Debian GNU/Linux.
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+All options have been imported, now we should add specific descriptions
+for each option.
+.IP "\fB\-d, \-\-dev\fR" 4
+.IX Item "-d, --dev"
+\&\s-1CDR\s0 device to use
+.IP "\fB\-s, \-\-speed\fR" 4
+.IX Item "-s, --speed"
+Burn speed
+.IP "\fB\-d, \-\-dummy\fR" 4
+.IX Item "-d, --dummy"
+Burn with laser off
+.IP "\fB\-a, \-\-dao\fR" 4
+.IX Item "-a, --dao"
+Burn in disk-at-once (\s-1DAO\s0) mode for gapless recording
+.IP "\fB\-b, \-\-burnfree\fR" 4
+.IX Item "-b, --burnfree"
+Turn on Buffer Underrun Free writing
+.IP "\fB\-t, \-\-temp\fR" 4
+.IX Item "-t, --temp"
+Temporary directory
+.IP "\fB\-m, \-\-mp3dec\fR" 4
+.IX Item "-m, --mp3dec"
+\&\s-1MP3\s0 decoder to use
+.IP "\fB\-l, \-\-lowercase\fR" 4
+.IX Item "-l, --lowercase"
+Convert filenames to lowercase
+.IP "\fB\-S, \-\-spaces\fR" 4
+.IX Item "-S, --spaces"
+Replace spaces with underscores
+.IP "\fB\-B, \-\-brackets\fR" 4
+.IX Item "-B, --brackets"
+Replace brackets with underscores
+.IP "\fB\-q, \-\-quotes\fR" 4
+.IX Item "-q, --quotes"
+Replace quotes with underscores
+.IP "\fB\-Q, \-\-questions\fR" 4
+.IX Item "-Q, --questions"
+Replace questionmarks with underscores
+.IP "\fB\-n, \-\-normalize\fR" 4
+.IX Item "-n, --normalize"
+Normalize \s-1WAV\s0 files before burning
+.IP "\fB\-L, \-\-list\fR" 4
+.IX Item "-L, --list"
+Read file names from <file> instead of command line
+.IP "\fB\-v, \-\-verbose\fR" 4
+.IX Item "-v, --verbose"
+Enable verbose output
+.IP "\fB\-h, \-\-help\fR" 4
+.IX Item "-h, --help"
+Show the help screen
+.IP "\fB\-V, \-\-version\fR" 4
+.IX Item "-V, --version"
+Show version and infos
+.SH "RETURN VALUE"
+.IX Header "RETURN VALUE"
+\&\fBmp3roaster\fR returns 0 on success, 1 on error.
+.SH "DIAGNOSTICS"
+.IX Header "DIAGNOSTICS"
+This has to be written yet.
+.SH "EXAMPLES"
+.IX Header "EXAMPLES"
+Once correctly configured MP3Roaster is very easy to use, just launch it
+from the command line with a bunch of compressed audio files, here is a
+short example:
+.PP
+.Vb 1
+\&    % mp3roaster "Root Dance.mp3" Free\e Software.flac bar.ogg Decoded.wav
+.Ve
+.PP
+This will burn Root\e Dance.mp3, Free\e Software.flac bar.ogg and Decoded.wav
+on your audio \s-1CD\s0 preserving the song order as specified on the command line.
+.PP
+Here is another example showing the usage of command line options like
+the dummy option:
+.PP
+.Vb 1
+\&    % mp3roaster \-d "Root Dance.mp3" Free\e Software.flac bar.ogg Decoded.wav
+.Ve
+.PP
+.Vb 2
+\&    This will do the same job as above but with the laser of your
+\&    CD writer turned off, so no data will be really written.
+.Ve
+.PP
+You see MP3Roaster is really easy to use, this was one of my main goals
+while I've written the code: Keep it simple ;)
+.SH "FILES"
+.IX Header "FILES"
+MP3Roaster can be configured through a system wide and a personal configuration
+file. When you run MP3Roaster it will first check for your personal
+configuration file in your home directory, if no one is found it will fall-back
+to the system wide configuration files placed in /etc.
+.PP
+By default MP3Roaster installs the configuration files in /etc/mp3roaster, but
+there are other possible file locations for the configuration file:
+.PP
+.Vb 1
+\&    . System wide configuration in /etc
+.Ve
+.PP
+.Vb 2
+\&        . /etc/mp3roaster/mp3roasterrc      (DEFAULT)
+\&        . /etc/mp3roasterrc
+.Ve
+.PP
+.Vb 1
+\&    . Personal configuration in your home
+.Ve
+.PP
+.Vb 2
+\&        . ~/.mp3roaster/mp3roasterrc
+\&        . ~/.mp3roasterrc
+.Ve
+.PP
+So if you want to have personal MP3Roaster configuration file just copy
+the system wide configuration file to your home directory and edit it.
+.SH "CAVEHEATS"
+.IX Header "CAVEHEATS"
+None actually.
+.SH "BUGS"
+.IX Header "BUGS"
+There may be some minor troubles regarding file names, feel free to report
+any bugs you may encounter (In fact you shouldn't).
+.SH "NOTES"
+.IX Header "NOTES"
+There are currrently no special notes.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+cdrecord.
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+.IP "Ivo Marino <ei...@us...>" 4
+.IX Item "Ivo Marino <ei...@us...>"
+.PD 0
+.IP "Lorenzo Taylor <lor...@us...>" 4
+.IX Item "Lorenzo Taylor <lor...@us...>"
+.PD
+.SH "HISTORY"
+.IX Header "HISTORY"
+Take a look at the ChangeLog for now.


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.