From 74ec912343a55bfda7099a819836e4c4913a2d52 Mon Sep 17 00:00:00 2001 From: crouzet Date: Thu, 30 Nov 2017 16:30:25 +0100 Subject: [PATCH] update of config doc --- doc/src/commands/config.rst | 44 +++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 16 deletions(-) diff --git a/doc/src/commands/config.rst b/doc/src/commands/config.rst index c1f26e5..30db82a 100644 --- a/doc/src/commands/config.rst +++ b/doc/src/commands/config.rst @@ -4,40 +4,52 @@ config Description =========== -The **config** manages sat configuration. +The **config** command manages sat configuration. It allows display, manipulation and operation on configuration files Usage ===== -* List available products: :: +* Edit the user personal configuration file (~/.salomeTools/SAT.pyconf). It is used to store the user personal choices, like the favorite editor, browser, pdf viewer: :: + + sat config --edit + +* List the available applications (they come from the sat projects defined in data/local.pyconf): :: sat config --list -* Copy a product into the user personal directory: :: - - sat config --copy [new_name] +* Edit the configuration of an application: :: -* Edit the user configuration file: :: + sat config --edit - sat config --edit +* Copy an application configuration file into the user personal directory: :: + + sat config --copy [new_name] + +* Print the value of a configuration parameter. Use the automatic completion to get recursively the parameter names. Use -n option to get only the value, not the lable (useful in automatic scripts). Examples: :: -* Edit a product: :: + sat config --value + sat config --value LOCAL + sat config --value LOCAL.workdir - sat config --edit + sat config --value + sat config SALOME-8.4.0 --value APPLICATION.workdir + sat config SALOME-8.4.0 -n --value APPLICATION.workdir -* Get the value of a parameter: :: +* Print the patches that are applied: :: - sat config --value - sat config --value TOOLS.prepare.cvs_server + sat config SALOME-8.4.0 --show_patchs - sat config --value - sat config SALOME_7_7_1 --value PRODUCT.out_dir +* Get information on a product configuration: :: + sat config --info + sat config SALOME-8.4.0 --info KERNEL + sat config SALOME-8.4.0 --info qt Configuration ============= -* SITE.config +* PATH. - * **configPath**: list of directories where to find products files. + * **ARCHIVEPATH** list of directories where to find application files. + * **PRODUCTPATH** list of directories where to find products configuration files. * USER -- 2.39.2