bladeRF-cli: Fixed errors and inconsistencies in interactive help text

This commit is contained in:
Jon Szymaniak 2015-07-15 22:26:23 -04:00
commit ab441d15cb
3 changed files with 44 additions and 36 deletions

View file

@ -5,7 +5,7 @@
*
* This file is part of the bladeRF project
*
* Copyright (C) 2014 Nuand LLC
* Copyright (C) 2014-2015 Nuand LLC
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@ -27,7 +27,7 @@
* Any manual modifications to this file will be overwritten!
* To edit the content of help strings, please edit interactive-help.md
*
* Last generated: Thu Dec 18 17:47:58 EST 2014 by jynik
* Last generated: Wed Jul 15 22:24:41 EDT 2015 by jynik
*/
#ifndef BLADERF_CLI_DOC_CMD_HELP_H__
@ -283,34 +283,36 @@
"\n" \
"- 100\n" \
"\n" \
" XB-100 GPIO expansion board.\n" \
" XB-100 GPIO expansion board\n" \
"\n" \
"- 200\n" \
"\n" \
" XB-200 LF/MF/HF/VHF transverter expansion board\n" \
"\n" \
"Valid subcommands:\n" \
"Common subcommands:\n" \
"\n" \
"- enable <board_model>\n" \
"- enable\n" \
"\n" \
" Enable the XB-100 or XB-200 expansion board.\n" \
"\n" \
"- filter 200 [rx|tx] [50|144|222|custom|auto_1db|auto_3db]\n" \
"XB-200 subcommands:\n" \
"\n" \
"- filter [rx|tx] [50|144|222|custom|auto_1db|auto_3db]\n" \
"\n" \
" Selects the specified RX or TX filter on the XB-200 board. Below\n" \
" are descriptions of each of the filter options.\n" \
"\n" \
" - 50\n" \
"\n" \
" Selects the 50-54 MHz (6 meter band) filter\n" \
" Select the 50-54 MHz (6 meter band) filter.\n" \
"\n" \
" - 144\n" \
"\n" \
" Selects the 144-148 MHz (2 meter band) filter\n" \
" Select the 144-148 MHz (2 meter band) filter.\n" \
"\n" \
" - 222\n" \
"\n" \
" Selects 222-225 MHz (1.25 meter band) filter. Realistically,\n" \
" Select the 222-225 MHz (1.25 meter band) filter. Realistically,\n" \
" this filter option is actually slightly wider, covering\n" \
" 206 MHz - 235 MHz.\n" \
"\n" \
@ -336,14 +338,14 @@
"\n" \
"Examples:\n" \
"\n" \
"- xb 100 enable\n" \
"- xb 200 enable\n" \
"\n" \
" Enables the XB-100 GPIO expansion board.\n" \
" Enables and configures the XB-200 transverter expansion board.\n" \
"\n" \
"- xb 200 filter rx 144\n" \
"\n" \
" Selects the 144-148 MHz receive filter on the XB-200 expansion\n" \
" board.\n" \
" Selects the 144-148 MHz receive filter on the XB-200 transverter\n" \
" expansion board.\n" \
"\n" \
@ -687,7 +689,7 @@
"\n" \
" sampling External or internal sampling mode\n" \
"\n" \
" samplerate Samplerate settings\n" \
" samplerate Sample rate settings\n" \
"\n" \
" trimdac VCTCXO Trim DAC settings\n" \
" -----------------------------------------------------------------------\n" \

View file

@ -329,7 +329,7 @@ Valid values for \f[C]board_model\f[]:
\f[C]100\f[]
.RS 2
.PP
XB\-100 GPIO expansion board.
XB\-100 GPIO expansion board
.RE
.IP \[bu] 2
\f[C]200\f[]
@ -338,15 +338,17 @@ XB\-100 GPIO expansion board.
XB\-200 LF/MF/HF/VHF transverter expansion board
.RE
.PP
Valid subcommands:
Common subcommands:
.IP \[bu] 2
\f[C]enable\ <board_model>\f[]
\f[C]enable\f[]
.RS 2
.PP
Enable the XB\-100 or XB\-200 expansion board.
.RE
.PP
XB\-200 subcommands:
.IP \[bu] 2
\f[C]filter\ 200\ [rx|tx]\ [50|144|222|custom|auto_1db|auto_3db]\f[]
\f[C]filter\ [rx|tx]\ [50|144|222|custom|auto_1db|auto_3db]\f[]
.RS 2
.PP
Selects the specified RX or TX filter on the XB\-200 board.
@ -357,7 +359,7 @@ Below are descriptions of each of the filter options.
.IP
.nf
\f[C]
Selects\ the\ 50\-54\ MHz\ (6\ meter\ band)\ filter
Select\ the\ 50\-54\ MHz\ (6\ meter\ band)\ filter.
\f[]
.fi
.RE
@ -367,7 +369,7 @@ Selects\ the\ 50\-54\ MHz\ (6\ meter\ band)\ filter
.IP
.nf
\f[C]
Selects\ the\ 144\-148\ MHz\ (2\ meter\ band)\ filter
Select\ the\ 144\-148\ MHz\ (2\ meter\ band)\ filter.
\f[]
.fi
.RE
@ -377,7 +379,7 @@ Selects\ the\ 144\-148\ MHz\ (2\ meter\ band)\ filter
.IP
.nf
\f[C]
Selects\ 222\-225\ MHz\ (1.25\ meter\ band)\ filter.\ Realistically,
Select\ the\ 222\-225\ MHz\ (1.25\ meter\ band)\ filter.\ Realistically,
this\ filter\ option\ is\ actually\ slightly\ wider,\ covering
206\ MHz\ \-\ 235\ MHz.
\f[]
@ -425,16 +427,17 @@ that\ are\ not\ associated\ with\ the\ on\-board\ filters.
.PP
Examples:
.IP \[bu] 2
\f[C]xb\ 100\ enable\f[]
\f[C]xb\ 200\ enable\f[]
.RS 2
.PP
Enables the XB\-100 GPIO expansion board.
Enables and configures the XB\-200 transverter expansion board.
.RE
.IP \[bu] 2
\f[C]xb\ 200\ filter\ rx\ 144\f[]
.RS 2
.PP
Selects the 144\-148 MHz receive filter on the XB\-200 expansion board.
Selects the 144\-148 MHz receive filter on the XB\-200 transverter
expansion board.
.RE
.SS mimo
.PP
@ -1021,7 +1024,7 @@ T}
T{
\f[C]samplerate\f[]
T}@T{
Samplerate settings
Sample rate settings
T}
T{
\f[C]trimdac\f[]

View file

@ -264,34 +264,36 @@ Valid values for `board_model`:
- `100`
XB-100 GPIO expansion board.
XB-100 GPIO expansion board
- `200`
XB-200 LF/MF/HF/VHF transverter expansion board
Valid subcommands:
Common subcommands:
- `enable <board_model>`
- `enable`
Enable the XB-100 or XB-200 expansion board.
- `filter 200 [rx|tx] [50|144|222|custom|auto_1db|auto_3db]`
XB-200 subcommands:
- `filter [rx|tx] [50|144|222|custom|auto_1db|auto_3db]`
Selects the specified RX or TX filter on the XB-200 board. Below
are descriptions of each of the filter options.
* 50
Selects the 50-54 MHz (6 meter band) filter
Select the 50-54 MHz (6 meter band) filter.
* 144
Selects the 144-148 MHz (2 meter band) filter
Select the 144-148 MHz (2 meter band) filter.
* 222
Selects 222-225 MHz (1.25 meter band) filter. Realistically,
Select the 222-225 MHz (1.25 meter band) filter. Realistically,
this filter option is actually slightly wider, covering
206 MHz - 235 MHz.
@ -317,13 +319,14 @@ Valid subcommands:
Examples:
* `xb 100 enable`
* `xb 200 enable`
Enables the XB-100 GPIO expansion board.
Enables and configures the XB-200 transverter expansion board.
* `xb 200 filter rx 144`
Selects the 144-148 MHz receive filter on the XB-200 expansion board.
Selects the 144-148 MHz receive filter on the XB-200 transverter
expansion board.
mimo
@ -688,7 +691,7 @@ that particular command. The parameter is one of:
`sampling` External or internal sampling mode
`samplerate` Samplerate settings
`samplerate` Sample rate settings
`trimdac` VCTCXO Trim DAC settings
----------------------------------------------------------------------