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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
.ig \"-*- nroff -*-
..
.de TQ
.br
.ns
.TP \\$1
..
.\" Like TP, but if specified indent is more than half
.\" the current line-length - indent, use the default indent.
.de Tp
.ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
.el .TP "\\$1"
..
.TH lintex 1 "11 September 2012" "lintex version 1.13"
.SH NAME
lintex \- removes TeX-related garbage files
.SH SYNOPSIS
.BR lintex " [ " "\-i" " ] [ " "\-r" " ] [ " "\-b ext" " ] [ " "\-p" " ]"
.RB " [ " "\-k" " ] [ " "\-o" " ] [ " "\-q" " ] [ " "\-v" " ] [ " "\-d" " ]"
.RI " [ " dir " [ " dir " \|.\|.\|.\| ]]"
.SH DESCRIPTION
.B lintex
is a program that removes TeX-related auxiliary files, normally not
needed after a successful TeX run (i.e. log, aux, dvi, \.\.\. files);
they are actually removed only if their modification timestamp is more
recent than the one of the related TeX source and if they aren't readonly.
In addition, all the backup files that your favorite editor has generated
are also removed.
.SH OPTIONS
.TP
.B \-i
Asks the user permission before actually removing any file.
.TP
.B \-r
The given directories are scanned recursively; i.e., if they contain
any subdirectory structure, all the tree will be cleaned up.
.TP
.B \-b ext
.B ext
is the trailer string (the \'extension\') that identifies the backup
files generated by your editor, e.g.
.BR "\-b .bak" ";"
.B ext
defaults to ~ (the tilde character), i.e. to the
.IR emacs
convention. If
.B ext
includes characters having a special meaning for the shell, it must be
enclosed in quotes: e.g.
.B
\-b "~"
(equivalent to the default). Specifying the null string, as in
.BR "\-b """"" ","
inhibits the cleanup of any special file.
.TP
.B \-p
Pretends, show what files would be removed but don't actually remove them.
.TP
.B \-k
Keeps final documents (.pdf, .ps, .dvi).
.TP
.B \-o
Permits the removal of files older than their sources.
.TP
.B \-q
Quiet, only prints error messages.
.TP
.B \-v
Verbose, prints which files were removed and which weren't.
.TP
.B \-d
Debug, prints the answers to all of life's questions.
.SH PARAMETERS
.TP
.SM
.I dir
The name(s), separated by whitespace, of one or more directories to be
cleaned; if missing, the default is the current directory.
.SH EXTENSIONS THAT GET REMOVED
All files ending in the following extensions may be removed when appropriate:
.aux, .bbl, .blg, .dvi, .idx, .ilg, .ind, .lof, .log, .lot, .nav, .out,\
.pdf, .ps, .snm, .thm, .toc, .toc.old, .synctex.gz, .xyc
.SH ENVIRONMENT
The \fBHOME\fP environment variable determines the location of the configuration
file, see \fBFILES\fP below.
.SH FILES
Users can create a configuration file \fI$HOME/.lintexrc\fP which optionally
contains the keys \fBremove-keys\fP and \fBkeep-keys\fP, each followed by a
Python style list of extensions to additionally remove or keep, respectively.
Each extension \fImust\fP be preceded by a period, e.g. ".pdf" and not "pdf".
The \fBkeep-keys\fP key is only used when the keep option (\fB\-k\fP) is passed.
Note that the extensions listed in the \fBkeep-keys\fP field replace the
defaults used by the \fB\-k\fP option. The \fBkeep-keys\fP option also takes
precedence over \fBremove-keys\fP: no file ending in an extension removed by
default or listed in \fBremove-keys\fP will be deleted if its extension is
listed in \fBkeep-keys\fP and the \fB\-k\fP option was passed. For example, the
configuration file
keep-keys = [".pdf", ".ps", ".log"];
remove-keys = [".txt", ".1"];
will keep any file ending in ".pdf", ".ps" or ".log" when lintex is called with
the \fP\-k\fP option (but \fInot\fP files ending in ".dvi"), and adds ".txt" and
".1" to the list of extensions to check for removal. The following configuration
file provides lintex with its default behaviour:
keep-keys = [".pdf", ".ps", ".dvi"];
remove-keys = [];
.SH AUTHOR
lintex was written by Maurizio Loreti <Maurizio_Loreti\@gmail.com> between 1996
and 2002.
.LP
As of 2010, lintex is maintained by Ryan Kavanagh <rak\@debian.org>. It
features several extensions/bug fixes. Feel free to email him with your comments
and suggestions.
.SH COPYRIGHT
Copyright \[co] 1996\(en2002 Maurizio Loreti <Maurizio_Loreti\@gmail.com>
Copyright \[co] 2010\(en2012 Ryan Kavanagh <rak\@debian.org>
.B lintex
is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free
Software Foundation; either version 2, or (at your option) any later
version.
.LP
.B lintex
is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
(here included in the file
.IR COPYING "),"
for more details.
|
