Commit graph

12 commits

Author SHA1 Message Date
Jon Szymaniak
26268323da host/utilities: Copyright date updated 2015-02-25 14:56:14 -05:00
Ryan Tucker
e9570df455 bladeRF-cli: remove bladeRF-flash mention from man page 2014-07-26 12:16:37 -04:00
Jon Szymaniak
0e5fc8fca2 host: Removed bladeRF-flash
A majority of functionality presented by bladeRF-flash is now duplicated
in the bladeRF-cli utility.

Now that the bladeRF USB interfaces have stabilized more and the
instructions for bootloader-based recovery are available, this program
is generally no longer needed. As such, it is being removed to avoid
future neglect and bitrot.
2014-07-22 00:20:52 -04:00
Ryan Tucker
39afa2f07b Markdown-ify the bladeRF-cli interactive help
Adds a new include, doc/cmd_help.h.  This is generated by
pandoc from doc/interactive-help.md.  It's ugly, but that's
why it's programatically generated.

CMake will either generate a new cmd_help.{h,man} or copy them
in from cmd_help.{h,man}.in if pandoc isn't available.

Update cmd.c to use all of these new #defines.  (It looks
cleaner now...!)

Remove the old get-interactive-commands.bash, which is no longer
a part of the build process.  pandoc also generates a man page
snippet for insertion by help2man.

Also some editorial/spelling clarifications/corrections, and
adjustments for formatting.
2014-07-06 17:04:47 -04:00
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
Ryan Tucker
2ba30c627a bladeRF-cli, doc: Use --help-interactive to get cmds from bladeRF-cli
When building the man page, use the --help-interactive option to
bladeRF-cli to get the list of interactive commands.
2014-05-12 21:59:58 -04:00
Ryan Tucker
8957eda839 Use help2man to generate man pages (fixes #165)
A little more lightweight than the doxygen approach,
and keeps the documentation harmonized with --help.

h/t to A. Maitland Bottoms for pointing me to this.
2013-11-16 16:25:58 -05:00
Jon Szymaniak
12a4313cc1 bladeRF-cli: Improved script support, quoted param support, misc. cleanup
Scripts can be invoked from within other scripts, using the "run"
command. An error is reported if a recursive loop is detected.

An "echo" command has been added for debug purposes.

Parameters may now be surrounded in double quotes to include spaces.

Removed extraneous error messages from main(); The preceding functions
print error messages if needed.

Removed error-out if no device is attached. This allows scripts to be
run if the device is not attached. Commands already verify that a device
is attached, if required.
2013-11-11 22:14:53 -05:00
Jon Szymaniak
f0737ec83e utilities: Removed invalid path from Doxygen configuration
This addresses the warning item from the man page build.
2013-10-22 22:24:26 -04:00
Jon Szymaniak
8c057b61fa libbladeRF, utils: Moving ezusb code out of lib into utils
With future license-related cleanup, all GPLv2 programs will live
in the utilities directory. As such, ezusb.c has been moved out
of the library, and the bladeRF-cli utility has been modified to
use this directly.
2013-10-21 21:05:17 -04:00
Ryan Tucker
223adda59c Generate manpages for bladeRF-* with doxygen
It still requires manual canoodling, but the canoodling is with
markdown instead of nroff.
2013-10-06 20:17:26 -04:00
Ryan Tucker
6f33d9264b Add doxygen markdown files to generate man pages 2013-10-06 20:17:15 -04:00