Tuesday, March 22, 2011

Documenting a Unix Script

#! /usr/bin/ksh
echo "# +-----------------------------------------------------------------------"
echo "# | Program ID:    scriptname.sh"
echo "# |"
echo "# | Purpose:       description"
echo "# |"
echo "# | Developer:     Lynn Tobias"
echo "# | Program Date:  mm/dd/yyyy"
echo "# |"
echo "# | Input File(s): /ux123/scripts/YES              -- 'Y' for prompts"
echo "# |                /ux123/scripts/ods_uat.password -- sql+ password"
echo "# |"
echo "# | Table(s) Used: EXT_BLDLIST"
echo "# |"
echo "# | Called by:     ?"
echo "# | Calls:         scriptname.pl"
echo "# |"
echo "# | Output:        /ux123/scripts/blddist.file10"
echo "# |                "
echo "# | Revisions:     Dvlpr Date     Version Comment/Change"
echo "# |                ----- -------- ------- --------------------------------"
echo "# |"
echo "# +-----------------------------------------------------------------------"

No comments:

Post a Comment