aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/grosciteco.tes.1.in
diff options
context:
space:
mode:
authorRobin Haberkorn <robin.haberkorn@googlemail.com>2016-11-16 16:28:03 +0100
committerRobin Haberkorn <robin.haberkorn@googlemail.com>2016-11-18 07:05:52 +0100
commitb44a4bae7d5c1098709dfaffd122263e0f4c5bc6 (patch)
tree2789f5ab99317bf1e399f82b173e7d2ba3b1ce1c /doc/grosciteco.tes.1.in
parentcb5e08b40d7444817c7eb6c1e4e8bf5208c2823c (diff)
downloadsciteco-b44a4bae7d5c1098709dfaffd122263e0f4c5bc6.tar.gz
standard lib: added getopt.tes for parsing command line options in scripts
* this uses an optstring compatible with getopt(3). * It does not use repeated getopt calls to iterate options, though but places the results in registers beginning with "getopt.". E.g. option "C" will result in "getopt.C" being set after the call to setopt. String arguments are supported and are placed in the string part of the getopt registers. * The grosciteco.tes and symbols-extract.tes scripts make use of getopt now, to simplify and clean up their command line handling.
Diffstat (limited to 'doc/grosciteco.tes.1.in')
-rw-r--r--doc/grosciteco.tes.1.in10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/grosciteco.tes.1.in b/doc/grosciteco.tes.1.in
index e890a96..0aac8dc 100644
--- a/doc/grosciteco.tes.1.in
+++ b/doc/grosciteco.tes.1.in
@@ -15,8 +15,9 @@ GNU roff post-processor for \*(ST
.SH SYNOPSIS
.
.SY grosciteco.tes
+.OP "-t" tec_output
+.OP "--"
.I text_output
-.I tec_output
.I input
.YS
.
@@ -66,9 +67,7 @@ documentation within \*(ST.
.
.SH OPTIONS
.
-.IP "\fItext_output\fP
-The plain-text output file, e.g. \(lqgreat-macro.woman\(rq.
-.IP "\fItec_output\fP
+.IP "\fB-t \fItec_output\fR"
The \*(ST script that when executed after loading
\fItext_output\fP into a Scintilla view, styles that document.
It can be thought of as representing meta-information
@@ -76,6 +75,9 @@ for \fItext_output\fP.
In order to cooperate with the \(lqwoman\(rq lexer and
\*(ST's \fB?\fP command, its file name should be
\fItext_output\fP.tec, e.g. \(lqgreat-macro.woman.tec\(rq.
+This is also the default when omitted.
+.IP "\fItext_output\fP
+The plain-text output file, e.g. \(lqgreat-macro.woman\(rq.
.IP "\fIinput\fP"
The \fIinput\fP file is in \fBtroff\fP's device-independant
output format.