From cc0efbc46469769c11757449f001d919e5f6e8bd Mon Sep 17 00:00:00 2001 From: Victor Gaydov Date: Mon, 29 Jul 2024 01:24:53 +0400 Subject: [PATCH] docs: Update manual pages --- docs/man/roc-copy.1 | 2 +- docs/man/roc-recv.1 | 20 ++++++++++++++++---- docs/man/roc-send.1 | 14 +++++++------- docs/sphinx/manuals/roc_copy.rst | 2 +- docs/sphinx/manuals/roc_recv.rst | 11 ++++++----- docs/sphinx/manuals/roc_send.rst | 6 +++--- 6 files changed, 34 insertions(+), 21 deletions(-) diff --git a/docs/man/roc-copy.1 b/docs/man/roc-copy.1 index 243cbc2d9..57b348a77 100644 --- a/docs/man/roc-copy.1 +++ b/docs/man/roc-copy.1 @@ -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 diff --git a/docs/man/roc-recv.1 b/docs/man/roc-recv.1 index 94e59f384..c5fb941ec 100644 --- a/docs/man/roc-recv.1 +++ b/docs/man/roc-recv.1 @@ -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 @@ -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 diff --git a/docs/man/roc-send.1 b/docs/man/roc-send.1 index dd769703c..8066d62ac 100644 --- a/docs/man/roc-send.1 +++ b/docs/man/roc-send.1 @@ -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 @@ -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) diff --git a/docs/sphinx/manuals/roc_copy.rst b/docs/sphinx/manuals/roc_copy.rst index e7a4c011a..765e2cbef 100644 --- a/docs/sphinx/manuals/roc_copy.rst +++ b/docs/sphinx/manuals/roc_copy.rst @@ -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 diff --git a/docs/sphinx/manuals/roc_recv.rst b/docs/sphinx/manuals/roc_recv.rst index bce74b698..4b37b20c0 100644 --- a/docs/sphinx/manuals/roc_recv.rst +++ b/docs/sphinx/manuals/roc_recv.rst @@ -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 @@ -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 diff --git a/docs/sphinx/manuals/roc_send.rst b/docs/sphinx/manuals/roc_send.rst index 6c7579104..1523b7ff9 100644 --- a/docs/sphinx/manuals/roc_send.rst +++ b/docs/sphinx/manuals/roc_send.rst @@ -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 @@ -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