| 1 |
xkeyval v2.10 |
| 2 |
------------ |
| 3 |
|
| 4 |
This package is an extension of the keyval package by David Carlisle |
| 5 |
and offers additional macros for setting keys and declaring and |
| 6 |
setting class or package options. This distribution also includes |
| 7 |
the following additional packages: |
| 8 |
|
| 9 |
xkvview v1.4a : viewer utility for package programmers |
| 10 |
xkvltxp v1.3 : LaTeX kernel patch to allow expandable macros in |
| 11 |
package options |
| 12 |
pst-xkey v1.6 : specialization of the xkeyval package for PSTricks |
| 13 |
packages |
| 14 |
|
| 15 |
See for more information the pdf documentation of this package. |
| 16 |
|
| 17 |
|
| 18 |
Installation |
| 19 |
------------ |
| 20 |
|
| 21 |
First check whether this package can be installed by the |
| 22 |
distribution that you use, since that will simplify installation. |
| 23 |
For manual installations, the structure and supposed location in a |
| 24 |
TDS compliant TeX-tree is shown in the overview below. In words, |
| 25 |
keyval.tex, pst-xkey.tex, xkvutils.tex, xkvtxhdr.tex and xkeyval.tex |
| 26 |
should be available to TeX and LaTeX; pst-xkey.sty, xkeyval.sty, |
| 27 |
xkvview.sty and xkvltxp.sty should be available to LaTeX. The package |
| 28 |
to which a specific run file belongs, is denoted in between square |
| 29 |
brackets. Don't forget to update your filename database after installing |
| 30 |
the files. |
| 31 |
|
| 32 |
CTAN:/macros/latex/contrib/xkeyval: official location |
| 33 |
| |
| 34 |
|- readme : should not be installed |
| 35 |
|- doc |
| 36 |
| `- xkeyval.pdf : /doc/latex/xkeyval |
| 37 |
|- run |
| 38 |
| |- keyval.tex : /tex/generic/xkeyval [xkeyval] |
| 39 |
| |- xkvutils.tex : /tex/generic/xkeyval [xkeyval] |
| 40 |
| |- pst-xkey.sty : /tex/latex/xkeyval [pst-xkey] |
| 41 |
| |- pst-xkey.tex : /tex/generic/xkeyval [pst-xkey] |
| 42 |
| |- xkeyval.sty : /tex/latex/xkeyval [xkeyval] |
| 43 |
| |- xkeyval.tex : /tex/generic/xkeyval [xkeyval] |
| 44 |
| |- xkvview.sty : /tex/latex/xkeyval [xkvview] |
| 45 |
| |- xkvltxp.sty : /tex/latex/xkeyval [xkvltxp] |
| 46 |
| `- xkvtxhdr.tex : /tex/generic/xkeyval [xkeyval] |
| 47 |
`- source |
| 48 |
`- xkeyval.dtx : /source/latex/xkeyval |
| 49 |
|
| 50 |
The package includes pregenerated run and doc files, but you can |
| 51 |
reproduce them from the source if necessary. See the first lines |
| 52 |
of xkeyval.dtx for information how to do this. Example files can |
| 53 |
be produced by running the file xkeyval.dtx with LaTeX once. |
| 54 |
|
| 55 |
See the documentation of your LaTeX distribution or the TeX |
| 56 |
Frequently Asked Questions for more information on installing |
| 57 |
xkeyval into your LaTeX distribution |
| 58 |
(http://www.tex.ac.uk/cgi-bin/texfaq2html?label=instpackages). |
| 59 |
|
| 60 |
|
| 61 |
License |
| 62 |
------- |
| 63 |
|
| 64 |
Copyright (C) 2004-2022 Hendri Adriaens |
| 65 |
|
| 66 |
This work may be distributed and/or modified under the |
| 67 |
conditions of the LaTeX Project Public License, either version 1.3 |
| 68 |
of this license or (at your option) any later version. |
| 69 |
The latest version of this license is in |
| 70 |
http://www.latex-project.org/lppl.txt |
| 71 |
and version 1.3 or later is part of all distributions of LaTeX |
| 72 |
version 2003/12/01 or later. |
| 73 |
|
| 74 |
This work has the LPPL maintenance status "maintained". |
| 75 |
|
| 76 |
This Current Maintainer of this work is Hendri Adriaens and David Carlisle. |
| 77 |
|
| 78 |
This work consists of the file xkeyval.dtx and derived files |
| 79 |
keyval.tex, xkvtxhdr.tex, xkeyval.sty, xkeyval.tex, xkvview.sty, |
| 80 |
xkvltxp.sty, xkvutils.tex, pst-xkey.tex, pst-xkey.sty, xkveca.cls, |
| 81 |
xkvecb.cls, xkvesa.sty, xkvesb.sty, xkvesc.sty, xkvex1.tex, |
| 82 |
xkvex2.tex, xkvex3.tex and xkvex4.tex. |
| 83 |
|
| 84 |
The following files constitute the xkeyval bundle and must be |
| 85 |
distributed as a whole: readme, xkeyval.pdf, keyval.tex, |
| 86 |
pst-xkey.sty, pst-xkey.tex, xkeyval.sty, xkeyval.tex, xkvview.sty, |
| 87 |
xkvltxp.sty, xkvtxhdr.tex, xkvutils.tex, pst-xkey.dtx and xkeyval.dtx. |