summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/texdoc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/texdoc/README.md')
-rw-r--r--Master/texmf-dist/doc/support/texdoc/README.md104
1 files changed, 104 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/texdoc/README.md b/Master/texmf-dist/doc/support/texdoc/README.md
new file mode 100644
index 00000000000..19b0208825a
--- /dev/null
+++ b/Master/texmf-dist/doc/support/texdoc/README.md
@@ -0,0 +1,104 @@
+# Texdoc (v3.0)
+
+[![Build Status](https://travis-ci.org/TeX-Live/texdoc.svg?branch=master)](https://travis-ci.org/TeX-Live/texdoc)
+
+Texdoc is a command line program to find and view documentation in TeX Live.
+
+## General Information
+
+* Website: <https://www.tug.org/texdoc/>
+* Repository: <https://github.com/TeX-Live/texdoc/>
+* Mailing list: <texdoc@tug.org>
+
+## Using Texdoc
+
+Texdoc is part of the TeX Live distribution. Generally, you don't have to install it yourself.
+
+If you want to try/test the develop version, please see below.
+
+## How to Install the Develop Version
+
+### Using Bundler
+
+The easiest way to install the develop version of Texdoc is using [Bundler](https://bundler.io/) and [Rake](https://github.com/ruby/rake):
+
+```
+$ bundle install
+$ rake install
+```
+
+If you want to uninstall the develop version (to use the TeX Live version), just try:
+
+```
+$ rake uninstall
+```
+
+### Installing manually
+
+Here, `$TEXDOC` means the path to the texdoc dev sources you cloned (or downloaded), and `$TEXMFHOME` denotes your personal TEXMF tree (you can get its location with `kpsewhich --var-value TEXMFHOME`).
+
+* **The command.** Symlink or copy `$TEXDOC/script` as `$TEXMFHOME/scripts/texdoc`.
+* **The configuration file.** Symlink or copy `$TEXDOC/texdoc.cnf` as `$TEXMFHOME/texdoc/texdoc-dist.cnf` (notice the `-dist` part). It will completely override the other configuration files except `$TEXMFHOME/texdoc/texdoc.cnf` which you can still use for you personal settings.
+
+You can make sure that the right files are used by running `texdoc --files`: the first line contains the full path to the version of used `texdoclib.tlu`, and the rest lists the configuration files in use.
+
+## Files in This Repository
+
+- `doc/` contains the documentation,
+- `script/` contains the source code,
+- `spec/` is a directory for testing scripts, and
+- `texdoc.cnf` is the default configuration file.
+
+## Building and Testing
+
+Many building tasks are defined as [Rake](https://github.com/ruby/rake) tasks:
+
+### Generating all documentation
+
+This will generate both the PDF and the manpage in `doc/` directory.
+
+```
+$ rake doc
+```
+
+### Generating a pre-hashed cache file
+
+This will generate a pre-hashed cache file `script/Data.tlpdb.lua`. This task have to be done under a TeX Live setup with tlpdb.
+
+```
+$ rake gen_datafile
+```
+
+### Running all tests
+
+This will run all tests in `spec/` directory.
+
+```
+$ rake test
+```
+
+### Showing all available tasks
+
+This will show all available tasks with a short discription.
+
+```
+$ rake -T
+```
+
+## Further Information
+
+More specific information (e.g. TODO) can be found in the Wiki of our GitHub repository. Please visit:
+
+* <https://github.com/TeX-Live/texdoc/wiki>
+
+## Copyright and License
+
+Copyright 2008-2018 Manuel Pégourié-Gonnard, Takuto Asakura, Karl Berry, and Norbert Preining. All rights reserved.
+
+This package is distributed under the terms of the GNU General Public License as published by the Free Software Foundation, either [version 3](./COPYING) of the License, or (at your option) any later version.
+
+Previous work (texdoc program) in the public domain:
+
+* Contributions from Reinhard Kotucha (2008).
+* First texlua versions by Frank Küster (2007).
+* Original shell script by Thomas Esser, David Aspinall, and Simon Wilkinson.