The hunchentoot-cgi Reference Manual

This is the hunchentoot-cgi Reference Manual, version 0.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:34:06 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 hunchentoot-cgi

Author

Cyrus Harmon <>

License

BSD

Version

0.3

Dependencies
  • hunchentoot (system).
  • puri (system).
Source

hunchentoot-cgi.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 hunchentoot-cgi/hunchentoot-cgi.asd

Source

hunchentoot-cgi.asd.

Parent Component

hunchentoot-cgi (system).

ASDF Systems

hunchentoot-cgi.


3.1.2 hunchentoot-cgi/defpackage.lisp

Source

hunchentoot-cgi.asd.

Parent Component

hunchentoot-cgi (system).

Packages

hunchentoot-cgi.


3.1.3 hunchentoot-cgi/util.lisp

Dependency

defpackage.lisp (file).

Source

hunchentoot-cgi.asd.

Parent Component

hunchentoot-cgi (system).

Internals

3.1.4 hunchentoot-cgi/hunchentoot-cgi.lisp

Dependencies
Source

hunchentoot-cgi.asd.

Parent Component

hunchentoot-cgi (system).

Public Interface

create-cgi-dispatcher-and-handler (function).

Internals

4 Packages

Packages are listed by definition order.


4.1 hunchentoot-cgi

Source

defpackage.lisp.

Use List
  • common-lisp.
  • hunchentoot.
Public Interface

create-cgi-dispatcher-and-handler (function).

Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: create-cgi-dispatcher-and-handler (uri-prefix base-path &optional content-type)
Package

hunchentoot-cgi.

Source

hunchentoot-cgi.lisp.


5.2 Internals


5.2.1 Macros

Macro: with-program ((program program-args environment &key output input) &body body)

Creates an new process of the specified by PROGRAM using PROGRAM-ARGS as a list of the arguments to the program. Binds the stream variable to an input stream from which the output of the process can be read and executes body as an implicit progn.

Package

hunchentoot-cgi.

Source

util.lisp.


5.2.2 Ordinary functions

Function: copy-stream (in out &optional element-type)

Copy everything from in to out

Package

hunchentoot-cgi.

Source

util.lisp.

Function: handle-cgi-script (path &optional content-type)

A function which acts like a Hunchentoot handler for the file denoted by PATH. Send a content type header corresponding to CONTENT-TYPE or (if that is NIL) tries to determine the content type via the file’s suffix.

Package

hunchentoot-cgi.

Source

hunchentoot-cgi.lisp.

Function: host-name (&optional request)

Returns just the host portion of the ’Host’ incoming http header value, rather than either host or host:port if the port is specified.

Package

hunchentoot-cgi.

Source

hunchentoot-cgi.lisp.

Function: host-name-and-port (&optional request)

Returns the multiple values host and port (or nil if no port
is specified) of the ’Host’ incoming http header value, rather than either host or host:port if the port is specified.

Package

hunchentoot-cgi.

Source

hunchentoot-cgi.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables