tomo.1 - tomo

(91 lines)
   1 .\" Automatically generated by Pandoc 3.5
   2 .\"
   3 .TH "TOMO" "1" "June 11, 2024" ""
   4 .SH NAME
   5 tomo \- The programming language of tomorrow.
   6 .SH SYNOPSIS
   7 .TP
   8 Run a program:
   9 \f[B]tomo\f[R] \f[I]program.tm\f[R] [[\f[B]\-\-\f[R]]
  10 \f[I]args\&...\f[R]]
  11 .TP
  12 Transpile tomo files to C files:
  13 \f[B]tomo\f[R] \f[B]\-t\f[R] \f[I]file1.tm\f[R] \f[I]file2.tm\f[R]\&...
  14 .TP
  15 Compile files to static object files:
  16 \f[B]tomo\f[R] \f[B]\-c\f[R] \f[I]file1.tm\f[R] \f[I]file2.tm\f[R]\&...
  17 .TP
  18 Compile files to a executables:
  19 \f[B]tomo\f[R] \f[B]\-e\f[R] \f[I]file1.tm\f[R] \f[I]file2.tm\f[R]\&...
  20 .TP
  21 Build a package:
  22 \f[B]tomo\f[R] \f[B]\-p\f[R] \f[I]file1.tm\f[R] \f[I]file2.tm\f[R]\&...
  23 .SH DESCRIPTION
  24 Tomo is a programming language that is statically typed, compiled,
  25 small, and garbage\-collected, with concise syntax and built\-in support
  26 for high\-performance, low\-overhead datastructures.
  27 It compiles by first outputting C code, which is then compiled using a C
  28 compiler of your choice.
  29 .SH OPTIONS
  30 .TP
  31 \f[B]\-\-changelog\f[R]
  32 Print the compiler change log and exit.
  33 .TP
  34 \f[B]\-\-transpile\f[R], \f[B]\-t\f[R] \f[I]file1.tm\f[R] \f[I]file2.tm\f[R]\&...
  35 Transpile the given files to C.
  36 .TP
  37 \f[B]\-\-compile\-exe\f[R], \f[B]\-e\f[R] \f[I]file1.tm\f[R] \f[I]file2.tm\f[R]\&...
  38 Compile the given files to executables.
  39 .TP
  40 \f[B]\-\-compile\-obj\f[R], \f[B]\-c\f[R] \f[I]file1.tm\f[R] \f[I]file2.tm\f[R]\&...
  41 Compile the given files to static objects.
  42 .TP
  43 \f[B]\-\-help\f[R], \f[B]\-h\f[R]
  44 Print the usage and exit.
  45 .TP
  46 \f[B]\-\-package\f[R], \f[B]\-p\f[R] \f[I]folder1\f[R] \f[I]folder2\f[R]\&...
  47 Compile the input folders to shared packages.
  48 .TP
  49 \f[B]\-\-install\f[R], \f[B]\-I\f[R]
  50 When using \f[B]\-e\f[R] or \f[B]\-L\f[R], install the resulting
  51 executables or packages.
  52 .TP
  53 \f[B]\-\-show\-codegen\f[R] \f[I]\f[R], \f[B]\-C\f[R] \f[I]\f[R]
  54 Set a program (e.g.\ \f[B]cat\f[R] or \f[B]bat\f[R]) to display the
  55 generated code
  56 .TP
  57 \f[B]\-\-force\-rebuild\f[R], \f[B]\-f\f[R]
  58 Force rebuilding/recompiling.
  59 .TP
  60 \f[B]\-\-format\f[R] \f[I]file1.tm\f[R] \f[I]file2.tm\f[R]\&...
  61 Autoformat the given files and print them to standard output.
  62 .TP
  63 \f[B]\-\-format\f[R] \f[I]file1.tm\f[R] \f[I]file2.tm\f[R]\&...
  64 Autoformat the given files in\-place and overwrite the original files.
  65 .TP
  66 \f[B]\-\-optimization\f[R] \f[B]level\f[R], \f[B]\-O\f[R] \f[B]level\f[R]
  67 Set the optimization level.
  68 .TP
  69 \f[B]\-\-prefix\f[R]
  70 Print the Tomo installation prefix and exit.
  71 .TP
  72 \f[B]\-\-quiet\f[R], \f[B]\-q\f[R]
  73 Run in quiet mode.
  74 .TP
  75 \f[B]\-\-run\f[R], \f[B]\-r\f[R]
  76 Run an installed tomo program from
  77 \f[B]\[ti]/.local/lib/tomo_vX.Y/\f[R].
  78 .TP
  79 \f[B]\-\-source\-mapping=\f[R], \f[B]\-m=\f[R] \f[B]<yes|no>\f[R]
  80 Toggle whether source mapping should be enabled or disabled.
  81 .TP
  82 \f[B]\-\-uninstall\f[R], \f[B]\-u\f[R] \f[I]pkg1\f[R] \f[I]pkg2\f[R]\&...
  83 Uninstall the given packages.
  84 .TP
  85 \f[B]\-\-verbose\f[R], \f[B]\-v\f[R]
  86 Print extra verbose output.
  87 .TP
  88 \f[B]\-\-version\f[R]
  89 Print the compiler version and exit.
  90 .SH AUTHORS
  91 Bruce Hill (\f[I]bruce\[at]bruce\-hill.com\f[R]).