Package: icedax Version: 9:1.1.2-1 Severity: minor Tags: patch man readmult refers to cdda2wav only.
The icedax.1.diff patch makes improvements in the formatting (by trying to have a more consistent appearance), corrects some roff-syntax mistakes and modifies this paragraph of the section DISCUSSION: icedax stands for CDDA to WAV (where CDDA stands for compact disc digital audio and WAV is a sound sample format introduced by MS Windows). It allows copying CDDA audio data from the CDROM drive into a file in WAV or other formats. by simply suppressing it since a similar, non erroneous explanation is already present in the section DESCRIPTION.
--- icedax.1.orig 2007-01-15 07:54:29.000000000 +0100 +++ icedax.1 2007-01-15 09:25:39.000000000 +0100 @@ -83,8 +83,8 @@ .RB [ -S .IR speed ] .RB [ -paranoia ] -.RB [ cddbp-server=servername ] -.RB [ cddbp-port=portnumber ] +.RB [ cddbp-server=\fIservername ] +.RB [ cddbp-port=\fIportnumber ] .RI [ filename(s) or .IR directories ] @@ -105,11 +105,9 @@ .TP .BI \-device " device uses -.B device -as the source for CDDA reading. For example -.B /dev/cdrom -or -.B Bus,ID,Lun. +.I device +as the source for CDDA reading. For example '/dev/cdrom' or +.RI ' Bus , ID , Lun '. The device specification can also have influence on the selection of the driver interface (eg. on Linux). See the .B \-I @@ -123,7 +121,7 @@ .TP .BI \-auxdevice " auxdevice uses -.B auxdevice +.I auxdevice as CDROM drive for ioctl usage. .TP .BI \-I " interface @@ -141,7 +139,7 @@ mainly depend on the audio extraction quality of the operating system which is usually extremely bad. .TP -.BI \-c " channels --channels" +.BI \-c " channels" " --channels" uses .B 1 for mono, or @@ -160,19 +158,19 @@ .B \-x " --max" sets maximum (CD) quality. .TP -.BI \-b " bits --bits-per-sample" +.BI \-b " bits" " --bits-per-sample" sets bits per sample per channel: .BR 8 , .B 12 or .BR 16 . .TP -.BI \-r " rate --rate" +.BI \-r " rate" " --rate" sets rate in samples per second. Possible values are listed with the .B \-R option. .TP -.BI \-a " divider --divider" +.BI \-a " divider" " --divider" sets rate to 44100Hz / divider. Possible values are listed with the .B \-R option. @@ -180,62 +178,62 @@ .B \-R " --dump-rates" shows a list of all sample rates and their dividers. .TP -.B \-P " sectors --set-overlap" +.BI \-P " sectors" " --set-overlap" sets the initial number of overlap .I sectors for jitter correction. .TP -.BI \-n " sectors --sectors-per-request" +.BI \-n " sectors" " --sectors-per-request" reads .I sectors per request. .TP -.BI \-l " buffers --buffers-in-ring" +.BI \-l " buffers" " --buffers-in-ring" uses a ring buffer with .I buffers total. .TP -.BI \-t " track+endtrack --track" +.BI \-t " track+endtrack" " --track" selects the start track and optionally the end track. .TP -.BI \-i " index --index" +.BI \-i " index" " --index" selects the start index. .TP -.BI \-o " offset --offset" +.BI \-o " offset" " --offset" starts .I offset sectors behind start track (one sector equivalents 1/75 seconds). .TP -.B \-O " audiotype --output-format" +.BI \-O " audiotype" " --output-format" can be -.I wav +.B wav (for wav files) or -.I aiff +.B aiff (for apple/sgi aiff files) or -.I aifc +.B aifc (for apple/sgi aifc files) or -.I au +.B au or -.I sun +.B sun (for sun .au PCM files) or -.I cdr +.B cdr or -.I raw +.B raw (for headerless files to be used for cd writers). .TP -.BI \-C " endianess --cdrom-endianess" +.BI \-C " endianess" " --cdrom-endianess" sets endianess of the input samples to 'little', 'big' or 'guess' to override defaults. .TP -.BI \-E " endianess --output-endianess" +.BI \-E " endianess" " --output-endianess" sets endianess of the output samples to 'little' or 'big' to override defaults. .TP -.BI \-d " duration --duration" +.BI \-d " duration" " --duration" sets recording time in seconds or frames. Frames (sectors) are indicated by a 'f' suffix (like 75f for 75 sectors). .B 0 sets the time for whole track. .TP -.B \-B " --bulk --alltracks" +.B \-B " --bulk" " --alltracks" copies each track into a separate file. .TP .B \-w " --wait" @@ -251,15 +249,14 @@ undo the effect of pre-emphasis in the input samples. .TP .B \-e " --echo" -copies audio data to sound device e.g. -.BR /dev/dsp . +copies audio data to sound device e.g. '/dev/dsp'. .TP -.B \-p " percentage --set-pitch" +.BI \-p " percentage" " --set-pitch" changes pitch of audio data copied to sound device. .TP -.B \-v " itemlist --verbose-level" +.BI \-v " itemlist" " --verbose-level" prints verbose information about the CD. -.B Level +.I itemlist is a list of comma separated suboptions. Each suboption controls the type of information to be reported. .TS H allbox; @@ -292,9 +289,11 @@ .B \-J " --info-only" does not write to a file, it just gives information about the disc. .TP -.B \-L " cddb mode --cddb" +.BI \-L " cddb mode" " --cddb" does a cddbp album- and track title lookup based on the cddb id. -The parameter cddb mode defines how multiple entries shall be handled. +The parameter +.I cddb mode +defines how multiple entries shall be handled. .TS H allbox; c cw(4i) @@ -310,10 +309,10 @@ T} .TE .TP -.B " cddbp-server=servername" +.B " cddbp-server=\fIservername" sets the server to be contacted for title lookups. .TP -.B " cddbp-port=portnumber" +.B " cddbp-port=\fIportnumber" sets the port number to be used for title lookups. .TP .B \-H " --no-infofile" @@ -322,11 +321,12 @@ .B \-g " --gui" formats the output to be better parsable by gui frontends. .TP -.B \-M " count --md5" -enables calculation of MD-5 checksum for 'count' bytes from a beginning of a -track. +.BI \-M " count" " --md5" +enables calculation of MD-5 checksum for +.I count +bytes from a beginning of a track. .TP -.B \-S " speed --speed" +.BI \-S " speed" " --speed" sets the cdrom device to one of the selectable speeds for reading. .TP .B \-q " --quiet" @@ -348,7 +348,7 @@ .B \-\-devices Like \-scanbus but works in a more native way, respecting the device name specification on the current operating system. See -.B wodim(1) +.BR wodim (1) for details. .TP .B \-paranoia @@ -362,8 +362,7 @@ and .B environment variable settings (currently -.B CDDA_DEVICE -). +.BR CDDA_DEVICE ). .SH "ENVIRONMENT VARIABLES" .B CDDA_DEVICE is used to set the device name. The device naming is compatible with the one @@ -389,7 +388,7 @@ Note that this forces .B icedax to create a pipe to the -.B rsh(1) +.BR rsh (1) program and disallows .B icedax to directly access the network socket to the remote server. @@ -397,7 +396,7 @@ the connection compared to a .B root initiated -.B rcmd(3) +.BR rcmd (3) connection. .TP .B RSCSI @@ -457,34 +456,17 @@ CD or .B multimedia CDROM (containing audio parts) directly digitally. These parts can be -written to a file, a pipe, or to a sound device. -.PP -.B icedax -stands for -.B CDDA -to -.B WAV -(where -.B CDDA -stands for compact disc digital audio and -.B WAV -is a sound sample format introduced by MS Windows). It -allows copying -.B CDDA -audio data from the CDROM drive into a file in -.B WAV -or other formats. +written, in different formats, to a file, a pipe, or a sound device. .PP The latest versions try to get higher real-time scheduling priorities to ensure smooth (uninterrupted) operation. These priorities are available for super users and are higher than those of 'normal' processes. Thus delays are minimized. .PP If your CDROM is on device -.B DEV +.I DEV and it is loaded with an audio CD, you may simply invoke -.B icedax dev=DEV -and it will create the sound file -.B audio.wav +.BI "icedax dev=" DEV +and it will create the sound file "audio.wav" recording the whole track beginning with track 1 in stereo at 16 bit at 44100 Hz sample rate, if your file system has enough space free. Otherwise recording time will be limited. For details see files @@ -505,16 +487,16 @@ .B The SCSI devices used with the generic SCSI interface however are now .B addressed with their SCSI-Bus, SCSI-Id, and SCSI-Lun instead of the generic .B SCSI device descriptor!!! -One example for a SCSI CDROM drive on bus 0 with SCSI ID 3 and lun 0 is -D0,3,0. +One example for a SCSI CDROM drive on bus 0 with SCSI ID 3 and lun 0 is '-D0,3,0'. .IP "Select Auxiliary device" .BI \-A " auxdevice" is necessary for CD-Extra handling. For Non-SCSI-CDROM drives this is the -same device as given by -D (see above). For SCSI-CDROM drives it is the -CDROM drive (SCSI) device (i.e. -.B /dev/sr0 -) corresponding to the SCSI device (i.e. -.B 0,3,0 -). It has to match the device used for sampling. +same device as given by +.B \-D +(see above). +For SCSI-CDROM drives it is the CDROM drive (SCSI) device (i.e. '/dev/sr0') +corresponding to the SCSI device (i.e. '0,3,0'). +It has to match the device used for sampling. .IP "Select Interface" .BI \-I " interface" selects the CDROM drive interface. For SCSI drives use generic_scsi @@ -540,13 +522,13 @@ to at most onefold speed. You cannot make better recordings than your sound card can play (since the same data is used). .IP "Change pitch of echoed audio" -.B "\-p percentage" +.BI "\-p" " percentage" changes the pitch of all audio echoed to a sound card. Only the copy to the soundcard is affected, the recorded audio samples in a file remain the same. Normal pitch, which is the default, is given by 100%. -Lower percentages correspond to lower pitches, i.e. --p 50 transposes the audio output one octave lower. +Lower percentages correspond to lower pitches, i.e. '-p 50' transposes +the audio output one octave lower. See also the script .B pitchplay as an example. This option was contributed by Raul Sobon. @@ -629,10 +611,10 @@ invoke the index scanner, which will take some time to find the correct start position. An offset may be given additionally (see below). .IP "Set recording time" -.B \-d " n" +.BI \-d " n" sets recording time to .I n -seconds or set recording time for whole track if +seconds or sets recording time for whole track if .I n is zero. In order to specify the duration in frames (sectors) also, the argument can have an appended 'f'. Then the numerical argument is to be @@ -652,12 +634,12 @@ option (see below). Notice that recording time will be shortened, unless enough disk space exists. Recording can be aborted at anytime by pressing the break character (signal SIGQUIT). - .IP "Record all tracks of a complete audio CD in separate files" +.IP "Record all tracks of a complete audio CD in separate files" .B \-B copies each track into a separate file. A base name can be given. File names have an appended track number and an extension corresponding to the audio format. To record all audio tracks of a CD, use a sufficient high duration -(i.e. -d99999). +(i.e. '-d99999'). .IP "Set start sector offset" .BI \-o " sectors" increments start sector of the track by @@ -702,17 +684,17 @@ subsequently a reverse filtering is done for this track before the samples are written into the audio file. .IP "Set audio format" -.B \-O " audiotype" +.BI \-O " audiotype" can be -.I wav +.B wav (for wav files) or -.I au +.B au or -.I sun +.B sun (for sun PCM files) or -.I cdr +.B cdr or -.I raw +.B raw (for headerless files to be used for cd writers). All file samples are coded in linear pulse code modulation (as done in the audio compact disc format). This holds for all audio formats. @@ -729,16 +711,18 @@ format, the sample parameters can only be identified by playing the samples on a soundcard or similar. The default filename extension is '.cdr' or '.raw'. .IP "Select cdrom drive reading speed" -.B \-S " speed" +.BI \-S " speed" allows to switch the cdrom drive to a certain level of speed in order to reduce read errors. The argument is transfered verbatim to the drive. Details depend very much on the cdrom drives. -An argument of 0 for example is often the default speed of the drive, -a value of 1 often selects single speed. +An argument of '0' for example is often the default speed of the drive, +a value of '1' often selects single speed. .IP "Enable MD5 checksums" -.B \-M " count" -enables calculation of MD-5 checksum for 'count' bytes from the beginning of a -track. This was introduced for quick comparisons of tracks. +.BI \-M " count" +enables calculation of MD-5 checksum for +.I count +bytes from the beginning of a track. +This was introduced for quick comparisons of tracks. .IP "Use Monty's libparanoia for reading of sectors" .B \-paranoia selects an alternate way of extracting audio sectors. Monty's library is used @@ -754,7 +738,7 @@ (This applies unless option .B \-paranoia is used.) -.B \-P " sectors" +.BI \-P " sectors" sets the given number of sectors for initial overlap sampling for jitter correction. Two cases are to be distinguished. For nonzero values, some sectors are read twice to enable icedax's jitter correction. @@ -772,22 +756,22 @@ The case of zero sectors is nice on low load situations or errorfree (perfect) cdrom drives and perfect (not scratched) audio cds. .IP "Set the transfer size" -.B \-n " sectors" +.BI \-n " sectors" will set the transfer size to the specified sectors per request. .IP "Set number of ring buffer elements" -.B \-l " buffers" +.BI \-l " buffers" will allocate the specified number of ring buffer elements. .IP "Set endianess of input samples" -.B \-C " endianess" +.BI \-C " endianess" will override the default settings of the input format. Endianess can be set explicitly to "little" or "big" or to the automatic endianess detection based on voting with "guess". .IP "Set endianess of output samples" -.B \-E " endianess" +.BI \-E " endianess" (endianess can be "little" or "big") will override the default settings of the output format. .IP "Verbose option" -.B \-v " itemlist" +.BI \-v " itemlist" prints more information. A list allows selection of different information items. .sp @@ -871,22 +855,32 @@ option). This is just for information purposes. .SH "CDDBP support" .IP "Lookup album and track titles option" -.B \-L " cddbp mode" +.BI \-L " cddbp mode" Icedax tries to retrieve performer, album-, and track titles from a cddbp server. The default server right now is 'freedb.freedb.org'. It is planned to have more control over the server handling later. The parameter defines how multiple entries are handled: -.PP -0 interactive mode, the user chooses one of the entries. -.PP -1 take the first entry without asking. +.sp +.B 0 +interactive mode, the user chooses one of the entries. +.sp +.B 1 +take the first entry without asking. .IP "Set server for title lookups" -.B cddbp-server " servername" -When using \-L or --cddb, the server being contacted can be set with +.BI cddbp-server " servername" +When using +.B \-L +or +.BR \-\-cddb , +the server being contacted can be set with this option. .IP "Set portnumber for title lookups" -.B cddbp-port " portnumber" -When using \-L or --cddb, the server port being contacted can be set with +.BI cddbp-port " portnumber" +When using +.B \-L +or +.BR --cddb , +the server port being contacted can be set with this option. .SH "HINTS ON USAGE" Don't create samples you cannot read. First check your sample player @@ -897,7 +891,7 @@ .B WAV format). Most CD-Writers insist on audio samples in a bigendian format. Now icedax supports the -.B \-E " endianess" +.BI \-E " endianess" option to control the endianess of the written samples. .PP If your hardware is fast enough to run icedax @@ -905,7 +899,7 @@ gain speed when switching all overlap sampling off with the .B \-P " 0" option. Further fine tuning can be done with the -.B \-n " sectors" +.BI \-n " sectors" option. You can specify how much sectors should be requested in one go. .PP Icedax supports @@ -932,21 +926,29 @@ .sp Audio files: .sp -There are audio files containing samples with default extensions -.wav, .au, .aifc, .aiff, and .cdr according to the selected sound format. -These files are not generated when option (-N) is given. Multiple files may -be written when the bulk copy option (-B) is used. Individual file names -can be given as arguments. If the number of file names given is sufficient -to cover all included audio tracks, the file names will be used verbatim. +There are audio files containing samples with default +extensions '.wav', '.au', '.aifc', '.aiff', and '.cdr' according +to the selected sound format. +These files are not generated when option +.B \-N +is given. +Multiple files may be written when the bulk copy option +.RB ( \-B ) +is used. +Individual file names can be given as arguments. +If the number of file names given is sufficient to cover all included +audio tracks, the file names will be used verbatim. Otherwise, if there are less file names than files needed to write the included tracks, the part of the file name before the extension is extended -with '_dd' where dd represents the current track number. +with '-\fIdd\fP' where \fIdd\fP represents the current track number. .sp Cddb and Cdindex files: .sp If icedax detects cd-extra or cd-text (album/track) title information, then .cddb and .cdindex files are generated unless suppressed by the -option -H. They contain suitable formatted entries for submission to +option +.BR \-H . +They contain suitable formatted entries for submission to audio cd track title databases in the internet. The CDINDEX and CDDB(tm) systems are currently supported. For more information please visit www.musicbrainz.org and www.freedb.com. @@ -955,8 +957,11 @@ .sp The inf files are describing the sample files and the part from the audio cd, it was taken from. They are a means to transfer information to a cd burning -program like wodim. For example, if the original audio cd had pre-emphasis -enabled, and icedax -T did remove the pre-emphasis, then the inf file has +program like +.BR wodim . +For example, if the original audio cd had pre-emphasis enabled, and +.B icedax \-T +did remove the pre-emphasis, then the inf file has pre-emphasis not set (since the audio file does not have it anymore), while the .cddb and the .cdindex have pre-emphasis set as the original does. .SH WARNING @@ -995,11 +1000,13 @@ as shipped by the cdrkit distribution. See .B http://alioth.debian.org/projects/debburn/ -for details. It is a spinoff from the original program cdda2wav as distributed -in the cdrtools package [1]. However, the cdrtools developers are not involved -in the development of this spinoff and therefore shall not be made responsible -for any problem caused by it. Do not try to get support for this program by -contacting the original authors. +for details. It is a spinoff from the original program +.B cdda2wav +as distributed in the cdrtools package [1]. +However, the cdrtools developers are not involved in the development of this +spinoff and therefore shall not be made responsible for any problem caused +by it. +Do not try to get support for this program by contacting the original authors. .PP If you have support questions, send them to .PP
