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

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