Blame tcar-scripts-prepare-docs/Manpages/prepare.asciidoc

Alain Reguera Delgado 733076
prepare(1)
Alain Reguera Delgado 733076
==========
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
Name
Alain Reguera Delgado 733076
----
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
prepare - Prepare your workstation for using the repository.
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
Synopsis
Alain Reguera Delgado 733076
--------
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
*centos-art.sh prepare [OPTIONS]*
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
Description
Alain Reguera Delgado 733076
-----------
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
The first time you download the CentOS artwork repository into your
Alain Reguera Delgado 733076
workstation, you only find source files inside the repository. In
Alain Reguera Delgado 733076
order to produce each component of CentOS corporate visual identity,
Alain Reguera Delgado 733076
it is necessary that you first transform the source files (e.g.,
Alain Reguera Delgado 733076
+.svgz+, +.asciidoc+, +.po+) into final files (e.g., +.png+, +.html+,
Alain Reguera Delgado 733076
+.mo+).  This process is known as _preparing your workstation to use
Alain Reguera Delgado 733076
the repository_ and is standardized through the *prepare* module. This
Alain Reguera Delgado 733076
way, the *prepare* module is the first command you execute after
Alain Reguera Delgado 733076
downloading a fresh copy of CentOS artwork repository.
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
When you execute the *prepare* module without any option, it first
Alain Reguera Delgado 733076
checks existence of required packages (see --packages), then updates
Alain Reguera Delgado 733076
the locale information required by *centos-art.sh* script to show
Alain Reguera Delgado 733076
messages in your current locale, later renders documentation (see
Alain Reguera Delgado 733076
--documents) and images (see --images) using source files available
Alain Reguera Delgado 733076
inside the repository. Finally, it updates the link relation that
Alain Reguera Delgado 733076
connects content inside the repository and the applications outside it
Alain Reguera Delgado 733076
(see --links).
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
When you execute the *prepare* module with options, the order in which
Alain Reguera Delgado 733076
preparation actions take place is set by the order in which you passed
Alain Reguera Delgado 733076
the options.  See <<options>>, for more information about available
Alain Reguera Delgado 733076
options and what they do.
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
Once the *prepare* module completes its execution, both your
Alain Reguera Delgado 733076
workstation and your copy of CentOS artwork repository will be ready
Alain Reguera Delgado 733076
for production.
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
[[options]]
Alain Reguera Delgado 733076
Options
Alain Reguera Delgado 733076
-------
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
The *prepare* module accepts the following options:
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
*--help*::
Alain Reguera Delgado 733076
    Print module's documentation.
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
*--version*::
Alain Reguera Delgado 733076
    Print module's version.
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
*--packages*::
Alain Reguera Delgado 733076
    This option verifies whether you have installed the required
Alain Reguera Delgado 733076
    packages in your workstation or not. If they are not installed an
Alain Reguera Delgado 733076
    error will be printed telling you what the missing package is, so
Alain Reguera Delgado 733076
    you can install it. It is important that all the required packages
Alain Reguera Delgado 733076
    be installed for *centos-art.sh* script modules to work as
Alain Reguera Delgado 733076
    expected.
Alain Reguera Delgado 733076
+
Alain Reguera Delgado 733076
[NOTE]
Alain Reguera Delgado 733076
======================================================================
Alain Reguera Delgado 733076
When you are verifying packages, be aware that it is required that you
Alain Reguera Delgado 733076
have installed EPEL repository. The EPEL configuration package
Alain Reguera Delgado 733076
(*epel-release*) isn't part of CentOS distribution and you need to
Alain Reguera Delgado 733076
download it and install it manually. The *epel-release* package can be
Alain Reguera Delgado 733076
found in either of the locations (based on your system version):
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
 * For CentOS-5: http://download.fedoraproject.org/pub/epel/5/i386/[http://download.fedoraproject.org/pub/epel/5/i386/]
Alain Reguera Delgado 733076
 * For CentOS-6: http://download.fedoraproject.org/pub/epel/6/i386/[http://download.fedoraproject.org/pub/epel/6/i386/]
Alain Reguera Delgado 733076
======================================================================
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
*--locales*::
Alain Reguera Delgado 733076
    This option looks for all translatable strings inside the
Alain Reguera Delgado 733076
    *centos-art.sh* script, updates the related POT and PO files and
Alain Reguera Delgado 733076
    produces the related MO file using the specific locale environment
Alain Reguera Delgado 733076
    information the script was run in. If the PO file already have
Alain Reguera Delgado 733076
    translations, they are preserved and used to build the MO file.
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
*--links*::
Alain Reguera Delgado 733076
    This updates the link information that connects the information
Alain Reguera Delgado 733076
    inside the repository with the information outside the repository.
Alain Reguera Delgado 733076
    For example, inside the repository we have the font information
Alain Reguera Delgado 733076
    required to build messages in specific typography, such
Alain Reguera Delgado 733076
    information isn't by default in the default system locations so we
Alain Reguera Delgado 733076
    install them in the home directory of the user running the
Alain Reguera Delgado 733076
    *prepare* module, using symbolic links.
Alain Reguera Delgado 733076
+
Alain Reguera Delgado 733076
Whenever you need to update this information, use this option. Take
Alain Reguera Delgado 733076
care that all links previously created in the target location will be
Alain Reguera Delgado 733076
removed and recreated again. So, you can change the name relation in
Alain Reguera Delgado 733076
the configuration files and install the changes without leaving broken
Alain Reguera Delgado 733076
links in the target location.
Alain Reguera Delgado 733076
+
Alain Reguera Delgado 733076
The file that controls the link configuration is inside the repository
Alain Reguera Delgado 733076
at +Automation/Modules/Prepare/Modules/Links/Configs/render.conf+.
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
*--images*::
Alain Reguera Delgado 733076
    This option produces images from source files available inside the
Alain Reguera Delgado 733076
    repository, using the correct order. When you use this option,
Alain Reguera Delgado 733076
    centos-art.sh script calls the render module internally which
Alain Reguera Delgado 733076
    produces content for all configuration (+render.conf+) files found
Alain Reguera Delgado 733076
    inside the repository.
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
*--documents*::
Alain Reguera Delgado 733076
    This options produces documentation from source files available
Alain Reguera Delgado 733076
    inside the repository. When you pass this option, the current
Alain Reguera Delgado 733076
    locale information is considered to produce the documentation. If
Alain Reguera Delgado 733076
    the current locale doesn't have translation files set for the
Alain Reguera Delgado 733076
    current locale information, English language is used as default
Alain Reguera Delgado 733076
    language.
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
Author
Alain Reguera Delgado 733076
------
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
The *prepare* module has received contributions from the following
Alain Reguera Delgado 733076
people:
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
 * Alain Reguera Delgado <mailto:al@centos.org.cu[al@centos.org.cu]>, 2009-2013
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
Copyright
Alain Reguera Delgado 733076
---------
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
Copyright (C) 2009-2013 The CentOS Project
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
This program is free software; you can redistribute it and/or modify
Alain Reguera Delgado 733076
it under the terms of the GNU General Public License as published by
Alain Reguera Delgado 733076
the Free Software Foundation; either version 2 of the License, or (at
Alain Reguera Delgado 733076
your option) any later version.
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
This program is distributed in the hope that it will be useful, but
Alain Reguera Delgado 733076
WITHOUT ANY WARRANTY; without even the implied warranty of
Alain Reguera Delgado 733076
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Alain Reguera Delgado 733076
General Public License for more details.
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
You should have received a copy of the GNU General Public License
Alain Reguera Delgado 733076
along with this program; if not, write to the Free Software
Alain Reguera Delgado 733076
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
See Also
Alain Reguera Delgado 733076
--------
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
centos-art.sh(1), centos-art.sh-render(1), centos-art.sh-locale(1)
Alain Reguera Delgado 733076
Alain Reguera Delgado 733076
// vim: set syntax=asciidoc: