diff --git a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/funref.docbook b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/funref.docbook index 72300f2..8aec14a 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/funref.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/funref.docbook @@ -533,6 +533,166 @@ cli_exportFunctions "Render/render" + cli_getConfigLines + FILE + SECTION + OPTION + + + + + The cli_getConfigLines function + standardizes the way configuration lines are retrieved from + configuration files. + + + + The cli_getConfigLines function accepts + the following arguments: + + + + + FILE + + + This argument specifies the absolute path to the configuration + file you want to retrieve configuration lines from. For + example, + ${TCAR_WORKDIR}/trunk/Identity/Models/Themes/Default/Distro/5/Anaconda/branding.conf. + + + + + + SECTION + + + This argument specifies the name of the section you want to + retrieve configuration lines from. For example, + symbols without brackets. + + + + + + OPTION + + + This argument specifies the name of the option related to the + configuration line you want to retrieve. For example, + anaconda_header.svgz. + + + + + + + In order for cli_getConfigLines to work + properly, the configuration files must have a section line + with the form [sectionname] which groups + several option = "value" lines. + Lines beginning with # are ignored and can + be used for comments. + + + + Configuration file used to produce Tcar-fs documentation manual + + Configuration used to produce Tcar-fs documentation manual + + + +[main] + +# Specify documentation backend used by documentation manual. +manual_format = "texinfo" + +# Specify title style used by sections inside the manual. +manual_section_style = "directory" + +# Specify the order used by sections inside the manual. +manual_section_order = "ordered" + +[templates] + +# Specify relation between template files and section definition files +# inside the manual. +Chapters/section-functions.texinfo = "^.+-functions-[[:alnum:]]+\.texinfo$" +Chapters/section.texinfo = "^.+\.texinfo$" + + + + + + + + The section names and option names used inside configuration + files can be anything. It depends on the use and + interpretation programmed inside + centos-art.sh script for specific purposes + which defines what kind of section and options must exist + inside a configuration file. For example, consider the + configuration files used by render + functionality. They follow the same structure used in + documentation configuration files but the meaning of their + sections and options change to fit the specific needs of + render functionality. + + + + Configuration file used to produced Anaconda images + + Configuration used to produced Anaconda images + + + +[types] + +anaconda_header.svgz = "Types/White/48/=\BRAND=-5.png:x48+20+20" +first.svgz = "Types/White/32/=\BRAND=-5.png:x32+30+219" +splash.svgz = "Types/White/48/=\BRAND=-5-msg.png:x48+30+138" + +[symbols] + +anaconda_header.svgz = "Symbols/48/=\BRAND=.png:x48+732+20" +first.svgz = "Symbols/48/=\BRAND=.png:x48+30+20" +splash.svgz = "Symbols/48/=\BRAND=.png:x48+30+20" + + + + + + + + Use the cli_getConfigLines function when + you need to retrieve option = "value" lines + from configuration files in a controlled way. + + + + See also: + + + + + + + + + cli_getConfigValue + + + + + ... + + + + + + + cli_synchronizeRepoChanges LOCATION