The osicat Reference Manual

4.1.1 osicat/osicat.asd

Source

osicat.asd.

Parent Component

osicat (system).

ASDF Systems

osicat.

---

4.1.2 osicat/osicat-sys/osicat-sys.lisp

Source

osicat.asd.

Parent Component

osicat-sys (module).

Packages

osicat-sys.

Public Interface

• bug (function).
• bug (condition).
• define-unsupported-functions (macro).
• file-descriptor (function).
• file-descriptor (type).
• file-descriptor-designator (class).
• filename (function).
• filename (type).
• filename-designator (class).
• free-translated-object (method).
• free-translated-object (method).
• free-translated-object (method).
• native-namestring (function).
• size-of-char (constant).
• size-of-int (constant).
• size-of-long (constant).
• size-of-long-long (constant).
• size-of-pointer (constant).
• size-of-short (constant).
• system-error (function).
• system-error (condition).
• system-error-code (reader method).
• system-error-identifier (reader method).
• system-error-message (reader method).
• translate-to-foreign (method).
• translate-to-foreign (method).
• translate-to-foreign (method).
• unsupported-function (macro).
• unsupported-function (condition).

Internals

• define-designator (macro).
• get-stream-fd (generic function).
• message (reader method).
• pointer-or-nil (function).
• pointer-or-nil (type).
• pointer-or-nil-designator (class).
• uf-function (reader method).

---

4.1.3 osicat/posix/packages.lisp

Source

osicat.asd.

Parent Component

posix (module).

Packages

osicat-posix.

---

4.1.4 osicat/posix/basic-unixint.lisp

Dependency

packages.lisp (file).

Source

osicat.asd.

Parent Component

posix (module).

---

4.1.5 osicat/posix/unixint.lisp

If Feature

(:not :windows)

Dependency

basic-unixint.lisp (file).

Source

osicat.asd.

Parent Component

posix (module).

---

4.1.6 osicat/posix/early.lisp

Dependencies

• unixint.lisp (file).
• basic-unixint.lisp (file).

Source

osicat.asd.

Parent Component

posix (module).

Public Interface

• e2big (condition).
• eacces (condition).
• eaddrinuse (condition).
• eaddrnotavail (condition).
• eafnosupport (condition).
• eagain (condition).
• ealready (condition).
• ebadf (condition).
• ebadmsg (condition).
• ebusy (condition).
• echild (condition).
• econnaborted (condition).
• econnrefused (condition).
• econnreset (condition).
• edeadlk (condition).
• edestaddrreq (condition).
• edom (condition).
• edquot (condition).
• eexist (condition).
• efault (condition).
• efbig (condition).
• ehostdown (condition).
• ehostunreach (condition).
• eidrm (condition).
• eilseq (condition).
• einprogress (condition).
• eintr (condition).
• einval (condition).
• eio (condition).
• eisconn (condition).
• eisdir (condition).
• eloop (condition).
• emfile (condition).
• emlink (condition).
• emsgsize (condition).
• emultihop (condition).
• enametoolong (condition).
• enetdown (condition).
• enetreset (condition).
• enetunreach (condition).
• enfile (condition).
• enobufs (condition).
• enodata (condition).
• enodev (condition).
• enoent (condition).
• enoexec (condition).
• enolck (condition).
• enolink (condition).
• enomem (condition).
• enomsg (condition).
• enonet (condition).
• enoprotoopt (condition).
• enospc (condition).
• enosr (condition).
• enostr (condition).
• enosys (condition).
• enotblk (condition).
• enotconn (condition).
• enotdir (condition).
• enotempty (condition).
• enotsock (condition).
• enotty (condition).
• enxio (condition).
• eopnotsupp (condition).
• eoverflow (condition).
• eperm (condition).
• epfnosupport (condition).
• epipe (condition).
• eproto (condition).
• eprotonosupport (condition).
• eprototype (condition).
• erange (condition).
• eremote (condition).
• erofs (condition).
• eshutdown (condition).
• esocktnosupport (condition).
• espipe (condition).
• esrch (condition).
• estale (condition).
• etime (condition).
• etimedout (condition).
• etoomanyrefs (condition).
• etxtbsy (condition).
• eusers (condition).
• ewouldblock (condition).
• exdev (condition).
• expand-from-foreign (method).
• posix-error (function).
• posix-error (condition).
• posix-error-object (reader method).
• posix-error-syscall (reader method).

Internals

• *map-failed-pointer* (special variable).
• *posix-error-map* (special variable).
• +most-positive-uintptr+ (constant).
• base-type (reader method).
• defcsyscall (macro).
• defsyscall (macro).
• eadv (condition).
• ebade (condition).
• ebadfd (condition).
• ebadr (condition).
• ebadrqc (condition).
• ebadslt (condition).
• ebfont (condition).
• echrng (condition).
• ecomm (condition).
• edeadlock (condition).
• edotdot (condition).
• el2hlt (condition).
• el2nsync (condition).
• el3hlt (condition).
• el3rst (condition).
• elibacc (condition).
• elibbad (condition).
• elibexec (condition).
• elibmax (condition).
• elibscn (condition).
• elnrng (condition).
• emediumtype (condition).
• enavail (condition).
• enoano (condition).
• enocsi (condition).
• enomedium (condition).
• enopkg (condition).
• enotnam (condition).
• enotuniq (condition).
• eremchg (condition).
• eremoteio (condition).
• erestart (condition).
• errno-object (reader method).
• errno-wrapper (class).
• error-generator (reader method).
• error-predicate (reader method).
• esrmnt (condition).
• estrpipe (condition).
• euclean (condition).
• eunatch (condition).
• exfull (condition).
• function-name (reader method).
• get-posix-error-condition (function).
• make-from-pointer-function-name (function).
• make-posix-error (function).
• never-fails (function).
• return-filter (reader method).
• syscall-signal-posix-error (function).
• syscall-signal-posix-error-via-return-value (function).

---

4.1.7 osicat/posix/wrappers.lisp

Dependency

early.lisp (file).

Source

osicat.asd.

Parent Component

posix (module).

---

4.1.8 osicat/posix/basic-unix.lisp

Dependency

wrappers.lisp (file).

Source

osicat.asd.

Parent Component

posix (module).

Public Interface

• *default-open-mode* (special variable).
• *environ* (symbol macro).
• access (function).
• bzero (function).
• chdir (function).
• chmod (function).
• close (function).
• creat (function).
• dup (function).
• dup2 (function).
• fstat (function).
• getcwd (function).
• getenv (function).
• initialize-instance (method).
• memcpy (function).
• memmove (function).
• memset (function).
• mkdir (function).
• mktemp (function).
• open (function).
• pipe (function).
• print-object (method).
• putenv (function).
• read (function).
• realpath (function).
• rename (function).
• rmdir (function).
• sleep (function).
• stat (function).
• stat (class).
• stat-atime (function).
• stat-atime-nsec (function).
• stat-atime-sec (function).
• stat-atimespec (reader method).
• stat-blksize (reader method).
• stat-blocks (reader method).
• stat-ctime (function).
• stat-ctime-nsec (function).
• stat-ctime-sec (function).
• stat-ctimespec (reader method).
• stat-dev (reader method).
• stat-gid (reader method).
• stat-ino (reader method).
• stat-mode (reader method).
• stat-mtime (function).
• stat-mtime-nsec (function).
• stat-mtime-sec (function).
• stat-mtimespec (reader method).
• stat-nlink (reader method).
• stat-rdev (reader method).
• stat-size (reader method).
• stat-uid (reader method).
• strerror (function).
• time (function).
• umask (function).
• unlink (function).
• utime (function).
• write (function).

Internals

• %getcwd (function).
• %mktemp (function).
• %open (function).
• %pipe (function).
• %realpath (function).
• %time (function).
• %utime (function).
• %var-accessor-*environ* (function).
• (setf %var-accessor-*environ*) (function).
• funcall-stat (function).

---

4.1.9 osicat/posix/unix.lisp

If Feature

(:not :windows)

Dependency

basic-unix.lisp (file).

Source

osicat.asd.

Parent Component

posix (module).

Public Interface

• chown (function).
• clock-getres (function).
• clock-gettime (function).
• clock-settime (function).
• closedir (function).
• closelog (function).
• exit (function).
• fchdir (function).
• fchmod (function).
• fchown (function).
• fchownat (function).
• fcntl (function).
• fork (function).
• fstatat (function).
• fstatvfs (function).
• fsync (function).
• futimens (function).
• getdomainname (function).
• getegid (function).
• geteuid (function).
• getgid (function).
• getgrgid (function).
• getgrnam (function).
• gethostname (function).
• getpagesize (function).
• getpgid (function).
• getpgrp (function).
• getpid (function).
• getppid (function).
• getpriority (function).
• getpwnam (function).
• getpwuid (function).
• getrlimit (function).
• getrusage (function).
• gettimeofday (function).
• getuid (function).
• initgroups (function).
• ioctl (function).
• isatty (function).
• kill (function).
• lchown (function).
• link (function).
• linkat (function).
• lockf (function).
• lstat (function).
• mkdirat (function).
• mkdtemp (function).
• mkfifo (function).
• mkfifoat (function).
• mkstemp (function).
• mkstemps (function).
• mlock (function).
• mlockall (function).
• mprotect (function).
• msync (function).
• munlock (function).
• munlockall (function).
• munmap (function).
• nice (function).
• openat (function).
• opendir (function).
• openlog (function).
• readdir (function).
• readlink (function).
• readlinkat (function).
• readv (function).
• renameat (function).
• rewinddir (function).
• seekdir (function).
• setegid (function).
• setenv (function).
• seteuid (function).
• setgid (function).
• setgroups (function).
• setlogmask (function).
• setpgid (function).
• setpgrp (function).
• setpriority (function).
• setregid (function).
• setreuid (function).
• setrlimit (function).
• setsid (function).
• setuid (function).
• statvfs (function).
• symlink (function).
• symlinkat (function).
• sync (function).
• sysconf (function).
• syslog (function).
• tcgetattr (function).
• tcsetattr (function).
• telldir (function).
• timer-create (function).
• timer-delete (function).
• timer-getoverrun (function).
• timer-gettime (function).
• timer-settime (function).
• uname (function).
• unlinkat (function).
• unsetenv (function).
• usleep (function).
• utimensat (function).
• utimes (function).
• wait (function).
• waitpid (function).
• writev (function).

Internals

• %clock-getres (function).
• %clock-gettime (function).
• %clock-settime (function).
• %closelog (function).
• %futimens (function).
• %getdomainname (function).
• %getgrgid-r (function).
• %getgrnam-r (function).
• %gethostname (function).
• %getpwnam-r (function).
• %getpwuid-r (function).
• %getrusage (function).
• %gettimeofday (function).
• %ioctl-with-arg (function).
• %ioctl-without-arg (function).
• %mkdtemp (function).
• %mkstemp (function).
• %mkstemps (function).
• %nice (function).
• %openat (function).
• %openlog (function).
• %readlink (function).
• %readlinkat (function).
• %setgroups (function).
• %sysconf (function).
• %syslog (function).
• %timer-create (function).
• %timer-gettime (function).
• %timer-settime (function).
• %uname (function).
• %utimensat (function).
• %utimes (function).
• %wait (function).
• %waitpid (function).
• *syslog-identity* (special variable).
• deconstruct-itimerspec (function).
• funcall-getgr (function).
• funcall-getpw (function).
• funcall-statvfs (function).

---

4.1.10 osicat/posix/linux.lisp

If Feature

:linux

Dependencies

• unix.lisp (file).
• basic-unix.lisp (file).

Source

osicat.asd.

Parent Component

posix (module).

Public Interface

• fdatasync (function).
• gettid (function).
• syscall (function).

---

4.1.11 osicat/posix/windows.lisp

If Feature

:windows

Dependencies

• linux.lisp (file).
• unix.lisp (file).
• basic-unix.lisp (file).

Source

osicat.asd.

Parent Component

posix (module).

---

4.1.12 osicat/posix/misc.lisp

Dependencies

• windows.lisp (file).
• linux.lisp (file).
• unix.lisp (file).
• basic-unix.lisp (file).

Source

osicat.asd.

Parent Component

posix (module).

Public Interface

• fd-open-p (function).
• repeat-decreasing-timeout (macro).
• repeat-upon-condition (macro).
• repeat-upon-condition-decreasing-timeout (macro).
• repeat-upon-eintr (macro).

---

4.1.13 osicat/windows/package.lisp

Source

osicat.asd.

Parent Component

windows (module).

---

4.1.14 osicat/windows/early.lisp

Dependency

package.lisp (file).

Source

osicat.asd.

Parent Component

windows (module).

---

4.1.15 osicat/windows/windowsint.lisp

Dependency

early.lisp (file).

Source

osicat.asd.

Parent Component

windows (module).

---

4.1.16 osicat/windows/ioctl.lisp

Dependency

windowsint.lisp (file).

Source

osicat.asd.

Parent Component

windows (module).

---

4.1.17 osicat/windows/windows.lisp

Dependency

ioctl.lisp (file).

Source

osicat.asd.

Parent Component

windows (module).

---

4.1.18 osicat/mach/package.lisp

Source

osicat.asd.

Parent Component

mach (module).

---

4.1.19 osicat/mach/mach.lisp

Dependency

package.lisp (file).

Source

osicat.asd.

Parent Component

mach (module).

---

4.1.20 osicat/src/packages.lisp

Source

osicat.asd.

Parent Component

src (module).

Packages

osicat.

---

4.1.21 osicat/src/fd-streams.lisp

Dependency

packages.lisp (file).

Source

osicat.asd.

Parent Component

src (module).

Internals

make-fd-stream (function).

---

4.1.22 osicat/src/osicat.lisp

Dependencies

• packages.lisp (file).
• fd-streams.lisp (file).

Source

osicat.asd.

Parent Component

src (module).

Public Interface

• *default-allow-unprivileged-create* (special variable).
• *temporary-directory* (special variable).
• absolute-pathname (function).
• absolute-pathname-p (function).
• current-directory (function).
• (setf current-directory) (function).
• delete-directory (function).
• delete-directory-and-files (function).
• directory-exists-p (function).
• directory-pathname-p (function).
• environment (function).
• (setf environment) (function).
• environment-variable (function).
• (setf environment-variable) (function).
• file-exists-p (function).
• file-kind (function).
• file-permissions (function).
• (setf file-permissions) (function).
• good-symlink-exists-p (function).
• list-directory (function).
• make-link (function).
• makunbound-environment-variable (function).
• mapdir (function).
• open-temporary-file (function).
• pathname-as-directory (function).
• pathname-as-file (function).
• pathname-directory-pathname (function).
• read-link (function).
• regular-file-exists-p (function).
• relative-pathname-p (function).
• unlink (function).
• unmerge-pathnames (function).
• user-info (function).
• walk-directory (function).
• with-directory-iterator (macro).
• with-temporary-file (macro).

Internals

• %get-file-kind (function).
• %open-temporary-file/fd-streams (function).
• %open-temporary-file/no-fd-streams (function).
• +permissions+ (constant).
• call-with-directory-iterator (function).
• call-with-temporary-file (function).
• component-present-p (function).
• get-file-kind (function).
• to-simple-string (function).

---

4.1.23 osicat/src/windows.lisp

If Feature

:windows

Dependency

packages.lisp (file).

Source

osicat.asd.

Parent Component

src (module).

---

4.1.24 osicat/src/time.lisp

Dependency

packages.lisp (file).

Source

osicat.asd.

Parent Component

src (module).

Public Interface

get-monotonic-time (function).

---

6.1.1 Constants

Constant: size-of-char ¶

Package

osicat-sys.

Source

osicat-sys.lisp.

Constant: size-of-int ¶

Package

osicat-sys.

Source

osicat-sys.lisp.

Constant: size-of-long ¶

Package

osicat-sys.

Source

osicat-sys.lisp.

Constant: size-of-long-long ¶

Package

osicat-sys.

Source

osicat-sys.lisp.

Constant: size-of-pointer ¶

Package

osicat-sys.

Source

osicat-sys.lisp.

Constant: size-of-short ¶

Package

osicat-sys.

Source

osicat-sys.lisp.

---

6.1.2 Special variables

Special Variable: *default-allow-unprivileged-create* ¶

The default value to :ALLOW-UNPRIVILEGED-CREATE argument to MAKE-LINK. Only has an effect on Windows.

Package

osicat.

Source

osicat.lisp.

Special Variable: *default-open-mode* ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Special Variable: *temporary-directory* ¶

Package

osicat.

Source

osicat.lisp.

---

6.1.3 Symbol macros

Symbol Macro: *environ* ¶

Package

osicat-posix.

Source

basic-unix.lisp.

---

6.1.4 Macros

Macro: define-unsupported-functions (&body functions) ¶

Package

osicat-sys.

Source

osicat-sys.lisp.

Macro: repeat-decreasing-timeout ((timeout-var timeout &optional block-name) &body body) ¶

Package

osicat-posix.

Source

misc.lisp.

Macro: repeat-upon-condition ((&rest conditions) &body body) ¶

Package

osicat-posix.

Source

misc.lisp.

Macro: repeat-upon-condition-decreasing-timeout (((&rest conditions) timeout-var timeout &optional block-name) &body body) ¶

Package

osicat-posix.

Source

misc.lisp.

Macro: repeat-upon-eintr (&body body) ¶

Package

osicat-posix.

Source

misc.lisp.

Macro: unsupported-function (name) ¶

Package

osicat-sys.

Source

osicat-sys.lisp.

Macro: with-directory-iterator ((iterator pathspec) &body body) ¶

PATHSPEC must be a valid directory designator: *DEFAULT-PATHNAME-DEFAULTS* is bound, and (CURRENT-DIRECTORY) is set to the designated directory for the dynamic scope of the body.

Within the lexical scope of the body, ITERATOR is defined via macrolet such that successive invocations of (ITERATOR) return the directory entries, one by one. Both files and directories are returned, except ’.’ and ’..’. The order of entries is not guaranteed. The entries are returned as relative pathnames against the designated directory. Entries that are symbolic links are not resolved, but links that point to directories are interpreted as directory designators. Once all entries have been returned, further invocations of (ITERATOR) will all return NIL.

The value returned is the value of the last form evaluated in body. Signals an error if PATHSPEC is wild or does not designate a directory.

Package

osicat.

Source

osicat.lisp.

Macro: with-temporary-file ((stream &key pathspec element-type external-format) &body body) ¶

Within the lexical scope of the body, STREAM is connected to a temporary file as created by OPEN-TEMPORARY-FILE. The file is closed automatically once BODY exits.

Package

osicat.

Source

osicat.lisp.

---

6.1.5 Ordinary functions

Function: absolute-pathname (pathspec &optional default) ¶

Returns an absolute pathname corresponding to PATHSPEC by merging it with DEFAULT, and (CURRENT-DIRECTORY) if necessary.

Package

osicat.

Source

osicat.lisp.

Function: absolute-pathname-p (pathspec) ¶

Returns T if the PATHSPEC designates an absolute pathname, NIL otherwise.

Package

osicat.

Source

osicat.lisp.

Function: access (path amode) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: bug (control &rest args) ¶

Package

osicat-sys.

Source

osicat-sys.lisp.

Function: bzero (buffer length) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: chdir (path) ¶

Changes the current working directory

Package

osicat-posix.

Source

basic-unix.lisp.

Function: chmod (path mode) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: chown (path owner group) ¶

Change ownership of a file.

Package

osicat-posix.

Source

unix.lisp.

Function: clock-getres (clock-id) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: clock-gettime (clock-id) ¶

Returns the time of the clock CLOCKID.

Package

osicat-posix.

Source

unix.lisp.

Function: clock-settime (clock-id) ¶

Sets the time of the clock CLOCKID.

Package

osicat-posix.

Source

unix.lisp.

Function: close (fd) ¶

Close an open file descriptor.

Package

osicat-posix.

Source

basic-unix.lisp.

Function: closedir (dir) ¶

Closes a directory when done listing its contents

Package

osicat-posix.

Source

unix.lisp.

Function: closelog () ¶

Close system log.

Package

osicat-posix.

Source

unix.lisp.

Function: creat (pathname mode) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: current-directory () ¶

CURRENT-DIRECTORY returns the operating system’s current directory, which may or may not correspond to *DEFAULT-PATHNAME-DEFAULTS*.

SETF CURRENT-DIRECTORY changes the operating system’s current directory to the PATHSPEC. An error is signalled if the PATHSPEC is wild or does not designate a directory.

Package

osicat.

Source

osicat.lisp.

Function: (setf current-directory) () ¶

Package

osicat.

Source

osicat.lisp.

Function: delete-directory (pathspec) ¶

Deletes the directory designated by PATHSPEC. Returns T. The directory must be empty. Symbolic links are not followed.

Signals an error if PATHSPEC is wild, doesn’t designate a directory, or if the directory could not be deleted.

Package

osicat.

Source

osicat.lisp.

Function: delete-directory-and-files (dirname &key if-does-not-exist) ¶

Recursively deletes all files and directories within the directory designated by the non-wild pathname designator DIRNAME including DIRNAME itself. IF-DOES-NOT-EXIST must be one of :ERROR or :IGNORE where :ERROR means that an error will be signaled if the directory DIRNAME does not exist.

Package

osicat.

Source

osicat.lisp.

Function: directory-exists-p (pathspec) ¶

Checks whether the file named by the pathname designator PATHSPEC exists and is a directory. Returns its truename if this is the case, NIL otherwise. Follows symbolic links.

Package

osicat.

Source

osicat.lisp.

Function: directory-pathname-p (pathspec) ¶

Returns NIL if PATHSPEC (a pathname designator) does not designate a directory, PATHSPEC otherwise. It is irrelevant whether file or directory designated by PATHSPEC does actually exist.

Package

osicat.

Source

osicat.lisp.

Function: dup (fildes) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: dup2 (fildes1 fildes2) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: environment () ¶

ENVIRONMENT returns the current environment as an assoc-list. SETF ENVIRONMENT modifies the environment its argument.

Often it is preferable to use SETF ENVIRONMENT-VARIABLE and MAKUNBOUND-ENVIRONMENT-VARIABLE to modify the environment instead of SETF ENVIRONMENT.

Package

osicat.

Source

osicat.lisp.

Function: (setf environment) () ¶

Package

osicat.

Source

osicat.lisp.

Function: environment-variable (name) ¶

ENVIRONMENT-VARIABLE returns the environment variable identified by NAME, or NIL if one does not exist. NAME can either be a symbol or a string.

SETF ENVIRONMENT-VARIABLE sets the environment variable identified by NAME to VALUE. Both NAME and VALUE can be either a symbols or strings. Signals an error on failure.

Package

osicat.

Source

osicat.lisp.

Function: (setf environment-variable) (name) ¶

Package

osicat.

Source

osicat.lisp.

Function: exit (code) ¶

Exit a process immediately.

Package

osicat-posix.

Source

unix.lisp.

Function: fchdir (fildes) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: fchmod (fd mode) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: fchown (fd owner group) ¶

Change ownership of an open file.

Package

osicat-posix.

Source

unix.lisp.

Function: fchownat (dirfd path owner group flags) ¶

Change ownership of an open file.

Package

osicat-posix.

Source

unix.lisp.

Function: fcntl (fd cmd &optional arg) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: fd-open-p (fd) ¶

Package

osicat-posix.

Source

misc.lisp.

Function: fdatasync (fd) ¶

Package

osicat-posix.

Source

linux.lisp.

Function: file-descriptor (file-descriptor) ¶

Package

osicat-sys.

Source

osicat-sys.lisp.

Function: file-exists-p (pathspec &optional file-kind) ¶

Checks whether the file named by the pathname designator
PATHSPEC exists, if this is the case and FILE-KIND is specified
it also checks the file kind. If the tests succeed, return two values: truename and file kind of PATHSPEC, NIL otherwise.
Follows symbolic links.

Package

osicat.

Source

osicat.lisp.

Function: file-kind (pathspec &key follow-symlinks) ¶

Returns a keyword indicating the kind of file designated by PATHSPEC, or NIL if the file does not exist. Does not follow symbolic
links by default.

Possible file-kinds in addition to NIL are: :REGULAR-FILE, :SYMBOLIC-LINK, :DIRECTORY, :PIPE, :SOCKET, :CHARACTER-DEVICE, and :BLOCK-DEVICE.
If FOLLOW-SYMLINKS is non-NIL and PATHSPEC designates a broken symlink returns :BROKEN as second value.

Signals an error if PATHSPEC is wild.

Package

osicat.

Source

osicat.lisp.

Function: file-permissions (pathspec) ¶

FILE-PERMISSIONS returns a list of keywords identifying the permissions of PATHSPEC.

SETF FILE-PERMISSIONS sets the permissions of PATHSPEC as identified by the symbols in list.

If PATHSPEC designates a symbolic link, that link is implicitly resolved.

Permission symbols consist of :USER-READ, :USER-WRITE, :USER-EXEC, :GROUP-READ, :GROUP-WRITE, :GROUP-EXEC, :OTHER-READ, :OTHER-WRITE, :OTHER-EXEC, :SET-USER-ID, :SET-GROUP-ID, and :STICKY.

Both signal an error if PATHSPEC is wild, or doesn’t designate an existing file.

Package

osicat.

Source

osicat.lisp.

Function: (setf file-permissions) (pathspec) ¶

Package

osicat.

Source

osicat.lisp.

Function: filename (filename) ¶

Package

osicat-sys.

Source

osicat-sys.lisp.

Function: fork () ¶

Create a child process.

Package

osicat-posix.

Source

unix.lisp.

Function: fstat (fd) ¶

Get information about a file descriptor

Package

osicat-posix.

Source

basic-unix.lisp.

Function: fstatat (dirfd pathname flags) ¶

Get information about a file located in the DIRFD directory

Package

osicat-posix.

Source

unix.lisp.

Function: fstatvfs (fd) ¶

Retrieve file system information.

Package

osicat-posix.

Source

unix.lisp.

Function: fsync (fildes) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: futimens (fd atime-sec atime-nsec mtime-sec mtime-nsec) ¶

Set file access and modification time with nanosecond precision.

Package

osicat-posix.

Source

unix.lisp.

Function: get-monotonic-time () ¶

Gets current time in seconds from a system’s monotonic clock.

Package

osicat-sys.

Source

time.lisp.

Function: getcwd () ¶

Returns the current working directory as a string.

Package

osicat-posix.

Source

basic-unix.lisp.

Function: getdomainname () ¶

Package

osicat-posix.

Source

unix.lisp.

Function: getegid () ¶

Get effective group id of the current process.

Package

osicat-posix.

Source

unix.lisp.

Function: getenv (name) ¶

Returns the value of an environment variable

Package

osicat-posix.

Source

basic-unix.lisp.

Function: geteuid () ¶

Get effective user id of the current process.

Package

osicat-posix.

Source

unix.lisp.

Function: getgid () ¶

Get real group id of the current process.

Package

osicat-posix.

Source

unix.lisp.

Function: getgrgid (gid) ¶

Gets a group-entry, by group id. (reentrant)

Package

osicat-posix.

Source

unix.lisp.

Function: getgrnam (name) ¶

Gets a group-entry, by group name. (reentrant)

Package

osicat-posix.

Source

unix.lisp.

Function: gethostname () ¶

Package

osicat-posix.

Source

unix.lisp.

Function: getpagesize () ¶

Get memory page size.

Package

osicat-posix.

Source

unix.lisp.

Function: getpgid (pid) ¶

Get process group id of a process.

Package

osicat-posix.

Source

unix.lisp.

Function: getpgrp () ¶

Get process group id of the current process.

Package

osicat-posix.

Source

unix.lisp.

Function: getpid () ¶

Returns the process id of the current process

Package

osicat-posix.

Source

unix.lisp.

Function: getppid () ¶

Returns the process id of the current process’s parent

Package

osicat-posix.

Source

unix.lisp.

Function: getpriority (which who) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: getpwnam (name) ¶

Gets the password-entry of a user, by username.

Package

osicat-posix.

Source

unix.lisp.

Function: getpwuid (uid) ¶

Gets the password-entry of a user, by user id.

Package

osicat-posix.

Source

unix.lisp.

Function: getrlimit (resource) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: getrusage (who) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: gettid () ¶

Returns the thread ID of the calling thread.

Package

osicat-posix.

Source

linux.lisp.

Function: gettimeofday () ¶

Return the time in seconds and microseconds.

Package

osicat-posix.

Source

unix.lisp.

Function: getuid () ¶

Get real user id of the current process.

Package

osicat-posix.

Source

unix.lisp.

Function: good-symlink-exists-p (pathspec) ¶

Checks whether the file named by the pathname designator PATHSPEC exists and is a symlink pointing to an existent file.

Package

osicat.

Source

osicat.lisp.

Function: initgroups (user gid) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: ioctl (fd request &optional arg) ¶

Control device.

Package

osicat-posix.

Source

unix.lisp.

Function: isatty (fd) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: kill (pid sig) ¶

Send signal to a process.

Package

osicat-posix.

Source

unix.lisp.

Function: lchown (path owner group) ¶

Change ownership of a file or symlink.

Package

osicat-posix.

Source

unix.lisp.

Function: link (path1 path2) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: linkat (olddirfd oldpath newdirfd newpath flags) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: list-directory (pathspec &key bare-pathnames) ¶

Returns a fresh list of pathnames corresponding to all files
within the directory named by the non-wild pathname designator PATHSPEC.
If BARE-PATHNAMES is non-NIL only the files’s bare pathnames are returned (with an empty directory component), otherwise the files’ pathnames are merged with PATHSPEC.

Package

osicat.

Source

osicat.lisp.

Function: lockf (fd cmd len) ¶

Apply, test or remove a POSIX lock on an open file.

Package

osicat-posix.

Source

unix.lisp.

Function: lstat (path) ¶

Get information about a file or symlink.

Package

osicat-posix.

Source

unix.lisp.

Function: make-link (link &key target hard allow-unprivileged-create) ¶

Creates LINK that points to TARGET. Defaults to a symbolic link, but giving a non-NIL value to the keyword argument :HARD creates a hard link. Returns the pathname of the link.

Relative targets are resolved against the directory of the link. Relative links are resolved against *DEFAULT-PATHNAME-DEFAULTS*.

Windows only: If ALLOW-UNPRIVILEGED-CREATE is non-NIL, requests a symlink is created even if the process does not have administrative privileges. This is only possible if Developer mode is enabled.

Signals an error if either target or link is wild, target does not exist, or link exists already.

Package

osicat.

Source

osicat.lisp.

Function: makunbound-environment-variable (name) ¶

Removes the environment variable identified by NAME from the current environment. NAME can be either a string or a symbol. Returns the string designated by NAME. Signals an error on failure.

Package

osicat.

Source

osicat.lisp.

Function: mapdir (function pathspec) ¶

Applies function to each entry in directory designated by
PATHSPEC in turn and returns a list of the results. Binds *DEFAULT-PATHNAME-DEFAULTS* to the directory designated by pathspec round to function call.

If PATHSPEC designates a symbolic link, it is implicitly resolved.

Signals an error if PATHSPEC is wild or doesn’t designate a directory.

Package

osicat.

Source

osicat.lisp.

Function: memcpy (dest src length) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: memmove (dest src length) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: memset (buffer value length) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: mkdir (path mode) ¶

Create a directory.

Package

osicat-posix.

Source

basic-unix.lisp.

Function: mkdirat (dirfd pathname mode) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: mkdtemp (&optional template) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: mkfifo (path mode) ¶

Create a FIFO (named pipe).

Package

osicat-posix.

Source

unix.lisp.

Function: mkfifoat (dirfd path mode) ¶

Create a FIFO (named pipe).

Package

osicat-posix.

Source

unix.lisp.

Function: mkstemp (&optional template) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: mkstemps (template suffix) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: mktemp (&optional template) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: mlock (addr len) ¶

Lock a range of process address space.

Package

osicat-posix.

Source

unix.lisp.

Function: mlockall (flags) ¶

Lock the address space of a process.

Package

osicat-posix.

Source

unix.lisp.

Function: mprotect (addr len flags) ¶

Set protection of memory mapping.

Package

osicat-posix.

Source

unix.lisp.

Function: msync (addr len flags) ¶

Synchronize memory with physical storage.

Package

osicat-posix.

Source

unix.lisp.

Function: munlock (addr len) ¶

Unlock a range of process address space.

Package

osicat-posix.

Source

unix.lisp.

Function: munlockall () ¶

Package

osicat-posix.

Source

unix.lisp.

Function: munmap (addr len) ¶

Unmap pages of memory.

Package

osicat-posix.

Source

unix.lisp.

Function: native-namestring (pathname) ¶

Package

osicat-sys.

Source

osicat-sys.lisp.

Function: nice (increment) ¶

Change process priority.

Package

osicat-posix.

Source

unix.lisp.

Function: open (pathname flags &optional mode) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: open-temporary-file (&key pathspec element-type external-format) ¶

Creates a temporary file setup for input and output, and returns two VALUES: the stream connected to that file and the pathname of the file or NIL.

PATHSPEC serves as template for the file to be created: a certain number of random characters will be concatenated to the file component of PATHSPEC. If PATHSPEC has no directory component, the file will be created inside *TEMPORARY-DIRECTORY*. If possible, the file itself is unlinked once it has been opened and the second return value is NIL. Otherwise, you must delete the file yourself.

ELEMENT-TYPE specifies the unit of transaction of the stream.
Consider using WITH-TEMPORARY-FILE instead of this function.

On failure, a FILE-ERROR may be signalled.

Package

osicat.

Source

osicat.lisp.

Function: openat (dirfd pathname flags &optional mode) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: opendir (filename) ¶

Opens a directory for listing of its contents

Package

osicat-posix.

Source

unix.lisp.

Function: openlog (name options &optional facility) ¶

Open system log.

Package

osicat-posix.

Source

unix.lisp.

Function: pathname-as-directory (pathspec) ¶

Converts the non-wild pathname designator PATHSPEC to directory form.

Package

osicat.

Source

osicat.lisp.

Function: pathname-as-file (pathspec) ¶

Converts the non-wild pathname designator PATHSPEC to file form.

Package

osicat.

Source

osicat.lisp.

Function: pathname-directory-pathname (pathspec) ¶

Returns the directory part of PATHSPEC as a pathname.

Package

osicat.

Source

osicat.lisp.

Function: pipe () ¶

Create pipe, returns two values with the new FDs.

Package

osicat-posix.

Source

basic-unix.lisp.

Function: posix-error (&optional errno object syscall) ¶

Package

osicat-posix.

Source

early.lisp.

Function: putenv (string) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: read (fd buf count) ¶

Read at most COUNT bytes from FD into the foreign area BUF.

Package

osicat-posix.

Source

basic-unix.lisp.

Function: read-link (pathspec) ¶

Returns the pathname pointed to by the symbolic link designated by PATHSPEC. If the link is relative, then the returned pathname is relative to the link, not *DEFAULT-PATHNAME-DEFAULTS*.

Signals an error if PATHSPEC is wild, or does not designate a symbolic link.

Package

osicat.

Source

osicat.lisp.

Function: readdir (dir) ¶

Reads an item from the listing of a directory (reentrant)

Package

osicat-posix.

Source

unix.lisp.

Function: readlink (path) ¶

Read value of a symbolic link.

Package

osicat-posix.

Source

unix.lisp.

Function: readlinkat (dirfd path) ¶

Read value of a symbolic link, relative to a directory.

Package

osicat-posix.

Source

unix.lisp.

Function: readv (fd iov count) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: realpath (path) ¶

Returns the canonicalized absolute pathname

Package

osicat-posix.

Source

basic-unix.lisp.

Function: regular-file-exists-p (pathspec) ¶

Checks whether the file named by the pathname designator PATHSPEC exists and is a regular file. Returns its truename if this is the case, NIL otherwise. Follows symbolic links.

Package

osicat.

Source

osicat.lisp.

Function: relative-pathname-p (pathspec) ¶

Returns T if the PATHSPEC designates a relative pathname, NIL otherwise.

Package

osicat.

Source

osicat.lisp.

Function: rename (old new) ¶

Rename a file.

Package

osicat-posix.

Source

basic-unix.lisp.

Function: renameat (olddirfd oldpath newdirfd newpath) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: rewinddir (dir) ¶

Rewinds a directory.

Package

osicat-posix.

Source

unix.lisp.

Function: rmdir (path) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: seekdir (dir pos) ¶

Seeks a directory.

Package

osicat-posix.

Source

unix.lisp.

Function: setegid (gid) ¶

Set effective group id of the current process.

Package

osicat-posix.

Source

unix.lisp.

Function: setenv (name value) ¶

Changes the value of an environment variable

Package

osicat-posix.

Source

unix.lisp.

Function: seteuid (uid) ¶

Set effective user id of the current process.

Package

osicat-posix.

Source

unix.lisp.

Function: setgid (gid) ¶

Get real group id of the current process.

Package

osicat-posix.

Source

unix.lisp.

Function: setgroups (gids) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: setlogmask (mask) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: setpgid (pid pgid) ¶

Set process group id of a process.

Package

osicat-posix.

Source

unix.lisp.

Function: setpgrp () ¶

Set process group id of the current process.

Package

osicat-posix.

Source

unix.lisp.

Function: setpriority (which who value) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: setregid (rgid egid) ¶

Set real and effective group id of the current process.

Package

osicat-posix.

Source

unix.lisp.

Function: setreuid (ruid euid) ¶

Set real and effective user id of the current process.

Package

osicat-posix.

Source

unix.lisp.

Function: setrlimit (resource soft-limit hard-limit) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: setsid () ¶

Create session and set process group id of the current process.

Package

osicat-posix.

Source

unix.lisp.

Function: setuid (uid) ¶

Set real user id of the current process.

Package

osicat-posix.

Source

unix.lisp.

Function: sleep (seconds) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: stat (path) ¶

Get information about a file.

Package

osicat-posix.

Source

basic-unix.lisp.

Function: stat-atime (stat) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: stat-atime-nsec (stat) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: stat-atime-sec (stat) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: stat-ctime (stat) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: stat-ctime-nsec (stat) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: stat-ctime-sec (stat) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: stat-mtime (stat) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: stat-mtime-nsec (stat) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: stat-mtime-sec (stat) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: statvfs (path) ¶

Retrieve file system information.

Package

osicat-posix.

Source

unix.lisp.

Function: strerror (&optional err) ¶

Look up the error message string for ERRNO. (reentrant)

Package

osicat-posix.

Source

basic-unix.lisp.

Function: symlink (name1 name2) ¶

Creates a symbolic link

Package

osicat-posix.

Source

unix.lisp.

Function: symlinkat (target newdirfd linkpath) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: sync () ¶

Schedule all file system buffers to be written to disk.

Package

osicat-posix.

Source

unix.lisp.

Function: syscall (number) ¶

Invoke the system call whose assembly language interface is selected with NUMBER.

Package

osicat-posix.

Source

linux.lisp.

Function: sysconf (name) ¶

Get value of configurable system variables.

Package

osicat-posix.

Source

unix.lisp.

Function: syslog (priority format &rest args) ¶

Send a message to the syslog facility, with severity level PRIORITY. The message will be formatted by CL:FORMAT (rather than C’s printf) with format string FORMAT and arguments ARGS.

Package

osicat-posix.

Source

unix.lisp.

Function: system-error (control-string &rest args) ¶

Package

osicat-sys.

Source

osicat-sys.lisp.

Function: tcgetattr (fd termios) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: tcsetattr (fd mode termios) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: telldir (dir) ¶

Returns the current location in a directory

Package

osicat-posix.

Source

unix.lisp.

Function: time () ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: timer-create (clock-id notify-method &key signal notify-value function attributes thread-id) ¶

Creates a new per-process interval timer.

Package

osicat-posix.

Source

unix.lisp.

Function: timer-delete (timer-id) ¶

Deletes the timer identified by TIMER-ID.

Package

osicat-posix.

Source

unix.lisp.

Function: timer-getoverrun (timer-id) ¶

Returns the overrun count for the timer identified by TIMER-ID.

Package

osicat-posix.

Source

unix.lisp.

Function: timer-gettime (timer-id) ¶

Returns the interval and the time until next expiration for the
timer specified by TIMER-ID. Both the interval and the time are returned as seconds and nanoseconds, so four values are returned.

Package

osicat-posix.

Source

unix.lisp.

Function: timer-settime (timer-id flags interval-sec interval-nsec initial-sec initial-nsec &optional return-previous-p) ¶

Arms or disarms the timer identified by TIMER-ID.

Package

osicat-posix.

Source

unix.lisp.

Function: umask (new-mode) ¶

Sets the umask and returns the old one

Package

osicat-posix.

Source

basic-unix.lisp.

Function: uname () ¶

Get name and information about current kernel.

Package

osicat-posix.

Source

unix.lisp.

Function: unlink (pathname) ¶

Unlink the directory entry pointed to by PATHNAME. If PATHNAME is a symbolic link, the link is deleted, not the target.

Package

osicat.

Source

osicat.lisp.

Function: unlink (path) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: unlinkat (dirfd pathname flags) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: unmerge-pathnames (pathspec &optional default) ¶

Removes those leading directory components from PATHSPEC that are shared with DEFAULT.

Package

osicat.

Source

osicat.lisp.

Function: unsetenv (name) ¶

Removes the binding of an environment variable

Package

osicat-posix.

Source

unix.lisp.

Function: user-info (id) ¶

USER-INFO returns the password entry for the given name or numerical user ID, as an assoc-list.

Package

osicat.

Source

osicat.lisp.

Function: usleep (useconds) ¶

Package

osicat-posix.

Source

unix.lisp.

Function: utime (filename atime mtime) ¶

Package

osicat-posix.

Source

basic-unix.lisp.

Function: utimensat (dirfd filename atime-sec atime-nsec mtime-sec mtime-nsec flags) ¶

Set file access and modification time with nanosecond precision.

Package

osicat-posix.

Source

unix.lisp.

Function: utimes (filename atime-sec atime-usec mtime-sec mtime-usec) ¶

Set file access and modification time with microsecond precision.

Package

osicat-posix.

Source

unix.lisp.

Function: wait () ¶

Wait for any child process to terminate.

Package

osicat-posix.

Source

unix.lisp.

Function: waitpid (pid &key no-hang untraced) ¶

Wait for a specific child process to terminate

Package

osicat-posix.

Source

unix.lisp.

Function: walk-directory (dirname fn &key directories if-does-not-exist test) ¶

Recursively applies the function FN to all files within the directory named by the non-wild pathname designator DIRNAME and all of its sub-directories. Returns T on success.

FN will only be applied to files for which the function TEST returns a true value. If DIRECTORIES is not NIL, FN and TEST are applied to directories as well. If DIRECTORIES is :DEPTH-FIRST, FN will be applied to the directory’s contents first. If DIRECTORIES is :BREADTH-FIRST and TEST returns NIL, the directory’s content will be skipped. IF-DOES-NOT-EXIST must be
one of :ERROR or :IGNORE where :ERROR means that an error will be signaled if the directory DIRNAME does not exist.

Package

osicat.

Source

osicat.lisp.

Function: write (fd buf count) ¶

Write at most COUNT bytes to FD from the foreign area BUF.

Package

osicat-posix.

Source

basic-unix.lisp.

Function: writev (fd iov count) ¶

Package

osicat-posix.

Source

unix.lisp.

---