#!/bin/bash

######################################################################

#

#   tcar_printHelp.sh -- This function standardizes the way

#   centos-art.sh script prints help about itself.

#

#   Written by:

#   * Alain Reguera Delgado <al@centos.org.cu>, 2009-2013

#

# Copyright (C) 2009-2013 The CentOS Artwork SIG

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or (at

# your option) any later version.

#

# This program is distributed in the hope that it will be useful, but

# WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

# General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

#

######################################################################

function tcar_printHelp {

    local TCAR_MANPAGE_FILE="${1}"

    local TCAR_MANPAGE_NAME="${TCAR_MODULE_NAME}"

    if [[ -n ${TCAR_MANPAGE_FILE} ]];then

        TCAR_MANPAGE_NAME="${TCAR_MODULE_NAME}-${TCAR_MANPAGE_FILE}"

    fi

    # Print documentation for manpage name.

    /usr/bin/man -M ${TCAR_MODULE_DIR_MANUALS} "${TCAR_MANPAGE_NAME}"

    # Finish script execution successfully.

    exit 0

}