1FFGENPLUGIN(1) Fawkes Manual FFGENPLUGIN(1)
2
3
4
6 ffgenplugin - Generate the necessary files to build a fawkes plugin
7
9 ffgenplugin [-h] <author_name> <plugin_name> <description> <directory>
10
12 This program will generate the basic files to build a fawkes Plugin
13 into a folder specified by the user, to simplify the process of
14 building your own plugin
15
17 -h
18 Show help instructions.
19
20 author_name
21 The author’s name, for the plugin description
22
23 plugin_name
24 Name of the plugin, seperate multiple words with a dash
25
26 description
27 Short description of the plugin
28
29 directory
30 Path to the directory where the files should be generated in
31
33 ffgenplugin "John Doe" move-robot "Move the robot forward for a meter"
34 ../src/plugins/move-robot
35 Will generate the following files: Makefile move-robot_plugin.cpp
36 move-robot_thread.h move-robot_thread.cpp in the directory
37 ../src/plugins/move-robot
38
40 fawkes(8)
41
43 Written by Johannes Rothe <johannes.rothe@rwth-aachen.de>
44
46 Documentation by Johannes Rothe <johannes.rothe@rwth-aachen.de>
47
49 Part of the Fawkes Robot Software Framework. Project website is at
50 http://www.fawkesrobotics.org
51
52
53
54Fawkes 1.2.0 05/21/2019 FFGENPLUGIN(1)