doc/src/usage_of_sat.rst

   1 ********************
   2 Usage of SAlomeTools
   3 ********************
   4
   5 Usage
   6 =====
   7 sat usage is a Command Line Interface (CLI).
   8
   9 .. code-block:: bash
  10
  11   sat [generic_options] [command] [product] [command_options]
  12
  13 Options of sat
  14 --------------
  15
  16 Useful *not exhaustive* generic options of *sat* CLI.
  17
  18 *--help or -h*
  19 ...............
  20
  21 Get help as simple text.
  22
  23 .. code-block:: bash
  24
  25     sat --help          # get the list of existing commands
  26     sat --help compile  # get the help on a specific command 'compile'
  27
  28
  29 *--debug or -g*
  30 ................
  31
  32 Execution in debug mode allows to see more trace and *stack* if an exception is raised.
  33
  34 *--verbose or -v*
  35 ..................
  36
  37 Change verbosity level (default is 3).
  38
  39 .. code-block:: bash
  40
  41     # for product 'SALOME_xx' for example
  42     # execute compile command in debug mode with trace level 4
  43     sat -g -v 4 compile SALOME_xx
  44
  45
  46 Build a SALOME product
  47 ======================
  48
  49 Get the list of available products
  50 ----------------------------------
  51
  52 To get the list of the current available products in your context:
  53
  54 .. code-block:: bash
  55
  56     sat config --list
  57
  58 Prepare sources of a product
  59 ----------------------------
  60
  61 To prepare (get) *all* the sources of a product (*SALOME_xx* for example):
  62
  63 .. code-block:: bash
  64
  65     sat prepare SALOME_xx
  66
  67 | The sources are usually copied in directories
  68 | *$USER.workDir + SALOME_xx... + SOURCES + $PRODUCT.name*
  69
  70
  71 Compile SALOME
  72 ----------------
  73
  74 To compile products:
  75
  76 .. code-block:: bash
  77
  78     # compile all prerequisites/products
  79     sat compile SALOME_xx
  80
  81     # compile only 2 products (KERNEL and SAMPLES), if not done yet
  82     sat compile SALOME_xx --products KERNEL,SAMPLES
  83
  84     # compile only 2 products, unconditionaly
  85     sat compile SALOME_xx ---products SAMPLES --clean_all
  86
  87
  88 | The products are usually build in the directories
  89 | *$USER.workDir + SALOME_xx... + BUILD + $PRODUCT.name*
  90 |
  91 | The products are usually installed in the directories
  92 | *$USER.workDir + SALOME_xx... + INSTALL + $PRODUCT.name*
  93
  94