<html lang="en">
<head>
<title>System Information - GNU Octave</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Octave">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="System-Utilities.html#System-Utilities" title="System Utilities">
<link rel="prev" href="Group-Database-Functions.html#Group-Database-Functions" title="Group Database Functions">
<link rel="next" href="Hashing-Functions.html#Hashing-Functions" title="Hashing Functions">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="System-Information"></a>
<p>
Next: <a rel="next" accesskey="n" href="Hashing-Functions.html#Hashing-Functions">Hashing Functions</a>,
Previous: <a rel="previous" accesskey="p" href="Group-Database-Functions.html#Group-Database-Functions">Group Database Functions</a>,
Up: <a rel="up" accesskey="u" href="System-Utilities.html#System-Utilities">System Utilities</a>
<hr>
</div>
<h3 class="section">36.11 System Information</h3>
<!-- computer scripts/miscellaneous/computer.m -->
<p><a name="doc_002dcomputer"></a>
<div class="defun">
— Function File: [<var>c</var>, <var>maxsize</var>, <var>endian</var>] = <b>computer</b> ()<var><a name="index-computer-3323"></a></var><br>
— Function File: <var>arch</var> = <b>computer</b> (<var>"arch"</var>)<var><a name="index-computer-3324"></a></var><br>
<blockquote><p>Print or return a string of the form <var>cpu</var>-<var>vendor</var>-<var>os</var>
that identifies the kind of computer Octave is running on. If invoked
with an output argument, the value is returned instead of printed. For
example:
<pre class="example"> computer ()
-| i586-pc-linux-gnu
x = computer ()
⇒ x = "i586-pc-linux-gnu"
</pre>
<p>If two output arguments are requested, also return the maximum number
of elements for an array.
<p>If three output arguments are requested, also return the byte order
of the current system as a character (<code>"B"</code> for big-endian or
<code>"L"</code> for little-endian).
<p>If the argument <code>"arch"</code> is specified, return a string
indicating the architecture of the computer on which Octave is
running.
</p></blockquote></div>
<!-- uname src/syscalls.cc -->
<p><a name="doc_002duname"></a>
<div class="defun">
— Built-in Function: [<var>uts</var>, <var>err</var>, <var>msg</var>] = <b>uname</b> ()<var><a name="index-uname-3325"></a></var><br>
<blockquote><p>Return system information in the structure. For example:
<pre class="example"> uname ()
⇒ {
sysname = x86_64
nodename = segfault
release = 2.6.15-1-amd64-k8-smp
version = Linux
machine = #2 SMP Thu Feb 23 04:57:49 UTC 2006
}
</pre>
<p>If successful, <var>err</var> is 0 and <var>msg</var> is an empty string.
Otherwise, <var>err</var> is nonzero and <var>msg</var> contains a
system-dependent error message.
</p></blockquote></div>
<!-- nproc src/DLD-FUNCTIONS/nproc.cc -->
<p><a name="doc_002dnproc"></a>
<div class="defun">
— Loadable Function: <b>nproc</b> ()<var><a name="index-nproc-3326"></a></var><br>
— Loadable Function: <b>nproc</b> (<var>query</var>)<var><a name="index-nproc-3327"></a></var><br>
<blockquote><p>Return the current number of available processors.
<p>If called with the optional argument <var>query</var>, modify how processors
are counted as follows:
<dl>
<dt><code>all</code><dd>total number of processors.
<br><dt><code>current</code><dd>processors available to the current process.
<br><dt><code>overridable</code><dd>likewise, but overridable through the <samp><span class="env">OMP_NUM_THREADS</span></samp><!-- /@w --> environment
variable.
</dl>
</p></blockquote></div>
<!-- ispc scripts/miscellaneous/ispc.m -->
<p><a name="doc_002dispc"></a>
<div class="defun">
— Function File: <b>ispc</b> ()<var><a name="index-ispc-3328"></a></var><br>
<blockquote><p>Return true if Octave is running on a Windows system and false otherwise.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002disunix.html#doc_002disunix">isunix</a>, <a href="doc_002dismac.html#doc_002dismac">ismac</a>.
</p></blockquote></div>
<!-- isunix scripts/miscellaneous/isunix.m -->
<p><a name="doc_002disunix"></a>
<div class="defun">
— Function File: <b>isunix</b> ()<var><a name="index-isunix-3329"></a></var><br>
<blockquote><p>Return true if Octave is running on a Unix-like system and false otherwise.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dismac.html#doc_002dismac">ismac</a>, <a href="doc_002dispc.html#doc_002dispc">ispc</a>.
</p></blockquote></div>
<!-- ismac scripts/miscellaneous/ismac.m -->
<p><a name="doc_002dismac"></a>
<div class="defun">
— Function File: <b>ismac</b> ()<var><a name="index-ismac-3330"></a></var><br>
<blockquote><p>Return true if Octave is running on a Mac OS X system and false otherwise.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002disunix.html#doc_002disunix">isunix</a>, <a href="doc_002dispc.html#doc_002dispc">ispc</a>.
</p></blockquote></div>
<!-- isieee src/sysdep.cc -->
<p><a name="doc_002disieee"></a>
<div class="defun">
— Built-in Function: <b>isieee</b> ()<var><a name="index-isieee-3331"></a></var><br>
<blockquote><p>Return true if your computer <em>claims</em> to conform to the IEEE standard
for floating point calculations. No actual tests are performed.
</p></blockquote></div>
<!-- isdeployed scripts/miscellaneous/isdeployed.m -->
<p><a name="doc_002disdeployed"></a>
<div class="defun">
— Function File: <b>isdeployed</b> ()<var><a name="index-isdeployed-3332"></a></var><br>
<blockquote><p>Return true if the current program has been compiled and is running
separately from the Octave interpreter and false if it is running in
the Octave interpreter. Currently, this function always returns
false in Octave.
</p></blockquote></div>
<!-- OCTAVE_HOME src/defaults.cc -->
<p><a name="doc_002dOCTAVE_005fHOME"></a>
<div class="defun">
— Built-in Function: <b>OCTAVE_HOME</b> ()<var><a name="index-OCTAVE_005fHOME-3333"></a></var><br>
<blockquote><p>Return the name of the top-level Octave installation directory.
</p></blockquote></div>
<!-- matlabroot scripts/path/matlabroot.m -->
<p><a name="doc_002dmatlabroot"></a>
<div class="defun">
— Function File: <b>matlabroot</b> ()<var><a name="index-matlabroot-3334"></a></var><br>
<blockquote><p>Return the name of the top-level Octave installation directory.
<p>This is an alias for the function <code>OCTAVE_HOME</code><!-- /@w --> provided
for compatibility.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dOCTAVE_005fHOME.html#doc_002dOCTAVE_005fHOME">OCTAVE_HOME</a>.
</p></blockquote></div>
<!-- OCTAVE_VERSION src/defaults.cc -->
<p><a name="doc_002dOCTAVE_005fVERSION"></a>
<div class="defun">
— Built-in Function: <b>OCTAVE_VERSION</b> ()<var><a name="index-OCTAVE_005fVERSION-3335"></a></var><br>
<blockquote><p>Return the version number of Octave, as a string.
</p></blockquote></div>
<!-- version scripts/miscellaneous/version.m -->
<p><a name="doc_002dversion"></a>
<div class="defun">
— Function File: <b>version</b> ()<var><a name="index-version-3336"></a></var><br>
<blockquote><p>Return the version number of Octave, as a string.
<p>This is an alias for the function <samp><span class="env">OCTAVE_VERSION</span></samp><!-- /@w --> provided for
compatibility
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dOCTAVE_005fVERSION.html#doc_002dOCTAVE_005fVERSION">OCTAVE_VERSION</a>..
</p></blockquote></div>
<!-- ver scripts/miscellaneous/ver.m -->
<p><a name="doc_002dver"></a>
<div class="defun">
— Function File: <b>ver</b> ()<var><a name="index-ver-3337"></a></var><br>
<blockquote><p>Display a header containing the current Octave version number, license
string and operating system, followed by the installed package names,
versions, and installation directories.
— Function File: v = <b>ver</b> ()<var><a name="index-ver-3338"></a></var><br>
<blockquote><p>Return a vector of structures, respecting Octave and each installed package.
The structure includes the following fields.
<dl>
<dt><code>Name</code><dd>Package name.
<br><dt><code>Version</code><dd>Version of the package.
<br><dt><code>Revision</code><dd>Revision of the package.
<br><dt><code>Date</code><dd>Date respecting the version/revision.
</dl>
— Function File: v = <b>ver</b> (<var>"Octave"</var>)<var><a name="index-ver-3339"></a></var><br>
<blockquote><p>Return version information for Octave only.
— Function File: v = <b>ver</b> (<var>package</var>)<var><a name="index-ver-3340"></a></var><br>
<blockquote><p>Return version information for <var>package</var>.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dversion.html#doc_002dversion">version</a>, <a href="doc_002doctave_005fconfig_005finfo.html#doc_002doctave_005fconfig_005finfo">octave_config_info</a>.
</p></blockquote></div>
<!-- compare_versions scripts/miscellaneous/compare_versions.m -->
<p><a name="doc_002dcompare_005fversions"></a>
<div class="defun">
— Function File: <b>compare_versions</b> (<var>v1, v2, operator</var>)<var><a name="index-compare_005fversions-3341"></a></var><br>
<blockquote><p>Compare two version strings using the given <var>operator</var>.
<p>This function assumes that versions <var>v1</var> and <var>v2</var> are
arbitrarily long strings made of numeric and period characters
possibly followed by an arbitrary string (e.g., "1.2.3", "0.3",
"0.1.2+", or "1.2.3.4-test1").
<p>The version is first split into numeric and character portions
and then the parts are padded to be the same length (i.e., "1.1" would be
padded to be "1.1.0" when being compared with "1.1.1", and
separately, the character parts of the strings are padded with
nulls).
<p>The operator can be any logical operator from the set
<ul>
<li>"=="
equal
<li>"<"
less than
<li>"<="
less than or equal to
<li>">"
greater than
<li>">="
greater than or equal to
<li>"!="
not equal
<li>"~="
not equal
</ul>
<p>Note that version "1.1-test2" will compare as greater than
"1.1-test10". Also, since the numeric part is compared first, "a"
compares less than "1a" because the second string starts with a
numeric part even though <code>double("a")</code> is greater than
<code>double("1").</code>
</p></blockquote></div>
<!-- license scripts/miscellaneous/license.m -->
<p><a name="doc_002dlicense"></a>
<div class="defun">
— Function File: <b>license</b><var><a name="index-license-3342"></a></var><br>
<blockquote><p>Display the license of Octave.
— Function File: <b>license</b> (<var>"inuse"</var>)<var><a name="index-license-3343"></a></var><br>
<blockquote><p>Display a list of packages currently being used.
— Function File: <var>retval</var> = <b>license</b> (<var>"inuse"</var>)<var><a name="index-license-3344"></a></var><br>
<blockquote><p>Return a structure containing the fields <code>feature</code> and <code>user</code>.
— Function File: <var>retval</var> = <b>license</b> (<var>"test", feature</var>)<var><a name="index-license-3345"></a></var><br>
<blockquote><p>Return 1 if a license exists for the product identified by the string
<var>feature</var> and 0 otherwise. The argument <var>feature</var> is case
insensitive and only the first 27 characters are checked.
— Function File: <b>license</b> (<var>"test", feature, toggle</var>)<var><a name="index-license-3346"></a></var><br>
<blockquote><p>Enable or disable license testing for <var>feature</var>, depending on
<var>toggle</var>, which may be one of:
<dl>
<dt>"enable"<dd>Future tests for the specified license of <var>feature</var> are conducted
as usual.
<br><dt>"disable"<dd>Future tests for the specified license of <var>feature</var> return 0.
</dl>
— Function File: <var>retval</var> = <b>license</b> (<var>"checkout", feature</var>)<var><a name="index-license-3347"></a></var><br>
<blockquote><p>Check out a license for <var>feature</var>, returning 1 on success and 0
on failure.
<p>This function is provided for compatibility with <span class="sc">matlab</span>.
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->
<p class="noindent"><strong>See also:</strong> <a href="doc_002dver.html#doc_002dver">ver</a>, <a href="doc_002dversion.html#doc_002dversion">version</a>.
</p></blockquote></div>
<!-- octave_config_info src/toplev.cc -->
<p><a name="doc_002doctave_005fconfig_005finfo"></a>
<div class="defun">
— Built-in Function: <b>octave_config_info</b> ()<var><a name="index-octave_005fconfig_005finfo-3348"></a></var><br>
— Built-in Function: <b>octave_config_info</b> (<var>option</var>)<var><a name="index-octave_005fconfig_005finfo-3349"></a></var><br>
<blockquote><p>Return a structure containing configuration and installation
information for Octave.
<p>If <var>option</var> is a string, return the configuration information for the
specified option.
</blockquote></div>
<!-- usejava scripts/miscellaneous/usejava.m -->
<p><a name="doc_002dusejava"></a>
<div class="defun">
— Function File: <b>usejava</b> (<var>feature</var>)<var><a name="index-usejava-3350"></a></var><br>
<blockquote><p>Return true if the specific Sun Java element <var>feature</var> is available.
<p>Possible features are:
<dl>
<dt>"awt"<dd>Abstract Window Toolkit for GUIs.
<br><dt>"desktop"<dd>Interactive desktop is running.
<br><dt>"jvm"<dd>Java Virtual Machine.
<br><dt>"swing"<dd>Swing components for lightweight GUIs.
</dl>
<p>This function is provided for compatibility with <span class="sc">matlab</span> scripts which
may alter their behavior based on the availability of Java. Octave does
not implement an interface to Java and this function always returns
<code>false</code>.
</p></blockquote></div>
<!-- getrusage src/DLD-FUNCTIONS/getrusage.cc -->
<p><a name="doc_002dgetrusage"></a>
<div class="defun">
— Loadable Function: <b>getrusage</b> ()<var><a name="index-getrusage-3351"></a></var><br>
<blockquote><p>Return a structure containing a number of statistics about the current
Octave process. Not all fields are available on all systems. If it is
not possible to get CPU time statistics, the CPU time slots are set to
zero. Other missing data are replaced by NaN. The list of possible
fields is:
<dl>
<dt><code>idrss</code><dd>Unshared data size.
<br><dt><code>inblock</code><dd>Number of block input operations.
<br><dt><code>isrss</code><dd>Unshared stack size.
<br><dt><code>ixrss</code><dd>Shared memory size.
<br><dt><code>majflt</code><dd>Number of major page faults.
<br><dt><code>maxrss</code><dd>Maximum data size.
<br><dt><code>minflt</code><dd>Number of minor page faults.
<br><dt><code>msgrcv</code><dd>Number of messages received.
<br><dt><code>msgsnd</code><dd>Number of messages sent.
<br><dt><code>nivcsw</code><dd>Number of involuntary context switches.
<br><dt><code>nsignals</code><dd>Number of signals received.
<br><dt><code>nswap</code><dd>Number of swaps.
<br><dt><code>nvcsw</code><dd>Number of voluntary context switches.
<br><dt><code>oublock</code><dd>Number of block output operations.
<br><dt><code>stime</code><dd>A structure containing the system CPU time used. The structure has the
elements <code>sec</code> (seconds) <code>usec</code> (microseconds).
<br><dt><code>utime</code><dd>A structure containing the user CPU time used. The structure has the
elements <code>sec</code> (seconds) <code>usec</code> (microseconds).
</dl>
</p></blockquote></div>
</body></html>
