summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/memoize-clean.1
blob: 328349c41b479927b3c5c6557b80fd865b54195a (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
.\" Automatically generated by Pandoc 3.0.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "memoize-clean" "1" "October 10, 2023" "memoize-clean of Memoize v1.0.0" "User Manual"
.nh
.SH NAME
.PP
memoize-clean.pl, memoize-clean.py - Remove (stale) memo and extern
files
.SH SYNOPSIS
.PP
\f[B]memoize-clean.pl\f[R] [\f[I]OPTIONS\f[R]] [\f[I]document1.mmz\f[R]
\&...]
.PP
\f[B]memoize-clean.py\f[R] [\f[I]OPTIONS\f[R]] [\f[I]document1.mmz\f[R]
\&...]
.SH DESCRIPTION
.PP
\f[B]memoize-clean\f[R] is a script accompanying Memoize, a TeX package
which allows the author to reuse the results of compilation-intensive
code such as TikZ pictures.
.PP
By default, this script removes stale memo and extern files.
A stale memo or extern is an extern produced during a compilation of a
previous version of the document which was neither used nor produced
during the last compilation of the document.
Typically, stale files arise when we change the memoized code (or its
context).
.PP
\f[B]memoize-clean.pl\f[R] removes all memo and extern files with
prefixes mentioned in the listed \f[B].mmz\f[R] files and by options
\f[B]--prefix\f[R] which are not explicitly mentioned in the
\f[B].mmz\f[R] files.
.PP
Before deleting anything, \f[B]memoize-clean.pl\f[R] lists all the files
it would delete and asks for confirmation.
.SH OPTIONS
.TP
\f[B]-p, --prefix\f[R]
Add a memo/extern prefix for cleaning.
This option may be given multiple times.
.TP
\f[B]-a, --all\f[R]
Remove all memos and externs, rather than only the stale ones.
.TP
\f[B]-y, --yes\f[R]
Do not ask for confirmation.
.TP
\f[B]-q, --quiet\f[R]
Don\[cq]t describe what\[cq]s happening.
.TP
\f[B]-h, --help\f[R]
Show help.
.TP
\f[B]-V, --version\f[R]
Show the Memoize version number and exit.
.SH SEE ALSO
.PP
Memoize manual (https://ctan.org/pkg/memoize), section 6.6.3.