Changeset 9082 in project


Ignore:
Timestamp:
02/28/08 07:44:36 (12 years ago)
Author:
Ivan Raikov
Message:

chicken-setup documentation updates.

Location:
chicken/trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • chicken/trunk/chicken-setup.1

    r8361 r9082  
    11.\" dummy line
    2 .TH CHICKEN-SETUP 1 "25 Jan 2004"
     2.TH CHICKEN-SETUP 1 "28 Feb 2008"
    33
    44.SH NAME
     
    5050.SH OPTIONS
    5151
     52.TP
     53.B \-h,\ \-help     
     54Shows a summary of options and exits.
     55
     56.TP
     57.B \-V,\ \-version
     58Shows the version of
     59.I chicken-setup
     60and exits.
     61
     62.TP
     63.B \-release
     64Shows release number of CHICKEN and exits.
     65
     66.TP
     67.BI \-R,\ \-repository \ [PATH]         
     68If
     69.B PATH
     70is not given, prints the location of the extension repository.
     71If
     72.B PATH
     73is given, specifies the location for the extension repository
     74The default repository path is the installation library directory (usually
     75.I /usr/local/lib/chicken
     76, or (if set) the directory given in the environment variable
     77.I CHICKEN\_REPOSITORY
     78
     79.TP
     80.B \-u,\ \-uninstall
     81Removes the given extension from the repository.
     82
     83.TP
     84.BI \-H,\ \-host \ HOSTNAME[:PORT]
     85Specifies alternative host for downloading extensions.
     86.B PORT
     87may be omitted and defaults to 80.
     88
     89.TP
     90.BI \-p,\ \-proxy \ HOSTNAME[:PORT]
     91Connects to server via proxy.
     92.B PORT
     93may be omitted and defaults to 80.
     94
     95.TP
     96.B \-l,\ \-list
     97Lists all installed extensions and exits, or show extension-information
     98of extensions given on the command-line (following this option).
     99
     100.TP
     101.BI \-r,\ \-run \ FILENAME
     102Loads and executes given file.
     103
     104.TP
     105.BI \-P,\ \-program\-path \ [PATH]
     106If
     107.B PATH
     108is not given, prints the location where executable files will be installed.
     109If
     110.B PATH
     111is given, specifies the location for installing executable files.
     112
     113.TP
     114.BI  \-s,\ \-script \ FILENAME           
     115Executes the given script with remaining arguments and exits.
     116
     117.TP
     118.B \-f,\ \-fetch
     119Only download, don't extract, build or install.
     120
     121.TP
     122.B \-v,\ \-verbose
     123Displays additional information (mainly for debugging).
     124
     125.TP
     126.B \-k,\ \-keep
     127Keeps intermediate files after building and installing.
     128
    52129.TP
    53 .BI \-csc\-option option
     130.BI \-c,\ \-csc\-option \ option
    54131Passes
    55132.B option
     
    62139
    63140.TP
    64 .BI \-destdir\ pathname
    65 Specifies alternative installation prefix by setting the
    66 .B installation-prefix
    67 parameter.
    68 
    69 .TP
    70 .B \-docindex
    71 Displays the path to the index-page of any installed extension-documentation. If the index page
    72 does not exist, it is created.
    73 
    74 .TP
    75 .B \-dont\-ask
    76 Do not ask the user before trying to download required extensions.
    77 
    78 .TP
    79 .BI \-eval\ expression
    80 Evaluates the given expression(s).
    81 
    82 .TP
    83 .B \-fetch
    84 Only download, don't extract, build or install.
    85 
    86 .TP
    87 .B \-fetch\-tree
    88 Downloads and prints the repository catalog to stdout.
    89 
    90 .TP
    91 .B \-help
    92 Show usage information and exit.
    93 
    94 .TP
    95 .BI \-host\ hostname:port
    96 Specifies alternative host for downloading extensions.
    97 .B port
    98 may be omitted and defaults to 80.
    99 
    100 .TP
    101 .B \-keep
    102 Keep temporary files and directories.
    103 
    104 .TP
    105 .B \-list
    106 List all installed extensions and exit, or show extension-information of extensions given on the
    107 command-line (following this option).
    108 
    109 .TP
    110 .BI \-local\ path
    111 Fetch extension sources from local filesystem at
    112 .B path
    113 instead of downloading egg from egg server.
    114 
    115 .TP
    116 .B \-no\-install
    117 Do not install generated binaries and/or support files. Any invocations of
     141.B \-d,\ \-dont\-ask
     142Does not ask the user before trying to download required extensions.
     143
     144.TP
     145.BI \-n,\ \-no\-install
     146Does not install generated binaries and support files after building.
     147Any invocations of
    118148.I install\-program
    119149,
    120150.I install\-extension
     151,
     152.I install\-script
    121153or
    122 .I install\-script
    123 will be be no-ops.
    124 
    125 .TP
    126 .B \-program\-path
    127 Display the path where executables are installed.
    128 
    129 .TP
    130 .BI \-program\-path\ directory
    131 Sets the location where executables are installed.
    132 
    133 .TP
    134 .BI \-proxy\ hostname:port
    135 Connect to server via proxy.
    136 .B port
    137 may be omitted and defaults to 80.
    138 
    139 .TP
    140 .B \-repository
    141 Displays the name of the extension repository.
    142 
    143 .TP
    144 .BI \-repository\ directory
    145 Sets the location of the extension repository for all subsequent operations.
    146 The default repository path is the installation library directory (usually
    147 .I \/usr\/local\/lib\/chicken
    148 , or (if set) the directory given in the environment variable
    149 .I CHICKEN\_REPOSITORY
    150 
    151 .TP
    152 .BI \-revision\ revision
    153 Specifies the subversion revision that you want to check out (only useful in
    154 combination with the
    155 .B \-svn
    156 option).
    157 
    158 .TP
    159 .BI \-run\ filename
    160 Load and execute given file.
    161 
    162 .TP
    163 .BI \-script\ filename
    164 Executes the given Scheme source file with all remaining arguments and exit.
    165 
    166 .TP
    167 .BI \-svn\ url
    168 Fetch extension sources from Subversion (http://subversion.tigris.org) repository,
    169 instead of downloading egg from egg server.
    170 
    171 .TP
    172 .B \-test
    173 If the extension sources contain a directory named
     154.I copy\-file
     155will be no-ops.
     156
     157.TP
     158.B \-i,\ \-docindex
     159Displays the path to the index-page of any installed
     160extension-documentation. If the index page does not exist, it is
     161created.
     162
     163.TP
     164.BI \-e,\ \-eval \ EXPRESSION
     165Evaluates the given expression(s).
     166
     167.TP
     168.BI \-t,\ \-test
     169If the
     170.B .egg
     171extension archive contains a directory named
    174172.B tests
    175173and this directory includes a file named
     
    180178
    181179.TP
    182 .BI \-tree\ filename
     180.B \-host\-extension
     181Compiles any extensions in "host" mode.
     182
     183.TP
     184.BI \-ls \ EXTENSION
     185Lists the installed files for the given extension.
     186
     187.TP
     188.B \-fetch\-tree
     189Downloads and prints the repository catalog to standard output.
     190
     191.TP
     192.BI \-create\-tree \ PATH
     193Creates repository catalog from SVN checkout.
     194
     195.TP
     196.BI \-tree \ FILENAME
    183197Uses the repository catalog stored in
    184 .B filename
     198.B FILENAME
    185199instead of downloading it.
    186200
    187 .TP
    188 .B \-uninstall
    189 Removes all following extensions from repository.
    190 
    191 .TP
    192 .B \-verbose
    193 Display additional information (mainly for debugging).
    194 
    195 .TP
    196 .B \-version
    197 Display version and exit.
     201
     202.TP
     203.BI \-svn \ URL
     204Fetches extension sources from an SVN repository instead of
     205downloading egg from egg server.
     206
     207.TP
     208.BI \-local \ PATH
     209Fetches extension sources from the local filesystem at
     210.B PATH
     211instead of downloading egg from egg server.
     212
     213.TP
     214.BI \-destdir \ PATH
     215Specifies alternative installation prefix. This affects executable
     216files, examples, and files installed with the
     217.I copy-file
     218procedure.
     219
     220.TP
     221.BI \-revision \ REVISION
     222Specifies the SVN revision that to check out (only useful in
     223combination with the
     224.B \-svn
     225option).
     226
     227.TP
     228.BI \-build\-prefix \ PATH
     229Specifies the location where
     230.I chicken-setup
     231will create build directories. The default location is the value
     232of environment variable
     233.I CHICKEN_TMPDIR
     234,
     235.I TMPDIR
     236or
     237.I /tmp/chicken-{MAJOR-VERSION}-build-{USER}
     238if none of those variables are found in the environment. If
     239.I /tmp
     240does not exist or is not writeable, then the build directory is
     241.I {HOME}/tmp/chicken-{MAJOR-VERSION}-build-{USER}
     242.
     243
     244
     245.TP
     246.BI \-download\-dir \ PATH
     247Specifies the location where chicken-setup will save downloaded files
     248The default is
     249.I {BUILD-PREFIX}/downloads)
     250
    198251
    199252.TP
    200253.B \-\-
    201 Ignore all further arguments.
     254Ignores all further arguments.
    202255
    203256.SH ENVIRONMENT\ VARIABLES
     
    221274.B chicken\-setup
    222275.
     276
     277.TP
     278.B CHICKEN_TMPDIR
     279The location where egg files will be unpacked and extensions compiled.
    223280
    224281.SH DOCUMENTATION
  • chicken/trunk/chicken-setup.scm

    r9080 r9082  
    158158(define setup-build-prefix
    159159  (make-parameter
    160    (or (getenv "TMP") (getenv "TEMP") (getenv "TMPDIR") (getenv "TEMPDIR")
     160   (or (getenv "CHICKEN_TMPDIR") (getenv "TMPDIR")
    161161       ((lambda (user)
    162162          (and user  (file-write-access? "/tmp")
     
    172172(define setup-verbose-flag        (make-parameter #f))
    173173(define setup-install-flag        (make-parameter #t))
     174
    174175
    175176(define *copy-command* (if *windows-shell* 'copy "cp -r"))
     
    485486usage: chicken-setup [OPTION ...] FILENAME
    486487
    487   -h  -help                      show this text and exit
    488   -V  -version                   show version of this program and exit
    489       -release                   show release number and exit
     488  -h  -help                      shows this text and exits
     489  -V  -version                   shows version of this program and exits
     490      -release                   shows release number and exits
    490491  -R  -repository [PATH]         if PATH is not given, prints the location of the extension repository
    491492                                 if PATH is given, specifies the location for the extension repository
     
    493494  -H  -host HOSTNAME[:PORT]      specifies alternative host for downloading
    494495  -p  -proxy HOSTNAME[:PORT]     connects via proxy
    495   -l  -list [NAME ...]           lists installed extensions or show extension information
     496  -l  -list [NAME ...]           lists installed extensions or shows extension information
    496497  -r  -run FILENAME              loads and executes given file
    497498  -P  -program-path [PATH]       if PATH is not given, prints the location where executables will be installed
    498499                                 if PATH is given, specifies the location for installing executables
    499   -s  -script FILENAME           executes script with remaining arguments and exit
     500  -s  -script FILENAME           executes script with remaining arguments and exits
    500501  -f  -fetch                     only download, don't extract, build or install
    501502  -v  -verbose                   verbose mode
     
    522523      -download-dir PATH         location where chicken-setup will save downloaded files
    523524                                 (default: {build-prefix}/downloads)
    524   --                             ignore all following arguments
     525  --                             ignores all following arguments
    525526
    526527  Builds and installs extension libraries.
     
    11651166}
    11661167EOF
    1167                           )))
     1168    )))
    11681169    (with-output-to-file (doc-index)
    11691170      (lambda ()
     
    11991200                  string<?) ) )
    12001201          (display "</tbody></table></body></font></html>\n") ) ) ) ) )
    1201 
    12021202
    12031203;;; Output stuff
Note: See TracChangeset for help on using the changeset viewer.