Blame Automation/Manuals/tcar_getConfigValue.sh.asciidoc

Alain Reguera Delgado 8ea9a9
tcar_getConfigValue.sh(1)
Alain Reguera Delgado 8ea9a9
=========================
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
== Name
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
tcar_getConfigValue - Standardize options retrieval from configuration
Alain Reguera Delgado 8ea9a9
files.
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
== Synopsis
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
*tcar_getConfigValue FILE SECTION OPTION*
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
== Description
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
The *tcar_getConfigValue* function standardizes the way option values
Alain Reguera Delgado 8ea9a9
are retrieved from configuration files. As convention,
Alain Reguera Delgado 8ea9a9
*tcar_getConfigValue* uses the output produced by
Alain Reguera Delgado 8ea9a9
*tcar_getConfigLines* as input to retrieve the option values. As
Alain Reguera Delgado 8ea9a9
convention, in +option = "value"+ lines, the values retrieved are
Alain Reguera Delgado 8ea9a9
always on the right side. The values retrieved are also output without
Alain Reguera Delgado 8ea9a9
quotation and translation markers already expanded.
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
The *tcar_getConfigValue* function accepts the
Alain Reguera Delgado 8ea9a9
following arguments:
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
FILE::
Alain Reguera Delgado 8ea9a9
    This argument specifies the absolute path to the configuration
Alain Reguera Delgado 8ea9a9
    file you want to retrieve the value from. For example,
Alain Reguera Delgado 8ea9a9
    ``+${TCAR_WORKDIR}/Identity/Models/Themes/Default/Distro/5/Anaconda/branding.conf+''.
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
SECTION::
Alain Reguera Delgado 8ea9a9
    This argument specifies the name of the section related to the
Alain Reguera Delgado 8ea9a9
    configuration line you want to retrieve the value from. For
Alain Reguera Delgado 8ea9a9
    example, ``symbols'' without brackets.
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
OPTION::
Alain Reguera Delgado 8ea9a9
    This argument specifies the name of the option you want to
Alain Reguera Delgado 8ea9a9
    retrieve the value from.
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
Use the *tcar_getConfigValue* function whenever you want to retrieve
Alain Reguera Delgado 8ea9a9
values from configuration files in a controlled way.
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
== Bugs
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
See https://centos.org.cu/bugs/
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
== Authors
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
The *tcar_checkFiles* function has received contributions from the
Alain Reguera Delgado 8ea9a9
following people:
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
- Alain Reguera Delgado <al@centos.org.cu>, =COPYRIGHT_YEAR_LIST=
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
== License
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
Copyright (C) =COPYRIGHT_YEAR_LIST= =COPYRIGHT_HOLDER=
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
This program is free software; you can redistribute it and/or modify
Alain Reguera Delgado 8ea9a9
it under the terms of the GNU General Public License as published by
Alain Reguera Delgado 8ea9a9
the Free Software Foundation; either version 2 of the License, or (at
Alain Reguera Delgado 8ea9a9
your option) any later version.
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
This program is distributed in the hope that it will be useful, but
Alain Reguera Delgado 8ea9a9
WITHOUT ANY WARRANTY; without even the implied warranty of
Alain Reguera Delgado 8ea9a9
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Alain Reguera Delgado 8ea9a9
General Public License for more details.
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
You should have received a copy of the GNU General Public License
Alain Reguera Delgado 8ea9a9
along with this program; if not, write to the Free Software
Alain Reguera Delgado 8ea9a9
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Alain Reguera Delgado 8ea9a9
Alain Reguera Delgado 8ea9a9
// vim: set syntax=asciidoc: