summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/filemod/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/filemod/README
Initial commit
Diffstat (limited to 'macros/latex/contrib/filemod/README')
-rw-r--r--macros/latex/contrib/filemod/README58
1 files changed, 58 insertions, 0 deletions
diff --git a/macros/latex/contrib/filemod/README b/macros/latex/contrib/filemod/README
new file mode 100644
index 0000000000..6f48dd2195
--- /dev/null
+++ b/macros/latex/contrib/filemod/README
@@ -0,0 +1,58 @@
+The filemod Package
+~~~~~~~~~~~~~~~~~~~
+Copyright (C) Martin Scharrer <martin@scharrer-online.de>
+
+This package provides macros to read and compare the modification dates
+of files. These files can be .tex files, images or other files as long as they can be
+found by the LaTeX compiler. It uses the \pdffilemoddate primitive of pdfLaTeX
+to receive the file modification date as PDF date string, parses it and returns
+the value to the user.
+The functionality is provided by purely expandable macros or by faster but non-expandable ones.
+
+This package will work with LaTeX and plain eTeX as long pdf(La)TeX (in
+PDF or DVI mode) or Lua(La)TeX is used. Xe(La)TeX is not supported because it
+does not provide \pdffilemoddate.
+
+Examples:
+ % Prints file modification date and time of main file
+ \filemodprint{\jobname}
+
+ % Include newest of a set of files:
+ \input{\filemodNewest{{file1}{file2}{file3}}}
+
+ % Include newest of a set of images:
+ % (\includegraphics doesn't expand its fully before parsing it)
+ \FilemodNewest{{file1}{file2}{file3}}
+ \includegraphics{\filemodresultfile}
+
+
+REQUIREMENTS:
+=============
+pdflatex v1.30.0 or later is required.
+Alternative LuaTeX can be used together with the `pdftexcmds` package.
+
+
+INSTALLATION:
+=============
+Compile the DTX file (with included INS file) through pdflatex:
+
+ pdflatex filemod.dtx
+ pdflatex filemod.dtx
+ pdflatex filemod.dtx
+
+Copy the files to the following directories which must be created beforehand.
+Example for a Unix/Linux OS, change accordantly for MS Windows and Mac, e.g.
+copy it using a graphics interface.
+
+ cp filemod*.sty ${TEXMF}/tex/latex/filemod/
+ cp filemod*.tex ${TEXMF}/tex/generic/filemod/
+
+OPTIONAL:
+The documentation can be installed by:
+ cp filemod.pdf README ${TEXMF}/doc/latex/filemod/
+
+The source can be installed by:
+ cp filemod.dtx ${TEXMF}/source/latex/filemod/
+
+The TEXMF is /usr/local/texlive/2010/texmf-dist, ${HOME}/texmf or similar.
+