tomo/tomo.1

79 lines
2.2 KiB
Groff

.\" Automatically generated by Pandoc 3.1.11.1
.\"
.TH "TOMO" "1" "June 11, 2024" "" ""
.SH NAME
tomo \- The programming language of tomorrow.
.SH SYNOPSIS
.TP
Run the REPL:
\f[B]tomo\f[R]
.TP
Run a program:
\f[B]tomo\f[R] \f[I]program.tm\f[R] [[\f[B]\-\-\f[R]]
\f[I]args\&...\f[R]]
.TP
Transpile tomo files to C files:
\f[B]tomo\f[R] \f[B]\-t\f[R] \f[I]file1.tm\f[R] \f[I]file2.tm\f[R]\&...
.TP
Compile files to static object files:
\f[B]tomo\f[R] \f[B]\-c\f[R] \f[I]file1.tm\f[R] \f[I]file2.tm\f[R]\&...
.TP
Compile file to an executable:
\f[B]tomo\f[R] \f[B]\-e\f[R] \f[I]file1.tm\f[R]
.TP
Build a shared library:
\f[B]tomo\f[R] \f[B]\-s=\f[R]\f[I]mylib.1.2.3\f[R] \f[I]file1.tm\f[R]
\f[I]file2.tm\f[R]\&...
.SH DESCRIPTION
Tomo is a programming language that is statically typed, compiled,
small, and garbage\-collected, with concise syntax and built\-in support
for high\-performance, low\-overhead datastructures.
It compiles by first outputting C code, which is then compiled using a C
compiler of your choice.
.SH OPTIONS
.TP
\f[B]\-h\f[R], \f[B]\-\-help\f[R]
Print the usage and exit.
.TP
\f[B]\-t\f[R]
Transpile the input files to C code without compiling them.
.TP
\f[B]\-c\f[R]
Compile the input files to static objects, rather than running them.
.TP
\f[B]\-e\f[R]
Compile the input file to an executable.
.TP
\f[B]\-L\f[R]
Compile the input files to a library \f[B].so\f[R] file and header.
.TP
\f[B]\-I\f[R]
Install the compiled executable or library.
.TP
\f[B]\-C\f[R]
Print transpiled C code to the console.
.TP
\f[B]\-\-c\-compiler\f[R]
Set which C compiler is used.
.TP
\f[B]\-f\f[R], \f[B]\-\-autoformat\f[R]
Set which autoformat program is used.
.TP
\f[B]\-v\f[R], \f[B]\-\-verbose\f[R]
Print extra verbose output.
.TP
\f[B]\-q\f[R], \f[B]\-\-quiet\f[R]
Be extra quiet and do not print what the compiler is doing, only program
output.
.SS ENVIRONMENT VARIABLES
Some options can be configured by setting environment variables.
.TP
\f[B]CC=\f[R]\f[I]c\-compiler\f[R]
Set which C compiler is used.
.TP
\f[B]AUTOFMT=\f[R]\f[I]autoformatter\f[R]
The program used to autoformat generated C code.
Default: \f[B]indent \-kr \-l100 \-nbbo \-nut \-sob\f[R]
.SH AUTHORS
Bruce Hill (\f[I]bruce\[at]bruce\-hill.com\f[R]).