diff options
Diffstat (limited to 'vendor/voclient/doc/mkpage')
-rwxr-xr-x | vendor/voclient/doc/mkpage | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/vendor/voclient/doc/mkpage b/vendor/voclient/doc/mkpage new file mode 100755 index 00000000..285024a9 --- /dev/null +++ b/vendor/voclient/doc/mkpage @@ -0,0 +1,60 @@ +#!/bin/csh -f +# +# MKTEMP -- Utility script to make a template man page. +# +# Usage: % mktemp <taskname> +# +# Mike Fitzpatrick, NOAO, Nov 2011 + + +set tlc = $1 +set Tlc = `echo $1 | tr a-z A-Z` + +cat << EOF_TEMPLATE > /tmp/t$$ +.\" @(#)task.1 1.0 Feb-2013 MJF +.TH TASK 1 "Feb 2013" "VOClient Package" +.SH NAME +task \- short description +.SH SYNOPSIS +\fBtask\fP [\-\fopts\fP] file + +.SH OPTIONS +The \fItask\fP application accepts the following options: +.TP 8 +.B \-h, --help +Print a help summary to the terminal and exit. No processing is done +following this flag. + +.SH DESCRIPTION +The \fItask\fP application ...... +.PP +More descriptions ..... + +.SH SUB-DESCRIPTION +More useful stuff ....... + +.SH RETURN STATUS +On exit the \fBtask\fP task will return a zero indicating success, or a +one indicating an error. + +.SH EXAMPLES +.TP 4 +1) Queury for .... +.nf + % task ..... +.fi + +.SH BUGS +No known bugs with this release. +.SH Revision History +Feb 2013 - First public release +.SH Author +Michael Fitzpatrick (fitz@noao.edu), Feb 2013 +.SH "SEE ALSO" +voregistry, votinfo, votpos, votsort, votstat + +EOF_TEMPLATE + + +cat /tmp/t$$ | sed -e "s/task/${tlc}/g" -e "s/TASK/${Tlc}/g" > $1.man +/bin/rm -rf /tmp/t$$ |