Initial commit of newLISP.
[newlisp.git] / doc / FILES
blob6866c325bab6329f11b00e794d12b5844d7ff0a4
1 LIST OF FILES IN DISTRIBUTION in newLISP version 9.0
2 ----------------------------------------------------
4 doc/             documentation directory
6 COPYING          text of GNU GPL, also conatined in the manual
7 CREDITS          people who helped developing or documenting newLISP
8 INSTALL          install procedure
9 LOCALIZATION     how to localize newLISP builds
10 TRUE64BUILD      comments on building for the true64 CPU flavor
11 newlisp.1        man page for LINUX/BSD/UNIX
12 newlispdoc.1     man page for newlispdoc
14 manual_frame.html         for viewing the manual in a frame with index
15 newlisp_manual.html       newLISP for LINUX, Users manual and Reference
16 newlisp-index.html        index for frame viewing of manual
17 newLISPdoc.html           documentation for newlispdoc utility
18 newLISP-9.2-Release.html  release notes for mayor release 
20 CodePatterns.html      frequently used patterns in newLISP programming
21 MemoryManagement.html  how newLISP manages memory
24 util/          various utility files
26 http-conf.lsp  configuration file for newLISP HTTP server mode
27 link.lsp       for 'linking' a source file together with a newlisp executeable
28 nclocal.c       nc/netcat like utility for loal domain sockets
29 newlisp.vim         syntax file for VIM editor syntax highlighting
30 newlispdoc      utility to generate HTML docs from newLISP source
31 preparepdf      preprocessese newlisp_manual.html for PDF conversion
32 syntax.cgi      syntax highlighting in HTML for newLISP source
33 syntax-help     function for inclusion in init.lsp for command line syntax help
34 sql.c           program to disply MySQL include file offsets
35 type.c          program to show type sizes for porting newLISP
37 newlisp-x.x.x/   main distribution directory containing all source
39 README           general info and install
40 newlisp.c        newLISP VM and core primitives and auxiilary functions
41 newlisp.h        main header file
42 primes.h         header file containing table of all primitives 
43 protos.h         header file containing function prototypes
44 nl-list.c        functions working on lists
45 nl-liststr.c     functions working on lists and striong alike
46 nl-string.c      string handling primitives
47 nl-filesys.c     I/O primitives, process control, time date
48 nl-import.c      shared library interface
49 nl-math.c        floating point API
50 nl-matrix.c      matrix functions
51 nl-sock.c        networking API
52 nl-symbol.c      symbol creation manipulation Red/Black tree
53 nl-xml.c         xml functions
54 nl-web.c         special web functions
55 nl-debug.c       debugging functions
56 nl-utf8.c        UTF-8 versions of some newLISP string functions
57 unix-lib.c       for compiling newlisp.so shared lib under Linux/UNIX
58 osx-dlfcn.c      Mac OSX/Darwin dylib library interface
59 osx-dlfcn.h      Mac OSX/Darwin dylib library interface
60 win32-util.c     Win32 specific functions also used in CYGWIN, MinGW
61 win32dll.c       for compiling a Win32 DLL also used in CYGWIN, MinGW
62 win32dll.def     for compiling a Win32 DLL also used in CYGWIN, MinGW
63 win32-path.c     routines for UTF-16 file and directory access
64 init.lsp.example initialization file loaded from /usr/share/newlisp/init.lsp
66 pcre.h            PCRE Perl Compatible Regular Expression header file
67 pcre-config.h     PCRE config file
68 pcre-internal.h   PCRE headerfile
69 pcre.c            PCRE main source
70 pcre-chartables.c PCRE standrad character table
72 Makefile          main makefile
73 build             script called discovering the OS platform and making newlisp
74 configure         discovery of OS platform only without actually making newlisp
76 makefile_*        See the file Makefile for explanation
78 qa-dot            test suite for countries with decimal point
79 qa-comma          test suite for countries with decimal comma
80 qa-lfs            test suite for large file system support
81 qa-local-domain   test suite for local-dmain UNIX sockets
82 qa-net            test suite for distributed networking functions (UNIX only)
83 qa-setsig         test suite for signals
84 qa-utf16path.lsp  test suite for UTF-16 pathnames on Win32
85 qa-utf8           displays a sentence in many language alphabets
86 qa-xml            test suite for xml functions
88 modules/          modules to be loaded which implement a specific interface
90 For all modules HTML documentation can be generated using newlispoc
91 inside the modules directory execute: newlisp -s *.lsp
92 The module for GUI-Server guiserver.lsp can be found in the
93 guiserver subdirectory newlisp-x.x.x/guiserver/
95 cgi.lsp             functions for CGI with Apache or compatible web servers
96 crypto.lsp      OpenSSL crypto library module
97 ftp.lsp             functions for file transfer with FTP        
98 gmp.lsp         functions for GNU Multiplem Precision Library support
99 infix.lsp           parses infix, postfix and reverse polish to s-expressions
100 mysql.lsp           MySQL version 4.0 database access
101 mysql5.lsp          MySQL version 5.0 database access
102 mysql51.lsp         MySQL version 5.0 database access
103 odbc.lsp            ODBC database access
104 pop3.lsp            mailbox access with POP3
105 postsrcipt.lsp  functions for generating Postscript files
106 smtp.lsp            sending mail with SMTP
107 sqlite3.lsp         SQLite3 database access for SQLite 3.0 and later
108 stat.lsp            multivariate statistics and plotting (requires gnuplot)
109 unix.lsp        functions for importing common libc UNIX utility functions
110 xmlrpc-client.lsp   cient module for XML-RPC
111 zlisp.lsp       Zlib compression/de-compression support
113 examples/      various code examples and utilities
115 finger         sample script for a finger client
116 client         client/server networking sample
117 form.html      sample html form for processing with form.cgi
118 form.cgi       newLISP CGI processing sample script
119 newLISP-Excel-Import.xls  example how to call newlisp.dll from VB for applications
120 opengl-demo.lsp  OpenGL demo using Glut, see file header for libs required
121 prodcons.lsp   demo for fork, wait-pid, semaphore and share on Linux/UNIX
122 server         client/server networking sample
123 sqlite.cgi     simple script to call sqlite from a websever
124 sqlite3.cgi    simple script to call sqlite from a websever
125 tcltk.lsp      run Tcl/Tk apps without newlisp-tk frontend
126 udp-client.lsp example for UDP client
127 udp-server.lsp example for UDP server
128 upload.html    file upload example with multipart POST request
129 upload.cgi     CGI to handle upload.html
130 xmlrpc.cgi     newISP XML-RPC service as a CGI request
132 guiserver/
134 All of the following files are also installed when executing:
135     sudo make install
137 guiserver.lsp       module file to talk to guiserver.jar
138 guiserver.jar       compiled GUI-Server Java executable
139 guiserver.lsp.html  HTML doc generated from guiserver.lsp
140 index.html          index page for guiserver.lsp.html
141 newlisp-edit.lsp    GUI-Server application
143 *.lsp          various demos for GUI-Server
145 CHANGES             changes notes for guiserver
146 guisserver.lsp.html guiserver module file
147 guisserver.lsp.html guiserver docs generated from guiserver.lsp
148 index.html          index of guiserver functions generated from guiserver.lsp
149 Makefile            used for guisever development
150 Manifest            used by the Java compiler
152 /guiserver/images
154 *.png          various icons and images built into guiserver.jar
156 /guiserver/java/
158 *.java         Java source for GUI-Server
160                               +++