From ffbf518ffff6a171f618bd377afb1bed167885fe Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Sep 11 2012 05:52:27 +0000 Subject: Update `trunk/Manuals/Tcar-ug/Scripts/Bash/environment.docbook' file. --- diff --git a/Manuals/Tcar-ug/Scripts/Bash/environment.docbook b/Manuals/Tcar-ug/Scripts/Bash/environment.docbook index 2d3cb09..45d81db 100644 --- a/Manuals/Tcar-ug/Scripts/Bash/environment.docbook +++ b/Manuals/Tcar-ug/Scripts/Bash/environment.docbook @@ -1,6 +1,6 @@ - Environment Variables + Execution Environment When you login in your computer you enter into a unique user @@ -10,54 +10,56 @@ see the bash(1) man page. This way different users can benefit from their own environment variables to customize the execution of centos-art.sh - script in a safe way. For example, users can use the variables - of their environments to set different locations for their - working copies of &TCAR;.See + script in a safe way. For example, users can use the + variables of their environments to set different locations for + their working copies of &TCAR;.See When you execute the centos-art.sh script, you create a new environment inside the user environment which - we call the centos-art.sh script - environment. This environment inherits all variables from the - user environment and contains the variables and - functionalities defined by the - centos-art.sh script. If your only interest - is using the centos-art.sh script to - accomplish tasks inside the working copy, you don't need to - know the whole environment of centos-art.sh - script but the user environment only. However, if your - interest is improving the centos-art.sh - script somehow, to know the centos-art.sh - script environment is a fundamental knowledge you need to have - in order to understand where to put the code you want to - contribute inside the script. + we call the script environment. This environment inherits all + variables from the user environment and contains the variables + and functionalities defined by the script itself. If your only + interest is using the centos-art.sh script + to accomplish tasks inside the working copy, you don't need to + know the whole environment it uses, but the user environment + only. However, if your interest is improving it somehow, to + know the environment where it is run is a fundamental + knowledge you need to be armed with in order to understand + where to put the code you want to contribute inside the + script. - The <command>centos-art.sh</command> script environment + The script environment - The centos-art.sh script environment + The script environment ---------------------------------------------------- +------------------------------------------------------- User environment -----|-------------------|-------------------------- -. |-- TCAR_WORKDIR |-- EDITOR . -. |-- LANG |-- HOME . -. `-- centos-art.sh `-- ... . -. ----|------------------------------------ . -. centos-art.sh environment . -. ----|-----------------|------------------ . -. . |-- CLI_NAME |-- render() . . -. . |-- CLI_BASEDIR | |-- svg() . . -. . |-- CLI_TEMPDIR | `-- docbook() . . -. . |-- CLI_VERSION |-- help() . . -. . `-- ... `-- ... . . -. ......................................... . -................................................... +----|-------------------|------------------------------ +. |-- TCAR_WORKDIR |-- EDITOR . +. |-- LANG |-- HOME . +. `-- centos-art.sh `-- ... . +. ----|---------------------------------------- . +. centos-art.sh script environment . +. ----|-----------------|---------------------- . +. . |-- CLI_NAME `-- init() . . +. . |-- CLI_VERSION |-- render() . . +. . |-- CLI_BASEDIR | |-- svg() . . +. . |-- CLI_FUNCDIR | `-- docbook() . . +. . |-- CLI_TEMPDIR |-- help() . . +. . `-- ... | |-- docbook() . . +. . | `-- texinfo() . . +. . |-- locale() . . +. . `-- ... . . +. ............................................. . +....................................................... @@ -66,22 +68,17 @@ User environment To study the environment of centos-art.sh - script consider the directory structure under trunk/Scripts/Bash/. In this - structure each directory under Functions creates a new function - environment inside the centos-art.sh script - environment. You can only execute one function by script - execution so it will only be one function environment inside - the centos-art.sh script environment every - time it is executed. In some cases, it is possible to find a + script, you need to consider the directory structure under + trunk/Scripts/Bash/. In + this structure each directory under Functions/ creates a new function + environment inside the script environment. You can only + execute one function environment at a time for each script + environment. In some cases, it is possible to find a sub-function environment which takes place inside the function - environment. This is the case of the + environment. Such is the case of the render functionality which produces both - images and docbook manuals. Likewise function environments to - centos-art.sh script environment, there can - only exist one sub-function environment inside the current - function environment. + images and DocBook manuals. @@ -185,7 +182,7 @@ User environment - The centos-art.sh script uses the + The centos-art.sh script use the LANG environment variable to determine what language to use for printing output messages from the script itself, as well as the portable objects locations that need to