summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2021-08-03 20:44:46 +0000
committerKarl Berry <karl@freefriends.org>2021-08-03 20:44:46 +0000
commitfe7ff0a0d1835123521025ee969717c5ee858b3c (patch)
treec3def8b3ebe52589372dfa5a2b4c59d5ff74a9dc /Master/texmf-dist/doc/latex
parent533b01e11248a6e6f0c54fbb9ad447defd732f0b (diff)
graphicscache (3aug21)
git-svn-id: svn://tug.org/texlive/trunk@60150 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r--Master/texmf-dist/doc/latex/graphicscache/LICENSE29
-rw-r--r--Master/texmf-dist/doc/latex/graphicscache/README.md72
-rw-r--r--Master/texmf-dist/doc/latex/graphicscache/graphicscache.pdfbin0 -> 242162 bytes
3 files changed, 101 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/graphicscache/LICENSE b/Master/texmf-dist/doc/latex/graphicscache/LICENSE
new file mode 100644
index 00000000000..189aad77d38
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/graphicscache/LICENSE
@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2018, Max Schwarz
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/Master/texmf-dist/doc/latex/graphicscache/README.md b/Master/texmf-dist/doc/latex/graphicscache/README.md
new file mode 100644
index 00000000000..7bcb689121e
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/graphicscache/README.md
@@ -0,0 +1,72 @@
+# graphicscache
+
+This LaTeX package provides caching of `\includegraphics` calls, with several
+useful effects:
+
+* Recompilations are much faster (10x speedup observed)
+* Images can be postprocessed with `ghostscript` before inclusion, thus:
+ * Automatic downscaling to specified DPI
+ * Automatic JPEG compression with configurable quality
+ * Much smaller files (e.g. 10MB instead of 150MB)!
+
+Note: Due to the one-by-one invocation of `pdflatex` and `ghostscript` for
+each graphics element, the first compilation is typically slower than usual.
+
+Note: graphicscache needs the `\write18` call (also called shell escape). This
+is a security risk if you have untrusted TeX sources.
+
+graphicscache supports **PDFLaTeX** and **LuaLaTeX**, **XeLaTeX** is not supported.
+
+## Quickstart
+
+Compile the package using
+
+ latex graphicscache.ins
+
+to generate the file `graphicscache.sty`, which you should place in your TeX
+input path. On Unix systems, this can be done by:
+
+ mkdir -p ~/texmf/tex/latex/graphicscache
+ cp graphicscache.sty ~/texmf/tex/latex/graphicscache/
+ texhash
+
+Or just drop the graphicscache.sty next to your TeX document.
+
+Activate caching with
+
+ \usepackage{graphicscache}
+
+and you are finished. Remember to compile your document with `-shell-escape`,
+like
+
+ pdflatex -shell-escape paper.tex
+
+Most LaTeX editors allow you to enable shell escape in their settings.
+
+Your PDF should now re-compile faster and be significantly smaller!
+
+## Releasing
+
+Another feature is creating a "release" tarball containing your TeX sources
+and the downscaled images. **NOTE**: This is not required for using the caching
+& compression features of graphicscache!
+
+Just use the `release.sh` shell script in your source
+directory. In this case it is recommended to place the `graphicscache.sty` file
+in your source tree, since your release target will probably not have it.
+
+ # first copy graphicscache.sty and release.sh into your paper directory
+ cp ...
+
+ # then release!
+ bash release.sh paper.tex
+
+After checking `test_release/submission.pdf`, the file `release.tar` can be uploaded
+to arXiv (they will extract it automatically).
+
+## Documentation
+
+For more information, check the package documentation, which you can generate
+with:
+
+ pdflatex graphicscache.dtx
diff --git a/Master/texmf-dist/doc/latex/graphicscache/graphicscache.pdf b/Master/texmf-dist/doc/latex/graphicscache/graphicscache.pdf
new file mode 100644
index 00000000000..27682695fe1
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/graphicscache/graphicscache.pdf
Binary files differ