Tcl Library Source Code

Bounty program for improvements to Tcl and certain Tcl packages.

[ Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]


tcldocstrip - Tcl-based Docstrip Processor

Table Of Contents


tcldocstrip output ?options? input ?guards?
tcldocstrip ?options? output (?options? input guards)...
tcldocstrip -guards input


The application described by this document, tcldocstrip, is a relative of docstrip, a simple literate programming tool for LaTeX.

tcldocstrip is based upon the package docstrip.


tcldocstrip was written with the following three use cases in mind.

  1. Conversion of a single input file according to the listed guards into the stripped output. This handles the most simple case of a set of guards specifying a single document found in a single input file.

  2. Stitching, or the assembly of an output from several sets of guards, in a specific order, and possibly from different files. This is the second common case. One document spread over several inputs, and/or spread over different guard sets.

  3. Extraction and listing of all the unique guard expressions and guards used within a document to help a person which did not author the document in question in familiarizing itself with it.



This section describes all the options available to the user of the application, with the exception of the option -guards. This option was described already, in section COMMAND LINE.

Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category docstrip of the Tcllib Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.




.dtx, LaTeX, conversion, docstrip, documentation, literate programming, markup, source


Documentation tools


Copyright © 2005 Andreas Kupries