Go to the first, previous, next, last section, table of contents.

# System Utilities

This chapter describes the functions that are available to allow you to get information about what is happening outside of Octave, while it is still running, and use this information in your program. For example, you can get information about environment variables, the current time, and even start other programs from the Octave prompt.

## Timing Utilities

Octave's core set of functions for manipulating time values are patterned after the corresponding functions from the standard C library. Several of these functions use a data structure for time that includes the following elements:

`usec`
  Microseconds after the second (0-999999).
`sec`
  Seconds after the minute (0-61). This number can be 61 to account for leap seconds.
`min`
  Minutes after the hour (0-59).
`hour`
  Hours since midnight (0-23).
`mday`
  Day of the month (1-31).
`mon`
  Months since January (0-11).
`year`
  Years since 1900.
`wday`
  Days since Sunday (0-6).
`yday`
  Days since January 1 (0-365).
`isdst`
  Daylight Savings Time flag.
`zone`
  Time zone.

In the descriptions of the following functions, this structure is referred to as a tm_struct.

Loadable Function: time ()
  Return the current time as the number of seconds since the epoch. The epoch is referenced to 00:00:00 CUT (Coordinated Universal Time) 1 Jan 1970. For example, on Monday February 17, 1997 at 07:15:06 CUT, the value returned by `time` was 856163706.

Function File: ctime (t)
  Convert a value returned from `time` (or any other nonnegative integer), to the local time and return a string of the same form as `asctime`. The function `ctime (time)` is equivalent to `asctime (localtime (time))`. For example,

      ctime (time ())
           => "Mon Feb 17 01:15:06 1997"

Loadable Function: gmtime (t)
  Given a value returned from time (or any nonnegative integer), return a time structure corresponding to CUT. For example,

      gmtime (time ())
           => {
                 usec = 0
                 year = 97
                 mon = 1
                 mday = 17
                 sec = 6
                 zone = CST
                 min = 15
                 wday = 1
                 hour = 7
                 isdst = 0
                 yday = 47
               }

Loadable Function: localtime (t)
  Given a value returned from time (or any nonnegative integer), return a time structure corresponding to the local time zone.

      localtime (time ())
           => {
                 usec = 0
                 year = 97
                 mon = 1
                 mday = 17
                 sec = 6
                 zone = CST
                 min = 15
                 wday = 1
                 hour = 1
                 isdst = 0
                 yday = 47
               }

Loadable Function: mktime (tm_struct)
  Convert a time structure corresponding to the local time to the number of seconds since the epoch. For example,

      mktime (localtime (time ())
           => 856163706

Function File: asctime (tm_struct)
  Convert a time structure to a string using the following five-field format: Thu Mar 28 08:40:14 1996. For example,

      asctime (localtime (time ())
           => "Mon Feb 17 01:15:06 1997\n"

  This is equivalent to `ctime (time ())`.

Loadable Function: strftime (tm_struct)
  Format a time structure in a flexible way using ``%'` substitutions similar to those in `printf`. Except where noted, substituted fields have a fixed size; numeric fields are padded if necessary. Padding is with zeros by default; for fields that display a single number, padding can be changed or inhibited by following the ``%'` with one of the modifiers described below. Unknown field specifiers are copied as normal characters. All other characters are copied to the output without change. For example,

      strftime ("%r (%Z) %A %e %B %Y", localtime (time ())
           => "01:15:06 AM (CST) Monday 17 February 1997"

  Octave's `strftime` function supports a superset of the ANSI C field specifiers.

  Literal character fields:

  `%`
    % character.
  `n`
    Newline character.
  `t`
    Tab character.

  Numeric modifiers (a nonstandard extension):

  `- (dash)`
    Do not pad the field.
  `_ (underscore)`
    Pad the field with spaces.

  Time fields:

  `%H`
    Hour (00-23).
  `%I`
    Hour (01-12).
  `%k`
    Hour (0-23).
  `%l`
    Hour (1-12).
  `%M`
    Minute (00-59).
  `%p`
    Locale's AM or PM.
  `%r`
    Time, 12-hour (hh:mm:ss [AP]M).
  `%R`
    Time, 24-hour (hh:mm).
  `%s`
    Time in seconds since 00:00:00, Jan 1, 1970 (a nonstandard extension).
  `%S`
    Second (00-61).
  `%T`
    Time, 24-hour (hh:mm:ss).
  `%X`
    Locale's time representation (%H:%M:%S).
  `%Z`
    Time zone (EDT), or nothing if no time zone is determinable.

  Date fields:

  `%a`
    Locale's abbreviated weekday name (Sun-Sat).
  `%A`
    Locale's full weekday name, variable length (Sunday-Saturday).
  `%b`
    Locale's abbreviated month name (Jan-Dec).
  `%B`
    Locale's full month name, variable length (January-December).
  `%c`
    Locale's date and time (Sat Nov 04 12:02:33 EST 1989).
  `%C`
    Century (00-99).
  `%d`
    Day of month (01-31).
  `%e`
    Day of month ( 1-31).
  `%D`
    Date (mm/dd/yy).
  `%h`
    Same as %b.
  `%j`
    Day of year (001-366).
  `%m`
    Month (01-12).
  `%U`
    Week number of year with Sunday as first day of week (00-53).
  `%w`
    Day of week (0-6).
  `%W`
    Week number of year with Monday as first day of week (00-53).
  `%x`
    Locale's date representation (mm/dd/yy).
  `%y`
    Last two digits of year (00-99).
  `%Y`
    Year (1970-).

Most of the remaining functions described in this section are not patterned after the standard C library. Some are available for compatiblity with MATLAB and others are provided because they are useful.

Function File: clock ()
  Return a vector containing the current year, month (1-12), day (1-31), hour (0-23), minute (0-59) and second (0-61). For example,

      clock ()
           => [ 1993, 8, 20, 4, 56, 1 ]

  The function clock is more accurate on systems that have the `gettimeofday` function.

Function File: date ()
  Return the date as a character string in the form DD-MMM-YY. For example,

      date ()
           => "20-Aug-93"

Function File: etime (t1, t2)
  Return the difference (in seconds) between two time values returned from `clock`. For example:

      t0 = clock ();
      # many computations later...
      elapsed_time = etime (clock (), t0);

  will set the variable `elapsed_time` to the number of seconds since the variable `t0` was set.

Built-in Function: [total, user, system] = cputime ();
  Return the CPU time used by your Octave session. The first output is the total time spent executing your process and is equal to the sum of second and third outputs, which are the number of CPU seconds spent executing in user mode and the number of CPU seconds spent executing in system mode, respectively. If your system does not have a way to report CPU time usage, `cputime` returns 0 for each of its output values. Note that because Octave used some CPU time to start, it is reasonable to check to see if `cputime` works by checking to see if the total CPU time used is nonzero.

Function File: is_leap_year (year)
  Return 1 if the given year is a leap year and 0 otherwise. If no arguments are provided, `is_leap_year` will use the current year. For example,

      is_leap_year (2000)
           => 1

Function File: tic ()
Function File: toc ()
  These functions set and check a wall-clock timer. For example,

      tic ();
      # many computations later...
      elapsed_time = toc ();

  will set the variable `elapsed_time` to the number of seconds since the most recent call to the function `tic`.

  If you are more interested in the CPU time that your process used, you should use the `cputime` function instead. The `tic` and `toc` functions report the actual wall clock time that elapsed between the calls. This may include time spent processing other jobs or doing nothing at all. For example,

      tic (); sleep (5); toc ()
           => 5
      t = cputime (); sleep (5); cputime () - t
           => 0

  (This example also illustrates that the CPU timer may have a fairly coarse resolution.)

Built-in Function: pause (seconds)
  Suspend the execution of the program. If invoked without any arguments, Octave waits until you type a character. With a numeric argument, it pauses for the given number of seconds. For example, the following statement prints a message and then waits 5 seconds before clearing the screen.

      fprintf (stderr, "wait please...\n");
      pause (5);
      clc;

Built-in Function: sleep (seconds)
  Suspend the execution of the program for the given number of seconds.

Built-in Function: usleep (microseconds)
  Suspend the execution of the program for the given number of microseconds. On systems where it is not possible to sleep for periods of time less than one second, `usleep` will pause the execution for `round (microseconds / 1e6)` seconds.

## Filesystem Utilities

Octave includes the following functions for renaming and deleting files, creating, deleting, and reading directories, and for getting information about the status of files.

Built-in Function: [err, msg] = rename (old, new)
  Change the name of file old to new.

  If successful, err is 0 and msg is an empty string. Otherwise, err is nonzero and msg contains a system-dependent error message.

Built-in Function: [err, msg] = unlink (file)
  Delete file.

  If successful, err is 0 and msg is an empty string. Otherwise, err is nonzero and msg contains a system-dependent error message.

Built-in Function: [files, err, msg] = readdir (dir)
  Return names of the files in the directory dir as an array of strings. If an error occurs, return an empty matrix in files.

  If successful, err is 0 and msg is an empty string. Otherwise, err is nonzero and msg contains a system-dependent error message.

Built-in Function: [err, msg] = mkdir (dir)
  Create a directory named dir.

  If successful, err is 0 and msg is an empty string. Otherwise, err is nonzero and msg contains a system-dependent error message.

Built-in Function: [err, msg] = rmdir (dir)
  Remove the directory named dir.

  If successful, err is 0 and msg is an empty string. Otherwise, err is nonzero and msg contains a system-dependent error message.

Built-in Function: [err, msg] = mkfifo (name)
  Create a FIFO special file.

  If successful, err is 0 and msg is an empty string. Otherwise, err is nonzero and msg contains a system-dependent error message.

Built-in Function: umask (mask)
  Set the permission mask for file creation. The parameter mask is interpreted as an octal number.

Built-in Function: [info, err, msg] = stat (file)
Built-in Function: [info, err, msg] = lstat (file)
  Return a structure s containing the following information about file.
  `dev`
    ID of device containing a directory entry for this file.
  `ino`
    File number of the file.
  `modestr`
    File mode, as a string of ten letters or dashes as would be returned by `ls -l`.
  `nlink`
    Number of links.
  `uid`
    User ID of file's owner.
  `gid`
    Group ID of file's group.
  `rdev`
    ID of device for block or character special files.
  `size`
    Size in bytes.
  `atime`
    Time of last access in the same form as time values returned from `time`. See section Timing Utilities.
  `mtime`
    Time of last modification in the same form as time values returned from `time`. See section Timing Utilities.
  `ctime`
    Time of last file status change in the same form as time values returned from `time`. See section Timing Utilities.
  `blksize`
    Size of blocks in the file.
  `blocks`
    Number of blocks allocated for file.

  If the call is successful err is 0 and msg is an empty string. If the file does not exist, or some other error occurs, s is an empty matrix, err is -1, and msg contains the corresponding system error message.

  If file is a symbolic link, `stat` will return information about the actual file the is referenced by the link. Use `lstat` if you want information about the symbolic link itself.

  For example,

      [s, err, msg] = stat ("/vmlinuz")
           => s =
              {
                atime = 855399756
                rdev = 0
                ctime = 847219094
                uid = 0
                size = 389218
                blksize = 4096
                mtime = 847219094
                gid = 6
                nlink = 1
                blocks = 768
                modestr = -rw-r--r--
                ino = 9316
                dev = 2049
              }
           => err = 0
           => msg =

Built-in Function: glob (pattern)
  Given an array of strings in pattern, return the list of file names that any of them, or an empty string if no patterns match. Tilde expansion is performed on each of the patterns before looking for matching file names. For example,

      glob ("/vm*")
           => "/vmlinuz"

  Note that multiple values are returned in a string matrix with the fill character set to ASCII NUL.

Built-in Function: fnmatch (pattern, string)
  Return 1 or zero for each element of string that matches any of the elements of the string array pattern, using the rules of filename pattern matching. For example,

      fnmatch ("a*b", ["ab"; "axyzb"; "xyzab"])
           => [ 1; 1; 0 ]

Built-in Function: file_in_path (path, file)
  Return the absolute name name of file if it can be found in path. The value of path should be a colon-separated list of directories in the format described for the built-in variable `LOADPATH`.

  If the file cannot be found in the path, an empty matrix is returned. For example,

      file_in_path (LOADPATH, "nargchk.m")
           => "/usr/local/share/octave/2.0/m/general/nargchk.m"

Built-in Function: tilde_expand (string)
  Performs tilde expansion on string. If string begins with a tilde character, (``~'`), all of the characters preceding the first slash (or all characters, if there is no slash) are treated as a possible user name, and the tilde and the following characters up to the slash are replaced by the home directory of the named user. If the tilde is followed immediately by a slash, the tilde is replaced by the home directory of the user running Octave. For example,

      tilde_expand ("~joeuser/bin")
           => "/home/joeuser/bin"
      tilde_expand ("~/bin")
           => "/home/jwe/bin"

## Controlling Subprocesses

Octave includes some high-level commands like `system` and `popen` for starting subprocesses. If you want to run another program to perform some task and then look at its output, you will probably want to use these functions.

Octave also provides several very low-level Unix-like functions which can also be used for starting subprocesses, but you should probably only use them if you can't find any way to do what you need with the higher-level functions.

Built-in Function: system (string, return_output, type)
  Execute a shell command specified by string. The second argument is optional. If type is `"async"`, the process is started in the background and the process id of the child process is returned immediately. Otherwise, the process is started, and Octave waits until it exits. If type argument is omitted, a value of `"sync"` is assumed.

  If two input arguments are given (the actual value of return_output is irrelevant) and the subprocess is started synchronously, or if system is called with one input argument and one or more output arguments, the output from the command is returned. Otherwise, if the subprocess is executed synchronously, it's output is sent to the standard output. To send the output of a command executed with system through the pager, use a command like

      disp (system (cmd, 1));

  or

      printf ("%s\n", system (cmd, 1));

  The `system` function can return two values. The first is any output from the command that was written to the standard output stream, and the second is the output status of the command. For example,

      [output, status] = system ("echo foo; exit 2");

  will set the variable `output` to the string ``foo'`, and the variable `status` to the integer ``2'`.

Built-in Function: fid = popen (command, mode)
  Start a process and create a pipe. The name of the command to run is given by command. The file identifier corresponding to the input or output stream of the process is returned in fid. The argument mode may be
  `"r"`
    The pipe will be connected to the standard output of the process, and open for reading.
  `"w"`
    The pipe will be connected to the standard input of the process, and open for writing.

  For example,

      fid = popen ("ls -ltr / | tail -3", "r");
      while (isstr (s = fgets (fid)))
        fputs (stdout, s);
      endwhile
           -| drwxr-xr-x  33 root  root  3072 Feb 15 13:28 etc
           -| drwxr-xr-x   3 root  root  1024 Feb 15 13:28 lib
           -| drwxrwxrwt  15 root  root  2048 Feb 17 14:53 tmp

Built-in Function: pclose (fid)
  Close a file identifier that was opened by `popen`. You may also use `fclose` for the same purpose.

Built-in Function: [in, out, pid] = popen2 (command, args)
  Start a subprocess with two-way communication. The name of the process is given by command, and args is an array of strings containing options for the command. The file identifiers for the input and output streams of the subprocess are returned in in and out. If execution of the command is successful, pid contains the process ID of the subprocess. Otherwise, pid is -1.

  For example,

      [in, out, pid] = popen2 ("sort", "-nr");
      fputs (in, "these\nare\nsome\nstrings\n");
      fclose (in);
      while (isstr (s = fgets (out)))
        fputs (stdout, s);
      endwhile
      fclose (out);
           -| are
           -| some
           -| strings
           -| these

Built-in Variable: EXEC_PATH
  The variable `EXEC_PATH` is a colon separated list of directories to search when executing subprograms. Its initial value is taken from the environment variable `OCTAVE_EXEC_PATH` (if it exists) or `PATH`, but that value can be overridden by the command line argument `--exec-path PATH`, or by setting the value of `EXEC_PATH` in a startup script. If the value of `EXEC_PATH` begins (ends) with a colon, the directories

      octave-home/libexec/octave/site/exec/arch
      octave-home/libexec/octave/version/exec/arch

  are prepended (appended) to `EXEC_PATH`, where octave-home is the top-level directory where all of Octave is installed (the default value is ``/usr/local'`). If you don't specify a value for `EXEC_PATH` explicitly, these special directories are prepended to your shell path.

In most cases, the following functions simply decode their arguments and make the corresponding Unix system calls. For a complete example of how they can be used, look at the definition of the function `popen2`.

Built-in Function: [pid, msg] = fork ()
  Create a copy of the current process.

  Fork can return one of the following values:

  > 0
    You are in the parent process. The value returned from `fork` is the process id of the child process. You should probably arrange to wait for any child processes to exit.
  0
    You are in the child process. You can call `exec` to start another process. If that fails, you should probably call `exit`.
  < 0
    The call to `fork` failed for some reason. You must take evasive action. A system dependent error message will be waiting in msg.

Built-in Function: [err, msg] = exec (file, args)
  Replace current process with a new process. Calling `exec` without first calling `fork` will terminate your current Octave process and replace it with the program named by file. For example,

      exec ("ls" "-l")

  will run `ls` and return you to your shell prompt.

  If successful, `exec` does not return. If `exec` does return, err will be nonzero, and msg will contain a system-dependent error message.

Built-in Function: [file_ids, err, msg] = pipe ()
  Create a pipe and return the vector file_ids, which corresponding to the reading and writing ends of the pipe.

  If successful, err is 0 and msg is an empty string. Otherwise, err is nonzero and msg contains a system-dependent error message.

Built-in Function: [fid, msg] = dup2 (old, new)
  Duplicate a file descriptor.

  If successful, fid is greater than zero and contains the new file ID. Otherwise, fid is negative and msg contains a system-dependent error message.

Built-in Function: [pid, msg] = waitpid (pid, options)
  Wait for process pid to terminate. The pid argument can be:
  -1
    Wait for any child process.
  0
    Wait for any child process whose process group ID is equal to that of the Octave interpreter process.
  > 0
    Wait for termination of the child process with ID pid.

  The options argument can be:

  0
    Wait until signal is received or a child process exits (this is the default if the options argument is missing).
  1
    Do not hang if status is not immediately available.
  2
    Report the status of any child processes that are stopped, and whose status has not yet been reported since they stopped.
  3
    Implies both 1 and 2.

  If the returned value of pid is greater than 0, it is the process ID of the child process that exited. If an error occurs, pid will be less than zero and msg will contain a system-dependent error message.

Built-in Function: [err, msg] = fcntl (fid, request, arg)
  Change the properties of the open file fid. The following values may be passed as request:
  `F_DUPFD`
    Return a duplicate file descriptor.
  `F_GETFD`
    Return the file descriptor flags for fid.
  `F_SETFD`
    Set the file descriptor flags for fid.
  `F_GETFL`
    Return the file status flags for fid. The following codes may be returned (some of the flags may be undefined on some systems).
    `O_RDONLY`
      Open for reading only.
    `O_WRONLY`
      Open for writing only.
    `O_RDWR`
      Open for reading and writing.
    `O_APPEND`
      Append on each write.
    `O_NONBLOCK`
      Nonblocking mode.
    `O_SYNC`
      Wait for writes to complete.
    `O_ASYNC`
      Asynchronous I/O.
  `F_SETFL`
    Set the file status flags for fid to the value specified by arg. The only flags that can be changed are `O_APPEND` and `O_NONBLOCK`.

  If successful, err is 0 and msg is an empty string. Otherwise, err is nonzero and msg contains a system-dependent error message.

## Process, Group, and User IDs

Built-in Function: getpgrp ()
  Return the process group id of the current process.

Built-in Function: getpid ()
  Return the process id of the current process.

Built-in Function: getppid ()
  Return the process id of the parent process.

Built-in Function: geteuid ()
  Return the effective user id of the current process.

Built-in Function: getuid ()
  Return the real user id of the current process.

Built-in Function: getegid ()
  Return the effective group id of the current process.

Built-in Function: getgid ()
  Return the real group id of the current process.

## Environment Variables

Built-in Function: getenv (var)
  Return the value of the environment variable var. For example,

      getenv ("PATH")

  returns a string containing the value of your path.

Built-in Function: putenv (var, value)
  Set the value of the environment variable var to value.

## Current Working Directory

Command: cd dir
Command: chdir dir
  Change the current working directory to dir. For example,

      cd ~/octave

  Changes the current working directory to ``~/octave'`. If the directory does not exist, an error message is printed and the working directory is not changed.

Built-in Function: pwd ()
  Return the current working directory.

Command: ls options
Command: dir options
  List directory contents. For example,

      ls -l
           -| total 12
           -| -rw-r--r--   1 jwe  users  4488 Aug 19 04:02 foo.m
           -| -rw-r--r--   1 jwe  users  1315 Aug 17 23:14 bar.m

  The `dir` and `ls` commands are implemented by calling your system's directory listing command, so the available options may vary from system to system.

## Password Database Functions

Octave's password database functions return information in a structure with the following fields.

`name`
  The user name.
`passwd`
  The encrypted password, if available.
`uid`
  The numeric user id.
`gid`
  The numeric group id.
`gecos`
  The GECOS field.
`dir`
  The home directory.
`shell`
  The initial shell.

In the descriptions of the following functions, this data structure is referred to as a pw_struct.

Loadable Function: pw_struct = getpwent ()
  Return a structure containing an entry from the password database, opening it if necessary. Once the end of the data has been reached, `getpwent` returns 0.

Loadable Function: pw_struct = getpwuid (uid).
  Return a structure containing the first entry from the password database with the user ID uid. If the user ID does not exist in the database, `getpwuid` returns 0.

Loadable Function: pw_struct = getpwnam (name)
  Return a structure containing the first entry from the password database with the user name name. If the user name does not exist in the database, `getpwname` returns 0.

Loadable Function: setpwent ()
  Return the internal pointer to the beginning of the password database.

Loadable Function: endpwent ()
  Close the password database.

## Group Database Functions

Octave's group database functions return information in a structure with the following fields.

`name`
  The user name.
`passwd`
  The encrypted password, if available.
`gid`
  The numeric group id.
`mem`
  The members of the group.

In the descriptions of the following functions, this data structure is referred to as a grp_struct.

Loadable Function: grp_struct = getgrent ()
  Return an entry from the group database, opening it if necessary. Once the end of the data has been reached, `getgrent` returns 0.

Loadable Function: grp_struct = getgrgid (gid).
  Return the first entry from the group database with the group ID gid. If the group ID does not exist in the database, `getgrgid` returns 0.

Loadable Function: grp_struct = getgrnam (name)
  Return the first entry from the group database with the group name name. If the group name does not exist in the database, `getgrname` returns 0.

Loadable Function: setgrent ()
  Return the internal pointer to the beginning of the group database.

Loadable Function: endgrent ()
  Close the group database.

## System Information

Built-in Function: computer ()
  Print or return a string of the form cpu-vendor-os 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,

      computer ()
           -| i586-pc-linux-gnu

      x = computer ()
           => x = "i586-pc-linux-gnu"

Built-in Function: isieee ()
  Return 1 if your computer claims to conform to the IEEE standard for floating point calculations.

Built-in Function: version ()
  Return Octave's version number as a string. This is also the value of the built-in variable `OCTAVE_VERSION`.

Built-in Variable: OCTAVE_VERSION
  The version number of Octave, as a string.

Built-in Function: octave_config_info ()
  Return a structure containing configuration and installation information.

Loadable Function: getrusage ()
  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. Here is a list of all the possible fields that can be present in the structure returned by `getrusage`:
  ``
  `idrss`
    Unshared data size.
  `inblock`
    Number of block input operations.
  `isrss`
    Unshared stack size.
  `ixrss`
    Shared memory size.
  `majflt`
    Number of major page faults.
  `maxrss`
    Maximum data size.
  `minflt`
    Number of minor page faults.
  `msgrcv`
    Number of messages received.
  `msgsnd`
    Number of messages sent.
  `nivcsw`
    Number of involuntary context switches.
  `nsignals`
    Number of signals received.
  `nswap`
    Number of swaps.
  `nvcsw`
    Number of voluntary context switches.
  `oublock`
    Number of block output operations.
  `stime`
    A structure containing the system CPU time used. The structure has the elements `sec` (seconds) `usec` (microseconds).
  `utime`
    A structure containing the user CPU time used. The structure has the elements `sec` (seconds) `usec` (microseconds).

Go to the first, previous, next, last section, table of contents.