The s-utils Reference Manual

This is the s-utils Reference Manual, version 1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:12:42 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 s-utils

S-UTILS is collection of Common Lisp utilities

Maintainer

Sven Van Caekenberghe <>

Author

Sven Van Caekenberghe <>

License

Lesser Lisp General Public License (LLGPL)

Long Description

S-UTILS is collection of Common Lisp utilities

Version

1

Source

s-utils.asd.

Child Component

src (module).


3 Modules

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


3.1 s-utils/src

Source

s-utils.asd.

Parent Component

s-utils (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 s-utils/s-utils.asd

Source

s-utils.asd.

Parent Component

s-utils (system).

ASDF Systems

s-utils.


4.1.2 s-utils/src/package.lisp

Source

s-utils.asd.

Parent Component

src (module).

Packages

s-utils.


4.1.3 s-utils/src/utils.lisp

Dependency

package.lisp (file).

Source

s-utils.asd.

Parent Component

src (module).

Public Interface

5 Packages

Packages are listed by definition order.


5.1 s-utils

S-UTILS is collection of Common Lisp utilities

Source

package.lisp.

Use List

common-lisp.

Public Interface

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: +en-duration-unit-names+

English time duration unit name constant strings

Package

s-utils.

Source

utils.lisp.

Special Variable: +us-date-format+

US English style date-only format

Package

s-utils.

Source

utils.lisp.

Special Variable: +us-day-names+

US English short day name constant strings

Package

s-utils.

Source

utils.lisp.

Special Variable: +us-month-names+

US English short month name constant strings

Package

s-utils.

Source

utils.lisp.

Special Variable: +us-time-format+

US English style date-time format

Package

s-utils.

Source

utils.lisp.


6.1.2 Ordinary functions

Function: copy-stream (in out &optional buffer second-buffer convertor)

Copy all data from input stream in to output stream out using buffer (and read/write-sequence)

Package

s-utils.

Source

utils.lisp.

Function: format-duration (seconds &key unit-names stream)

Format seconds as duration using unit-names, if stream is not nil use it, else return a string

Package

s-utils.

Source

utils.lisp.

Function: format-iso-gmt-time (universal-time &key stream)

Format universal time using a simple and fast ’ISO GMT’ style, if stream is not nil use it, else return a string

Package

s-utils.

Source

utils.lisp.

Function: format-universal-time (universal-time &key format day-names month-names decode-in-timezone stream)

Format universal time using format, day-names and month-names, if stream is not nil use it, else return a string

Package

s-utils.

Source

utils.lisp.

Function: make-subdirectory (basedir subdir)

Give a pathname, basedir, of a directory, create a subdirectory with name subdir

Package

s-utils.

Source

utils.lisp.

Function: parse-integer-safely (string &key start end radix default)

Like parse-integer, but will return default on error, accepts nil as argument

Package

s-utils.

Source

utils.lisp.

Function: pathname-parent (pathname)

Given a pathname, return the parent pathname

Package

s-utils.

Source

utils.lisp.

Function: tokens (string &key start end separators)

Split string in a list of tokens using separators, a list of characters

Package

s-utils.

Source

utils.lisp.


Appendix A Indexes


A.1 Concepts