summaryrefslogtreecommitdiff
path: root/support/xetal/xetal.1
blob: 1d033b6eb405c6fc25c7cd866881200850ec4453 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
.TH XETAL 1 "1/17/92" "Version 1.2"
.de BP
.sp
.ti -.2i
\(**
..
.SH NAME
xetal \- a detexifier 
.SH SYNOPSIS
.B xetal 
[ options ] [ files ]
.SH DESCRIPTION
.I XETAL
removes all commands and mathematical formulas from tex and latex files.
If no files are specified, xetal reads from its standard input.
Xetal can also be used to perform elementary syntax checks on tex files.
It recognizes some basic tex and latex commands.
.P
.SH OPTIONS
.TP
.B \-a character
Don't remove accents. Accents will be preceded by "character".
.TP
.B \-A
Don't remove accents. Don't put escape character before accents.
.TP
.B \-b
Replace consecutive blanks by one blank.
.TP
.B \-c
Don't remove commands.
.TP
.B \-C
Don't remove comments.
.TP
.B \-d
Debugging mode. Don't try !
.TP
.B \-e label1,label2,...,last_label
Handle environnements label1, label2, ... as mathematical environnements.
.TP
.B \-E
Disable error messages.
.TP
.B \-f character
Replace deleted words and formulas with "character".
Default is space.
.TP
.B \-F
Don't replace deleted commands and formulas.
.TP
.B \-g
Replace deleted '{' and '}' by blank or specified replacement character.
.TP
.B \-i
Don't execute \include and \input commands.
.TP
.B \-m
Don't remove mathematical formulas.
.TP
.B \-n number
Numerotate output text every "number" lines. Use -n0 to remove 
numerotation. Default is -n0. 
.TP
.B \-N
Write filename only for the first line of each file.
.TP
.B \-o
Display macros definitions.
.TP
.B \-p
Remove punctuation.
.TP
.B \-r
Generate a succint report for the job done.
.TP
.B \-S
Silent mode: no output is produced. This option overrides every other
output option.
.TP
.B \-t
Remove text.
.TP
.B \-u
Output unknown (non-mathematical) commands.
.TP
.B \-w
Disable warning messages.
.TP
.B \-z
Display text after \\end.
.sp
.SH WARNING
.TP
Macros definitions are read, but they are not interpreted by xetal. 
Here is the kind of things xetal won't appreciate :
.sp
	\\documentstyle[\\docsty}
.sp
	{\\obeyspaces\\global\\let =\\ }
.sp
Error handling is very crude. In particular, line numbers in error \
messages aren't very reliable.
.sp
.SH BUGS
Bugs should be reported to cerf (e_mail: cerf@ens.ens.fr).