catkin_make &catkin build

https://catkin-tools.readthedocs.io/en/latest/

http://docs.ros.org/api/catkin/html/

Users of catkin_make and catkin_make_isolated should go to the Migration Guide for help transitioning to catkin build.

The catkin Command

The catkin Command-Line Interface (CLI) tool is the single point of entry for most of the functionality provided by this package. All invocations of the catkin CLI tool take this form:

$ catkin [global options] <verb> [verb arguments and options]

The different capabilities of the catkin CLI tool are organized into different sub-command “verbs.” This is similar to common command-line tools such as git or apt-get. Verbs include actions such as build which builds a catkin workspace or list which simply lists the catkin packages found in one or more folders.

Verbs can take arbitrary arguments and options, but they must all come after the verb. For more help on the usage of a particular verb, simply pass the -h or --help option after the verb.

Built-in catkin Verbs

Each of the following verbs is built-in to the catkin command and has its own detailed documentation:

• build – Build packages in a catkin workspace
• config – Configure a catkin workspace’s layout and settings
• clean – Clean products generated in a catkin workspace
• create – Create structures like Catkin packages
• env – Run commands with a modified environemnt
• init – Initialize a catkin workspace
• list – Find and list information about catkin packages in a workspace
• locate – Get important workspace directory paths
• profile – Manage different named configuration profiles

Contributed Third Party Verbs

• lint – Check catkin packages for common errors

Shell Support for the catkin Command

If you are using bash or zsh, then you can source an extra setup file to gain access to some additional verbs. For more information see: Shell support in catkin command.

Extending the catkin command

If you would like to add a verb to the catkin command without modifying its source, please read Adding New Verbs.

Catkin

Catkin is a collection of CMake macros and associated code used to build packages used in ROS.

It was initially introduced as part of the ROS Fuerte release where it was used for a small set of base packages. For Groovy and Hydro it was significantly modified, and used by many more packages. All released Hydro packages were built using catkin, although existing rosbuildpackages can still be built from source on top of the catkin packages. Indigo is very similar, except for some deprecated features that were removed.

Note

This document covers the Indigo version. The Groovy and Hydro versions are documented separately.

Contents

• How to do common tasks
  • Package format 2 (recommended)
  • Package format 1 (legacy)
• User Guide
  • Installation
  • Finding required packages
  • Handling of setup.py
  • CMake coding standards
  • Variables
  • Environment files
  • Glossary
• Advanced Users Guide
  • Updating a catkin package for Indigo
  • Migrating from Fuerte catkin
  • How to build the docs
• Developers Guide
  • Design sketch
  • Pre- and Post-installation Disk Layout reference
  • Code Generation
  • Extracted CMake API reference
  • Catkin Maintainers guide
  • Upload catkin documentation
  • Catkin Python API

Code & support

Catkin	http://github.com/ros/catkin
Issues	http://github.com/ros/catkin/issues