mirror of
https://github.com/janet-lang/janet
synced 2024-12-13 02:00:26 +00:00
8162c64ca3
* I deleted Alt-H and Alt-L because Ctrl-F and Ctrl-B serve the same roles. * Ctrl-W, Alt-D, Alt-F, and Alt-B behave more similarly to the same key bindings on GNU readline. * Improved documentation of REPL keybindings on man page. * Home and End keys now work on more terminal environments. * Removed bindings for `Esc OH` and `Esc OF` because andrewchambers doesn't need those bindings and the bindings don't seem to make much sense for Home and End. `Esc O` is Single Shift Select of G3 Character Set in xterm. https://invisible-island.net/xterm/ctlseqs/ctlseqs.html
208 lines
5.3 KiB
Groff
208 lines
5.3 KiB
Groff
.TH JANET 1
|
|
.SH NAME
|
|
janet \- run the Janet language abstract machine
|
|
.SH SYNOPSIS
|
|
.B janet
|
|
[\fB\-hvsrpnqk\fR]
|
|
[\fB\-e\fR \fISOURCE\fR]
|
|
[\fB\-l\fR \fIMODULE\fR]
|
|
[\fB\-m\fR \fIPATH\fR]
|
|
[\fB\-c\fR \fIMODULE JIMAGE\fR]
|
|
[\fB\-\-\fR]
|
|
.BR script
|
|
.BR args ...
|
|
.SH DESCRIPTION
|
|
Janet is a functional and imperative programming language and bytecode interpreter.
|
|
It is a modern lisp, but lists are replaced by other data structures with better utility
|
|
and performance (arrays, tables, structs, tuples). The language also features bridging
|
|
to native code written in C, meta-programming with macros, and bytecode assembly.
|
|
|
|
There is a repl for trying out the language, as well as the ability to run script files.
|
|
This client program is separate from the core runtime, so Janet could be embedded
|
|
into other programs. Try Janet in your browser at https://janet-lang.org.
|
|
|
|
Implemented in mostly standard C99, Janet runs on Windows, Linux and macOS.
|
|
The few features that are not standard C99 (dynamic library loading, compiler
|
|
specific optimizations), are fairly straight forward. Janet can be easily ported to
|
|
most new platforms.
|
|
|
|
.SH REPL KEY-BINDINGS
|
|
|
|
.TP 16
|
|
.BR Home
|
|
Move cursor to the beginning of input line.
|
|
|
|
.TP 16
|
|
.BR End
|
|
Move cursor to the end of input line.
|
|
|
|
.TP 16
|
|
.BR Left/Right
|
|
Move cursor in input line.
|
|
|
|
.TP 16
|
|
.BR Up/Down
|
|
Go backwards and forwards through history.
|
|
|
|
.TP 16
|
|
.BR Tab
|
|
Complete current symbol, or show available completions.
|
|
|
|
.TP 16
|
|
.BR Delete
|
|
Delete one character after the cursor.
|
|
|
|
.TP 16
|
|
.BR Backspace
|
|
Delete one character before the cursor.
|
|
|
|
.TP 16
|
|
.BR Ctrl\-A
|
|
Move cursor to the beginning of input line.
|
|
|
|
.TP 16
|
|
.BR Ctrl\-B
|
|
Move cursor one character to the left.
|
|
|
|
.TP 16
|
|
.BR Ctrl\-E
|
|
Move cursor to the end of input line.
|
|
|
|
.TP 16
|
|
.BR Ctrl\-F
|
|
Move cursor one character to the right.
|
|
|
|
.TP 16
|
|
.BR Ctrl\-H
|
|
Delete one character before the cursor.
|
|
|
|
.TP 16
|
|
.BR Ctrl\-K
|
|
Delete everything after the cursor on the input line.
|
|
|
|
.TP 16
|
|
.BR Ctrl\-L
|
|
Clear the screen.
|
|
|
|
.TP 16
|
|
.BR Ctrl\-N/Ctrl\-P
|
|
Go forwards and backwards through history.
|
|
|
|
.TP 16
|
|
.BR Ctrl\-U
|
|
Delete everything before the cursor on the input line.
|
|
|
|
.TP 16
|
|
.BR Ctrl\-W
|
|
Delete one word before the cursor.
|
|
|
|
.TP 16
|
|
.BR Alt\-B/Alt\-F
|
|
Move cursor backwards and forwards one word.
|
|
|
|
.TP 16
|
|
.BR Alt\-D
|
|
Delete one word after the cursor.
|
|
|
|
.TP 16
|
|
.BR Alt\-,
|
|
Go to earliest item in history.
|
|
|
|
.TP 16
|
|
.BR Alt\-.
|
|
Go to last item in history.
|
|
|
|
.LP
|
|
|
|
The repl keybindings are loosely based on a subset of GNU readline, although
|
|
Janet does not use GNU readline internally for the repl. It is a limited
|
|
substitute for GNU readline, and does not handle
|
|
utf-8 input or other mutlibyte input well.
|
|
|
|
To disable the built-in repl input handling, pass the \fB\-s\fR option to Janet, and
|
|
use a program like rlwrap with Janet to provide input.
|
|
|
|
For key bindings that operate on words, a word is considered to be a sequence
|
|
of characters that does not contain whitespace.
|
|
|
|
.SH DOCUMENTATION
|
|
|
|
For more complete API documentation, run a REPL (Read Eval Print Loop), and use the doc macro to
|
|
see documentation on individual bindings.
|
|
|
|
.SH OPTIONS
|
|
.TP
|
|
.BR \-h
|
|
Shows the usage text and exits immediately.
|
|
|
|
.TP
|
|
.BR \-v
|
|
Shows the version text and exits immediately.
|
|
|
|
.TP
|
|
.BR \-s
|
|
Read raw input from stdin and forgo prompt history and other readline-like features.
|
|
|
|
.TP
|
|
.BR \-e\ code
|
|
Execute a string of Janet source. Source code is executed in the order it is encountered, so earlier
|
|
arguments are executed before later ones.
|
|
|
|
.TP
|
|
.BR \-n
|
|
Disable ANSI colors in the repl. Has no effect if no repl is run.
|
|
|
|
.TP
|
|
.BR \-r
|
|
Open a REPL (Read Eval Print Loop) after executing all sources. By default, if Janet is called with no
|
|
arguments, a REPL is opened.
|
|
|
|
.TP
|
|
.BR \-p
|
|
Turn on the persistent flag. By default, when Janet is executing commands from a file and encounters an error,
|
|
it will immediately exit after printing the error message. In persistent mode, Janet will keep executing commands
|
|
after an error. Persistent mode can be good for debugging and testing.
|
|
|
|
.TP
|
|
.BR \-q
|
|
Quiet output. Don't print a repl prompt or expression results to stdout.
|
|
|
|
.TP
|
|
.BR \-k
|
|
Don't execute a script, only compile it to check for errors. Useful for linting scripts.
|
|
|
|
.TP
|
|
.BR \-m\ syspath
|
|
Set the dynamic binding :syspath to the string syspath so that Janet will load system modules
|
|
from a directory different than the default. The default is set when Janet is built, and defaults to
|
|
/usr/local/lib/janet on Linux/Posix, and C:/Janet/Library on Windows. This option supersedes JANET_PATH.
|
|
|
|
.TP
|
|
.BR \-c\ source\ output
|
|
Precompiles Janet source code into an image, a binary dump that can be efficiently loaded later.
|
|
Source should be a path to the Janet module to compile, and output should be the file path of
|
|
resulting image. Output should usually end with the .jimage extension.
|
|
|
|
.TP
|
|
.BR \-l\ path
|
|
Load a Janet file before running a script or repl. Multiple files can be loaded
|
|
in this manner, and exports from each file will be made available to the script
|
|
or repl.
|
|
|
|
.TP
|
|
.BR \-\-
|
|
Stop parsing command line arguments. All arguments after this one will be considered file names
|
|
and then arguments to the script.
|
|
|
|
.SH ENVIRONMENT
|
|
|
|
.B JANET_PATH
|
|
.RS
|
|
The location to look for Janet libraries. This is the only environment variable Janet needs to
|
|
find native and source code modules. If no JANET_PATH is set, Janet will look in
|
|
the default location set at compile time.
|
|
.RE
|
|
|
|
.SH AUTHOR
|
|
Written by Calvin Rose <calsrose@gmail.com>
|