LinuxCommandLibrary

nim

nim

TLDR

Compile a source file

$ nim compile [path/to/file.nim]
copy


Compile and run a source file
$ nim compile -r [path/to/file.nim]
copy


Compile a source file with release optimizations enabled
$ nim compile -d:release [path/to/file.nim]
copy


Build a release binary optimized for low file size
$ nim compile -d:release --opt:size [path/to/file.nim]
copy


Generate HTML documentation for a module (output will be placed in the current directory)
$ nim doc [path/to/file.nim]
copy


Check a file for syntax and semantics
$ nim check [path/to/file.nim]
copy

DESCRIPTION

Nim Compiler Version 1.4.2 [Linux: amd64] Compiled at 2021-05-13 Copyright © 2006-2020 by Andreas Rumpf ::

nim command [options] [projectfile] [arguments]

Command:

compile, c

compile project with default code generator (C)

r

compile to $nimcache/projname, run with [arguments] using backend specified by `--backend` (default: c)

doc

generate the documentation for inputfile for backend specified by `--backend` (default: c)

Arguments:

arguments are passed to the program being run (if --run option is selected)

OPTIONS

-p, --path:PATH

add path to search paths

-d, --define:SYMBOL(:VAL)

define a conditional symbol (Optionally: Define the value for that symbol, see: "compile time define pragmas")

-u, --undef:SYMBOL

undefine a conditional symbol

-f, --forceBuild:on|off

force rebuilding of all modules

--stackTrace:on|off

turn stack tracing on|off

--lineTrace:on|off

turn line tracing on|off

--threads:on|off

turn support for multi-threading on|off

-x, --checks:on|off

turn all runtime checks on|off

-a, --assertions:on|off

turn assertions on|off

--opt:none|speed|size

optimize not at all or for speed|size Note: use -d:release for a release build!

--debugger:native

Use native debugger (gdb)

--app:console|gui|lib|staticlib

generate a console app|GUI app|DLL|static library

-r, --run

run the compiled program with given arguments

--fullhelp

show all command line switches

-h, --help

show this help

-v, --version

show detailed version information

Note, single letter options that take an argument require a colon. E.g. -p:PATH.

REPORTING BUGS

https://github.com/nim-lang/Nim/issues

SEE ALSO

The nim-doc package.

Copied to clipboard