The clx Reference Manual

Table of Contents

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

The clx Reference Manual

This is the clx Reference Manual, version 0.7.5, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:36:02 2018 GMT+0.


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

1 Introduction

CLX

CLX is an X11 client library for Common Lisp. The code was originally taken from a CMUCL distribution, was modified somewhat in order to make it compile and run under SBCL, then a selection of patches were added from other CLXes around the net.

Features

Supported versions

CLX should work with SBCL, CCL, ECL and CLISP. If it doesn't please submit an issue along with the version information of your implementation.

Allegro Common Lisp users should use clx version maintained by Franz Inc., which can be found at https://github.com/franzinc/clx

Building using quicklisp

(ql:quickload 'clx)

To load demos and tests as well:

(ql:quickload 'clx/demo)

or if you want to use the latest version from git, clone this repository to your local-project and use quickload as described above

cd ~/quicklisp/local-projects/
git clone git://github.com/sharplispers/clx.git

Building using ASDF

If you don't have quicklisp installed you can use ASDF to load CLX. To do so clone this repository to either:

where ASDF will look for system definitions by default

and then on the lisp REPL type

(require 'asdf)
(asdf:load-system 'clx)

If you want to load clx from another location you have to first tell ASDF to look in that directory by adding the directory to ASDF's central registry on every session.

(require 'asdf)
(push "/path/to/the/clx/directory/" asdf:*central-registry*) ; Mind the trailing slash, it is important.
(asdf:load-system 'clx)

or you can configure ASDF to look in your directory as described in the ASDF Manual

To load demo and test files as well:

(asdf:load-system 'clx/demo)

Demos

To test CLX (and get a small amount of Lisp advocacy), try loading the file "demo/menu", and then executing the function xlib::just-say-lisp.

(load "clx/demo/menu")
(xlib::just-say-lisp)

Note: If you're new to Lisp, be advised that despite the examples in demo/, it's generally /not/ considered good style to switch to the :xlib package and write your code in it. Spend some time with a language reference to familiarize yourself with USE-PACKAGE, or better yet, the USE option to DEFPACKAGE.

Documentation

An up to date version of the manual can be found at sharplispers.github.io/clx

#Bug reports, new features, patches

Please use github to track issues:

Contributing

To contribute submit a pull request

To report bugs, request features, etc please use the github issue tracker


Heavy lifting by <Raymond.Wiker at fast.no> ASDFized version by Daniel Barlow and Christophe Rhodes

The sharplispers group on github have recently (November 2011) "adopted" clx and maintain the version that lives at:

https://github.com/sharplispers/clx


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

2 Systems

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


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

2.1 clx

Maintainer

sharplispers

Author

Texas Instruments Incorporated. Franz Inc, Berkeley, Ca. Independent FOSS developers

License

MIT

Description

An implementation of the X Window System protocol in Lisp.

Version

0.7.5

Dependency

sb-bsd-sockets

Source

clx.asd (file)

Components

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

3 Modules

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


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

3.1 clx/extensions

Dependency

resource.lisp (file)

Parent

clx (system)

Location

extensions/

Components

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

3.2 clx/manual

Dependency

cmudep (file)

Parent

clx (system)

Location

manual/

Component

clx.texinfo (file)


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

3.3 clx/debug

Dependency

manual (module)

Parent

clx (system)

Location

debug/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 clx.asd

Location

clx.asd

Systems

clx (system)

Packages

clx-system

Internal Definitions

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

4.1.2 clx/package.lisp

Parent

clx (system)

Location

package.lisp

Packages

xlib


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

4.1.3 clx/depdefs.lisp

Dependency

package.lisp (file)

Parent

clx (system)

Location

depdefs.lisp

Exported Definitions

array-index (type)

Internal Definitions

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

4.1.4 clx/clx.lisp

Dependency

depdefs.lisp (file)

Parent

clx (system)

Location

clx.lisp

Exported Definitions
Internal Definitions

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

4.1.5 clx/dependent.lisp

Dependency

clx.lisp (file)

Parent

clx (system)

Location

dependent.lisp

Exported Definitions
Internal Definitions

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

4.1.6 clx/macros.lisp

Dependency

dependent.lisp (file)

Parent

clx (system)

Location

macros.lisp

Internal Definitions

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

4.1.7 clx/bufmac.lisp

Dependency

macros.lisp (file)

Parent

clx (system)

Location

bufmac.lisp

Internal Definitions

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

4.1.8 clx/buffer.lisp

Dependency

bufmac.lisp (file)

Parent

clx (system)

Location

buffer.lisp

Internal Definitions

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

4.1.9 clx/display.lisp

Dependency

buffer.lisp (file)

Parent

clx (system)

Location

display.lisp

Exported Definitions
Internal Definitions

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

4.1.10 clx/gcontext.lisp

Dependency

display.lisp (file)

Parent

clx (system)

Location

gcontext.lisp

Exported Definitions
Internal Definitions

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

4.1.11 clx/input.lisp

Dependency

gcontext.lisp (file)

Parent

clx (system)

Location

input.lisp

Exported Definitions
Internal Definitions

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

4.1.12 clx/requests.lisp

Dependency

input.lisp (file)

Parent

clx (system)

Location

requests.lisp

Exported Definitions
Internal Definitions

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

4.1.13 clx/fonts.lisp

Dependency

requests.lisp (file)

Parent

clx (system)

Location

fonts.lisp

Exported Definitions
Internal Definitions

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

4.1.14 clx/graphics.lisp

Dependency

fonts.lisp (file)

Parent

clx (system)

Location

graphics.lisp

Exported Definitions
Internal Definitions

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

4.1.15 clx/text.lisp

Dependency

graphics.lisp (file)

Parent

clx (system)

Location

text.lisp

Exported Definitions
Internal Definitions

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

4.1.16 clx/attributes.lisp

Dependency

text.lisp (file)

Parent

clx (system)

Location

attributes.lisp

Exported Definitions
Internal Definitions

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

4.1.17 clx/translate.lisp

Dependency

attributes.lisp (file)

Parent

clx (system)

Location

translate.lisp

Exported Definitions
Internal Definitions

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

4.1.18 clx/keysyms.lisp

Dependency

translate.lisp (file)

Parent

clx (system)

Location

keysyms.lisp


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

4.1.19 clx/manager.lisp

Dependency

keysyms.lisp (file)

Parent

clx (system)

Location

manager.lisp

Exported Definitions
Internal Definitions

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

4.1.20 clx/image.lisp

Dependency

manager.lisp (file)

Parent

clx (system)

Location

image.lisp

Exported Definitions
Internal Definitions

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

4.1.21 clx/resource.lisp

Dependency

image.lisp (file)

Parent

clx (system)

Location

resource.lisp

Exported Definitions
Internal Definitions

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

4.1.22 clx/extensions/shape.lisp

Parent

extensions (module)

Location

extensions/shape.lisp

Exported Definitions
Internal Definitions

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

4.1.23 clx/extensions/big-requests.lisp

Parent

extensions (module)

Location

extensions/big-requests.lisp

Internal Definitions

enable-big-requests (function)


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

4.1.24 clx/extensions/xvidmode.lisp

Parent

extensions (module)

Location

extensions/xvidmode.lisp

Exported Definitions
Internal Definitions

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

4.1.25 clx/extensions/xrender.lisp

Parent

extensions (module)

Location

extensions/xrender.lisp

Exported Definitions
Internal Definitions

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

4.1.26 clx/extensions/glx.lisp

Parent

extensions (module)

Location

extensions/glx.lisp

Packages

xlib/glx

Exported Definitions
Internal Definitions

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

4.1.27 clx/extensions/gl.lisp

Dependency

glx.lisp (file)

Parent

extensions (module)

Location

extensions/gl.lisp

Packages

xlib/gl

Exported Definitions
Internal Definitions

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

4.1.28 clx/extensions/dpms.lisp

Parent

extensions (module)

Location

extensions/dpms.lisp

Packages

xlib/dpms

Exported Definitions
Internal Definitions

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

4.1.29 clx/extensions/xtest.lisp

Parent

extensions (module)

Location

extensions/xtest.lisp

Packages

xlib/xtest

Exported Definitions
Internal Definitions

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

4.1.30 clx/extensions/screensaver.lisp

Parent

extensions (module)

Location

extensions/screensaver.lisp

Exported Definitions

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

4.1.31 clx/extensions/randr.lisp

Parent

extensions (module)

Location

extensions/randr.lisp

Exported Definitions
Internal Definitions

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

4.1.32 clx/extensions/xinerama.lisp

Parent

extensions (module)

Location

extensions/xinerama.lisp

Packages

xlib/xinerama

Exported Definitions
Internal Definitions

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

4.1.33 clx/extensions/dbe.lisp

Parent

extensions (module)

Location

extensions/dbe.lisp

Exported Definitions
Internal Definitions

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

4.1.34 clx/extensions/xc-misc.lisp

Parent

extensions (module)

Location

extensions/xc-misc.lisp

Exported Definitions
Internal Definitions

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

4.1.35 clx/extensions/dri2.lisp

Parent

extensions (module)

Location

extensions/dri2.lisp

Exported Definitions
Internal Definitions

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

4.1.36 clx/extensions/composite.lisp

Parent

extensions (module)

Location

extensions/composite.lisp

Exported Definitions
Internal Definitions

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

4.2 Other


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.1 clx/NEWS

Dependency

extensions (module)

Parent

clx (system)

Location

NEWS


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.2 clx/CHANGES

Dependency

news (file)

Parent

clx (system)

Location

CHANGES


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.3 clx/README.md

Dependency

changes (file)

Parent

clx (system)

Location

README.md


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.4 clx/README-R5

Dependency

readme.md (file)

Parent

clx (system)

Location

README-R5


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.5 clx/exclMakefile

Dependency

readme-r5 (file)

Parent

clx (system)

Location

exclMakefile


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.6 clx/exclREADME

Dependency

exclmakefile (file)

Parent

clx (system)

Location

exclREADME


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.7 clx/exclcmac

Dependency

exclreadme (file)

Parent

clx (system)

Location

exclcmac.lisp


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.8 clx/excldepc

Dependency

exclcmac (file)

Parent

clx (system)

Location

excldep.c


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.9 clx/sockcl

Dependency

excldepc (file)

Parent

clx (system)

Location

sockcl.lisp


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.10 clx/socket

Dependency

sockcl (file)

Parent

clx (system)

Location

socket.c


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.11 clx/defsystem

Dependency

socket (file)

Parent

clx (system)

Location

defsystem.lisp


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.12 clx/provide

Dependency

defsystem (file)

Parent

clx (system)

Location

provide.lisp


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.13 clx/cmudep

Dependency

provide (file)

Parent

clx (system)

Location

cmudep.lisp


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.14 clx/manual/clx.texinfo

Parent

manual (module)

Location

manual/clx.texinfo


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.15 clx/debug/debug

Parent

debug (module)

Location

debug/debug.lisp


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.16 clx/debug/describe

Parent

debug (module)

Location

debug/describe.lisp


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.17 clx/debug/event-test

Parent

debug (module)

Location

debug/event-test.lisp


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.18 clx/debug/keytrans

Parent

debug (module)

Location

debug/keytrans.lisp


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.19 clx/debug/trace

Parent

debug (module)

Location

debug/trace.lisp


Previous: , Up: Other files   [Contents][Index]

4.2.20 clx/debug/util

Parent

debug (module)

Location

debug/util.lisp


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

5 Packages

Packages are listed by definition order.


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

5.1 clx-system

Source

clx.asd

Use List
Internal Definitions

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

5.2 xlib

Source

package.lisp (file)

Use List
Used By List
Exported Definitions
Internal Definitions