comparison doc/manual.tex @ 1850:30c56e3bcf47

Plugging some gaps in the manual
author Adam Chlipala <adam@chlipala.net>
date Sun, 21 Apr 2013 10:17:43 -0400
parents e15234fbb163
children c44bfaa69dd8
comparison
equal deleted inserted replaced
1849:3005c66b70e8 1850:30c56e3bcf47
150 \item \texttt{jsFunc Module.ident=name} gives the JavaScript name of an FFI value. 150 \item \texttt{jsFunc Module.ident=name} gives the JavaScript name of an FFI value.
151 \item \texttt{library FILENAME} parses \texttt{FILENAME.urp} and merges its contents with the rest of the current file's contents. If \texttt{FILENAME.urp} doesn't exist, the compiler also tries \texttt{FILENAME/lib.urp}. 151 \item \texttt{library FILENAME} parses \texttt{FILENAME.urp} and merges its contents with the rest of the current file's contents. If \texttt{FILENAME.urp} doesn't exist, the compiler also tries \texttt{FILENAME/lib.urp}.
152 \item \texttt{limit class num} sets a resource usage limit for generated applications. The limit \texttt{class} will be set to the non-negative integer \texttt{num}. The classes are: 152 \item \texttt{limit class num} sets a resource usage limit for generated applications. The limit \texttt{class} will be set to the non-negative integer \texttt{num}. The classes are:
153 \begin{itemize} 153 \begin{itemize}
154 \item \texttt{cleanup}: maximum number of cleanup operations (e.g., entries recording the need to deallocate certain temporary objects) that may be active at once per request 154 \item \texttt{cleanup}: maximum number of cleanup operations (e.g., entries recording the need to deallocate certain temporary objects) that may be active at once per request
155 \item \texttt{database}: maximum size of database files (currently only used by SQLite) 155 \item \texttt{clients}: maximum number of simultaneous connections to one application by web clients waiting for new asynchronous messages sent with \texttt{Basis.send}
156 \item \texttt{database}: maximum size of a database file (currently only used by SQLite, which interprets the parameter as a number of pages, where page size is itself a quantity configurable in SQLite)
156 \item \texttt{deltas}: maximum number of messages sendable in a single request handler with \texttt{Basis.send} 157 \item \texttt{deltas}: maximum number of messages sendable in a single request handler with \texttt{Basis.send}
157 \item \texttt{globals}: maximum number of global variables that FFI libraries may set in a single request context 158 \item \texttt{globals}: maximum number of global variables that FFI libraries may set in a single request context
158 \item \texttt{headers}: maximum size (in bytes) of per-request buffer used to hold HTTP headers for generated pages 159 \item \texttt{headers}: maximum size (in bytes) of per-request buffer used to hold HTTP headers for generated pages
159 \item \texttt{heap}: maximum size (in bytes) of per-request heap for dynamically allocated data 160 \item \texttt{heap}: maximum size (in bytes) of per-request heap for dynamically allocated data
160 \item \texttt{inputs}: maximum number of top-level form fields per request 161 \item \texttt{inputs}: maximum number of top-level form fields per request
259 \end{itemize} 260 \end{itemize}
260 261
261 \item \texttt{-dumpSource}: When compilation fails, output to stderr the complete source code of the last intermediate program before the compilation phase that signaled the error. (Warning: these outputs can be very long and aren't especially optimized for readability!) 262 \item \texttt{-dumpSource}: When compilation fails, output to stderr the complete source code of the last intermediate program before the compilation phase that signaled the error. (Warning: these outputs can be very long and aren't especially optimized for readability!)
262 263
263 \item \texttt{-limit class num}: Equivalent to the \texttt{limit} directive from \texttt{.urp} files 264 \item \texttt{-limit class num}: Equivalent to the \texttt{limit} directive from \texttt{.urp} files
265
266 \item \texttt{-moduleOf FILENAME}: Prints the Ur/Web module name corresponding to source file \texttt{FILENAME}, exiting immediately afterward.
264 267
265 \item \texttt{-output FILENAME}: Set where the application executable is written. 268 \item \texttt{-output FILENAME}: Set where the application executable is written.
266 269
267 \item \texttt{-path NAME VALUE}: Set the value of path variable \texttt{\$NAME} to \texttt{VALUE}, for use in \texttt{.urp} files. 270 \item \texttt{-path NAME VALUE}: Set the value of path variable \texttt{\$NAME} to \texttt{VALUE}, for use in \texttt{.urp} files.
268 271