{ "mode": "man", "parameter": "tlmgr", "section": "", "url": "https://www.chedong.com/phpMan.php/man/tlmgr/json", "generated": "2026-05-30T06:10:37Z", "synopsis": "tlmgr [option...] action [option...] [operand...]", "sections": { "NAME": { "content": "tlmgr - the native TeX Live Manager\n", "subsections": [] }, "SYNOPSIS": { "content": "tlmgr [option...] action [option...] [operand...]\n", "subsections": [] }, "DESCRIPTION": { "content": "tlmgr manages an existing TeX Live installation, both packages and configuration options.\nFor information on initially downloading and installing TeX Live, see\n.\n\nThe most up-to-date version of this documentation (updated nightly from the development\nsources) is available at , along with procedures for\nupdating \"tlmgr\" itself and information about test versions.\n\nWARNING: tlmgr in Debian runs always in user mode\n\nTeX Live is organized into a few top-level schemes, each of which is specified as a different\nset of collections and packages, where a collection is a set of packages, and a package is\nwhat contains actual files. Schemes typically contain a mix of collections and packages, but\neach package is included in exactly one collection, no more and no less. A TeX Live\ninstallation can be customized and managed at any level.\n\nSee for all the TeX Live documentation available.\n", "subsections": [] }, "EXAMPLES": { "content": "After successfully installing TeX Live, here are a few common operations with \"tlmgr\":\n\n\"tlmgr option repository ctan\"\n\"tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet\"\nTell \"tlmgr\" to use a nearby CTAN mirror for future updates; useful if you installed TeX\nLive from the DVD image and want to have continuing updates. The two commands are\nequivalent; \"ctan\" is just an alias for the given url.\n\nCaveat: \"mirror.ctan.org\" resolves to many different hosts, and they are not perfectly\nsynchronized; we recommend updating only daily (at most), and not more often. You can\nchoose a particular mirror if problems; the list of all CTAN mirrors with the status of\neach is at .\n\n\"tlmgr update --list\"\nReport what would be updated without actually updating anything.\n\n\"tlmgr update --all\"\nMake your local TeX installation correspond to what is in the package repository\n(typically useful when updating from CTAN).\n\n\"tlmgr info\" what\nDisplay detailed information about a package what, such as the installation status and\ndescription, of searches for what in all packages.\n\nFor all the capabilities and details of \"tlmgr\", please read the following voluminous\ninformation.\n", "subsections": [] }, "OPTIONS": { "content": "The following options to \"tlmgr\" are global options, not specific to any action. All\noptions, whether global or action-specific, can be given anywhere on the command line, and in\nany order. The first non-option argument will be the main action. In all cases, \"--\"option\nand \"-\"option are equivalent, and an \"=\" is optional between an option name and its value.\n\n--repository url|path\nSpecify the package repository from which packages should be installed or updated, either\na local directory or network location, as below. This overridesthe default package\nrepository found in the installation's TeX Live Package Database (a.k.a. the TLPDB, which\nis given entirely in the file \"tlpkg/texlive.tlpdb\").\n\nThis \"--repository\" option changes the location only for the current run; to make a\npermanent change, use \"option repository\" (see the \"option\" action).\n\nAs an example, you can choose a particular CTAN mirror with something like this:\n\n-repository http://ctan.example.org/its/ctan/dir/systems/texlive/tlnet\n\nOf course a real hostname and its particular top-level CTAN directory have to be\nspecified. The list of CTAN mirrors is available at .\n\nHere's an example of using a local directory:\n\n-repository /local/TL/repository\n\nFor backward compatibility and convenience, \"--location\" and \"--repo\" are accepted as\naliases for this option.\n\nLocations can be specified as any of the following:\n\n\"/some/local/dir\"\n\"file:/some/local/dir\"\nEquivalent ways of specifying a local directory.\n\n\"ctan\"\n\"https://mirror.ctan.org/systems/texlive/tlnet\"\nPick a CTAN mirror automatically, trying for one that is both nearby and up-to-date.\nThe chosen mirror is used for the entire download. The bare \"ctan\" is merely an alias\nfor the full url. (See for more about CTAN and its mirrors.)\n\n\"http://server/path/to/tlnet\"\nStandard HTTP. If the (default) LWP method is used, persistent connections are\nsupported. TL can also use \"curl\" or \"wget\" to do the downloads, or an arbitrary\nuser-specified program, as described in the \"tlmgr\" documentation\n().\n\n\"https://server/path/to/tlnet\"\nAgain, if the (default) LWP method is used, this supports persistent connections.\nUnfortunately, some versions of \"wget\" and \"curl\" do not support https, and even when\n\"wget\" supports https, certificates may be rejected even when the certificate is\nfine, due to a lack of local certificate roots. The simplest workaround for this\nproblem is to use http or ftp.\n\n\"ftp://server/path/to/tlnet\"\nIf the (default) LWP method is used, persistent connections are supported.\n\n\"user@machine:/path/to/tlnet\"\n\"scp://user@machine/path/to/tlnet\"\n\"ssh://user@machine/path/to/tlnet\"\nThese forms are equivalent; they all use \"scp\" to transfer files. Using \"ssh-agent\"\nis recommended. (Info: ,\n.)\n\nIf the repository is on the network, trailing \"/\" characters and/or trailing \"/tlpkg\"\nand/or \"/archive\" components are ignored.\n\n--gui [action]\nTwo notable GUI front-ends for \"tlmgr\", \"tlshell\" and \"tlcockpit\", are started up as\nseparate programs; see their own documentation.\n\n\"tlmgr\" itself has a graphical interface as well as the command line interface. You can\ngive the option to invoke it, \"--gui\", together with an action to be brought directly\ninto the respective screen of the GUI. For example, running\n\ntlmgr --gui update\n\nstarts you directly at the update screen. If no action is given, the GUI will be started\nat the main screen. See \"GUI FOR TLMGR\".\n\nHowever, the native GUI requires Perl/TK, which is no longer included in TeX Live's Perl\ndistribution for Windows. You may find \"tlshell\" or \"tlcockpit\" easier to work with.\n\n--gui-lang llcode\nBy default, the GUI tries to deduce your language from the environment (on Windows via\nthe registry, on Unix via \"LCMESSAGES\"). If that fails you can select a different\nlanguage by giving this option with a language code (based on ISO 639-1). Currently\nsupported (but not necessarily completely translated) are: English (en, default),\nCzech (cs), German (de), French (fr), Italian (it), Japanese (ja), Dutch (nl),\nPolish (pl), Brazilian Portuguese (ptBR), Russian (ru), Slovak (sk), Slovenian (sl),\nSerbian (sr), Ukrainian (uk), Vietnamese (vi), simplified Chinese (zhCN), and\ntraditional Chinese (zhTW).\n\ntlshell shares its message catalog with tlmgr.\n\n--command-logfile file\n\"tlmgr\" logs the output of all programs invoked (mktexlr, mtxrun, fmtutil, updmap) to a\nseparate log file, by default \"TEXMFSYSVAR/web2c/tlmgr-commands.log\". This option allows\nyou to specify a different file for the log.\n", "subsections": [ { "name": "--debug-translation", "content": "In GUI mode, this switch tells \"tlmgr\" to report any untranslated (or missing) messages\nto standard error. This can help translators to see what remains to be done.\n", "long": "--debug-translation" }, { "name": "--machine-readable", "content": "Instead of the normal output intended for human consumption, write (to standard output) a\nfixed format more suitable for machine parsing. See the \"MACHINE-READABLE OUTPUT\"\nsection below.\n", "long": "--machine-readable" }, { "name": "--no-execute-actions", "content": "Suppress the execution of the execute actions as defined in the tlpsrc files. Documented\nonly for completeness, as this is only useful in debugging.\n\n--package-logfile file\n\"tlmgr\" logs all package actions (install, remove, update, failed updates, failed\nrestores) to a separate log file, by default \"TEXMFSYSVAR/web2c/tlmgr.log\". This option\nallows you to specify a different file for the log.\n", "long": "--no-execute-actions" }, { "name": "--pause", "content": "This option makes \"tlmgr\" wait for user input before exiting. Useful on Windows to avoid\ndisappearing command windows.\n", "long": "--pause" }, { "name": "--persistent-downloads", "content": "", "long": "--persistent-downloads" }, { "name": "--no-persistent-downloads", "content": "For network-based installations, this option (on by default) makes \"tlmgr\" try to set up\na persistent connection (using the \"LWP\" Perl module). The idea is to open and reuse\nonly one connection per session between your computer and the server, instead of\ninitiating a new download for each package.\n\nIf this is not possible, \"tlmgr\" will fall back to using \"wget\". To disable these\npersistent connections, use \"--no-persistent-downloads\".\n", "long": "--no-persistent-downloads" }, { "name": "--pin-file", "content": "Change the pinning file location from \"TEXMFLOCAL/tlpkg/pinning.txt\" (see \"Pinning\"\nbelow). Documented only for completeness, as this is only useful in debugging.\n", "long": "--pin-file" }, { "name": "--usermode", "content": "Activates user mode for this run of \"tlmgr\"; see \"USER MODE\" below.\n\n--usertree dir\nUses dir for the tree in user mode; see \"USER MODE\" below.\n", "long": "--usermode" }, { "name": "--verify-repo=[none|main|all]", "content": "Defines the level of verification done: If \"none\" is specified, no verification\nwhatsoever is done. If \"main\" is given and a working GnuPG (\"gpg\") binary is available,\nall repositories are checked, but only the main repository is required to be signed. If\n\"all\" is given, then all repositories need to be signed. See \"CRYPTOGRAPHIC\nVERIFICATION\" below for details.\n\nThe standard options for TeX Live programs are also accepted: \"--help/-h/-?\", \"--version\",\n\"-q\" (no informational messages), \"-v\" (debugging messages, can be repeated). For the\ndetails about these, see the \"TeXLive::TLUtils\" documentation.\n\nThe \"--version\" option shows version information about the TeX Live release and about the\n\"tlmgr\" script itself. If \"-v\" is also given, revision number for the loaded TeX Live Perl\nmodules are shown, too.\n", "long": "--verify-repo", "arg": "[none|main|all]" } ] }, "ACTIONS": { "content": "", "subsections": [ { "name": "help", "content": "Display this help information and exit (same as \"--help\", and on the web at\n). Sometimes the \"perldoc\" and/or \"PAGER\" programs\non the system have problems, resulting in control characters being literally output. This\ncan't always be detected, but you can set the \"NOPERLDOC\" environment variable and \"perldoc\"\nwill not be used.\n" }, { "name": "version", "content": "Gives version information (same as \"--version\").\n\nIf \"-v\" has been given the revisions of the used modules are reported, too.\n" }, { "name": "backup", "content": "backup [ooppttiioonn...] --all\nbackup [ooppttiioonn...] ppkkgg...\nIf the \"--clean\" option is not specified, this action makes a backup of the given\npackages, or all packages given \"--all\". These backups are saved to the value of the\n\"--backupdir\" option, if that is an existing and writable directory. If \"--backupdir\" is\nnot given, the \"backupdir\" option setting in the TLPDB is used, if present. If both are\nmissing, no backups are made. (The installer sets \"backupdir\" to \".../tlpkg/backups\",\nunder the TL root installation directory, so it is usually defined; see the \"option\"\ndescription for more information.)\n\nIf the \"--clean\" option is specified, backups are pruned (removed) instead of saved. The\noptional integer value N may be specified to set the number of backups that will be\nretained when cleaning. If \"N\" is not given, the value of the \"autobackup\" option is\nused. If both are missing, an error is issued. For more details of backup pruning, see\nthe \"option\" action.\n\nOptions:\n\n--backupdir directory\nOverrides the \"backupdir\" option setting in the TLPDB. The directory argument is\nrequired and must specify an existing, writable directory where backups are to be\nplaced.\n\n--all\nIf \"--clean\" is not specified, make a backup of all packages in the TeX Live\ninstallation; this will take quite a lot of space and time. If \"--clean\" is\nspecified, all packages are pruned.\n\n--clean[=N]\nInstead of making backups, prune the backup directory of old backups, as explained\nabove. The optional integer argument N overrides the \"autobackup\" option set in the\nTLPDB. You must use \"--all\" or a list of packages together with this option, as\ndesired.\n\n--dry-run\nNothing is actually backed up or removed; instead, the actions to be performed are\nwritten to the terminal.\n\ncandidates pkg\nShows the available candidate repositories for package pkg. See \"MULTIPLE REPOSITORIES\"\nbelow.\n\ncheck [option...] [depends|executes|files|runfiles|texmfdbs|all]\nExecute one (or all) check(s) of the consistency of the installation. If no problems are\nfound, there will be no output. (To get a view of what is being done, run \"tlmgr -v check\".)\n" }, { "name": "depends", "content": "Lists those packages which occur as dependencies in an installed collection, but are\nthemselves not installed, and those packages which are not contained in any collection.\n\nIf you call \"tlmgr check collections\" this test will be carried out instead since former\nversions for \"tlmgr\" called it that way.\n" }, { "name": "executes", "content": "Check that the files referred to by \"execute\" directives in the TeX Live Database are\npresent.\n" }, { "name": "files", "content": "Checks that all files listed in the local TLPDB (\"texlive.tlpdb\") are actually present,\nand lists those missing.\n" }, { "name": "runfiles", "content": "List those filenames that are occurring more than one time in the runfiles sections,\nexcept for known duplicates.\n" }, { "name": "texmfdbs", "content": "Checks related to the \"ls-R\" files. If you have defined new trees, or changed the \"TEXMF\"\nor \"TEXMFDBS\" variables, it can't hurt to run this. It checks that:\n\n- all items in \"TEXMFDBS\" have the \"!!\" prefix.\n- all items in \"TEXMFBDS\" have an \"ls-R\" file (if they exist at all).\n- all items in \"TEXMF\" with \"!!\" are listed in \"TEXMFDBS\".\n- all items in \"TEXMF\" with an \"ls-R\" file are listed in \"TEXMFDBS\".\n\nOptions:\n" }, { "name": "--use-svn", "content": "Use the output of \"svn status\" instead of listing the files; for checking the TL\ndevelopment repository. (This is run nightly.)\n", "long": "--use-svn" }, { "name": "conf", "content": "conf [texmf|tlmgr|updmap [--conffile ffiillee] [--delete] [kkeeyy [vvaalluuee]]]\nconf auxtrees [--conffile ffiillee] [show|add|remove] [vvaalluuee]\nWith only \"conf\", show general configuration information for TeX Live, including active\nconfiguration files, path settings, and more. This is like running \"texconfig conf\", but\nworks on all supported platforms.\n\nWith one of \"conf texmf\", \"conf tlmgr\", or \"conf updmap\", shows all key/value pairs\n(i.e., all settings) as saved in \"ROOT/texmf.cnf\", the user-specific \"tlmgr\"\nconfiguration file (see below), or the first found (via \"kpsewhich\") \"updmap.cfg\" file,\nrespectively.\n\nIf key is given in addition, shows the value of only that key in the respective file. If\noption --delete is also given, the value in the given configuration file is entirely\nremoved (not just commented out).\n\nIf value is given in addition, key is set to value in the respective file. No error\nchecking is done!\n\nThe \"PATH\" value shown by \"conf\" is as used by \"tlmgr\". The directory in which the\n\"tlmgr\" executable is found is automatically prepended to the PATH value inherited from\nthe environment.\n\nHere is a practical example of changing configuration values. If the execution of (some\nor all) system commands via \"\\write18\" was left enabled during installation, you can\ndisable it afterwards:\n\ntlmgr conf texmf shellescape 0\n\nThe subcommand \"auxtrees\" allows adding and removing arbitrary additional texmf trees,\ncompletely under user control. \"auxtrees show\" shows the list of additional trees,\n\"auxtrees add\" tree adds a tree to the list, and \"auxtrees remove\" tree removes a tree\nfrom the list (if present). The trees should not contain an \"ls-R\" file (or files will\nnot be found if the \"ls-R\" becomes stale). This works by manipulating the Kpathsea\nvariable \"TEXMFAUXTREES\", in (by default) \"ROOT/texmf.cnf\". Example:\n\ntlmgr conf auxtrees add /quick/test/tree\ntlmgr conf auxtrees remove /quick/test/tree\n\nIn all cases the configuration file can be explicitly specified via the option\n\"--conffile\" file, e.g., if you don't want to change the system-wide configuration.\n\nWarning: The general facility for changing configuration values is here, but tinkering\nwith settings in this way is strongly discouraged. Again, no error checking on either\nkeys or values is done, so any sort of breakage is possible.\n\ndump-tlpdb [option...] [--json]\nDump complete local or remote TLPDB to standard output, as-is. The output is analogous to\nthe \"--machine-readable\" output; see \"MACHINE-READABLE OUTPUT\" section.\n\nOptions:\n" }, { "name": "--local", "content": "Dump the local TLPDB.\n", "long": "--local" }, { "name": "--remote", "content": "Dump the remote TLPDB.\n", "long": "--remote" }, { "name": "--json", "content": "Instead of dumping the actual content, the database is dumped as JSON. For the format of\nJSON output see \"tlpkg/doc/JSON-formats.txt\", format definition \"TLPDB\".\n\nExactly one of \"--local\" and \"--remote\" must be given.\n\nIn either case, the first line of the output specifies the repository location, in this\nformat:\n\n\"location-url\" \"\\t\" location\n\nwhere \"location-url\" is the literal field name, followed by a tab, and location is the file\nor url to the repository.\n\nLine endings may be either LF or CRLF depending on the current platform.\n", "long": "--json" }, { "name": "generate", "content": "generate [ooppttiioonn...] language\ngenerate [ooppttiioonn...] language.dat\ngenerate [ooppttiioonn...] language.def\ngenerate [ooppttiioonn...] language.dat.lua\n\nThe \"generate\" action overwrites any manual changes made in the respective files: it\nrecreates them from scratch based on the information of the installed packages, plus local\nadaptions. The TeX Live installer and \"tlmgr\" routinely call \"generate\" for all of these\nfiles.\n\nFor managing your own fonts, please read the \"updmap --help\" information and/or\n.\n\nFor managing your own formats, please read the \"fmtutil --help\" information.\n\nIn more detail: \"generate\" remakes any of the configuration files \"language.dat\",\n\"language.def\", and \"language.dat.lua\" from the information present in the local TLPDB, plus\nlocally-maintained files.\n\nThe locally-maintained files are \"language-local.dat\", \"language-local.def\", or\n\"language-local.dat.lua\", searched for in \"TEXMFLOCAL\" in the respective directories. If\nlocal additions are present, the final file is made by starting with the main file, omitting\nany entries that the local file specifies to be disabled, and finally appending the local\nfile.\n\n(Historical note: The formerly supported \"updmap-local.cfg\" and \"fmtutil-local.cnf\" are no\nlonger read, since \"updmap\" and \"fmtutil\" now reads and supports multiple configuration\nfiles. Thus, local additions can and should be put into an \"updmap.cfg\" of \"fmtutil.cnf\"\nfile in \"TEXMFLOCAL\". The \"generate updmap\" and \"generate fmtutil\" actions no longer exist.)\n\nLocal files specify entries to be disabled with a comment line, namely one of these:\n\n%!NAME\n--!NAME\n\nwhere \"language.dat\" and \"language.def\" use \"%\", and \"language.dat.lua\" use \"--\". In all\ncases, the name is the respective format name or hyphenation pattern identifier. Examples:\n\n%!german\n--!usenglishmax\n\n(Of course, you're not likely to actually want to disable those particular items. They're\njust examples.)\n\nAfter such a disabling line, the local file can include another entry for the same item, if a\ndifferent definition is desired. In general, except for the special disabling lines, the\nlocal files follow the same syntax as the master files.\n\nThe form \"generate language\" recreates all three files \"language.dat\", \"language.def\", and\n\"language.dat.lua\", while the forms with an extension recreates only that given language\nfile.\n\nOptions:\n\n--dest outputfile\nspecifies the output file (defaults to the respective location in \"TEXMFSYSVAR\"). If\n\"--dest\" is given to \"generate language\", it serves as a basename onto which \".dat\" will\nbe appended for the name of the \"language.dat\" output file, \".def\" will be appended to\nthe value for the name of the \"language.def\" output file, and \".dat.lua\" to the name of\nthe \"language.dat.lua\" file. (This is just to avoid overwriting; if you want a specific\nname for each output file, we recommend invoking \"tlmgr\" twice.)\n\n--localcfg localconffile\nspecifies the (optional) local additions (defaults to the respective location in\n\"TEXMFLOCAL\").\n" }, { "name": "--rebuild-sys", "content": "tells \"tlmgr\" to run necessary programs after config files have been regenerated. These\nare: \"fmtutil-sys --all\" after \"generate fmtutil\", \"fmtutil-sys --byhyphen\n.../language.dat\" after \"generate language.dat\", and \"fmtutil-sys --byhyphen\n.../language.def\" after \"generate language.def\".\n\nThese subsequent calls cause the newly-generated files to actually take effect. This is\nnot done by default since those calls are lengthy processes and one might want to made\nseveral related changes in succession before invoking these programs.\n\nThe respective locations are as follows:\n\ntex/generic/config/language.dat (and language-local.dat)\ntex/generic/config/language.def (and language-local.def)\ntex/generic/config/language.dat.lua (and language-local.dat.lua)\n", "long": "--rebuild-sys" }, { "name": "gui", "content": "Start the graphical user interface. See GUI below.\n" }, { "name": "info", "content": "info [ooppttiioonn...] ppkkgg...\ninfo [ooppttiioonn...] collections\ninfo [ooppttiioonn...] schemes\nWith no argument, lists all packages available at the package repository, prefixing those\nalready installed with \"i\".\n\nWith the single word \"collections\" or \"schemes\" as the argument, lists the request type\ninstead of all packages.\n\nWith any other arguments, display information about pkg: the name, category, short and\nlong description, sizes, installation status, and TeX Live revision number. If pkg is\nnot locally installed, searches in the remote installation source.\n\nFor normal packages (not collections or schemes), the sizes of the four groups of files\n(run/src/doc/bin files) are shown separately. For collections, the cumulative size is\nshown, including all directly-dependent packages (but not dependent collections). For\nschemes, the cumulative size is also shown, including all directly-dependent collections\nand packages.\n\nIf pkg is not found locally or remotely, the search action is used and lists matching\npackages and files.\n\nIt also displays information taken from the TeX Catalogue, namely the package version,\ndate, and license. Consider these, especially the package version, as approximations\nonly, due to timing skew of the updates of the different pieces. By contrast, the\n\"revision\" value comes directly from TL and is reliable.\n\nThe former actions \"show\" and \"list\" are merged into this action, but are still supported\nfor backward compatibility.\n\nOptions:\n\n--list\nIf the option \"--list\" is given with a package, the list of contained files is also\nshown, including those for platform-specific dependencies. When given with schemes\nand collections, \"--list\" outputs their dependencies in a similar way.\n\n--only-installed\nIf this option is given, the installation source will not be used; only locally\ninstalled packages, collections, or schemes are listed.\n\n--only-remote\nOnly list packages from the remote repository. Useful when checking what is available\nin a remote repository using \"tlmgr --repo ... --only-remote info\". Note that\n\"--only-installed\" and \"--only-remote\" cannot both be specified.\n\n--data \"item1,item2,...\"\nIf the option \"--data\" is given, its argument must be a comma or colon separated list\nof field names from: \"name\", \"category\", \"localrev\", \"remoterev\", \"shortdesc\",\n\"longdesc\", \"installed\", \"size\", \"relocatable\", \"depends\", \"cat-version\", \"cat-date\",\n\"cat-license\", plus various \"cat-contact-*\" fields (see below).\n\nThe \"cat-*\" fields all come from the TeX Catalogue\n(). For each, there are two more variants with prefix\n\"l\" and \"r\", e.g., \"lcat-version\" and \"rcat-version\", which indicate the local and\nremote information, respectively. The variants without \"l\" and \"r\" show the most\ncurrent one, which is normally the remote value.\n\nThe requested packages' information is listed in CSV format, one package per line,\nand the column information is given by the \"itemN\". The \"depends\" column contains the\nnames of all the dependencies separated by \":\" characters.\n\nAt this writing, the \"cat-contact-*\" fields include: \"home\", \"repository\", \"support\",\n\"bugs\", \"announce\", \"development\". Each may be empty or a url value. A brief\ndescription is on the CTAN upload page for new packages: .\n\n--json\nIn case \"--json\" is specified, the output is a JSON encoded array where each array\nelement is the JSON representation of a single \"TLPOBJ\" but with additional\ninformation. For details see \"tlpkg/doc/JSON-formats.txt\", format definition:\n\"TLPOBJINFO\". If both \"--json\" and \"--data\" are given, \"--json\" takes precedence.\n" }, { "name": "init-usertree", "content": "Sets up a texmf tree for so-called user mode management, either the default user tree\n(\"TEXMFHOME\"), or one specified on the command line with \"--usertree\". See \"USER MODE\"\nbelow.\n\ninstall [option...] pkg...\nInstall each pkg given on the command line, if it is not already installed. It does not\ntouch existing packages; see the \"update\" action for how to get the latest version of a\npackage.\n\nBy default this also installs all packages on which the given pkgs are dependent. Options:\n" }, { "name": "--dry-run", "content": "Nothing is actually installed; instead, the actions to be performed are written to the\nterminal.\n", "long": "--dry-run" }, { "name": "--file", "content": "Instead of fetching a package from the installation repository, use the package files\ngiven on the command line. These files must be standard TeX Live package files (with\ncontained tlpobj file).\n", "long": "--file" }, { "name": "--force", "content": "If updates to \"tlmgr\" itself (or other parts of the basic infrastructure) are present,\n\"tlmgr\" will bail out and not perform the installation unless this option is given. Not\nrecommended.\n", "long": "--force" }, { "name": "--no-depends", "content": "Do not install dependencies. (By default, installing a package ensures that all\ndependencies of this package are fulfilled.)\n", "long": "--no-depends" }, { "name": "--no-depends-at-all", "content": "Normally, when you install a package which ships binary files the respective binary\npackage will also be installed. That is, for a package \"foo\", the package\n\"foo.i386-linux\" will also be installed on an \"i386-linux\" system. This option\nsuppresses this behavior, and also implies \"--no-depends\". Don't use it unless you are\nsure of what you are doing.\n", "long": "--no-depends-at-all" }, { "name": "--reinstall", "content": "Reinstall a package (including dependencies for collections) even if it already seems to\nbe installed (i.e, is present in the TLPDB). This is useful to recover from accidental\nremoval of files in the hierarchy.\n\nWhen re-installing, only dependencies on normal packages are followed (i.e., not those of\ncategory Scheme or Collection).\n", "long": "--reinstall" }, { "name": "--with-doc", "content": "", "long": "--with-doc" }, { "name": "--with-src", "content": "While not recommended, the \"install-tl\" program provides an option to omit installation\nof all documentation and/or source files. (By default, everything is installed.) After\nsuch an installation, you may find that you want the documentation or source files for a\ngiven package after all. You can get them by using these options in conjunction with\n\"--reinstall\", as in (using the \"fontspec\" package as the example):\n\ntlmgr install --reinstall --with-doc --with-src fontspec\n\nThis action does not automatically add new symlinks in system directories; you need to run\n\"tlmgr path add\" (\"path\") yourself if you are using this feature and want new symlinks added.\n", "long": "--with-src" }, { "name": "key", "content": "" }, { "name": "key list", "content": "key add ffiillee\nkey remove kkeeyyiidd\nThe action \"key\" allows listing, adding and removing additional GPG keys to the set of\ntrusted keys, that is, those that are used to verify the TeX Live databases.\n\nWith the \"list\" argument, \"key\" lists all keys.\n\nThe \"add\" argument requires another argument, either a filename or \"-\" for stdin, from\nwhich the key is added. The key is added to the local keyring\n\"GNUPGHOME/repository-keys.gpg\", which is normally \"tlpkg/gpg/repository-keys.gpg\".\n\nThe \"remove\" argument requires a key id and removes the requested id from the local\nkeyring.\n" }, { "name": "list", "content": "Synonym for \"info\".\n" }, { "name": "option", "content": "" }, { "name": "option [--json] [show]", "content": "" }, { "name": "option [--json] showall|help", "content": "option kkeeyy [vvaalluuee]\n\nThe first form, \"show\", shows the global TeX Live settings currently saved in the TLPDB with\na short description and the \"key\" used for changing it in parentheses.\n\nThe second form, \"showall\", is similar, but also shows options which can be defined but are\nnot currently set to any value (\"help\" is a synonym).\n\nBoth \"show...\" forms take an option \"--json\", which dumps the option information in JSON\nformat. In this case, both forms dump the same data. For the format of the JSON output see\n\"tlpkg/doc/JSON-formats.txt\", format definition \"TLOPTION\".\n\nIn the third form, with key, if value is not given, the setting for key is displayed. If\nvalue is present, key is set to value.\n\nPossible values for key are (run \"tlmgr option showall\" for the definitive list):\n\nrepository (default package repository),\nformats (generate formats at installation or update time),\npostcode (run postinst code blobs)\ndocfiles (install documentation files),\nsrcfiles (install source files),\nbackupdir (default directory for backups),\nautobackup (number of backups to keep).\nsysbin (directory to which executables are linked by the path action)\nsysman (directory to which man pages are linked by the path action)\nsysinfo (directory to which Info files are linked by the path action)\ndesktopintegration (Windows-only: create Start menu shortcuts)\nfileassocs (Windows-only: change file associations)\nmultiuser (Windows-only: install for all users)\n\nOne common use of \"option\" is to permanently change the installation to get further updates\nfrom the Internet, after originally installing from DVD. To do this, you can run\n\ntlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet\n\nThe \"install-tl\" documentation has more information about the possible values for\n\"repository\". (For backward compatibility, \"location\" can be used as a synonym for\n\"repository\".)\n\nIf \"formats\" is set (this is the default), then formats are regenerated when either the\nengine or the format files have changed. Disable this only when you know how and want to\nregenerate formats yourself whenever needed (which is often, in practice).\n\nThe \"postcode\" option controls execution of per-package postinstallation action code. It is\nset by default, and again disabling is not likely to be of interest except to developers\ndoing debugging.\n\nThe \"docfiles\" and \"srcfiles\" options control the installation of their respective file\ngroups (documentation, sources; grouping is approximate) per package. By default both are\nenabled (1). Either or both can be disabled (set to 0) if disk space is limited or for\nminimal testing installations, etc. When disabled, the respective files are not downloaded\nat all.\n\nThe options \"autobackup\" and \"backupdir\" determine the defaults for the actions \"update\",\n\"backup\" and \"restore\". These three actions need a directory in which to read or write the\nbackups. If \"--backupdir\" is not specified on the command line, the \"backupdir\" option value\nis used (if set). The TL installer sets \"backupdir\" to \".../tlpkg/backups\", under the TL root\ninstallation directory.\n\nThe \"autobackup\" option (de)activates automatic generation of backups. Its value is an\ninteger. If the \"autobackup\" value is \"-1\", no backups are removed. If \"autobackup\" is 0 or\nmore, it specifies the number of backups to keep. Thus, backups are disabled if the value is\n0. In the \"--clean\" mode of the \"backup\" action this option also specifies the number to be\nkept. The default value is 1, so that backups are made, but only one backup is kept.\n\nTo setup \"autobackup\" to \"-1\" on the command line, use:\n\ntlmgr option -- autobackup -1\n\nThe \"--\" avoids having the \"-1\" treated as an option. (The \"--\" stops parsing for options at\nthe point where it appears; this is a general feature across most Unix programs.)\n\nThe \"sysbin\", \"sysman\", and \"sysinfo\" options are used on Unix systems to control the\ngeneration of links for executables, Info files and man pages. See the \"path\" action for\ndetails.\n\nThe last three options affect behavior on Windows installations. If \"desktopintegration\" is\nset, then some packages will install items in a sub-folder of the Start menu for \"tlmgr gui\",\ndocumentation, etc. If \"fileassocs\" is set, Windows file associations are made (see also the\n\"postaction\" action). Finally, if \"multiuser\" is set, then adaptions to the registry and the\nmenus are done for all users on the system instead of only the current user. All three\noptions are on by default.\n" }, { "name": "paper", "content": "" }, { "name": "paper [a4|letter]", "content": "<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [ppaappeerrssiizzee|--list]>" }, { "name": "paper --json", "content": "With no arguments (\"tlmgr paper\"), shows the default paper size setting for all known\nprograms.\n\nWith one argument (e.g., \"tlmgr paper a4\"), sets the default for all known programs to that\npaper size.\n\nWith a program given as the first argument and no paper size specified (e.g., \"tlmgr dvips\npaper\"), shows the default paper size for that program.\n\nWith a program given as the first argument and a paper size as the last argument (e.g.,\n\"tlmgr dvips paper a4\"), set the default for that program to that paper size.\n\nWith a program given as the first argument and \"--list\" given as the last argument (e.g.,\n\"tlmgr dvips paper --list\"), shows all valid paper sizes for that program. The first size\nshown is the default.\n\nIf \"--json\" is specified without other options, the paper setup is dumped in JSON format. For\nthe format of JSON output see \"tlpkg/doc/JSON-formats.txt\", format definition \"TLPAPER\".\n\nIncidentally, this syntax of having a specific program name before the \"paper\" keyword is\nunusual. It is inherited from the longstanding \"texconfig\" script, which supports other\nconfiguration settings for some programs, notably \"dvips\". \"tlmgr\" does not support those\nextra settings.\n" }, { "name": "path", "content": "" }, { "name": "path [--w32mode=user|admin] add", "content": "" }, { "name": "path [--w32mode=user|admin] remove", "content": "On Unix, adds or removes symlinks for executables, man pages, and info pages in the\nsystem directories specified by the respective options (see the \"option\" description\nabove). Does not change any initialization files, either system or personal. Furthermore,\nany executables added or removed by future updates are not taken care of automatically;\nthis command must be rerun as needed.\n\nOn Windows, the registry part where the binary directory is added or removed is\ndetermined in the following way:\n\nIf the user has admin rights, and the option \"--w32mode\" is not given, the setting\nw32multiuser determines the location (i.e., if it is on then the system path, otherwise\nthe user path is changed).\n\nIf the user has admin rights, and the option \"--w32mode\" is given, this option determines\nthe path to be adjusted.\n\nIf the user does not have admin rights, and the option \"--w32mode\" is not given, and the\nsetting w32multiuser is off, the user path is changed, while if the setting\nw32multiuser is on, a warning is issued that the caller does not have enough\nprivileges.\n\nIf the user does not have admin rights, and the option \"--w32mode\" is given, it must be\n\"user\" and the user path will be adjusted. If a user without admin rights uses the option\n\"--w32mode admin\" a warning is issued that the caller does not have enough privileges.\n" }, { "name": "pinning", "content": "The \"pinning\" action manages the pinning file, see \"Pinning\" below.\n\n\"pinning show\"\nShows the current pinning data.\n\n\"pinning add\" repo pkgglob...\nPins the packages matching the pkgglob(s) to the repository repo.\n\n\"pinning remove\" repo pkgglob...\nAny packages recorded in the pinning file matching the s for the given\nrepository repo are removed.\n\n\"pinning remove repo --all\"\nRemove all pinning data for repository repo.\n" }, { "name": "platform", "content": "platform list|add|remove ppllaattffoorrmm...\nplatform set ppllaattffoorrmm" }, { "name": "platform set auto", "content": "\"platform list\" lists the TeX Live names of all the platforms (a.k.a. architectures),\n(\"i386-linux\", ...) available at the package repository.\n\n\"platform add\" platform... adds the executables for each given platform platform to the\ninstallation from the repository.\n\n\"platform remove\" platform... removes the executables for each given platform platform\nfrom the installation, but keeps the currently running platform in any case.\n\n\"platform set\" platform switches TeX Live to always use the given platform instead of\nauto detection.\n\n\"platform set auto\" switches TeX Live to auto detection mode for platform.\n\nPlatform detection is needed to select the proper \"xz\" and \"wget\" binaries that are\nshipped with TeX Live.\n\n\"arch\" is a synonym for \"platform\".\n\nOptions:\n\n--dry-run\nNothing is actually installed; instead, the actions to be performed are written to\nthe terminal.\n" }, { "name": "postaction", "content": "postaction [ooppttiioonn...] install [shortcut|fileassoc|script] [ppkkgg...]\npostaction [ooppttiioonn...] remove [shortcut|fileassoc|script] [ppkkgg...]\nCarry out the postaction \"shortcut\", \"fileassoc\", or \"script\" given as the second\nrequired argument in install or remove mode (which is the first required argument), for\neither the packages given on the command line, or for all if \"--all\" is given.\n\nOptions:\n\n--w32mode=[user|admin]\nIf the option \"--w32mode\" is given the value \"user\", all actions will only be carried\nout in the user-accessible parts of the registry/filesystem, while the value \"admin\"\nselects the system-wide parts of the registry for the file associations. If you do\nnot have enough permissions, using \"--w32mode=admin\" will not succeed.\n\n--fileassocmode=[1|2]\n\"--fileassocmode\" specifies the action for file associations. If it is set to 1 (the\ndefault), only new associations are added; if it is set to 2, all associations are\nset to the TeX Live programs. (See also \"option fileassocs\".)\n\n--all\nCarry out the postactions for all packages\n" }, { "name": "print-platform", "content": "Print the TeX Live identifier for the detected platform (hardware/operating system)\ncombination to standard output, and exit. \"--print-arch\" is a synonym.\n" }, { "name": "print-platform-info", "content": "Print the TeX Live platform identifier, TL platform long name, and original output from\nguess.\n\nremove [option...] pkg...\nRemove each pkg specified. Removing a collection removes all package dependencies (unless\n\"--no-depends\" is specified), but not any collection dependencies of that collection.\nHowever, when removing a package, dependencies are never removed. Options:\n" }, { "name": "--all", "content": "Uninstalls all of TeX Live, asking for confirmation unless \"--force\" is also specified.\n", "long": "--all" }, { "name": "--backup", "content": "--backupdir directory\nThese options behave just as with the update action (q.v.), except they apply to making\nbackups of packages before they are removed. The default is to make such a backup, that\nis, to save a copy of packages before removal.\n\nThe \"restore\" action explains how to restore from a backup.\n", "long": "--backup" }, { "name": "--no-depends", "content": "Do not remove dependent packages.\n", "long": "--no-depends" }, { "name": "--no-depends-at-all", "content": "See above under install (and beware).\n", "long": "--no-depends-at-all" }, { "name": "--force", "content": "By default, removal of a package or collection that is a dependency of another collection\nor scheme is not allowed. With this option, the package will be removed unconditionally.\nUse with care.\n\nA package that has been removed using the \"--force\" option because it is still listed in\nan installed collection or scheme will not be updated, and will be mentioned as \"forcibly\nremoved\" in the output of \"tlmgr update --list\".\n", "long": "--force" }, { "name": "--dry-run", "content": "Nothing is actually removed; instead, the actions to be performed are written to the\nterminal.\n\nExcept with \"--all\", this \"remove\" action does not automatically remove symlinks to\nexecutables from system directories; you need to run \"tlmgr path remove\" (\"path\") yourself if\nyou remove an individual package with a symlink in a system directory.\n", "long": "--dry-run" }, { "name": "repository", "content": "" }, { "name": "repository list", "content": "repository list ppaatthh||uurrll||ttaagg\nrepository add ppaatthh [ttaagg]\nrepository remove ppaatthh||ttaagg\nrepository set ppaatthh[#ttaagg] [ppaatthh[#ttaagg] ...]" }, { "name": "repository status", "content": "This action manages the list of repositories. See MULTIPLE REPOSITORIES below for\ndetailed explanations.\n\nThe first form, \"repository list\", lists all configured repositories and the respective\ntags if set. If a path, url, or tag is given after the \"list\" keyword, it is interpreted\nas the source from which to initialize a TL database and lists the contained packages.\nThis can also be an otherwise-unused repository, either local or remote. If the option\n\"--with-platforms\" is specified in addition, for each package the available platforms (if\nany) are also listed.\n\nThe form \"repository add\" adds a repository (optionally attaching a tag) to the list of\nrepositories, while \"repository remove\" removes a repository, either by full path/url, or\nby tag.\n\nThe form \"repository set\" sets the list of available repositories to the items given on\nthe command line, overwriting previous settings.\n\nThe form \"repository status\" reports the verification status of the loaded repositories\nwith the format of one repository per line with fields separated by a single space:\n\nThe tag (which can be the same as the url);\n= the url;\n\n= iff machine-readable output is specified, the verification code (a number);\n\n= a textual description of the verification status, as the last field extending to\nthe end of line.\n\nThat is, in normal (not machine-readable) output, the third field (numeric verification\nstatus) is not present.\n\nIn all cases, one of the repositories must be tagged as \"main\"; otherwise, all operations\nwill fail!\n" }, { "name": "restore", "content": "restore [ooppttiioonn...] ppkkgg [rreevv]\nrestore [ooppttiioonn...] --all\nRestore a package from a previously-made backup.\n\nIf \"--all\" is given, try to restore the latest revision of all package backups found in\nthe backup directory.\n\nOtherwise, if neither pkg nor rev are given, list the available backup revisions for all\npackages. With pkg given but no rev, list all available backup revisions of pkg.\n\nWhen listing available packages, \"tlmgr\" shows the revision, and in parenthesis the\ncreation time if available (in format yyyy-mm-dd hh:mm).\n\nIf (and only if) both pkg and a valid revision number rev are specified, try to restore\nthe package from the specified backup.\n\nOptions:\n\n--all\nTry to restore the latest revision of all package backups found in the backup\ndirectory. Additional non-option arguments (like pkg) are not allowed.\n\n--backupdir directory\nSpecify the directory where the backups are to be found. If not given it will be\ntaken from the configuration setting in the TLPDB.\n\n--dry-run\nNothing is actually restored; instead, the actions to be performed are written to the\nterminal.\n\n--force\nDon't ask questions.\n\n--json\nWhen listing backups, the option \"--json\" turn on JSON output. The format is an\narray of JSON objects (\"name\", \"rev\", \"date\"). For details see\n\"tlpkg/doc/JSON-formats.txt\", format definition: \"TLBACKUPS\". If both \"--json\" and\n\"--data\" are given, \"--json\" takes precedence.\n" }, { "name": "search", "content": "search [ooppttiioonn...] wwhhaatt\nsearch [ooppttiioonn...] --file wwhhaatt\nsearch [ooppttiioonn...] --all wwhhaatt\nBy default, search the names, short descriptions, and long descriptions of all locally\ninstalled packages for the argument what, interpreted as a (Perl) regular expression.\n\nOptions:\n\n--file\nList all filenames containing what.\n\n--all\nSearch everything: package names, descriptions and filenames.\n\n--global\nSearch the TeX Live Database of the installation medium, instead of the local\ninstallation.\n\n--word\nRestrict the search of package names and descriptions (but not filenames) to match\nonly full words. For example, searching for \"table\" with this option will not output\npackages containing the word \"tables\" (unless they also contain the word \"table\" on\nits own).\n" }, { "name": "shell", "content": "Starts an interactive mode, where tlmgr prompts for commands. This can be used directly, or\nfor scripting. The first line of output is \"protocol\" n, where n is an unsigned number\nidentifying the protocol version (currently 1).\n\nIn general, tlmgr actions that can be given on the command line translate to commands in this\nshell mode. For example, you can say \"update --list\" to see what would be updated. The TLPDB\nis loaded the first time it is needed (not at the beginning), and used for the rest of the\nsession.\n\nBesides these actions, a few commands are specific to shell mode:\n\nprotocol\nPrint \"protocol n\", the current protocol version.\n\nhelp\nPrint pointers to this documentation.\n\nversion\nPrint tlmgr version information.\n\nquit, end, bye, byebye, EOF\nExit.\n\nrestart\nRestart \"tlmgr shell\" with the original command line; most useful when developing\n\"tlmgr\".\n\nload [local|remote]\nExplicitly load the local or remote, respectively, TLPDB.\n\nsave\nSave the local TLPDB, presumably after other operations have changed it.\n\nget [var] =item set [var [val]]\nGet the value of var, or set it to val. Possible var names: \"debug-translation\",\n\"machine-readable\", \"no-execute-actions\", \"require-verification\", \"verify-downloads\",\n\"repository\", and \"prompt\". All except \"repository\" and \"prompt\" are booleans, taking\nvalues 0 and 1, and behave like the corresponding command line option. The \"repository\"\nvariable takes a string, and sets the remote repository location. The \"prompt\" variable\ntakes a string, and sets the current default prompt.\n\nIf var or then val is not specified, it is prompted for.\n" }, { "name": "show", "content": "Synonym for \"info\".\n" }, { "name": "uninstall", "content": "Synonym for remove.\n\nupdate [option...] [pkg...]\nUpdates the packages given as arguments to the latest version available at the installation\nsource. Either \"--all\" or at least one pkg name must be specified. Options:\n" }, { "name": "--all", "content": "Update all installed packages except for \"tlmgr\" itself. If updates to \"tlmgr\" itself are\npresent, this gives an error, unless also the option \"--force\" or \"--self\" is given. (See\nbelow.)\n\nIn addition to updating the installed packages, during the update of a collection the\nlocal installation is (by default) synchronized to the status of the collection on the\nserver, for both additions and removals.\n\nThis means that if a package has been removed on the server (and thus has also been\nremoved from the respective collection), \"tlmgr\" will remove the package in the local\ninstallation. This is called ``auto-remove'' and is announced as such when using the\noption \"--list\". This auto-removal can be suppressed using the option \"--no-auto-remove\"\n(not recommended, see option description).\n\nAnalogously, if a package has been added to a collection on the server that is also\ninstalled locally, it will be added to the local installation. This is called\n``auto-install'' and is announced as such when using the option \"--list\". This auto-\ninstallation can be suppressed using the option \"--no-auto-install\" (also not\nrecommended).\n\nAn exception to the collection dependency checks (including the auto-installation of\npackages just mentioned) are those that have been ``forcibly removed'' by you, that is,\nyou called \"tlmgr remove --force\" on them. (See the \"remove\" action documentation.) To\nreinstall any such forcibly removed packages use \"--reinstall-forcibly-removed\".\n\nTo reiterate: automatic removals and additions are entirely determined by comparison of\ncollections. Thus, if you manually install an individual package \"foo\" which is later\nremoved from the server, \"tlmgr\" will not notice and will not remove it locally. (It has\nto be this way, without major rearchitecture work, because the tlpdb does not record the\nrepository from which packages come from.)\n\nIf you want to exclude some packages from the current update run (e.g., due to a slow\nlink), see the \"--exclude\" option below.\n", "long": "--all" }, { "name": "--self", "content": "Update \"tlmgr\" itself (that is, the infrastructure packages) if updates to it are\npresent. On Windows this includes updates to the private Perl interpreter shipped inside\nTeX Live.\n\nIf this option is given together with either \"--all\" or a list of packages, then \"tlmgr\"\nwill be updated first and, if this update succeeds, the new version will be restarted to\ncomplete the rest of the updates.\n\nIn short:\n\ntlmgr update --self # update infrastructure only\ntlmgr update --self --all # update infrastructure and all packages\ntlmgr update --force --all # update all packages but *not* infrastructure\n# ... this last at your own risk, not recommended!\n", "long": "--self" }, { "name": "--dry-run", "content": "Nothing is actually installed; instead, the actions to be performed are written to the\nterminal. This is a more detailed report than \"--list\".\n\n--list [pkg]\nConcisely list the packages which would be updated, newly installed, or removed, without\nactually changing anything. If \"--all\" is also given, all available updates are listed.\nIf \"--self\" is given, but not \"--all\", only updates to the critical packages (tlmgr,\ntexlive infrastructure, perl on Windows, etc.) are listed. If neither \"--all\" nor\n\"--self\" is given, and in addition no pkg is given, then \"--all\" is assumed (thus, \"tlmgr\nupdate --list\" is the same as \"tlmgr update --list --all\"). If neither \"--all\" nor\n\"--self\" is given, but specific package names are given, those packages are checked for\nupdates.\n\n--exclude pkg\nExclude pkg from the update process. If this option is given more than once, its\narguments accumulate.\n\nAn argument pkg excludes both the package pkg itself and all its related platform-\nspecific packages pkg.ARCH. For example,\n\ntlmgr update --all --exclude a2ping\n\nwill not update \"a2ping\", \"a2ping.i386-linux\", or any other \"a2ping.\"ARCH package.\n\nIf this option specifies a package that would otherwise be a candidate for auto-\ninstallation, auto-removal, or reinstallation of a forcibly removed package, \"tlmgr\"\nquits with an error message. Excludes are not supported in these circumstances.\n\nThis option can also be set permanently in the tlmgr config file with the key\n\"update-exclude\".\n\n--no-auto-remove [pkg...]\nBy default, \"tlmgr\" tries to remove packages in an existing collection which have\ndisappeared on the server, as described above under \"--all\". This option prevents such\nremovals, either for all packages (with \"--all\"), or for just the given pkg names. This\ncan lead to an inconsistent TeX installation, since packages are not infrequently renamed\nor replaced by their authors. Therefore this is not recommended.\n\n--no-auto-install [pkg...]\nUnder normal circumstances \"tlmgr\" will install packages which are new on the server, as\ndescribed above under \"--all\". This option prevents any such automatic installation,\neither for all packages (with \"--all\"), or the given pkg names.\n\nFurthermore, after the \"tlmgr\" run using this has finished, the packages that would have\nbeen auto-installed will be considered as forcibly removed. So, if \"foobar\" is the only\nnew package on the server, then\n\ntlmgr update --all --no-auto-install\n\nis equivalent to\n\ntlmgr update --all\ntlmgr remove --force foobar\n\nAgain, since packages are sometimes renamed or replaced, using this option is not\nrecommended.\n", "long": "--dry-run" }, { "name": "--reinstall-forcibly-removed", "content": "Under normal circumstances \"tlmgr\" will not install packages that have been forcibly\nremoved by the user; that is, removed with \"remove --force\", or whose installation was\nprohibited by \"--no-auto-install\" during an earlier update.\n\nThis option makes \"tlmgr\" ignore the forcible removals and re-install all such packages.\nThis can be used to completely synchronize an installation with the server's idea of what\nis available:\n\ntlmgr update --reinstall-forcibly-removed --all\n", "long": "--reinstall-forcibly-removed" }, { "name": "--backup", "content": "--backupdir directory\nThese two options control the creation of backups of packages before updating; that is,\nbacking up packages as currently installed. If neither option is given, no backup will\nmade. If \"--backupdir\" is given and specifies a writable directory then a backup will be\nmade in that location. If only \"--backup\" is given, then a backup will be made to the\ndirectory previously set via the \"option\" action (see below). If both are given then a\nbackup will be made to the specified directory.\n\nYou can also set options via the \"option\" action to automatically make backups for all\npackages, and/or keep only a certain number of backups.\n\n\"tlmgr\" always makes a temporary backup when updating packages, in case of download or\nother failure during an update. In contrast, the purpose of this \"--backup\" option is to\nsave a persistent backup in case the actual content of the update causes problems, e.g.,\nintroduces an TeX incompatibility.\n\nThe \"restore\" action explains how to restore from a backup.\n", "long": "--backup" }, { "name": "--no-depends", "content": "If you call for updating a package normally all depending packages will also be checked\nfor updates and updated if necessary. This switch suppresses this behavior.\n", "long": "--no-depends" }, { "name": "--no-depends-at-all", "content": "See above under install (and beware).\n", "long": "--no-depends-at-all" }, { "name": "--force", "content": "Force update of normal packages, without updating \"tlmgr\" itself (unless the \"--self\"\noption is also given). Not recommended.\n\nAlso, \"update --list\" is still performed regardless of this option.\n\nIf the package on the server is older than the package already installed (e.g., if the\nselected mirror is out of date), \"tlmgr\" does not downgrade. Also, packages for uninstalled\nplatforms are not installed.\n\n\"tlmgr\" saves one copy of the main \"texlive.tlpdb\" file used for an update with a suffix\nrepresenting the repository url, as in \"tlpkg/texlive.tlpdb.main.\"long-hash-string. Thus,\neven when many mirrors are used, only one main \"tlpdb\" backup is kept. For non-main\nrepositories, which do not generally have (m)any mirrors, no pruning of backups is done.\n\nThis action does not automatically add or remove new symlinks in system directories; you need\nto run \"tlmgr\" \"path\" yourself if you are using this feature and want new symlinks added.\n", "long": "--force" } ] }, "CONFIGURATION FILE FOR TLMGR": { "content": "\"tlmgr\" reads two configuration files: one is system-wide, in \"TEXMFSYSCONFIG/tlmgr/config\",\nand the other is user-specific, in \"TEXMFCONFIG/tlmgr/config\". The user-specific one is the\ndefault for the \"conf tlmgr\" action. (Run \"kpsewhich -var-value=TEXMFSYSCONFIG\" or \"...\nTEXMFCONFIG ...\" to see the actual directory names.)\n\nA few defaults corresponding to command-line options can be set in these configuration files.\nIn addition, the system-wide file can contain a directive to restrict the allowed actions.\n\nIn these config files, empty lines and lines starting with # are ignored. All other lines\nmust look like:\n\nkey = value\n\nwhere the spaces are optional but the \"=\" is required.\n\nThe allowed keys are:\n\n\"auto-remove\", value 0 or 1 (default 1), same as command-line option.\n\"gui-expertmode\", value 0 or 1 (default 1). This switches between the full GUI and a\nsimplified GUI with only the most common settings.\n\"gui-lang\" llcode, with a language code value as with the command-line option.\n\"no-checksums\", value 0 or 1 (default 0, see below).\n\"persistent-downloads\", value 0 or 1 (default 1), same as command-line option.\n\"require-verification\", value 0 or 1 (default 0), same as command-line option.\n\"tkfontscale\", value any float. Controls the scaling of fonts in the Tk based frontends.\n\"update-exclude\", value: comma-separated list of packages (no space allowed). Same as the\ncommand line option \"--exclude\" for the action \"update\".\n\"verify-downloads\", value 0 or 1 (default 1), same as command-line option.\n\nThe system-wide config file can contain one additional key:\n\n\"allowed-actions\" action1 [,action,...] The value is a comma-separated list of \"tlmgr\"\nactions which are allowed to be executed when \"tlmgr\" is invoked in system mode (that is,\nwithout \"--usermode\").\nThis allows distributors to include the \"tlmgr\" in their packaging, but allow only a\nrestricted set of actions that do not interfere with their distro package manager. For\nnative TeX Live installations, it doesn't make sense to set this.\n\nThe \"no-checksums\" key needs more explanation. By default, package checksums computed and\nstored on the server (in the TLPDB) are compared to checksums computed locally after\ndownloading. \"no-checksums\" disables this process.\n\nThe checksum algorithm is SHA-512. Your system must have one of (looked for in this order)\nthe Perl \"Digest::SHA\" module, the \"openssl\" program (), the \"sha512sum\"\nprogram (from GNU Coreutils, ), or finally the\n\"shasum\" program (just to support old Macs). If none of these are available, a warning is\nissued and \"tlmgr\" proceeds without checking checksums. (Incidentally, other SHA\nimplementations, such as the pure Perl and pure Lua modules, are much too slow to be usable\nin our context.) \"no-checksums\" avoids the warning.\n", "subsections": [] }, "CRYPTOGRAPHIC VERIFICATION": { "content": "\"tlmgr\" and \"install-tl\" perform cryptographic verification if possible. If verification is\nperformed and successful, the programs report \"(verified)\" after loading the TLPDB;\notherwise, they report \"(not verified)\". But either way, by default the installation and/or\nupdates proceed normally.\n\nIf a program named \"gpg\" is available (that is, found in \"PATH\"), by default cryptographic\nsignatures will be checked: we require the main repository be signed, but not any additional\nrepositories. If \"gpg\" is not available, by default signatures are not checked and no\nverification is carried out, but \"tlmgr\" still proceeds normally.\n\nThe behavior of the verification can be controlled by the command line and config file option\n\"verify-repo\" which takes one of the following values: \"none\", \"main\", or \"all\". With \"none\",\nno verification whatsoever is attempted. With \"main\" (the default) verification is required\nonly for the main repository, and only if \"gpg\" is available; though attempted for all,\nmissing signatures of subsidiary repositories will not result in an error. Finally, in the\ncase of \"all\", \"gpg\" must be available and all repositories need to be signed.\n\nIn all cases, if a signature is checked and fails to verify, an error is raised.\n\nCryptographic verification requires checksum checking (described just above) to succeed, and\na working GnuPG (\"gpg\") program (see below for search method). Then, unless cryptographic\nverification has been disabled, a signature file (\"texlive.tlpdb.*.asc\") of the checksum file\nis downloaded and the signature verified. The signature is created by the TeX Live\nDistribution GPG key 0x0D5E5D9106BAB6BC, which in turn is signed by Karl Berry's key\n0x0716748A30D155AD and Norbert Preining's key 0x6CACA448860CDC13. All of these keys are\nobtainable from the standard key servers.\n\nAdditional trusted keys can be added using the \"key\" action.\n", "subsections": [ { "name": "Configuration of GnuPG invocation", "content": "The executable used for GnuPG is searched as follows: If the environment variable \"TLGNUPG\"\nis set, it is tested and used; otherwise \"gpg\" is checked; finally \"gpg2\" is checked.\n\nFurther adaptation of the \"gpg\" invocation can be made using the two environment variables\n\"TLGNUPGHOME\", which is passed to \"gpg\" as the value for \"--homedir\", and \"TLGNUPGARGS\",\nwhich replaces the default options \"--no-secmem-warning --no-permission-warning\".\n" } ] }, "USER MODE": { "content": "\"tlmgr\" provides a restricted way, called ``user mode'', to manage arbitrary texmf trees in\nthe same way as the main installation. For example, this allows people without write\npermissions on the installation location to update/install packages into a tree of their own.\n\n\"tlmgr\" is switched into user mode with the command line option \"--usermode\". It does not\nswitch automatically, nor is there any configuration file setting for it. Thus, this option\nhas to be explicitly given every time user mode is to be activated.\n\nThis mode of \"tlmgr\" works on a user tree, by default the value of the \"TEXMFHOME\" variable.\nThis can be overridden with the command line option \"--usertree\". In the following when we\nspeak of the user tree we mean either \"TEXMFHOME\" or the one given on the command line.\n\nNot all actions are allowed in user mode; \"tlmgr\" will warn you and not carry out any\nproblematic actions. Currently not supported (and probably will never be) is the \"platform\"\naction. The \"gui\" action is currently not supported, but may be in a future release.\n\nSome \"tlmgr\" actions don't need any write permissions and thus work the same in user mode and\nnormal mode. Currently these are: \"check\", \"help\", \"list\", \"print-platform\",\n\"print-platform-info\", \"search\", \"show\", \"version\".\n\nOn the other hand, most of the actions dealing with package management do need write\npermissions, and thus behave differently in user mode, as described below: \"install\",\n\"update\", \"remove\", \"option\", \"paper\", \"generate\", \"backup\", \"restore\", \"uninstall\",\n\"symlinks\".\n\nBefore using \"tlmgr\" in user mode, you have to set up the user tree with the \"init-usertree\"\naction. This creates usertree\"/web2c\" and usertree\"/tlpkg/tlpobj\", and a minimal\nusertree\"/tlpkg/texlive.tlpdb\". At that point, you can tell \"tlmgr\" to do the (supported)\nactions by adding the \"--usermode\" command line option.\n\nIn user mode the file usertree\"/tlpkg/texlive.tlpdb\" contains only the packages that have\nbeen installed into the user tree using \"tlmgr\", plus additional options from the ``virtual''\npackage \"00texlive.installation\" (similar to the main installation's \"texlive.tlpdb\").\n\nAll actions on packages in user mode can only be carried out on packages that are known as\n\"relocatable\". This excludes all packages containing executables and a few other core\npackages. Of the 2500 or so packages currently in TeX Live the vast majority are relocatable\nand can be installed into a user tree.\n\nDescription of changes of actions in user mode:\n", "subsections": [ { "name": "User mode install", "content": "In user mode, the \"install\" action checks that the package and all dependencies are all\neither relocated or already installed in the system installation. If this is the case, it\nunpacks all containers to be installed into the user tree (to repeat, that's either\n\"TEXMFHOME\" or the value of \"--usertree\") and add the respective packages to the user tree's\n\"texlive.tlpdb\" (creating it if need be).\n\nCurrently installing a collection in user mode installs all dependent packages, but in\ncontrast to normal mode, does not install dependent collections. For example, in normal mode\n\"tlmgr install collection-context\" would install \"collection-basic\" and other collections,\nwhile in user mode, only the packages mentioned in \"collection-context\" are installed.\n\nIf a package shipping map files is installed in user mode, a backup of the user's\n\"updmap.cfg\" in \"USERTREE/web2c/\" is made, and then this file regenerated from the list of\ninstalled packages.\n" }, { "name": "User mode backup, restore, remove, update", "content": "In user mode, these actions check that all packages to be acted on are installed in the user\ntree before proceeding; otherwise, they behave just as in normal mode.\n" }, { "name": "User mode generate, option, paper", "content": "In user mode, these actions operate only on the user tree's configuration files and/or\n\"texlive.tlpdb\". creates configuration files in user tree\n" } ] }, "MULTIPLE REPOSITORIES": { "content": "The main TeX Live repository contains a vast array of packages. Nevertheless, additional\nlocal repositories can be useful to provide locally-installed resources, such as proprietary\nfonts and house styles. Also, alternative package repositories distribute packages that\ncannot or should not be included in TeX Live, for whatever reason.\n\nThe simplest and most reliable method is to temporarily set the installation source to any\nrepository (with the \"-repository\" or \"option repository\" command line options), and perform\nyour operations.\n\nWhen you are using multiple repositories over a sustained length of time, however, explicitly\nswitching between them becomes inconvenient. Thus, it's possible to tell \"tlmgr\" about\nadditional repositories you want to use. The basic command is \"tlmgr repository add\". The\nrest of this section explains further.\n\nWhen using multiple repositories, one of them has to be set as the main repository, which\ndistributes most of the installed packages. When you switch from a single repository\ninstallation to a multiple repository installation, the previous sole repository will be set\nas the main repository.\n\nBy default, even if multiple repositories are configured, packages are still only installed\nfrom the main repository. Thus, simply adding a second repository does not actually enable\ninstallation of anything from there. You also have to specify which packages should be taken\nfrom the new repository, by specifying so-called ``pinning'' rules, described next.\n", "subsections": [ { "name": "Pinning", "content": "When a package \"foo\" is pinned to a repository, a package \"foo\" in any other repository, even\nif it has a higher revision number, will not be considered an installable candidate.\n\nAs mentioned above, by default everything is pinned to the main repository. Let's now go\nthrough an example of setting up a second repository and enabling updates of a package from\nit.\n\nFirst, check that we have support for multiple repositories, and have only one enabled (as is\nthe case by default):\n\n$ tlmgr repository list\nList of repositories (with tags if set):\n/var/www/norbert/tlnet\n\nOk. Let's add the \"tlcontrib\" repository (this is a real repository hosted at\n) with the tag \"tlcontrib\":\n\n$ tlmgr repository add http://contrib.texlive.info/current tlcontrib\n\nCheck the repository list again:\n\n$ tlmgr repository list\nList of repositories (with tags if set):\nhttp://contrib.texlive.info/current (tlcontrib)\n/var/www/norbert/tlnet (main)\n\nNow we specify a pinning entry to get the package \"classico\" from \"tlcontrib\":\n\n$ tlmgr pinning add tlcontrib classico\n\nCheck that we can find \"classico\":\n\n$ tlmgr show classico\npackage: classico\n...\nshortdesc: URW Classico fonts\n...\n\n- install \"classico\":\n\n$ tlmgr install classico\ntlmgr: package repositories:\n...\n[1/1, ??:??/??:??] install: classico @tlcontrib [737k]\n\nIn the output here you can see that the \"classico\" package has been installed from the\n\"tlcontrib\" repository (@tlcontrib).\n\nFinally, \"tlmgr pinning\" also supports removing certain or all packages from a given\nrepository:\n\n$ tlmgr pinning remove tlcontrib classico # remove just classico\n$ tlmgr pinning remove tlcontrib --all # take nothing from tlcontrib\n\nA summary of \"tlmgr pinning\" actions is given above.\n" } ] }, "GUI FOR TLMGR": { "content": "The graphical user interface for \"tlmgr\" requires Perl/Tk\n. For Unix-based systems Perl/Tk (as well as\nPerl of course) has to be installed outside of TL.\n has a list of invocations for some distros. For\nWindows the necessary modules are no longer shipped within TeX Live, so you'll have to have\nan external Perl available that includes them.\n\nWe are talking here about the GUI built into tlmgr itself, not about the other tlmgr GUIs,\nwhich are: tlshell (Tcl/Tk-based), tlcockpit (Java-based) and, only on Macs, TeX Live\nUtility. These are invoked as separate programs.\n\nThe GUI mode of tlmgr is started with the invocation \"tlmgr gui\"; assuming Tk is loadable,\nthe graphical user interface will be shown. The main window contains a menu bar, the main\ndisplay, and a status area where messages normally shown on the console are displayed.\n\nWithin the main display there are three main parts: the \"Display configuration\" area, the\nlist of packages, and the action buttons.\n\nAlso, at the top right the currently loaded repository is shown; this also acts as a button\nand when clicked will try to load the default repository. To load a different repository,\nsee the \"tlmgr\" menu item.\n\nFinally, the status area at the bottom of the window gives additional information about what\nis going on.\n", "subsections": [ { "name": "Main display", "content": "Display configuration area\n\nThe first part of the main display allows you to specify (filter) which packages are shown.\nBy default, all are shown. Changes here are reflected right away.\n\nStatus\nSelect whether to show all packages (the default), only those installed, only those not\ninstalled, or only those with update available.\n\nCategory\nSelect which categories are shown: packages, collections, and/or schemes. These are\nbriefly explained in the \"DESCRIPTION\" section above.\n\nMatch\nSelect packages matching for a specific pattern. By default, this searches both\ndescriptions and filenames. You can also select a subset for searching.\n\nSelection\nSelect packages to those selected, those not selected, or all. Here, ``selected'' means\nthat the checkbox in the beginning of the line of a package is ticked.\n\nDisplay configuration buttons\nTo the right there are three buttons: select all packages, select none (a.k.a. deselect\nall), and reset all these filters to the defaults, i.e., show all available.\n\nPackage list area\n\nThe second are of the main display lists all installed packages. If a repository is loaded,\nthose that are available but not installed are also listed.\n\nDouble clicking on a package line pops up an informational window with further details: the\nlong description, included files, etc.\n\nEach line of the package list consists of the following items:\n\na checkbox\nUsed to select particular packages; some of the action buttons (see below) work only on\nthe selected packages.\n\npackage name\nThe name (identifier) of the package as given in the database.\n\nlocal revision (and version)\nIf the package is installed the TeX Live revision number for the installed package will\nbe shown. If there is a catalogue version given in the database for this package, it\nwill be shown in parentheses. However, the catalogue version, unlike the TL revision, is\nnot guaranteed to reflect what is actually installed.\n\nremote revision (and version)\nIf a repository has been loaded the revision of the package in the repository (if\npresent) is shown. As with the local column, if a catalogue version is provided it will\nbe displayed. And also as with the local column, the catalogue version may be stale.\n\nshort description\nThe short description of the package.\n\nMain display action buttons\n\nBelow the list of packages are several buttons:\n\nUpdate all installed\nThis calls \"tlmgr update --all\", i.e., tries to update all available packages. Below\nthis button is a toggle to allow reinstallation of previously removed packages as part of\nthis action.\n\nThe other four buttons only work on the selected packages, i.e., those where the checkbox\nat the beginning of the package line is ticked.\n\nUpdate\nUpdate only the selected packages.\n\nInstall\nInstall the selected packages; acts like \"tlmgr install\", i.e., also installs\ndependencies. Thus, installing a collection installs all its constituent packages.\n\nRemove\nRemoves the selected packages; acts like \"tlmgr remove\", i.e., it will also remove\ndependencies of collections (but not dependencies of normal packages).\n\nBackup\nMakes a backup of the selected packages; acts like \"tlmgr backup\". This action needs the\noption \"backupdir\" set (see \"Options -\" General>).\n" }, { "name": "Menu bar", "content": "The following entries can be found in the menu bar:\n\n\"tlmgr\" menu\nThe items here load various repositories: the default as specified in the TeX Live\ndatabase, the default network repository, the repository specified on the command line\n(if any), and an arbitrarily manually-entered one. Also has the so-necessary \"quit\"\noperation.\n\n\"Options menu\"\nProvides access to several groups of options: \"Paper\" (configuration of default paper\nsizes), \"Platforms\" (only on Unix, configuration of the supported/installed platforms),\n\"GUI Language\" (select language used in the GUI interface), and \"General\" (everything\nelse).\n\nSeveral toggles are also here. The first is \"Expert options\", which is set by default.\nIf you turn this off, the next time you start the GUI a simplified screen will be shown\nthat display only the most important functionality. This setting is saved in the\nconfiguration file of \"tlmgr\"; see \"CONFIGURATION FILE FOR TLMGR\" for details.\n\nThe other toggles are all off by default: for debugging output, to disable the automatic\ninstallation of new packages, and to disable the automatic removal of packages deleted\nfrom the server. Playing with the choices of what is or isn't installed may lead to an\ninconsistent TeX Live installation; e.g., when a package is renamed.\n\n\"Actions menu\"\nProvides access to several actions: update the filename database (aka \"ls-R\", \"mktexlsr\",\n\"texhash\"), rebuild all formats (\"fmtutil-sys --all\"), update the font map database\n(\"updmap-sys\"), restore from a backup of a package, and use of symbolic links in system\ndirectories (not on Windows).\n\nThe final action is to remove the entire TeX Live installation (also not on Windows).\n\n\"Help menu\"\nProvides access to the TeX Live manual (also on the web at\n) and the usual ``About'' box.\n" }, { "name": "GUI options", "content": "Some generic Perl/Tk options can be specified with \"tlmgr gui\" to control the display:\n\n\"-background\" color\nSet background color.\n\n\"-font \"\" fontname fontsize \"\"\"\nSet font, e.g., \"tlmgr gui -font \"helvetica 18\"\". The argument to \"-font\" must be\nquoted, i.e., passed as a single string.\n\n\"-foreground\" color\nSet foreground color.\n\n\"-geometry\" geomspec\nSet the X geometry, e.g., \"tlmgr gui -geometry 1024x512-0+0\" creates the window of\n(approximately) the given size in the upper-right corner of the display.\n\n\"-xrm\" xresource\nPass the arbitrary X resource string xresource.\n\nA few other obscure options are recognized but not mentioned here. See the Perl/Tk\ndocumentation () for the complete list, and any X\ndocumentation for general information.\n" } ] }, "MACHINE-READABLE OUTPUT": { "content": "With the \"--machine-readable\" option, \"tlmgr\" writes to stdout in the fixed line-oriented\nformat described here, and the usual informational messages for human consumption are written\nto stderr (normally they are written to stdout). The idea is that a program can get all the\ninformation it needs by reading stdout.\n\nCurrently this option only applies to the update, install, and \"option\" actions.\n", "subsections": [ { "name": "Machine-readable \"update\" and \"install\" output", "content": "The output format is as follows:\n\nfieldname \"\\t\" value\n...\n\"end-of-header\"\npkgname status localrev serverrev size runtime esttot\n...\n\"end-of-updates\"\nother output from post actions, not in machine readable form\n\nThe header section currently has two fields: \"location-url\" (the repository source from which\nupdates are being drawn), and \"total-bytes\" (the total number of bytes to be downloaded).\n\nThe localrev and serverrev fields for each package are the revision numbers in the local\ninstallation and server repository, respectively. The size field is the number of bytes to\nbe downloaded, i.e., the size of the compressed tar file for a network installation, not the\nunpacked size. The runtime and esttot fields are only present for updated and auto-install\npackages, and contain the currently passed time since start of installation/updates and the\nestimated total time.\n\nLine endings may be either LF or CRLF depending on the current platform.\n\n\"location-url\" location\nThe location may be a url (including \"file:///foo/bar/...\"), or a directory name\n(\"/foo/bar\"). It is the package repository from which the new package information was\ndrawn.\n\n\"total-bytes\" count\nThe count is simply a decimal number, the sum of the sizes of all the packages that need\nupdating or installing (which are listed subsequently).\n\nThen comes a line with only the literal string \"end-of-header\".\n\nEach following line until a line with literal string \"end-of-updates\" reports on one package.\nThe fields on each line are separated by a tab. Here are the fields.\n\npkgname\nThe TeX Live package identifier, with a possible platform suffix for executables. For\ninstance, \"pdftex\" and \"pdftex.i386-linux\" are given as two separate packages, one on\neach line.\n\nstatus\nThe status of the package update. One character, as follows:\n\n\"d\" The package was removed on the server.\n\n\"f\" The package was removed in the local installation, even though a collection\ndepended on it. (E.g., the user ran \"tlmgr remove --force\".)\n\n\"u\" Normal update is needed.\n\n\"r\" Reversed non-update: the locally-installed version is newer than the version on\nthe server.\n\n\"a\" Automatically-determined need for installation, the package is new on the server\nand is (most probably) part of an installed collection.\n\n\"i\" Package will be installed and isn't present in the local installation (action\ninstall).\n\n\"I\" Package is already present but will be reinstalled (action install).\n\nlocalrev\nThe revision number of the installed package, or \"-\" if it is not present locally.\n\nserverrev\nThe revision number of the package on the server, or \"-\" if it is not present on the\nserver.\n\nsize\nThe size in bytes of the package on the server. The sum of all the package sizes is\ngiven in the \"total-bytes\" header field mentioned above.\n\nruntime\nThe run time since start of installations or updates.\n\nesttot\nThe estimated total time.\n" }, { "name": "Machine-readable \"option\" output", "content": "The output format is as follows:\n\nkey \"\\t\" value\n\nIf a value is not saved in the database the string \"(not set)\" is shown.\n\nIf you are developing a program that uses this output, and find that changes would be\nhelpful, do not hesitate to write the mailing list.\n" } ] }, "ENVIRONMENT VARIABLES": { "content": "\"tlmgr\" uses many of the standard TeX environment variables, as reported by, e.g., \"tlmgr\nconf\" (\"conf\").\n\nIn addition, for ease in scripting and debugging, \"tlmgr\" looks for the following environment\nvariables. These are not of interest for normal user installations.\n\n\"TEXLIVECOMPRESSOR\"\nThis variable allows selecting a different compressor program for backups and\nintermediate rollback containers. The order of selection is:\n\n1. If the environment variable \"TEXLIVECOMPRESSOR\" is defined, use it; abort if it\ndoesn't work. Possible values: \"lz4\", \"gzip\", \"xz\". The necessary options are\nadded internally.\n\n2. If lz4 is available (either from the system or TL) and working, use that.\n\n3. If gzip is available (from the system) and working, use that.\n\n4. If xz is available (either from the system or TL) and working, use that.\n\nlz4 and gzip are faster in creating tlmgr's local backups, hence they are preferred. The\nunconditional use of xz for the tlnet containers is unaffected, to minimize download\nsizes.\n\n\"TEXLIVEDOWNLOADER\"\n\"TLDOWNLOADPROGRAM\"\n\"TLDOWNLOADARGS\"\nThese options allow selecting different download programs then the ones automatically\nselected by the installer. The order of selection is:\n\n1. If the environment variable \"TEXLIVEDOWNLOADER\" is defined, use it; abort if the\nspecified program doesn't work. Possible values: \"lwp\", \"curl\", \"wget\". The\nnecessary options are added internally.\n\n2. If the environment variable \"TLDOWNLOADPROGRAM\" is defined (can be any value),\nuse it together with \"TLDOWNLOADARGS\"; abort if it doesn't work.\n\n3. If LWP is available and working, use that (by far the most efficient method, as\nit supports persistent downloads).\n\n4. If curl is available (from the system) and working, use that.\n\n5. If wget is available (either from the system or TL) and working, use that.\n\nTL provides \"wget\" binaries for platforms where necessary, so some download method should\nalways be available.\n\n\"TEXLIVEPREFEROWN\"\nBy default, compression and download programs provided by the system, i.e., found along\n\"PATH\" are preferred over those shipped with TeX Live.\n\nThis can create problems with systems that are too old, and so can be overridden by\nsetting the environment variable \"TEXLIVEPREFEROWN\" to 1. In this case, executables\nshipped with TL will be preferred.\n\nExtra compression/download programs not provided by TL, such as gzip, lwp, and curl, are\nstill checked for on the system and used if available, per the above.\n\"TEXLIVEPREFEROWN\" only applies when the program being checked for is shipped with TL,\nnamely the lz4 and xz compressors and wget downloader.\n\nException: on Windows, the \"tar.exe\" shipped with TL is always used, regardless of any\nsetting.\n", "subsections": [] }, "AUTHORS AND COPYRIGHT": { "content": "This script and its documentation were written for the TeX Live distribution\n() and both are licensed under the GNU General Public License\nVersion 2 or later.\n\n$Id: tlmgr.pl 60557 2021-09-20 10:46:43Z preining $\n\n\n\nperl v5.34.0 2021-09-20 TLMGR(1)", "subsections": [] } }, "summary": "tlmgr - the native TeX Live Manager", "flags": [ { "flag": "", "long": "--debug-translation", "arg": null, "description": "In GUI mode, this switch tells \"tlmgr\" to report any untranslated (or missing) messages to standard error. This can help translators to see what remains to be done." }, { "flag": "", "long": "--machine-readable", "arg": null, "description": "Instead of the normal output intended for human consumption, write (to standard output) a fixed format more suitable for machine parsing. See the \"MACHINE-READABLE OUTPUT\" section below." }, { "flag": "", "long": "--no-execute-actions", "arg": null, "description": "Suppress the execution of the execute actions as defined in the tlpsrc files. Documented only for completeness, as this is only useful in debugging. --package-logfile file \"tlmgr\" logs all package actions (install, remove, update, failed updates, failed restores) to a separate log file, by default \"TEXMFSYSVAR/web2c/tlmgr.log\". This option allows you to specify a different file for the log." }, { "flag": "", "long": "--pause", "arg": null, "description": "This option makes \"tlmgr\" wait for user input before exiting. Useful on Windows to avoid disappearing command windows." }, { "flag": "", "long": "--persistent-downloads", "arg": null, "description": "" }, { "flag": "", "long": "--no-persistent-downloads", "arg": null, "description": "For network-based installations, this option (on by default) makes \"tlmgr\" try to set up a persistent connection (using the \"LWP\" Perl module). The idea is to open and reuse only one connection per session between your computer and the server, instead of initiating a new download for each package. If this is not possible, \"tlmgr\" will fall back to using \"wget\". To disable these persistent connections, use \"--no-persistent-downloads\"." }, { "flag": "", "long": "--pin-file", "arg": null, "description": "Change the pinning file location from \"TEXMFLOCAL/tlpkg/pinning.txt\" (see \"Pinning\" below). Documented only for completeness, as this is only useful in debugging." }, { "flag": "", "long": "--usermode", "arg": null, "description": "Activates user mode for this run of \"tlmgr\"; see \"USER MODE\" below. --usertree dir Uses dir for the tree in user mode; see \"USER MODE\" below." }, { "flag": "", "long": "--verify-repo", "arg": "[none|main|all", "description": "Defines the level of verification done: If \"none\" is specified, no verification whatsoever is done. If \"main\" is given and a working GnuPG (\"gpg\") binary is available, all repositories are checked, but only the main repository is required to be signed. If \"all\" is given, then all repositories need to be signed. See \"CRYPTOGRAPHIC VERIFICATION\" below for details. The standard options for TeX Live programs are also accepted: \"--help/-h/-?\", \"--version\", \"-q\" (no informational messages), \"-v\" (debugging messages, can be repeated). For the details about these, see the \"TeXLive::TLUtils\" documentation. The \"--version\" option shows version information about the TeX Live release and about the \"tlmgr\" script itself. If \"-v\" is also given, revision number for the loaded TeX Live Perl modules are shown, too." } ], "examples": [ "After successfully installing TeX Live, here are a few common operations with \"tlmgr\":", "\"tlmgr option repository ctan\"", "\"tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet\"", "Tell \"tlmgr\" to use a nearby CTAN mirror for future updates; useful if you installed TeX", "Live from the DVD image and want to have continuing updates. The two commands are", "equivalent; \"ctan\" is just an alias for the given url.", "Caveat: \"mirror.ctan.org\" resolves to many different hosts, and they are not perfectly", "synchronized; we recommend updating only daily (at most), and not more often. You can", "choose a particular mirror if problems; the list of all CTAN mirrors with the status of", "each is at .", "\"tlmgr update --list\"", "Report what would be updated without actually updating anything.", "\"tlmgr update --all\"", "Make your local TeX installation correspond to what is in the package repository", "(typically useful when updating from CTAN).", "\"tlmgr info\" what", "Display detailed information about a package what, such as the installation status and", "description, of searches for what in all packages.", "For all the capabilities and details of \"tlmgr\", please read the following voluminous", "information." ], "see_also": [] }