diff options
| author | Robin Haberkorn <robin.haberkorn@googlemail.com> | 2013-03-16 16:13:45 +0100 |
|---|---|---|
| committer | Robin Haberkorn <robin.haberkorn@googlemail.com> | 2013-03-16 18:07:33 +0100 |
| commit | 28a7cf634e3430bd3f83f50f1d112051f9e8c822 (patch) | |
| tree | fb2d156609fe03daf171c2effe8750f0875b9f26 /doc/sciteco.7.template | |
| parent | 7a0ca37989f19bec5fac57cc5890a44f28972666 (diff) | |
| download | sciteco-28a7cf634e3430bd3f83f50f1d112051f9e8c822.tar.gz | |
wrote introduction (typographic conventions) for command reference
Diffstat (limited to 'doc/sciteco.7.template')
| -rw-r--r-- | doc/sciteco.7.template | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/sciteco.7.template b/doc/sciteco.7.template index cd4d18a..a427cac 100644 --- a/doc/sciteco.7.template +++ b/doc/sciteco.7.template @@ -992,6 +992,37 @@ loops in conditional blocks. . .SH COMMAND REFERENCE . +This section documents all of the commands supported by +\*(ST. +The command reference adheres to a few typographic conventions: +.RS +.IP \(bu 3 +The first lines in each command subsection descibes the +command's syntax. +Each line corresponds to one alternative. +.IP \(bu +.RI [ ... ] +denotes an optional value or construct. +.IP \(bu +Alternatives are separated by \(lq|\(rq. +.IP \(bu +.I Italic +(or underlined) words refer to variable values or characters. +.IP \(bu +.B Bold +characters are of syntactic significance. +.IP \(bu +A right arrow (\(->) is followed by the command's return +values (i.e. values pushed onto the expression stack). +.IP \(bu +.B $ +separates string arguments since the default string +terminator Escape (code 27) is echoed as a dollar sign +by \*(ST. +.RE +.LP +The same conventions are used elsewhere in this manual. +. .COMMANDS . . |