summaryrefslogtreecommitdiff
path: root/support/texfindpkg/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'support/texfindpkg/README.md')
-rw-r--r--support/texfindpkg/README.md66
1 files changed, 39 insertions, 27 deletions
diff --git a/support/texfindpkg/README.md b/support/texfindpkg/README.md
index d0822b625d..06c2d44bc2 100644
--- a/support/texfindpkg/README.md
+++ b/support/texfindpkg/README.md
@@ -1,27 +1,32 @@
-# TeXFindPkg tool for installing TeX packages
+# TeXFindPkg tool for querying or installing TeX packages
```
-Description: Install TeX packages and their dependencies
+Description: Query or 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
+## 1\. Introduction
-TeXFindPkg makes it easy to install TeX packages and their dependencies by file names, command names or environment names.
+TeXFindPkg makes it easy to query or install TeX packages and their dependencies by file names, command names or environment names.
+It 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.
-- 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}`.
+## 2\. Installation
-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.
+Normally your TeX distribution will copy TeXFindPkg files and create a binary file `texfindpkg` when you install this package.
+If a manual installation is needed, you could copy TeXFindPkg files to TEXMF tree as follows:
-## Installation
+| Package file | Where to install it |
+| :------ | :------ |
+| texfindpkg.1 | TEXMF/doc/man/man1/texfindpkg.1 |
+| README.md | TEXMF/doc/support/texfindpkg/README.md |
+| texfindpkg.lua | TEXMF/scripts/texfindpkg/texfindpkg.lua |
+| texfindpkg.json.gz | TEXMF/scripts/texfindpkg/texfindpkg.json.gz |
+| tfpbuild.lua | TEXMF/source/texfindpkg/tfpbuild.lua |
-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,
+Then you could create a symbolic link from `/usr/local/bin/texfindpkg` to `path/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:
```
@@ -29,30 +34,37 @@ or create a batch file `texfindpkg.bat` in binary folder of the TeX distribution
texlua path\to\texfindpkg.lua %*
```
-## Usage
+## 3\. Usage
+
+After installing TeXFindPkg, you can run it by executing
```
-texfindpkg <action> [<options>] [<name>]
+texfindpkg <action> [<option>] [<name>]
```
-where `<action>` could be `install` or `query`, and `<name>` could be file name, command name or environment name.
-For example:
+The `<action>` could be `query`, `install`, `help` or `version`.
+The leading dashes in any `<action>` will be removed first.
-```
-texfindpkg install array.sty
-texfindpkg install \fakeverb
-texfindpkg install {frame}
-texfindpkg query array.sty
-texfindpkg query \fakeverb
-texfindpkg query {frame}
-```
+For `query` action, you pass `-f`, `-c` or `-e` as `<option>`
+to indicate the following `<name>` is a file name, command name or environment name.
+For example,
+
+- `texfindpkg query -f array.sty` means querying package with file `array.sty`;
+- `texfindpkg query -c fakeverb` means querying package with command `\fakeverb`;
+- `texfindpkg query -e frame` means querying package with environment `{frame}`.
+
+The only difference between `query` and `install` actions is that
+with `install` action TeXFindPkg will install missing TeXLive or MiKTeX packages at the end.
+
+With `help` action, TeXFindPkg prints help message and exit.
+With `version` action, TeXFindPkg prints version information and exit.
-## Building
+## 4\. 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.
+After putting `completion` folder into current folder, you can execute `texlua tfpbuild.lua generate` to generate `texfindpkg.json` and `texfindpkg.json.gz` files.
-## Contributing
+## 5\. Contributing
Any updates of dependencies, commands or environments for packages should be contributed directly to TeXstudio project.