2 .. include:: ../rst_prolog.rst
10 sat usage is a Command Line Interface (CLI_).
14 sat [generic_options] [command] [product] [command_options]
19 Useful *not exhaustive* generic options of *sat* CLI.
24 Get help as simple text.
28 sat --help # get the list of existing commands
29 sat --help compile # get the help on a specific command 'compile'
35 Execution in debug mode allows to see more trace and *stack* if an exception is raised.
40 Change verbosity level (default is 3).
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
49 Build a SALOME product
50 ======================
52 Get the list of available products
53 ----------------------------------
55 To get the list of the current available products in your context:
61 Prepare sources of a product
62 ----------------------------
64 To prepare (get) *all* the sources of a product (*SALOME_xx* for example):
70 | The sources are usually copied in directories
71 | *$USER.workDir + SALOME_xx... + SOURCES + $PRODUCT.name*
81 # compile all prerequisites/products
84 # compile only 2 products (KERNEL and SAMPLES), if not done yet
85 sat compile SALOME_xx --products KERNEL,SAMPLES
87 # compile only 2 products, unconditionaly
88 sat compile SALOME_xx ---products SAMPLES --clean_all
91 | The products are usually build in the directories
92 | *$USER.workDir + SALOME_xx... + BUILD + $PRODUCT.name*
94 | The products are usually installed in the directories
95 | *$USER.workDir + SALOME_xx... + INSTALL + $PRODUCT.name*