ffgenplugin - Man Page

Generate the necessary files to build a fawkes plugin

Synopsis

ffgenplugin [-h] <author_name> <plugin_name> <description> <directory>

Description

This program will generate the basic files to build a fawkes Plugin into a folder specified by the user, to simplify the process of building your own plugin

Options

-h

Show help instructions.

author_name

The author’s name, for the plugin description

plugin_name

Name of the plugin, seperate multiple words with a dash

description

Short description of the plugin

directory

Path to the directory where the files should be generated in

Example

ffgenplugin "John Doe" move-robot "Move the robot forward for a meter" ../src/plugins/move-robot

Will generate the following files: Makefile move-robot_plugin.cpp move-robot_thread.h move-robot_thread.cpp in the directory ../src/plugins/move-robot

See Also

fawkes(8)

Author

Written by Johannes Rothe <johannes.rothe@rwth-aachen.de>

Documentation

Documentation by Johannes Rothe <johannes.rothe@rwth-aachen.de>

Fawkes

Part of the Fawkes Robot Software Framework. Project website is at http://www.fawkesrobotics.org

Info

05/10/2021 Fawkes 1.3.0 Fawkes Manual