From 47ec7efdb38d404cfdc7e3229dc3cb7c11d69f14 Mon Sep 17 00:00:00 2001 From: Nate Bargmann Date: Thu, 1 Mar 2012 21:09:49 -0600 Subject: [PATCH] Update man pages for sorted -l output The output from [rig|rot]ctl[d] using the -l|--list option is now sorted by model number in ascending order. Document it. (cherry picked from commit 45def7bbcfa10be1199bb1dcf19d844153a6905f) --- tests/README | 4 ++-- tests/rigctl.1 | 10 ++++++++-- tests/rigctld.8 | 10 ++++++++-- tests/rotctl.1 | 10 ++++++++-- tests/rotctld.8 | 10 ++++++++-- 5 files changed, 34 insertions(+), 10 deletions(-) diff --git a/tests/README b/tests/README index 102bae0f3..8c2262b5f 100644 --- a/tests/README +++ b/tests/README @@ -9,10 +9,10 @@ If you don't know the number, listrigs can give it to you, Rig# Mfg Model Vers. 1 Hamlib Dummy 0.1 - 1506 Winradio WR-3500 0.6 + 105 Yaesu FT-747GX 0.1 210 Kenwood TS-870S 0.1 311 Icom IC-706MkIIG 0.2 - 105 Yaesu FT-747GX 0.1 + 1506 Winradio WR-3500 0.6 [etc.] In any case, you are encouraged to check for correct initialization diff --git a/tests/rigctl.1 b/tests/rigctl.1 index 2c7240c09..bfd8aa36b 100644 --- a/tests/rigctl.1 +++ b/tests/rigctl.1 @@ -2,7 +2,7 @@ .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH RIGCTL "1" "January 7, 2012" "Hamlib" "Radio Control Program" +.TH RIGCTL "1" "March 1, 2012" "Hamlib" "Radio Control Program" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -107,7 +107,13 @@ Set config parameter. e.g. stop_bits=2 Use -L option for a list. .TP .B \-l, --list -List all model numbers defined in \fBHamlib\fP and exit. +List all model numbers defined in \fBHamlib\fP and exit. As of 1.2.15.1 +the list is sorted by model number. +.sp +\fBN.B.\fP In Linux the list can be scrolled back using Shift-PageUp/ +Shift-PageDown, or using the scrollbars of a virtual terminal in X or +the cmd window in Windows. The output can be piped to 'more' or 'less', +e.g. 'rigctl -l | more'. .TP .B \-u, --dump-caps Dump capabilities for the radio defined with -m above and exit. diff --git a/tests/rigctld.8 b/tests/rigctld.8 index 5282c1eaf..ab1c09d19 100644 --- a/tests/rigctld.8 +++ b/tests/rigctld.8 @@ -2,7 +2,7 @@ .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH RIGCTLD "8" "January 7, 2012" "Hamlib" "Rig Control Daemon" +.TH RIGCTLD "8" "March 1, 2012" "Hamlib" "Rig Control Daemon" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -116,7 +116,13 @@ Set config parameter. e.g. --set-conf=stop_bits=2 Use -L option for a list. .TP .B \-l, --list -List all model numbers defined in \fBHamlib\fP and exit. +List all model numbers defined in \fBHamlib\fP and exit. As of 1.2.15.1 +the list is sorted by model number. +.sp +\fBN.B.\fP In Linux the list can be scrolled back using Shift-PageUp/ +Shift-PageDown, or using the scrollbars of a virtual terminal in X or +the cmd window in Windows. The output can be piped to 'more' or 'less', +e.g. 'rigctld -l | more'. .TP .B \-u, --dump-caps Dump capabilities for the radio defined with -m above and exit. diff --git a/tests/rotctl.1 b/tests/rotctl.1 index 9193c83ca..5c50773b0 100644 --- a/tests/rotctl.1 +++ b/tests/rotctl.1 @@ -2,7 +2,7 @@ .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH ROTCTL "1" "January 7, 2012" "Hamlib" "Rotator Control Program" +.TH ROTCTL "1" "March 1, 2012" "Hamlib" "Rotator Control Program" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -78,7 +78,13 @@ Use -L option for a list. Dump capabilities for the rotor defined with -m above and exit. .TP .B \-l, --list -List all model numbers defined in \fBHamlib\fP and exit. +List all model numbers defined in \fBHamlib\fP and exit. As of 1.2.15.1 +the list is sorted by model number. +.sp +\fBN.B.\fP In Linux the list can be scrolled back using Shift-PageUp/ +Shift-PageDown, or using the scrollbars of a virtual terminal in X or +the cmd window in Windows. The output can be piped to 'more' or 'less', +e.g. 'rotctl -l | more'. .TP .B \-v, --verbose Set verbose mode, cumulative (see DIAGNOSTICS below). diff --git a/tests/rotctld.8 b/tests/rotctld.8 index 8533f1a7b..f2d79ac71 100644 --- a/tests/rotctld.8 +++ b/tests/rotctld.8 @@ -2,7 +2,7 @@ .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH ROTCTLD "8" "January 7, 2012" "Hamlib" "Rotator Control Daemon" +.TH ROTCTLD "8" "March 1, 2012" "Hamlib" "Rotator Control Daemon" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -94,7 +94,13 @@ Set config parameter. e.g. --set-conf=stop_bits=2 Use -L option for a list. .TP .B \-l, --list -List all model numbers defined in \fBHamlib\fP and exit. +List all model numbers defined in \fBHamlib\fP and exit. As of 1.2.15.1 +the list is sorted by model number. +.sp +\fBN.B.\fP In Linux the list can be scrolled back using Shift-PageUp/ +Shift-PageDown, or using the scrollbars of a virtual terminal in X or +the cmd window in Windows. The output can be piped to 'more' or 'less', +e.g. 'rotctld -l | more'. .TP .B \-u, --dump-caps Dump capabilities for the radio defined with -m above and exit.