2 .. include:: ../../rst_prolog.rst
9 The **package** command creates a SALOME_ archive (usually a compressed Tar_ file .tgz).
10 This tar file is used later to intall SALOME on other remote computer.
12 Depending on the selected options, the archive includes sources and binaries
13 of SALOME products and prerequisites.
15 Usually utility *salomeTools* is included in the archive.
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.
24 * Create a package for a product (example as *SALOME_xx*): ::
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.
33 * Create a package with a specific name: ::
35 sat package SALOME_xx --name YourSpecificName
38 By default, the archive is created in the working directory of the user (``USER.workDir``).
40 If the option *--name* is used with a path (relative or absolute) it will be used.
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``).
48 # Creates SALOME_xx.tgz in $USER.workDir
51 # Creates SALOME_xx_<arch>.tgz in $USER.workDir
52 sat package SALOME_xx --binaries
54 # Creates MySpecificName.tgz in $USER.workDir
55 sat package SALOME_xx --name MySpecificName
58 * Force the creation of the archive (if it already exists): ::
60 sat package SALOME_xx --force
63 * Include the binaries in the archive (products and prerequisites): ::
65 sat package SALOME_xx --binaries
67 This command will create an archive named ``SALOME_xx _<arch>.tgz``
68 where <arch> is the OS_ architecture of the machine.
71 * Do not delete Version Control System (VCS_) informations from the configurations files of the embedded salomeTools: ::
73 sat package SALOME_xx --with_vcs
75 The version control systems known by this option are CVS_, SVN_ and Git_.
78 Some useful configuration pathes
79 =================================
81 No specific configuration.