ref: 0dce53f602bb40cc1476fdab7fba27ce028d3ce4
parent: 2e62a7cff3b96ca1335ad65d3b3d8292a458747a
author: Mark Harris <[email protected]>
date: Sat Sep 7 17:55:14 EDT 2019
man: Clean up man pages
--- a/man/opusdec.1
+++ b/man/opusdec.1
@@ -1,133 +1,119 @@
.\" Process this file with
.\" groff -man -Tascii opusdec.1
.\"
-.TH opusdec 1 2012-08-31 "Xiph.Org Foundation" "opus-tools"
-
+.TH opusdec 1 2019-09-07 "Xiph.Org Foundation" "opus-tools"
.SH NAME
-opusdec \- decode audio in Opus format to Wave or raw PCM
-
+opusdec \(en decode audio in Opus format to Wave or raw PCM
.SH SYNOPSIS
.B opusdec
[
-.B -hV
-] [
-.B --quiet
-] [
-.B --rate Hz
-] [
-.B --force-stereo
-] [
-.B --gain dB
-] [
-.B --no-dither
-] [
-.B --float
-] [
-.B --force-wav
-] [
-.B --packet-loss pct
-] [
-.B --save-range file
+.I options
]
-.B input.opus
+.I input
[
-.B output.wav
+.I output
]
-
.SH DESCRIPTION
-
.B opusdec
decodes Opus URLs or files to uncompressed Wave or raw PCM.
-
-In URLs, the
-.B file
-,
-.B http
-, and
+.PP
+.I input
+may be a URL, file, or "\fB\-\fR" to read from stdin. In URLs, the
+.BR file ,
+.BR http ,
+and
.B https
schemes are supported unless HTTP support was disabled at build time.
-
-If the input file is specified as
-.B "-"
-, then
+.PP
+.I output
+is an output file or "\fB\-\fR" to write to stdout. The output
+will be in Wave format if the output filename ends in
+.B .wav
+or the
+.B "--force-wav"
+option is used; otherwise raw PCM samples will be written.
+.PP
+If
+.I output
+is not specified,
.B opusdec
-will read from stdin. Likewise, an output filename of
-.B "-"
-will cause output to be to stdout.
-
-If no output is specified
-.B opusdec
will attempt to play the audio in realtime if it supports
audio playback on your system.
-
-.SH "OPTIONS"
-.IP "-h, --help"
-Show help message
-.IP "-V, --version"
-Show version information
-.IP "--quiet"
-Suppresses program output
-.IP "--rate n"
+.SH OPTIONS
+.TP
+.BR -h ", " --help
+Show command help.
+.TP
+.BR -V ", " --version
+Show version information.
+.TP
+.B --quiet
+Suppresses program output.
+.TP
+.BI --rate " N"
+Force decoding at sampling rate
+.I N
+Hz.
+.TP
+.B --force-stereo
+Force decoding to stereo.
+.TP
+.BI --gain " N"
.br
-Force decoding at sampling rate n Hz
-.IP "--force-stereo"
-.br
-Force decoding to stereo
-.IP "--gain n"
-.br
-Adjust the output volume n dB, negative values make the signal quieter
-.IP "--no-dither"
-Do not dither 16-bit output
-.IP "--float"
-Output 32-bit floating-point samples instead of 16-bit integer samples
-.IP "--force-wav"
-Force including a Wave header on output (e.g. for non-wav extensions and stdout)
-.IP "--packet-loss n"
-Simulate n % random Opus packet loss
-.IP "--save-range file"
-Save check values for every frame to a file
-
+Adjust the output volume
+.I N
+dB.
+Negative values make the signal quieter.
+.TP
+.B --no-dither
+Do not dither 16-bit output.
+.TP
+.B --float
+Output 32-bit floating-point samples instead of 16-bit integer samples.
+.TP
+.B --force-wav
+Force Wave output format, regardless of the output filename extension.
+.TP
+.BI --packet-loss " N"
+Simulate \fIN\fR\|% random Opus packet loss.
+.TP
+.BI --save-range " FILENAME"
+Save check values for every frame to a file.
.SH EXAMPLES
Decode a file
.B input.opus
to
-.B output.wav
-.RS
+.BR output.wav :
+.RS 5
opusdec input.opus output.wav
.RE
-
+.PP
Play a file
-.B input.opus
-.RS
+.BR input.opus :
+.RS 5
opusdec input.opus
.RE
-
-Re-encode a high bitrate Opus file to a lower rate
-.RS
+.PP
+Re-encode a high bitrate Opus file to a lower rate:
+.RS 5
opusdec --force-wav input.opus - | opusenc --bitrate 64 - output.opus
.RE
-
-Play an http stream
+.PP
+Play the http stream
.B http://icecast.somwhere.org:8000/stream.opus
-on a system with pulseaudio
-.br
+on a system with pulseaudio:
.I (press ctrl-c to quit)
-.RS
+.RS 5
padsp opusdec http://icecast.somwhere.org:8000/stream.opus
.RE
-
.SH AUTHORS
-.br
Jean-Marc Valin <[email protected]>
-.br
+.PP
Gregory Maxwell <[email protected]>
-
.SH BUGS
-
Opusdec does not currently reject all invalid files which it should reject.
It also doesn't provide very helpful output for the corrupted files it
does reject. Use \fBopusinfo\fR(1) for somewhat better diagnostics.
-
.SH SEE ALSO
.BR opusenc (1),
.BR opusinfo (1)
--- a/man/opusenc.1
+++ b/man/opusenc.1
@@ -1,391 +1,361 @@
.\" Process this file with
.\" groff -man -Tascii opusenc.1
.\"
-.TH opusenc 1 2012-08-31 "Xiph.Org Foundation" "opus-tools"
-
+.TH opusenc 1 2019-09-07 "Xiph.Org Foundation" "opus-tools"
.SH NAME
-opusenc \- encode audio into the Opus format
-
+opusenc \(en encode audio into the Opus format
.SH SYNOPSIS
.B opusenc
[
-.B -h
-] [
-.B -V
-] [
-.B --help-picture
-] [
-.B --quiet
-] [
-.B --bitrate
-.I kbit/s
-] [
-.B --vbr
-] [
-.B --cvbr
-] [
-.B --hard-cbr
-] [
-.B --music
-] [
-.B --speech
-] [
-.B --comp
-.I complexity
-] [
-.B --framesize
-.I 2.5, 5, 10, 20, 40, 60
-] [
-.B --expect-loss
-.I pct
-] [
-.B --downmix-mono
-] [
-.B --downmix-stereo
-] [
-.B --no-phase-inv
-] [
-.B --max-delay
-.I ms
-] [
-.B --title
-.I 'track title'
-] [
-.B --artist
-.I author
-] [
-.B --album
-.I 'album title'
-] [
-.B --tracknumber
-.I 'track number'
-] [
-.B --genre
-.I genre
-] [
-.B --date
-.I YYYY-MM-DD
-] [
-.B --comment
-.I tag=value
-] [
-.B --picture
-.IB filename | specification
-] [
-.B --padding
-.I n
-] [
-.B --discard-comments
-] [
-.B --discard-pictures
-] [
-.B --raw
-] [
-.B --raw-bits
-.I bits/sample
-] [
-.B --raw-rate
-.I Hz
-] [
-.B --raw-chan
-.I N
-] [
-.B --raw-endianness
-.I flag
-] [
-.B --ignorelength
-] [
-.B --serial
-.I serial number
-] [
-.B --save-range
-.I file
-] [
-.B --set-ctl-int
-.I ctl=value
+.I options
]
-.I input.wav
+.I input_file
.I output.opus
-
.SH DESCRIPTION
.B opusenc
reads audio data in Wave, AIFF, FLAC, Ogg/FLAC,
-or raw PCM format and encodes it into an Ogg
-Opus stream. If the input file is "-" audio data is read from stdin.
-Likewise, if the output file is "-" the Ogg Opus stream is written to stdout.
-
+or raw PCM format and encodes it into an Ogg Opus stream.
+If the input file is "\fB\-\fR" audio data is read from stdin.
+Likewise, if the output file is "\fB\-\fR" the Ogg Opus stream
+is written to stdout.
+.PP
Unless quieted
.B opusenc
-displays fancy statistics about the encoding progress.
-
+displays statistics about the encoding progress.
.SH OPTIONS
.SS "General options"
-.IP "-h, --help"
-Show command help
-.IP "-V, --version"
-Show the version number
-.IP "--help-picture"
-Show help on attaching album art
-.IP "--quiet"
-Enable quiet mode. No messages are displayed.
-
+.TP
+.BR -h ", " --help
+Show command help.
+.TP
+.BR -V ", " --version
+Show version information.
+.TP
+.B --help-picture
+Show help on attaching album art.
+.TP
+.B --quiet
+Enable quiet mode.
+No messages are displayed.
.SS "Encoding options"
-.IP "--bitrate N.nnn"
-Set target bitrate in kbit/s (6-256 per channel)
-
+.TP
+.BI --bitrate " N"
+Set target bitrate in kbit/s (6\(en256 per channel).
+.IP
In VBR mode this specifies the average rate for a large and diverse
-collection of audio. In CVBR and Hard-CBR mode it specifies the specific
-output bitrate.
-
+collection of audio.
+In CVBR and Hard-CBR mode it specifies the specific output bitrate.
+.IP
The default for input with a sample rate of 44.1 kHz or higher is
64 kbit/s per mono stream and 96 kbit/s per coupled pair.
-.IP "--vbr"
-Use variable bitrate encoding (default)
-
+.TP
+.B --vbr
+Use variable bitrate encoding (default).
In VBR mode the bitrate may go up and down freely depending on the content
to achieve more consistent quality.
-.IP "--cvbr"
+.TP
+.B --cvbr
Use constrained variable bitrate encoding.
-
-Outputs to a specific bitrate. This mode is analogous to CBR in AAC/MP3
-encoders and managed mode in Vorbis coders. This delivers less consistent
-quality than VBR mode but consistent bitrate.
-.IP "--hard-cbr"
+Outputs a specific bitrate.
+This mode is analogous to CBR in AAC and MP3 encoders and managed mode in
+Vorbis coders.
+This delivers less consistent quality than VBR mode but consistent bitrate.
+.TP
+.B --hard-cbr
Use hard constant bitrate encoding.
-
With hard-cbr every frame will be exactly the same size, similar to how
-speech codecs work. This delivers lower overall quality but is useful
-where bitrate changes might leak data in encrypted channels or on
-synchronous transports.
-.IP "--music"
+speech codecs work.
+This delivers lower overall quality but is useful where bitrate changes
+might leak data in encrypted channels or on synchronous transports.
+.TP
+.B --music
Override automatic detection and tune low bitrate encoding for music.
By default, music is detected automatically and the classification
may vary over time.
-
+.IP
Tuning impacts lower bitrates that involve tradeoffs between speech
clarity and musical accuracy, and has no impact at bitrates typically
used for high quality music encoding.
-.IP "--speech"
+.TP
+.B --speech
Override automatic detection and tune low bitrate encoding for speech.
By default, speech is detected automatically and the classification
may vary over time.
-
+.IP
Tuning impacts lower bitrates that involve tradeoffs between speech
clarity and musical accuracy, and has no impact at bitrates typically
used for high quality music encoding.
-.IP "--comp N"
-Set encoding computational complexity (0-10, default: 10). Zero gives the
-fastest encodes but lower quality, while 10 gives the highest quality
-but slower encoding.
-.IP "--framesize N"
-Set maximum frame size in milliseconds (2.5, 5, 10, 20, 40, 60, default: 20)
-.br
-Smaller framesizes achieve lower latency but less quality at a given
-bitrate.
-.br
-Sizes greater than 20ms are only interesting at fairly low
-bitrates.
-.IP "--expect-loss N"
-Set expected packet loss in percent (default: 0)
-.IP "--downmix-mono"
-Downmix to mono
-.IP "--downmix-stereo"
-Downmix to stereo (if >2 channels input)
-.IP "--no-phase-inv"
-Disable use of phase inversion for intensity stereo. This trades some
-stereo quality for a higher quality mono downmix, and is useful when
-encoding stereo audio that is likely to be downmixed to mono after decoding.
-.IP "--max-delay N"
-Set maximum container delay in milliseconds (0-1000, default: 1000)
-
+.TP
+.BI --comp " N"
+Set encoding computational complexity (0\(en10, default: 10).
+Zero gives the fastest encodes but lower quality, while 10 gives the
+highest quality but slower encoding.
+.TP
+.BI --framesize " N"
+Set maximum frame size in milliseconds (2.5, 5, 10, 20, 40, 60, default: 20).
+Smaller framesizes achieve lower latency but less quality at a given bitrate.
+Sizes greater than 20\ ms are only interesting at fairly low bitrates.
+.TP
+.BI --expect-loss " N"
+Set expected packet loss in percent (default: 0).
+.TP
+.B --downmix-mono
+Downmix to mono.
+.TP
+.B --downmix-stereo
+Downmix multichannel speaker configurations to stereo.
+.TP
+.B --no-phase-inv
+Disable use of phase inversion for intensity stereo.
+This trades some stereo quality for a higher quality mono downmix,
+and is useful when encoding stereo audio that is likely to be downmixed
+to mono after decoding.
+.TP
+.BI --max-delay " N"
+Set maximum container delay in milliseconds (0\(en1000, default: 1000).
.SS "Metadata options"
-.IP "--title title"
+.TP
+.BI --title " TITLE"
Set the track title comment field to
-.I title
-.IP "--artist artist"
+.IR TITLE .
+.TP
+.BI --artist " ARTIST"
Set the artist comment field to
-.I artist.
+.IR ARTIST .
This may be used multiple times to list contributing artists individually.
Note that some playback software does not display multiple artists gracefully.
-.IP "--album album"
+.TP
+.BI --album " ALBUM"
Set the album or collection title field to
-.I album
-.IP "--tracknumber N"
-Set the track number comment field to
-.I N
-.IP "--date YYYY-MM-DD"
-Set the date comment field to
-.I YYYY-MM-DD.
-This may be shortened to YYYY-MM or YYYY.
-.IP "--genre genre"
+.IR ALBUM .
+.TP
+.BI --genre " GENRE"
Set the genre comment field to
-.I genre.
-This option may be specified multiple times to tag a track with
+.IR GENRE .
+This option may be used multiple times to tag a track with
multiple overlapping genres.
-.IP "--comment tag=value"
-Add an extra comment. This may be used multiple times. The argument
-should be in the form "tag=value".
-See the vorbis-comment specification for well known tag names:
-https://www.xiph.org/vorbis/doc/v-comment.html
-.IP "--picture filename|specification"
+.TP
+.BI --date " YYYY-MM-DD"
+Set the date comment field to
+.IR YYYY-MM-DD .
+This may be shortened to
+.I YYYY-MM
+or
+.IR YYYY .
+.TP
+.BI --tracknumber " N"
+Set the track number comment field to
+.IR N .
+.TP
+.BI --comment " TAG" = VALUE
+Add an extra comment.
+This may be used multiple times.
+The argument should be in the form
+.IR TAG = VALUE .
+See the vorbis-comment specification
+<https://\:www.\:xiph.\:org/\:vorbis/\:doc/v-\:comment.\:html>
+for well known tag names.
+.TP
+\fB--picture\fR \fIFILENAME\fR | \fISPECIFICATION\fR
Attach album art for the track.
-
+JPEG and PNG image formats are accepted.
Either a
-.I filename
+.I FILENAME
for the artwork or a more complete
-.I specification
+.I SPECIFICATION
form can be used.
The picture is added to a
.B METADATA_BLOCK_PICTURE
-comment field similar to what is used in
-.SM FLAC.
+comment field similar to what is used in FLAC.
+.IP
The
-.I specification
-is a string whose parts are separated by | (pipe) characters.
-Some parts may be left empty to invoke default values.
-Passing a plain filename is just shorthand for the "||||filename"
+.I SPECIFICATION
+is a string whose parts are separated by
+.B |
+(pipe) characters.
+Except for the filename all parts are optional.
+A plain
+.I FILENAME
+is equivalent to a
+.BI |||| FILENAME
specification.
-
+.IP
The format of
-.I specification
-is [\fBtype\fR]|[\fBmedia-type\fR]|[\fBdescription\fR]|[\fBwidth\fRx\fBheight\fRx\fBdepth\fR[/\fBcolors\fR]]|\fBfilename\fR
-
-.I type
-is an optional number describing the nature of the picture.
-Defined values are from one of:
-
- 0: Other
-.br
- 1: 32x32 pixel 'file icon' (PNG only)
-.br
- 2: Other file icon
-.br
- 3: Cover (front)
-.br
- 4: Cover (back)
-.br
- 5: Leaflet page
-.br
- 6: Media (e.g., label side of a CD)
-.br
- 7: Lead artist/lead performer/soloist
-.br
- 8: Artist/performer
-.br
- 9: Conductor
-.br
- 10: Band/Orchestra
-.br
- 11: Composer
-.br
- 12: Lyricist/text writer
-.br
- 13: Recording location
-.br
- 14: During recording
-.br
- 15: During performance
-.br
- 16: Movie/video screen capture
-.br
- 17: A bright colored fish
-.br
- 18: Illustration
-.br
- 19: Band/artist logotype
-.br
- 20: Publisher/studio logotype
-
-The default is 3 (front cover).
-More than one --picture option can be specified to attach multiple pictures.
+.I SPECIFICATION
+is:
+\%[\,\fITYPE\/\fR]\|\fB|\fR\|[\,\fIMEDIATYPE\/\fR]\|\fB|\fR\|[\,\fIDESCRIPTION\/\fR]\|\fB|\fR\|[\,\fIDIMENSIONS\/\fR]\|\fB|\|\fIFILENAME\fR
+.IP
+.PD 0
+.I TYPE
+is a number denoting the nature of the picture (default 3):
+.RS
+.RS 4
+.TP
+.B 0
+Other
+.TP
+.B 1
+32x32 pixel 'file icon' (PNG only)
+.TP
+.B 2
+Other file icon
+.TP
+.B 3
+Cover (front)
+.TP
+.B 4
+Cover (back)
+.TP
+.B 5
+Leaflet page
+.TP
+.B 6
+Media (e.g., label side of a CD)
+.TP
+.B 7
+Lead artist/lead performer/soloist
+.TP
+.B 8
+Artist/performer
+.TP
+.B 9
+Conductor
+.TP
+.B 10
+Band/Orchestra
+.TP
+.B 11
+Composer
+.TP
+.B 12
+Lyricist/text writer
+.TP
+.B 13
+Recording location
+.TP
+.B 14
+During recording
+.TP
+.B 15
+During performance
+.TP
+.B 16
+Movie/video screen capture
+.TP
+.B 17
+A bright colored fish
+.TP
+.B 18
+Illustration
+.TP
+.B 19
+Band/artist logotype
+.TP
+.B 20
+Publisher/studio logotype
+.RE
+.RE
+.IP
There may only be one picture each of type 1 and 2 in a file.
-
-.I media-type
-is optional and is now ignored.
-
-.I description
-is optional. The default is an empty string.
-
-The next part specifies the resolution and color information, but
-is now ignored.
-
-.I filename
+.PD
+.IP
+The default
+.I DESCRIPTION
+is an empty string.
+.I FILENAME
is the path to the picture file to be imported.
-
-.IP "--padding n"
+.I MEDIATYPE
+and
+.I DIMENSIONS
+are obtained from the file and any specified values are ignored.
+.IP
+More than one
+.B --picture
+option can be specified to attach multiple pictures.
+.TP
+.BI --padding " N"
Reserve
-.I n
-extra bytes for metadata tags. This can make later tag editing more
-efficient. Defaults to 512.
-.IP "--discard-comments"
+.I N
+extra bytes for metadata tags.
+This can make later tag editing more efficient.
+Defaults to 512.
+.TP
+.B --discard-comments
Don't propagate metadata tags from the input file.
-.IP "--discard-pictures"
+.TP
+.B --discard-pictures
Don't propagate pictures or art from the input file.
-
.SS "Input options"
-.IP "--raw"
-Interpret input as raw PCM data without headers
-.IP "--raw-bits N"
-Set bits/sample for raw input (default: 16)
-.IP "--raw-rate N"
-Set sampling rate for raw input (default: 48000)
-.IP "--raw-chan N"
-Set number of channels for raw input (default: 2)
-.IP "--raw-endianness [0/1]"
-Set the endianness for raw input: 1 for big endian, 0 for little (default: 0)
-.IP "--ignorelength"
-Ignore the data length in Wave headers. Opusenc automatically ignores
-the length when its implausible (very small or very large) but some STDIN
-usage may still need this option to avoid truncation.
-
+.TP
+.B --raw
+Interpret input as raw PCM data without headers.
+.TP
+.BI --raw-bits " N"
+Set bits/sample for raw input (default: 16).
+.TP
+.BI --raw-rate " N"
+Set sampling rate for raw input (default: 48000).
+.TP
+.BI --raw-chan " N"
+Set number of channels for raw input (default: 2).
+.TP
+.BR --raw-endianness " " 0 | 1
+Set the endianness for raw input: 1 for big endian, 0 for little (default: 0).
+.TP
+.B --ignorelength
+Ignore the data length in Wave headers.
+The length will always be ignored when it is implausible (very small or very
+large), but some stdin usage may still need this option to avoid truncation.
.SS "Diagnostic options"
-.IP "--serial n"
-Force use of a specific stream serial number, rather than one that is randomly generated.
-This is used to make the encoder deterministic for testing and is not generally recommended.
-.IP "--save-range file"
-Save check values for every frame to a file
-.IP "--set-ctl-int x=y"
-Pass the encoder control x with value y (advanced).
-Preface with s: to direct the ctl to multistream s
-.br
-This may be used multiple times
-
+.TP
+.BI --serial " N"
+Force use of a specific stream serial number, rather than one that is
+randomly generated.
+This is used to make the encoder deterministic for testing and is not
+generally recommended.
+.TP
+.BI --save-range " FILENAME"
+Save check values for every frame to a file.
+.TP
+\fB--set-ctl-int\fR [\,\fIS\/\fB:\fR]\,\fIX\/\fR=\,\fIY\fR
+Pass the encoder control
+.I X
+with value
+.I Y
+(advanced).
+Preface with
+.IR S :
+to direct the ctl to multistream stream number
+.IR S .
+This may be used multiple times.
.SH EXAMPLES
-
-Simplest usage. Take input as input.wav and produce output as output.opus:
-.RS
+Simplest usage.
+Take input as input.wav and produce output as output.opus:
+.RS 5
opusenc input.wav output.opus
.RE
.PP
-
Produce a very high quality encode with a target rate of 160 kbit/s:
-.RS
+.RS 5
opusenc --bitrate 160 input.wav output.opus
.RE
.PP
-
Record and send a live stream to an Icecast HTTP streaming server using oggfwd:
-.RS
-arecord -c 2 -r 48000 -twav - | opusenc --bitrate 96 - - | oggfwd icecast.somewhere.org 8000 password /stream.opus
+.RS 5
+arecord -c 2 -r 48000 -twav - | opusenc --bitrate 96 - - | oggfwd icecast.somewhere.org 8000 password /stream.opus
.RE
-.PP
-
.SH NOTES
-
-While it is possible to use opusenc for low latency streaming (e.g. with --max-delay set to 0
-and netcat instead of Icecast) it's not really designed for this, and the Ogg container
-and TCP transport aren't the best tools for that application. Shell
-pipelines themselves will often have high buffering. The ability to set
-framesizes as low as 2.5 ms in opusenc mostly exists to try out the quality
-of the format with low latency settings, but not really for actual low
-latency usage.
-.br
+While it is possible to use opusenc for low latency streaming (e.g. with
+.B "--max-delay 0"
+and netcat instead of Icecast) it's not really designed for this, and the
+Ogg container and TCP transport aren't the best tools for that application.
+Shell pipelines themselves will often have high buffering.
+The ability to set framesizes as low as 2.5\ ms in opusenc mostly exists
+to try out the quality of the format with low latency settings, but not
+really for actual low latency usage.
Interactive usage should use UDP/RTP directly.
-
.SH AUTHORS
-.br
Gregory Maxwell <[email protected]>
-
.SH SEE ALSO
.BR opusdec (1),
.BR opusinfo (1),
--- a/man/opusinfo.1
+++ b/man/opusinfo.1
@@ -1,11 +1,9 @@
.\" Process this file with
.\" groff -man -Tascii opusinfo.1
.\"
-.TH opusinfo 1 2012-08-31 "Xiph.Org Foundation" "opus-tools"
-
+.TH opusinfo 1 2019-09-07 "Xiph.Org Foundation" "opus-tools"
.SH NAME
-opusinfo \- gives information about Opus files and does extensive validity checking
-
+opusinfo \(en display information and perform validity checks on Opus files
.SH SYNOPSIS
.B opusinfo
[
@@ -17,10 +15,8 @@
] [
.B -V
]
-.I file1.opus
+.I file.opus
.B ...
-.I fileN.opus
-
.SH DESCRIPTION
.B opusinfo
reads one or more Opus files and prints information about stream contents
@@ -27,46 +23,44 @@
(including chained and/or multiplexed streams) to standard output. It will
detect (but not correct) a wide range of common defects, with many
additional checks specifically for Opus streams.
-
+.PP
For all stream types
.B opusinfo
will print the filename being processed, the stream serial numbers, and various
common error conditions.
-
+.PP
For
.B Opus
-streams, information including the version used for encoding, number of channels
-and other header information, the bitrate and playback length, the contents of the
-comment header, and general statistics about the stream are printed.
-
-Opusinfo is a fork of \fBogginfo\fR(1) with the non-opus parts largely removed.
-
+streams, information including the version used for encoding, number of
+channels and other header information, the bitrate and playback length,
+the contents of the comment header, and general statistics about the
+stream are printed.
+.PP
+Opusinfo is a fork of \fBogginfo\fR(1) with the non-Opus parts largely removed.
.SH OPTIONS
-.IP -h
-Show a help and usage message.
-.IP -q
+.TP
+.B -h
+Show command help.
+.TP
+.B -q
Quiet mode. This may be specified multiple times. Doing so once will remove
the detailed informative messages; twice will remove warnings as well.
-.IP -v
+.TP
+.B -v
Verbose mode. At the current time, this does not do anything.
-.IP -V
-Show program version info and exit.
-
+.TP
+.B -V
+Show version information.
.SH NOTES
-
There are many kinds of errored, invalid, non-normative, or otherwise
-unwise stream constructions which opusinfo will not produce warnings
-on. Passing opusinfo with flying colors is not certification of the
+unwise stream constructions for which opusinfo will not produce warnings.
+Passing opusinfo with flying colors is not certification of the
correctness of a stream. Future versions may detect more error
conditions.
-
.SH AUTHORS
-.br
Michael Smith <[email protected]>
-.br
+.PP
Gregory Maxwell <[email protected]>
-
.SH SEE ALSO
-
.BR opusdec (1),
.BR opusenc (1)
--- a/man/opusrtp.1
+++ b/man/opusrtp.1
@@ -1,90 +1,89 @@
.\" Process this file with
.\" groff -man -Tascii opusrtp.1
.\"
-.TH opusrtp 1 2012-08-31 "Xiph.Org Foundation" "opus-tools"
-
+.TH opusrtp 1 2019-09-07 "Xiph.Org Foundation" "opus-tools"
.SH NAME
-opusrtp \- transmit or receive an Opus audio RTP stream
-
+opusrtp \(en transmit or receive an Opus audio RTP stream
.SH SYNOPSIS
-.sp
.B opusrtp
[
-.B transmit-options
+.I transmit-options
]
-.B in.opus ...
-.sp
+.I in.opus ...
+.PP
.B opusrtp
.B --sniff
.I device
[
-.B receive-options
+.I receive-options
]
-.sp
+.PP
.B opusrtp
.B --extract
.I in.pcap
[
-.B receive-options
+.I receive-options
]
-.sp
+.PP
.B opusrtp
.B --help
-.sp
+.PP
.B opusrtp
.B --version
-
.SH DESCRIPTION
-
.B opusrtp
is an experimental tool to transmit and receive Opus audio RTP streams,
used for interactive applications on the internet.
-
-.SH "OPTIONS"
+.SH OPTIONS
.SS "General options"
-.IP "-h, --help"
-Show command help
-.IP "-V, --version"
-Show version information
-
+.TP
+.BR -h ", " --help
+Show command help.
+.TP
+.BR -V ", " --version
+Show version information.
.SS "Transmit options"
-.IP "-d, --destination addr"
-Set destination IP address (default 127.0.0.1)
-.IP "-p, --port n"
-Set destination port (default 1234)
-.IP "-t, --type n"
-Set RTP payload type (default 120)
-
+.TP
+\fB-d\fR, \fB--destination\fR \fIaddr\fR
+Set destination IP address (default: 127.0.0.1).
+.TP
+\fB-p\fR, \fB--port\fR \fIN\fR
+Set destination port (1\(en65535, default: 1234).
+.TP
+\fB-t\fR, \fB--type\fR \fIN\fR
+Set RTP payload type (0\(en127, default: 120).
.SS "Receive options"
-.IP "--sniff device"
+.TP
+\fB--sniff\fR \fIdevice\fR
Sniff the network device for active RTP sessions, which can be
useful for debugging other Opus RTP implementations. This may
require superuser privileges.
-.IP "-e, --extract in.pcap"
-Extract from input pcap file
-.IP "-p, --port n"
-Set destination port to capture. By default, the first plausible
+.TP
+\fB-e\fR, \fB--extract\fR \fIin.pcap\fR
+Extract from input pcap file.
+.TP
+\fB-p\fR, \fB--port\fR \fIN\fR
+Set destination port to capture (1\(en65535). By default, the first plausible
port number that is seen is captured.
-.IP "-t, --type n"
-Set RTP payload type to capture. By default, the first plausible
-dynamic payload type that is seen is captured.
-.IP "-o, --output out.opus"
-Write Ogg Opus output file
-.IP "-r, --rate n"
-Set original sample rate in Ogg Opus output file (default 48000)
-.IP "-c, --channels n"
-Set channel count in Ogg Opus output file (default 2)
-
+.TP
+\fB-t\fR, \fB--type\fR \fIN\fR
+Set RTP payload type to capture (0\(en127). By default, the first plausible
+dynamic payload type (96\(en127) that is seen is captured.
+.TP
+\fB-o\fR, \fB--output\fR \fIout.opus\fR
+Write Ogg Opus output file.
+.TP
+\fB-r\fR, \fB--rate\fR \fIN\fR
+Set original sample rate in Ogg Opus output file (default: 48000).
+.TP
+\fB-c\fR, \fB--channels\fR \fIN\fR
+Set channel count in Ogg Opus output file (default: 2).
.SH AUTHORS
-.br
Ralph Giles <[email protected]>
-
.SH BUGS
-
The receive mode does not support out-of-order or missing packets,
multiple simultaneous RTP streams with the same destination port
number and payload type, or normal unicast and multicast receive.
-
.SH SEE ALSO
.BR opusdec (1),
.BR opusenc (1),