From a4c8409944b686f214c79c299831839589b559c5 Mon Sep 17 00:00:00 2001 From: Bruce Hill Date: Sat, 30 Aug 2025 12:16:57 -0400 Subject: Update docs --- docs/tomo.1.md | 60 ++++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 39 insertions(+), 21 deletions(-) (limited to 'docs') diff --git a/docs/tomo.1.md b/docs/tomo.1.md index 3bf5e779..6fefad69 100644 --- a/docs/tomo.1.md +++ b/docs/tomo.1.md @@ -32,41 +32,59 @@ C code, which is then compiled using a C compiler of your choice. # OPTIONS -`-h`, `--help` -: Print the usage and exit. +`--changelog` +: Print the compiler change log and exit. -`-t`, `--transpile` -: Transpile the input files to C code without compiling them. +`--compile-exe`, `-e` +: Compile the input file to an executable. -`-c`, `--compile-obj` +`--compile-obj`, `-c` : Compile the input files to static objects, rather than running them. -`-e`, `--compile-exe` -: Compile the input file to an executable. - -`-L`, `--library` -: Compile the input files to a shared library file and header. +`--help`, `-h` +: Print the usage and exit. -`-I`, `--install` +`--install`, `-I` : Install the compiled executable or library. -`-C` **, `--show-codegen` ** +`--library`, `-L` +: Compile the input files to a shared library file and header. + +`--show-codegen` **, `-C` ** : Set a program (e.g. `cat` or `bat`) to display the generated code -`-O` **level**, `--optimization` **level** -: Set the optimization level. +`--force-rebuild`, `-f` +: Force rebuilding/recompiling. -`-v`, `--verbose` -: Print extra verbose output. +`--format` +: Autoformat a file and print it to standard output. -`--version` -: Print the compiler version and exit. +`--format-inplace` +: Autoformat a file in-place. -`--changelog` -: Print the compiler change log and exit. +`--optimization` **level**, `-O` **level** +: Set the optimization level. `--prefix` : Print the Tomo installation prefix and exit. -`-r`, `--run` +`--quiet`, `-q` +: Run in quiet mode. + +`--run`, `-r` : Run an installed tomo program from `~/.local/share/tomo_vX.Y/installed`. + +`--source-mapping=`, `-m=` **** +: Toggle whether source mapping should be enabled or disabled. + +`--transpile`, `-t` +: Transpile the input files to C code without compiling them. + +`--uninstall`, `-u` +: Uninstall a compiled executable or library. + +`--verbose`, `-v` +: Print extra verbose output. + +`--version` +: Print the compiler version and exit. -- cgit v1.2.3