diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/libraries.md | 4 | ||||
| -rw-r--r-- | docs/tomo.1.md | 62 | ||||
| -rw-r--r-- | docs/versions.md | 2 |
3 files changed, 43 insertions, 25 deletions
diff --git a/docs/libraries.md b/docs/libraries.md index 69608ae3..79477070 100644 --- a/docs/libraries.md +++ b/docs/libraries.md @@ -151,7 +151,7 @@ that can be used by other Tomo projects. You can build a library by running If you additionally add the `-I` flag, Tomo will copy the entire directory (excluding files and directories that begin with `.` such as `.git`) into -`~/.local/share/tomo_vX.Y/installed/` (where `X` and `Y` are the major/minor +`~/.local/lib/tomo_vX.Y/` (where `X` and `Y` are the major/minor version of the compiler). ### Using Shared Libraries @@ -169,7 +169,7 @@ When you build and install a library, its version is determined from a [Versions](versions.md)). The library's version number is added to the file path where the library is installed, so if the library `foo` has version `v1.2`, then it will be installed to -`~/.local/share/tomo_vX.Y/installed/foo_v1.2/`. When using a library, you must +`~/.local/lib/tomo_vX.Y/foo_v1.2/`. When using a library, you must explicitly supply either the exact version in the `use` statement like this: `use foo_v1.2`, or provide a `modules.ini` file that lists version information and other details about modules being used. For each module, you should provide diff --git a/docs/tomo.1.md b/docs/tomo.1.md index 3bf5e779..79c94ddd 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` *<program>*, `--show-codegen` *<program>* +`--library`, `-L` +: Compile the input files to a shared library file and header. + +`--show-codegen` *<program>*, `-C` *<program>* : 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` -: Run an installed tomo program from `~/.local/share/tomo_vX.Y/installed`. +`--quiet`, `-q` +: Run in quiet mode. + +`--run`, `-r` +: Run an installed tomo program from `~/.local/lib/tomo_vX.Y/`. + +`--source-mapping=`, `-m=` **<yes|no>** +: 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. diff --git a/docs/versions.md b/docs/versions.md index c68d1f81..eb617f43 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -49,7 +49,7 @@ The version for the Tomo language itself will come into play in a few ways: (e.g. `~/.local/lib/libtomo_v1.2.so`) and headers (e.g. `~/.local/include/tomo_v1.2/tomo.h`). 4. Tomo libraries will be installed to a separate subdirectory for each version - of the compiler (e.g. `~/.local/share/tomo_v1.2/installed`). + of the compiler (e.g. `~/.local/lib/tomo_v1.2/`). ## Tomo Program Versions |