Blame Manuals/centos-art.sh.asciidoc

Alain Reguera Delgado e54180
centos-art.sh(1)
Alain Reguera Delgado e54180
================
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
Name
Alain Reguera Delgado e54180
----
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
centos-art.sh - The CentOS artwork repository automation tool.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
Synopsis
Alain Reguera Delgado e54180
--------
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
*centos-art.sh* [*--help*|*--version*]::
Alain Reguera Delgado e54180
    Print information about *centos-art.sh* script itself.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
*centos-art.sh* *MODULE* [*--help|--version*]::
Alain Reguera Delgado e54180
    Print information about the specified module. See <<modules>>
Alain Reguera Delgado e54180
    below to see which modules *centos-art.sh* script supports.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
Description
Alain Reguera Delgado e54180
-----------
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
*centos-art.sh* exists to standardize frequent tasks inside the CentOS
Alain Reguera Delgado e54180
artwork repository. Inside *centos-art.sh* script, frequent tasks are
Alain Reguera Delgado e54180
organized inside modules.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
When you execute the *centos-art.sh* script in a terminal, it requests
Alain Reguera Delgado e54180
you to enter the absolute path of CentOS artwork repository in your
Alain Reguera Delgado e54180
workstation. This information is required in order for *centos-art.sh*
Alain Reguera Delgado e54180
to know where the repository directory structure you want to work with
Alain Reguera Delgado e54180
is stored in.  Later, once *centos-art.sh* knows where your copy of
Alain Reguera Delgado e54180
CentOS artwork repository is stored in, it initializes configuration
Alain Reguera Delgado e54180
variables and global functions. At this point, it continues reading
Alain Reguera Delgado e54180
the command-line arguments to retrieve the module's name, process
Alain Reguera Delgado e54180
common options next to it, store module-specific options and initiates
Alain Reguera Delgado e54180
the module's environment by executing the module's initialization
Alain Reguera Delgado e54180
script, based on the module's name retrieved from the command-line.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
[[modules]]
Alain Reguera Delgado e54180
Modules
Alain Reguera Delgado e54180
-------
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
The *centos-art.sh* script supports the following modules:
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
*prepare*::
Alain Reguera Delgado e54180
    Standardize configuration tasks needed by your working copy (e.g.,
Alain Reguera Delgado e54180
    verify whether required packages are installed or not in your
Alain Reguera Delgado e54180
    workstation, calls render module to produce images and manuals in
Alain Reguera Delgado e54180
    the correct order). This is the first task you should run in your
Alain Reguera Delgado e54180
    workstation, just after downloading a fresh working copy of CentOS
Alain Reguera Delgado e54180
    artwork repository.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
*render*::
Alain Reguera Delgado e54180
    Standardize the way content is produced inside the repository.
Alain Reguera Delgado e54180
    This function relies on configuration files to do its work.
Alain Reguera Delgado e54180
    Whenever you need to produce images, documentation or localized
Alain Reguera Delgado e54180
    content this is the module you'll need to use.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
*locale*::
Alain Reguera Delgado e54180
    Standardize the way translatable strings are retrieved from source
Alain Reguera Delgado e54180
    files and put into portable objects for you to edit.  Portable
Alain Reguera Delgado e54180
    objects produced by this module are used by *render* module to
Alain Reguera Delgado e54180
    produce localized content.  Whenever you need to produce the
Alain Reguera Delgado e54180
    intermediate files holding the translatable strings required to
Alain Reguera Delgado e54180
    produce localized content, use this module.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
*tuneup*::
Alain Reguera Delgado e54180
    Standardize maintenance tasks frequently run inside the repository
Alain Reguera Delgado e54180
    (e.g., reset written by, copyright and license information inside
Alain Reguera Delgado e54180
    shell script's top-comments; transform probably malformed HTML
Alain Reguera Delgado e54180
    documents into valid documents, and remove unused tags inside SVG
Alain Reguera Delgado e54180
    documents.).
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
[[options]]
Alain Reguera Delgado e54180
Options
Alain Reguera Delgado e54180
-------
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
The *centos-art.sh* script supports the following options:
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
*--help*::
Alain Reguera Delgado e54180
    Print script documentation.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
*--version*::
Alain Reguera Delgado e54180
    Print script version.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
*--debug*::
Alain Reguera Delgado e54180
    Run the script in debugging mode. This option is very useful if
Alain Reguera Delgado e54180
    you want to get a closer look to the way modules are opened and
Alain Reguera Delgado e54180
    closed inside *centos-art.sh* script.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
*--quiet*::
Alain Reguera Delgado e54180
    Run the script quietly. This option reduces the amount of
Alain Reguera Delgado e54180
    information the *centos-art.sh* script prints out when processing
Alain Reguera Delgado e54180
    source files.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
*--yes*::
Alain Reguera Delgado e54180
    Run the script in affirmative mode. This is answering ``yes'' to
Alain Reguera Delgado e54180
    all ``yes or no'' questions. This option is useful when you run
Alain Reguera Delgado e54180
    *centos-art.sh* with the *--quiet* option.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
[[exit-status]]
Alain Reguera Delgado e54180
Exit Status
Alain Reguera Delgado e54180
-----------
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
* 0 -- Exit successfully without errors.
Alain Reguera Delgado e54180
* 1 -- Exit with errors.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
[[bugs]]
Alain Reguera Delgado e54180
Bugs
Alain Reguera Delgado e54180
----
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
* https://centos.org.cu/bugs/[https://centos.org.cu/bugs/]
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
Author
Alain Reguera Delgado e54180
------
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
The *centos-art.sh* script has received contribution from the
Alain Reguera Delgado e54180
following people:
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
* Alain Reguera Delgado <mailto:al@centos.org.cu[al@centos.org.cu]>, 2009-2013
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
Copyright
Alain Reguera Delgado e54180
---------
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
Copyright (C) 2009-2013 The CentOS Artwork SIG
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: