clone url: git://git.m455.casa/fa
esperbuild/espersrc/fennel-0.7.0/fennel.1
| 1 | .TH FENNEL 1 |
| 2 | |
| 3 | .SH NAME |
| 4 | fennel \- a lisp programming language that runs on Lua |
| 5 | .SH SYNOPSIS |
| 6 | .B fennel |
| 7 | [\fB--repl\fR] | |
| 8 | [\fB--compile \fIfilename\fR] | |
| 9 | [\fB--eval \fIsource\fR] | |
| 10 | [\fIfilename\fP] [\fIargs ...\fR] |
| 11 | |
| 12 | .SH DESCRIPTION |
| 13 | This manual page documents briefly the |
| 14 | .B fennel |
| 15 | command. |
| 16 | .PP |
| 17 | .B fennel |
| 18 | is the main entry point for Fennel, a lisp programming language that |
| 19 | runs on Lua runtimes. With no options or arguments, it runs an |
| 20 | interactive Read-Eval-Print loop (REPL). |
| 21 | .PP |
| 22 | Given a filename as its first argument, it runs that file and passes |
| 23 | it the subsequent arguments. Ahead-of-time compilation can be invoked |
| 24 | with the |
| 25 | .B --compile |
| 26 | flag. |
| 27 | |
| 28 | .SH OPTIONS |
| 29 | A summary of options is included below. |
| 30 | .TP |
| 31 | .B \-\-repl |
| 32 | Start an interactive repl session. |
| 33 | .TP |
| 34 | .B \-\-compile \fIfilename\fP |
| 35 | Perform ahead-of-time compilation on the provided file and write the |
| 36 | Lua output to stdout. |
| 37 | .TP |
| 38 | .B \-\-eval \fIsource\fP |
| 39 | Evaluate a piece of source code and print the result. |
| 40 | .TP |
| 41 | .B \-\-no-searcher |
| 42 | When running a repl or a file, |
| 43 | .B fennel.searcher |
| 44 | is installed by default so that the |
| 45 | .B require |
| 46 | function can load Fennel files in addition to Lua files. This flag |
| 47 | disables that behavior. Has no effect for ahead-of-time compilation. |
| 48 | .TP |
| 49 | .B \-\-indent \fIval\fP |
| 50 | When compiling, use the given string as indentation for the compiler |
| 51 | output. This should consist of whitespace. |
| 52 | .TP |
| 53 | .B \-\-add-package-path \fIpath\fP |
| 54 | Add the given path to |
| 55 | .B package.path |
| 56 | so that the |
| 57 | .B require |
| 58 | function will know to look there when searching for Lua modules. |
| 59 | .TP |
| 60 | .B \-\-add-fennel-path \fIpath\fP |
| 61 | Same as above, but for Fennel's path used when searching for Fennel |
| 62 | modules. |
| 63 | .TP |
| 64 | .B \-\-globals \fIVAR1[,VAR2...]\fP |
| 65 | Allow VAR1, VAR2, etc as globals in addition to the standard set of |
| 66 | globals. This enables strict global checking even in ahead-of-time |
| 67 | compilation where it otherwise would be disabled. |
| 68 | .TP |
| 69 | .B \-\-globals-only \fIVAR1[,VAR2...]\fP |
| 70 | Same as above, but without the addition of the standard set of globals. |
| 71 | .TP |
| 72 | .B \-\-require-as-include |
| 73 | Instead of loading required modules at runtime, compile them inline |
| 74 | into the main file being compiled. Only useful during ahead-of-time |
| 75 | compilation. |
| 76 | .TP |
| 77 | .B \-\-load \fIFILE\fP |
| 78 | Load the specified file before any command is run. |
| 79 | .TP |
| 80 | .B \-\-compile-binary \fIFILE\fP \fIOUT\fP \fILUA_LIB\fP \fILUA_DIR\fP |
| 81 | Compile FILE to a standalone binary OUT using LUA_LIB and the Lua |
| 82 | header files in LUA_DIR. See |
| 83 | .B \-\-compile-binary \-\-help |
| 84 | for details. |
| 85 | .TP |
| 86 | .B \-\-no\-compiler\-sandbox |
| 87 | Do not limit compiler environment to minimal sandbox. |
| 88 | .TP |
| 89 | .B \-h, \-\-help |
| 90 | Print a help message and exit |
| 91 | .TP |
| 92 | .B \-v, \-\-version |
| 93 | Print the version number and exit |
| 94 | |
| 95 | .SH DOCUMENTATION |
| 96 | |
| 97 | See https://fennel-lang.org for documentation on Fennel. The syntax is |
| 98 | based on the lisp family of languages while the semantics are very |
| 99 | close to Lua, so Lua's reference manual is helpful. |
| 100 | |
| 101 | .SH COMMUNITY |
| 102 | |
| 103 | The mailing list is at https://lists.sr.ht/~technomancy/fennel while |
| 104 | the issue tracker is at https://todo.sr.ht/~technomancy/fennel. |
| 105 | |
| 106 | .SH AUTHOR |
| 107 | Calvin Rose and contributors: |
| 108 | https://git.sr.ht/~technomancy/fennel/contributors |
| 109 | |
| 110 | .SH LICENSE |
| 111 | Copyright © 2016-2020, Released under the MIT/X11 license |