Return to Snippet

Revision: 41508
at February 19, 2011 03:46 by Mazzaroth


Updated Code
#------------------------------------------------------------------------------
# sub usage():
#       Displays usage information.
#
sub usage {
    print <<END_OF_USAGE;
Usage:
    ${PROGNAME} [-f[ile] <file>]
            [-v[erbose]] [-DEBUG <integer>]
            [-H[ELP]] [-D[OCUMENT]] [-A[BOUT]] [-R[EL_NOTES]]
    where
         [-f[ile]] <file>        Name of the G2++ file to convert to XML.
         [-v[erbose]]            Displays ongoing information.
         [-DEBUG <integer>]      Displays debug information.
                                 Default is 0. Available: 1, 2, 3, 4.
         [-H[ELP]]               Displays this Usage information.
         [-D[OCUMENT]]           Displays full documentation.
         [-A[BOUT]]              Displays version and author informations.
         [-R[EL_NOTES]]          Displays release notes informations.
END_OF_USAGE
}

#------------------------------------------------------------------------------
# sub about():
#       displays about information.
#
sub about {
    print <<END_OF_ABOUT;
${PROGNAME}

Edouard Boily,
edouard.boily\@gmail.com

\$Revision: 1.0 \$
\$Date: 2002/03/25 09:00 \$
END_OF_ABOUT
}


#------------------------------------------------------------------------------
# sub document():
#       displays full documentation.
#
sub document {
print <<END_OF_DOCUMENTATION;
CGI                                                ${PROGNAME}(1)

NAME
    ${PROGNAME} - Convert a G2++ file into an XML file.

SYNOPSIS
    ${PROGNAME} -f[ile <file>]
            [-v[erbose]] [-H[ELP]] [-D[OCUMENT]] [-A[BOUT]]

DESCRIPTION
    This program reads a G2++ file and converts it into XML.


ARGUMENTS
   -f[file] <file>
     Allows to specify a G2++ file to convert.

   [-v[erbose]]
     Displays ongoing information and details.

   [-H[ELP]]
     Displays the usage.
     If used with other options, causes immediate program termination.

   [-D[OCUMENT]]
     Displays the full documentation text (this file).
     If used with other options, causes immediate program termination.

   [-A[BOUT]]
     Displays informations about this program. Version, author, etc.
     If used with other options, causes immediate program termination.

EXAMPLES
    Convert the file ..\test_files\Test_01.g2++ into XML. Display the
    result on stdout.
       ${PROGNAME} -f ..\test_files\Test_01.g2++
    
    The output file will contain a comment specifying the original
    file and the translation date.
    
    The DTD of the output file will refer to a local DTD whose name is
    composed of the FA fields 'system' and 'trans'.

END_OF_DOCUMENTATION
}


#------------------------------------------------------------------------------
# sub relnotes():
#       displays release notes.
#
sub rel_notes {
    print <<END_OF_RELNOTES;
${PROGNAME}
\$Revision: 1.0 \$
\$Date: 2002/03/21 14:17 \$
	Support unlimited G2++ structure, including arrays.

END_OF_RELNOTES
}

Revision: 41507
at February 19, 2011 03:30 by Mazzaroth


Initial Code
#------------------------------------------------------------------------------
# sub usage():
#       Displays usage information.
#
sub usage {
    print <<END_OF_USAGE;
Usage:
    ${PROGNAME} [-f[ile] <file>]
            [-v[erbose]] [-DEBUG <integer>]
            [-H[ELP]] [-D[OCUMENT]] [-A[BOUT]] [-R[EL_NOTES]]
    where
         [-f[ile]] <file>        Name of the G2++ file to convert to XML.
         [-v[erbose]]            Displays ongoing information.
         [-DEBUG <integer>]      Displays debug information.
                                 Default is 0. Available: 1, 2, 3, 4.
         [-H[ELP]]               Displays this Usage information.
         [-D[OCUMENT]]           Displays full documentation.
         [-A[BOUT]]              Displays version and author informations.
         [-R[EL_NOTES]]          Displays release notes informations.
END_OF_USAGE
}

#------------------------------------------------------------------------------
# sub about():
#       displays about information.
#
sub about {
    print <<END_OF_ABOUT;
${PROGNAME}

Edouard Boily,
edouard.boily\@videotron.ca

\$Revision: 1.0 \$
\$Date: 2002/03/25 09:00 \$
END_OF_ABOUT
}


#------------------------------------------------------------------------------
# sub document():
#       displays full documentation.
#
sub document {
print <<END_OF_DOCUMENTATION;
CGI                                                ${PROGNAME}(1)

NAME
    ${PROGNAME} - Convert a G2++ file into an XML file.

SYNOPSIS
    ${PROGNAME} -f[ile <file>]
            [-v[erbose]] [-H[ELP]] [-D[OCUMENT]] [-A[BOUT]]

DESCRIPTION
    This program reads a G2++ file and converts it into XML.


ARGUMENTS
   -f[file] <file>
     Allows to specify a G2++ file to convert.

   [-v[erbose]]
     Displays ongoing information and details.

   [-H[ELP]]
     Displays the usage.
     If used with other options, causes immediate program termination.

   [-D[OCUMENT]]
     Displays the full documentation text (this file).
     If used with other options, causes immediate program termination.

   [-A[BOUT]]
     Displays informations about this program. Version, author, etc.
     If used with other options, causes immediate program termination.

EXAMPLES
    Convert the file ..\test_files\Test_01.g2++ into XML. Display the
    result on stdout.
       ${PROGNAME} -f ..\test_files\Test_01.g2++
    
    The output file will contain a comment specifying the original
    file and the translation date.
    
    The DTD of the output file will refer to a local DTD whose name is
    composed of the FA fields 'system' and 'trans'.

END_OF_DOCUMENTATION
}


#------------------------------------------------------------------------------
# sub relnotes():
#       displays release notes.
#
sub rel_notes {
    print <<END_OF_RELNOTES;
${PROGNAME}
\$Revision: 1.0 \$
\$Date: 2002/03/21 14:17 \$
	Support unlimited G2++ structure, including arrays.

END_OF_RELNOTES
}

Initial URL


Initial Description


Initial Title
documentation subs

Initial Tags


Initial Language
Perl