Posted By

Mazzaroth on 02/19/11


Tagged


Versions (?)

Who likes this?

1 person have marked this snippet as a favorite

wheffner


documentation subs


 / Published in: Perl
 

  1. #------------------------------------------------------------------------------
  2. # sub usage():
  3. # Displays usage information.
  4. #
  5. sub usage {
  6. print <<END_OF_USAGE;
  7. Usage:
  8. ${PROGNAME} [-f[ile] <file>]
  9. [-v[erbose]] [-DEBUG <integer>]
  10. [-H[ELP]] [-D[OCUMENT]] [-A[BOUT]] [-R[EL_NOTES]]
  11. where
  12. [-f[ile]] <file> Name of the G2++ file to convert to XML.
  13. [-v[erbose]] Displays ongoing information.
  14. [-DEBUG <integer>] Displays debug information.
  15. Default is 0. Available: 1, 2, 3, 4.
  16. [-H[ELP]] Displays this Usage information.
  17. [-D[OCUMENT]] Displays full documentation.
  18. [-A[BOUT]] Displays version and author informations.
  19. [-R[EL_NOTES]] Displays release notes informations.
  20. END_OF_USAGE
  21. }
  22.  
  23. #------------------------------------------------------------------------------
  24. # sub about():
  25. # displays about information.
  26. #
  27. sub about {
  28. print <<END_OF_ABOUT;
  29. ${PROGNAME}
  30.  
  31. Edouard Boily,
  32. edouard.boily\@gmail.com
  33.  
  34. \$Revision: 1.0 \$
  35. \$Date: 2002/03/25 09:00 \$
  36. END_OF_ABOUT
  37. }
  38.  
  39.  
  40. #------------------------------------------------------------------------------
  41. # sub document():
  42. # displays full documentation.
  43. #
  44. sub document {
  45. print <<END_OF_DOCUMENTATION;
  46. CGI ${PROGNAME}(1)
  47.  
  48. NAME
  49. ${PROGNAME} - Convert a G2++ file into an XML file.
  50.  
  51. SYNOPSIS
  52. ${PROGNAME} -f[ile <file>]
  53. [-v[erbose]] [-H[ELP]] [-D[OCUMENT]] [-A[BOUT]]
  54.  
  55. DESCRIPTION
  56. This program reads a G2++ file and converts it into XML.
  57.  
  58.  
  59. ARGUMENTS
  60. -f[file] <file>
  61. Allows to specify a G2++ file to convert.
  62.  
  63. [-v[erbose]]
  64. Displays ongoing information and details.
  65.  
  66. [-H[ELP]]
  67. Displays the usage.
  68. If used with other options, causes immediate program termination.
  69.  
  70. [-D[OCUMENT]]
  71. Displays the full documentation text (this file).
  72. If used with other options, causes immediate program termination.
  73.  
  74. [-A[BOUT]]
  75. Displays informations about this program. Version, author, etc.
  76. If used with other options, causes immediate program termination.
  77.  
  78. EXAMPLES
  79. Convert the file ..\test_files\Test_01.g2++ into XML. Display the
  80. result on stdout.
  81. ${PROGNAME} -f ..\test_files\Test_01.g2++
  82.  
  83. The output file will contain a comment specifying the original
  84. file and the translation date.
  85.  
  86. The DTD of the output file will refer to a local DTD whose name is
  87. composed of the FA fields 'system' and 'trans'.
  88.  
  89. END_OF_DOCUMENTATION
  90. }
  91.  
  92.  
  93. #------------------------------------------------------------------------------
  94. # sub relnotes():
  95. # displays release notes.
  96. #
  97. sub rel_notes {
  98. print <<END_OF_RELNOTES;
  99. ${PROGNAME}
  100. \$Revision: 1.0 \$
  101. \$Date: 2002/03/21 14:17 \$
  102. Support unlimited G2++ structure, including arrays.
  103.  
  104. END_OF_RELNOTES
  105. }

Report this snippet  

You need to login to post a comment.