Task #10851 (closed)
Opened 6 years ago
Closed 4 years ago
Generate a CLI manual
| Reported by: | jamoore | Owned by: | sbesson |
|---|---|---|---|
| Priority: | minor | Milestone: | 5.x |
| Component: | Documentation | Version: | 5.0.8 |
| Keywords: | n.a. | Cc: | cblackburn, hflynn, rleigh |
| Resources: | n.a. | Referenced By: | n.a. |
| References: | n.a. | Remaining Time: | n.a. |
| Sprint: | n.a. |
Description
The scripts provided by Roger for printing/parsing the CLI help texts should be moved to one of our repositories (ome.git/docs?) and included in the build:
#!/bin/bash
set -e
hlog="/tmp/help.txt"
clog="/tmp/commands.txt"
rm -f "$hlog" "$clog"
commands()
{
if bin/omero "$@" --help >/dev/null 2>/dev/null; then
bin/omero "$@" --help | sed -e '1,/subcommand>$/d' -e "s/^[[:space:]][[:space:]]*\([[:graph:]][[:graph:]]*\).*$/\1/"
fi
}
help()
{
if bin/omero "$@" --help >/dev/null 2>/dev/null; then
cat <<EOF >>"$hlog"
-------------------------------------------------------------------------------
[ omero $@ --help ]
-------------------------------------------------------------------------------
EOF
bin/omero $@ --help >> "$hlog"
fi
}
dump_commands()
{
local prefix=$1
shift
echo "Dumping 'bin/omero $@'"
help "$@"
if [ -n "$cmd" ]; then
Change History (2)
comment:1 Changed 6 years ago by hflynn
comment:2 Changed 4 years ago by sbesson
- Resolution set to fixed
- Status changed from new to closed
- Version set to 5.0.8
See https://github.com/openmicroscopy/openmicroscopy/pull/3520.
bin/omero help --all --recursive
should give an exhaustive help of the CLI.
Note: See
TracTickets for help on using
tickets.
You may also have a look at Agilo extensions to the ticket.
Following issues spotted during proof-reading: