summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/nameauth/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/nameauth/README.txt')
-rw-r--r--Master/texmf-dist/doc/latex/nameauth/README.txt90
1 files changed, 90 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/nameauth/README.txt b/Master/texmf-dist/doc/latex/nameauth/README.txt
new file mode 100644
index 00000000000..1063131bddd
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/nameauth/README.txt
@@ -0,0 +1,90 @@
+|
+--------:| ----------------------------------------------------------------
+nameauth:| Name authority mechanism for consistency in text and index
+ Author:| Charles P. Schaum
+ E-mail:| charles dot schaum at comcast dot net
+ License:| Released under the LaTeX Project Public License v1.3c or later
+ See:| http://www.latex-project.org/lppl.txt
+
+Short description:
+
+The nameauth package automates the formatting and indexing of names.
+This aids the use of a name authority and the process of textual reordering
+and revision without needing to retype name references.
+
+Files Distribution
+
+README This file
+nameauth.pdf Documentation
+
+Makefile Automates building with GNU make 3.81
+nameauth.dtx Documented LaTeX file containing both code and documentation
+
+Installation
+
+Unpack nameauth.zip in an appropriate directory.
+
+Note that the instructions below assume that you are using a *nix-
+compatible computer. If that is otherwise, you will need to modify
+these instructions to your needs.
+
+If you have a make utility compatible with GNU make you can type
+
+make inst
+
+to install the package into your $TEXMFHOME tree or
+
+make install
+
+to install the package into your $TEXMFLOCAL tree for all users.
+
+Manually, you can generate the package files. First you generate the
+installer driver, README, and style files, with a preliminary 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:
+
+pdflatex --recorder --interaction=nonstopmode nameauth.dtx
+
+The next commands generate the glossary/index and final pdf file
+
+makeindex -q -s gglo.ist -o nameauth.gls nameauth.glo
+makeindex -q -s gind.ist -o nameauth.ind nameauth.idx
+pdflatex --recorder --interaction=nonstopmode nameauth.dtx
+pdflatex --recorder --interaction=nonstopmode nameauth.dtx
+
+Normally you create the following manual installation directories for user:
+
+$TEXMFHOME/source/latex/nameauth dtx file
+$TEXMFHOME/tex/latex/nameauth sty file
+$TEXMFHOME/doc/latex/nameauth pdf file
+
+and you create the following manual installation directories for local site:
+
+$TEXMFLOCAL/source/latex/nameauth dtx file
+$TEXMFLOCAL/tex/latex/nameauth sty file
+$TEXMFLOCAL/doc/latex/nameauth pdf file
+
+The above environment variables often are /usr/local/texlive/texmf-local and
+~/texmf.
+
+Run mktexlsr with the appropriate level of permissions to complete the install.
+
+Testing notes:
+
+This packages works and builds with latex, lualatex, pdflatex, and xelatex.
+It can be used with makeindex and texindy. The documentation builds with
+lualatex, pdflatex, and xelatex, using makeindex.
+
+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.
+
+License
+
+This material is subject to the LaTeX Project Public License:
+http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html
+
+Happy TeXing!