aboutsummaryrefslogtreecommitdiff
path: root/src/docs/Environment-Variables.html
blob: 2482e3791c211badd56dbd29d7aa6f91aa53aa15 (plain)
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2020 Cem Keylan

Licensed under Gnu Free Documentation License. -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Environment Variables (Carbs Linux User Manual)</title>

<meta name="description" content="Environment Variables (Carbs Linux User Manual)">
<meta name="keywords" content="Environment Variables (Carbs Linux User Manual)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html" rel="start" title="Top">
<link href="Package-Manager.html" rel="up" title="Package Manager">
<link href="Hooks.html" rel="next" title="Hooks">
<link href="cpt_002dbuild.html" rel="prev" title="cpt-build">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<span id="Environment-Variables"></span><div class="header">
<p>
Next: <a href="Hooks.html" accesskey="n" rel="next">Hooks</a>, Previous: <a href="Usage.html" accesskey="p" rel="prev">Usage</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> &nbsp; </p>
</div>
<hr>
<span id="Environment-Variables-1"></span><h3 class="section">2.2 Environment Variables</h3>

<p>Since there is no configuration file for cpt, the package manager is configured
through environment variables. These can be set per operation, or be set to your
shell configuration or <samp>~/.profile</samp>. Here are the environment variables that
alter the behaviour of <code>cpt</code>:
</p>
<dl compact="compact">
<dt><code>CPT_PATH</code></dt>
<dd><p>Set the locations of your repositories. This is set similar to the <code>PATH</code>
variable.
</p></dd>
<dt><code>XDG_CACHE_HOME</code></dt>
<dd><p>Unless this is set, the <samp>~/.cache</samp> directory will be used instead.
</p></dd>
<dt><code>CPT_CACHE</code></dt>
<dd><p>The cache directory for <code>cpt</code>. Default: <samp>$XDG_CACHE_HOME/cpt</samp>
</p></dd>
<dt><code>CPT_CHOICE</code></dt>
<dd><p>If this is set to 0, a package installation will be aborted on conflicts.
Default: 1
</p></dd>
<dt><code>CPT_COMPRESS</code></dt>
<dd><p>Program used to compress package tarballs. The values should be the default
suffixes for the program. Available values are:
</p><ul>
<li> <code>gz</code>
</li><li> <code>zst</code>
</li><li> <code>bz2</code>
</li><li> <code>xz</code>
</li></ul>
<p>Default: <code>gz</code>
</p></dd>
<dt><code>CPT_DEBUG</code></dt>
<dd><p>If this is set to 1, temporary build directories will not be removed after the
given operation. Default: unset
</p></dd>
<dt><code>CPT_FETCH</code></dt>
<dd><p>If this is set to 0, <code>cpt-update</code> will not fetch the repositories.
This behaviour can also be achieved by adding <samp>-n</samp> or <samp>--no-fetch</samp>
as an argument. Default: 0
</p></dd>
<dt><code>CPT_FORCE</code></dt>
<dd><p>If this is set to 1, some of the <code>cpt</code> tools will continue regardless of
errors or skip certain checks. Here are some examples:
</p>
<ul>
<li> <code>cpt-install</code> will install a package without verifying its manifest.
</li><li> <code>cpt-install</code> will install a package even when there are missing
dependencies.
</li><li> <code>cpt-remove</code> will remove packages even when there are other packages
that depend on the current package.
</li></ul>

<p>This behaviour can also be achieved by adding <samp>-f</samp> or <samp>--force</samp>
as an argument to those utilities.
</p>
<p>Default: 0
</p>
</dd>
<dt><code>CPT_HOOK</code></dt>
<dd><p>Location for the hook file See <a href="Hooks.html">Hooks</a>. Default: unset
</p></dd>
<dt><code>CPT_KEEPLOG</code></dt>
<dd><p>Normally, logs are deleted if the package is built successfully. If set to 1,
logs will be kept even when the packages are built as intended. Default: 0
</p></dd>
<dt><code>CPT_PID</code></dt>
<dd><p>If this variable is set, the temporary files will be created with this variable
as the suffix, instead of the PID of the <code>cpt</code> process. The advantage
is that you can know exactly where the build directory is located, while the
disadvantage is that there will be issues with multiple operations at the
same time. So the best way to use this variable is during one-time <code>cpt</code>
calls.
</p><div class="example">
<pre class="example">CPT_PID=mesa cpt b mesa
</pre></div>
<p>By running the above, you will know that the created build directories will end
with the <tt>*-mesa</tt> suffix.
</p></dd>
<dt><code>CPT_PROMPT</code></dt>
<dd><p>If set to 0, the package manager will not prompt you for anything and will
continue with the default action. This behaviour can also be achieved by adding <samp>-y</samp> or <samp>--no-prompt</samp>
as an argument to some utilities.
Default: 1
</p></dd>
<dt><code>CPT_ROOT</code></dt>
<dd><p>If this variable is set, <code>cpt</code> will assume this as the system root, and
will install/remove/update/list packages assuming this is the system root.
This behaviour can also be achieved by adding <samp>--root</samp> as an argument to some utilities.
</p></dd>
<dt><code>CPT_TEST</code></dt>
<dd><p>If set to 1, <code>cpt-build</code> will run tests where a package has the
<samp>test</samp> build file. This behaviour can also be achieved by adding <samp>-t</samp> or <samp>--test</samp>
as an argument to <code>cpt-build</code>. Default: 0
</p></dd>
<dt><code>CPT_TMPDIR</code></dt>
<dd><p>The directory to create the build files. This can be changed (for example to
/tmp) for building on RAM, saving SSD space, etc. Default: <code>$CPT_CACHE</code>
</p></dd>
</dl>

<hr>
<div class="header">
<p>
Next: <a href="Hooks.html" accesskey="n" rel="next">Hooks</a>, Previous: <a href="Usage.html" accesskey="p" rel="prev">Usage</a>, Up: <a href="Package-Manager.html" accesskey="u" rel="up">Package Manager</a> &nbsp; </p>
</div>



</body>
</html>