summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2023-04-05 20:09:08 +0000
committerKarl Berry <karl@freefriends.org>2023-04-05 20:09:08 +0000
commit93570294d6aa702f5ac83233dbacda328ea8fa28 (patch)
tree0abe1922134288130aaccae5e10bc78e51795b2b /Master/texmf-dist/doc/support
parentebd6a55d07b38530ea441b619d12f712f2652da8 (diff)
texfindpkg (5apr23)
git-svn-id: svn://tug.org/texlive/trunk@66777 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support')
-rw-r--r--Master/texmf-dist/doc/support/texfindpkg/README.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/texfindpkg/README.md b/Master/texmf-dist/doc/support/texfindpkg/README.md
new file mode 100644
index 00000000000..d0822b625d7
--- /dev/null
+++ b/Master/texmf-dist/doc/support/texfindpkg/README.md
@@ -0,0 +1,58 @@
+# TeXFindPkg tool for installing TeX packages
+
+```
+Description: Install TeX packages and their dependencies
+Copyright: 2023 (c) Jianrui Lyu <tolvjr@163.com>
+Repository: https://github.com/lvjr/texfindpkg
+License: GNU General Public License v3.0
+```
+
+## Introduction
+
+TeXFindPkg makes it easy to install TeX packages and their dependencies by file names, command names or environment names.
+
+- To install a package by its file name you can run `texfindpkg install array.sty`;
+- To install a package by some command name you can run `texfindpkg install \fakeverb`;
+- To install a package by some environment name you can run `texfindpkg install {frame}`.
+
+TeXFindPkg supports both TeXLive and MiKTeX distributions. At present it focuses mainly on LaTeX packages,
+but may extend to ConTeXt packages if anyone would like to contribute.
+
+## Installation
+
+Your TeX distribution should have created a binary file `texfindpkg` when you install this package.
+If not, you could create a symbolic link from `/usr/local/bin/texfindpkg` to `texfindpkg.lua` on Linux or MacOS,
+or create a batch file `texfindpkg.bat` in binary folder of the TeX distribution with these lines on Windows:
+
+```
+@echo off
+texlua path\to\texfindpkg.lua %*
+```
+
+## Usage
+
+```
+texfindpkg <action> [<options>] [<name>]
+```
+
+where `<action>` could be `install` or `query`, and `<name>` could be file name, command name or environment name.
+For example:
+
+```
+texfindpkg install array.sty
+texfindpkg install \fakeverb
+texfindpkg install {frame}
+texfindpkg query array.sty
+texfindpkg query \fakeverb
+texfindpkg query {frame}
+```
+
+## Building
+
+TeXFindPkg uses completion files of TeXstudio editor which are in `completion` folder of TeXstudio [repository](https://github.com/texstudio-org/texstudio).
+
+After putting `completion` folder into current folder, you can run `texlua texfindpkg.lua generate` to generate `texfindpkg.json` and `texfindpkg.json.gz` files.
+
+## Contributing
+
+Any updates of dependencies, commands or environments for packages should be contributed directly to TeXstudio project.