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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Octave: Startup Files</title>
<meta name="description" content="GNU Octave: Startup Files">
<meta name="keywords" content="GNU Octave: Startup Files">
<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="Invoking-Octave-from-the-Command-Line.html#Invoking-Octave-from-the-Command-Line" rel="up" title="Invoking Octave from the Command Line">
<link href="Quitting-Octave.html#Quitting-Octave" rel="next" title="Quitting Octave">
<link href="Command-Line-Options.html#Command-Line-Options" rel="prev" title="Command Line Options">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
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.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Startup-Files"></a>
<div class="header">
<p>
Previous: <a href="Command-Line-Options.html#Command-Line-Options" accesskey="p" rel="prev">Command Line Options</a>, Up: <a href="Invoking-Octave-from-the-Command-Line.html#Invoking-Octave-from-the-Command-Line" accesskey="u" rel="up">Invoking Octave from the Command Line</a> [<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="Startup-Files-1"></a>
<h4 class="subsection">2.1.2 Startup Files</h4>
<a name="index-initialization"></a>
<a name="index-startup"></a>
<p>When Octave starts, it looks for commands to execute from the files in
the following list. These files may contain any valid Octave commands,
including function definitions.
</p>
<a name="index-startup-files"></a>
<dl compact="compact">
<dt><code><var>octave-home</var>/share/octave/site/m/startup/octaverc</code></dt>
<dd><a name="index-site-startup-file"></a>
<p>where <var>octave-home</var> is the directory in which Octave is installed
(the default is <samp>/usr/local</samp>).
This file is provided so that changes to the default Octave environment
can be made globally for all users at your site for all versions of Octave
you have installed. Care should be taken when making changes to this file
since all users of Octave at your site will be affected. The default file
may be overridden by the environment variable <code><span class="nolinebreak">OCTAVE_SITE_INITFILE</span></code><!-- /@w -->.
</p>
</dd>
<dt><code><var>octave-home</var>/share/octave/<var>version</var>/m/startup/octaverc</code></dt>
<dd><a name="index-version-startup-file"></a>
<p>where <var>octave-home</var> is the directory in which Octave is
installed (the default is <samp>/usr/local</samp>), and <var>version</var>
is the version number of Octave. This file is provided so that changes
to the default Octave environment can be made globally for all users of
a particular version of Octave. Care should be taken when making
changes to this file since all users of Octave at your site will be
affected. The default file may be overridden by the environment variable
<code><span class="nolinebreak">OCTAVE_VERSION_INITFILE</span></code><!-- /@w -->.
</p>
</dd>
<dt><code>~/.octaverc</code></dt>
<dd><a name="index-personal-startup-file"></a>
<a name="index-_007e_002f_002eoctaverc"></a>
<p>This file is used to make personal changes to the default
Octave environment.
</p>
</dd>
<dt><code>.octaverc</code></dt>
<dd><a name="index-project-startup-file"></a>
<a name="index-_002eoctaverc"></a>
<p>This file can be used to make changes to the default Octave environment
for a particular project. Octave searches for this file in the current
directory after it reads <samp>~/.octaverc</samp>. Any use of the <code>cd</code>
command in the <samp>~/.octaverc</samp> file will affect the directory where
Octave searches for <samp>.octaverc</samp>.
</p>
<p>If you start Octave in your home directory, commands from the file
<samp>~/.octaverc</samp> will only be executed once.
</p></dd>
</dl>
<p>A message will be displayed as each of the startup files is read if you
invoke Octave with the <samp>--verbose</samp> option but without the
<samp>--silent</samp> option.
</p>
<p>The <code>dump_prefs</code> function is useful for determining what customizations
to Octave are possible and which are in effect.
</p>
<a name="XREFdump_005fprefs"></a><dl>
<dt><a name="index-dump_005fprefs"></a>Function File: <em></em> <strong>dump_prefs</strong> <em>()</em></dt>
<dt><a name="index-dump_005fprefs-1"></a>Function File: <em></em> <strong>dump_prefs</strong> <em>(<var>fid</var>)</em></dt>
<dd><p>Dump all of the current user preference variables in a format that can be
parsed by Octave later. <var>fid</var> is a file descriptor as returned by
<code>fopen</code>. If <var>file</var> is omitted, the listing is printed to stdout.
</p></dd></dl>
<hr>
<div class="header">
<p>
Previous: <a href="Command-Line-Options.html#Command-Line-Options" accesskey="p" rel="prev">Command Line Options</a>, Up: <a href="Invoking-Octave-from-the-Command-Line.html#Invoking-Octave-from-the-Command-Line" accesskey="u" rel="up">Invoking Octave from the Command Line</a> [<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>
</body>
</html>
|
