summaryrefslogtreecommitdiff
path: root/macros/generic/memoize/doc/memoize-clean.1.md
blob: c64cbc0cd0c35965fe7e1c932bde6f1154124418 (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
---
title: memoize-clean
section: 1
header: User Manual
footer: memoize-clean of Memoize v1.1.1
date: January 16, 2024
hyphenate: false
---

# NAME
memoize-clean.pl, memoize-clean.py - Remove (stale) memo and extern files


# SYNOPSIS
**memoize-clean.pl** [*OPTIONS*] [*document1.mmz* ...]

**memoize-clean.py** [*OPTIONS*] [*document1.mmz* ...]


# DESCRIPTION

**memoize-clean** is a script accompanying Memoize, a TeX package which allows
the author to reuse the results of compilation-intensive code such as TikZ
pictures.

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).

**memoize-clean.pl** removes all memo and extern files with prefixes mentioned
in the listed **.mmz** files and by options **\--prefix** which are not
explicitly mentioned in the **.mmz** files.

Before deleting anything, **memoize-clean.pl** lists all the files it would
delete and asks for confirmation.

# OPTIONS

**-p, \--prefix**
: Add a memo/extern prefix for cleaning. This option may be given multiple
    times.

**-a, \--all**
: Remove all memos and externs, rather than only the stale ones.

**-y, \--yes**
: Do not ask for confirmation.

**-q, \--quiet**
: Don't describe what's happening.

**-h, \--help**
: Show help.

**-V, \--version**
: Show the Memoize version number and exit.

# SEE ALSO

[Memoize manual](https://ctan.org/pkg/memoize), section 6.6.3.