summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2023-10-11 20:46:52 +0000
committerKarl Berry <karl@freefriends.org>2023-10-11 20:46:52 +0000
commitf52476c6ec7e3d1a646e83baf4b64a9999c5ecd1 (patch)
tree90b962392e9c6bb7fb2d4ffde2440c0690b9f7a3 /Master/texmf-dist/doc/man
parent9a9196eacd240c7126b5660aaf6d11c4ce30b111 (diff)
memoize (11oct23)
git-svn-id: svn://tug.org/texlive/trunk@68515 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/man')
-rw-r--r--Master/texmf-dist/doc/man/man1/memoize-clean.172
-rw-r--r--Master/texmf-dist/doc/man/man1/memoize-clean.man1.pdfbin0 -> 17977 bytes
-rw-r--r--Master/texmf-dist/doc/man/man1/memoize-clean.pl.11
-rw-r--r--Master/texmf-dist/doc/man/man1/memoize-clean.pl.man1.pdfbin0 -> 2298 bytes
-rw-r--r--Master/texmf-dist/doc/man/man1/memoize-clean.py.11
-rw-r--r--Master/texmf-dist/doc/man/man1/memoize-clean.py.man1.pdfbin0 -> 2298 bytes
-rw-r--r--Master/texmf-dist/doc/man/man1/memoize-extract.1111
-rw-r--r--Master/texmf-dist/doc/man/man1/memoize-extract.man1.pdfbin0 -> 23222 bytes
-rw-r--r--Master/texmf-dist/doc/man/man1/memoize-extract.pl.11
-rw-r--r--Master/texmf-dist/doc/man/man1/memoize-extract.pl.man1.pdfbin0 -> 2298 bytes
-rw-r--r--Master/texmf-dist/doc/man/man1/memoize-extract.py.11
-rw-r--r--Master/texmf-dist/doc/man/man1/memoize-extract.py.man1.pdfbin0 -> 2298 bytes
12 files changed, 187 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/man/man1/memoize-clean.1 b/Master/texmf-dist/doc/man/man1/memoize-clean.1
new file mode 100644
index 00000000000..328349c41b4
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/memoize-clean.1
@@ -0,0 +1,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.
diff --git a/Master/texmf-dist/doc/man/man1/memoize-clean.man1.pdf b/Master/texmf-dist/doc/man/man1/memoize-clean.man1.pdf
new file mode 100644
index 00000000000..ef8d5cab9d4
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/memoize-clean.man1.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/man/man1/memoize-clean.pl.1 b/Master/texmf-dist/doc/man/man1/memoize-clean.pl.1
new file mode 100644
index 00000000000..cec749ce8c0
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/memoize-clean.pl.1
@@ -0,0 +1 @@
+.so man1/doc/memoize-clean.1
diff --git a/Master/texmf-dist/doc/man/man1/memoize-clean.pl.man1.pdf b/Master/texmf-dist/doc/man/man1/memoize-clean.pl.man1.pdf
new file mode 100644
index 00000000000..fed432810ec
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/memoize-clean.pl.man1.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/man/man1/memoize-clean.py.1 b/Master/texmf-dist/doc/man/man1/memoize-clean.py.1
new file mode 100644
index 00000000000..cec749ce8c0
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/memoize-clean.py.1
@@ -0,0 +1 @@
+.so man1/doc/memoize-clean.1
diff --git a/Master/texmf-dist/doc/man/man1/memoize-clean.py.man1.pdf b/Master/texmf-dist/doc/man/man1/memoize-clean.py.man1.pdf
new file mode 100644
index 00000000000..9c1844e1a95
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/memoize-clean.py.man1.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/man/man1/memoize-extract.1 b/Master/texmf-dist/doc/man/man1/memoize-extract.1
new file mode 100644
index 00000000000..916d402c7c0
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/memoize-extract.1
@@ -0,0 +1,111 @@
+.\" 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-extract" "1" "October 10, 2023" "memoize-extract of Memoize v1.0.0" "User Manual"
+.nh
+.SH NAME
+.PP
+memoize-extract.pl, memoize-extract.py - Extract extern pages out of the
+PDF
+.SH SYNOPSIS
+.PP
+\f[B]memoize-extract.pl\f[R] [\f[I]OPTIONS\f[R]] \f[I]document.mmz\f[R]
+.PP
+\f[B]memoize-extract.py\f[R] [\f[I]OPTIONS\f[R]] \f[I]document.mmz\f[R]
+.SH DESCRIPTION
+.PP
+\f[B]memoize-extract\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
+Memoize dumps the created externs (boxes containing the typeset material
+to be reused) onto their own pages in the produced PDF file.
+It is the job of \f[B]memoize-extract\f[R] to extract these extern pages
+into separate PDF files.
+At subsequent compilations, Memoize will include those extern files into
+the document, without compiling their source again.
+.PP
+Memoize communicates with \f[B]memoize-extract\f[R] through file
+\f[I]document.mmz\f[R].
+When \f[I]document.tex\f[R] is compiled to produce
+\f[I]document.pdf\f[R], Memoize produces \f[I]document.mmz\f[R], which
+records which pages in the produced document are extern pages and to
+which extern files they should be extracted.
+Therefore, after compiling \f[I]document.tex\f[R], the externs should be
+extracted by \f[B]memoize-extract\f[R] \f[I]document.mmz\f[R].
+.PP
+\f[I]document.mmz\f[R] also records the expected width and height of
+each extern.
+In case of a mismatch, \f[B]memoize-extract\f[R] refuses to extract the
+page and removes the extern file if it already exist, and prints a
+warning message to the standard error.
+The script furthermore refuses to extract the page if a (c)c-memo
+associated to the extern does not exist, and to write to any file whose
+absolute path does not occur under the current directory or the
+directory set by TEXMFOUTPUT (in \f[I]texmf.cnf\f[R] or as an
+environment variable); TEXMFOUTPUT is also not allowed to point to the
+root directory, except on Windows, where it can only point to a drive
+root.
+.PP
+The Perl (.pl) and the Python (.py) version of the script are
+functionally equivalent.
+The Perl script requires library
+PDF::API2 (https://metacpan.org/pod/PDF::API2), and the Python script
+requires library pdfrw2 (https://pypi.org/project/pdfrw2).
+.SH OPTIONS
+.TP
+\f[B]-P, --pdf\f[R] \f[I]filename.pdf\f[R]
+The externs will be extracted from \f[I]filename.pdf\f[R].
+By default, they are extracted from \f[I]document.pdf\f[R].
+.TP
+\f[B]-p, --prune\f[R]
+Remove the extern pages from the PDF after extraction.
+.TP
+\f[B]-k, --keep\f[R]
+Do not modify the \f[I]document.mmz\f[R] to mark the externs as
+extracted.
+By default, they are commented out to prevent double extraction.
+.TP
+\f[B]-f, --force\f[R]
+Extract the extern even if the size-check fails.
+.TP
+\f[B]-l, --log\f[R] \f[I]filename\f[R]
+Log size mismatches to \f[I]filename\f[R] rather than to the standard
+error.
+.TP
+\f[B]-w, --warning-template\f[R] \f[I]string\f[R]
+Wrap the size mismatch warning text into the given template:
+\[rs]warningtext in the template will be replaced by the warning text.
+.TP
+\f[B]-q, --quiet\f[R]
+Don\[cq]t describe what\[cq]s happening.
+.TP
+\f[B]-e, --embedded\f[R]
+Prefix all messages to the standard output with the script name.
+.TP
+\f[B]-m, --mkdir\f[R]
+A paranoid \f[I]mkdir -p\f[R].
+(No extraction occurs, \f[I]document.mmz\f[R] is interpreted as a
+directory name.)
+.TP
+\f[B]-h, --help\f[R]
+Show help and exit.
+.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.1.
diff --git a/Master/texmf-dist/doc/man/man1/memoize-extract.man1.pdf b/Master/texmf-dist/doc/man/man1/memoize-extract.man1.pdf
new file mode 100644
index 00000000000..b3677fb5972
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/memoize-extract.man1.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/man/man1/memoize-extract.pl.1 b/Master/texmf-dist/doc/man/man1/memoize-extract.pl.1
new file mode 100644
index 00000000000..ebeb9dfc67e
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/memoize-extract.pl.1
@@ -0,0 +1 @@
+.so man1/doc/memoize-extract.1
diff --git a/Master/texmf-dist/doc/man/man1/memoize-extract.pl.man1.pdf b/Master/texmf-dist/doc/man/man1/memoize-extract.pl.man1.pdf
new file mode 100644
index 00000000000..b86276dea61
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/memoize-extract.pl.man1.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/man/man1/memoize-extract.py.1 b/Master/texmf-dist/doc/man/man1/memoize-extract.py.1
new file mode 100644
index 00000000000..ebeb9dfc67e
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/memoize-extract.py.1
@@ -0,0 +1 @@
+.so man1/doc/memoize-extract.1
diff --git a/Master/texmf-dist/doc/man/man1/memoize-extract.py.man1.pdf b/Master/texmf-dist/doc/man/man1/memoize-extract.py.man1.pdf
new file mode 100644
index 00000000000..e7f022ba814
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man1/memoize-extract.py.man1.pdf
Binary files differ