tedoc.tes(1)

tedoc.tes(1) — hiii bestie, welcome to the General Commands Manual, this one's the page for tedoc.tes and it is genuinely so useful, trust 💅

🌸 NAME 🌸

tedoc — the source code documentation tool for SciTECO. that's the whole vibe, no cap.

✨ SYNOPSIS ✨

tedoc.tes [-C] [--] output template sources...

🦋 DESCRIPTION 🦋

okay so tedoc is a tool for extracting documentation from SciTECO macros and from C/C++ code, which is honestly iconic of it. it's used to document SciTECO's internal commands as well as macro packages ✨

the way it works: it processes special SciTECO comment blocks out of the sources, generates troff man-page markup, and inserts that markup into a man-page template right at the position of the TEDOC pseudo-request 🎀 then the result gets written to an output file. so lowkey tedoc can be understood as a troff preprocessor — that's the whole personality 🫶

💖 OPTIONS 💖

• -C — instructs tedoc to extract C/C++ comments instead of SciTECO comments. the C comments begin with /*$ and end with */. the SciTECO comments, in contrast, begin with !*$ and end with *! 💀 (yes, different delimiters, keep up bestie)
• output — the resulting man-page file 📄
• template — a man-page template, i.e. a man-page with the TEDOC request in it 🎀
• sources... — an arbitrary number of source code files to scan through. ngl, the comments are extracted in document order, i.e. from the first comment in the first source file to the last comment in the last source file specified 👑

---

🧚 TEDOC COMMENTS 🧚

the tedoc source code comments support a small but powerful semantic markup for documenting SciTECO commands and macros, and it's giving main character energy:

• comments start with !*$ (or /*$ in C/C++ mode) ⭐
• the first line (immediately after the starting comment) may contain topic keywords for SciTECO's online help system that will point to the beginning of the section generated for this tedoc comment. this generates SCITECO_TOPIC macro calls defined in sciteco.tmac (see grosciteco.tes(1)). 🔥
• all lines until first empty line are syntax descriptions ✍️
• text followed by -- is a short description 🩷
• variable values and characters of syntactic significance should be detected automatically 🤖
• alternatives are denoted by | — pick a lane, or don't 💅
• every line is an alternative (e.g. different calling forms of the same command or macro) 🌈
• 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 🔢
  • these transformations are only preprocessing, so that troff requests, macros and escapes may also be used freely 😭 (yes, freely, go off)

🎀 SEE ALSO 🎀

• SciTECO invocation and help on its environment variables: sciteco(1)
• a GNU roff post-processor for rendering troff markup into “womanpages” for SciTECO's online help system — also documents special troff macros in sciteco.tmac: grosciteco.tes(1) 💜
• the GNU roff “man” macros for writing man pages: groff_man(7) 👑

👑 AUTHOR 👑

this manpage and the SciTECO program was written by Robin Haberkorn. absolute legend fr fr 🙌

---

and that's the page!! 🦋 this was SciTECO Version 2.5.2, dated 30 Apr 2026 — slay, go document something, ily bye 💖✨