Changeset 13015 in project for chicken


Ignore:
Timestamp:
01/16/09 00:25:08 (11 years ago)
Author:
Kon Lovett
Message:

Added runtime commandline options. Minor fixes to options w/ arguments.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • chicken/trunk/chicken.1

    r12797 r13015  
    3737.TP
    3838.B \-block
    39 Enable block-compilation. When this option is specified, the compiler assumes that global variables are not modified outside this compilation-unit.
     39Enable block-compilation. When this option is specified, the compiler assumes
     40that global variables are not modified outside this compilation-unit.
    4041
    4142.TP
    4243.B \-case\-insensitive
    43 Enables the reader to read symbols case-insensitive. The default is to read case-sensitive (in violation of R5RS).
     44Enables the reader to read symbols case-insensitive. The default is to read
     45case-sensitive (in violation of R5RS).
    4446This option registers the
    4547.B case\-insensitive
     
    5658.TP
    5759.BI \-database\-size \ number
    58 Specifies the initial size of the analysis-database. Should only be used if extremely large files are to be compiled.
     60Specifies the initial size of the analysis-database. Should only be used if
     61extremely large files are to be compiled.
    5962
    6063.TP
     
    8992.B \-disable\-interrupts
    9093Equivalent to
    91 .B \-prelude\ "(declare\ (interrupts-disabled))"
     94.B \-prelude\ \'(declare\ (interrupts-disabled))\'
     95\.
    9296
    9397.TP
     
    96100
    97101.TP
    98 .B \-disable\-warning\ class
     102.BI \-disable\-warning \ class
    99103Disables specific class of warnings, may be given multiple times.
    100104
     
    112116
    113117.TP
    114 .I \-emit\-debug\-info
     118.B \-emit\-debug\-info
    115119Emit additional information for each
    116120.B lambda
     
    119123
    120124.TP
    121 .BI \-emit\-exports\ filename
     125.BI \-emit\-exports \ filename
    122126Write exported toplevel variables to file
    123 .B filename
    124 
    125 .TP
    126 .I \-emit\-external\-prototypes\-first
     127.I filename
     128\.
     129
     130.TP
     131.B \-emit\-external\-prototypes\-first
    127132Emit prototypes for callbacks defined with
    128133.B define\-external
     
    133138
    134139.TP
    135 .I \-emit\-inline\-file\ FILENAME
    136 Write procedures that can be globally inlined in internal form to FILENAME,
    137 if global inlining is enabled. Implies "-inline -local".
     140.BI \-emit\-inline\-file \ filename
     141Write procedures that can be globally inlined in internal form to
     142.I filename
     143, if global inlining is enabled. Implies "-inline -local".
    138144
    139145.TP
     
    148154.TP
    149155.BI \-extend \ filename
    150 Loads a Scheme file before compilation commences. This feature can be used to extend the compiler.
     156Loads a Scheme file,
     157.I filename
     158, before compilation commences. This feature can be used to extend the compiler.
    151159
    152160.TP
    153161.B \-extension
    154162Mostly equivalent to
    155 .B \-prelude\ \'\(define-extension\ NAME\)\'
     163.B \-prelude\ \'(define-extension\ NAME)\'
    156164where
    157165.B NAME
    158166is the basename of the currently compiled file. Note that if you want to compile a file
    159167as a normal (dynamically loadable) extension library, you should also pass the
    160 .I \-shared
     168.B \-shared
    161169option.
    162170
     
    171179.B \-fixnum\-arithmetic
    172180Equivalent to
    173 .B \-prelude\ "(declare\ (fixnum))"
     181.B \-prelude\ \'(declare\ (fixnum))\'
     182\.
    174183
    175184.TP
     
    182191or
    183192.B K
    184 suffix which stand for mega- and kilobytes, respectively. The default heap-size is 16 megabytes.
     193suffix which stand for mega- and kilo-bytes, respectively. The default heap-size is 16 megabytes.
    185194
    186195.TP
     
    198207.TP
    199208.B \-help
    200 Print a summary of available options and the format of the command-line parameters and exit the compiler.
     209Print a summary of available options and the format of the command-line
     210parameters and exit the compiler.
    201211
    202212.TP
     
    204214Do not load any extensions from the repository (treat repository as empty). Also
    205215do not consult compiled (only interpreted) import libraries in
    206 .B import
     216.I import
    207217forms.
    208218
     
    216226Specifies an additional search path for files included via the
    217227.I include
    218 special form. This option may be given multiple times. If the environment variable
    219 .B CHICKEN_INCLUDE_PATH
    220 is set, it should contain a list of alternative include
    221 pathnames separated by
    222 .I \;
    223 \.
     228special form. This option may be given multiple times.
    224229
    225230.TP
     
    232237
    233238.TP
    234 .BI \-inline\-limit threshold
     239.BI \-inline\-limit \ threshold
    235240Sets the maximum size of potentially inlinable procedures.
    236241
    237242.TP
    238243.BI \-keep\-shadowed\-macros
    239 Do not remove macro definitions with the same name as assigned toplevel variables (the default is to remove the macro definition).
    240 
    241 .TP
    242 .BI \-keyword\-style style
     244Do not remove macro definitions with the same name as assigned toplevel
     245variables (the default is to remove the macro definition).
     246
     247.TP
     248.BI \-keyword\-style \ style
    243249Enables alternative keyword syntax, where style may be either
    244250.B prefix
     
    247253(as in DSSSL) or
    248254.B none
    249 Any other value is ignored. The default is \texttt{suffix}.
     255Any other value is ignored. The default is
     256.B suffix
     257\.
    250258
    251259.TP
     
    260268.TP
    261269.B \-no\-trace
    262 Disable generation of tracing information. If a compiled executable should halt due to a runtime error,
    263 then a file containing a stack-trace will be written to the current directory under the name
     270Disable generation of tracing information. If a compiled executable should halt
     271due to a runtime error, then a file containing a stack-trace will be written to
     272the current directory under the name
    264273.I STACKTRACE
    265 \. Each line in the created file gives the name and the line-number (if available) of a procedure call.
    266 With this option given, the generated code is slightly faster.
     274\. Each line in the created file gives the name and the line-number (if
     275available) of a procedure call. With this option given, the generated code is
     276slightly faster.
    267277
    268278.TP
     
    272282.TP
    273283.BI \-nursery \ number
     284
    274285.TP
    275286.BI \-stack\-size \ number
     
    318329.I expressions
    319330after all other toplevel expressions in the compiled file.
    320 This option may be given multiple times. Processing of this option takes place after processing of
     331This option may be given multiple times. Processing of this option takes place
     332after processing of
    321333.BI \-epilogue
    322334\.
     
    327339.I expressions
    328340before all other toplevel expressions in the compiled file.
    329 This option may be given multiple times. Processing of this option takes place before processing of
     341This option may be given multiple times. Processing of this option takes place
     342before processing of
    330343.B \-prologue
    331344\.
     
    334347.B \-profile
    335348.B \-accumulate\-profile
    336 Instruments the source code to count procedure calls and execution times. After the program terminates
    337 (either via an explicit
     349Instruments the source code to count procedure calls and execution times. After
     350the program terminates (either via an explicit
    338351.B exit
    339352or implicitly), profiling statistics are written to a file named
     
    346359
    347360.TP
    348 .B \-profile\-name\ filename
     361.BI \-profile\-name \ filename
    349362Specifies the name of the generated profile information file. Only useful
    350363in combination with the
     
    380393also available at run-time. By default
    381394low-level macros are not available at run-time. Note that highlevel-macros ("syntax-case")
    382  defined in compiled code are never available at run-time.
     395defined in compiled code are never available at run-time.
    383396
    384397.TP
     
    430443.TP
    431444.B CHICKEN_INCLUDE_PATH
    432 Contains one or more pathnames where the compiler should additionally look for include-files, separated by
     445Contains one or more pathnames where the compiler should additionally look for
     446include-files, separated by
    433447.B \;
    434448characters.
     
    440454\.
    441455
     456.SH RUNTIME\ OPTIONS
     457After successful compilation a C source file is generated and can be compiled
     458with a C compiler. Executables generated with
     459.B chicken
     460(and the
     461.B chicken
     462program itself) accept a small set of runtime options.
     463
     464.TP
     465.B \-:?
     466Shows a list of the available runtime options and exits the program.
     467
     468.TP
     469.B \-:aNUMBER
     470Specifies the length of the buffer for recording a trace of the last invoked
     471procedures. Defaults to 8.
     472
     473.TP
     474.B \-:b
     475Enter a read-eval-print-loop when an error is encountered.
     476
     477.TP
     478.B \-:B
     479Sounds a bell (ASCII 7) on every major garbage collection.
     480
     481.TP
     482.B \-:c
     483Forces console mode. Currently this is only used in the interpreter (csi) to
     484force output of the
     485.I #;N>
     486prompt even if stdin is not a terminal (for example if running in an emacs buffer under Windows).
     487
     488.TP
     489.B \-:d
     490Prints some debug-information at runtime.
     491
     492.TP
     493.B \-:D
     494Prints some more debug-information at runtime.
     495
     496.TP
     497.B \-:fNUMBER
     498Specifies the maximal number of currently pending finalizers before finalization is forced.
     499
     500.TP
     501.B \-:hNUMBER
     502Specifies fixed heap size
     503
     504.TP
     505.B \-:hgPERCENTAGE
     506Sets the growth rate of the heap in percent. If the heap is exhausted, then it
     507will grow by
     508.B PERCENTAGE
     509\. The default is 200.
     510
     511.TP
     512.B \-:hiNUMBER
     513Specifies the initial heap size
     514
     515.TP
     516.B \-:hmNUMBER
     517Specifies a maximal heap size. The default is (2GB - 15).
     518
     519.TP
     520.B \-:hsPERCENTAGE
     521Sets the shrink rate of the heap in percent. If no more than a quarter of
     522.B PERCENTAGE
     523of the heap is used, then it will shrink to
     524.B PERCENTAGE
     525\. The default
     526is 50. Note: If you want to make sure that the heap never shrinks, specify a
     527value of 0. (this can be useful in situations where an optimal heap-size is
     528known in advance).
     529
     530.TP
     531.B \-:o
     532Disables detection of stack overflows at run-time.
     533
     534.TP
     535.B \-:r
     536Writes trace output to stderr. This option has no effect with in files compiled with the
     537.B -no-trace
     538options.
     539
     540.TP
     541.B \-:sNUMBER
     542Specifies stack size.
     543
     544.TP
     545.B \-:tNUMBER
     546Specifies symbol table size.
     547
     548.TP
     549.B \-:w
     550Enables garbage collection of unused symbols. By default unused and unbound
     551symbols are not garbage collected.
     552
     553.TP
     554.B \-:x
     555Raises uncaught exceptions of separately spawned threads in primordial thread.
     556By default uncaught exceptions in separate threads are not handled, unless the
     557primordial one explicitly joins them. When warnings are enabled (the default)
     558and
     559.B \-:x
     560is not given, a warning will be shown, though.
     561
     562.P
     563The
     564.B NUMBER
     565argument values may be given in bytes, in kilobytes (suffixed with K or k),
     566in megabytes (suffixed with M or m), or in gigabytes (suffixed with G or g).
     567Runtime options may be combined, like
     568.B \-:dc
     569, but everything following a
     570.B NUMBER
     571argument is ignored. So
     572.B \-:wh64m
     573is OK, but
     574.B \-:h64mw
     575will not enable GC of unused symbols.
     576
    442577.SH DOCUMENTATION
    443578
Note: See TracChangeset for help on using the changeset viewer.