The sysexits Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The sysexits Reference Manual

This is the sysexits Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:04:44 2022 GMT+0.

Table of Contents


1 Introduction

sysexits

Sysexits provides constants for the exit codes defined in sysexits.h.

Install

Clone the project to your ASDF or Quicklisp source registry:

$ git clone https://github.com/teddywing/cl-sysexits.git ~/quicklisp/local-projects/sysexits

License

Licensed under the BSD 3-Clause license (see the included LICENSE file).


2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 sysexits

Exit codes defined in sysexits.h

Author

Teddy Wing

License

BSD-3-Clause

Version

1.0.0

Source

sysexits.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 sysexits/src

Source

sysexits.asd.

Parent Component

sysexits (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

4.1.1 sysexits/sysexits.asd

Source

sysexits.asd.

Parent Component

sysexits (system).

ASDF Systems

sysexits.


4.1.2 sysexits/src/package.lisp

Source

sysexits.asd.

Parent Component

src (module).

Packages

sysexits.


4.1.3 sysexits/src/sysexits.lisp

Dependency

package.lisp (file).

Source

sysexits.asd.

Parent Component

src (module).

Public Interface

5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 sysexits

Source

package.lisp.

Use List

common-lisp.

Public Interface

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Previous: , Up: Definitions   [Contents][Index]

6.1 Public Interface


6.1.1 Constants

Constant: +cantcreat+

A (user specified) output file cannot be created.

Package

sysexits.

Source

sysexits.lisp.

Constant: +config+

Configuration error.

Package

sysexits.

Source

sysexits.lisp.

Constant: +dataerr+

The input data was incorrect in some way. This should only be used for user’s data & not system files.

Package

sysexits.

Source

sysexits.lisp.

Constant: +ioerr+

An error occurred while doing I/O on some file.

Package

sysexits.

Source

sysexits.lisp.

Constant: +nohost+

The host specified did not exist. This is used in mail addresses or network requests.

Package

sysexits.

Source

sysexits.lisp.

Constant: +noinput+

An input file (not a system file) did not exist or was not readable. This could also include errors like "No message" to a mailer (if it cared to catch it).

Package

sysexits.

Source

sysexits.lisp.

Constant: +noperm+

You did not have sufficient permission to perform the operation. This is not intended for file system problems, which should use NOINPUT or CANTCREAT, but rather for higher level permissions.

Package

sysexits.

Source

sysexits.lisp.

Constant: +nouser+

The user specified did not exist. This might be used for mail addresses or remote logins.

Package

sysexits.

Source

sysexits.lisp.

Constant: +ok+

Successful termination.

Package

sysexits.

Source

sysexits.lisp.

Constant: +oserr+

An operating system error has been detected. This is intended to be used for such things as "cannot fork", "cannot create pipe", or the like. It includes things like getuid returning a user that does not exist in the passwd file.

Package

sysexits.

Source

sysexits.lisp.

Constant: +osfile+

Some system file (e.g., /etc/passwd, /etc/utmp, etc.) does not exist, cannot be opened, or has some sort of error (e.g., syntax error).

Package

sysexits.

Source

sysexits.lisp.

Constant: +protocol+

The remote system returned something that was "not possible" during a protocol exchange.

Package

sysexits.

Source

sysexits.lisp.

Constant: +software+

An internal software error has been detected. This should be limited to non-operating system related errors as possible.

Package

sysexits.

Source

sysexits.lisp.

Constant: +tempfail+

Temporary failure, indicating something that is not really an error. In sendmail, this means that a mailer (e.g.) could not create a connection, and the request should be reattempted later.

Package

sysexits.

Source

sysexits.lisp.

Constant: +unavailable+

A service is unavailable. This can occur if a support program or file does not exist. This can also be used as a catchall message when something you wanted to do doesn’t work, but you don’t know why.

Package

sysexits.

Source

sysexits.lisp.

Constant: +usage+

The command was used incorrectly, e.g., with the wrong number of arguments, a bad flag, a bad syntax in a parameter, or whatever.

Package

sysexits.

Source

sysexits.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions