Blame Scripts/Documentation/Manpages/tcar-prepare.asciidoc

Alain Reguera Delgado 572d08
tcar-prepare(1)
Alain Reguera Delgado 572d08
===============
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
Name
Alain Reguera Delgado 572d08
----
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
tcar-prepare - Prepare the repository workplace.
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
Synopsis
Alain Reguera Delgado 572d08
--------
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
*centos-art.sh prepare /path/to/your/workplace*
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
Description
Alain Reguera Delgado 572d08
-----------
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
When you install The CentOS Artwork Repository in your workstation, it
Alain Reguera Delgado 572d08
only provides the source files and documentation you need to produce
Alain Reguera Delgado 572d08
final content but no way to produce final content inside the location
Alain Reguera Delgado 572d08
it was installed. To produce final content using the source files
Alain Reguera Delgado 572d08
provided by The CentOS Artwork Repository you need to create a
Alain Reguera Delgado 572d08
directory in your workstation where you can store the files you
Alain Reguera Delgado 572d08
produce and the configuration files provided by the installed
Alain Reguera Delgado 572d08
repository.  This directory is known as the ``repository workplace''
Alain Reguera Delgado 77084b
and you should create it using the *tcar-prepare* command.
Alain Reguera Delgado 572d08
Alain Reguera Delgado 77084b
The *tcar-prepare* module creates the workplace in the location you
Alain Reguera Delgado 572d08
specified as argument in the command-line. Inside the workplace, there
Alain Reguera Delgado 572d08
is one directory for each visual manifestation The CentOS Project is
Alain Reguera Delgado 572d08
made of. Each directory inside the workplace might exist to organize
Alain Reguera Delgado 572d08
other directories or storing final content. The directories storing
Alain Reguera Delgado 572d08
final content hold one configuration file describing how the final
Alain Reguera Delgado 572d08
content is produced inside of it. The configuration files inside the
Alain Reguera Delgado 572d08
workplace are symbolic links to configuration files inside The CentOS
Alain Reguera Delgado 572d08
Artwork Repository installed in your workstation.
Alain Reguera Delgado 572d08
Alain Reguera Delgado 77084b
The first time you create the workplace using the *tcar-prepare*
Alain Reguera Delgado 77084b
module, it doesn't include images required to brand other images
Alain Reguera Delgado 77084b
(e.g., The CentOS Symbol and The CentOS Type). This is something you
Alain Reguera Delgado 77084b
need to do in order for images requiring brand information to be
Alain Reguera Delgado 77084b
rendered as they are expected. Rendering images related to brands
Alain Reguera Delgado 77084b
might consume some time but it is something that needs to be done just
Alain Reguera Delgado 77084b
once, unless variations to brand information be introduced to The
Alain Reguera Delgado 77084b
CentOS Artwork Repository, in which case it would be required to
Alain Reguera Delgado 77084b
render them again to propagate the changes introduced to brand
Alain Reguera Delgado 77084b
information the next time images requiring them be rendered.
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
[[options]]
Alain Reguera Delgado 572d08
Options
Alain Reguera Delgado 572d08
-------
Alain Reguera Delgado 572d08
Alain Reguera Delgado 77084b
The *tcar-prepare* module accepts the following options:
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
*--help*::
Alain Reguera Delgado 572d08
    Print module's documentation.
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
*--version*::
Alain Reguera Delgado 572d08
    Print module's version.
Alain Reguera Delgado 572d08
Alain Reguera Delgado 77084b
Author
Alain Reguera Delgado 77084b
------
Alain Reguera Delgado 572d08
Alain Reguera Delgado 77084b
Written by Alain Reguera Delgado
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
Copyright
Alain Reguera Delgado 572d08
---------
Alain Reguera Delgado 572d08
Alain Reguera Delgado 77084b
Copyright (C) 2014 The CentOS Artwork SIG
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
This program is free software; you can redistribute it and/or modify
Alain Reguera Delgado 572d08
it under the terms of the GNU General Public License as published by
Alain Reguera Delgado 572d08
the Free Software Foundation; either version 2 of the License, or (at
Alain Reguera Delgado 572d08
your option) any later version.
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
This program is distributed in the hope that it will be useful, but
Alain Reguera Delgado 572d08
WITHOUT ANY WARRANTY; without even the implied warranty of
Alain Reguera Delgado 572d08
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Alain Reguera Delgado 572d08
General Public License for more details.
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
You should have received a copy of the GNU General Public License
Alain Reguera Delgado 572d08
along with this program; if not, write to the Free Software
Alain Reguera Delgado 572d08
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
See Also
Alain Reguera Delgado 572d08
--------
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
tcar(1), tcar-render(1), tcar-locale(1)
Alain Reguera Delgado 572d08
Alain Reguera Delgado 572d08
// vim: set syntax=asciidoc: