catkin build doc

gistfile1.txt

[moldy-crow:~/versioned/catkin_tools]$ catkin build -h                        (metadata-file) 
usage: catkin build [-h] [--workspace WORKSPACE] [--profile PROFILE]
                    [--list-only] [--no-deps] [--start-with PKGNAME]
                    [--source SOURCE] [--build BUILD] [--devel DEVEL]
                    [--isolate-devel] [--install-space INSTALL_SPACE]
                    [--install] [--isolate-install]
                    [--space-suffix SPACE_SUFFIX] [--extend EXTEND_PATH]
                    [--tmp-config] [--parallel-jobs PARALLEL_JOBS]
                    [--force-cmake]
                    [--cmake-args [CMAKE_ARGS [CMAKE_ARGS ...]]]
                    [--make-args [MAKE_ARGS [MAKE_ARGS ...]]]
                    [--catkin-make-args [CATKIN_MAKE_ARGS [CATKIN_MAKE_ARGS ...]]]
                    [--no-install-lock] [--force-color] [--verbose]
                    [--interleave-output] [--no-status]
                    [packages [packages ...]]

Builds a catkin workspace

optional arguments:
  -h, --help            show this help message and exit
  --workspace WORKSPACE, -w WORKSPACE
                        The base path of the workspace (default ".")
  --profile PROFILE     The name of a config profile to use (default: active
                        profile)
  --list-only, --list   List packages in topological order, then exit.

Packages:
  Control which packages get built.

  packages              Workspace packages to build, package dependencies are
                        built as well unless --no-deps is used. If no packages
                        are given, then all the packages are built.
  --no-deps             Only build specified packages, not their dependencies.
  --start-with PKGNAME  Start building with this package, skipping any before
                        it.

Config:
  Override the configuration of the active profile.

  --source SOURCE, --source-space SOURCE
                        The path to the source space (default "src")
  --build BUILD, --build-space BUILD
                        The path to the build space (default "build")
  --devel DEVEL, --devel-space DEVEL
                        Sets the target devel space (default "devel")
  --isolate-devel       Build products from each catkin package into isolated
                        devel spaces.
  --install-space INSTALL_SPACE
                        Sets the target install space (default "install")
  --install             Causes each catkin package to be installed.
  --isolate-install     Install each catkin package into a separate install
                        space.
  --space-suffix SPACE_SUFFIX
                        suffix for build, devel, and install space if they are
                        not otherwise explicitly set
  --extend EXTEND_PATH  Explicitly extend the devel- or install-space of
                        another catkin workspace. Note that calling this will
                        also invoke the --force-cmake option.
  --tmp-config          Prevents storing of configuration.

Build:
  Parameters for the underlying buildsystem.

  --parallel-jobs PARALLEL_JOBS, --parallel PARALLEL_JOBS, -p PARALLEL_JOBS
                        Maximum number of packages which could be built in
                        parallel (default is cpu count)
  --force-cmake         Runs cmake explicitly for each catkin package.
  --cmake-args [CMAKE_ARGS [CMAKE_ARGS ...]]
                        Arbitrary arguments which are passes to CMake. It must
                        be passed after other arguments since it collects all
                        following options.
  --make-args [MAKE_ARGS [MAKE_ARGS ...]]
                        Arbitrary arguments which are passes to make.It must
                        be passed after other arguments since it collects all
                        following options.
  --catkin-make-args [CATKIN_MAKE_ARGS [CATKIN_MAKE_ARGS ...]]
                        Arbitrary arguments which are passes to make but only
                        for catkin packages.It must be passed after other
                        arguments since it collects all following options.
  --no-install-lock     Prevents serialization of the install steps, which is
                        on by default to prevent file install collisions

Interface:
  The behavior of the command-line interface.

  --force-color         Forces catkin build to ouput in color, even when the
                        terminal does not appear to support it.
  --verbose, -v         Print output from commands in ordered blocks once the
                        command finishes.
  --interleave-output, -i
                        Prevents ordering of command output when multiple
                        commands are running at the same time.
  --no-status           Suppresses status line, useful in situations where
                        carriage return is not properly supported.