Blame Automation/Modules/Hello/Manuals/hello.asciidoc

Alain Reguera Delgado 98c81b
hello(1)
Alain Reguera Delgado 98c81b
========
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
Name
Alain Reguera Delgado 98c81b
----
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
hello - Print out greetings and exit successfully.
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
Synopsis
Alain Reguera Delgado 98c81b
--------
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
*centos-art hello [--help|--version|--debug|--greeting=TEXT|--lowercase|--uppercase]*
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
Description
Alain Reguera Delgado 98c81b
-----------
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
The *hello* module is very simple. Its main purpose is to print out
Alain Reguera Delgado 98c81b
the ``Hello, World!'' greeting to standard output and exit
Alain Reguera Delgado 98c81b
successfully.  You can use options to change the greeting message and
Alain Reguera Delgado 98c81b
the way it is printed out. The *hello* module provides a very simple
Alain Reguera Delgado 98c81b
example you can use as base to understand how modules work inside
Alain Reguera Delgado 98c81b
*centos-art.sh* script and use that knowledge to start writing your
Alain Reguera Delgado 98c81b
own modules for *centos-art.sh* script.
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
Options
Alain Reguera Delgado 98c81b
-------
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
The *hello* module accepts the following options:
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
*--help*::
Alain Reguera Delgado 98c81b
    Print out module's documentation.
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
*--version*::
Alain Reguera Delgado 98c81b
    Print out module's version and legal status.
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
*--debug*::
Alain Reguera Delgado 98c81b
    Run the script in debugging mode. This option is very useful if
Alain Reguera Delgado 98c81b
    you want to get a closer look to the way modules are opened and
Alain Reguera Delgado 98c81b
    closed inside *centos-art.sh* script.
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
*--greeting=TEXT*::
Alain Reguera Delgado 98c81b
    Set a different greeting to be printed out.
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
*--lowercase*::
Alain Reguera Delgado 98c81b
    Print out the greeting in lowercase.
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
*--uppercase*::
Alain Reguera Delgado 98c81b
    Print out the greeting in uppercase.
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
Exit Status
Alain Reguera Delgado 98c81b
-----------
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
The *hello* module ends its execution with one of the following exit
Alain Reguera Delgado 98c81b
status:
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
* 0 -- Exit successfully without errors.
Alain Reguera Delgado 98c81b
* 1 -- Exit with errors.
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
Authors
Alain Reguera Delgado 98c81b
-------
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
The *hello* module has received contribution from the following
Alain Reguera Delgado 98c81b
people:
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
* Alain Reguera Delgado <mailto:al@centos.org.cu[al@centos.org.cu]>, 2013
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
Copyright
Alain Reguera Delgado 98c81b
---------
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
Copyright (C) 2009-2013 The CentOS Artwork SIG
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
This program is free software; you can redistribute it and/or modify
Alain Reguera Delgado 98c81b
it under the terms of the GNU General Public License as published by
Alain Reguera Delgado 98c81b
the Free Software Foundation; either version 2 of the License, or (at
Alain Reguera Delgado 98c81b
your option) any later version.
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
This program is distributed in the hope that it will be useful, but
Alain Reguera Delgado 98c81b
WITHOUT ANY WARRANTY; without even the implied warranty of
Alain Reguera Delgado 98c81b
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Alain Reguera Delgado 98c81b
General Public License for more details.
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
You should have received a copy of the GNU General Public License
Alain Reguera Delgado 98c81b
along with this program; if not, write to the Free Software
Alain Reguera Delgado 98c81b
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Alain Reguera Delgado 98c81b
Alain Reguera Delgado 98c81b
// vim: set syntax=asciidoc: