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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Environment Variables (GNU Octave (version 7.3.0))</title>
<meta name="description" content="Environment Variables (GNU Octave (version 7.3.0))">
<meta name="keywords" content="Environment Variables (GNU Octave (version 7.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="System-Utilities.html" rel="up" title="System Utilities">
<link href="Current-Working-Directory.html" rel="next" title="Current Working Directory">
<link href="Process-ID-Information.html" rel="prev" title="Process ID Information">
<style type="text/css">
<!--
a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em}
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {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}
span:hover a.copiable-anchor {visibility: visible}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<div class="section" id="Environment-Variables">
<div class="header">
<p>
Next: <a href="Current-Working-Directory.html" accesskey="n" rel="next">Current Working Directory</a>, Previous: <a href="Process-ID-Information.html" accesskey="p" rel="prev">Process, Group, and User IDs</a>, Up: <a href="System-Utilities.html" accesskey="u" rel="up">System Utilities</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Environment-Variables-1"></span><h3 class="section">36.7 Environment Variables</h3>
<span id="XREFgetenv"></span><dl class="def">
<dt id="index-getenv"><span class="category">: </span><span><em></em> <strong>getenv</strong> <em>(<var>var</var>)</em><a href='#index-getenv' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Return the value of the environment variable <var>var</var>.
</p>
<p>For example,
</p>
<div class="example">
<pre class="example">getenv ("PATH")
</pre></div>
<p>returns a string containing the value of your path.
</p>
<p><strong>See also:</strong> <a href="#XREFsetenv">setenv</a>, <a href="#XREFunsetenv">unsetenv</a>.
</p></dd></dl>
<span id="XREFsetenv"></span><dl class="def">
<dt id="index-setenv"><span class="category">: </span><span><em></em> <strong>setenv</strong> <em>(<var>var</var>, <var>value</var>)</em><a href='#index-setenv' class='copiable-anchor'> ¶</a></span></dt>
<dt id="index-setenv-1"><span class="category">: </span><span><em></em> <strong>setenv</strong> <em>(<var>var</var>)</em><a href='#index-setenv-1' class='copiable-anchor'> ¶</a></span></dt>
<dt id="index-putenv"><span class="category">: </span><span><em></em> <strong>putenv</strong> <em>(…)</em><a href='#index-putenv' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Set the value of the environment variable <var>var</var> to <var>value</var>.
</p>
<p>If no <var>value</var> is specified then the variable will be assigned the null
string.
</p>
<p><strong>See also:</strong> <a href="#XREFunsetenv">unsetenv</a>, <a href="#XREFgetenv">getenv</a>.
</p></dd></dl>
<span id="XREFunsetenv"></span><dl class="def">
<dt id="index-unsetenv"><span class="category">: </span><span><em><var>status</var> =</em> <strong>unsetenv</strong> <em>(<var>var</var>)</em><a href='#index-unsetenv' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Delete the environment variable <var>var</var>.
</p>
<p>Return 0 if the variable was deleted, or did not exist, and -1 if an error
occurred.
</p>
<p><strong>See also:</strong> <a href="#XREFsetenv">setenv</a>, <a href="#XREFgetenv">getenv</a>.
</p></dd></dl>
<span id="XREFget_005fhome_005fdirectory"></span><dl class="def">
<dt id="index-get_005fhome_005fdirectory"><span class="category">: </span><span><em><var>homedir</var> =</em> <strong>get_home_directory</strong> <em>()</em><a href='#index-get_005fhome_005fdirectory' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Return the current home directory.
</p>
<p>On most systems, this is equivalent to <code>getenv ("HOME")</code>. On Windows
systems, if the environment variable <code>HOME</code> is not set then it is
equivalent to
<code>fullfile (getenv ("HOMEDRIVE"), getenv ("HOMEPATH"))</code>
</p>
<p><strong>See also:</strong> <a href="#XREFgetenv">getenv</a>.
</p></dd></dl>
</div>
</body>
</html>
|
