summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/nameauth/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/nameauth/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/nameauth/README.md71
1 files changed, 37 insertions, 34 deletions
diff --git a/Master/texmf-dist/doc/latex/nameauth/README.md b/Master/texmf-dist/doc/latex/nameauth/README.md
index 2ea1c5952b3..0ae72377ac8 100644
--- a/Master/texmf-dist/doc/latex/nameauth/README.md
+++ b/Master/texmf-dist/doc/latex/nameauth/README.md
@@ -11,15 +11,16 @@ editing process without needing to retype name references.
|`nameauth.dtx`|commented style file; source file |
|`Makefile` |For use with GNU make; with source file|
|`nameauth.ins`|installation driver (generated file) |
-|`nameauth.pdf`|Documentation (generated file) |
-|`README.md` |This file (generated file) |
-|`examples.tex`|example macros (generated file) |
+|`nameauth.sty`|style file (generated file) |
+|`nameauth.pdf`|Documentation (generated file) |
+|`README.md` |This file (generated file) |
+|`examples.tex`|example macros (generated file) |
# Obtaining the Package
1. Packaged in your current TeX distrbution: See the appropriate documentation.
-2. Otherwise, download `nameauth.zip` from [CTAN](www.ctan.org/tex-archive/macros/latex/contrib/nameauth).
+2. Otherwise, download `nameauth.zip` from [CTAN](http://mirrors.ctan.org/macros/latex/contrib/nameauth.zip).
3. Unpack `nameauth.zip` in an appropriate directory.
@@ -31,54 +32,56 @@ editing process without needing to retype name references.
This method requires GNU `make` on a POSIX-compliant environment, such as GNU/Linux, various BSD flavors, perhaps MacOS (e.g., with various porting systems), and even Cygwin on Windows.
-0. A quick install in one's home directory using some of the included files from the `zip` archive just requires the following steps:
+ * We use the LaTeX installation on the host machine to build the package. When using `make`, any `dvi` files that are created will also be converted to `pdf` format.
- tex nameauth.dtx
- make inst
+1. Type `make` to generate the release files using `pdflatex`.
-Otherwise we use the LaTeX installation on the host machine to build the package. When using `make`, any `dvi` files that are created will also be converted to `pdf` format.
+2. To use another LaTeX engine, type one of the following:
-1. Type `make distclean release` to generate the release files using `pdflatex`.
-
-2. To use another TeX engine, type one of the following:
- make ENGINE=latex
+ make ENGINE=xelatex
make ENGINE=lualatex
make ENGINE=dvilualatex
- make ENGINE=xelatex
+ make ENGINE=latex
3. Type `make inst` to install the files in the user's personal TDS-compliant directory tree.
4. Type `sudo make install` to install the files in the system-wide, local TDS-compliant directory tree.
+5. One can include multiple make targets on the command line, but that goes beyond the scope of this document and is intended for experienced users.
+
## Manual Compilation
Otherwise, the following steps are used for manual installation. See the general information at the [TeX FAQ](https://www.texfaq.org/FAQ-installthings).
-0. To use some of the included files from the `zip` archive and only extract files from the `dtx` file, just do the following step and proceed to installation:
-
- tex nameauth.dtx
-
1. To build the package on the host system, generate the installation files and a copy of the documentation without the table of contents and cross-references. We use `pdflatex` by default:
pdflatex --shell-escape --recorder --interaction=batchmode nameauth.dtx
-2. Generate the TOC and cross-references for the documentation:
+2. This will generate the following files:
+
+ nameauth.ins (complete)
+ nameauth.sty (complete)
+ nameauth.pdf (incomplete; do steps 3 through 5)
+ README.md (complete)
+ examples.tex (complete)
+
+3. Generate the TOC and cross-references for the documentation:
pdflatex --recorder --interaction=nonstopmode nameauth.dtx
-3. Generate the index files using `makeindex`:
+4. Generate the index files using `makeindex`:
makeindex -q -s gglo.ist -o nameauth.gls nameauth.glo
makeindex -q -s gind.ist -o nameauth.ind nameauth.idx
-4. Integrate the glossary (changes) and index into the documentation. The second run updates the TOC:
+5. Integrate the glossary (changes) and index into the documentation. The second run updates the TOC:
pdflatex --recorder --interaction=nonstopmode nameauth.dtx
pdflatex --recorder --interaction=nonstopmode nameauth.dtx
-One can substitute, e.g., `latex`, `xelatex`, `lualatex`, and `dvilualatex` for `pdflatex`, but the documentation may look different in some cases.
+One can substitute, e.g., `xelatex`, `lualatex`, `dvilualatex`, and `latex`, for `pdflatex`, but the documentation may look different in some cases.
-## File Installation
+## Manual File Installation
Different TeX distributions have somewhat different ways to store TDS-compliant configuration and package data. See, for example, [MikTeX](https://miktex.org/kb/texmf-roots) and the [TeX FAQ](https://www.texfaq.org/FAQ-privinst). Two approaches below conform generally to a Unix-based system:
@@ -86,11 +89,11 @@ Different TeX distributions have somewhat different ways to store TDS-compliant
`TEXMFHOME` is a variable that points to the root of a TDS-compliant directory tree available to a user. Use `kpsewhich --var-value TEXMFHOME` to obtain its value. Quite often it is equivalent to `$HOME/texmf`. The dollar sign in front of the variable denotes the value of the variable instead of its name. So if `$HOME` is `/home/bob`, then `$TEXMFHOME` would be `/home/bob/texmf`, and we can understand the following paths to be under that directory:
-|Path |Description |
-|----------------------------------|---------------------------------------|
-|`$TEXMFHOME/source/latex/nameauth`|`ins` and `dtx` files, Makefile |
-|`$TEXMFHOME/tex/latex/nameauth` |`sty` file |
-|`$TEXMFHOME/doc/latex/nameauth` |`pdf` file, `README.md`, `examples.tex`|
+|Path |Description |
+|----------------------------------|----------------------------------------|
+|`$TEXMFHOME/source/latex/nameauth`|`ins` and `dtx` files, Makefile |
+|`$TEXMFHOME/tex/latex/nameauth` |`sty` file |
+|`$TEXMFHOME/doc/latex/nameauth` |`pdf` file, `README.md`, `examples.tex` |
On older TeX distributions, run `mktexlsr` on $TEXMFHOME to complete the install process.
@@ -98,11 +101,11 @@ On older TeX distributions, run `mktexlsr` on $TEXMFHOME to complete the install
`TEXMFLOCAL` is a variable that points to the root of a TDS-compliant directory tree available to all users on a local site, system-wide installation. Use `kpsewhich --var-value TEXMFLOCAL` to obtain its value. See the [TeX FAQ](https://www.texfaq.org/FAQ-what-TDS). We can understand the following paths to be under that directory:
-|Path |Description |
-|-----------------------------------|---------------------------------------|
-|`$TEXMFLOCAL/source/latex/nameauth`|`ins` and `dtx` files, Makefile |
-|`$TEXMFLOCAL/tex/latex/nameauth` |`sty` file |
-|`$TEXMFLOCAL/doc/latex/nameauth` |`pdf` file, `README.md`, `examples.tex`|
+|Path |Description |
+|-----------------------------------|----------------------------------------|
+|`$TEXMFLOCAL/source/latex/nameauth`|`ins` and `dtx` files, Makefile |
+|`$TEXMFLOCAL/tex/latex/nameauth` |`sty` file |
+|`$TEXMFLOCAL/doc/latex/nameauth` |`pdf` file, `README.md`, `examples.tex` |
Run `mktexlsr` with the appropriate permissions on `$TEXMFLOCAL` to complete the install process.
@@ -141,7 +144,7 @@ The manual is also a test suite.
# Copyright
-Copyright (C) 2020 by Charles P. Schaum <charles[dot]schaum@comcast.net>
+Copyright (C) 2021 by Charles P. Schaum <charles[dot]schaum@comcast.net>
-------------------------------------------------------
This file may be distributed and/or modified under the
@@ -149,7 +152,7 @@ conditions of the LaTeX Project Public License, either version 1.3
of this license or (at your option) any later version.
The latest version of this license is in:
- [http://www.latex-project.org/lppl.txt](http://www.latex-project.org/lppl.txt)
+ [http://www.latex-project.org/lppl.txt](https://www.latex-project.org/lppl.txt)
and version 1.3 or later is part of all distributions of LaTeX
version 2005/12/01 or later.