~ chicken-core (chicken-5) 6191ef0ec2a7935fa2c0c127d86bac3d2585cd1b
commit 6191ef0ec2a7935fa2c0c127d86bac3d2585cd1b Author: felix <bunny351@gmail.com> AuthorDate: Mon May 3 08:38:36 2010 +0200 Commit: felix <bunny351@gmail.com> CommitDate: Mon May 3 08:38:36 2010 +0200 simplified manpages diff --git a/chicken-install.1 b/chicken-install.1 index e1454e27..1a3e09e6 100644 --- a/chicken-install.1 +++ b/chicken-install.1 @@ -24,92 +24,9 @@ manual for more information. .SH OPTIONS -.TP -.B \-h,\ \-help -Shows a summary of options and exits. - -.TP -.B \-v,\ \-version -Shows tool version and exits. - -.TP -.B \-force -Do not ask when versions don't match, continue with the installation instead. - -.TP -.BI \-i,\ \-init\ DIRECTORY -Initialize empty alternative repository. - -.TP -.B \-k,\ \-keep -Keep temporary directories after an installation process finished -(whether successfull or not). - -.TP -.N \-n\-install -Do not install the extension, just build it. Implies -.B \-keep - -.TP -.BI \-l,\ \-location \ LOCATION -Specifies the location from where to retrieve the extension sources. -Defaults to the current official egg-repository suitable for this -version of -.B CHICKEN -Depending on the transport used (see below), the -.B LOCATION -may be an svn(1) repository URL, a http URL or a location in the local -file-system. - -.TP -.BI \-t,\ \-transport \ TRANSPORT -Selects the mechanism to use to download any extensions that are directly -or indirectly to be installed. Currently the transports -.B http -(the default, retrieve files via the HTTP protocol), -.B svn -(retrieve by performing a checkout - requires the svn(1) client to be -installed) and -.B local -(install directly from the local file-system). - -.TP -.B \-s,\ \-sudo -Perform any installation steps the install files by commands invoked -with the sudo(1) tool. - -.TP -.B \-u,\ \-update -Scan all installed import libraries and generate module database file. - -.TP -.B \-r,\ \-retrieve -Only fetch the extensions, do not install them. - -.TP -.BI \-p,\ \-prefix \ PREFIX -Select an alternative installation prefix. - -.TP -.B \-host\-extension -Mark this extension as a "host" extension. This is mainly intended -for cross-compilation. - -.TP -.B \-test -After successfull installation, invoke any accompanying test-suite, -if found in the extension sources. When this option is given, additional -dependencies configured in the -.B test\-depends -meta property may be downloaded and installed, if necessary. - -.TP -.BI \-username USERNAME -Set username for transports that require authentification. - -.TP -.BI \-password PASSWORD -Set password for transports that require authentification. +Enter +.B chicken-install\ \-help +for a list of supported command-line options. .SH ENVIRONMENT\ VARIABLES diff --git a/chicken-status.1 b/chicken-status.1 index 02c78a28..11db8713 100644 --- a/chicken-status.1 +++ b/chicken-status.1 @@ -21,17 +21,9 @@ manual for more information. .SH OPTIONS -.TP -.B \-h,\ \-help -Shows a summary of options and exits. - -.TP -.B \-v,\ \-version -Shows tool version and exits. - -.TP -.B \-f,\ \-files -Shows files belonging to the matching extension. +Enter +.B chicken-status\ \-help +for a list of supported command-line options. .SH ENVIRONMENT\ VARIABLES diff --git a/chicken-uninstall.1 b/chicken-uninstall.1 index da34bc61..51847e87 100644 --- a/chicken-uninstall.1 +++ b/chicken-uninstall.1 @@ -22,24 +22,9 @@ manual for more information. .SH OPTIONS -.TP -.B \-h,\ \-help -Shows a summary of options and exits. - -.TP -.B \-v,\ \-version -Shows tool version and exits. - -.TP -.B \-force -Do not ask when multiple extensions match the given patterns, delete -whatever matches. - -.TP -.B \-s,\ \-sudo -Perform any uninstallation steps that remove files by commands invoked -with the sudo(1) tool. - +Enter +.B chicken-uninstall\ \-help +for a list of supported command-line options. .SH ENVIRONMENT\ VARIABLES diff --git a/chicken.1 b/chicken.1 index dcaa84c5..d1484cf6 100644 --- a/chicken.1 +++ b/chicken.1 @@ -25,438 +25,9 @@ supporting most of the features as described in the .SH OPTIONS -.TP -.B \-analyze\-only -Stop compilation after first analysis pass. - -.B \-benchmark\-mode -Equivalent to -.B \-optimize\-level\ 3\ \-fixnum\-arithmetic\ \-disable\-interrupts\ \-lambda\-lift -.B \-block\ \-no\-lambda\-info - -.TP -.B \-block -Enable block-compilation. When this option is specified, the compiler assumes -that global variables are not modified outside this compilation-unit. - -.TP -.B \-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 -.B case\-insensitive -feature identifier. - -.TP -.B \-check\-imports -Search for references to undefined global variables. - -.TP -.B \-check\-syntax -Aborts compilation process after macro-expansion and syntax checks. - -.TP -.BI \-database\-size \ number -Specifies the initial size of the analysis-database. Should only be used if -extremely large files are to be compiled. - -.TP -.BI \-debug \ modes -Enables one or more debugging modes. See the User's Manual for more information. - -.TP -.BI \-debug\-level \ level -Selects amount of debug-information. -.I level -should be an integer. -.P -.br -.B \ \ \ \ 0 --no-trace -no-lambda-info -.br -.B \ \ \ \ 1 --no-trace -.br -.B \ \ \ \ 2 -nothing. - -.TP -.B \-disable\-c\-syntax\-checks -Disable basic syntax checking of embedded C code fragments. - -.TP -.B \-disable\-compiler\-macros -Disable expansion of compiler macros. - -.TP -.B \-disable\-interrupts -Equivalent to -.B \-prelude\ \'(declare\ (interrupts-disabled))\' -\. - -.TP -.B \-disable\-stack\-overflow\-checks -Disables detection of stack-overflows. - -.TP -.BI \-disable\-warning \ class -Disables specific -.I class -of warnings, may be given multiple times. -.P -.br -.B \ \ \ \ ext\ \ \ -Suspect extension use. -.br -.B \ \ \ \ type\ \ -Suspect type/literal use. -.br -.B \ \ \ \ usage\ -Suspect feature use. -.br -.B \ \ \ \ style\ -Suspect feature use. -.br -.B \ \ \ \ syntax -Suspect sytax form. -.br -.B \ \ \ \ redef\ -Redefinition of builtin binding. -.br -.B \ \ \ \ var\ \ \ -Suspect variable use. - -.TP -.B \-dynamic -This option should be used when compiling files intended to be loaded dynamically into -a running Scheme program. - -.TP -.BI \-epilogue \ filename -Includes the file named -.I filename -at the end of the compiled source file. -The include-path is not searched. This option may be given multiple times. - -.TP -.B \-emit\-debug\-info -Emit additional information for each -.B lambda -expression (currently the argument-list, -after alpha-conversion/renaming). - -.TP -.BI \-emit\-exports \ filename -Write exported toplevel variables to file -.I filename -\. - -.TP -.B \-emit\-external\-prototypes\-first -Emit prototypes for callbacks defined with -.B define\-external -before any -other foreign declarations. This is sometimes useful, when C/C++ code embedded into -the a Scheme program has to access the callbacks. By default the prototypes are emitted -after foreign declarations. - -.TP -.BI \-emit\-inline\-file \ filename -Write procedures that can be globally inlined in internal form to -.I filename -, if global inlining is enabled. Implies "-inline -local". - -.TP -.B \-explicit\-use -Disables automatic use of the units -.I library -and -.I eval -\. Use this option if compiling a library unit -instead of an application unit. - -.TP -.BI \-extend \ filename -Loads a Scheme file, -.I filename -, before compilation commences. This feature can be used to extend the compiler. - -.TP -.B \-extension -Mostly equivalent to -.B \-prelude\ \'(define-extension\ NAME)\' -where -.B NAME -is the basename of the currently compiled file. Note that if you want to compile a file -as a normal (dynamically loadable) extension library, you should also pass the -.B \-shared -option. - -.TP -.BI \-feature \ symbol -Registers -.I symbol -to be a valid feature identifier for -.B cond\-expand - -.TP -.B \-fixnum\-arithmetic -Equivalent to -.B \-prelude\ \'(declare\ (fixnum))\' -\. - -.TP -.BI \-heap\-size \ number -Sets the static heap-size of the generated executable to -.I number -bytes. The parameter may be -followed by a -.B M -or -.B K -suffix which stand for mega- and kilo-bytes, respectively. The default heap-size is 16 megabytes. - -.TP -.BI \-heap\-initial\-size \ number -Sets the size that the heap of the compiled application should have at startup time. - -.TP -.BI \-heap\-growth \ percentage -Sets the heap-growth rate for the compiled program at compile time. - -.TP -.BI \-heap\-shrinkage \ percentage -Sets the heap-shrinkage rate for the compiled program at compile time. - -.TP -.B \-help -Print a summary of available options and the format of the command-line -parameters and exit the compiler. - -.TP -.B \-ignore\-repository -Do not load any extensions from the repository (treat repository as empty). Also -do not consult compiled (only interpreted) import libraries in -.I import -forms. - -.TP -.BI \-import\ pathname -Read exports from linked or loaded libraries from given file. Implies -.B \-check\-imports - -.TP -.BI \-include\-path \ pathname -Specifies an additional search path for files included via the -.I include -special form. This option may be given multiple times. - -.TP -.B \-inline -Enables procedure inlining. - -.TP -.B \-inline\-global -Enable cross-module inlining. - -.TP -.BI \-inline\-limit \ threshold -Sets the maximum size of potentially inlinable procedures. - -.TP -.BI \-keep\-shadowed\-macros -Do not remove macro definitions with the same name as assigned toplevel -variables (the default is to remove the macro definition). - -.TP -.BI \-keyword\-style \ style -Enables alternative keyword syntax, where style may be either -.B prefix -(as in Common Lisp), -.B suffix -(as in DSSSL) or -.B none -Any other value is ignored. The default is -.B suffix -\. - -.TP -.B \-lambda\-lift -Enable the optimization known as lambda-lifting. - -.TP -.B \-local -Assume toplevel variables defined in the current compilation unit are -not externally modified. - -.TP -.B \-no\-trace -Disable generation of tracing information. If a compiled executable should halt -due to a runtime error, then a file containing a stack-trace will be written to -the current directory under the name -.I STACKTRACE -\. Each line in the created file gives the name and the line-number (if -available) of a procedure call. With this option given, the generated code is -slightly faster. - -.TP -.B \-no\-warnings -Disable generation of compiler warnings. - -.TP -.BI \-nursery \ number - -.TP -.BI \-stack\-size \ number -Sets the size of the first heap-generation of the generated executable to -.I number -bytes. The parameter may -be followed by a -.B M -or -.B K -suffix. The default stack-size depends on the target platform. - -.TP -.BI \-optimize\-leaf\-routines -Enable leaf routine optimization. - -.TP -.BI \-optimize\-level \ level -Enables certain sets of optimization options. -.I level -should be an integer. Each optimization level corresponds to a certain set of optimization option -as shown in the following list: -.P -.br -.B \ \ \ \ 0 -nothing -.br -.B \ \ \ \ 1 --optimize-leaf-routines -.br -.B \ \ \ \ 2 --optimize-leaf-routines -usual-integrations -.br -.B \ \ \ \ 3 --optimize-leaf-routines -usual-integrations -unsafe - -.TP -.BI \-output\-file \ filename -Specifies the pathname of the generated C file. Default is -.I FILENAME.c -\. - -.TP -.BI \-postlude \ expressions -Add -.I 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 -.BI \-epilogue -\. - -.TP -.BI \-prelude \ expressions -Add -.I expressions -before all other toplevel expressions in the compiled file. -This option may be given multiple times. Processing of this option takes place -before processing of -.B \-prologue -\. - -.TP -.B \-profile -.B \-accumulate\-profile -Instruments the source code to count procedure calls and execution times. After -the program terminates (either via an explicit -.B exit -or implicitly), profiling statistics are written to a file named -.B PROFILE.<PID> -where <PID> is the process ID of the program being profiled. -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 -.B chicken\-profile -program to display the profiling information in a more user-friendly form. - -.TP -.BI \-profile\-name \ filename -Specifies the name of the generated profile information file. Only useful -in combination with the -.B \-profile -or -.B \-accumulate-profile -options. - -.TP -.BI \-prologue \ filename -Includes the file named -.I filename -at the start of the compiled source file. -The include-path is not searched. This option may be given multiple times. - -.TP -.B \-release -Print release number and exit. - -.TP -.BI \-require\-extension \ name -Loads the syntax-extension -.I name -before the source program is processed. This is identical to adding -.B require\-extension\ NAME -at the start of -the compiled program. - -.TP -.B \-run\-time\-macros -Makes low-level macros (defined with -.B define\-macro -also available at run-time. By default -low-level macros are not available at run-time. Note that highlevel-macros ("syntax-case") -defined in compiled code are never available at run-time. - -.TP -.B \-to\-stdout -Write compiled code to standard output instead of creating a -.I .c -file. - -.TP -.BI \-unit \ name -Compile this file as a library unit. - -.TP -.B \-unsafe -Disable runtime safety checks. - -.TP -.B \-unsafe\-libraries -Marks the generated file for being linked with the unsafe runtime system. This -should be used when generating shared object files that are to be loaded -dynamically. If the marker is present, any attempt to load code compiled with -this option will signal an error. - -.TP -.BI \-uses \ name -Use definitions in the given library unit. - -.TP -.B \-usual\-integrations -Specifies that standard procedures and certain internal procedures are never redefined, and can -be inlined. This is equivalent to declaring -.I (usual\-integrations) -\. - -.TP -.B \-verbose -Prints progress information to standard output during compilation. - -.TP -.B \-version -Prints the version and some copyright information and exit the compiler. +Enter +.B chicken\ \-help +for a list of supported command-line options. .SH ENVIRONMENT\ VARIABLES diff --git a/csc.1 b/csc.1 index 4faa7654..be647451 100644 --- a/csc.1 +++ b/csc.1 @@ -23,7 +23,7 @@ compiler and the host systems C compiler to generate an executable from a Scheme source file or C files generated by .I CHICKEN For a list of options enter -.B csc \ \-help +.B csc\ \-help .SH ENVIRONMENT\ VARIABLES diff --git a/csi.1 b/csi.1 index 4f50f754..2efa0a76 100644 --- a/csi.1 +++ b/csi.1 @@ -32,121 +32,9 @@ compiler. .SH OPTIONS -.TP -.B \-\- -Ignore everything on the command-line following this marker. Runtime options -.B \-\:... -are still recognized. - -.TP -.B \-i\ \-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 -.B case\-insensitive -feature identifier. - -.TP -.B \-b\ \-batch -Quit the interpreter after processing all command line options. - -.TP -.BI \-e\ \-eval \ expressions -Evaluate -.I expressions -\. - -.TP -.BI \-p\ \-print \ expressions -Evaluate -.I expressions -and print result(s) -\. - -.TP -.BI \-P\ \-pretty-print \ expressions -Evaluate -.I expressions -and pretty-print result(s) -\. - -.BI \-D\ \-feature \ symbol -Registers -.I symbol -to be a valid feature identifier for -.B cond\-expand - -.TP -.B \-h\ \-help -Write a summary of the available command line options to standard ouput and exit. - -.TP -.BI \-I\ \-include\-path \ pathname -Specifies an alternative search-path for files included via the -.B include -special form. This option may be given multiple times. If the environment variable -.B CHICKEN_INCLUDE_PATH -is set, it should contain a list of alternative include -pathnames separated by -.B \; . - -.TP -.BI \-k\ \-keyword\-style style -Enables alternative keyword syntax, where style may be either -.B prefix -(as in Common Lisp), -.B suffix -(as in DSSSL) or -.B none -Any other value is ignored. The default is \texttt{suffix}. - -.TP -.B \-n\ \-no\-init -Do not load the initialization-file -.I ~/\.csirc -\. -If this option is not given and the file -.I ~/\.csirc -exists, then it is loaded before the read-eval-print loop commences. - -.TP -.B \-w\ \-no\-warnings -Disables any warnings that might be issued by the reader or evaluated code. - -.TP -.B \-q\ \-quiet -Do not print a startup message. - -.TP -.BI \-s\ \-script\ pathname -This is equivalent to -.B \-batch\ \-quiet -.I pathname -, but also ignores all arguments after the argument following -.B \-script - -.TP -.BI \-sx\ pathname -Similar to -.B \-script -but invokes prints each expression before it is evaluated, - -.TP -.BI \-ss\ pathname -Similar to -.B \-script -but invokes the procedure -.B main -after loading the file specified by -.B pathname -with a single argument (the list of command line arguments) returning any result as status code. - -.TP -.BI \-R\ \-require\-extension\ name -Require extension for evaluated code. - -.TP -.B \-v\ \-version -Write the banner with version information to standard output and exit. +Enter +.B csi \-help +for a list of supported command-line options. .SH ENVIRONMENT\ VARIABLESTrap