From 5c139e628cf04a5766d531de5b7643fdf883fd5f Mon Sep 17 00:00:00 2001 From: stanley lieber Date: Sat, 11 Feb 2012 13:32:05 -0600 Subject: add flacdec(1) man page; combine mp3dec(1), mp3enc(1), oggdec(1) and oggenc(1) man pages into flacdec(1) --- sys/man/1/flacdec | 282 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ sys/man/1/mp3dec | 27 ------ sys/man/1/mp3enc | 208 ---------------------------------------- sys/man/1/oggdec | 23 ----- sys/man/1/oggenc | 31 ------ 5 files changed, 282 insertions(+), 289 deletions(-) create mode 100644 sys/man/1/flacdec delete mode 100644 sys/man/1/mp3dec delete mode 100644 sys/man/1/mp3enc delete mode 100644 sys/man/1/oggdec delete mode 100644 sys/man/1/oggenc diff --git a/sys/man/1/flacdec b/sys/man/1/flacdec new file mode 100644 index 000000000..09f500564 --- /dev/null +++ b/sys/man/1/flacdec @@ -0,0 +1,282 @@ +.TH FLACDEC 1 +.SH NAME +flacdec \- decode FLAC audio files +.br +mp3dec \- decode MPEG layer 3 audio files +.br +mp3enc \- encode MPEG layer 3 audio files +.br +oggdec \- decode Ogg Vorbis audio files +.br +oggenc \- encode Ogg Vorbis audio files +.SH SYNOPSIS +.B audio/flacdec +.br +.B audio/mp3dec +[ +.B -d +] +.br +.in +0.5i +.ti -0.5i +.B audio/mp3enc +[ +.B -hprv +] [ +.B -b +.I bitrate +] [ +.B -B +.I bitrate +] [ +.B -m +.I mode +] [ +.B -q +q ] [ +.B -s +.I sfreq +] [ +.B -V +.I q +] [ +.I "long or silly options" +] +.in -0.5i +.B audio/oggdec +.br +.B audio/oggenc +.SH DESCRIPTION +.I Flacdec, mp3dec and oggdec +decode audio from standard input, +writing 16-bit stereo linear PCM sample data to +standard output. The +.B -d +option enables debug prints to standard error. +.PP +.I Mp3enc +compresses audio on standard input, +normally PCM-encoded, +and produces MP3-encoded audio on standard output. +By default, the MP3 file will use `constant bit-rate' (CBR) +encoding, but that can be changed via +.B --abr +(average bitrate desired, ABR) +or +.BR -v +(variable bitrate, VBR). +.PP +.I Oggenc +reads 44100Hz 16 bit LSB stereo data from standard input, and writes +encoded +.I 128 kbit/s +variable bit rate +.I ogg vorbis +stream to standard output. +.SH MP3ENC OPTIONS +.SS Options +.TF "\fB-b \fP" +.TP +.B -b +set minimum allowed +.I bitrate +in Kb/s for VBR, default 32Kb/s. +For CBR, +set the exact bitrate in Kb/s, which defaults to 128Kb/s. +.TP +.B -B +set maximum allowed +.I bitrate +in Kb/s for VBR, default 256Kb/s. +.TP +.BI -h +same as +.LR "-q 2" . +.TP +.B -m +.I mode +may be +(s)tereo, +(j)oint, +(f)orce +or +(m)ono +(default j). +.B force +forces mid/side stereo on all frames. +.TP +.B -p +add CRC error protection (adds an additional 16 bits per frame to the stream). +This seems to break playback. +.TP +.B -q +sets output quality to +.I q +(see +.BR -V ). +.TP +.B -r +input is raw pcm +.TP +.B -s +set sampling frequency of input file (in KHz) to +.IR sfreq , +default is 44.1. +.TP +.B -v +use variable bitrate (VBR) encoding +.TP +.B -V +set quality setting for VBR to +.IR q . +Default +.I q +is 4; +0 produces highest-quality and largest files, and +9 produces lowest-quality and smallest files. +.SS Long options +.TF "\fB--resample sfreq \fP" +.TP +.BI --abr " bitrate" +sets average +.I bitrate +desired in Kb/s, instead of setting quality, +and generates ABR encoding. +.TP +.BI --resample " sfreq" +set sampling frequency of output file (in KHz) to +.IR sfreq , +default is input sfreq. +.TP +.BI --mp3input +.I input +is an MP3 file +. +.SS Silly options +.TF --nohist +.TP +.BI -f +same as +.LR "-q 7" . +Such a deal. +.TP +.BI -o +mark as non-original (i.e. do not set the original bit) +.TP +.BI -c +mark as copyright +.TP +.BI -k +disable sfb=21 cutoff +.TP +.BI -e " emp" +de-emphasis n/5/c +(default n) +.TP +.BI -d +allow channels to have different blocktypes +.TP +.BI -t +disable Xing VBR informational tag +.TP +.BI -a +autoconvert from stereo to mono file for mono encoding +.TP +.BI -x +force byte-swapping of input (see +.IR dd (1) +instead) +.TP +.BI -S +don't print progress report, VBR histograms +.TP +.BI --athonly +only use the ATH for masking +.TP +.BI --nohist +disable VBR histogram display +.TP +.BI --voice +experimental voice mode +. +.SH EXAMPLES +Play a +.L .flac +file: +.IP +.EX +audio/flacdec < foo.flac >/dev/audio +.EE +.LP +Play an +.L .mp3 +file: +.IP +.EX +games/mp3dec < foo.mp3 >/dev/audio +.EE +.LP +Encode a +.L .wav +file as highest-quality MP3: +.IP +.EX +games/mp3enc -q 0 -b 320 foo.mp3 +.EE +.LP +Create a fixed 128Kb/s MP3 file from a +.L .wav +file: +.IP +.EX +games/mp3enc -h foo.mp3 +.EE +.LP +Stream from stereo 44.1KHz raw PCM data, encoding mono at 16KHz +(you may not need +.IR dd ): +.IP +.EX +dd -conv swab | games/mp3enc -a -r -m m --resample 16 -b 24 >foo.mp3 +.EE +.LP +Play an +.L .ogg +file: +.IP +.EX +audio/oggdec < foo.ogg > /dev/audio +.EE +.LP +Encode a +.L .wav +file as an +.L .ogg +file: +.IP +.EX +audio/oggenc < foo.wav > foo.ogg +.EE +.SH SOURCE +.B /sys/src/cmd/audio/mp3dec +.br +.B /sys/src/cmd/audio/mp3enc +.br +.B /sys/src/cmd/audio/oggdec +.br +.B /sys/src/cmd/audio/oggenc +.SH "SEE ALSO" +.IR dd (1), +.IR audio (3), +.IR cdfs (4), +.IR juke (7), +.IR playlistfs (7) +.br +.B http://www.underbit.com/products/mad/ +.br +.B http://www.sulaco.org/mp3 +.SH BUGS +GNU behemoths, lightly tamed. Quality is much better than encoders +based on the ISO routines, but still not as good as the FhG encoder. +.PP +There are zillions of undocumented options. diff --git a/sys/man/1/mp3dec b/sys/man/1/mp3dec deleted file mode 100644 index dc51ef48d..000000000 --- a/sys/man/1/mp3dec +++ /dev/null @@ -1,27 +0,0 @@ -.TH MP3DEC 1 -.SH NAME -mp3dec \- decode audio MPEG files (layers 1, 2 and 3) -.SH SYNOPSIS -.B audio/mp3dec -[ -.B -d -] -.SH DESCRIPTION -.I Mp3dec -decodes MPEG audio from stdanrd input, -writing 16-bit stereo linear PCM sample data to -standard output. -.PP -The -.B -d -option enabled debug prints to standard error. -.SH SOURCE -.B /sys/src/cmd/audio/mp3dec -.SH "SEE ALSO" -.IR mp3enc (1), -.IR juke (7), -.IR playlistfs (7) -.br -.B http://www.underbit.com/products/mad/ -.SH BUGS -It's another GNU behemoth, lightly tamed. diff --git a/sys/man/1/mp3enc b/sys/man/1/mp3enc deleted file mode 100644 index a68f03189..000000000 --- a/sys/man/1/mp3enc +++ /dev/null @@ -1,208 +0,0 @@ -.TH MP3ENC 1 -.SH NAME -mp3enc \- create mp3 audio files -.SH SYNOPSIS -.in +0.5i -.ti -0.5i -.B audio/mp3enc -[ -.B -hprv -] [ -.B -b -.I bitrate -] [ -.B -B -.I bitrate -] [ -.B -m -.I mode -] [ -.B -q -q ] [ -.B -s -.I sfreq -] [ -.B -V -.I q -] [ -.I "long or silly options" -] -.in -0.5i -.SH DESCRIPTION -.I Mp3enc -compresses audio on standard input, -normally PCM-encoded, -and produces MP3-encoded audio on standard output. -By default, the MP3 file will use `constant bit-rate' (CBR) -encoding, but that can be changed via -.B --abr -(average bitrate desired, ABR) -or -.BR -v -(variable bitrate, VBR). -.SS Options -.TF "\fB-b \fP" -.TP -.B -b -set minimum allowed -.I bitrate -in Kb/s for VBR, default 32Kb/s. -For CBR, -set the exact bitrate in Kb/s, which defaults to 128Kb/s. -.TP -.B -B -set maximum allowed -.I bitrate -in Kb/s for VBR, default 256Kb/s. -.TP -.BI -h -same as -.LR "-q 2" . -.TP -.B -m -.I mode -may be -(s)tereo, -(j)oint, -(f)orce -or -(m)ono -(default j). -.B force -forces mid/side stereo on all frames. -.TP -.B -p -add CRC error protection (adds an additional 16 bits per frame to the stream). -This seems to break playback. -.TP -.B -q -sets output quality to -.I q -(see -.BR -V ). -.TP -.B -r -input is raw pcm -.TP -.B -s -set sampling frequency of input file (in KHz) to -.IR sfreq , -default is 44.1. -.TP -.B -v -use variable bitrate (VBR) encoding -.TP -.B -V -set quality setting for VBR to -.IR q . -Default -.I q -is 4; -0 produces highest-quality and largest files, and -9 produces lowest-quality and smallest files. -.SS Long options -.TF "\fB--resample sfreq \fP" -.TP -.BI --abr " bitrate" -sets average -.I bitrate -desired in Kb/s, instead of setting quality, -and generates ABR encoding. -.TP -.BI --resample " sfreq" -set sampling frequency of output file (in KHz) to -.IR sfreq , -default is input sfreq. -.TP -.BI --mp3input -.I input -is an MP3 file -. -.SS Silly options -.TF --nohist -.TP -.BI -f -same as -.LR "-q 7" . -Such a deal. -.TP -.BI -o -mark as non-original (i.e. do not set the original bit) -.TP -.BI -c -mark as copyright -.TP -.BI -k -disable sfb=21 cutoff -.TP -.BI -e " emp" -de-emphasis n/5/c -(default n) -.TP -.BI -d -allow channels to have different blocktypes -.TP -.BI -t -disable Xing VBR informational tag -.TP -.BI -a -autoconvert from stereo to mono file for mono encoding -.TP -.BI -x -force byte-swapping of input (see -.IR dd (1) -instead) -.TP -.BI -S -don't print progress report, VBR histograms -.TP -.BI --athonly -only use the ATH for masking -.TP -.BI --nohist -disable VBR histogram display -.TP -.BI --voice -experimental voice mode -. -.SH EXAMPLES -Encode a -.L .wav -file as highest-quality MP3. -.IP -.EX -games/mp3enc -q 0 -b 320 -.EE -.LP -Create a fixed 128Kb/s MP3 file from a -.L .wav -file. -.IP -.EX -games/mp3enc -h foo.mp3 -.EE -.LP -Streaming from stereo 44.1KHz raw PCM data, encoding mono at 16KHz -(you may not need -.IR dd ): -.IP -.EX -dd -conv swab | games/mp3enc -a -r -m m --resample 16 -b 24 -.EE -.SH SOURCE -.B /sys/src/cmd/audio/mp3enc -.SH SEE ALSO -.IR dd (1), -.IR mp3dec (1), -.IR audio (3), -.IR cdfs (4), -.IR juke (7), -.IR playlistfs (7) -.br -.B http://www.sulaco.org/mp3 -.SH BUGS -Quality is much better than encoders based on the ISO routines, -but still not as good as the FhG encoder. -.PP -It's a GNU behemoth, lightly rehabilitated. -There are zillions of undocumented options. diff --git a/sys/man/1/oggdec b/sys/man/1/oggdec deleted file mode 100644 index 315832309..000000000 --- a/sys/man/1/oggdec +++ /dev/null @@ -1,23 +0,0 @@ -.TH OGGDEC 1 -.SH NAME -oggdec \- decode ogg vorbis audio files -.SH SYNOPSIS -.B audio/oggdec -.SH DESCRIPTION -.I oggdec -reads encoded data from standard input, and writes -44100Hz 16 bit LSB stereo data to standard output. -So -.IP -.L -audio/oggdec < file > /dev/audio -.LP -plays file, provided that you have a working /dev/audio. -.SH SOURCE -.B /sys/src/cmd/audio/oggdec -.SH SEE ALSO -.IR oggenc (1) -.SH DIAGNOSTICS -None. -.SH BUGS -Other output modes are not supported. diff --git a/sys/man/1/oggenc b/sys/man/1/oggenc deleted file mode 100644 index 08968df2d..000000000 --- a/sys/man/1/oggenc +++ /dev/null @@ -1,31 +0,0 @@ -.TH OGGENC 1 -.SH NAME -oggenc \- encode raw audio to -.I ogg vorbis -audio files -.SH SYNOPSIS -.B audio/oggenc -.SH DESCRIPTION -.I Oggenc -reads 44100Hz 16 bit LSB stereo data from standard input, and writes -encoded -.I 128 kbit/s -variable bit rate -.I ogg vorbis -stream to standard output. -So -.IP -.L -audio/oggenc < /dev/audio > audio.ogg -.LP -encodes an ogg vorbis stream from your computer's line in to -.B audio.ogg -in real time. -.SH SOURCE -.B /sys/src/cmd/audio/oggenc -.SH SEE ALSO -.IR oggdec (1) -.SH DIAGNOSTICS -None. -.SH BUGS -Other input and output modes are not supported. -- cgit v1.2.3