~ chicken-core (chicken-5) 977282b23f684062612d88408e2f1b9d34f58b55
commit 977282b23f684062612d88408e2f1b9d34f58b55 Author: felix <bunny351@gmail.com> AuthorDate: Fri May 28 09:07:11 2010 +0200 Commit: felix <bunny351@gmail.com> CommitDate: Fri May 28 09:07:11 2010 +0200 updated manual pages diff --git a/chicken-bug.1 b/chicken-bug.1 index 6d75838e..6e931705 100644 --- a/chicken-bug.1 +++ b/chicken-bug.1 @@ -3,7 +3,7 @@ .SH NAME -chicken-bug \- generates a Chicken Scheme bug report from user input +chicken-bug \- generates a bug report from user input .SH SYNOPSIS @@ -55,8 +55,7 @@ Submit bug reports by e-mail to .I chicken-janitors@nongnu.org .SH AUTHOR -Felix L. Winkelmann (felix@call-with-current-continuation.org) -and The Chicken Team. +The CHICKEN Team. .SH SEE ALSO .BR chicken(1) diff --git a/chicken-install.1 b/chicken-install.1 index 1a3e09e6..d3ccd7bf 100644 --- a/chicken-install.1 +++ b/chicken-install.1 @@ -18,9 +18,6 @@ command-line, then any existing .B setup scripts in the current directory will be executed in some unspecified order. -See the -.B Chicken -manual for more information. .SH OPTIONS @@ -48,7 +45,6 @@ path selected during configuration (usually .B $prefix/lib/chicken/<binary\-version> ) - .SH DOCUMENTATION More information can be found in the @@ -62,7 +58,7 @@ Submit bug reports by e-mail to tool. .SH AUTHORS -The Chicken Team +The CHICKEN Team .SH SEE ALSO .BR chicken-uninstall(1) diff --git a/chicken-profile.1 b/chicken-profile.1 index 0b638065..fcfb15d5 100644 --- a/chicken-profile.1 +++ b/chicken-profile.1 @@ -3,7 +3,7 @@ .SH NAME -chicken-profile \- generate a report from Chicken Scheme profiled program output +chicken-profile \- generate a report from profile-information .SH SYNOPSIS @@ -43,7 +43,7 @@ Show usage information. .SH DESCRIPTION -.I chicken\-profile reads in profiling information generated by Scheme +.I chicken\-profile reads in profiling information generated by CHICKEN Scheme programs compiled with the .B \-profile option, and generates a table listing function names and their execution times. @@ -54,7 +54,7 @@ Submit bug reports by e-mail to .I chicken-janitors@nongnu.org .SH AUTHORS -Felix L. Winkelmann and the Chicken Team +The CHICKEN Team .SH SEE ALSO .BR chicken(1) diff --git a/chicken-status.1 b/chicken-status.1 index 11db8713..4650a99e 100644 --- a/chicken-status.1 +++ b/chicken-status.1 @@ -12,12 +12,9 @@ chicken-status [OPTION | PATTERN] ... .SH DESCRIPTION .I chicken\-status -lists installed extensions matching the regular expression(s) +lists installed extensions for the CHICKEN Scheme system matching the regular expression(s) .B PATTERN or all, if no pattern has been given. -See the -.B Chicken -manual for more information. .SH OPTIONS @@ -45,7 +42,7 @@ path selected during configuration (usually .SH DOCUMENTATION More information can be found in the -.I Chicken\ User's\ Manual +.I CHICKEN\ User's\ Manual .SH BUGS Submit bug reports by e-mail to @@ -55,7 +52,7 @@ Submit bug reports by e-mail to tool. .SH AUTHORS -The Chicken Team +The CHICKEN Team .SH SEE ALSO .BR chicken-install(1) diff --git a/chicken-uninstall.1 b/chicken-uninstall.1 index 51847e87..8767cc61 100644 --- a/chicken-uninstall.1 +++ b/chicken-uninstall.1 @@ -12,13 +12,11 @@ chicken-uninstall [OPTION | PATTERN] ... .SH DESCRIPTION .I chicken\-uninstall -removes one or more already installed extension libraries. +removes one or more already installed extension libraries for the CHICKEN +Scheme system. .B PATTERN may be a regular expression naming multiple extensions or just an extension name. -See the -.B Chicken -manual for more information. .SH OPTIONS @@ -50,7 +48,7 @@ path selected during configuration (usually .SH DOCUMENTATION More information can be found in the -.I Chicken\ User's\ Manual +.I CHICKEN\ User's\ Manual .SH BUGS Submit bug reports by e-mail to @@ -60,7 +58,7 @@ Submit bug reports by e-mail to tool. .SH AUTHORS -The Chicken Team +The CHICKEN Team .SH SEE ALSO .BR chicken-install(1) diff --git a/chicken.1 b/chicken.1 index d1484cf6..20fa0683 100644 --- a/chicken.1 +++ b/chicken.1 @@ -3,25 +3,28 @@ .SH NAME -chicken \- A Scheme\-to\-C compiler +chicken \- A Scheme\-to\-C translator .SH SYNOPSIS .B chicken -.I pathname +.I PATHNAME [ -.I option ... +.I OPTION ... ] .SH DESCRIPTION -.I Chicken -is a compiler for the programming language +.I CHICKEN +is a compiler and interpreter for the programming language .I Scheme supporting most of the features as described in the .I Revised^5 Report on .I the Algorithmic Language Scheme -\. +\. The +-B chicken +program is the basic Scheme-to-C translator used in this system. +For a more convenient interface, see the manual page for csc(1). .SH OPTIONS @@ -48,135 +51,14 @@ Holds a string of default compiler options that should apply to every invocation .B chicken \. -.SH RUNTIME\ OPTIONS -After successful compilation a C source file is generated and can be compiled -with a C compiler. Executables generated with -.B chicken -(and the -.B chicken -program itself) accept a small set of runtime options. - -.TP -.B \-:? -Shows a list of the available runtime options and exits the program. - -.TP -.B \-:aNUMBER -Specifies the length of the buffer for recording a trace of the last invoked -procedures. Defaults to 8. - -.TP -.B \-:b -Enter a read-eval-print-loop when an error is encountered. - -.TP -.B \-:B -Sounds a bell (ASCII 7) on every major garbage collection. - -.TP -.B \-:c -Forces console mode. Currently this is only used in the interpreter (csi) to -force output of the -.I #;N> -prompt even if stdin is not a terminal (for example if running in an emacs buffer under Windows). - -.TP -.B \-:d -Prints some debug-information at runtime. - -.TP -.B \-:D -Prints some more debug-information at runtime. - -.TP -.B \-:fNUMBER -Specifies the maximal number of currently pending finalizers before finalization is forced. - -.TP -.B \-:hNUMBER -Specifies fixed heap size - -.TP -.B \-:hgPERCENTAGE -Sets the growth rate of the heap in percent. If the heap is exhausted, then it -will grow by -.B PERCENTAGE -\. The default is 200. - -.TP -.B \-:hiNUMBER -Specifies the initial heap size - -.TP -.B \-:hmNUMBER -Specifies a maximal heap size. The default is (2GB - 15). - -.TP -.B \-:hsPERCENTAGE -Sets the shrink rate of the heap in percent. If no more than a quarter of -.B PERCENTAGE -of the heap is used, then it will shrink to -.B PERCENTAGE -\. The default -is 50. Note: If you want to make sure that the heap never shrinks, specify a -value of 0. (this can be useful in situations where an optimal heap-size is -known in advance). - -.TP -.B \-:o -Disables detection of stack overflows at run-time. - -.TP -.B \-:r -Writes trace output to stderr. This option has no effect with in files compiled with the -.B -no-trace -options. - -.TP -.B \-:sNUMBER -Specifies stack size. - -.TP -.B \-:tNUMBER -Specifies symbol table size. - -.TP -.B \-:w -Enables garbage collection of unused symbols. By default unused and unbound -symbols are not garbage collected. - -.TP -.B \-: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 -.B \-:x -is not given, a warning will be shown, though. - -.P -The -.B NUMBER -argument values may be given in bytes, in kilobytes (suffixed with K or k), -in megabytes (suffixed with M or m), or in gigabytes (suffixed with G or g). -Runtime options may be combined, like -.B \-:dc -, but everything following a -.B NUMBER -argument is ignored. So -.B \-:wh64m -is OK, but -.B \-:h64mw -will not enable GC of unused symbols. - .SH DOCUMENTATION More information can be found in the -.I Chicken\ User's\ Manual +.I CHICKEN\ User's\ Manual .SH AUTHORS -Felix L. Winkelmann and The Chicken Team. +The CHICKEN Team. .SH SEE ALSO diff --git a/csc.1 b/csc.1 index be647451..b4e88f82 100644 --- a/csc.1 +++ b/csc.1 @@ -3,7 +3,7 @@ .SH NAME -csc \- driver program for the Chicken Scheme compiler +csc \- driver program for the CHICKEN Scheme compiler .SH SYNOPSIS @@ -51,7 +51,7 @@ Submit bug reports by e-mail to tool. .SH AUTHOR -Felix L. Winkelmann and the Chicken Team +The CHICKEN Team .SH SEE ALSO .BR chicken(1) diff --git a/csi.1 b/csi.1 index 2efa0a76..e860a5c5 100644 --- a/csi.1 +++ b/csi.1 @@ -4,7 +4,7 @@ .SH NAME The -.I Chicken +.I CHICKEN Scheme interpreter .SH SYNOPSIS @@ -61,7 +61,7 @@ can not be passed using this method. .SH DOCUMENTATION More information can be found in the -.I Chicken\ User's\ Manual +.I CHICKEN\ User's\ Manual .SH BUGS Submit bug reports by e-mail to @@ -71,7 +71,7 @@ Submit bug reports by e-mail to tool. .SH AUTHOR -Felix Winkelmann and the Chicken Team +The CHICKEN Team .SH SEE ALSO .BR chicken(1)Trap