summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/tex-ini-files/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/generic/tex-ini-files/README.md')
-rw-r--r--Master/texmf-dist/doc/generic/tex-ini-files/README.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/generic/tex-ini-files/README.md b/Master/texmf-dist/doc/generic/tex-ini-files/README.md
new file mode 100644
index 00000000000..2807e9b07ee
--- /dev/null
+++ b/Master/texmf-dist/doc/generic/tex-ini-files/README.md
@@ -0,0 +1,55 @@
+# Model TeX format creation files
+
+This bundle provides a collection of model `.ini` files for
+creating TeX formats. These files are commonly used to introduced
+distribution-dependent variations in formats. They are also used
+to allow existing format source files to be used with newer
+engines, for example to adapt the plain e-TeX source file to
+work with XeTeX and LuaTeX.
+
+## Shared configuration
+
+The file `pdftexconfig.dat` contains common settings for pdfTeX
+and LuaTeX, most of which are concerned with direct PDF output.
+These settings are given in a key-value format and are named
+based on the pdfTeX 1.40 primitives. The values for the settings
+themselves is taken from the standard values in TeX Live 2010
+with the paper size set as A4.
+
+Loading this data in pdfTeX is achieved by `pdftexconfig.tex`,
+whereas for LuaTeX the file `luatexconfig.tex` is needed. Both
+of these files will load the shared data file and assign the
+appropriate primitives.
+
+The loaders recognise the marker control sequence `\dvimode`.
+If this is defined, the loaders will set the format to produce
+DVI file, and otherwise will select direct PDF output. The loader
+will then undefine `\dvimode`.
+
+## History
+
+The use of `.ini` files for building formats has developed over
+some time. The initial versions of the files collected here were
+taken from TeX Live 2015, and thus carry forward long-standing
+behaviours from this system. Initial modifications were made
+to allow for significant changes in LuaTeX primitive support
+between TeX Live 2015 and TeX Live 2016.
+
+The files provided here are designed to work with other support
+files and engines available from late 2015 onward, in particular:
+- pdfTeX v1.40+
+- LuaTeX v0.80+
+- XeTeX v0.99992+
+- LaTeX2e 2015-01-01 onward
+- unicode-data v1.0+
+
+Major changes:
+- 2016-02-27 First version of bundle
+
+A full history of this bundle is available from
+https://github.com/josephwright/tex-ini-files
+
+## Legal
+
+The files provided here were originally written by various
+authors and are all marked as public domain.