doc/src/usage_of_sat.rst

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