summaryrefslogtreecommitdiff
path: root/support/kamal/detex.1
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/kamal/detex.1
Initial commit
Diffstat (limited to 'support/kamal/detex.1')
-rw-r--r--support/kamal/detex.158
1 files changed, 58 insertions, 0 deletions
diff --git a/support/kamal/detex.1 b/support/kamal/detex.1
new file mode 100644
index 0000000000..dc27bdde5b
--- /dev/null
+++ b/support/kamal/detex.1
@@ -0,0 +1,58 @@
+.TH detex 1 2/27/86
+.UC 4
+.SH NAME
+detex \- a filter to strip TeX and LaTeX's commands from a file.
+.SH SYNOPSIS
+.B detex [-iw]
+.I file1 [file2 ......]
+.br
+or
+.B detex [-iw]
+.I < file
+.br
+.SH DESCRIPTION
+TeX and LaTeX have control characters that
+.B spell
+and other
+.I troff
+-dependent
+processors (like diction) do not recognize.
+.I Detex
+works as a preprocessor by
+filtering those control characters. The output can then be piped to the next
+process. The output can be saved by redirecting the standard output.
+.I Detex
+does not break the document into individual words. It merely
+.I erases
+the control sequences.
+.br
+In-line or displayed equation are not passed to the output. Also,
+the character '%' is recognized as a comment indicator and the commented
+text is not passed to the output.
+.br
+.I Detex
+recognizes and opens files called by TeX's and LaTeX's \\input
+and \\include commands. The
+.B -i
+flag makes
+.I detex
+ignore these commands.
+The file name has to be correct relative to the current working directory.
+If it cannot open the file nor file_name.tex, it will give a non-fatal
+error message and proceed.
+.br
+Warning is given if suspected unmatching is detected. Use the
+.B -w
+flag to suppress these warnings.
+.SH DIAGNOSTICS
+Nesting of \\input and \\include is allowed but the number of opened files
+must not exceed the system's limit on the number of simultaneously opened
+files (normally < 20).
+.br
+Displayed material is regarded as mathematical equations and is ignored.
+.br
+White spaces withing LaTeX's \\begin{...} or \\end{...} are not allowed for.
+.SH SEE ALSO
+texexpand(1), texeqn(1), texmatch(1).
+.SH AUTHOR
+Kamal Al-Yahya, Stanford University