Notice: In order to edit this ticket you need to be either: a Product Owner, The owner or the reporter of the ticket, or, in case of a Task not yet assigned, a team_member"

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

Following issues spotted during proof-reading:

  • admin reindex - "Command-line tool for re-index the database" -> should be "re-indexing". Also LIMITATION bit after examples - "You will need to all passwordless login to PostgreSQL" -> this should be "call"?
  • cecog - "Provides actions for prepairing data and otherwise integrating with Cecog" - assume this should be "preparing"?
  • cecog merge - "Therefore need EMAN2 or PIL installed locally" -> should be "Therefore it needs…" or similar
  • chgrp obj - "Objects to be processedd in the form" -> "processed"
  • omero config - Should this be talking about 4.2 configuration files?
  • export - "If --iterate is used used, the only…" -> remove extra "used"
  • import - "If they interfere with any of the Python arguments, you may need to end precede your arguments with…" -> doesn't make sense, end or precede?
  • load - "This can be used as the #! header of a file to make standand-alone script" -> "stand-alone"
  • shell - "All arguments not understood vi bin/omero shell will be passed to the shell" -> "vi"? Not sure what this is in aid of, intended to be "via"? But still not sure that makes sense.

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.

1.3.13-PRO © 2008-2011 Agilo Software all rights reserved (this page was served in: 0.96593 sec.)

We're Hiring!