'\"
'\" Generated from file 'tcldocstrip\&.man' by tcllib/doctools with format 'nroff'
'\" Copyright (c) 2005 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net>
'\"
.TH "tcldocstrip" n 1\&.0 tcllib "Textprocessing toolbox"
.\" The -*- nroff -*- definitions below are for supplemental macros used
.\" in Tcl/Tk manual entries.
.\"
.\" .AP type name in/out ?indent?
.\"	Start paragraph describing an argument to a library procedure.
.\"	type is type of argument (int, etc.), in/out is either "in", "out",
.\"	or "in/out" to describe whether procedure reads or modifies arg,
.\"	and indent is equivalent to second arg of .IP (shouldn't ever be
.\"	needed;  use .AS below instead)
.\"
.\" .AS ?type? ?name?
.\"	Give maximum sizes of arguments for setting tab stops.  Type and
.\"	name are examples of largest possible arguments that will be passed
.\"	to .AP later.  If args are omitted, default tab stops are used.
.\"
.\" .BS
.\"	Start box enclosure.  From here until next .BE, everything will be
.\"	enclosed in one large box.
.\"
.\" .BE
.\"	End of box enclosure.
.\"
.\" .CS
.\"	Begin code excerpt.
.\"
.\" .CE
.\"	End code excerpt.
.\"
.\" .VS ?version? ?br?
.\"	Begin vertical sidebar, for use in marking newly-changed parts
.\"	of man pages.  The first argument is ignored and used for recording
.\"	the version when the .VS was added, so that the sidebars can be
.\"	found and removed when they reach a certain age.  If another argument
.\"	is present, then a line break is forced before starting the sidebar.
.\"
.\" .VE
.\"	End of vertical sidebar.
.\"
.\" .DS
.\"	Begin an indented unfilled display.
.\"
.\" .DE
.\"	End of indented unfilled display.
.\"
.\" .SO ?manpage?
.\"	Start of list of standard options for a Tk widget. The manpage
.\"	argument defines where to look up the standard options; if
.\"	omitted, defaults to "options". The options follow on successive
.\"	lines, in three columns separated by tabs.
.\"
.\" .SE
.\"	End of list of standard options for a Tk widget.
.\"
.\" .OP cmdName dbName dbClass
.\"	Start of description of a specific option.  cmdName gives the
.\"	option's name as specified in the class command, dbName gives
.\"	the option's name in the option database, and dbClass gives
.\"	the option's class in the option database.
.\"
.\" .UL arg1 arg2
.\"	Print arg1 underlined, then print arg2 normally.
.\"
.\" .QW arg1 ?arg2?
.\"	Print arg1 in quotes, then arg2 normally (for trailing punctuation).
.\"
.\" .PQ arg1 ?arg2?
.\"	Print an open parenthesis, arg1 in quotes, then arg2 normally
.\"	(for trailing punctuation) and then a closing parenthesis.
.\"
.\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
.\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1 \\fI\\$2\\fP (\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
.\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
.\"	# BS - start boxed text
.\"	# ^y = starting y location
.\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
.\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
.\"	# VS - start vertical sidebar
.\"	# ^Y = starting y location
.\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
.\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
.\"	# Special macro to handle page bottom:  finish off current
.\"	# box/sidebar if in box/sidebar mode, then invoked standard
.\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
.\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
.\"	# DE - end display
.de DE
.fi
.RE
.sp
..
.\"	# SO - start of list of standard options
.de SO
'ie '\\$1'' .ds So \\fBoptions\\fR
'el .ds So \\fB\\$1\\fR
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
.\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\*(So manual entry for details on the standard options.
..
.\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
.\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
.\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.\"	# UL - underline word
.de UL
\\$1\l'|0\(ul'\\$2
..
.\"	# QW - apply quotation marks to word
.de QW
.ie '\\*(lq'"' ``\\$1''\\$2
.\"" fix emacs highlighting
.el \\*(lq\\$1\\*(rq\\$2
..
.\"	# PQ - apply parens and quotation marks to word
.de PQ
.ie '\\*(lq'"' (``\\$1''\\$2)\\$3
.\"" fix emacs highlighting
.el (\\*(lq\\$1\\*(rq\\$2)\\$3
..
.\"	# QR - quoted range
.de QR
.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
.\"" fix emacs highlighting
.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
..
.\"	# MT - "empty" string
.de MT
.QW ""
..
.BS
.SH NAME
tcldocstrip \- Tcl-based Docstrip Processor
.SH SYNOPSIS
\fBtcldocstrip\fR \fIoutput\fR ?options? \fIinput\fR ?\fIguards\fR?
.sp
\fBtcldocstrip\fR ?options? \fIoutput\fR (?options? \fIinput\fR \fIguards\fR)\&.\&.\&.
.sp
\fBtcldocstrip\fR \fB-guards\fR \fIinput\fR
.sp
.BE
.SH DESCRIPTION
.PP
The application described by this document, \fBtcldocstrip\fR, is a
relative of \fBdocstrip\fR, a simple literate programming tool for
LaTeX\&.
.PP
\fBtcldocstrip\fR is based upon the package \fBdocstrip\fR\&.
.SS "USE CASES"
\fBtcldocstrip\fR was written with the following three use cases in
mind\&.
.PP
.IP [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\&.
.IP [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\&.
.IP [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\&.
.PP
.SS "COMMAND LINE"
.TP
\fBtcldocstrip\fR \fIoutput\fR ?options? \fIinput\fR ?\fIguards\fR?
This is the form for use case [1]\&. It converts the \fIinput\fR
file according to the specified \fIguards\fR and options\&. The result
is written to the named \fIoutput\fR file\&.
Usage of the string \fB-\fR as the name of the output signals that
the result should be written to \fBstdout\fR\&. The guards are
document-specific and have to be known to the caller\&. The
\fIoptions\fR will be explained later, in section \fBOPTIONS\fR\&.
.RS
.TP
path \fIoutput\fR (in)
This argument specifies where to write the generated document\&. It can
be the path to a file or directory, or \fB-\fR\&.
The last value causes the application to write the generated
documented to \fBstdout\fR\&.
.sp
If the \fIoutput\fR does not exist then [file dirname $output]
has to exist and must be a writable directory\&.
.TP
path \fIinputfile\fR (in)
This argument specifies the path to the file to process\&. It has to
exist, must be readable, and written in \fIdocstrip\fR format\&.
.RE
.sp
.TP
\fBtcldocstrip\fR ?options? \fIoutput\fR (?options? \fIinput\fR \fIguards\fR)\&.\&.\&.
This is the form for use case [2]\&. It differs from the form for
use case [1] by the possibility of having options before the
output file, which apply in general, and specifying more than one
inputfile, each with its own set of input specific options and guards\&.
.sp
It extracts data from the various \fIinput\fR files, according to the
specified \fIoptions\fR and \fIguards\fR, and writes the result to the
given \fIoutput\fR, 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 \fB-\fR as output
causes the application to write to stdout\&.
Using the string \fB\&.\fR 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\&.
.TP
\fBtcldocstrip\fR \fB-guards\fR \fIinput\fR
This is the form for use case [3]\&.
It determines the guards, and unique guard expressions used within the
provided \fIinput\fR document\&. The found strings are written to
stdout, one string per line\&.
.PP
.SS OPTIONS
This section describes all the options available to the user of the
application, with the exception of the option \fB-guards\fR\&. This
option was described already, in section \fBCOMMAND LINE\fR\&.
.PP
.TP
\fB-metaprefix\fR string
This option is inherited from the command \fBdocstrip::extract\fR
provided by the package \fBdocstrip\fR\&.
.sp
It specifies the string by which the '%%' prefix of a metacomment line
will be replaced\&. Defaults to '%%'\&. For Tcl code this would typically
be '#'\&.
.TP
\fB-onerror\fR mode
This option is inherited from the command \fBdocstrip::extract\fR
provided by the package \fBdocstrip\fR\&.
.sp
It controls what will be done when a format error in the \fItext\fR
being processed is detected\&. The settings are:
.RS
.TP
\fBignore\fR
Just ignore the error; continue as if nothing happened\&.
.TP
\fBputs\fR
Write an error message to \fBstderr\fR, then continue processing\&.
.TP
\fBthrow\fR
Throw an error\&. \fB::errorCode\fR is set to a list whose first element
is \fBDOCSTRIP\fR, second element is the type of error, and third
element is the line number where the error is detected\&. This is the
default\&.
.RE
.TP
\fB-trimlines\fR bool
This option is inherited from the command \fBdocstrip::extract\fR
provided by the package \fBdocstrip\fR\&.
.sp
Controls whether \fIspaces\fR at the end of a line should be trimmed
away before the line is processed\&. Defaults to \fBtrue\fR\&.
.TP
\fB-preamble\fR text
.TP
\fB-postamble\fR text
.TP
\fB-nopreamble\fR
.TP
\fB-nopostamble\fR
The -no*amble options deactivate file pre- and postambles altogether,
whereas the -*amble options specify the \fIuser\fR part of the file
pre- and postambles\&. This part can be empty, in that case only the
standard parts are shown\&. This is the default\&.
.sp
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\&.
.PP
.SH "BUGS, IDEAS, FEEDBACK"
This document, and the package it describes, will undoubtedly contain
bugs and other problems\&.
Please report such in the category \fIdocstrip\fR of the
\fITcllib Trackers\fR [http://core\&.tcl\&.tk/tcllib/reportlist]\&.
Please also report any ideas for enhancements you may have for either
package and/or documentation\&.
.PP
When proposing code changes, please provide \fIunified diffs\fR,
i\&.e the output of \fBdiff -u\fR\&.
.PP
Note further that \fIattachments\fR are strongly preferred over
inlined patches\&. Attachments can be made by going to the \fBEdit\fR
form of the ticket immediately after its creation, and then using the
left-most button in the secondary navigation bar\&.
.SH "SEE ALSO"
docstrip
.SH KEYWORDS
\\\&.dtx, LaTeX, conversion, docstrip, documentation, literate programming, markup, source
.SH CATEGORY
Documentation tools
.SH COPYRIGHT
.nf
Copyright (c) 2005 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net>

.fi
