Blame tcar-scripts-docs/Manpages/tcar_getConfigValue.sh.asciidoc

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