doc/src/commands/package.rst

   1
   2 .. include:: ../../rst_prolog.rst
   3
   4 Command package
   5 ****************
   6
   7 Description
   8 ============
   9 The **package** command creates a SALOME archive (usually a compressed Tar_ file .tgz).
  10 This tar file is used later to install SALOME on other remote computer.
  11
  12 Depending on the selected options, the archive includes sources and binaries
  13 of SALOME products and prerequisites.
  14
  15 Usually utility *sat* is included in the archive.
  16
  17 .. note::
  18   By default the package includes the sources of prerequisites and products.
  19   To select a subset, use the *--without_property* or *--with_vcs* options.
  20
  21
  22 Usage
  23 =====
  24 * Create a package for a product (example as *SALOME_xx*): ::
  25
  26     sat package SALOME_xx
  27
  28   This command will create an archive named ``SALOME_xx.tgz``
  29   in the working directory (``USER.workDir``).
  30   If the archive already exists, do nothing.
  31
  32
  33 * Create a package with a specific name: ::
  34
  35     sat package SALOME_xx --name YourSpecificName
  36
  37 .. note::
  38     By default, the archive is created in the working directory of the user (``USER.workDir``).
  39
  40     If the option *--name* is used with a path (relative or absolute) it will be used.
  41
  42     If the option *--name* is not used and binaries (prerequisites and products)
  43     are included in the package, the OS_ architecture
  44     will be appended to the name (example: ``SALOME_xx-CO7.tgz``).
  45
  46     Examples: ::
  47
  48         # Creates SALOME_xx.tgz in $USER.workDir
  49         sat package SALOME_xx
  50
  51         # Creates SALOME_xx_<arch>.tgz in $USER.workDir
  52         sat package SALOME_xx --binaries
  53
  54         # Creates MySpecificName.tgz in $USER.workDir
  55         sat package SALOME_xx --name MySpecificName
  56
  57
  58 * Force the creation of the archive (if it already exists): ::
  59
  60     sat package SALOME_xx --force
  61
  62
  63 * Include the binaries in the archive (products and prerequisites): ::
  64
  65     sat package SALOME_xx --binaries
  66
  67   This command will create an archive named ``SALOME_xx _<arch>.tgz``
  68   where <arch> is the OS architecture of the machine.
  69
  70
  71 * Do not delete Version Control System (VCS_) information from the configuration files of the embedded sat: ::
  72
  73     sat package SALOME_xx --with_vcs
  74
  75   The version control systems known by this option are CVS_, SVN_ and Git_.
  76
  77
  78 Some useful configuration paths
  79 =================================
  80
  81 No specific configuration.