diff options
Diffstat (limited to 'doc/generate-docs.tes')
| -rwxr-xr-x | doc/generate-docs.tes | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/generate-docs.tes b/doc/generate-docs.tes index 93b0e9d..3f9c857 100755 --- a/doc/generate-docs.tes +++ b/doc/generate-docs.tes @@ -1,4 +1,31 @@ #!/usr/bin/sciteco -m +! ./generate-docs.tes <output> <input> <sources> ! + +! + Preprocess a manpage template, inserting a SciTECO command reference. + + The .COMMANDS request is replaced with Troff markup generated from code + comments in <sources>. + + The comments support a small but powerful markup for documenting + TECO commands: + * comments start with /*$ + * all lines until first empty line are command syntax descriptions + * text followed by "--" is a short description + * variable values and characters of syntactic significance should be + detected automatically + * alternatives are denoted by "|" + * every line is an alternative + * return values may be specified after "->" + * the remaining text is the verbose command description + * <name> denotes a variable from the syntax description + * empty lines introduce paragraphs + * lines beginning with "-" are unordered lists + * lines beginning with numbers and dot ("1.", "2.", etc.) are + ordered lists + * the above transformations are only preprocessing, so that + Troff requests, escapes and tman macros may also be used. +! @{format_header}{ fd--S .U.f :L"S.|Z'U.t Q.f,Q.tXa Q.f,Q.tD I |