Skip to content

Commit

Permalink
add documentation for catkin#192
Browse files Browse the repository at this point in the history
  • Loading branch information
k-okada committed Dec 11, 2015
1 parent 92d2431 commit ee42965
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
36 changes: 36 additions & 0 deletions docs/advanced/catkin_shell_verbs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Shell support in ``catkin`` command
===================================

When you source the following file, you can use bash/zsh shell functions which provide added utility.

.. code-block:: shell
. /opt/ros/indigo/etc/bash_completion.d/catkin_shell_verbs.{bash,zsh}
Provided verbs are:

- ``cd`` -- Change to package directory in source space
- ``source`` -- Source the develspace or installspace of the containing workspace

Full Command-Line Interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Change to package directory in source space with `cd` verb.

.. code-block:: text
usage: catkin cd [ARGS...]
ARGS are any valid catkin locate arguments
The `source` verb sources the develspace or installspace of the containing workspace

.. code-block:: text
usage: catkin source [-w /path/to/ws]
Sources setup.sh in the workspace.
optional arguments:
-w [/path/to/ws] Source setup.sh from given workspace.
7 changes: 7 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Catkin Command Line Tools
verbs/catkin_list
verbs/catkin_locate
verbs/catkin_profile
Advanced: Shell support <advanced/catkin_shell_verbs>
Advanced: Verb Aliasing <advanced/verb_customization>
Advanced: Contributing Verbs <development/extending_the_catkin_command>
.. TODO: Advanced: Workspace Chaining <advanced/workspace_chaining>
Expand Down Expand Up @@ -67,6 +68,12 @@ Each of the following verbs is built-in to the ``catkin`` command and has its ow
- :doc:`list -- Find and list information about catkin packages in a workspace <verbs/catkin_list>`
- :doc:`profile -- Manage different named configuration profiles <verbs/catkin_profile>`

Shell support in ``catkin`` command
-----------------------------------

A bash/zsh user can use wrapper function, please read :doc:`development/catkin_shell_verbs`.


Extending the ``catkin`` command
--------------------------------

Expand Down

0 comments on commit ee42965

Please sign in to comment.