From 74ed35b28606776336cd39ae3f66ba59ea66ec34 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 5 May 2023 21:25:43 +0000 Subject: texfindpkg (5may23) git-svn-id: svn://tug.org/texlive/trunk@67027 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/support/texfindpkg/README.md | 66 +++++++++++++--------- 1 file changed, 39 insertions(+), 27 deletions(-) (limited to 'Master/texmf-dist/doc/support') diff --git a/Master/texmf-dist/doc/support/texfindpkg/README.md b/Master/texmf-dist/doc/support/texfindpkg/README.md index d0822b625d7..06c2d44bc24 100644 --- a/Master/texmf-dist/doc/support/texfindpkg/README.md +++ b/Master/texmf-dist/doc/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 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 [] [] +texfindpkg [