diff options
Diffstat (limited to 'Master/texmf-dist/doc/man/man1')
-rw-r--r-- | Master/texmf-dist/doc/man/man1/memoize-clean.1 | 4 | ||||
-rw-r--r-- | Master/texmf-dist/doc/man/man1/memoize-clean.man1.pdf | bin | 17977 -> 17991 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/man/man1/memoize-clean.pl.man1.pdf | bin | 2298 -> 2298 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/man/man1/memoize-clean.py.man1.pdf | bin | 2298 -> 2298 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/man/man1/memoize-extract.1 | 92 | ||||
-rw-r--r-- | Master/texmf-dist/doc/man/man1/memoize-extract.man1.pdf | bin | 23222 -> 27664 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/man/man1/memoize-extract.pl.man1.pdf | bin | 2298 -> 2298 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/man/man1/memoize-extract.py.man1.pdf | bin | 2298 -> 2298 bytes |
8 files changed, 71 insertions, 25 deletions
diff --git a/Master/texmf-dist/doc/man/man1/memoize-clean.1 b/Master/texmf-dist/doc/man/man1/memoize-clean.1 index 328349c41b4..88b292fc4f9 100644 --- a/Master/texmf-dist/doc/man/man1/memoize-clean.1 +++ b/Master/texmf-dist/doc/man/man1/memoize-clean.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 3.0.1 +.\" Automatically generated by Pandoc 3.1.5 .\" .\" Define V font for inline verbatim, using C font in formats .\" that render this, and otherwise B font. @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "memoize-clean" "1" "October 10, 2023" "memoize-clean of Memoize v1.0.0" "User Manual" +.TH "memoize-clean" "1" "January 02, 2024" "memoize-clean of Memoize v1.1.0" "User Manual" .nh .SH NAME .PP diff --git a/Master/texmf-dist/doc/man/man1/memoize-clean.man1.pdf b/Master/texmf-dist/doc/man/man1/memoize-clean.man1.pdf Binary files differindex ef8d5cab9d4..f66aafe1f29 100644 --- a/Master/texmf-dist/doc/man/man1/memoize-clean.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/memoize-clean.man1.pdf 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 Binary files differindex fed432810ec..33776be77ff 100644 --- a/Master/texmf-dist/doc/man/man1/memoize-clean.pl.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/memoize-clean.pl.man1.pdf 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 Binary files differindex 9c1844e1a95..e2765a18cf7 100644 --- a/Master/texmf-dist/doc/man/man1/memoize-clean.py.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/memoize-clean.py.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/memoize-extract.1 b/Master/texmf-dist/doc/man/man1/memoize-extract.1 index 916d402c7c0..0021aefbc24 100644 --- a/Master/texmf-dist/doc/man/man1/memoize-extract.1 +++ b/Master/texmf-dist/doc/man/man1/memoize-extract.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 3.0.1 +.\" Automatically generated by Pandoc 3.1.5 .\" .\" Define V font for inline verbatim, using C font in formats .\" that render this, and otherwise B font. @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "memoize-extract" "1" "October 10, 2023" "memoize-extract of Memoize v1.0.0" "User Manual" +.TH "memoize-extract" "1" "January 02, 2024" "memoize-extract of Memoize v1.1.0" "User Manual" .nh .SH NAME .PP @@ -47,18 +47,19 @@ 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] may also be given as document* or +\f[I]document.tex\f[R]. +When environment variable \f[I]TEXMF_OUTPUT_DIRECTORY\f[R] is set, this +filename is relative to the output directory specified by this variable. +.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. +The script also refuses to extract the page if a (c)c-memo associated to +the extern does not exist. +See also section SECURITY. .PP The Perl (.pl) and the Python (.py) version of the script are functionally equivalent. @@ -79,33 +80,78 @@ 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, --format\f[R] \f[I]latex\f[R]|\f[I]plain\f[R]|\f[I]context\f[R] +When this option is given, the script assumes that it was called from +within a TeX compilation of a document in the given format: it prefixes +all output by the script name, and creates a log file +\f[I]document.mmz.log\f[R], which receives any extraction-related +warnings and errors. +.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.) +directory name, which may end in any suffix; no suffix mangling is +performed.) +.TP +\f[B]-V, --version\f[R] +Show the Memoize version number and exit. .TP \f[B]-h, --help\f[R] Show help and exit. +.SH SECURITY +.PP +This script respects the restrictions on file input and output imposed +by the TeX configuration, more precisely, the variables +\f[I]openin_any\f[R] and \f[I]openout_any\f[R] of the \f[B]kpathsea\f[R] +library (https://tug.org/kpathsea). +You can inspect the values of these variables by executing +`\f[B]kpsewhich\f[R] -var-value=openin_any' and `\f[B]kpsewhich\f[R] +-var-value=openout_any'. +The interpretation is as follows: .TP -\f[B]-V, --version\f[R] -Show the Memoize version number and exit. +\f[B]a\f[R] (or \f[B]y\f[R] or \f[B]1\f[R]) any +Allows any file to be opened. +.TP +\f[B]r\f[R] (or \f[B]n\f[R] or \f[B]0\f[R]) restricted +Means disallowing special file names. +.TP +\f[B]p\f[R] (or any other value) paranoid +Means being really paranoid: disallowing special file names and +restricting input/output files to be in or below the working directory +or the directory specified by \f[I]TEXMFOUTPUT\f[R] or +\f[I]TEXMF_OUTPUT_DIRECTORY\f[R]. +\f[I]TEXMFOUTPUT\f[R] may be set either in \f[I]texmf.cnf\f[R] (e.g.\ by +\f[B]tlmgr\f[R]) or as an environment variable. +\f[I]TEXMF_OUTPUT_DIRECTORY\f[R] may only be set as an environment +variables; it is automatically set by TeX when called by +\f[I]-output-directory\f[R] option (starting in TeXLive 2024). +.SH EXIT STATUS +.TP +\f[B]0\f[R] +The externs were successfully extracted. +This exit code is returned even if no externs need to be extracted, or +if \f[I]document.mmz\f[R] does not exist. +.TP +\f[B]10\f[R] +A warning also reported back to the compilation when given option +\f[B]--format\f[R]. +Currently, either: (i) size-mismatch; (ii) a non-existing associated +(c)c-memo file; or (iii) unavailable \f[I]kpsewhich\f[R]. +.TP +\f[B]11\f[R] +An error also reported back to the compilation when given option +\f[B]--format\f[R]. +Currently, either: (i) a currupted document PDF, or (ii) a kpathsea +permission error. +.PP +Other exit codes are as produced by the underlying scripting language +(Perl of Python). .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 Binary files differindex b3677fb5972..d4a86aac163 100644 --- a/Master/texmf-dist/doc/man/man1/memoize-extract.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/memoize-extract.man1.pdf 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 Binary files differindex b86276dea61..ccb2da9f2a3 100644 --- a/Master/texmf-dist/doc/man/man1/memoize-extract.pl.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/memoize-extract.pl.man1.pdf 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 Binary files differindex e7f022ba814..5a73d2857ce 100644 --- a/Master/texmf-dist/doc/man/man1/memoize-extract.py.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/memoize-extract.py.man1.pdf |