CoreFlows/gui/doc/usage.rst

   1
   2 .. include:: ./rst_prolog.rst
   3
   4
   5 .. _iraUsage:
   6
   7 **********************
   8 Usage of solverlabGUI
   9 **********************
  10
  11 Usage
  12 =====
  13
  14 SolverlabGUI usage is a Command Line Interface (CLI_), which is
  15 Windows *and* Linux compatible (but only tested on Linus for the moment).
  16
  17 .. code-block:: bash
  18
  19   solverlabGUI --[options]
  20
  21
  22 Options of solverlabGUI
  23 ............................
  24
  25 Useful but *not exhaustive* generic options of *solverlabGUI* CLI.
  26
  27
  28 Option *--help or -h*
  29 ............................
  30
  31 Get help as simple text.
  32
  33 .. code-block:: bash
  34
  35     solverlabGUI --help          # get list of existing options
  36
  37
  38 Option *--doc or -d*
  39 ............................
  40
  41 Get documentation as browser html.
  42
  43 .. code-block:: bash
  44
  45     solverlabGUI --doc           # see html doc
  46
  47
  48 Option *--verbose or -v*
  49 ............................
  50
  51 Change verbosity level (default is 'info').
  52
  53 .. code-block:: bash
  54
  55     # execute solverlabGUI command in verbose debug mode
  56     solverlabGUI -v debug
  57
  58
  59 Option *--workdir or -w*
  60 ............................
  61
  62 Change working directory (user data directory). Default is
  63 ../SOLVERLABGUI_WORKDIR
  64
  65 .. code-block:: bash
  66
  67     # execute solverlabGUI in user choice working directory
  68     solverlabGUI -w .../MY_WORKDIR
  69
  70
  71