File: tlmgr.Rd

package info (click to toggle)
r-cran-tinytex 0.56-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 276 kB
  • sloc: sh: 13; makefile: 2
file content (143 lines) | stat: -rw-r--r-- 5,303 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/tlmgr.R
\name{tlmgr}
\alias{tlmgr}
\alias{tlmgr_search}
\alias{tlmgr_install}
\alias{tlmgr_remove}
\alias{tlmgr_version}
\alias{tlmgr_update}
\alias{tlmgr_path}
\alias{tlmgr_conf}
\alias{tlmgr_repo}
\title{Run the TeX Live Manager}
\usage{
tlmgr(args = character(), usermode = FALSE, ..., .quiet = FALSE)

tlmgr_search(what, file = TRUE, all = FALSE, global = TRUE, word = FALSE, ...)

tlmgr_install(
  pkgs = character(),
  usermode = FALSE,
  path = !usermode && os != "windows",
  ...
)

tlmgr_remove(pkgs = character(), usermode = FALSE)

tlmgr_version(format = c("raw", "string", "list"))

tlmgr_update(
  all = TRUE,
  self = TRUE,
  more_args = character(),
  usermode = FALSE,
  run_fmtutil = TRUE,
  delete_tlpdb = getOption("tinytex.delete_tlpdb", FALSE),
  ...
)

tlmgr_path(action = c("add", "remove"))

tlmgr_conf(more_args = character(), ...)

tlmgr_repo(url = NULL, ...)
}
\arguments{
\item{args}{A character vector of arguments to be passed to the command
\command{tlmgr}.}

\item{usermode}{(For expert users only) Whether to use TeX Live's
\href{https://www.tug.org/texlive/doc/tlmgr.html#USER-MODE}{user mode}. If
\code{TRUE}, you must have run \code{tlmgr('init-usertree')} once before.
This option allows you to manage a user-level texmf tree, e.g., install a
LaTeX package to your home directory instead of the system directory, to
which you do not have write permission. This option should not be needed on
personal computers, and has some limitations, so please read the
\pkg{tlmgr} manual very carefully before using it.}

\item{...}{For \code{tlmgr()}, additional arguments to be passed to
\code{\link{system2}()} (e.g., \code{stdout = TRUE} to capture stdout). For
other functions, arguments to be passed to \code{tlmgr()}.}

\item{.quiet}{Whether to hide the actual command before executing it.}

\item{what}{A search keyword as a (Perl) regular expression.}

\item{file}{Whether to treat \code{what} as a filename (pattern).}

\item{all}{For \code{tlmgr_search()}, whether to search in everything,
including package names, descriptions, and filenames. For
\code{tlmgr_update()}, whether to update all installed packages.}

\item{global}{Whether to search the online TeX Live Database or locally.}

\item{word}{Whether to restrict the search of package names and descriptions
to match only full words.}

\item{pkgs}{A character vector of LaTeX package names.}

\item{path}{Whether to run \code{tlmgr_path('add')} after installing packages
(\code{path = TRUE} is a conservative default: it is only necessary to do
this after a binary package is installed, such as the \pkg{metafont}
package, which contains the executable \command{mf}, but it does not hurt
even if no binary packages were installed).}

\item{format}{The data format to be returned: \code{raw} means the raw output
of the command \command{tlmgr --version}, \code{string} means a character
string of the format \samp{TeX Live YEAR (TinyTeX) with tlmgr DATE}, and
\code{list} means a list of the form \code{list(texlive = YEAR, tlmgr =
DATE, tinytex = TRUE/FALSE)}.}

\item{self}{Whether to update the TeX Live Manager itself.}

\item{more_args}{A character vector of more arguments to be passed to the
command \command{tlmgr update} or \command{tlmgr conf}.}

\item{run_fmtutil}{Whether to run \command{fmtutil-sys --all} to (re)create
format and hyphenation files after updating \pkg{tlmgr}.}

\item{delete_tlpdb}{Whether to delete the \file{texlive.tlpdb.HASH} files
(where \verb{HASH} is an MD5 hash) under the \file{tlpkg} directory of the
root directory of TeX Live after updating.}

\item{action}{On Unix, add/remove symlinks of binaries to/from the system's
\code{PATH}. On Windows, add/remove the path to the TeXLive binary
directory to/from the system environment variable \code{PATH}.}

\item{url}{The URL of the CTAN mirror. If \code{NULL}, show the current
repository, otherwise set the repository. See the \code{repository}
argument of \code{\link{install_tinytex}()} for examples.}
}
\description{
Execute the \command{tlmgr} command to search for LaTeX packages, install
packages, update packages, and so on.
}
\details{
The \code{tlmgr()} function is a wrapper of \code{system2('tlmgr')}. All
other \code{tlmgr_*()} functions are based on \code{tlmgr} for specific
tasks. For example, \code{tlmgr_install()} runs the command \command{tlmgr
install} to install LaTeX packages, and \code{tlmgr_update} runs the command
\command{tlmgr update}, etc. Note that \code{tlmgr_repo} runs \command{tlmgr
options repository} to query or set the CTAN repository. Please consult the
\pkg{tlmgr} manual for full details.
}
\examples{
\dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
# search for a package that contains titling.sty
tlmgr_search('titling.sty')

# to match titling.sty exactly, add a slash before the keyword, e.g.
tlmgr_search('/titling.sty')

# use a regular expression if you want to be more precise, e.g.
tlmgr_search('/titling\\\\.sty$')

# list all installed LaTeX packages
tlmgr(c('info', '--list', '--only-installed', '--data', 'name'))
\dontshow{\}) # examplesIf}
}
\references{
The \pkg{tlmgr} manual:
  \url{https://www.tug.org/texlive/doc/tlmgr.html}
}