tcldocstrip(1) | Textprocessing toolbox | tcldocstrip(1) |
tcldocstrip - Tcl-based Docstrip Processor
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.
If the output does not exist then [file dirname $output] has to exist and must be a writable directory.
It extracts data from the various input files, according to the specified options and guards, and writes the result to the given output, in the order of their specification on the command line. Options specified before the output are global settings, whereas the options specified before each input are valid only just for this input file. Unspecified values are taken from the global settings, or defaults. As for form [1] using the string - as output causes the application to write to stdout. Using the string . for an input file signals that the last input file should be used again. This enables the assembly of the output from one input file using multiple and different sets of guards, without having to specify the full name of the file every time.
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.
It specifies the string by which the '%%' prefix of a metacomment line will be replaced. Defaults to '%%'. For Tcl code this would typically be '#'.
It controls what will be done when a format error in the text being processed is detected. The settings are:
Controls whether spaces at the end of a line should be trimmed away before the line is processed. Defaults to true.
Preambles, when active, are written before the actual content of a generated file. In the same manner postambles are, when active, written after the actual content of a generated file.
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 [http://core.tcl.tk/tcllib/reportlist]. 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.
docstrip
\.dtx, LaTeX, conversion, docstrip, documentation, literate programming, markup, source
Documentation tools
Copyright (c) 2005 Andreas Kupries <andreas_kupries@users.sourceforge.net>
1.0 | tcllib |