bladeRF/host/utilities/doc/include_man/bladeRF-cli.h2m
Ryan Tucker aebee6e374 bladeRF-cli: Reformatted help text
Because of how man pages format things, it's easiest (maybe) to
use tabs and whatnot to designate indentation, etc, in the help
output.

This unfortunately makes some of the help output look relatively
crappy, but at least it is more consistent!  :-)

Additional fixes/tweaks will ensue.
2014-05-12 22:00:39 -04:00

34 lines
954 B
Text

[NAME]
bladeRF-cli - command line interface and test utility
[DESCRIPTION]
The \fBbladeRF-cli\fP utility is used to flash firmware files, load FPGA
bitstreams, and perform other tasks on the nuand bladeRF
software-defined radio system\&.
[EXAMPLES]
.PP
$ bladeRF-cli -l hostedx40.rbf
.IP
Loads an FPGA image named hostedx40.rbf onto the bladeRF's FPGA.
\fBNote\fP: The FPGA image loaded with --load-fpga will be lost on power-off.
.PP
$ bladeRF-cli -f firmware.img
.IP
Flashes firmware.img onto the bladeRF's firmware.
.PP
$ bladeRF-cli -L hostedx40.rbf
.IP
Flashes the FPGA image named hostedx40.rbf onto the bladeRF, where it will
be automatically loaded on power-up.
[INTERACTIVE COMMANDS]
bladeRF-cli supports a scriptable interactive mode. Run \fBbladeRF-cli --interactive\fP
to enter this mode. Type "\fBhelp\fP" for a listing of all commands, or
"\fBhelp <command>\fP" for more information about <command>.
[SEE ALSO]
bladeRF-flash(1)\&.