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

Alain Reguera Delgado a38022
hello(1)
Alain Reguera Delgado a38022
========
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
Name
Alain Reguera Delgado a38022
----
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
hello - Print out greetings and exit successfully.
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
Synopsis
Alain Reguera Delgado a38022
--------
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
*centos-art hello [OPTIONS]*
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
Description
Alain Reguera Delgado a38022
-----------
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
The *hello* module is very simple. Its main purpose is to print out
Alain Reguera Delgado a38022
the ``Hello, World!'' greeting to standard output and exit
Alain Reguera Delgado a38022
successfully.  You can use options to change the greeting message and
Alain Reguera Delgado a38022
the way it is printed out. The *hello* module provides a very simple
Alain Reguera Delgado a38022
example you can use as base to understand how modules work inside
Alain Reguera Delgado a38022
*centos-art.sh* script. You can this understanding to start writing
Alain Reguera Delgado a38022
your own modules for *centos-art.sh* script.
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
Options
Alain Reguera Delgado a38022
-------
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
The *hello* module accepts the following options:
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
*-h | --help*::
Alain Reguera Delgado a38022
    Print out module's documentation.
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
*-v | --version*::
Alain Reguera Delgado a38022
    Print out module's version and legal status.
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
*-d | --debug*::
Alain Reguera Delgado a38022
    Run the script in debugging mode. This option is very useful if
Alain Reguera Delgado a38022
    you want to get a closer look to module environments being
Alain Reguera Delgado a38022
    executed and destroyed at run-time.
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
*-g "TEXT" | --greeting="TEXT"*::
Alain Reguera Delgado a38022
    Set a different greeting message to be printed out. This option
Alain Reguera Delgado a38022
    accepts a value as argument. The text you provide must not have
Alain Reguera Delgado a38022
    empty spaces on it. By default, when you don't provide this
Alain Reguera Delgado a38022
    option, *hello* module prints out ``Hello, World'' as greeting. If
Alain Reguera Delgado a38022
    translations of this message are available for your locale, they
Alain Reguera Delgado a38022
    will be printed instead.
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
*-l | --lower*::
Alain Reguera Delgado a38022
    Print greeting message in lowercase. The final output is printed
Alain Reguera Delgado a38022
    out all in one line.
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
*-u | --upper*::
Alain Reguera Delgado a38022
    Print greeting message in uppercase. The final output is printed
Alain Reguera Delgado a38022
    out all in one line.
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
*-c | --camel*::
Alain Reguera Delgado a38022
    Print greeting messages in camel-case (e.g., "HeLlO, WoRlD!").
Alain Reguera Delgado a38022
    The output is printed out one character per line. This might not
Alain Reguera Delgado a38022
    have sense but it helps to describe how execution of sibling
Alain Reguera Delgado a38022
    modules work. Notice that, when printing final output, punctuation
Alain Reguera Delgado a38022
    marks doesn't count for formating.
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
*-r | --random*::
Alain Reguera Delgado a38022
    Print letters of a greeting message in a random order (e.g.,
Alain Reguera Delgado a38022
    rdodldrl!,,!).  The final output is printed out one character per
Alain Reguera Delgado a38022
    line. This might not have sense but it helps to describe how
Alain Reguera Delgado a38022
    recursive execution of sibling modules work.
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
Exit Status
Alain Reguera Delgado a38022
-----------
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
The *hello* module ends its execution with one of the following exit
Alain Reguera Delgado a38022
status:
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
* 0 -- Exit successfully without errors.
Alain Reguera Delgado a38022
* 1 -- Exit with errors.
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
Authors
Alain Reguera Delgado a38022
-------
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
The *hello* module has received contribution from the following
Alain Reguera Delgado a38022
people:
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
* Alain Reguera Delgado <mailto:al@centos.org.cu[al@centos.org.cu]>, 2013
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
Copyright
Alain Reguera Delgado a38022
---------
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
Copyright (C) 2009-2013 The CentOS Artwork SIG
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
This program is free software; you can redistribute it and/or modify
Alain Reguera Delgado a38022
it under the terms of the GNU General Public License as published by
Alain Reguera Delgado a38022
the Free Software Foundation; either version 2 of the License, or (at
Alain Reguera Delgado a38022
your option) any later version.
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
This program is distributed in the hope that it will be useful, but
Alain Reguera Delgado a38022
WITHOUT ANY WARRANTY; without even the implied warranty of
Alain Reguera Delgado a38022
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Alain Reguera Delgado a38022
General Public License for more details.
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
You should have received a copy of the GNU General Public License
Alain Reguera Delgado a38022
along with this program; if not, write to the Free Software
Alain Reguera Delgado a38022
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Alain Reguera Delgado a38022
Alain Reguera Delgado a38022
// vim: set syntax=asciidoc: