Changeset 35528 in project

Timestamp:

05/07/18 16:20:06 (2 years ago)

Author:

felix winkelmann

Message:

Fix links, resurrected Declarations page, minor fixes.

Location:

wiki/man/5

Files:

• Deployment (modified) (1 diff)
• Extensions (modified) (1 diff)
• Interface to external functions and variables (modified) (1 diff)
• The User's Manual (modified) (1 diff)
• Using the compiler (modified) (18 diffs)
• Using the interpreter (modified) (6 diffs)

wiki/man/5/Deployment

@@ -82 +82 @@
 and place them in the application directory.
 
+=== Distributing compiled C files
+
+It is possible to create distributions of Scheme projects that
+have been compiled to C.  The runtime system of CHICKEN consists of only
+two handcoded C files ({{runtime.c}} and {{chicken.h}}), plus the files
+{{chicken-config.h}} and {{buildtag.h}}, which are generated by the
+build process. All other modules of the runtime system and the extension
+libraries are just compiled Scheme code. The following example shows a
+minimal application, which should run without changes on most operating
+systems, like Windows, Linux or FreeBSD (note however that static
+binaries are not supported on Mac OS X).
+
+Take the following "Hello World" program:
+
+<enscript highlight=scheme>
+; hello.scm
+
+(print "Hello, world!")
+</enscript>
+
+  % csc -t hello.scm -optimize-level 3 -output-file hello.c
+
+Compiled to C, we get {{hello.c}}. We need the files {{chicken.h}},
+{{chicken-config.h}}, {{buildtag.h}} and {{runtime.c}}, which contain
+the basic runtime system, plus the library files {{build-version.c}},
+{{chicken-syntax.c}}, {{eval.c}}, {{expand.c}}, {{internal.c}},
+{{library.c}} and {{modules.c}}, which contain the same functionality as
+the library that is linked into plain CHICKEN-compiled applications:
+
+  % cd /tmp
+  % echo '(print "Hello World.")' > hello.scm
+  % csc -t hello.scm
+  % cp $CHICKEN_BUILD/build-version.c .
+  % cp $CHICKEN_BUILD/chicken-syntax.c .
+  % cp $CHICKEN_BUILD/eval.c .
+  % cp $CHICKEN_BUILD/expand.c .
+  % cp $CHICKEN_BUILD/internal.c .
+  % cp $CHICKEN_BUILD/library.c .
+  % cp $CHICKEN_BUILD/modules.c .
+  % cp $CHICKEN_BUILD/runtime.c .
+  % cp $CHICKEN_BUILD/chicken.h .
+  % cp $CHICKEN_BUILD/chicken-config.h .
+  % cp $CHICKEN_BUILD/buildtag.h .
+  % gcc -Os -fomit-frame-pointer -DHAVE_CHICKEN_CONFIG_H hello.c \
+    build-version.c eval.c expand.c internal.c library.c modules.c runtime.c \
+    -o hello -lm
+
+Once we have all the files together, we can create a tarball:
+
+ % tar czf hello.tar.gz hello.c build-version.c chicken-syntax.c eval.c \
+   expand.c internal.c library.c modules.c runtime.c chicken.h \
+   chicken-config.h buildtag.h
+
+This is naturally rather simplistic. Things like enabling dynamic
+loading and selecting supported features of the host system would need
+more configuration- and build-time support. All this can be addressed
+using more elaborate build-scripts, makefiles or by using
+autoconf/automake.
+
+The {{chicken-config.h}} file may contain incorrect settings for your
+deployment target. Especially when the architecture is different. In
+that case you will have to adjust the values as needed.
+
+For more information, study the CHICKEN source code and/or ask on the CHICKEN
+mailing lists to understand the implications and difficulties of this deployment
+method in more detail.
+
 === Platform specific notes
 

wiki/man/5/Extensions

@@ -265 +265 @@
 
 ---
-Previous: [[Interface to external functions and variables]]
+Previous: [[Declarations]]
 
 Next: [[Extension tools]]

wiki/man/5/Interface to external functions and variables

@@ -20 +20 @@
 Previous: [[Included modules]]
 
-Next: [[Extensions]]
+Next: [[Declarations]]

wiki/man/5/The User's Manual

@@ -16 +16 @@
 * [[Included modules]] : A reference to CHICKEN's core module library
 * [[Interface to external functions and variables]] : Accessing C/C++ code and data
+* [[Declarations]] : Compiler declarations
 * [[Extensions]] : Packaging and installing extension libraries
 * [[Extension tools]] : {{chicken-[un]install}} and {{chicken-status}}

wiki/man/5/Using the compiler

@@ -15 +15 @@
 === Compiler command line format
 
- csc FILENAME-OR-OPTION
+ chicken FILENAME OPTION ...
 
 {{FILENAME}} is the pathname of the source file that is to
@@ -25 +25 @@
 ; -analyze-only : Stop compilation after first analysis pass.
 
-; -block : Enable block-compilation. When this option is specified, the compiler assumes that global variables are not modified outside this compilation-unit.  Specifically, toplevel bindings are not seen by {{eval}} and unused toplevel bindings are removed.
+; -block : Enable block-compilation. When this option is specified, the compiler assumes that global variables are not modified outside of this compilation-unit.  Specifically, toplevel bindings are not seen by {{eval}} and unused toplevel bindings are removed.
 
 ; -case-insensitive : Enables the reader to read symbols case insensitive. The default is to read case sensitive (in violation of R5RS).  This option registers the {{case-insensitive}} feature identifier.
@@ -37 +37 @@
 ; -debug MODES : Enables one or more compiler debugging modes. {{MODES}} is a string of characters that select debugging information about the compiler that will be printed to standard output. Use {{-debug h}} to see a list of available debugging options.
 
-; -debug-level LEVEL : Selects amount of debug-information. {{LEVEL}} should be an integer.
-
-     -debug-level 0             is equivalent to -no-trace -no-lambda-info
-     -debug-level 1             is equivalent to -no-trace
-     -debug-level 2             is the default behaviour
-     -debug-level 3             is equivalent to -debug-info
-
-; -disable-interrupts : Equivalent to the {{(disable-interrupts)}} declaration. No interrupt-checks are generated for compiled programs.
+; -debug-level LEVEL : Selects amount of debug-information. {{LEVEL}} should be an integer, where {{0}} is equivalent to {{-no-trace -no-lambda-info}}, {{1}} is equivalent to {{-no-trace}}, {{2}} is the default behaviour and {{3}} is equivalent to {{-debug-mode}}.
+
+; -disable-interrupts : Equivalent to the {{(disable-interrupts)}} declaration. No interrupt-checks are generated for compiled programs, which disables thread context switches in this (and only this) compilation unit.
 
 ; -disable-stack-overflow-checks : Disables detection of stack overflows. This is equivalent to running the compiled executable with the {{-:o}} runtime option.
@@ -70 +65 @@
 ; -feature SYMBOL : Registers {{SYMBOL}} to be a valid feature identifier for {{cond-expand}}. Multiple symbols may be given, if comma-separated.
 
-; -fixnum-arithmetic : Equivalent to {{(fixnum-arithmetic)}} declaration. Assume all mathematical operations use small integer arguments.
-
-; -heap-size NUMBER : Sets a fixed heap size of the generated executable to {{NUMBER}} bytes. The parameter may be followed by a  {{M}} ({{m}}) or {{K}} ({{k}}) suffix which stand for mega- and kilobytes, respectively.  The default heap size is 5 kilobytes. Note that only half of it is in use at every given time.
+; -fixnum-arithmetic : Equivalent to the {{(fixnum-arithmetic)}} declaration. Assume all mathematical operations use small integer arguments.
+
+; -heap-size NUMBER : Sets a fixed heap size of {{NUMBER}} bytes for the generated executable. The parameter may be followed by a  {{M}} ({{m}}) or {{K}} ({{k}}) suffix which stand for mega- and kilobytes, respectively.  The default heap size is 500 kilobytes. Note that only half of it is in use at every given time. Note also that by default the heap is dynamically resized unless this option is given.
 
 ; -help : Print a summary of available options and the format of the command line parameters and exit the compiler.
 
-; -ignore-repository : Do not load any extensions from the repository (treat repository as empty). Also do not consult compiled (only interpreted) import libraries in {{import}} forms.
-
-; -include-path PATHNAME : Specifies an additional search path for files included via the {{include}} special form. This option may be given multiple times. If the environment variable {{CHICKEN_INCLUDE_PATH}} is set, it should contain a list of alternative include pathnames separated by {{:}} (unix) or {{;}} (windows).
+; -ignore-repository : Do not load any extensions from the repository (treat the repository as empty). Also do not consult compiled (only interpreted) import libraries in {{import}} forms.
+
+; -include-path PATHNAME : Specifies an additional search path for files included via the {{include}} special form. This option may be given multiple times. If the environment variable {{CHICKEN_INCLUDE_PATH}} is set, it should contain a list of alternative include pathnames separated by {{:}} (UNIX) or {{;}} (Windows).
 
 ; -inline : Enable procedure inlining for known procedures of a size below the threshold (which can be set through the {{-inline-limit}} option).
@@ -86 +81 @@
 ; -inline-limit THRESHOLD : Sets the maximum size of a potentially inlinable procedure. The default threshold is {{20}}.
 
-; -keyword-style STYLE : Enables alternative keyword syntax, where {{STYLE}} may be either {{prefix}} (as in Common Lisp, e.g. :keyword), {{suffix}} (as in DSSSL, e.g. keyword:) or {{none}}. Any other value is ignored. The default is {{suffix}}.
+; -keyword-style STYLE : Enables alternative keyword syntax, where {{STYLE}} may be either {{prefix}} (as in Common Lisp, e.g. :keyword), {{suffix}} (as in DSSSL, e.g. keyword:) or {{none}} (where only the {{#:KEYWORD}} is allowed). Any other value is ignored. The default is {{suffix}}.
 
 ; -keep-shadowed-macros : Do not remove macro definitions with the same name as assigned toplevel variables (the default is to remove the macro definition).
@@ -102 +97 @@
 ; -no-bound-checks : disable bound variable checks
 
-; -no-feature SYMBOL : Disables the predefined feature-identifier {{SYMBOL}}. Multiple symbols may be given, if comma-separated.
-
-; -no-lambda-info : Don't emit additional information for each {{lambda}} expression (currently the argument-list, after alpha-conversion/renaming).
-
-; -no-module-registration : Do not generate module-registration code in the compiled code. This is only needed if you want to use an import library that is generated by other means (manually, for example).
+; -no-feature SYMBOL : Disables the predefined feature-identifier {{SYMBOL}}. Multiple comma-separated symbols may be given.
+
+; -no-lambda-info : Do not emit additional information for each {{lambda}} expression (currently the argument-list, after alpha-conversion/renaming).
+
+; -no-module-registration : Do not generate module-registration code in the compiled code. This is needed if you want to use an import library that is generated by other means (manually, for example), or when you do not intend to use modules in the program at runtime (using {{eval}}).
 
 ; -no-parentheses-synonyms : Disables list delimiter synonyms, [..] and {...} for (...).
@@ -127 +122 @@
 ; -optimize-leaf-routines : Enable leaf routine optimization.
 
-; -optimize-level LEVEL : Enables certain sets of optimization options. {{LEVEL}} should be an integer.
-
-     -optimize-level 0          is equivalent to -no-usual-integrations -no-compiler-syntax
-     -optimize-level 1          is equivalent to -optimize-leaf-routines
-     -optimize-level 2          is equivalent to -optimize-leaf-routines -inline
-     -optimize-level 3          is equivalent to -optimize-leaf-routines -local -inline -inline-global -specialize
-     -optimize-level 4          is equivalent to -optimize-leaf-routines -local -inline -inline-global -specialize -unsafe
-     -optimize-level 5          is equivalent to -optimize-leaf-routines -block -inline -inline-global -specialize -unsafe -disable-interrupts -no-trace -no-lambda-info -clustering -lfa2
-
-; -output-file FILENAME : Specifies the pathname of the generated C file. Default is {{FILENAME.c}}.
+; -optimize-level LEVEL : Enables certain sets of optimization options. {{LEVEL}} should be an integer. Level {{0}} is equivalent to {{-no-usual-integrations -no-compiler-syntax}} (no optimization), level {{1}  is equivalent to {{-optimize-leaf-routines}} (minimal optimization), level {{2}} is equivalent to {{-optimize-leaf-routines -inline}} (enable optimizations that do not break standard compliance, this is the default), level {{3}} is equivalent to {{-optimize-leaf-routines -local -inline -inline-global -specialize}} (maximal optimization, while still "safe"), level {{4}} is equivalent to {{-optimize-leaf-routines -local -inline -inline-global -specialize -unsafe}} (maximal optimization, "unsafe") and any higher level is equivalent to {{-optimize-leaf-routines -block -inline -inline-global -specialize -unsafe -disable-interrupts -no-trace -no-lambda-info -clustering -lfa2}} (all possible optimizations, "unsafe").
+
+; -output-file FILENAME : Specifies the pathname of the generated C file. Default is to use the source filename with the extension replaced by {{.c}}.
 
 ; -postlude EXPRESSIONS : Add {{EXPRESSIONS}} after all other toplevel expressions in the compiled file.  This option may be given multiple times. Processing of this option takes place after processing of {{-epilogue}}.
@@ -143 +131 @@
 
 ; -profile : 
-; -accumulate-profile : Instruments the source code to count procedure calls and execution times. After the program terminates (either via an explicit {{exit}} or implicitly), profiling statistics are written to a file named {{PROFILE.<randomnumber>}}. Each line of the generated file contains a list with the procedure name, the number of calls and the time spent executing it. Use the {{chicken-profile}} program to display the profiling information in a more user-friendly form. Enter {{chicken-profile -help}} at the command line to get a list of available options. The {{-accumulate-profile}} option is similar to {{-profile}}, but the resulting profile information will be appended to any existing {{PROFILE}} file. {{chicken-profile}} will merge and sum up the accumulated timing information, if several entries for the same procedure calls exist. Only profiling information for global procedures will be collected.  See the {{-:p}} option under [[#runtime-options|"Runtime options"]] below for statistical profiling support.
+; -accumulate-profile : Instruments the source code to count procedure calls and execution times. After the program terminates (either via an explicit {{exit}} or implicitly), profiling statistics are written to a file named {{PROFILE.<randomnumber>}}. Each line of the generated file contains a list with the procedure name, the number of calls and the time spent executing it. Use the {{chicken-profile}} program to display the profiling information in a more user-friendly form. Enter {{chicken-profile -help}} at the command line to get a list of available options. The {{-accumulate-profile}} option is similar to {{-profile}}, but the resulting profile information will be appended to any existing {{PROFILE}} file. {{chicken-profile}} will merge and sum up the accumulated timing information, if several entries for the same procedure calls exist. Only profiling information for global procedures will be collected.  See the {{-:p}} option under [[#Runtime options|"Runtime options"]] below for statistical profiling support.
 
 ; -profile-name FILENAME : Specifies name of the generated profile information (which defaults to {{PROFILE.<randomnumber>}}. Implies {{-profile}}.
@@ -149 +137 @@
 ; -prologue FILENAME : Includes the file named {{FILENAME}} at the start of the compiled source file.  The include-path is not searched. This option may be given multiple times.
 
-; -r5rs-syntax : Disables the CHICKEN extensions to R5RS syntax. Does not disable [[Non-standard read syntax|non-standard read syntax]].
-
-; -raw : Disables the generation of any implicit code that uses the Scheme libraries (that is all runtime system files besides {{runtime.c}} and {{chicken.h}}).
+; -r5rs-syntax : Disables the CHICKEN extensions to R5RS syntax. Does not disable non-standard read syntax.
+
+; -raw : Disables the generation of any implicit code that uses the Scheme libraries (that is all runtime system files besides {{runtime.c}} and {{chicken.h}}). Use this only when you know what you are doing.
 
 ; -require-extension NAME : Loads the extension {{NAME}} before the compilation process commences. This is identical to adding {{(require-extension NAME)}} at the start of the compiled program. If {{-uses NAME}} is also given on the command line, then any occurrences of {{-require-extension NAME}} are replaced with {{(declare (uses NAME))}}. Multiple names may be given and should be separated by commas.
@@ -161 +149 @@
 ; -static : Link extensions statically, if possible.
 
-; -strict-types : Assume that the type of variables is not changed by assignments. This gives more type-information during specialization, but violating this assumption will result in unsafe and incorrectly behaving code.
+; -strict-types : Assume that the type of variables is not changed by assignments. This gives more type-information during specialization, but violating this assumption will result in unsafe and incorrectly behaving code. Use with care.
 
 ; -consult-types-file FILENAME : load additional type database from {{FILENAME}}. Type-definitions in {{FILENAME}} will override previous type-definitions.
@@ -173 +161 @@
 ; -unsafe : Disable runtime safety checks.
 
-; -uses NAME : Use definitions from the library unit {{NAME}}. This is equivalent to {{-prelude "(declare (uses NAME))"}}. Multiple arguments may be given, separated by {{,}}.
+; -uses NAME : Use definitions from the library unit {{NAME}}. This is equivalent to {{-prelude "(declare (uses NAME))"}}. Multiple arguments may be given, separated by {{,}} (comma).
 
 ; -no-usual-integrations : Specifies that standard procedures and certain internal procedures may be redefined, and can not be inlined. This is equivalent to declaring {{(not usual-integrations)}}.
@@ -196 +184 @@
 After successful compilation a C source file is generated and can be
 compiled with a C compiler. Executables generated with CHICKEN (and the
-compiler itself) accept a small set of runtime options:
+compiler itself) accept a small set of runtime options. These are filtered out
+by the startup code and will not be contained in the result of 
+{{(command-line-arguments)}}.
 
 ; {{-:?}} : Shows a list of the available runtime options and exits the program.
@@ -202 +192 @@
 ; {{-:aNUMBER}} : Specifies the length of the buffer for recording a trace of the last invoked procedures. Defaults to 16.
 
-; {{-:ANUMBER}} : Specifies fixed "temporary stack" size. This is used mostly for {{apply}}. If you supply a zero size (the default), the stack will be dynamically reallocated as needed.
+; {{-:ANUMBER}} : Specifies fixed ''temporary stack'' size. This is used mostly for {{apply}}. If you supply a zero size (the default), the temorary stack will be dynamically reallocated as needed.
 
 ; {{-:b}} : Enter a read-eval-print-loop when an error is encountered.
 
-; {{-:B}} : Sounds a bell (ASCII 7) on every major garbage collection.
+; {{-:B}} : Sounds a bell (by writing ASCII 7 to stdout) on every major garbage collection.
 
 ; {{-:c}} : Forces console mode. Currently this is only used in the interpreter ({{csi}}) to force output of the {{#;N>}} prompt even if stdin is not a terminal (for example if running in an {{emacs}} buffer under Windows).
@@ -216 +206 @@
 ; {{-:g}} : Prints information about garbage-collection.
 
-; {{-:G}} : Force GUI mode (show error messages in dialog box, suitable for platform).
+; {{-:G}} : Force GUI mode (show error messages in dialog box if running under MacOS X or Windows).
 
 ; {{-:H}} : Before terminating, dump heap usage to stderr.
@@ -238 +228 @@
 ; {{-:PFREQUENCY}} : Same as {{-:p}} but set the sampling frequency in microseconds (default is 10000 microseconds or every 10 milliseconds).
 
-; {{-:r}} : Writes trace output to stderr. This option has no effect with in files compiled with the {{-no-trace}} options.
+; {{-:r}} : Writes trace output to stderr. This option has no effect in files compiled with the {{-no-trace}} options.
 
 ; {{-:sNUMBER}} : Specifies stack size.
 
 ; {{-:tNUMBER}} : Specifies symbol table size.
-
-; {{-:w}} : Enables garbage collection of unused symbols. By default unused and unbound symbols are not garbage collected.
 
 ; {{-:x}} : Raises uncaught exceptions of separately spawned threads in primordial thread. By default uncaught exceptions in separate threads are not handled, unless the primordial one explicitly joins them. When warnings are enabled (the default) and {{-:x}} is not given, a warning will be shown, though.
@@ -254 +242 @@
 
 Runtime options may be combined, like {{-:dc}}, but everything following
-an argument is ignored. So {{-:wh64m}} is OK, but {{-:h64mw}} will not
-enable GC of unused symbols.
-
-=== Examples
-
-==== A simple example (with one source file)
-
-To compile a Scheme program (assuming a UNIX-like environment) consisting of a single source file, perform the following steps.
-
-===== Writing your source file
-
-In this example we will assume your source file is called {{foo.scm}}:
-
-<enscript highlight=scheme>
-;;; foo.scm
-
-(define (fac n)
-  (if (zero? n)
-      1
-      (* n (fac (- n 1))) ) )
-
-(write (fac 10))
-(newline)
-</enscript>
-
-===== Compiling your program
-
-Compile the file {{foo.scm}}:
-
- % csc foo.scm
-
-This will produce the {{foo}} executable:
-
- % ls
- foo  foo.scm
-
-===== Running your program
-
-To run your newly compiled executable use:
-
- % ./foo
- 3628800
-
-
-==== An example with multiple files
-
-If multiple bodies of Scheme code are to be combined into a single
-executable, then we have to compile each file and link the resulting
-object files together with the runtime system.
-
-Let's consider an example where your program consists of multiple source files.
-
-===== Writing your source files
-
-The declarations in these files specify which of the compiled files is the main
-module, and which is the library module. An executable can only have
-one main module, since a program has only a single entry-point. In this
-case {{foo.scm}} is the main module, because it doesn't have a
-{{unit}} declaration:
-
-<enscript highlight=scheme>
-;;; foo.scm
-
-; The declaration marks this source file as dependant on the symbols provided
-; by the bar unit:
-(declare (uses bar))
-
-(write (fac 10)) (newline)
-</enscript>
-
-{{bar.scm}} will be our library:
-
-<enscript highlight=scheme>
-;;; bar.scm
-
-; The declaration marks this source file as the bar unit.  The names of the
-; units and your files don't need to match.
-(declare (unit bar))
-
-(define (fac n)
-  (if (zero? n)
-      1
-      (* n (fac (- n 1))) ) )
-</enscript>
-
-===== Compiling and running your program
-
-You should compile your two files with the following commands:
-
- % csc -c bar.scm
- % csc -c foo.scm
-
-That should produce two files, {{bar.o}} and {{foo.o}}.
-They contain the code from your source files in compiled form.
-
-To link your compiled files use the following command:
-
- % csc foo.o bar.o -o foo
-
-This should produce the {{foo}} executable, which you can run just as in the previous example.
-At this point you can also erase the {{*.o}} files.
-
-You could avoid one step and link the two files just as {{foo.scm}} is compiled:
-
- % csc -c bar.scm
- % csc foo.scm bar.o -o foo
-
-Note that if you want to distribute your program, you might want it to
-follow the GNU Coding Standards.  One relatively easy way to achieve
-this is to use Autoconf and Automake, two tools made for this specific
-purpose. 
+an argument is ignored. So {{-:oh64m}} is OK, but {{-:h64mo}} will not
+disable stack overflow checks.
 
 === Extending the compiler
@@ -374 +253 @@
 {{user-preprocessor-pass}}, {{user-pass}} and {{user-post-analysis-pass}}
 can be set to procedures that are called to perform certain compilation
-passes instead of the usual processing (for more information about
-parameters see [[Supported language]]).
+passes in addition to the usual processing.
 
 These parameters are provided by the {{(chicken compiler user-pass)}}
@@ -404 +282 @@
 seen by {{user-preprocessor-pass}}, but are seen by {{user-pass}}.
 
-=== Distributing compiled C files
-
-It is relatively easy to create distributions of Scheme projects that
-have been compiled to C.  The runtime system of CHICKEN consists of only
-two handcoded C files ({{runtime.c}} and {{chicken.h}}), plus the files
-{{chicken-config.h}} and {{buildtag.h}}, which are generated by the
-build process. All other modules of the runtime system and the extension
-libraries are just compiled Scheme code. The following example shows a
-minimal application, which should run without changes on most operating
-systems, like Windows, Linux or FreeBSD (note however that static
-binaries are not supported on Mac OS X).
-
-Take the following "Hello World" program:
-
-<enscript highlight=scheme>
-; hello.scm
-
-(print "Hello, world!")
-</enscript>
-
-  % csc -t hello.scm -optimize-level 3 -output-file hello.c
-
-Compiled to C, we get {{hello.c}}. We need the files {{chicken.h}},
-{{chicken-config.h}}, {{buildtag.h}} and {{runtime.c}}, which contain
-the basic runtime system, plus the library files {{build-version.c}},
-{{chicken-syntax.c}}, {{eval.c}}, {{expand.c}}, {{internal.c}},
-{{library.c}} and {{modules.c}}, which contain the same functionality as
-the library that is linked into plain CHICKEN-compiled applications:
-
-  % cd /tmp
-  % echo '(print "Hello World.")' > hello.scm
-  % csc -t hello.scm
-  % cp $CHICKEN_BUILD/build-version.c .
-  % cp $CHICKEN_BUILD/chicken-syntax.c .
-  % cp $CHICKEN_BUILD/eval.c .
-  % cp $CHICKEN_BUILD/expand.c .
-  % cp $CHICKEN_BUILD/internal.c .
-  % cp $CHICKEN_BUILD/library.c .
-  % cp $CHICKEN_BUILD/modules.c .
-  % cp $CHICKEN_BUILD/runtime.c .
-  % cp $CHICKEN_BUILD/chicken.h .
-  % cp $CHICKEN_BUILD/chicken-config.h .
-  % cp $CHICKEN_BUILD/buildtag.h .
-  % gcc -static -Os -fomit-frame-pointer -DHAVE_CHICKEN_CONFIG_H hello.c \
-    build-version.c eval.c expand.c internal.c library.c modules.c runtime.c \
-    -o hello -lm
-
-Once we have all the files together, we can create a tarball:
-
- % tar cf hello.tar hello.c build-version.c chicken-syntax.c eval.c \
-   expand.c internal.c library.c modules.c runtime.c chicken.h \
-   chicken-config.h buildtag.h
- % gzip hello.tar
-
-This is naturally rather simplistic. Things like enabling dynamic
-loading and selecting supported features of the host system would need
-more configuration- and build-time support. All this can be addressed
-using more elaborate build-scripts, makefiles or by using
-autoconf/automake.
-
-The {{chicken-config.h}} file may contain incorrect settings for your
-deployment target. Especially when the architecture is different. In
-that case you will have to adjust the values as needed.
-
-Note that the size of the application can still be reduced by removing
-any of the C files besides {{build-version.c}}, {{library.c}}, and
-{{runtime.c}}, and compiling {{hello.scm}} with the {{-explicit-use}}
-option.
-
-For more information, study the CHICKEN source code and/or ask on the CHICKEN
-mailing list.
-
 ---
 Previous: [[Using the interpreter]]

wiki/man/5/Using the interpreter

@@ -27 +27 @@
 The parameter {{command-line-arguments}} is set to a list of the
 parameters that were passed to the Scheme script.  Scripts can be compiled
-to standalone executables (don't forget to declare used library units).
+to standalone executables.
 
 CHICKEN supports writing shell scripts in Scheme for other platforms as well,
@@ -132 +132 @@
 
 You can define your own toplevel commands using the {{toplevel-command}}
-procedure:
+procedure (see [[Module (chicken csi)]]).
 
 
@@ -189 +189 @@
 === History access
 
-The interpreter toplevel accepts the special object {{#[INDEX]}} which
+The interpreter toplevel accepts the special object {{#INDEX}} which
 returns the result of entry number {{INDEX}} in the history list. If
 the expression for that entry resulted in multiple values, the first
@@ -195 +195 @@
 {{INDEX}} is given (and if a whitespace or closing paranthesis
 character follows the {{#}}, then the result of the last expression is
-returned.  Note that the value returned is implicitly quoted.
-
-=== Auto-completion and edition
+returned.  Note that the value that {{#INDEX}} stands for is an expression,
+not a literal, and so is implicitly quoted, so
+
+ #;1> 123
+ 123
+ #;2> '(1 2 #)
+
+will not return the result you expected.
+
+=== Auto-completion and editing
 
 On platforms that support it, it is possible to get auto-completion of
@@ -241 +248 @@
 ; -h  -help : Write a summary of the available command line options to standard output and exit.
 
-; -I  -include-path PATHNAME : Specifies an alternative search-path for files included via the {{include}} special form. This option may be given multiple times. If the environment variable {{CHICKEN_INCLUDE_PATH}} is set, it should contain a list of alternative include pathnames separated by {{;}}.
+; -I  -include-path PATHNAME : Specifies an alternative search-path for files included via the {{include}} special form. This option may be given multiple times. If the environment variable {{CHICKEN_INCLUDE_PATH}} is set, it should contain a list of alternative include pathnames separated by {{:}} (UNIX) or {{;}} (Windows).
 
 ; -K  -keyword-style STYLE : Enables alternative keyword syntax, where {{STYLE}} may be either {{prefix}} (as in Common Lisp) or {{suffix}} (as in DSSSL). Any other value is ignored.
@@ -255 +262 @@
 ; -q  -quiet : Do not print a startup message. Also disables generation of call-trace information for interpreted code.
 
-;     -r5rs-syntax : Disables the CHICKEN extensions to R5RS syntax. Does not disable [[Non-standard read syntax|non-standard read syntax]].
+;     -r5rs-syntax : Disables the CHICKEN extensions to R5RS syntax. Does not disable non-standard read syntax.
 
 ; -s  -script PATHNAME : This is equivalent to {{-batch -quiet -no-init PATHNAME}}. Arguments following {{PATHNAME}} are available by using  {{command-line-arguments}} and are not processed as interpreter options. Extra options in the environment variable {{CSI_OPTIONS}} are ignored.