File: Environment-Variables.html

package info (click to toggle)
octave 4.0.3-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 94,200 kB
  • ctags: 52,925
  • sloc: cpp: 316,850; ansic: 43,469; fortran: 23,670; sh: 13,805; yacc: 8,204; objc: 7,939; lex: 3,631; java: 2,127; makefile: 1,746; perl: 1,022; awk: 988
file content (117 lines) | stat: -rw-r--r-- 5,095 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Octave: Environment Variables</title>

<meta name="description" content="GNU Octave: Environment Variables">
<meta name="keywords" content="GNU Octave: Environment Variables">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="System-Utilities.html#System-Utilities" rel="up" title="System Utilities">
<link href="Current-Working-Directory.html#Current-Working-Directory" rel="next" title="Current Working Directory">
<link href="Process-ID-Information.html#Process-ID-Information" rel="prev" title="Process ID Information">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {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}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
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">
<a name="Environment-Variables"></a>
<div class="header">
<p>
Next: <a href="Current-Working-Directory.html#Current-Working-Directory" accesskey="n" rel="next">Current Working Directory</a>, Previous: <a href="Process-ID-Information.html#Process-ID-Information" accesskey="p" rel="prev">Process ID Information</a>, Up: <a href="System-Utilities.html#System-Utilities" accesskey="u" rel="up">System Utilities</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Environment-Variables-1"></a>
<h3 class="section">36.7 Environment Variables</h3>

<a name="XREFgetenv"></a><dl>
<dt><a name="index-getenv"></a>Built-in Function: <em></em> <strong>getenv</strong> <em>(<var>var</var>)</em></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 (&quot;PATH&quot;)
</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>


<a name="XREFsetenv"></a><dl>
<dt><a name="index-setenv"></a>Built-in Function: <em></em> <strong>setenv</strong> <em>(<var>var</var>, <var>value</var>)</em></dt>
<dt><a name="index-setenv-1"></a>Built-in Function: <em></em> <strong>setenv</strong> <em>(<var>var</var>)</em></dt>
<dt><a name="index-putenv"></a>Built-in Function: <em></em> <strong>putenv</strong> <em>(&hellip;)</em></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>


<a name="XREFunsetenv"></a><dl>
<dt><a name="index-unsetenv"></a>Built-in Function: <em><var>status</var> =</em> <strong>unsetenv</strong> <em>(<var>var</var>)</em></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>


<a name="XREFget_005fhome_005fdirectory"></a><dl>
<dt><a name="index-get_005fhome_005fdirectory"></a>Built-in Function: <em><var>homedir</var> =</em> <strong>get_home_directory</strong> <em>()</em></dt>
<dd><p>Return the current home directory.
</p>
<p>On most systems, this is equivalent to <code>getenv (&quot;HOME&quot;)</code>.  On Windows
systems, if the environment variable <code>HOME</code> is not set then it is
equivalent to
<code>fullfile (getenv (&quot;HOMEDRIVE&quot;), getenv (&quot;HOMEPATH&quot;))</code>
</p>
<p><strong>See also:</strong> <a href="#XREFgetenv">getenv</a>.
</p></dd></dl>





</body>
</html>