instscript [options] scriptname | |
-h,--help | print short help and exit |
-H,--Help | print full documentation via less and exit |
-V,--version | print version and exit |
-d,--debug | set debug flag: keep intermediate files for inspection |
-e,--extras=X | set list of extra files to be zipped to X (comma separated) |
-z,--zip | create zip file for CTAN |
instscript installs a (bash, ruby, perl, ...) script, for which the documentation is maintained in the gendoc format. The variable Instdir tells where things are installed:
The script is installed in $Instdir/bin. Its documentation is extracted and placed in $Instdir/html (for the html documentation), in $Instdir/pdf for the PDF documentation and in $Instdir/man/man1 (for the man page). instscript must be executed in the source directory of the script.
The script must have valid gendoc documentation - see github. The first paragraph that is found under the =␣Description header is saved in a README.md file, which should be part of the source: it is used by github. Bars (|) will be stripped from that paragraph.
With the --zip option, a zip file containing the script, a README file, a man page, and html and pdf documents is created.
synopsis: | handle_options "$@" |
description: | handle the options. |
globals used: | Myname Version |
globals set: | args zip |