<!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>GCL SI Manual: Operating System Definitions</title>
<meta name="description" content="GCL SI Manual: Operating System Definitions">
<meta name="keywords" content="GCL SI Manual: Operating System Definitions">
<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="Function-and-Variable-Index.html#Function-and-Variable-Index" rel="index" title="Function and Variable Index">
<link href="Function-and-Variable-Index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Operating-System.html#Operating-System" rel="up" title="Operating System">
<link href="Structures.html#Structures" rel="next" title="Structures">
<link href="Command-Line.html#Command-Line" rel="prev" title="Command Line">
<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="Operating-System-Definitions"></a>
<div class="header">
<p>
Previous: <a href="Command-Line.html#Command-Line" accesskey="p" rel="prev">Command Line</a>, Up: <a href="Operating-System.html#Operating-System" accesskey="u" rel="up">Operating System</a> [<a href="Function-and-Variable-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-and-Variable-Index.html#Function-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Operating-System-Definitions-1"></a>
<h3 class="section">9.2 Operating System Definitions</h3>
<dl>
<dt><a name="index-GET_002dDECODED_002dTIME"></a>Function: <strong>GET-DECODED-TIME</strong> <em>()</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns the current time in decoded time format. Returns nine values: second,
minute, hour, date, month, year, day-of-week, daylight-saving-time-p, and
time-zone.
</p>
</dd></dl>
<dl>
<dt><a name="index-HOST_002dNAMESTRING"></a>Function: <strong>HOST-NAMESTRING</strong> <em>(pathname)</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns the host part of PATHNAME as a string.
</p>
</dd></dl>
<dl>
<dt><a name="index-RENAME_002dFILE"></a>Function: <strong>RENAME-FILE</strong> <em>(file new-name)</em></dt>
<dd><p>Package:LISP
</p>
<p>Renames the file FILE to NEW-NAME. FILE may be a string, a pathname, or
a stream.
</p>
</dd></dl>
<dl>
<dt><a name="index-FILE_002dAUTHOR"></a>Function: <strong>FILE-AUTHOR</strong> <em>(file)</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns the author name of the specified file, as a string.
FILE may be a string or a stream
</p>
</dd></dl>
<dl>
<dt><a name="index-PATHNAME_002dHOST"></a>Function: <strong>PATHNAME-HOST</strong> <em>(pathname)</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns the host slot of PATHNAME.
</p>
</dd></dl>
<dl>
<dt><a name="index-FILE_002dPOSITION"></a>Function: <strong>FILE-POSITION</strong> <em>(file-stream &optional position)</em></dt>
<dd><p>Package:LISP
</p>
<p>Sets the file pointer of the specified file to POSITION, if POSITION is given.
Otherwise, returns the current file position of the specified file.
</p>
</dd></dl>
<dl>
<dt><a name="index-DECODE_002dUNIVERSAL_002dTIME"></a>Function: <strong>DECODE-UNIVERSAL-TIME</strong> <em>(universal-time &optional (timezone -9))</em></dt>
<dd><p>Package:LISP
</p>
<p>Converts UNIVERSAL-TIME into a decoded time at the TIMEZONE.
Returns nine values: second, minute, hour, date, month (1 - 12), year,
day-of-week (0 - 6), daylight-saving-time-p, and time-zone.
TIMEZONE in GCL defaults to 6, the time zone of Austin, Texas.
</p>
</dd></dl>
<dl>
<dt><a name="index-USER_002dHOMEDIR_002dPATHNAME"></a>Function: <strong>USER-HOMEDIR-PATHNAME</strong> <em>(&optional host)</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns the home directory of the logged in user as a pathname. HOST
is ignored.
</p>
</dd></dl>
<dl>
<dt><a name="index-_002aMODULES_002a"></a>Variable: <strong>*MODULES*</strong></dt>
<dd><p>Package:LISP
A list of names of the modules that have been loaded into GCL.
</p>
</dd></dl>
<dl>
<dt><a name="index-SHORT_002dSITE_002dNAME"></a>Function: <strong>SHORT-SITE-NAME</strong> <em>()</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns a string that identifies the physical location of the current GCL.
</p>
</dd></dl>
<dl>
<dt><a name="index-DIRECTORY"></a>Function: <strong>DIRECTORY</strong> <em>(name)</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns a list of files that match NAME. NAME may be a string, a pathname,
or a file stream.
</p>
</dd></dl>
<dl>
<dt><a name="index-SOFTWARE_002dVERSION"></a>Function: <strong>SOFTWARE-VERSION</strong> <em>()</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns a string that identifies the software version of the software
under which GCL is currently running.
</p>
</dd></dl>
<dl>
<dt><a name="index-INTERNAL_002dTIME_002dUNITS_002dPER_002dSECOND"></a>Constant: <strong>INTERNAL-TIME-UNITS-PER-SECOND</strong></dt>
<dd><p>Package:LISP
The number of internal time units that fit into a second.
</p>
</dd></dl>
<dl>
<dt><a name="index-ENOUGH_002dNAMESTRING"></a>Function: <strong>ENOUGH-NAMESTRING</strong> <em>(pathname &optional (defaults *default-pathname-defaults*))</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns a string which uniquely identifies PATHNAME with respect to
DEFAULTS.
</p>
</dd></dl>
<dl>
<dt><a name="index-REQUIRE"></a>Function: <strong>REQUIRE</strong> <em>(module-name &optional (pathname))</em></dt>
<dd><p>Package:LISP
</p>
<p>If the specified module is not present, then loads the appropriate file(s).
PATHNAME may be a single pathname or it may be a list of pathnames.
</p>
</dd></dl>
<dl>
<dt><a name="index-ENCODE_002dUNIVERSAL_002dTIME"></a>Function: <strong>ENCODE-UNIVERSAL-TIME</strong> <em>(second minute hour date month year &optional (timezone ))</em></dt>
<dd><p>Package:LISP
</p>
<p>Does the inverse operation of DECODE-UNIVERSAL-TIME.
</p>
</dd></dl>
<dl>
<dt><a name="index-LISP_002dIMPLEMENTATION_002dVERSION"></a>Function: <strong>LISP-IMPLEMENTATION-VERSION</strong> <em>()</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns a string that tells you when the current GCL implementation is
brought up.
</p>
</dd></dl>
<dl>
<dt><a name="index-MACHINE_002dINSTANCE"></a>Function: <strong>MACHINE-INSTANCE</strong> <em>()</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns a string that identifies the machine instance of the machine
on which GCL is currently running.
</p>
</dd></dl>
<dl>
<dt><a name="index-ROOM"></a>Function: <strong>ROOM</strong> <em>(&optional (x t))</em></dt>
<dd><p>Package:LISP
</p>
<p>Displays information about storage allocation in the following format.
</p>
<ul class="no-bullet">
<li> for each type class
<ul class="no-bullet">
<li> the number of pages so-far allocated for the type class
</li><li> the maximum number of pages for the type class
</li><li> the percentage of used cells to cells so-far allocated
</li><li> the number of times the garbage collector has been called to
collect cells of the type class
</li><li> the implementation types that belongs to the type class
</li></ul>
</li><li> the number of pages actually allocated for contiguous blocks
</li><li> the maximum number of pages for contiguous blocks
</li><li> the number of times the garbage collector has been called to collect
contiguous blocks
</li><li> the number of pages in the hole
</li><li> the maximum number of pages for relocatable blocks
</li><li> the number of times the garbage collector has been called to collect
relocatable blocks
</li><li> the total number of pages allocated for cells
</li><li> the total number of pages allocated
</li><li> the number of available pages
</li><li> the number of pages GCL can use.
<p>The number of times the garbage collector has been called is not shown,
if the number is zero. The optional X is ignored.
</p></li></ul>
</dd></dl>
<dl>
<dt><a name="index-GET_002dUNIVERSAL_002dTIME"></a>Function: <strong>GET-UNIVERSAL-TIME</strong> <em>()</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns the current time as a single integer in universal time format.
</p>
</dd></dl>
<dl>
<dt><a name="index-GET_002dINTERNAL_002dRUN_002dTIME"></a>Function: <strong>GET-INTERNAL-RUN-TIME</strong> <em>()</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns the run time in the internal time format. This is useful for
finding CPU usage. If the operating system allows, a second value
containing CPU usage of child processes is returned.
</p>
</dd></dl>
<dl>
<dt><a name="index-_002aDEFAULT_002dPATHNAME_002dDEFAULTS_002a"></a>Variable: <strong>*DEFAULT-PATHNAME-DEFAULTS*</strong></dt>
<dd><p>Package:LISP
The default pathname-defaults pathname.
</p>
</dd></dl>
<dl>
<dt><a name="index-LONG_002dSITE_002dNAME"></a>Function: <strong>LONG-SITE-NAME</strong> <em>()</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns a string that identifies the physical location of the current GCL.
</p>
</dd></dl>
<dl>
<dt><a name="index-DELETE_002dFILE"></a>Function: <strong>DELETE-FILE</strong> <em>(file)</em></dt>
<dd><p>Package:LISP
Deletes FILE.
</p>
</dd></dl>
<dl>
<dt><a name="index-GET_002dINTERNAL_002dREAL_002dTIME"></a>Function: <strong>GET-INTERNAL-REAL-TIME</strong> <em>()</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns the real time in the internal time format. This is useful for
finding elapsed time.
</p>
</dd></dl>
<dl>
<dt><a name="index-MACHINE_002dTYPE"></a>Function: <strong>MACHINE-TYPE</strong> <em>()</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns a string that identifies the machine type of the machine
on which GCL is currently running.
</p>
</dd></dl>
<dl>
<dt><a name="index-TIME"></a>Macro: <strong>TIME</strong></dt>
<dd><p>Package:LISP
</p>
<p>Syntax:
</p><div class="example">
<pre class="example">(time form)
</pre></div>
<p>Evaluates FORM and outputs timing statistics on *TRACE-OUTPUT*.
</p>
</dd></dl>
<dl>
<dt><a name="index-SOFTWARE_002dTYPE"></a>Function: <strong>SOFTWARE-TYPE</strong> <em>()</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns a string that identifies the software type of the software
under which GCL is currently running.
</p>
</dd></dl>
<dl>
<dt><a name="index-LISP_002dIMPLEMENTATION_002dTYPE"></a>Function: <strong>LISP-IMPLEMENTATION-TYPE</strong> <em>()</em></dt>
<dd><p>Package:LISP
</p>
<p>Returns a string that tells you that you are using a version of GCL.
</p>
</dd></dl>
<dl>
<dt><a name="index-SLEEP"></a>Function: <strong>SLEEP</strong> <em>(n)</em></dt>
<dd><p>Package:LISP
</p>
<p>This function causes execution to be suspended for N seconds. N may
be any non-negative, non-complex number.
</p>
</dd></dl>
<dl>
<dt><a name="index-BREAK_002dON_002dFLOATING_002dPOINT_002dEXCEPTIONS"></a>Function: <strong>BREAK-ON-FLOATING-POINT-EXCEPTIONS</strong> <em>(&key division-by-zero</em></dt>
<dd><p>floating-point-invalid-operation
floating-point-overflow
floating-point-underflow
floating-point-inexact)
Package:SI
</p>
<p>Break on the specified IEEE floating point error conditions. With no
arguments, report the exceptions currently trapped. Disable the break
by setting the key to nil, e.g.
</p>
<p>> (break-on-floaing-point-exceptions :division-by-zero t)
(DIVISION-BY-ZERO)
</p>
<p>> (break-on-floaing-point-exceptions)
(DIVISION-BY-ZERO)
</p>
<p>> (break-on-floaing-point-exceptions :division-by-zero nil)
NIL
</p>
<p>On some of the most common platforms, the offending instruction will be
disassembled, and the register arguments looked up in the saved context
and reported in as operands. Within the error handler, addresses may be
disassembled, and other registers inspected, using the functions defined
in gcl_fpe.lsp.
</p>
</dd></dl>
<hr>
<div class="header">
<p>
Previous: <a href="Command-Line.html#Command-Line" accesskey="p" rel="prev">Command Line</a>, Up: <a href="Operating-System.html#Operating-System" accesskey="u" rel="up">Operating System</a> [<a href="Function-and-Variable-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-and-Variable-Index.html#Function-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
