man: Clean up man pages

parent 2e62a7cf
.\" 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
.B opusdec
will read from stdin. Likewise, an output filename of
.B "-"
will cause output to be to stdout.
If no output is specified
.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 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"
.br
Force decoding at sampling rate n Hz
.IP "--force-stereo"
.br
Force decoding to stereo
.IP "--gain 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
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 <jmvalin@jmvalin.ca>
.br
.PP
Gregory Maxwell <greg@xiph.org>
.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)
This diff is collapsed.
.\" 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,56 +15,52 @@ opusinfo \- gives information about Opus files and does extensive validity check
] [
.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
(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 <msmith@xiph.org>
.br
.PP
Gregory Maxwell <greg@xiph.org>
.SH SEE ALSO
.BR opusdec (1),
.BR opusenc (1)
.\" 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 <giles@thaumas.net>
.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),
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment