Added lispkitc shell script to shortcut compiling.

Added install targets to makefile.
Update the docs to include lispkitc info.

Author: carld

.gitignore

@@ -0,0 +1,3 @@
+*.o
+*.gcda
+*.gcno

Makefile

@@ -2,6 +2,9 @@
 
 SOURCE_ID  := $(shell date +%Y%m%d)
 
+PREFIX  = /usr/local
+MANDIR  = $(PREFIX)/share/man
+
 CC      = gcc
 CFLAGS += -Wall
 CFLAGS += -pedantic
@@ -24,6 +27,9 @@ OBJ     = $(SRC:.c=.o)
 
 BIN     = lispkit
 
+COMPILER_SRC = lispkit-compiler.lks
+COMPILER_BIN = lispkit-compiler.bin
+
 all: $(BIN)
 
 .c.o:
@@ -33,8 +39,31 @@ $(BIN): $(OBJ)
 	$(CC) -o $@ $^  $(LDFLAGS)
 	@size $(BIN)
 
+install: $(BIN) $(BIN)c
+	install -v $(BIN) $(PREFIX)/bin
+	install -v $(BIN)c $(PREFIX)/bin
+	install -v -d $(MANDIR)/man1
+	install -v -m 0644 lispkit.1 $(MANDIR)/man1
+	install -v -d $(PREFIX)/share/lispkit
+	install -v $(COMPILER_SRC) $(PREFIX)/share/lispkit
+	install -v $(COMPILER_BIN) $(PREFIX)/share/lispkit
+
+$(BIN)c: $(BIN)c.in
+	sed "s|COMPILER=|COMPILER=$(PREFIX)/share/lispkit/lispkit-compiler.bin|" lispkitc.in > $@
+
+uninstall:
+	rm -vf $(PREFIX)/bin/$(BIN)
+	rm -vf $(PREFIX)/bin/$(BIN)c
+	rm -vr $(MANDIR)/man1/lispkit.1
+	rm -vf $(PREFIX)/share/lispkit/$(COMPILER_SRC)
+	rm -vf $(PREFIX)/share/lispkit/$(COMPILER_BIN)
+	rm -vr $(PREFIX)/share/lispkit
+
+help:
+	groff -man -Tascii lispkit.1 | less -R
+
 %.o: %.lisp
-	./$(BIN) compiler.ascii $< | tee $@
+	./$(BIN) $(COMPILER_BIN) $< | tee $@
 
 clean:
 	rm -f $(OBJ) $(BIN) *.gcda *.gcno *.gcov *.o examples/*.o
@@ -43,18 +72,18 @@ test: $(BIN)
 	./test.sh
 
 examples:
-	for d in `ls examples/*.lisp`; do \
-	  ./$(BIN) compiler.ascii $$d > $$d.o; \
+	for d in $(shell ls examples/*.lisp); do \
+	  ./$(BIN) $(COMPILER_BIN) $$d > $$d.o; \
 	done;
 
 bootstrap:
-	./$(BIN) compiler.ascii compiler.txt.ascii > .compiler.out.tmp
-	cat compiler.ascii | tr '\n' ' ' > .compiler.orig.tmp
+	./$(BIN) $(COMPILER_BIN) $(COMPILER_SRC) > .compiler.out.tmp
+	cat $(COMPILER_BIN) | tr '\n' ' ' > .compiler.orig.tmp
 	diff -w .compiler.orig.tmp .compiler.out.tmp
 	rm .compiler.out.tmp .compiler.orig.tmp
 
 archive:
 	git archive --prefix=lispkit-$(SOURCE_ID)/ HEAD | gzip > lispkit-$(SOURCE_ID).tar.gz
 
-.PHONY: clean all test archive examples
+.PHONY: clean all test archive examples bootstrap
 

README

@@ -13,22 +13,43 @@ attempt some of the examples from table 12.1 and 12.2 in the book.
 
   make test
 
-To compile a lispkit program, where [filename] is the name of 
-a file containing lispkit source code:
 
-  ./lispkit compiler.ascii [filename]
+INSTALLATION
+------------
 
-To compile one of the examples, examples/square.lisp:
+To install lispkit to your system:
 
-  make examples/square.o
+  [sudo] make install
 
-You should see some output like:
+To remove lispkit:
 
-  ( 3 ( 1 ( 0 . 0 ) 1 ( 0 . 0 ) 17 5 ) 4 21 )
+  [sudo] make uninstall
+
+
+USING
+-----
+
+To compile a lispkit program, use the lispkitc script:
+
+  lispkitc infile [outfile]
+
+
+For example:
+
+  lispkitc examples/square.lisp square.bin
+
+
+To run a lispkit program:
+
+  lispkit program [argument]
+
+
+If no argument file is given, lispkit will read from stdin.
+
+
+For example:
+
+  echo 16 | lispkit square.bin
 
-Then run it, with no second argument lispkit will read the input
-from stdin.
 
-  echo 5 | ./lispkit examples/square.o
-  25
 

compiler.ascii renamed to lispkit-compiler.bin

@@ -1,29 +1,49 @@
 .\" groff -man -Tascii lispkit.1 | less
 .TH lispkit 1 
 .SH "NAME"
-Lispkit \- a functional programming language similar to Lisp
+lispkit \- functional programming language interpreter
+.br
+lispkitc \- lispkit compiler script
 .SH "SYNOPSIS"
 .B lispkit 
-.I function-file
+.I program
 [
-.I arguments-file
+.I argument
+]
+.br
+.B lispkitc
+.I infile
+[
+.I outfile
 ]
 .SH "OPTIONS"
-.IP function-file
+.IP program
 A file containing lispkit machine code.
-.IP argument-file 
+.IP argument
 A file containing lispkit arguments. 
-If not present, arguments can be entered through stdin.
+If absent will read arguments from stdin.
+.IP infile
+A lispkit source file.
+.IP outfile
+A compiled lispkit program.
+If absent will write program to stdout.
+.SH "DESCRIPTION"
+Lispkit is a SECD based machine for interpreting 
+programs made up of symbolic expressions
+and simple functions such as cons, car, cdr, 
+similar to Lisp.
 .SH "FILES"
-.IP compiler
+.IP lispkit-compiler.bin
 Lispkit compiler in machine code form
-.IP compiler
+.IP lispkit-compiler.lks
 Lispkit compiler in source code form
 .SH "ENVIRONMENT"
 .B LISPKIT_MEMORY
+Maximum number of object cells that Lispkit will allocate.
 .SH "AUTHOR"
 This program is based on the Lispkit described in
 "Functional Programming Application and Implementation", 
 by Peter Henderson (ISBN 0-13-331579-7).
-This Lispkit and man page by A. Carl Douglas (carl.douglas@gmail.com).
+This Lispkit and man page by 
+A. Carl Douglas (carl.douglas@gmail.com).
 

compiler.txt.ascii renamed to lispkit-compiler.lks

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+COMPILER=
+
+LISPKIT=$(which lispkit)
+
+if [[ $# == 0 ]]; then
+  echo lispkitc infile [outfile];
+  exit 0
+fi
+
+if [[ $LISPKIT == '' ]]; then
+  LISPKIT=./lispkit
+fi
+
+if [[ $2 != '' ]]; then
+  $LISPKIT $COMPILER $1 > $2
+else
+  $LISPKIT $COMPILER $1
+fi
+