The cari3s Reference Manual

Table of Contents

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

The cari3s Reference Manual

This is the cari3s Reference Manual, version 2.0.0, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Apr 08 13:02:12 2019 GMT+0.


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

1 Introduction

About Cari3s

This is an i3 status bar generator library/program.

How To

First make sure Cari3s is available to ASDF by either cloning and registering it, or downloading it via Quicklisp. Then build a standalone binary of Cari3s like this:

sbcl --eval "(asdf:make :cari3s)"

This should produce a binary called cari3s in the source directory. Copy or symlink it into your PATH.

Next, create a configuration file in ~/.config/i3/cari3s.conf with something like the following:

(cpu-usage)
(mem-usage)
(io-usage)
(network-ip)
(clock)

Then change your ~/.config/i3/config's status bar section and set the status_command to cari3s:

bar {
  status_command cari3s
  ...
}

Once you reload i3, it should display a status bar similar to the following:

status-bar

In the above example we defined five generators. The following generators are available out of the box:

The look of each of them can be customised through the :text format string, and the :markup pango options, as well as a variety of extra options for blocks.

Defining new Generators

Defining a raw generator is just a matter of subclassing generator and providing a method for generate that, when invoked, returns a list of block instances that should be displayed on the status bar.

There's some helper classes available like the single-generator and the value-generator, as most generators will only produce a single block and produce their text based on some recomputed value every time.

For the value-generator all you need to implement is a method on compute-value and provide a sensible default :text initarg.

None of the existing generators are terribly complicated, so if you're still unsure what to do, have a look at their sources.

Interfacing with Cari3s

Cari3s includes a TCP server that can be used for RPC. By default the server listens on port 2424. It uses a simple UTF-8 protocol that works on a per-line basis. Each line sent by a client should be formatted something like this:

echo :message "hi!"

The server will reply in the same format. See serialize-object for the complete format spec. You can use this interface in order to interface with and extend Cari3s with other applications.


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 cari3s

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://Shinmera.github.io/cari3s/

Source Control

(:git "https://github.com/shinmera/cari3s.git")

Bug Tracker

https://github.com/Shinmera/cari3s/issues

License

Artistic

Description

A generator for the i3 status bar.

Version

2.0.0

Dependencies
Source

cari3s.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 cari3s.asd

Location

cari3s.asd

Systems

cari3s (system)


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

3.1.2 cari3s/package.lisp

Parent

cari3s (system)

Location

package.lisp

Packages

cari3s


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

3.1.3 cari3s/toolkit.lisp

Dependency

package.lisp (file)

Parent

cari3s (system)

Location

toolkit.lisp

Internal Definitions

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

3.1.4 cari3s/protocol.lisp

Dependency

toolkit.lisp (file)

Parent

cari3s (system)

Location

protocol.lisp

Exported Definitions

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

3.1.5 cari3s/event.lisp

Dependency

protocol.lisp (file)

Parent

cari3s (system)

Location

event.lisp

Exported Definitions
Internal Definitions

%serialize-object (function)


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

3.1.6 cari3s/generators.lisp

Dependency

event.lisp (file)

Parent

cari3s (system)

Location

generators.lisp

Exported Definitions
Internal Definitions

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

3.1.7 cari3s/status-bar.lisp

Dependency

generators.lisp (file)

Parent

cari3s (system)

Location

status-bar.lisp

Exported Definitions
Internal Definitions

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

3.1.8 cari3s/toplevel.lisp

Dependency

status-bar.lisp (file)

Parent

cari3s (system)

Location

toplevel.lisp

Exported Definitions

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

3.1.9 cari3s/generators/battery.lisp

Dependency

toplevel.lisp (file)

Parent

cari3s (system)

Location

generators/battery.lisp

Exported Definitions
Internal Definitions

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

3.1.10 cari3s/generators/clock.lisp

Dependency

generators/battery.lisp (file)

Parent

cari3s (system)

Location

generators/clock.lisp

Exported Definitions

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

3.1.11 cari3s/generators/cpu-usage.lisp

Dependency

generators/clock.lisp (file)

Parent

cari3s (system)

Location

generators/cpu-usage.lisp

Exported Definitions
Internal Definitions

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

3.1.12 cari3s/generators/disk-usage.lisp

Dependency

generators/cpu-usage.lisp (file)

Parent

cari3s (system)

Location

generators/disk-usage.lisp

Exported Definitions
Internal Definitions

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

3.1.13 cari3s/generators/io-usage.lisp

Dependency

generators/disk-usage.lisp (file)

Parent

cari3s (system)

Location

generators/io-usage.lisp

Exported Definitions
Internal Definitions

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

3.1.14 cari3s/generators/mem-usage.lisp

Dependency

generators/io-usage.lisp (file)

Parent

cari3s (system)

Location

generators/mem-usage.lisp

Exported Definitions
Internal Definitions

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

3.1.15 cari3s/generators/network-ip.lisp

Dependency

generators/mem-usage.lisp (file)

Parent

cari3s (system)

Location

generators/network-ip.lisp

Exported Definitions
Internal Definitions

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

3.1.16 cari3s/generators/uptime.lisp

Dependency

generators/network-ip.lisp (file)

Parent

cari3s (system)

Location

generators/uptime.lisp

Exported Definitions

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

3.1.17 cari3s/generators/weather.lisp

Dependency

generators/uptime.lisp (file)

Parent

cari3s (system)

Location

generators/weather.lisp

Exported Definitions
Internal Definitions

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

3.1.18 cari3s/documentation.lisp

Dependency

generators/weather.lisp (file)

Parent

cari3s (system)

Location

documentation.lisp


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

4 Packages

Packages are listed by definition order.


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

4.1 cari3s

Source

package.lisp (file)

Nickname

org.shirakumo.cari3s

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: load-from-file FILE

Loads a status bar definition from the given file.

The file should have the following format:

DEFINITION ::= (INITARG|GENERATOR)*
INITARG ::= keyword value
GENERATOR ::= (NAME INITARG*)
NAME — A symbol naming the class of the generator.

So for instance a simple file for a status bar with a two-second interval, a clock generator, and a cpu-usage generator would look as follows:

:interval 2
(clock :text "~4@*~2d:~2,’0d:~2,’0d")
(cpu-usage)

See GENERATOR
See STATUS-BAR

Package

cari3s

Source

toplevel.lisp (file)

Function: run-bar BAR &key PAUSE CLICK-EVENTS-P

Starts the i3bar protocol and continuously processes the status bar.

If click-events-p is T, i3 will send click events to the status bar. Pause is the minimal number of seconds between calls to PROCESS.

See PROCESS
See STATUS-BAR

Package

cari3s

Source

status-bar.lisp (file)

Function: run-bar-from-file &optional FILE

Runs a status bar initialised from a file.

See LOAD-FROM-FILE
See RUN-BAR

Package

cari3s

Source

toplevel.lisp (file)

Function: toplevel ()

Lisp binary toplevel entry function.

This simply calls RUN-BAR-FROM-FILE, passing along the command line options to the binary.

Package

cari3s

Source

toplevel.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Generic functions

Generic Function: align OBJECT

Accessor to the text alignment property of the block.

Can be one of: :center :right :left
Defaults to :left

Note that alignment is only in effect if the min-width has not been reached.

See BLOCK

Package

cari3s

Writer

(setf align) (generic function)

Methods
Method: align (BLOCK block)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf align) NEW-VALUE OBJECT
Package

cari3s

Reader

align (generic function)

Methods
Method: (setf align) NEW-VALUE (BLOCK block)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: background OBJECT

Accessor to the background colour of the block.

A colour can either be an encoded RGB integer, or a list of R, G, B, and optional A elements with each element being an integer between 0 and 255.

See BLOCK

Package

cari3s

Writer

(setf background) (generic function)

Methods
Method: background (BLOCK block)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf background) NEW-VALUE OBJECT
Package

cari3s

Reader

background (generic function)

Methods
Method: (setf background) NEW-VALUE (BLOCK block)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: block-size OBJECT

Accessor to the block’s screen dimensions.

The dimensions is a cons of WIDTH and HEIGHT sizes in pixels.

See CLICK

Package

cari3s

Methods
Method: block-size (CLICK click)

automatically generated reader method

Source

event.lisp (file)

Generic Function: border OBJECT

Accessor to the border colour of the block.

A colour can either be an encoded RGB integer, or a list of R, G, B, and optional A elements with each element being an integer between 0 and 255.

See BLOCK

Package

cari3s

Writer

(setf border) (generic function)

Methods
Method: border (BLOCK block)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf border) NEW-VALUE OBJECT
Package

cari3s

Reader

border (generic function)

Methods
Method: (setf border) NEW-VALUE (BLOCK block)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: button OBJECT

Accessor to the X11 button ID that was used to perform the click.

By default this should be:
1 – left
2 – middle
3 – right

See CLICK

Package

cari3s

Methods
Method: button (CLICK click)

automatically generated reader method

Source

event.lisp (file)

Generic Function: click-pause OBJECT

Accessor to the number of seconds that the next tick event is delayed to when a click event has come in.

See PROCESS
See NEXT-TIME
See STATUS-BAR

Package

cari3s

Writer

(setf click-pause) (generic function)

Methods
Method: click-pause (STATUS-BAR status-bar)

automatically generated reader method

Source

status-bar.lisp (file)

Generic Function: (setf click-pause) NEW-VALUE OBJECT
Package

cari3s

Reader

click-pause (generic function)

Methods
Method: (setf click-pause) NEW-VALUE (STATUS-BAR status-bar)

automatically generated writer method

Source

status-bar.lisp (file)

Generic Function: compute-value VALUE-GENERATOR

Computes the values used for the format string in a value-generator’s text.

This function is called whenever GENERATE is called on the value-generator.

See VALUE-GENERATOR

Package

cari3s

Source

generators.lisp (file)

Methods
Method: compute-value (GENERATOR weather)
Source

generators/weather.lisp (file)

Method: compute-value (GENERATOR uptime)
Source

generators/uptime.lisp (file)

Method: compute-value (GENERATOR network-ip)
Source

generators/network-ip.lisp (file)

Method: compute-value (GENERATOR mem-usage)
Source

generators/mem-usage.lisp (file)

Method: compute-value (GENERATOR io-usage)
Source

generators/io-usage.lisp (file)

Method: compute-value (GENERATOR disk-usage)
Source

generators/disk-usage.lisp (file)

Method: compute-value (GENERATOR cpu-usage)
Source

generators/cpu-usage.lisp (file)

Method: compute-value (GENERATOR clock)
Source

generators/clock.lisp (file)

Method: compute-value (GENERATOR battery)
Source

generators/battery.lisp (file)

Generic Function: connections OBJECT

The list of connected client sockets.

This is not thread-safe to modify.

See EVENT-SERVER

Package

cari3s

Writer

(setf connections) (generic function)

Methods
Method: connections (EVENT-SERVER event-server)

automatically generated reader method

Source

event.lisp (file)

Generic Function: (setf connections) NEW-VALUE OBJECT
Package

cari3s

Reader

connections (generic function)

Methods
Method: (setf connections) NEW-VALUE (EVENT-SERVER event-server)

automatically generated writer method

Source

event.lisp (file)

Generic Function: continue-signal OBJECT

The unix signal used to continue bar updates.

Defaults to 18 (SIGCONT)

See HEADER

Package

cari3s

Writer

(setf continue-signal) (generic function)

Methods
Method: continue-signal (HEADER header)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf continue-signal) NEW-VALUE OBJECT
Package

cari3s

Reader

continue-signal (generic function)

Methods
Method: (setf continue-signal) NEW-VALUE (HEADER header)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: foreground OBJECT

Accessor to the foreground text colour of the block.

A colour can either be an encoded RGB integer, or a list of R, G, B, and optional A elements with each element being an integer between 0 and 255.

See BLOCK

Package

cari3s

Writer

(setf foreground) (generic function)

Methods
Method: foreground (BLOCK block)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf foreground) NEW-VALUE OBJECT
Package

cari3s

Reader

foreground (generic function)

Methods
Method: (setf foreground) NEW-VALUE (BLOCK block)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: from-table TYPE TABLE

Generate an object from a table of basic types.

This is intended for json deserialisation. Allowed types are: - hash-table
- string
- list
- vector
- number
- T
- NIL

Package

cari3s

Source

protocol.lisp (file)

Methods
Method: from-table (TYPE (eql click)) TABLE
Source

event.lisp (file)

Generic Function: generate GENERATOR

Generates a list of blocks to use in the status bar.

See BLOCK
See GENERATOR

Package

cari3s

Source

generators.lisp (file)

Methods
Method: generate (BAR status-bar)
Source

status-bar.lisp (file)

Method: generate (GENERATOR value-generator)
Method: generate (GENERATOR single-generator) around
Method: generate (GENERATOR generator) after
Generic Function: generators OBJECT

Accessor to the list of generators that the status-bar invokes to generate its output.

See GENERATOR
See STATUS-BAR

Package

cari3s

Writer

(setf generators) (generic function)

Methods
Method: generators (STATUS-BAR status-bar)

automatically generated reader method

Source

status-bar.lisp (file)

Generic Function: (setf generators) NEW-VALUE OBJECT
Package

cari3s

Reader

generators (generic function)

Methods
Method: (setf generators) NEW-VALUE (STATUS-BAR status-bar)

automatically generated writer method

Source

status-bar.lisp (file)

Generic Function: input OBJECT

Accessor to the input stream from which the status-bar reads click events.

This defaults to *STANDARD-INPUT*

See PROCESS
See STATUS-BAR

Package

cari3s

Writer

(setf input) (generic function)

Methods
Method: input (STATUS-BAR status-bar)

automatically generated reader method

Source

status-bar.lisp (file)

Generic Function: (setf input) NEW-VALUE OBJECT
Package

cari3s

Reader

input (generic function)

Methods
Method: (setf input) NEW-VALUE (STATUS-BAR status-bar)

automatically generated writer method

Source

status-bar.lisp (file)

Generic Function: instance OBJECT

Accessor to the instance name of the block.

See NAME
See BLOCK
See CLICK

Package

cari3s

Writer

(setf instance) (generic function)

Methods
Method: instance (CLICK click)

automatically generated reader method

Source

event.lisp (file)

Method: instance (BLOCK block)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf instance) NEW-VALUE OBJECT
Package

cari3s

Reader

instance (generic function)

Methods
Method: (setf instance) NEW-VALUE (BLOCK block)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: interval OBJECT

Accessor to the interval in seconds in which output is generated

The default interval is one second for generators, and 0.1 seconds for status-bars.

GENERATE is only called on generators if their own interval has expired. They will not be called more frequently than the status-bar’s own interval however.

See NEXT-TIME
See STATUS-BAR
See GENERATOR

Package

cari3s

Writer

(setf interval) (generic function)

Methods
Method: interval (STATUS-BAR status-bar)

automatically generated reader method

Source

status-bar.lisp (file)

Method: interval (GENERATOR generator)

automatically generated reader method

Source

generators.lisp (file)

Generic Function: (setf interval) NEW-VALUE OBJECT
Package

cari3s

Reader

interval (generic function)

Methods
Method: (setf interval) NEW-VALUE (STATUS-BAR status-bar)

automatically generated writer method

Source

status-bar.lisp (file)

Method: (setf interval) NEW-VALUE (GENERATOR generator)

automatically generated writer method

Source

generators.lisp (file)

Generic Function: listener OBJECT

The server socket to listen for connections on.

This is NIL if the server is not running.

This is not thread-safe to modify.

See EVENT-SERVER

Package

cari3s

Writer

(setf listener) (generic function)

Methods
Method: listener (EVENT-SERVER event-server)

automatically generated reader method

Source

event.lisp (file)

Generic Function: (setf listener) NEW-VALUE OBJECT
Package

cari3s

Reader

listener (generic function)

Methods
Method: (setf listener) NEW-VALUE (EVENT-SERVER event-server)

automatically generated writer method

Source

event.lisp (file)

Generic Function: location OBJECT

Accessor to the screen position of the click.

The location is a cons of X and Y coordinates, relative to the top left corner of the X11 root window in pixels.

See CLICK

Package

cari3s

Writer

(setf location) (generic function)

Methods
Method: location (WEATHER weather)

automatically generated reader method

Source

generators/weather.lisp (file)

Method: location (CLICK click)

automatically generated reader method

Source

event.lisp (file)

Generic Function: (setf location) NEW-VALUE OBJECT
Package

cari3s

Reader

location (generic function)

Methods
Method: (setf location) NEW-VALUE (WEATHER weather)

automatically generated writer method

Source

generators/weather.lisp (file)

Generic Function: markup OBJECT

Accessor to the list of markup regions for the pango block’s text.

See PANGO-BLOCK

Package

cari3s

Writer

(setf markup) (generic function)

Methods
Method: markup (PANGO-BLOCK pango-block)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf markup) NEW-VALUE OBJECT
Package

cari3s

Reader

markup (generic function)

Methods
Method: (setf markup) NEW-VALUE (PANGO-BLOCK pango-block)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: message OBJECT
Package

cari3s

Methods
Method: message (ECHO echo)

automatically generated reader method

Source

event.lisp (file)

Generic Function: min-width OBJECT

Accessor to the minimum pixel width of the block.

From i3docs:
The minimum width (in pixels) of the block. If the content of the text key take less space than the specified min-width, the block will be padded to the left and/or the right side, according to the align key. This is useful when you want to prevent the whole status line to shift when value take more or less space between each iteration. The value can also be a string. In this case, the width of the text given by min-width determines the minimum width of the block. This is useful when you want to set a sensible minimum width regardless of which font you are using, and at what particular size.

See BLOCK

Package

cari3s

Writer

(setf min-width) (generic function)

Methods
Method: min-width (BLOCK block)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf min-width) NEW-VALUE OBJECT
Package

cari3s

Reader

min-width (generic function)

Methods
Method: (setf min-width) NEW-VALUE (BLOCK block)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: name OBJECT

Accessor to the name of the block.

From i3docs:
Every block should have a unique name (string) entry so that it can be easily identified in scripts which process the output. i3bar completely ignores the name and instance fields. Make sure to also specify an instance (string) entry where appropriate. For example, the user can have multiple disk space blocks for multiple mount points.

See INSTANCE
See BLOCK
See CLICK

Package

cari3s

Writer

(setf name) (generic function)

Methods
Method: name (CLICK click)

automatically generated reader method

Source

event.lisp (file)

Method: name (BLOCK block)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf name) NEW-VALUE OBJECT
Package

cari3s

Reader

name (generic function)

Methods
Method: (setf name) NEW-VALUE (BLOCK block)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: next-time OBJECT

Accessor to the next time a tick event should be fired.

This is automatically updated when a tick event has fired or when a click event has fired and click-pause is set.

The value is in internal-time-units.

See INTERVAL
See CLICK-PAUSE
See STATUS-BAR

Package

cari3s

Writer

(setf next-time) (generic function)

Methods
Method: next-time (STATUS-BAR status-bar)

automatically generated reader method

Source

status-bar.lisp (file)

Generic Function: (setf next-time) NEW-VALUE OBJECT
Package

cari3s

Reader

next-time (generic function)

Methods
Method: (setf next-time) NEW-VALUE (STATUS-BAR status-bar)

automatically generated writer method

Source

status-bar.lisp (file)

Generic Function: object-initargs OBJECT

Returns a list of initargs to reconstruct the given object with make-instance.

By default this simply gathers a list of all slots that are
bound and that have at least one initarg. This is for the purpose
of reconstructing the object after serialisation.

You may add methods in case you want more precise control over
the reconstruction of the object.

Package

cari3s

Methods
Method: object-initargs OBJECT
Source

event.lisp (file)

Generic Function: output OBJECT

Accessor to the output stream to which the status-bar writes its results.

This defaults to *STANDARD-OUTPUT*

See PRODUCE-OUTPUT
See STATUS-BAR

Package

cari3s

Writer

(setf output) (generic function)

Methods
Method: output (STATUS-BAR status-bar)

automatically generated reader method

Source

status-bar.lisp (file)

Generic Function: (setf output) NEW-VALUE OBJECT
Package

cari3s

Reader

output (generic function)

Methods
Method: (setf output) NEW-VALUE (STATUS-BAR status-bar)

automatically generated writer method

Source

status-bar.lisp (file)

Generic Function: parse-event-or-lose STREAM

Attempts to parse an event from the given source, signalling an error on failure.

This will return an EVENT instance.

See EVENT

Package

cari3s

Methods
Method: parse-event-or-lose (STRING string)
Source

event.lisp (file)

Method: parse-event-or-lose (STREAM stream)
Source

event.lisp (file)

Generic Function: port OBJECT

The port on which the server listens for connections.

Defaults to 2424.

See EVENT-SERVER

Package

cari3s

Methods
Method: port (EVENT-SERVER event-server)

automatically generated reader method

Source

event.lisp (file)

Generic Function: process BAR

Processes the status-bar, causing it to potentially read inputs and generate outputs.

First the input is checked for a new click event. If one is there,
it is parsed from the stream and output is produced according to
GENERATE on the generators and the click event. If click-pause is
set, the next-time is delayed by click-pause number of seconds from
the current time.

Next the next-time is checked against the current internal real
time. If the time has passed, output is produced according to
GENERATE on the generators and a new tick event. The next-time is
then delayed by interval number of seconds from the current time.

See CLICK
See TICK
See NEXT-TIME
See CLICK-PAUSE
See INTERVAL
See GENERATOR
See GENERATORS
See STATUS-BAR

Package

cari3s

Methods
Method: process (BAR status-bar)
Source

status-bar.lisp (file)

Generic Function: process-connections SERVER

Processes the event-server connections.

This proceeds by listening for new connections and accepting them if there are any. It then listens on each socket in turn, parsing and processing pending events.
If a stream or socket error occurs, the connection is removed. If another error occurs during parsing or processing, an error is sent back to the client.

See PARSE-EVENT-OR-LOSE
See PROCESS-EVENT
See SERIALIZE-OBJECT
See EVENT-SERVER

Package

cari3s

Methods
Method: process-connections (SERVER event-server)
Source

event.lisp (file)

Generic Function: process-event EVENT PROCESSOR

Causes the given event to be processed by the specified receiver.

If the receiver does not understand the event, an error is signalled. In the case of a status-bar, unknown events are passed on to its generators. In the case of a generator, unknown events are ignored.

You should add methods to this as necessary in order to interface your object with the general event system.

See EVENT

Package

cari3s

Source

event.lisp (file)

Methods
Method: process-event (EVENT generate) (BAR status-bar)
Source

status-bar.lisp (file)

Method: process-event (EVENT echo) (BAR status-bar)
Source

status-bar.lisp (file)

Method: process-event (EVENT event) (BAR status-bar)
Source

status-bar.lisp (file)

Method: process-event (EVENT event) (GENERATOR generator)
Source

generators.lisp (file)

Generic Function: produce-output BAR PAYLOAD

Outputs the given payload as JSON to the status-bar’s output stream.

See OUTPUT
See STATUS-BAR

Package

cari3s

Methods
Method: produce-output (BAR status-bar) PAYLOAD
Source

status-bar.lisp (file)

Generic Function: relative-location OBJECT

Accessor to the relative position of the click.

The location is a cons of X and Y coordinates, relative to the top left corner of the block itself in pixels.

See CLICK

Package

cari3s

Methods
Method: relative-location (CLICK click)

automatically generated reader method

Source

event.lisp (file)

Generic Function: send-click-events-p OBJECT

Whether i3 should send click updates to the process.

Defaults to NIL

See HEADER

Package

cari3s

Writer

(setf send-click-events-p) (generic function)

Methods
Method: send-click-events-p (HEADER header)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf send-click-events-p) NEW-VALUE OBJECT
Package

cari3s

Reader

send-click-events-p (generic function)

Methods
Method: (setf send-click-events-p) NEW-VALUE (HEADER header)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: separator OBJECT

Accessor to the block’s separator behaviour.

If set should be either T, or a number of pixels for the width of the separator. If T, the default i3 behaviour is to use 9 pixels of width for the separator.

Package

cari3s

Writer

(setf separator) (generic function)

Methods
Method: separator (BLOCK block)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf separator) NEW-VALUE OBJECT
Package

cari3s

Reader

separator (generic function)

Methods
Method: (setf separator) NEW-VALUE (BLOCK block)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: serialize-object OBJECT STREAM

Serialises the object to the given stream in the event protocol format.

The event protocol format is an UTF-8 based format:
OBJECT ::= "NIL" | "T" | INSTANCE
INSTANCE ::= CLASS-NAME INITARG*
INITARG ::= keyword VALUE
VALUE ::= symbol | string | real | list

Programs that intend on parsing events or return values
from Cari3s need to be able to parse this format and
serialise their respective format to it as well.

Restrictions on the encoding of values:
- Strings may not contain the Linefeed character.
- Symbols must be either unqualified (without the package
prefix), or keywords.
- Symbol names may not contain the Linefeed character.
- Symbol names must be written in all lowercase with the
exception of NIL and T which are written all uppercase.
- Only proper lists are allowed.

Package

cari3s

Methods
Method: serialize-object (OBJECT standard-object) STREAM
Source

event.lisp (file)

Method: serialize-object (OBJECT structure-object) STREAM
Source

event.lisp (file)

Method: serialize-object (OBJECT condition) STREAM
Source

event.lisp (file)

Method: serialize-object (OBJECT string) STREAM
Source

event.lisp (file)

Method: serialize-object (OBJECT cons) STREAM
Source

event.lisp (file)

Method: serialize-object (OBJECT real) STREAM
Source

event.lisp (file)

Method: serialize-object (OBJECT symbol) STREAM
Source

event.lisp (file)

Method: serialize-object (OBJECT (eql nil)) STREAM
Source

event.lisp (file)

Method: serialize-object (OBJECT (eql t)) STREAM
Source

event.lisp (file)

Generic Function: short-markup OBJECT

Accessor to the list of markup regions for the pango block’s short-text.

See PANGO-BLOCK

Package

cari3s

Writer

(setf short-markup) (generic function)

Methods
Method: short-markup (PANGO-BLOCK pango-block)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf short-markup) NEW-VALUE OBJECT
Package

cari3s

Reader

short-markup (generic function)

Methods
Method: (setf short-markup) NEW-VALUE (PANGO-BLOCK pango-block)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: short-text OBJECT

Accessor to the short, alternate text content of the block.

From i3docs:
Where appropriate, the short-text should also be provided. It will be used in case the status line needs to be shortened because it uses more space than your screen provides. For example, when displaying an IPv6 address, the prefix is usually (!) more relevant than the suffix, because the latter stays constant when using autoconf, while the prefix changes. When displaying the date, the time is more important than the date (it is more likely that you know which day it is than what time it is).

See BLOCK

Package

cari3s

Writer

(setf short-text) (generic function)

Methods
Method: short-text (GENERATOR value-generator)
Source

generators.lisp (file)

Method: short-text (BLOCK pango-block)
Source

protocol.lisp (file)

Method: short-text (BLOCK block)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf short-text) NEW-VALUE OBJECT
Package

cari3s

Reader

short-text (generic function)

Methods
Method: (setf short-text) NEW-VALUE (BLOCK block)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: start SERVER

Start the event-server.

If it is already started, an error is signalled.

See EVENT-SERVER

Package

cari3s

Methods
Method: start (SERVER event-server)
Source

event.lisp (file)

Generic Function: stop SERVER

Stops the event-server.

If it is already stopped, nothing is done.

See EVENT-SERVER

Package

cari3s

Methods
Method: stop (SERVER event-server)
Source

event.lisp (file)

Generic Function: stop-signal OBJECT

The unix signal used to pause bar updates.

Defaults to 19 (SIGSTOP)

See HEADER

Package

cari3s

Writer

(setf stop-signal) (generic function)

Methods
Method: stop-signal (HEADER header)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf stop-signal) NEW-VALUE OBJECT
Package

cari3s

Reader

stop-signal (generic function)

Methods
Method: (setf stop-signal) NEW-VALUE (HEADER header)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: text OBJECT

Accessor to the full textual content of the block.

This field is required to be set.

See BLOCK

Package

cari3s

Writer

(setf text) (generic function)

Methods
Method: text (GENERATOR value-generator)
Source

generators.lisp (file)

Method: text (BLOCK pango-block)
Source

protocol.lisp (file)

Method: text (BLOCK block)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf text) NEW-VALUE OBJECT
Package

cari3s

Reader

text (generic function)

Methods
Method: (setf text) NEW-VALUE (BLOCK block)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: text-format BLOCK

Returns the text format used by the block’s text content.

Defaults to :none

See BLOCK

Package

cari3s

Methods
Method: text-format (BLOCK pango-block)
Source

protocol.lisp (file)

Method: text-format (BLOCK block)
Source

protocol.lisp (file)

Generic Function: to-table OBJECT

Turn the object into a table of basic types.

This is intended for json serialisation. Allowed types are: - hash-table
- string
- list
- vector
- number
- T
- NIL

Package

cari3s

Source

protocol.lisp (file)

Methods
Method: to-table (BLOCK block)
Method: to-table (HEADER header)
Generic Function: urgent-p OBJECT

Accessor to whether the block is considered urgent or not.

From i3docs:
A boolean which specifies whether the current value is urgent. Examples are battery charge values below 1 percent or no more available disk space (for non-root users). The presentation of urgency is up to i3bar.

See BLOCK

Package

cari3s

Writer

(setf urgent-p) (generic function)

Methods
Method: urgent-p (BLOCK block)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf urgent-p) NEW-VALUE OBJECT
Package

cari3s

Reader

urgent-p (generic function)

Methods
Method: (setf urgent-p) NEW-VALUE (BLOCK block)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: version OBJECT

The version integer of the protocol that is used.

Defaults to 1.

See HEADER

Package

cari3s

Writer

(setf version) (generic function)

Methods
Method: version (HEADER header)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf version) NEW-VALUE OBJECT
Package

cari3s

Reader

version (generic function)

Methods
Method: (setf version) NEW-VALUE (HEADER header)

automatically generated writer method

Source

protocol.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Classes

Class: battery ()

A generator for battery status information.

You may supply the name of the battery of interest using the :BATTERY initarg. It defaults to the first battery device.

This value-generator supplies the following six values: 0. charge-percentage
1. charging-p
2. discharging-p
3. hours-remaining
4. minutes-remaining
5. seconds-remaining

See VALUE-GENERATOR

Package

cari3s

Source

generators/battery.lisp (file)

Direct superclasses

value-generator (class)

Direct methods
Direct slots
Slot: battery-name
Initargs

:battery

Readers

battery-name (generic function)

Writers

(setf battery-name) (generic function)

Direct Default Initargs
InitargValue
:text"bat ~4,1f%~:[~; 🡅~]~:[~; 🡇~]~@[ ~d:~2,'0d~]"
:batteryt
:markup(quote ((0 3 :color 35054)))
Class: block ()

Class representing a block in the i3 status bar.

A block is a textual container with some styling options.
See your i3 documentation for more information on blocks and their behaviour.

Instances of this class can be serialised using Jonathan.

See TEXT
See SHORT-TEXT
See FOREGROUND
See BACKGROUND
See BORDER
See MIN-WIDTH
See ALIGN
See NAME
See INSTANCE
See URGENT-P
See SEPARATOR
See TEXT-FORMAT

Package

cari3s

Source

protocol.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

pango-block (class)

Direct methods
Direct slots
Slot: text
Initargs

:text

Readers

text (generic function)

Writers

(setf text) (generic function)

Slot: short-text
Initargs

:short-text

Readers

short-text (generic function)

Writers

(setf short-text) (generic function)

Slot: foreground
Initargs

:foreground

Readers

foreground (generic function)

Writers

(setf foreground) (generic function)

Slot: background
Initargs

:background

Readers

background (generic function)

Writers

(setf background) (generic function)

Slot: border
Initargs

:border

Readers

border (generic function)

Writers

(setf border) (generic function)

Slot: min-width
Initargs

:min-width

Readers

min-width (generic function)

Writers

(setf min-width) (generic function)

Slot: align
Initargs

:align

Readers

align (generic function)

Writers

(setf align) (generic function)

Slot: name
Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: instance
Initargs

:instance

Readers

instance (generic function)

Writers

(setf instance) (generic function)

Slot: urgent-p
Initargs

:urgent-p

Readers

urgent-p (generic function)

Writers

(setf urgent-p) (generic function)

Slot: separator
Initargs

:separator

Readers

separator (generic function)

Writers

(setf separator) (generic function)

Direct Default Initargs
InitargValue
:text(error "text required.")
:short-textnil
:foregroundnil
:backgroundnil
:bordernil
:min-widthnil
:align:left
:namenil
:instancenil
:urgent-pnil
:separatort
Class: click ()

Class representing a click event being fired on a block.

This event comes from i3 itself if the connection was opened with a header that has SEND-CLICK-EVENTS-P set to T.

See NAME
See INSTANCE
See BUTTON
See LOCATION
See RELATIVE-LOCATION
See BLOCK-SIZE

Package

cari3s

Source

event.lisp (file)

Direct superclasses

event (class)

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name (generic function)

Slot: instance
Initargs

:instance

Readers

instance (generic function)

Slot: button
Initargs

:button

Readers

button (generic function)

Slot: location
Initargs

:location

Readers

location (generic function)

Slot: relative-location
Initargs

:relative-location

Readers

relative-location (generic function)

Slot: block-size
Initargs

:block-size

Readers

block-size (generic function)

Direct Default Initargs
InitargValue
:namenil
:instancenil
:button1
:locationnil
:relative-locationnil
:block-sizenil
Class: clock ()

A generator for a current local time clock.

This value-generator supplies the following nine values: 0. year
1. month
2. day-of-month
3. day-of-week
4. hour
5. minute
6. second
7. short-day-name
8. short-month-name

See VALUE-GENERATOR

Package

cari3s

Source

generators/clock.lisp (file)

Direct superclasses

value-generator (class)

Direct methods

compute-value (method)

Direct Default Initargs
InitargValue
:text"date ~7@*~a ~2@*~2d ~8@*~a ~4@*~2d:~2,'0d:~2,'0d"
:markup(quote ((0 4 :color 35054)))
Class: cpu-usage ()

A generator for the current CPU usage.

This value-generator supplies the following value: 0. usage-percentage

See VALUE-GENERATOR

Package

cari3s

Source

generators/cpu-usage.lisp (file)

Direct superclasses

value-generator (class)

Direct methods
Direct slots
Slot: previous-time
Initform

0

Readers

previous-time (generic function)

Writers

(setf previous-time) (generic function)

Slot: previous-idle
Initform

0

Readers

previous-idle (generic function)

Writers

(setf previous-idle) (generic function)

Direct Default Initargs
InitargValue
:text"cpu ~4,1f%"
:markup(quote ((0 3 :color 35054)))
Class: disk-usage ()

A generator for the current partition capacity usage.

You may specify the path to the partition of interest using the :DEVICE initarg.

This value-generator supplies the following value:
0. usage-percentage

See VALUE-GENERATOR

Package

cari3s

Source

generators/disk-usage.lisp (file)

Direct superclasses

value-generator (class)

Direct methods
Direct slots
Slot: device
Initargs

:device

Readers

device (generic function)

Writers

(setf device) (generic function)

Direct Default Initargs
InitargValue
:text"disk ~4,1f%"
:markup(quote ((0 4 :color 35054)))
:device"/"
Class: echo ()

An event that is sent back over the connection as-is.

This event does not reach generators.

See event

Package

cari3s

Source

event.lisp (file)

Direct superclasses

event (class)

Direct methods
Direct slots
Slot: message
Initargs

:message

Readers

message (generic function)

Class: event ()

Superclass for all events that might happen in the system.

See PROCESS-EVENT

Package

cari3s

Source

event.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Class: event-server ()

Represents an event exchange server.

This server runs a TCP listener on a given port on the localhost. The port defaults to 2424. Once started, the server accepts an arbitrary amount of connections, over which events can be issued. An event should follow the format as specified in SERIALIZE-OBJECT, and should be followed by a single Linefeed. For each event issued, the server will respond with one or more objects. The connection is never closed by the server except for when the underlying stream is closed, or a TCP error occurs and the connection is doomed anyway. The client is allowed to terminate the connection at any time.

This class on its own does nothing. In order to start the server listener, START must be called. STOP can be called to end the listener and disconnect all clients. Once started, PROCESS-CONNECTIONS must be called regularly in order to accept new connections, handle incoming events, and to clean up old connections that have disconnected.

See PORT
See LISTENER
See CONNECTIONS
See START
See STOP
See PROCESS-CONNECTIONS

Package

cari3s

Source

event.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

status-bar (class)

Direct methods
Direct slots
Slot: port
Initargs

:port

Readers

port (generic function)

Slot: listener
Readers

listener (generic function)

Writers

(setf listener) (generic function)

Slot: connections
Readers

connections (generic function)

Writers

(setf connections) (generic function)

Direct Default Initargs
InitargValue
:port2424
Class: generate ()

An event to signal that blocks should be generated immediately.

This event does not reach generators.

See event

Package

cari3s

Source

event.lisp (file)

Direct superclasses

event (class)

Direct methods

process-event (method)

Class: generator ()

This is the superclass for all block generators.

A generator is responsible for creating one or more blocks that are emitted into the status bar.

A concrete class of a generator must supply a primary method on GENERATE.

See GENERATE
See INTERVAL
See PROCESS-EVENT

Package

cari3s

Source

generators.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

single-generator (class)

Direct methods
Direct slots
Slot: last-generation
Initform

most-negative-fixnum

Readers

last-generation (generic function)

Writers

(setf last-generation) (generic function)

Slot: interval
Initargs

:interval

Readers

interval (generic function)

Writers

(setf interval) (generic function)

Direct Default Initargs
InitargValue
:interval1
Class: header ()

Class representing the i3bar protocol header.

Instances of this class can be serialised using Jonathan.

See VERSION
See STOP-SIGNAL
See CONTINUE-SIGNAL
See SEND-CLICK-EVENTS-P

Package

cari3s

Source

protocol.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: version
Initargs

:version

Readers

version (generic function)

Writers

(setf version) (generic function)

Slot: stop-signal
Initargs

:stop-signal

Readers

stop-signal (generic function)

Writers

(setf stop-signal) (generic function)

Slot: continue-signal
Initargs

:continue-signal

Readers

continue-signal (generic function)

Writers

(setf continue-signal) (generic function)

Slot: send-click-events-p
Initargs

:send-click-events-p

Readers

send-click-events-p (generic function)

Writers

(setf send-click-events-p) (generic function)

Direct Default Initargs
InitargValue
:version1
:stop-signal19
:continue-signal18
:send-click-events-pnil
Class: io-usage ()

A generator for the current disk i/o usage.

You may specify whether you’re interested in :read, :write, or :read-write using the :DIRECTION initarg.

This value-generator supplies the following value:
0. megabytes-per-second

See VALUE-GENERATOR

Package

cari3s

Source

generators/io-usage.lisp (file)

Direct superclasses

value-generator (class)

Direct methods
Direct slots
Slot: device
Initargs

:device

Readers

device (generic function)

Writers

(setf device) (generic function)

Slot: direction
Initargs

:direction

Readers

direction (generic function)

Writers

(setf direction) (generic function)

Slot: previous-time
Initform

(get-internal-real-time)

Readers

previous-time (generic function)

Writers

(setf previous-time) (generic function)

Slot: previous-value
Initform

0

Readers

previous-value (generic function)

Writers

(setf previous-value) (generic function)

Direct Default Initargs
InitargValue
:text"i/o ~4,1fm/s"
:markup(quote ((0 3 :color 35054)))
:devicet
:direction:read-write
Class: mem-usage ()

A generator for the current memory usage.

You may specify whether you’re interested in swap and cache by using the :SWAP and :CACHE initargs respectively.

This value-generator supplies the following three values: 0. usage-percentage
1. total-megabytes
2. free-megabytes

See VALUE-GENERATOR

Package

cari3s

Source

generators/mem-usage.lisp (file)

Direct superclasses

value-generator (class)

Direct methods
Direct slots
Slot: include-swap
Initargs

:include-swap

Readers

include-swap (generic function)

Writers

(setf include-swap) (generic function)

Slot: include-cache
Initargs

:include-cache

Readers

include-cache (generic function)

Writers

(setf include-cache) (generic function)

Direct Default Initargs
InitargValue
:text"mem ~4,1f%"
:markup(quote ((0 3 :color 35054)))
:include-swapnil
:include-cachenil
Class: network-ip ()

A generator for the current network IP address.

You may specify which device you’re interested in with the :DEVICE initarg. It defaults to whichever device is listed first that does not bind to localhost.

This value-generator supplies the following two values: 0. ip-address
1. device-name

See VALUE-GENERATOR

Package

cari3s

Source

generators/network-ip.lisp (file)

Direct superclasses

value-generator (class)

Direct methods
Direct slots
Slot: device
Initargs

:device

Readers

device (generic function)

Writers

(setf device) (generic function)

Direct Default Initargs
InitargValue
:text"ip ~a"
:markup(quote ((0 2 :color 35054)))
:devicet
Class: pango-block ()

Represents a block whose text should be marked up with pango.

Note that neither TEXT nor SHORT-TEXT should contain raw pango markup tags themselves, but rather you should use the MARKUP and SHORT-MARKUP slots to set the markup regions to be used.

TEXT and SHORT-TEXT will automatically render the textual contents with the appropriate markup regions.

Each entry in the MARKUP and SHORT-MARKUP lists should have the following structure:

(START END . MARKUP/MARKUP-OPTIONS)

Please see the pango-markup library for more information:

https://shinmera.github.io/pango-markup

See MARKUP
See SHORT-MARKUP
See PANGO-MARKUP:MARKUP-REGIONS

Package

cari3s

Source

protocol.lisp (file)

Direct superclasses

block (class)

Direct subclasses

single-generator (class)

Direct methods
Direct slots
Slot: markup
Initargs

:markup

Readers

markup (generic function)

Writers

(setf markup) (generic function)

Slot: short-markup
Initargs

:short-markup

Readers

short-markup (generic function)

Writers

(setf short-markup) (generic function)

Direct Default Initargs
InitargValue
:markupnil
:short-markupnil
Class: single-generator ()

Superclass for all block generators that only generate a single block.

As a convenience, this generator also directly inherits from PANGO-BLOCK in order to let the user and subclasses customise
the block’s look and feel conveniently.

The primary method of a single-generator’s GENERATE does not
need to return anything useful, as the generator itself is
always automatically returned from GENERATE in a list.

If no :name is provided on a single-generator instance, the name is automatically set to the class-name of the instance’s class.

See PANGO-BLOCK
See GENERATOR
See GENERATE

Package

cari3s

Source

generators.lisp (file)

Direct superclasses
Direct subclasses

value-generator (class)

Direct methods
  • generate (method)
  • initialize-instance (method)
Class: status-bar ()

Class to represent an i3 status bar.

An instance of this class is capable of handling the i3 protocol and invoking a number of block generators at the appropriate times. It also handles remote client connections through the event-server.

See INTERVAL
See NEXT-TIME
See GENERATORS
See OUTPUT
See INPUT
See CLICK-PAUSE
See PRODUCE-OUTPUT
See PROCESS
See RUN-BAR
See EVENT-SERVER

Package

cari3s

Source

status-bar.lisp (file)

Direct superclasses

event-server (class)

Direct methods
Direct slots
Slot: interval
Initargs

:interval

Readers

interval (generic function)

Writers

(setf interval) (generic function)

Slot: next-time
Initform

0

Readers

next-time (generic function)

Writers

(setf next-time) (generic function)

Slot: generators
Initargs

:generators

Readers

generators (generic function)

Writers

(setf generators) (generic function)

Slot: blocks
Initform

(make-hash-table :test (quote eq))

Readers

blocks (generic function)

Writers

(setf blocks) (generic function)

Slot: output
Initargs

:output

Readers

output (generic function)

Writers

(setf output) (generic function)

Slot: input
Initargs

:input

Readers

input (generic function)

Writers

(setf input) (generic function)

Slot: click-pause
Initargs

:click-pause

Readers

click-pause (generic function)

Writers

(setf click-pause) (generic function)

Direct Default Initargs
InitargValue
:interval1
:click-pause1
:generatorsnil
:output*standard-output*
:input*standard-input*
Class: uptime ()

A generator for the current system uptime.

This value-generator supplies the following four values: 0. uptime-days (NIL if zero)
1. uptime-hours
2. uptime-minutes
3. uptime-seconds

Package

cari3s

Source

generators/uptime.lisp (file)

Direct superclasses

value-generator (class)

Direct methods

compute-value (method)

Direct Default Initargs
InitargValue
:text"up~@[ ~dd~] ~d:~2,'0d"
:markup(quote ((0 2 :color 35054)))
Class: value-generator ()

Superclass for all block generators that generate their text content based on some computed value.

The TEXT and SHORT-TEXT of a value-generator should be format
strings that may consume however many values the respective
generator promises to supply.

Note that the pango markup for both text and short-text is
applied AFTER the format string has been formatted in order to
avoid encoding issues with entities in format directives.

A concrete class of a value-generator must supply a primary
method on COMPUTE-VALUE.

See COMPUTE-VALUE
See SINGLE-GENERATOR

Package

cari3s

Source

generators.lisp (file)

Direct superclasses

single-generator (class)

Direct subclasses
Direct methods
Direct slots
Slot: value
Readers

value (generic function)

Writers

(setf value) (generic function)

Class: weather ()

A generator for current weather data.

You must specify your darksky.net api-key via the :API-KEY initarg, and your global coordinates in the (LAT . LNG) format via the :LOCATION initarg.

This requires an active internet connection to function.

This value-generator supplies the following seven values:
0. summary
1. temperature [C]
2. temperature-apparent-p
3. apparent-temperature [C]
4. humidity [%]
5. wind [km/h]
6. pressure [hPa]

Package

cari3s

Source

generators/weather.lisp (file)

Direct superclasses

value-generator (class)

Direct methods
Direct slots
Slot: api-key
Initargs

:api-key

Readers

api-key (generic function)

Writers

(setf api-key) (generic function)

Slot: location
Initargs

:location

Readers

location (generic function)

Writers

(setf location) (generic function)

Direct Default Initargs
InitargValue
:text"weather ~a at ~d°c~:[ (~d°c)~;~*~], ~d%, ~dkm/h, ~dhpa"
:markup(quote ((0 7 :color 35054)))
:interval(* 60 60)
:api-key(error "api-key required")
:location(error "location required")

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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Constants

Constant: ni-maxhost
Package

cari3s

Source

generators/network-ip.lisp (file)

Constant: ni-numerichost
Package

cari3s

Source

generators/network-ip.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Special variables

Special Variable: *weather-api*
Package

cari3s

Source

generators/weather.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Macros

Macro: with-input-ready (STREAM) &body BODY
Package

cari3s

Source

status-bar.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Functions

Function: %serialize-object OBJECT STREAM
Package

cari3s

Source

event.lisp (file)

Function: day-short-name DAY
Package

cari3s

Source

toolkit.lisp (file)

Function: eformat STRING &rest ARGS
Package

cari3s

Source

toolkit.lisp (file)

Function: format-color-string COLOR
Package

cari3s

Source

toolkit.lisp (file)

Function: freeifaddrs IFADDRS
Package

cari3s

Source

generators/network-ip.lisp (file)

Function: getifaddrs IFADDRS
Package

cari3s

Source

generators/network-ip.lisp (file)

Function: getnameinfo ADDR LEN HOST HOSTLEN SERV SERVLEN FLAGS
Package

cari3s

Source

generators/network-ip.lisp (file)

Function: ifaddrs-address POINTER-TO-IFADDRS
Function: (setf ifaddrs-address) VALUE POINTER-TO-IFADDRS
Package

cari3s

Source

generators/network-ip.lisp (file)

Function: ifaddrs-broadcast/destination-address POINTER-TO-IFADDRS
Function: (setf ifaddrs-broadcast/destination-address) VALUE POINTER-TO-IFADDRS
Package

cari3s

Source

generators/network-ip.lisp (file)

Function: ifaddrs-data POINTER-TO-IFADDRS
Function: (setf ifaddrs-data) VALUE POINTER-TO-IFADDRS
Package

cari3s

Source

generators/network-ip.lisp (file)

Function: ifaddrs-flags POINTER-TO-IFADDRS
Function: (setf ifaddrs-flags) VALUE POINTER-TO-IFADDRS
Package

cari3s

Source

generators/network-ip.lisp (file)

Function: ifaddrs-name POINTER-TO-IFADDRS
Function: (setf ifaddrs-name) VALUE POINTER-TO-IFADDRS
Package

cari3s

Source

generators/network-ip.lisp (file)

Function: ifaddrs-netmask POINTER-TO-IFADDRS
Function: (setf ifaddrs-netmask) VALUE POINTER-TO-IFADDRS
Package

cari3s

Source

generators/network-ip.lisp (file)

Function: ifaddrs-next POINTER-TO-IFADDRS
Function: (setf ifaddrs-next) VALUE POINTER-TO-IFADDRS
Package

cari3s

Source

generators/network-ip.lisp (file)

Function: month-short-name MM
Package

cari3s

Source

toolkit.lisp (file)

Function: parse-all-integers STRING &key START END
Package

cari3s

Source

toolkit.lisp (file)

Function: parse-meminfo ()
Package

cari3s

Source

generators/mem-usage.lisp (file)

Function: sockaddr-data POINTER-TO-SOCKADDR
Function: (setf sockaddr-data) VALUE POINTER-TO-SOCKADDR
Package

cari3s

Source

generators/network-ip.lisp (file)

Function: sockaddr-family POINTER-TO-SOCKADDR
Function: (setf sockaddr-family) VALUE POINTER-TO-SOCKADDR
Package

cari3s

Source

generators/network-ip.lisp (file)

Function: statfs PATH BUF
Package

cari3s

Source

generators/disk-usage.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Generic functions

Generic Function: api-key OBJECT
Generic Function: (setf api-key) NEW-VALUE OBJECT
Package

cari3s

Methods
Method: api-key (WEATHER weather)

automatically generated reader method

Source

generators/weather.lisp (file)

Method: (setf api-key) NEW-VALUE (WEATHER weather)

automatically generated writer method

Source

generators/weather.lisp (file)

Generic Function: battery-name OBJECT
Generic Function: (setf battery-name) NEW-VALUE OBJECT
Package

cari3s

Methods
Method: battery-name (BATTERY battery)

automatically generated reader method

Source

generators/battery.lisp (file)

Method: (setf battery-name) NEW-VALUE (BATTERY battery)

automatically generated writer method

Source

generators/battery.lisp (file)

Generic Function: blocks OBJECT
Generic Function: (setf blocks) NEW-VALUE OBJECT
Package

cari3s

Methods
Method: blocks (STATUS-BAR status-bar)

automatically generated reader method

Source

status-bar.lisp (file)

Method: (setf blocks) NEW-VALUE (STATUS-BAR status-bar)

automatically generated writer method

Source

status-bar.lisp (file)

Generic Function: device OBJECT
Generic Function: (setf device) NEW-VALUE OBJECT
Package

cari3s

Methods
Method: device (NETWORK-IP network-ip)

automatically generated reader method

Source

generators/network-ip.lisp (file)

Method: (setf device) NEW-VALUE (NETWORK-IP network-ip)

automatically generated writer method

Source

generators/network-ip.lisp (file)

Method: device (IO-USAGE io-usage)

automatically generated reader method

Source

generators/io-usage.lisp (file)

Method: (setf device) NEW-VALUE (IO-USAGE io-usage)

automatically generated writer method

Source

generators/io-usage.lisp (file)

Method: device (DISK-USAGE disk-usage)

automatically generated reader method

Source

generators/disk-usage.lisp (file)

Method: (setf device) NEW-VALUE (DISK-USAGE disk-usage)

automatically generated writer method

Source

generators/disk-usage.lisp (file)

Generic Function: direction OBJECT
Generic Function: (setf direction) NEW-VALUE OBJECT
Package

cari3s

Methods
Method: direction (IO-USAGE io-usage)

automatically generated reader method

Source

generators/io-usage.lisp (file)

Method: (setf direction) NEW-VALUE (IO-USAGE io-usage)

automatically generated writer method

Source

generators/io-usage.lisp (file)

Generic Function: include-cache OBJECT
Generic Function: (setf include-cache) NEW-VALUE OBJECT
Package

cari3s

Methods
Method: include-cache (MEM-USAGE mem-usage)

automatically generated reader method

Source

generators/mem-usage.lisp (file)

Method: (setf include-cache) NEW-VALUE (MEM-USAGE mem-usage)

automatically generated writer method

Source

generators/mem-usage.lisp (file)

Generic Function: include-swap OBJECT
Generic Function: (setf include-swap) NEW-VALUE OBJECT
Package

cari3s

Methods
Method: include-swap (MEM-USAGE mem-usage)

automatically generated reader method

Source

generators/mem-usage.lisp (file)

Method: (setf include-swap) NEW-VALUE (MEM-USAGE mem-usage)

automatically generated writer method

Source

generators/mem-usage.lisp (file)

Generic Function: last-generation OBJECT
Generic Function: (setf last-generation) NEW-VALUE OBJECT
Package

cari3s

Methods
Method: last-generation (GENERATOR generator)

automatically generated reader method

Source

generators.lisp (file)

Method: (setf last-generation) NEW-VALUE (GENERATOR generator)

automatically generated writer method

Source

generators.lisp (file)

Generic Function: previous-idle OBJECT
Generic Function: (setf previous-idle) NEW-VALUE OBJECT
Package

cari3s

Methods
Method: previous-idle (CPU-USAGE cpu-usage)

automatically generated reader method

Source

generators/cpu-usage.lisp (file)

Method: (setf previous-idle) NEW-VALUE (CPU-USAGE cpu-usage)

automatically generated writer method

Source

generators/cpu-usage.lisp (file)

Generic Function: previous-time OBJECT
Generic Function: (setf previous-time) NEW-VALUE OBJECT
Package

cari3s

Methods
Method: previous-time (IO-USAGE io-usage)

automatically generated reader method

Source

generators/io-usage.lisp (file)

Method: (setf previous-time) NEW-VALUE (IO-USAGE io-usage)

automatically generated writer method

Source

generators/io-usage.lisp (file)

Method: previous-time (CPU-USAGE cpu-usage)

automatically generated reader method

Source

generators/cpu-usage.lisp (file)

Method: (setf previous-time) NEW-VALUE (CPU-USAGE cpu-usage)

automatically generated writer method

Source

generators/cpu-usage.lisp (file)

Generic Function: previous-value OBJECT
Generic Function: (setf previous-value) NEW-VALUE OBJECT
Package

cari3s

Methods
Method: previous-value (IO-USAGE io-usage)

automatically generated reader method

Source

generators/io-usage.lisp (file)

Method: (setf previous-value) NEW-VALUE (IO-USAGE io-usage)

automatically generated writer method

Source

generators/io-usage.lisp (file)

Generic Function: process-inputs BAR
Package

cari3s

Methods
Method: process-inputs (BAR status-bar)
Source

status-bar.lisp (file)

Generic Function: value OBJECT
Generic Function: (setf value) NEW-VALUE OBJECT
Package

cari3s

Methods
Method: value (VALUE-GENERATOR value-generator)

automatically generated reader method

Source

generators.lisp (file)

Method: (setf value) NEW-VALUE (VALUE-GENERATOR value-generator)

automatically generated writer method

Source

generators.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.6 Classes

Class: file-system-id-tclass ()
Package

cari3s

Source

generators/disk-usage.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: file-system-tclass ()
Package

cari3s

Source

generators/disk-usage.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: ifaddrs-tclass ()
Package

cari3s

Source

generators/network-ip.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: sockaddr-tclass ()
Package

cari3s

Source

generators/network-ip.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cari3s.asd: The cari3s<dot>asd file
cari3s/documentation.lisp: The cari3s/documentation<dot>lisp file
cari3s/event.lisp: The cari3s/event<dot>lisp file
cari3s/generators.lisp: The cari3s/generators<dot>lisp file
cari3s/generators/battery.lisp: The cari3s/generators/battery<dot>lisp file
cari3s/generators/clock.lisp: The cari3s/generators/clock<dot>lisp file
cari3s/generators/cpu-usage.lisp: The cari3s/generators/cpu-usage<dot>lisp file
cari3s/generators/disk-usage.lisp: The cari3s/generators/disk-usage<dot>lisp file
cari3s/generators/io-usage.lisp: The cari3s/generators/io-usage<dot>lisp file
cari3s/generators/mem-usage.lisp: The cari3s/generators/mem-usage<dot>lisp file
cari3s/generators/network-ip.lisp: The cari3s/generators/network-ip<dot>lisp file
cari3s/generators/uptime.lisp: The cari3s/generators/uptime<dot>lisp file
cari3s/generators/weather.lisp: The cari3s/generators/weather<dot>lisp file
cari3s/package.lisp: The cari3s/package<dot>lisp file
cari3s/protocol.lisp: The cari3s/protocol<dot>lisp file
cari3s/status-bar.lisp: The cari3s/status-bar<dot>lisp file
cari3s/toolkit.lisp: The cari3s/toolkit<dot>lisp file
cari3s/toplevel.lisp: The cari3s/toplevel<dot>lisp file

F
File, Lisp, cari3s.asd: The cari3s<dot>asd file
File, Lisp, cari3s/documentation.lisp: The cari3s/documentation<dot>lisp file
File, Lisp, cari3s/event.lisp: The cari3s/event<dot>lisp file
File, Lisp, cari3s/generators.lisp: The cari3s/generators<dot>lisp file
File, Lisp, cari3s/generators/battery.lisp: The cari3s/generators/battery<dot>lisp file
File, Lisp, cari3s/generators/clock.lisp: The cari3s/generators/clock<dot>lisp file
File, Lisp, cari3s/generators/cpu-usage.lisp: The cari3s/generators/cpu-usage<dot>lisp file
File, Lisp, cari3s/generators/disk-usage.lisp: The cari3s/generators/disk-usage<dot>lisp file
File, Lisp, cari3s/generators/io-usage.lisp: The cari3s/generators/io-usage<dot>lisp file
File, Lisp, cari3s/generators/mem-usage.lisp: The cari3s/generators/mem-usage<dot>lisp file
File, Lisp, cari3s/generators/network-ip.lisp: The cari3s/generators/network-ip<dot>lisp file
File, Lisp, cari3s/generators/uptime.lisp: The cari3s/generators/uptime<dot>lisp file
File, Lisp, cari3s/generators/weather.lisp: The cari3s/generators/weather<dot>lisp file
File, Lisp, cari3s/package.lisp: The cari3s/package<dot>lisp file
File, Lisp, cari3s/protocol.lisp: The cari3s/protocol<dot>lisp file
File, Lisp, cari3s/status-bar.lisp: The cari3s/status-bar<dot>lisp file
File, Lisp, cari3s/toolkit.lisp: The cari3s/toolkit<dot>lisp file
File, Lisp, cari3s/toplevel.lisp: The cari3s/toplevel<dot>lisp file

L
Lisp File, cari3s.asd: The cari3s<dot>asd file
Lisp File, cari3s/documentation.lisp: The cari3s/documentation<dot>lisp file
Lisp File, cari3s/event.lisp: The cari3s/event<dot>lisp file
Lisp File, cari3s/generators.lisp: The cari3s/generators<dot>lisp file
Lisp File, cari3s/generators/battery.lisp: The cari3s/generators/battery<dot>lisp file
Lisp File, cari3s/generators/clock.lisp: The cari3s/generators/clock<dot>lisp file
Lisp File, cari3s/generators/cpu-usage.lisp: The cari3s/generators/cpu-usage<dot>lisp file
Lisp File, cari3s/generators/disk-usage.lisp: The cari3s/generators/disk-usage<dot>lisp file
Lisp File, cari3s/generators/io-usage.lisp: The cari3s/generators/io-usage<dot>lisp file
Lisp File, cari3s/generators/mem-usage.lisp: The cari3s/generators/mem-usage<dot>lisp file
Lisp File, cari3s/generators/network-ip.lisp: The cari3s/generators/network-ip<dot>lisp file
Lisp File, cari3s/generators/uptime.lisp: The cari3s/generators/uptime<dot>lisp file
Lisp File, cari3s/generators/weather.lisp: The cari3s/generators/weather<dot>lisp file
Lisp File, cari3s/package.lisp: The cari3s/package<dot>lisp file
Lisp File, cari3s/protocol.lisp: The cari3s/protocol<dot>lisp file
Lisp File, cari3s/status-bar.lisp: The cari3s/status-bar<dot>lisp file
Lisp File, cari3s/toolkit.lisp: The cari3s/toolkit<dot>lisp file
Lisp File, cari3s/toplevel.lisp: The cari3s/toplevel<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   I   L   M   N   O   P   R   S   T   U   V   W  
Index Entry  Section

%
%serialize-object: Internal functions

(
(setf align): Exported generic functions
(setf align): Exported generic functions
(setf api-key): Internal generic functions
(setf api-key): Internal generic functions
(setf background): Exported generic functions
(setf background): Exported generic functions
(setf battery-name): Internal generic functions
(setf battery-name): Internal generic functions
(setf blocks): Internal generic functions
(setf blocks): Internal generic functions
(setf border): Exported generic functions
(setf border): Exported generic functions
(setf click-pause): Exported generic functions
(setf click-pause): Exported generic functions
(setf connections): Exported generic functions
(setf connections): Exported generic functions
(setf continue-signal): Exported generic functions
(setf continue-signal): Exported generic functions
(setf device): Internal generic functions
(setf device): Internal generic functions
(setf device): Internal generic functions
(setf device): Internal generic functions
(setf direction): Internal generic functions
(setf direction): Internal generic functions
(setf foreground): Exported generic functions
(setf foreground): Exported generic functions
(setf generators): Exported generic functions
(setf generators): Exported generic functions
(setf ifaddrs-address): Internal functions
(setf ifaddrs-broadcast/destination-address): Internal functions
(setf ifaddrs-data): Internal functions
(setf ifaddrs-flags): Internal functions
(setf ifaddrs-name): Internal functions
(setf ifaddrs-netmask): Internal functions
(setf ifaddrs-next): Internal functions
(setf include-cache): Internal generic functions
(setf include-cache): Internal generic functions
(setf include-swap): Internal generic functions
(setf include-swap): Internal generic functions
(setf input): Exported generic functions
(setf input): Exported generic functions
(setf instance): Exported generic functions
(setf instance): Exported generic functions
(setf interval): Exported generic functions
(setf interval): Exported generic functions
(setf interval): Exported generic functions
(setf last-generation): Internal generic functions
(setf last-generation): Internal generic functions
(setf listener): Exported generic functions
(setf listener): Exported generic functions
(setf location): Exported generic functions
(setf location): Exported generic functions
(setf markup): Exported generic functions
(setf markup): Exported generic functions
(setf min-width): Exported generic functions
(setf min-width): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf next-time): Exported generic functions
(setf next-time): Exported generic functions
(setf output): Exported generic functions
(setf output): Exported generic functions
(setf previous-idle): Internal generic functions
(setf previous-idle): Internal generic functions
(setf previous-time): Internal generic functions
(setf previous-time): Internal generic functions
(setf previous-time): Internal generic functions
(setf previous-value): Internal generic functions
(setf previous-value): Internal generic functions
(setf send-click-events-p): Exported generic functions
(setf send-click-events-p): Exported generic functions
(setf separator): Exported generic functions
(setf separator): Exported generic functions
(setf short-markup): Exported generic functions
(setf short-markup): Exported generic functions
(setf short-text): Exported generic functions
(setf short-text): Exported generic functions
(setf sockaddr-data): Internal functions
(setf sockaddr-family): Internal functions
(setf stop-signal): Exported generic functions
(setf stop-signal): Exported generic functions
(setf text): Exported generic functions
(setf text): Exported generic functions
(setf urgent-p): Exported generic functions
(setf urgent-p): Exported generic functions
(setf value): Internal generic functions
(setf value): Internal generic functions
(setf version): Exported generic functions
(setf version): Exported generic functions

A
align: Exported generic functions
align: Exported generic functions
api-key: Internal generic functions
api-key: Internal generic functions

B
background: Exported generic functions
background: Exported generic functions
battery-name: Internal generic functions
battery-name: Internal generic functions
block-size: Exported generic functions
block-size: Exported generic functions
blocks: Internal generic functions
blocks: Internal generic functions
border: Exported generic functions
border: Exported generic functions
button: Exported generic functions
button: Exported generic functions

C
click-pause: Exported generic functions
click-pause: Exported generic functions
compute-value: Exported generic functions
compute-value: Exported generic functions
compute-value: Exported generic functions
compute-value: Exported generic functions
compute-value: Exported generic functions
compute-value: Exported generic functions
compute-value: Exported generic functions
compute-value: Exported generic functions
compute-value: Exported generic functions
compute-value: Exported generic functions
connections: Exported generic functions
connections: Exported generic functions
continue-signal: Exported generic functions
continue-signal: Exported generic functions

D
day-short-name: Internal functions
device: Internal generic functions
device: Internal generic functions
device: Internal generic functions
device: Internal generic functions
direction: Internal generic functions
direction: Internal generic functions

E
eformat: Internal functions

F
foreground: Exported generic functions
foreground: Exported generic functions
format-color-string: Internal functions
freeifaddrs: Internal functions
from-table: Exported generic functions
from-table: Exported generic functions
Function, %serialize-object: Internal functions
Function, (setf ifaddrs-address): Internal functions
Function, (setf ifaddrs-broadcast/destination-address): Internal functions
Function, (setf ifaddrs-data): Internal functions
Function, (setf ifaddrs-flags): Internal functions
Function, (setf ifaddrs-name): Internal functions
Function, (setf ifaddrs-netmask): Internal functions
Function, (setf ifaddrs-next): Internal functions
Function, (setf sockaddr-data): Internal functions
Function, (setf sockaddr-family): Internal functions
Function, day-short-name: Internal functions
Function, eformat: Internal functions
Function, format-color-string: Internal functions
Function, freeifaddrs: Internal functions
Function, getifaddrs: Internal functions
Function, getnameinfo: Internal functions
Function, ifaddrs-address: Internal functions
Function, ifaddrs-broadcast/destination-address: Internal functions
Function, ifaddrs-data: Internal functions
Function, ifaddrs-flags: Internal functions
Function, ifaddrs-name: Internal functions
Function, ifaddrs-netmask: Internal functions
Function, ifaddrs-next: Internal functions
Function, load-from-file: Exported functions
Function, month-short-name: Internal functions
Function, parse-all-integers: Internal functions
Function, parse-meminfo: Internal functions
Function, run-bar: Exported functions
Function, run-bar-from-file: Exported functions
Function, sockaddr-data: Internal functions
Function, sockaddr-family: Internal functions
Function, statfs: Internal functions
Function, toplevel: Exported functions

G
generate: Exported generic functions
generate: Exported generic functions
generate: Exported generic functions
generate: Exported generic functions
generate: Exported generic functions
generators: Exported generic functions
generators: Exported generic functions
Generic Function, (setf align): Exported generic functions
Generic Function, (setf api-key): Internal generic functions
Generic Function, (setf background): Exported generic functions
Generic Function, (setf battery-name): Internal generic functions
Generic Function, (setf blocks): Internal generic functions
Generic Function, (setf border): Exported generic functions
Generic Function, (setf click-pause): Exported generic functions
Generic Function, (setf connections): Exported generic functions
Generic Function, (setf continue-signal): Exported generic functions
Generic Function, (setf device): Internal generic functions
Generic Function, (setf direction): Internal generic functions
Generic Function, (setf foreground): Exported generic functions
Generic Function, (setf generators): Exported generic functions
Generic Function, (setf include-cache): Internal generic functions
Generic Function, (setf include-swap): Internal generic functions
Generic Function, (setf input): Exported generic functions
Generic Function, (setf instance): Exported generic functions
Generic Function, (setf interval): Exported generic functions
Generic Function, (setf last-generation): Internal generic functions
Generic Function, (setf listener): Exported generic functions
Generic Function, (setf location): Exported generic functions
Generic Function, (setf markup): Exported generic functions
Generic Function, (setf min-width): Exported generic functions
Generic Function, (setf name): Exported generic functions
Generic Function, (setf next-time): Exported generic functions
Generic Function, (setf output): Exported generic functions
Generic Function, (setf previous-idle): Internal generic functions
Generic Function, (setf previous-time): Internal generic functions
Generic Function, (setf previous-value): Internal generic functions
Generic Function, (setf send-click-events-p): Exported generic functions
Generic Function, (setf separator): Exported generic functions
Generic Function, (setf short-markup): Exported generic functions
Generic Function, (setf short-text): Exported generic functions
Generic Function, (setf stop-signal): Exported generic functions
Generic Function, (setf text): Exported generic functions
Generic Function, (setf urgent-p): Exported generic functions
Generic Function, (setf value): Internal generic functions
Generic Function, (setf version): Exported generic functions
Generic Function, align: Exported generic functions
Generic Function, api-key: Internal generic functions
Generic Function, background: Exported generic functions
Generic Function, battery-name: Internal generic functions
Generic Function, block-size: Exported generic functions
Generic Function, blocks: Internal generic functions
Generic Function, border: Exported generic functions
Generic Function, button: Exported generic functions
Generic Function, click-pause: Exported generic functions
Generic Function, compute-value: Exported generic functions
Generic Function, connections: Exported generic functions
Generic Function, continue-signal: Exported generic functions
Generic Function, device: Internal generic functions
Generic Function, direction: Internal generic functions
Generic Function, foreground: Exported generic functions
Generic Function, from-table: Exported generic functions
Generic Function, generate: Exported generic functions
Generic Function, generators: Exported generic functions
Generic Function, include-cache: Internal generic functions
Generic Function, include-swap: Internal generic functions
Generic Function, input: Exported generic functions
Generic Function, instance: Exported generic functions
Generic Function, interval: Exported generic functions
Generic Function, last-generation: Internal generic functions
Generic Function, listener: Exported generic functions
Generic Function, location: Exported generic functions
Generic Function, markup: Exported generic functions
Generic Function, message: Exported generic functions
Generic Function, min-width: Exported generic functions
Generic Function, name: Exported generic functions
Generic Function, next-time: Exported generic functions
Generic Function, object-initargs: Exported generic functions
Generic Function, output: Exported generic functions
Generic Function, parse-event-or-lose: Exported generic functions
Generic Function, port: Exported generic functions
Generic Function, previous-idle: Internal generic functions
Generic Function, previous-time: Internal generic functions
Generic Function, previous-value: Internal generic functions
Generic Function, process: Exported generic functions
Generic Function, process-connections: Exported generic functions
Generic Function, process-event: Exported generic functions
Generic Function, process-inputs: Internal generic functions
Generic Function, produce-output: Exported generic functions
Generic Function, relative-location: Exported generic functions
Generic Function, send-click-events-p: Exported generic functions
Generic Function, separator: Exported generic functions
Generic Function, serialize-object: Exported generic functions
Generic Function, short-markup: Exported generic functions
Generic Function, short-text: Exported generic functions
Generic Function, start: Exported generic functions
Generic Function, stop: Exported generic functions
Generic Function, stop-signal: Exported generic functions
Generic Function, text: Exported generic functions
Generic Function, text-format: Exported generic functions
Generic Function, to-table: Exported generic functions
Generic Function, urgent-p: Exported generic functions
Generic Function, value: Internal generic functions
Generic Function, version: Exported generic functions
getifaddrs: Internal functions
getnameinfo: Internal functions

I
ifaddrs-address: Internal functions
ifaddrs-broadcast/destination-address: Internal functions
ifaddrs-data: Internal functions
ifaddrs-flags: Internal functions
ifaddrs-name: Internal functions
ifaddrs-netmask: Internal functions
ifaddrs-next: Internal functions
include-cache: Internal generic functions
include-cache: Internal generic functions
include-swap: Internal generic functions
include-swap: Internal generic functions
input: Exported generic functions
input: Exported generic functions
instance: Exported generic functions
instance: Exported generic functions
instance: Exported generic functions
interval: Exported generic functions
interval: Exported generic functions
interval: Exported generic functions

L
last-generation: Internal generic functions
last-generation: Internal generic functions
listener: Exported generic functions
listener: Exported generic functions
load-from-file: Exported functions
location: Exported generic functions
location: Exported generic functions
location: Exported generic functions

M
Macro, with-input-ready: Internal macros
markup: Exported generic functions
markup: Exported generic functions
message: Exported generic functions
message: Exported generic functions
Method, (setf align): Exported generic functions
Method, (setf api-key): Internal generic functions
Method, (setf background): Exported generic functions
Method, (setf battery-name): Internal generic functions
Method, (setf blocks): Internal generic functions
Method, (setf border): Exported generic functions
Method, (setf click-pause): Exported generic functions
Method, (setf connections): Exported generic functions
Method, (setf continue-signal): Exported generic functions
Method, (setf device): Internal generic functions
Method, (setf device): Internal generic functions
Method, (setf device): Internal generic functions
Method, (setf direction): Internal generic functions
Method, (setf foreground): Exported generic functions
Method, (setf generators): Exported generic functions
Method, (setf include-cache): Internal generic functions
Method, (setf include-swap): Internal generic functions
Method, (setf input): Exported generic functions
Method, (setf instance): Exported generic functions
Method, (setf interval): Exported generic functions
Method, (setf interval): Exported generic functions
Method, (setf last-generation): Internal generic functions
Method, (setf listener): Exported generic functions
Method, (setf location): Exported generic functions
Method, (setf markup): Exported generic functions
Method, (setf min-width): Exported generic functions
Method, (setf name): Exported generic functions
Method, (setf next-time): Exported generic functions
Method, (setf output): Exported generic functions
Method, (setf previous-idle): Internal generic functions
Method, (setf previous-time): Internal generic functions
Method, (setf previous-time): Internal generic functions
Method, (setf previous-value): Internal generic functions
Method, (setf send-click-events-p): Exported generic functions
Method, (setf separator): Exported generic functions
Method, (setf short-markup): Exported generic functions
Method, (setf short-text): Exported generic functions
Method, (setf stop-signal): Exported generic functions
Method, (setf text): Exported generic functions
Method, (setf urgent-p): Exported generic functions
Method, (setf value): Internal generic functions
Method, (setf version): Exported generic functions
Method, align: Exported generic functions
Method, api-key: Internal generic functions
Method, background: Exported generic functions
Method, battery-name: Internal generic functions
Method, block-size: Exported generic functions
Method, blocks: Internal generic functions
Method, border: Exported generic functions
Method, button: Exported generic functions
Method, click-pause: Exported generic functions
Method, compute-value: Exported generic functions
Method, compute-value: Exported generic functions
Method, compute-value: Exported generic functions
Method, compute-value: Exported generic functions
Method, compute-value: Exported generic functions
Method, compute-value: Exported generic functions
Method, compute-value: Exported generic functions
Method, compute-value: Exported generic functions
Method, compute-value: Exported generic functions
Method, connections: Exported generic functions
Method, continue-signal: Exported generic functions
Method, device: Internal generic functions
Method, device: Internal generic functions
Method, device: Internal generic functions
Method, direction: Internal generic functions
Method, foreground: Exported generic functions
Method, from-table: Exported generic functions
Method, generate: Exported generic functions
Method, generate: Exported generic functions
Method, generate: Exported generic functions
Method, generate: Exported generic functions
Method, generators: Exported generic functions
Method, include-cache: Internal generic functions
Method, include-swap: Internal generic functions
Method, input: Exported generic functions
Method, instance: Exported generic functions
Method, instance: Exported generic functions
Method, interval: Exported generic functions
Method, interval: Exported generic functions
Method, last-generation: Internal generic functions
Method, listener: Exported generic functions
Method, location: Exported generic functions
Method, location: Exported generic functions
Method, markup: Exported generic functions
Method, message: Exported generic functions
Method, min-width: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, next-time: Exported generic functions
Method, object-initargs: Exported generic functions
Method, output: Exported generic functions
Method, parse-event-or-lose: Exported generic functions
Method, parse-event-or-lose: Exported generic functions
Method, port: Exported generic functions
Method, previous-idle: Internal generic functions
Method, previous-time: Internal generic functions
Method, previous-time: Internal generic functions
Method, previous-value: Internal generic functions
Method, process: Exported generic functions
Method, process-connections: Exported generic functions
Method, process-event: Exported generic functions
Method, process-event: Exported generic functions
Method, process-event: Exported generic functions
Method, process-event: Exported generic functions
Method, process-inputs: Internal generic functions
Method, produce-output: Exported generic functions
Method, relative-location: Exported generic functions
Method, send-click-events-p: Exported generic functions
Method, separator: Exported generic functions
Method, serialize-object: Exported generic functions
Method, serialize-object: Exported generic functions
Method, serialize-object: Exported generic functions
Method, serialize-object: Exported generic functions
Method, serialize-object: Exported generic functions
Method, serialize-object: Exported generic functions
Method, serialize-object: Exported generic functions
Method, serialize-object: Exported generic functions
Method, serialize-object: Exported generic functions
Method, short-markup: Exported generic functions
Method, short-text: Exported generic functions
Method, short-text: Exported generic functions
Method, short-text: Exported generic functions
Method, start: Exported generic functions
Method, stop: Exported generic functions
Method, stop-signal: Exported generic functions
Method, text: Exported generic functions
Method, text: Exported generic functions
Method, text: Exported generic functions
Method, text-format: Exported generic functions
Method, text-format: Exported generic functions
Method, to-table: Exported generic functions
Method, to-table: Exported generic functions
Method, urgent-p: Exported generic functions
Method, value: Internal generic functions
Method, version: Exported generic functions
min-width: Exported generic functions
min-width: Exported generic functions
month-short-name: Internal functions

N
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
next-time: Exported generic functions
next-time: Exported generic functions

O
object-initargs: Exported generic functions
object-initargs: Exported generic functions
output: Exported generic functions
output: Exported generic functions

P
parse-all-integers: Internal functions
parse-event-or-lose: Exported generic functions
parse-event-or-lose: Exported generic functions
parse-event-or-lose: Exported generic functions
parse-meminfo: Internal functions
port: Exported generic functions
port: Exported generic functions
previous-idle: Internal generic functions
previous-idle: Internal generic functions
previous-time: Internal generic functions
previous-time: Internal generic functions
previous-time: Internal generic functions
previous-value: Internal generic functions
previous-value: Internal generic functions
process: Exported generic functions
process: Exported generic functions
process-connections: Exported generic functions
process-connections: Exported generic functions
process-event: Exported generic functions
process-event: Exported generic functions
process-event: Exported generic functions
process-event: Exported generic functions
process-event: Exported generic functions
process-inputs: Internal generic functions
process-inputs: Internal generic functions
produce-output: Exported generic functions
produce-output: Exported generic functions

R
relative-location: Exported generic functions
relative-location: Exported generic functions
run-bar: Exported functions
run-bar-from-file: Exported functions

S
send-click-events-p: Exported generic functions
send-click-events-p: Exported generic functions
separator: Exported generic functions
separator: Exported generic functions
serialize-object: Exported generic functions
serialize-object: Exported generic functions
serialize-object: Exported generic functions
serialize-object: Exported generic functions
serialize-object: Exported generic functions
serialize-object: Exported generic functions
serialize-object: Exported generic functions
serialize-object: Exported generic functions
serialize-object: Exported generic functions
serialize-object: Exported generic functions
short-markup: Exported generic functions
short-markup: Exported generic functions
short-text: Exported generic functions
short-text: Exported generic functions
short-text: Exported generic functions
short-text: Exported generic functions
sockaddr-data: Internal functions
sockaddr-family: Internal functions
start: Exported generic functions
start: Exported generic functions
statfs: Internal functions
stop: Exported generic functions
stop: Exported generic functions
stop-signal: Exported generic functions
stop-signal: Exported generic functions

T
text: Exported generic functions
text: Exported generic functions
text: Exported generic functions
text: Exported generic functions
text-format: Exported generic functions
text-format: Exported generic functions
text-format: Exported generic functions
to-table: Exported generic functions
to-table: Exported generic functions
to-table: Exported generic functions
toplevel: Exported functions

U
urgent-p: Exported generic functions
urgent-p: Exported generic functions

V
value: Internal generic functions
value: Internal generic functions
version: Exported generic functions
version: Exported generic functions

W
with-input-ready: Internal macros

Jump to:   %   (  
A   B   C   D   E   F   G   I   L   M   N   O   P   R   S   T   U   V   W  

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

A.3 Variables

Jump to:   *  
A   B   C   D   F   G   I   L   M   N   O   P   R   S   T   U   V  
Index Entry  Section

*
*weather-api*: Internal special variables

A
align: Exported classes
api-key: Exported classes

B
background: Exported classes
battery-name: Exported classes
block-size: Exported classes
blocks: Exported classes
border: Exported classes
button: Exported classes

C
click-pause: Exported classes
connections: Exported classes
Constant, ni-maxhost: Internal constants
Constant, ni-numerichost: Internal constants
continue-signal: Exported classes

D
device: Exported classes
device: Exported classes
device: Exported classes
direction: Exported classes

F
foreground: Exported classes

G
generators: Exported classes

I
include-cache: Exported classes
include-swap: Exported classes
input: Exported classes
instance: Exported classes
instance: Exported classes
interval: Exported classes
interval: Exported classes

L
last-generation: Exported classes
listener: Exported classes
location: Exported classes
location: Exported classes

M
markup: Exported classes
message: Exported classes
min-width: Exported classes

N
name: Exported classes
name: Exported classes
next-time: Exported classes
ni-maxhost: Internal constants
ni-numerichost: Internal constants

O
output: Exported classes

P
port: Exported classes
previous-idle: Exported classes
previous-time: Exported classes
previous-time: Exported classes
previous-value: Exported classes

R
relative-location: Exported classes

S
send-click-events-p: Exported classes
separator: Exported classes
short-markup: Exported classes
short-text: Exported classes
Slot, align: Exported classes
Slot, api-key: Exported classes
Slot, background: Exported classes
Slot, battery-name: Exported classes
Slot, block-size: Exported classes
Slot, blocks: Exported classes
Slot, border: Exported classes
Slot, button: Exported classes
Slot, click-pause: Exported classes
Slot, connections: Exported classes
Slot, continue-signal: Exported classes
Slot, device: Exported classes
Slot, device: Exported classes
Slot, device: Exported classes
Slot, direction: Exported classes
Slot, foreground: Exported classes
Slot, generators: Exported classes
Slot, include-cache: Exported classes
Slot, include-swap: Exported classes
Slot, input: Exported classes
Slot, instance: Exported classes
Slot, instance: Exported classes
Slot, interval: Exported classes
Slot, interval: Exported classes
Slot, last-generation: Exported classes
Slot, listener: Exported classes
Slot, location: Exported classes
Slot, location: Exported classes
Slot, markup: Exported classes
Slot, message: Exported classes
Slot, min-width: Exported classes
Slot, name: Exported classes
Slot, name: Exported classes
Slot, next-time: Exported classes
Slot, output: Exported classes
Slot, port: Exported classes
Slot, previous-idle: Exported classes
Slot, previous-time: Exported classes
Slot, previous-time: Exported classes
Slot, previous-value: Exported classes
Slot, relative-location: Exported classes
Slot, send-click-events-p: Exported classes
Slot, separator: Exported classes
Slot, short-markup: Exported classes
Slot, short-text: Exported classes
Slot, stop-signal: Exported classes
Slot, text: Exported classes
Slot, urgent-p: Exported classes
Slot, value: Exported classes
Slot, version: Exported classes
Special Variable, *weather-api*: Internal special variables
stop-signal: Exported classes

T
text: Exported classes

U
urgent-p: Exported classes

V
value: Exported classes
version: Exported classes

Jump to:   *  
A   B   C   D   F   G   I   L   M   N   O   P   R   S   T   U   V  

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

A.4 Data types

Jump to:   B   C   D   E   F   G   H   I   M   N   P   S   U   V   W  
Index Entry  Section

B
battery: Exported classes
block: Exported classes

C
cari3s: The cari3s system
cari3s: The cari3s package
Class, battery: Exported classes
Class, block: Exported classes
Class, click: Exported classes
Class, clock: Exported classes
Class, cpu-usage: Exported classes
Class, disk-usage: Exported classes
Class, echo: Exported classes
Class, event: Exported classes
Class, event-server: Exported classes
Class, file-system-id-tclass: Internal classes
Class, file-system-tclass: Internal classes
Class, generate: Exported classes
Class, generator: Exported classes
Class, header: Exported classes
Class, ifaddrs-tclass: Internal classes
Class, io-usage: Exported classes
Class, mem-usage: Exported classes
Class, network-ip: Exported classes
Class, pango-block: Exported classes
Class, single-generator: Exported classes
Class, sockaddr-tclass: Internal classes
Class, status-bar: Exported classes
Class, uptime: Exported classes
Class, value-generator: Exported classes
Class, weather: Exported classes
click: Exported classes
clock: Exported classes
cpu-usage: Exported classes

D
disk-usage: Exported classes

E
echo: Exported classes
event: Exported classes
event-server: Exported classes

F
file-system-id-tclass: Internal classes
file-system-tclass: Internal classes

G
generate: Exported classes
generator: Exported classes

H
header: Exported classes

I
ifaddrs-tclass: Internal classes
io-usage: Exported classes

M
mem-usage: Exported classes

N
network-ip: Exported classes

P
Package, cari3s: The cari3s package
pango-block: Exported classes

S
single-generator: Exported classes
sockaddr-tclass: Internal classes
status-bar: Exported classes
System, cari3s: The cari3s system

U
uptime: Exported classes

V
value-generator: Exported classes

W
weather: Exported classes

Jump to:   B   C   D   E   F   G   H   I   M   N   P   S   U   V   W