commit 07cfa1f093081a9c22ec69cc66e0179ef2f7257e
parent 4b83c7661dcba75e5151d5db4b6cfd55588ead9c
Author: Alexander Burger <abu@software-lab.de>
Date: Tue, 8 Mar 2011 11:28:04 +0100
Created man pages
Diffstat:
3 files changed, 84 insertions(+), 0 deletions(-)
diff --git a/CHANGES b/CHANGES
@@ -1,4 +1,5 @@
* XXmar11 picoLisp-3.0.6
+ man pages for 'picolisp' and 'pil'
'version' also for 32-bit
Map/apply support for FEXPRs
Bug in vararg method calls (64-bit)
diff --git a/man/man1/picolisp.1 b/man/man1/picolisp.1
@@ -0,0 +1,82 @@
+.\" 08mar11abu
+.\"
+.TH PICOLISP 1 "" "" "User Commands"
+.SH NAME
+pil, picolisp \- a fast, lightweight Lisp interpreter
+.SH SYNOPSIS
+.B pil
+[arguments ..] [-] [arguments ..] [+]
+.br
+.B /installpath/bin/picolisp
+[arguments ..] [-] [arguments ..] [+]
+.SH DESCRIPTION
+.B PicoLisp
+is a Lisp interpreter with a small memory footprint, yet relatively high
+execution speed. It combines an elegant and powerful language with built-in
+database functionality.
+.P
+.B pil
+is the startup front-end for the interpreter. It takes care of starting the
+binary base system and loading a useful runtime environment.
+.P
+.B picolisp
+is just the bare interpreter binary. It is usually called in stand-alone
+scripts, by using the she-bang notation in the first line, passing the minimal
+environment in
+.I lib.l
+and loading additional files as needed:
+.P
+.RS
+#!/usr/bin/picolisp /usr/lib/picolisp/lib.l
+.RE
+.RS
+(load "@ext.l" "myfiles/lib.l" "myfiles/foo.l")
+.RE
+.SH INVOCATION
+.B PicoLisp
+has no pre-defined command line flags; any application is free to defined its
+own. Any built-in or user-level Lisp function can be invoked from the command
+line by prefixing it with a hyphen. Examples for built-in functions useful in
+this context are
+.B version
+(prints the version number) or
+.B bye
+(exit the interpreter). Therefore, a minimal call to print the version number
+and then immediately exit the interpreter would be:
+.P
+.RS
+pil -version -bye
+.RE
+.P
+Any other argument (not starting with a hyphen) should be the name of a file to
+be loaded. If the first character of a path or file name is an at-mark, it
+will be substituted by the path to the installation directory.
+.P
+All arguments are evaluated from left to right, then an interactive
+.I read-eval-print
+loop is entered (with a colon as prompt).
+.P
+A single hyphen stops the evaluation of the rest of the command line, so that
+the remaining arguments may be processed under program control.
+.P
+If the very last command line argument is a single plus character, debugging
+mode is switched on at interpreter startup, before evaluating any of the command
+line arguments. A minimal interactive session is therefore started as:
+.P
+.RS
+pil +
+.RE
+.P
+The interpreter can be terminated by typing Ctrl-D or (bye).
+.SH BUGS
+.B PicoLisp
+doesn't try to protect you from all programming errors, like other interpreters
+do ("You asked for it, you got it").
+.SH AUTHOR
+Alexander Burger <abu@software-lab.de>
+.SH RESOURCES
+.B Home page:
+http://home.picolisp.com
+.br
+.B Download:
+http://www.software-lab.de/down.html
diff --git a/man/man1/pil.1 b/man/man1/pil.1
@@ -0,0 +1 @@
+.so man1/picolisp.1
