51 lines
2.4 KiB
Groff
51 lines
2.4 KiB
Groff
.TH "felise" 1 "15 JUN 2023" "" "General Operation Manual"
|
|
.SH NAME
|
|
felise - programming language and interpreter
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.fam C
|
|
\fBfelise\fP [\fIoptions\fP] [\fIscript\fP [\fIargs\fP]]
|
|
.fam T
|
|
.fi
|
|
.SH DESCRIPTION
|
|
\fBfelise\fP is the interpreter implementation of the \fBfelise\fP programming language. The language sits in-between concatenative, procedural, and functional styles. It loads and executes felise programs in the form of textual source code and can also be used interactively as a REPL.
|
|
.TP
|
|
The options, see below, passed to the interpreter are executed followed by the felise program in the given script file. The args passed to the script are available as a list of strings held in the variable \fIsys-args\fP.
|
|
.TP
|
|
Interactive mode is accessed when no file is passed to the interpreter. In this mode \fBfelise\fP prompts the user, reads lines from stdin, and executes them as they are read. If a line ends in \\ a secondary prompt is displayed and lines are read until a line does not end in \\.
|
|
.TP
|
|
The repl supports GNU readline-style key commands (up/down to move between previous entries, ^a to move to the beginning of the line, ^e to move to the end, etc).
|
|
.SH OPTIONS
|
|
.TP
|
|
.B
|
|
\fB-h\fP
|
|
Display usage help and exit. Provides a list of all command line options with a short description and exits.
|
|
.TP
|
|
.B
|
|
\fB-r\fP
|
|
When using the REPL, use raw input from stdin rather than a readline-like input. This will let you input any characters, but will require ^D to submit the code. Useful for writing longer programs/procedures at the REPL.
|
|
.TP
|
|
.B
|
|
\fB-v\fP
|
|
Prints the version number and exits.
|
|
.TP
|
|
.B
|
|
\fB-debug\fP
|
|
Turns on debug mode, enabling interpreter warnings
|
|
.SH FILES & SYSTEM VARS
|
|
\fBfelise\fP sourc code files, by convention, have the file extension \fI.fe\fP.
|
|
.SH BUGS
|
|
There are bugs. Have fun!
|
|
.SH LINKS
|
|
\fBfelise\fP maintains a presence in the following locations:
|
|
.TP
|
|
.B
|
|
Source Code Repository
|
|
https://tildegit.org/sloum/felise
|
|
.SH COPYRIGHT
|
|
Copyright (C) 2023 Brian Evans
|
|
.TP
|
|
You can redistribute it and/or modify it under the terms of the Floodgap Free Software License (FFSL). You should have received a copy of the Floodgap Free Software License along with the source for felise; see the file LICENSE. If not, the terms of version 1 of the license (the applicable version) are available at http://www.floodgap.com/software/ffsl/license.txt
|
|
.SH AUTHORS
|
|
\fBfelise\fP is developed by sloum
|