Skip to content

Commit

Permalink
docs: Update manual pages
Browse files Browse the repository at this point in the history
  • Loading branch information
gavv committed Jul 28, 2024
1 parent 3b97901 commit cc0efbc
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/man/roc-copy.1
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Resampler backend (possible values=\(dqdefault\(dq, \(dqbuiltin\(dq, \(dqspeex\
.BI \-\-resampler\-profile\fB= ENUM
Resampler profile (possible values=\(dqlow\(dq, \(dqmedium\(dq, \(dqhigh\(dq default=\(gamedium\(aq)
.TP
.B \-\-profiling
.B \-\-profile
Enable self profiling (default=off)
.TP
.BI \-\-color\fB= ENUM
Expand Down
20 changes: 16 additions & 4 deletions docs/man/roc-recv.1
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,24 @@ IPv4 or IPv6 address of the network interface on which to join the multicast gro
.B \-\-reuseaddr
enable SO_REUSEADDR when binding sockets
.TP
.BI \-\-target\-latency\fB= STRING
Target latency, TIME units
.TP
.BI \-\-io\-latency\fB= STRING
Playback target latency, TIME units
.TP
.BI \-\-target\-latency\fB= STRING
Target latency, TIME units
.TP
.BI \-\-latency\-tolerance\fB= STRING
Maximum deviation from target latency, TIME units
.TP
.BI \-\-start\-latency\fB= STRING
Start latency, target\-latency must be \(aqauto\(aq or unset, TIME units
.TP
.BI \-\-min\-latency\fB= STRING
Minimum allowed latency, target\-latency and latency\-tolerance must be 0 or unset, TIME units
.TP
.BI \-\-max\-latency\fB= STRING
Maximum allowed latency, target\-latency and latency\-tolerance must be 0 or unset, TIME units
.TP
.BI \-\-no\-play\-timeout\fB= STRING
No playback timeout, TIME units
.TP
Expand Down Expand Up @@ -123,9 +132,12 @@ Which PLC algorithm to use (possible values=\(dqnone\(dq, \(dqbeep\(dq default=
.B \-1\fP,\fB \-\-oneshot
Exit when last connected client disconnects (default=off)
.TP
.B \-\-profiling
.B \-\-profile
Enable self\-profiling (default=off)
.TP
.BI \-\-dump\fB= STRING
Path for a CSV file where to dump run\-time metrics
.TP
.BI \-\-color\fB= ENUM
Set colored logging mode for stderr output (possible values=\(dqauto\(dq, \(dqalways\(dq, \(dqnever\(dq default=\(gaauto\(aq)
.UNINDENT
Expand Down
14 changes: 7 additions & 7 deletions docs/man/roc-send.1
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ Remote control endpoint
.B \-\-reuseaddr
enable SO_REUSEADDR when binding sockets
.TP
.BI \-\-target\-latency\fB= STRING
Target latency, TIME units
.TP
.BI \-\-io\-latency\fB= STRING
Recording target latency, TIME units
.TP
.BI \-\-target\-latency\fB= STRING
Target latency, TIME units
.TP
.BI \-\-latency\-tolerance\fB= STRING
Maximum deviation from target latency, TIME units
.TP
Expand Down Expand Up @@ -111,11 +111,11 @@ Resampler backend (possible values=\(dqdefault\(dq, \(dqbuiltin\(dq, \(dqspeex\
.BI \-\-resampler\-profile\fB= ENUM
Resampler profile (possible values=\(dqlow\(dq, \(dqmedium\(dq, \(dqhigh\(dq default=\(gamedium\(aq)
.TP
.B \-\-interleaving
Enable packet interleaving (default=off)
.B \-\-profile
Enable self\-profiling (default=off)
.TP
.B \-\-profiling
Enable self profiling (default=off)
.BI \-\-dump\fB= STRING
Path for a CSV file where to dump run\-time metrics
.TP
.BI \-\-color\fB= ENUM
Set colored logging mode for stderr output (possible values=\(dqauto\(dq, \(dqalways\(dq, \(dqnever\(dq default=\(gaauto\(aq)
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/manuals/roc_copy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Options
-r, --rate=INT Output sample rate, Hz
--resampler-backend=ENUM Resampler backend (possible values="default", "builtin", "speex", "speexdec" default=`default')
--resampler-profile=ENUM Resampler profile (possible values="low", "medium", "high" default=`medium')
--profiling Enable self profiling (default=off)
--profile Enable self profiling (default=off)
--color=ENUM Set colored logging mode for stderr output (possible values="auto", "always", "never" default=`auto')

File URI
Expand Down
11 changes: 6 additions & 5 deletions docs/sphinx/manuals/roc_recv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ Options
-c, --control=ENDPOINT_URI Local control endpoint
--miface=MIFACE IPv4 or IPv6 address of the network interface on which to join the multicast group
--reuseaddr enable SO_REUSEADDR when binding sockets
--io-latency=STRING Playback target latency, TIME units
--target-latency=STRING Target latency, TIME units
--latency-tolerance=STRING Maximum deviation from target latency, TIME units
--start-latency=STRING Target latency, TIME units
--min-latency=STRING Minimum allowed latency, TIME units
--max-latency=STRING Maximum allowed latency, TIME units
--io-latency=STRING Playback target latency, TIME units
--start-latency=STRING Start latency, target-latency must be 'auto' or unset, TIME units
--min-latency=STRING Minimum allowed latency, target-latency and latency-tolerance must be 0 or unset, TIME units
--max-latency=STRING Maximum allowed latency, target-latency and latency-tolerance must be 0 or unset, TIME units
--no-play-timeout=STRING No playback timeout, TIME units
--choppy-play-timeout=STRING Choppy playback timeout, TIME units
--frame-len=TIME Duration of the internal frames, TIME units
Expand All @@ -45,7 +45,8 @@ Options
--resampler-profile=ENUM Resampler profile (possible values="low", "medium", "high" default=`medium')
--plc=ENUM Which PLC algorithm to use (possible values="none", "beep" default=`none')
-1, --oneshot Exit when last connected client disconnects (default=off)
--profiling Enable self-profiling (default=off)
--profile Enable self-profiling (default=off)
--dump=STRING Path for a CSV file where to dump run-time metrics
--color=ENUM Set colored logging mode for stderr output (possible values="auto", "always", "never" default=`auto')

Endpoint URI
Expand Down
6 changes: 3 additions & 3 deletions docs/sphinx/manuals/roc_send.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Options
-r, --repair=ENDPOINT_URI Remote repair endpoint
-c, --control=ENDPOINT_URI Remote control endpoint
--reuseaddr enable SO_REUSEADDR when binding sockets
--target-latency=STRING Target latency, TIME units
--io-latency=STRING Recording target latency, TIME units
--target-latency=STRING Target latency, TIME units
--latency-tolerance=STRING Maximum deviation from target latency, TIME units
--nbsrc=INT Number of source packets in FEC block
--nbrpr=INT Number of repair packets in FEC block
Expand All @@ -38,8 +38,8 @@ Options
--latency-profile=ENUM Latency tuning profile (possible values="responsive", "gradual", "intact" default=`intact')
--resampler-backend=ENUM Resampler backend (possible values="default", "builtin", "speex", "speexdec" default=`default')
--resampler-profile=ENUM Resampler profile (possible values="low", "medium", "high" default=`medium')
--interleaving Enable packet interleaving (default=off)
--profiling Enable self profiling (default=off)
--profile Enable self-profiling (default=off)
--dump=STRING Path for a CSV file where to dump run-time metrics
--color=ENUM Set colored logging mode for stderr output (possible values="auto", "always", "never" default=`auto')

Endpoint URI
Expand Down

0 comments on commit cc0efbc

Please sign in to comment.