RAMEN-COMPILE

NAME

ramen-compile - Compile each given source file into an executable.

SYNOPSIS

ramen compile [OPTION]... FILE...

ARGUMENTS

FILE (required)

Source files to compile.

OPTIONS

--as=NAME

Name under which to run this program.

--dessser-code-generator=never|try|force (absent=never or
RAMEN_DESSSER_CODE_GENERATOR env)

Controls the usage of the new experimental code generator using the dessser library.

--external-compiler (absent RAMEN_USE_EXTERNAL_COMPILER env)

Call external compiler rather than using embedded one.

--help[=FMT] (default=auto)

Show this help in format FMT. The value FMT must be one of ’auto', ’pager', ’groff' or ’plain'. With ’auto', the format is ’pager’ or ’plain' whenever the TERM env var is ’dumb' or undefined.

-L VAL, --lib-path=VAL (absent RAMEN_PATH env)

Path where to find other programs.

--max-simultaneous-compilations=VAL, --max-simult-compilations=VAL
(absent=4 or RAMEN_MAX_SIMULT_COMPILATIONS env)

Max number of compilations to perform simultaneously.

-o FILE, --output=FILE

Where to store the output.

-O VAL, --optimization-level=VAL (absent=1 or RAMEN_OPTIMIZATION_LEVEL
env)

Controls how much effort is spent trying to optimize generated code, from 0 (none) to 3 (max)

-r, --replace

If a program with the same name is already defined, replace it.

--solver=VAL, --smt-solver=VAL (absent=/usr/bin/z3 -t:90000 -smt2 %s or
RAMEN_SMT_SOLVER env)

Command to run the SMT solver (with %s in place of the SMT2 file name).

--users-dir=PATH (absent RAMEN_USERS_DIR env)

Where to find users directory (defaults to $RAMEN_DIR/confserver/users).

--version

Show version information.

COMMON OPTIONS

--colors=VAL (absent=always or RAMEN_COLORS env)

Whether or not to use colors in terminal output.

--confserver[=VAL] (default=localhost) (absent RAMEN_CONFSERVER env)

host:port of Ramen confserver.

--confserver-key=VAL (absent="" or RAMEN_CONFSERVER_KEY env)

File name where the confserver public key is stored.

-d, --debug (absent RAMEN_DEBUG env)

Increase verbosity.

-i VAL, --identity=VAL (absent RAMEN_CLIENT_IDENTITY env)

Location of the file storing user's identity

--initial-export-duration=VAL (absent=0. or RAMEN_INITIAL_EXPORT env)

How long to export a node output after startup before a client asks for it.

--libs=VAL, --bundle-dir=VAL (absent=/usr/local/libexec/bundle/ or
RAMEN_LIBS env)

Directory where to find libraries for the embedded compiler.

--local-experiments-config=FILE, --experiments-config=FILE (absent
RAMEN_EXPERIMENTS_CONFIG env)

Configuration file for local experiments (defaults to $RAMEN_DIR/experiments/v1/config).

--masters=VAL (absent RAMEN_MASTERS env)

Indicates that Ramen must run in distributed mode and what sites play the master role.

--persist-dir=PATH (absent=/tmp/ramen or RAMEN_DIR env)

Directory where are stored data persisted on disc.

--priv-key=VAL, --client-private-key=VAL (absent=<KEY> or
RAMEN_CLIENT_PRIV_KEY env)

File name where the client private key is stored. This file must not be readable or writable by others.

--pub-key=VAL, --client-public-key=VAL (absent="" or
RAMEN_CLIENT_PUB_KEY env)

File name where the client public key is stored.

-q, --quiet (absent RAMEN_QUIET env)

Decrease verbosity.

--reuse-prev-files (absent RAMEN_REUSE_PREV_FILES env)

Reuse existing source files.

-S, --keep-temp-files (absent RAMEN_KEEP_TEMP_FILES env)

Keep temporary files.

--seed=VAL, --rand-seed=VAL (absent RAMEN_RANDOM_SEED env)

Seed to initialize the random generator with (will use a random one if unset).

--site=VAL (absent HOSTNAME env)

The name of this site.

--username=VAL (absent USER env)

--variant=EXP1=VAR1,EXP2=VAR2... (absent RAMEN_VARIANTS env)

Force variants.

ENVIRONMENT

These environment variables affect the execution of compile:
HOSTNAME

See option --site.

RAMEN_CLIENT_IDENTITY

See option --identity.

RAMEN_CLIENT_PRIV_KEY

See option --priv-key.

RAMEN_CLIENT_PUB_KEY

See option --pub-key.

RAMEN_COLORS

See option --colors.

RAMEN_CONFSERVER

See option --confserver.

RAMEN_CONFSERVER_KEY

See option --confserver-key.

RAMEN_DEBUG

See option --debug.

RAMEN_DESSSER_CODE_GENERATOR

See option --dessser-code-generator.

RAMEN_DIR

See option --persist-dir.

RAMEN_EXPERIMENTS_CONFIG

See option --experiments-config.

RAMEN_INITIAL_EXPORT

See option --initial-export-duration.

RAMEN_KEEP_TEMP_FILES

See option --keep-temp-files.

RAMEN_LIBS

See option --bundle-dir.

RAMEN_MASTERS

See option --masters.

RAMEN_MAX_SIMULT_COMPILATIONS

See option --max-simultaneous-compilations.

RAMEN_OPTIMIZATION_LEVEL

See option --optimization-level.

RAMEN_PATH

See option --lib-path.

RAMEN_QUIET

See option --quiet.

RAMEN_RANDOM_SEED

See option --rand-seed.

RAMEN_REUSE_PREV_FILES

See option --reuse-prev-files.

RAMEN_SMT_SOLVER

See option --smt-solver.

RAMEN_USERS_DIR

See option --users-dir.

RAMEN_USE_EXTERNAL_COMPILER

See option --external-compiler.

RAMEN_VARIANTS

See option --variant.

USER

See option --username.