search

GsDevKit / GsDevKit_home

master GsDevKit project
http://gsdevkit.github.io/GsDevKit_home
MIT License
31 stars 36 forks source link

$GS_HOME/bin/startNetldi help not clear enough for custom netldi args: #301

Open dalehenrich opened 3 years ago

dalehenrich commented 3 years ago

This is the current help text:

=================
   GsDevKit script: startNetldi -h
              path: /home/dhenrich/rogue/_homes/rogue/_home/bin/startNetldi
=================
USAGE: startNetldi [-h] <stone-name> [<startnetldi-commandLine-args>]

Start the netldi process for the given stone.

By default the netldi is started using the following commandline:

  startnetldi -l  -g -a dhenrich <netldi-name>

If a port number is specified in the session description then the following command line is used:

  startnetldi -l  -g -a dhenrich -P <port-number> <netldi-name>

If you specify any <startnetldi-commandLine-args>, then the <startnetldi-commandLine-args> are passed
to the startnetldi command and none of the above defaults apply (except for the -l option):

  startnetldi -l  <startnetldi-commandLine-args>

OPTIONS
  -h display help

EXAMPLES
  startNetldi -h
  startNetldi gs_326
  startNetldi gs_326 -g <netldi-name> -A ::1a

While there is a bit of coverage of custom options for the command, it does not make the fact that the netldi name should be included ...