Skip to content

Commit

Permalink
Fix doc of load_controller (#1135)
Browse files Browse the repository at this point in the history
  • Loading branch information
christophfroehlich authored Oct 11, 2023
1 parent b0830fe commit 486fde7
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions ros2controlcli/doc/userdoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,18 +148,21 @@ load_controller
.. code-block:: console
$ ros2 control load_controller -h
usage: ros2 control load_controller [-h] [--spin-time SPIN_TIME] [--set_state {configure,activate}] [-c CONTROLLER_MANAGER] [--include-hidden-nodes] controller_name
usage: ros2 control load_controller [-h] [--spin-time SPIN_TIME] [-s] [--set-state {configured,inactive,active}] [-c CONTROLLER_MANAGER]
[--include-hidden-nodes]
controller_name
Load a controller in a controller manager
positional arguments:
controller_name Name of the controller
optional arguments:
options:
-h, --help show this help message and exit
--spin-time SPIN_TIME
Spin time in seconds to wait for discovery (only applies when not using an already running daemon)
--set_state {configured,inactive,active}
-s, --use-sim-time Enable ROS simulation time
--set-state {configured,inactive,active}
Set the state of the loaded controller
-c CONTROLLER_MANAGER, --controller-manager CONTROLLER_MANAGER
Name of the controller manager ROS node
Expand Down

0 comments on commit 486fde7

Please sign in to comment.