Blame Automation/Manuals/centos-art.sh.asciidoc

Alain Reguera Delgado 0de111
centos-art.sh(1)
Alain Reguera Delgado 0de111
================
Alain Reguera Delgado 0de111
Alain Reguera Delgado 954d94
Name
Alain Reguera Delgado 0de111
----
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado daf412
centos-art.sh - The CentOS artwork repository automation tool.
Alain Reguera Delgado 0de111
Alain Reguera Delgado 954d94
Synopsis
Alain Reguera Delgado 0de111
--------
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 954d94
*centos-art.sh* [*--help*|*--version*]::
Alain Reguera Delgado daf412
    Print information about *centos-art.sh* script itself.
Alain Reguera Delgado 0de111
Alain Reguera Delgado 954d94
*centos-art.sh* *MODULE* [*--help|--version*]::
Alain Reguera Delgado daf412
    Print information about the specified module. See <<modules>>
Alain Reguera Delgado 2e0726
    below to see which modules *centos-art.sh* script supports.
Alain Reguera Delgado 954d94
Alain Reguera Delgado 954d94
Description
Alain Reguera Delgado 0de111
-----------
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 954d94
*centos-art.sh* exists to standardize frequent tasks inside the CentOS
Alain Reguera Delgado 2e0726
artwork repository. Inside *centos-art.sh* script, frequent tasks are
Alain Reguera Delgado 2e0726
organized inside modules.
Alain Reguera Delgado 2e0726
Alain Reguera Delgado 2e0726
When you execute the *centos-art.sh* script in a terminal, it requests
Alain Reguera Delgado 2e0726
you to enter the absolute path of CentOS artwork repository in your
Alain Reguera Delgado 2e0726
workstation. This information is required in order for *centos-art.sh*
Alain Reguera Delgado 2e0726
to know where the repository directory structure you want to work with
Alain Reguera Delgado 2e0726
is stored in.  Later, once *centos-art.sh* knows where your copy of
Alain Reguera Delgado 2e0726
CentOS artwork repository is stored in, it initializes configuration
Alain Reguera Delgado 2e0726
variables and global functions. At this point, it continues reading
Alain Reguera Delgado 2e0726
the command-line arguments to retrieve the module's name, process
Alain Reguera Delgado 2e0726
common options next to it, store module-specific options and initiates
Alain Reguera Delgado 2e0726
the module's environment by executing the module's initialization
Alain Reguera Delgado 2e0726
script, based on the module's name retrieved from the command-line.
Alain Reguera Delgado 954d94
Alain Reguera Delgado 2e37b0
[[modules]]
Alain Reguera Delgado 954d94
Modules
Alain Reguera Delgado 954d94
-------
Alain Reguera Delgado 2e0726
Alain Reguera Delgado 2e0726
The *centos-art.sh* script supports the following modules:
Alain Reguera Delgado 954d94
Alain Reguera Delgado 954d94
*prepare*::
Alain Reguera Delgado 2e0726
    Standardize configuration tasks needed by your working copy (e.g.,
Alain Reguera Delgado 2e0726
    verify whether required packages are installed or not in your
Alain Reguera Delgado 2e0726
    workstation, calls render module to produce images and manuals in
Alain Reguera Delgado 2e0726
    the correct order). This is the first task you should run in your
Alain Reguera Delgado 2e0726
    workstation, just after downloading a fresh working copy of CentOS
Alain Reguera Delgado 2e0726
    artwork repository.
Alain Reguera Delgado 954d94
Alain Reguera Delgado 954d94
*render*::
Alain Reguera Delgado 2e0726
    Standardize the way content is produced inside the repository.
Alain Reguera Delgado 2e0726
    This function relies on configuration files to do its work.
Alain Reguera Delgado 2e0726
    Whenever you need to produce images, documentation or localized
Alain Reguera Delgado 2e0726
    content this is the module you'll need to use.
Alain Reguera Delgado 954d94
Alain Reguera Delgado 954d94
*locale*::
Alain Reguera Delgado 2e0726
    Standardize the way translatable strings are retrieved from source
Alain Reguera Delgado 2e0726
    files and put into portable objects for you to edit.  Portable
Alain Reguera Delgado 2e0726
    objects produced by this module are used by *render* module to
Alain Reguera Delgado 2e0726
    produce localized content.  Whenever you need to produce the
Alain Reguera Delgado 2e0726
    intermediate files holding the translatable strings required to
Alain Reguera Delgado 2e0726
    produce localized content, use this module.
Alain Reguera Delgado 954d94
Alain Reguera Delgado 954d94
*tuneup*::
Alain Reguera Delgado 2e0726
    Standardize maintenance tasks frequently run inside the repository
Alain Reguera Delgado 2e0726
    (e.g., reset written by, copyright and license information inside
Alain Reguera Delgado 2e0726
    shell script's top-comments; transform probably malformed HTML
Alain Reguera Delgado 2e0726
    documents into valid documents, and remove unused tags inside SVG
Alain Reguera Delgado 2e0726
    documents.).
Alain Reguera Delgado 954d94
Alain Reguera Delgado 2e0726
[[options]]
Alain Reguera Delgado 954d94
Options
Alain Reguera Delgado 954d94
-------
Alain Reguera Delgado 954d94
Alain Reguera Delgado 2e0726
The *centos-art.sh* script supports the following options:
Alain Reguera Delgado 2e0726
Alain Reguera Delgado 954d94
*--help*::
Alain Reguera Delgado daf412
    Print script documentation.
Alain Reguera Delgado 954d94
Alain Reguera Delgado 954d94
*--version*::
Alain Reguera Delgado daf412
    Print script version.
Alain Reguera Delgado 954d94
Alain Reguera Delgado 2e0726
*--debug*::
Alain Reguera Delgado 2e0726
    Enable debugging messages.
Alain Reguera Delgado daf412
Alain Reguera Delgado 2e0726
*--quiet*::
Alain Reguera Delgado 2e0726
    Run the script quietly. Only error messages are printed out.
Alain Reguera Delgado 5824c8
Alain Reguera Delgado 2e0726
*--yes*::
Alain Reguera Delgado 2e0726
    Answer ``yes'' to all ``yes or no'' questions. This option is
Alain Reguera Delgado 2e0726
    useful when you run *centos-art.sh* with the *--quiet* option.
Alain Reguera Delgado 2e0726
Alain Reguera Delgado 2e0726
[[exit-status]]
Alain Reguera Delgado 2e0726
Exit Status
Alain Reguera Delgado 2e0726
-----------
Alain Reguera Delgado 2e0726
Alain Reguera Delgado 2e0726
* 0 -- Exit successfully without errors.
Alain Reguera Delgado 2e0726
* 1 -- Exit with errors.
Alain Reguera Delgado 2e0726
Alain Reguera Delgado 2e0726
[[bugs]]
Alain Reguera Delgado 2e0726
Bugs
Alain Reguera Delgado 2e0726
----
Alain Reguera Delgado daf412
Alain Reguera Delgado 2e0726
* https://centos.org.cu/bugs/[https://centos.org.cu/bugs/]
Alain Reguera Delgado 954d94
Alain Reguera Delgado 954d94
Author
Alain Reguera Delgado 954d94
------
Alain Reguera Delgado daf412
Alain Reguera Delgado daf412
The *centos-art.sh* script has received contribution from the
Alain Reguera Delgado daf412
following people:
Alain Reguera Delgado daf412
Alain Reguera Delgado 2e0726
* Alain Reguera Delgado <mailto:al@centos.org.cu[al@centos.org.cu]>, 2009-2013
Alain Reguera Delgado 954d94
Alain Reguera Delgado 954d94
Copyright
Alain Reguera Delgado 954d94
---------
Alain Reguera Delgado daf412
Alain Reguera Delgado 2e0726
Copyright (C) 2009-2013 The CentOS Artwork SIG
Alain Reguera Delgado 954d94
Alain Reguera Delgado 954d94
This program is free software; you can redistribute it and/or modify
Alain Reguera Delgado 954d94
it under the terms of the GNU General Public License as published by
Alain Reguera Delgado 954d94
the Free Software Foundation; either version 2 of the License, or (at
Alain Reguera Delgado 954d94
your option) any later version.
Alain Reguera Delgado 954d94
Alain Reguera Delgado 954d94
This program is distributed in the hope that it will be useful, but
Alain Reguera Delgado 954d94
WITHOUT ANY WARRANTY; without even the implied warranty of
Alain Reguera Delgado 954d94
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Alain Reguera Delgado 954d94
General Public License for more details.
Alain Reguera Delgado 954d94
Alain Reguera Delgado 954d94
You should have received a copy of the GNU General Public License
Alain Reguera Delgado 954d94
along with this program; if not, write to the Free Software
Alain Reguera Delgado 954d94
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Alain Reguera Delgado 954d94
Alain Reguera Delgado 954d94
// vim: set syntax=asciidoc: