Commands

prepare

The prepare command only installs dependencies for a component. It can be used like this:

rbuild prepare -d $deps_dir

This requires $deps_dir to be passed in, which is a directory used to install any dependencies to. No build directory is created for this command.

-d, --deps-dir <directory>

Directory for the third-party dependencies. This flag is always required.

-S, --source-dir <directory>

Directory of the source code. If no directory is provided it will use the current working directory.

-t, --toolchain <directory>

Set cmake toolchain file to use

--cxx <executable>

Set c++ compiler

--cc <executable>

Set c compiler

-D, --define <TEXT>

Extra cmake variables to define. Since this will only build the dependencies, these variables will be set for building dependencies only and will not apply to building the project.

-s, --session <name>

Pick the session to use. If no session is specified it will use the main session.

build

To build a component:

rbuild build -d $deps_dir

This requires $deps_dir to be passed in, which is a directory used to install any dependencies to. The final result of the build will be in the build directory, but can be overwritten with the -B flag.

-d, --deps-dir <directory>

Directory for the third-party dependencies. This flag is always required.

-S, --source-dir <directory>

Directory of the source code. If no directory is provided it will use the current working directory.

-t, --toolchain <directory>

Set cmake toolchain file to use

--cxx <executable>

Set c++ compiler

--cc <executable>

Set c compiler

-D, --define <TEXT>

Extra cmake variables to define. These variables will be set for the building of the project-only and it will not apply to dependencies.

-s, --session <name>

Pick the session to use. If no session is specified it will use the main session.

-T, --target <target>

Target to build. By default, it builds the all target, but this flag can be specified to build other targets. This can be passed multiple targets to build.

package

To build the packages for a component:

rbuild package -d $deps_dir

This requires $deps_dir to be passed in, which is a directory used to install any dependencies to. The final result of the packages will be in the build directory, but can be overwritten with the -B flag.

-d, --deps-dir <directory>

Directory for the third-party dependencies. This flag is always required.

-S, --source-dir <directory>

Directory of the source code. If no directory is provided it will use the current working directory.

-t, --toolchain <directory>

Set cmake toolchain file to use

--cxx <executable>

Set c++ compiler

--cc <executable>

Set c compiler

-D, --define <TEXT>

Extra cmake variables to define. These variables will be set for the building of the project-only and it will not apply to dependencies.

-s, --session <name>

Pick the session to use. If no session is specified it will use the main session.

develop

The develop command can be used to setup an environment for development. It will install all development dependencies and then configure cmake if a build directory is passed in:

rbuild develop -d $deps_dir -B $build_dir

This requires $deps_dir to be passed in, which is a directory used to install any dependencies to. The $build_dir is a directory that will be configured with cmake. If this is not passed in, no build directory will be configured.

-d, --deps-dir <directory>

Directory for the third-party dependencies. This flag is always required.

-S, --source-dir <directory>

Directory of the source code. If no directory is provided it will use the current working directory.

-t, --toolchain <directory>

Set cmake toolchain file to use

--cxx <executable>

Set c++ compiler

--cc <executable>

Set c compiler

-D, --define <TEXT>

Extra cmake variables to define. These variables will be set for the building of the project-only and it will not apply to dependencies.

-s, --session <name>

Pick the session to use. If no session is specified it will first try to use the develop session otherwise it will use the main session.