diff options
author | Karl Berry <karl@freefriends.org> | 2020-02-21 22:56:14 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2020-02-21 22:56:14 +0000 |
commit | d019eed60872773f44fc7884cda7cf41a126f99c (patch) | |
tree | 1bba8595a7946f5f0c7d7294e6aebb5dfe8e1f7d /Master/texmf-dist/doc/latex/nameauth/README.txt | |
parent | f7fd247772c2a77bffd50dfe8045b8441ca091e9 (diff) |
nameauth (21feb20)
git-svn-id: svn://tug.org/texlive/trunk@53863 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/nameauth/README.txt')
-rw-r--r-- | Master/texmf-dist/doc/latex/nameauth/README.txt | 84 |
1 files changed, 56 insertions, 28 deletions
diff --git a/Master/texmf-dist/doc/latex/nameauth/README.txt b/Master/texmf-dist/doc/latex/nameauth/README.txt index eba2ade9054..8a950701179 100644 --- a/Master/texmf-dist/doc/latex/nameauth/README.txt +++ b/Master/texmf-dist/doc/latex/nameauth/README.txt @@ -2,7 +2,7 @@ --------:| ---------------------------------------------------------------- nameauth:| Name authority mechanism for consistency in text and index Author:| Charles P. Schaum - E-mail:| charles dot schaum at comcast dot net + E-mail:| charles dot schaum@comcast.net License:| Released under the LaTeX Project Public License 1.3c or later See:| http://www.latex-project.org/lppl.txt @@ -29,14 +29,8 @@ www.ctan.org/tex-archive/macros/latex/contrib/nameauth Unpack nameauth.zip in an appropriate directory. -Note that the instructions below assume that you are using a kind of -Unix, BSD, Linux, Mac, or Cygwin under Microsoft Windows. If you have -a different operating environment, you will need to modify these -instructions to your own needs. Please be aware that this package is -designed to be stored in a UTF-8 encoded text file and built in a -Unicode-capable environment. - -If you have a make utility compatible with GNU make you can type +If you have a make utility compatible with GNU make, either in +GNU/Linux, a BSD variant, OSX, or Cygwin in Windows you can type make inst @@ -45,53 +39,87 @@ to install the package into your $TEXMFHOME tree or make install to install the package into your $TEXMFLOCAL tree for all users. +The latter requires sudo privileges. + +Other useful targets include: + +(release process) + +make release The default target, same as just ``make''. + +make clean Removes all intermediate files. Left are +the files listed above plus nameauth.sty. + +make distclean Leave only nameauth.dtx, examples.tex, +and Makefile. + +make zip Generate a zip file ready for distribution. + +(testing process) -Manually, you can generate the package files. First you generate the -installer driver, README, and style files, with a preliminary PDF: +make testing Release files, plus compiles examples.tex. + +make release ENGINE=<command> +Here, <command> can be pdflatex (default), +xelatex, lualatex, dvilualatex, or latex. + +make testing ENGINE=<command> See above. + +It is not necessary, however, to use GNU make. One can generate +the package files manually. Since the files nameauth.ins and README.txt +are contained in the .dtx file itself, the first step is to generate +the installer driver nameauth.ins, plus the file README.txt, which will +also trigger the extraction of nameauth.sty and produce the first pass of +the package documentation nameauth.pdf: pdflatex -shell-escape -recorder -interaction=batchmode nameauth.dtx -Next you generate the PDF with a table of contents and all cross-references -validated, so that the index entries will not move: +Next one adds a table of contents and all cross-references, this also +should finalize page numbers for glossary and index input files: pdflatex --recorder --interaction=nonstopmode nameauth.dtx -The next commands generate the glossary/index and final pdf file +The next commands generate the glossary/index output files: makeindex -q -s gglo.ist -o nameauth.gls nameauth.glo makeindex -q -s gind.ist -o nameauth.ind nameauth.idx + +The final two commands integrate the glossary (changes) and index: + pdflatex --recorder --interaction=nonstopmode nameauth.dtx pdflatex --recorder --interaction=nonstopmode nameauth.dtx -Normally you create the following manual installation directories for user: +Now one can either keep README.txt or rename it to README, e.g.: + +mv README.txt README + +Normally one creates the following directories for a user: $TEXMFHOME/source/latex/nameauth dtx file $TEXMFHOME/tex/latex/nameauth sty file $TEXMFHOME/doc/latex/nameauth pdf file, README, examples.tex -and you create the following manual installation directories for local site: +and creates the following directories for the local site: $TEXMFLOCAL/source/latex/nameauth dtx file $TEXMFLOCAL/tex/latex/nameauth sty file $TEXMFLOCAL/doc/latex/nameauth pdf file, README, examples.tex -The above environment variables often are /usr/local/texlive/texmf-local and -~/texmf. +The above environment variables often are /usr/local/texlive/texmf-local +and ~/texmf. -The make process normally renames the README.txt file created from the dtx file -to just README by using mv (move/rename utility in the *nix userland). Windows -distributions of TeX and LaTeX often keep the txt file as well. +The make process normally renames the README.txt file created from the +dtx file to just README by using mv (move / rename utility in the *nix +userland). Windows distributions of TeX and LaTeX often keep the txt file +because of using file extensions instead of ``magic numbers'' to identify +files. -Run mktexlsr with the appropriate level of permissions to complete the install. +Run mktexlsr with the appropriate level of permissions to complete the +install. Testing notes: -This package and documentation work and build with latex, lualatex, pdflatex, -and xelatex. It can be used with makeindex/texindy. - -For testing, the make file permits one to change the typesetting engine -on the command line. The default is to build the package and documentation -with pdflatex. See the make file for details. +See the nameauth manual. License |