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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- 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>Startup Files (GNU Octave (version 6.2.0))</title>
<meta name="description" content="Startup Files (GNU Octave (version 6.2.0))">
<meta name="keywords" content="Startup Files (GNU Octave (version 6.2.0))">
<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="Concept-Index.html" 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" rel="up" title="Invoking Octave from the Command Line">
<link href="Quitting-Octave.html" rel="next" title="Quitting Octave">
<link href="Command-Line-Options.html" rel="prev" title="Command Line Options">
<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>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<span id="Startup-Files"></span><div class="header">
<p>
Previous: <a href="Command-Line-Options.html" accesskey="p" rel="prev">Command Line Options</a>, Up: <a href="Invoking-Octave-from-the-Command-Line.html" 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" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Startup-Files-1"></span><h4 class="subsection">2.1.2 Startup Files</h4>
<span id="index-initialization"></span>
<span id="index-startup"></span>
<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>
<span id="index-startup-files"></span>
<dl compact="compact">
<dt><code><var>octave-home</var>/share/octave/site/m/startup/octaverc</code></dt>
<dd><span id="index-site-startup-file-1"></span>
<p>where <code><var>octave-home</var></code> 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><span id="index-version-startup-file"></span>
<p>where <code><var>octave-home</var></code> is the directory in which Octave is installed
(the default is <samp>/usr/local</samp>), and <code><var>version</var></code> 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><var>config-dir</var>/octave/octaverc</code></dt>
<dd><span id="index-personal-startup-file"></span>
<p>where <code><var>config-dir</var></code> is the platform-dependent location for user
local configuration files (e.g., <code><span class="nolinebreak">$XDG_CONFIG_HOME</span></code><!-- /@w --> on many Unix-like
operating systems or <code>%APPDATA%</code><!-- /@w --> on Windows).
</p>
</dd>
<dt><code>~/.octaverc</code></dt>
<dd><span id="index-personal-startup-file-1"></span>
<span id="index-octaverc-_007e_002f_002eoctaverc_007e_002f_002eoctaverc-1"></span>
<p>This file is used to make personal changes to the default Octave environment.
</p>
</dd>
<dt><code>.octaverc</code></dt>
<dd><span id="index-project-startup-file"></span>
<span id="index-octaverc-_002eoctaverc_002eoctaverc-1"></span>
<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>
<dt><code>startup.m</code></dt>
<dd><span id="index-startup_002em"></span>
<p>This file is used to make personal changes to the default Octave environment.
It is executed for <small>MATLAB</small> compatibility, but <samp>~/.octaverc</samp> is the
preferred location for configuration changes.
</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 startup files are always processed in the system’s locale charset
(independent of the m-file encoding that is set, for example, in the GUI
properties). In other words, the system’s locale charset is in effect until a
user manually sets the m-file encoding (e.g., in one of the startup files) and
triggers re-parsing of any relevant m-files. Octave can be forced to use a
new encoding with the undocumented function <code>__mfile_encoding__</code>:
</p>
<div class="example">
<pre class="example">__mfile_encoding__ ("utf-8"); # set new encoding
clear ("functions"); # re-parse all .m files in the new encoding
</pre></div>
<p>This changes the encoding that is used to interpret all subsequently run
startup and m-files (not including the currently executing file).
</p>
<hr>
<div class="header">
<p>
Previous: <a href="Command-Line-Options.html" accesskey="p" rel="prev">Command Line Options</a>, Up: <a href="Invoking-Octave-from-the-Command-Line.html" 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" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|