stklos.1.in 4.34 KB
Newer Older
eg's avatar
eg committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
.\" -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH STKLOS 1 "version @VERSION@"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
19 20 21 22 23
stklos \- An efficient Scheme System providing a powerful Object
System

.SH SYNOPSYS
\fbstklos\fR [OPTION ...] [ARGUMENT ... ]
eg's avatar
eg committed
24 25 26 27 28

.SH DESCRIPTION
.B STklos
is a free Scheme System (nearly) conform to R5RS. The aim of this
implementation is to be fast as well as light. The implementation is
29 30 31
based on an ad-hoc Virtual Machine.
.B STklos
can also be compiled as a library, so that one can easily embed it
eg's avatar
eg committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
in an application.
.LP
The salient points of STklos are:
.IP "" 4
- efficient and powerful object system based on CLOS providing:
.IP "" 8
+ Multiple Inheritance,
.IP "" 8
+ Generic Functions,
.IP "" 8
+ Multi-methods
.IP "" 8
+ an efficient MOP (Meta Object Protocol)
.IP "" 4
- a simple to use module system
.IP "" 4
- implemanents the full tower of numbers defined in R5RS
.IP "" 4
- easy connection to the GTK+ toolkit
.IP "" 4
- Perl compatible regular expressions thanks to the PCRE package.
.IP "" 4
- tail recursive calls are properly implemented

.SH OPTIONS
57
Here are the options available in the version @VERSION@ of
eg's avatar
eg committed
58 59 60 61 62 63 64 65 66 67
.B stklos.

.IP "-l file, --load=file"
load 'file' before going interactive
.IP "-f file, --file=file"
use 'file' as program
.IP "-e sexpr, --execute=sexpr"
evaluate the given sexpr and exit
.IP "-b file, --boot-file=file"
use 'file' to boot the system instead of the default one
68 69 70 71 72
.IP "-D directory, --conf-dir=directory"
use the given directory to store the various configuration files. This
directory is also used to store the packages installed with the
\fIstklos-pkg(1)\fR command. Note that the shell variable
\fISTKLOS_CONFDIR\fR can also be used to set this directory (see below).
eg's avatar
eg committed
73 74
.IP "-q, --no-init-file"
quiet: do not load the user init file
75 76 77 78
.IP "-i, --interactive"
be interactive, even if the command finds it is not the case. This
option is generally useful when used inside emacs since it permits to
display the REPL prompts.
Erick's avatar
Erick committed
79 80
.IP "-n, --no-line-editor"
tell the REPL to not use the line editor even if GNU readline or BSD
81
libedit libraries are found. This permit to use an external tool such
Erick's avatar
Erick committed
82
as rlwrap(1) instead of the internal line editor support.
83 84
.IP "-d, --debug"
insert informations to ease debugging (e.g, line numbers, signaling
Erick's avatar
Erick committed
85 86
usage of undefined symbols, ...). Can be used multiple times to
increase the debugging level;
87 88 89 90 91
.IP "-s, --stack-size=n"
use a stack of \fBn\fR cells.
.IP "-c, --case-sensitive"
be case sensitive. The default is to be case insensitive as specified
by R5RS.
92 93
.IP "-u yes|no, --utf8-encoding=yes|no"
use UTF-8 encoding for representing strings. The default for this option is "yes".
eg's avatar
eg committed
94 95 96 97
.IP "-v, --version"
print program version and exit
.IP "-h, --help"
print this help and exit
98 99
.IP "--"
This special option signals the end of the \fBstklos\fR command. The
100
arguments placed after this option are taken program arguments,
101 102
even if they start with a "-" character.

103
.SH ENVIRONMENT VARIABLES
eg's avatar
eg committed
104 105 106 107 108 109 110 111 112 113 114

.IP "STKLOS_LOAD_PATH"
This is a colon-separated list of directories in which \fBstklos\fR
looks for loading files. It is used by functions such as \fBload\fR
or \fBtry-load\fR.

.IP "STKLOS_FRAMES"
This variable must contains an integer which indicates the number of
frames printed on an error. Use the value \fB0\fR for an unlimited
back-trace.

115
.IP "STKLOS_CONFDIR"
116 117
This variable can be used to designate the directory used by \fBstklos\fR
to store its configuration or packages files. It not set, the default
118 119 120 121
\fBstklos\fR configuration directory is by default \fB~/.stklos\fR.

.SH FILES

122
.IP "~/<stklos-conf-dir>/stklosrc"
123 124 125
This file is the user init file which is loaded when \fBstklos\fR
starts. Use the \fB-q\fR to avoid the loading of this file.

eg's avatar
eg committed
126 127 128

.SH "SEE ALSO"
.BR stklos-config (1),
129 130
.BR stklos-compile (1),
.BR stklos-pkg (1)
eg's avatar
eg committed
131 132

.LP
133
The full documentation for
eg's avatar
eg committed
134 135
.B stkos
is available at http://www.stklos.net/documentation.html