RIV::Param module synopsis
The RIV::Param module synopsis shows how
to make calls to the constructor and parameter operation methods that
this module provides.
The comments provided in the synopsis serve as a quick reference as to the purpose of the constructor and parameter operation methods. The reference (man) pages for the constructor and each method provide the details.
# Load the RIV::Param module
use RIV::Param;
#
# These are the RIV::Param module constants used to specify
# whether a command line parameter takes no arguments or a
# single argument and whether it is mandatory.
RivParamNoArg, RivParamSingleArg;
RivParamMandatory, RivParamListArg;
#
# Call the RIV::Param constructor. The RIV::Param constructor
# returns to $param a new RIV::Param object.
#
$param = RIV::Param::new(\%paramHash, \$usageStringsRef, \$helpMessage, $dieOnUnknownArgs);
#
# Use the RIV::Param object ($param->) to invoke the methods
# that the RIV::Param module provides.
# Call the Usage method to print a brief usage explanation to
# standard output.
$param->Usage($errorCode);
#
# Call the DomainName method to obtain the name of the domain.
$domainName = $param->DomainName();
#
# Call the CommandName method to obtain the name of the command.
$commandName = $param->CommandName();