1FFGENPLUGIN(1)                   Fawkes Manual                  FFGENPLUGIN(1)
2
3
4

NAME

6       ffgenplugin - Generate the necessary files to build a fawkes plugin
7

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

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

EXAMPLE

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

SEE ALSO

40       fawkes(8)
41

AUTHOR

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

DOCUMENTATION

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

FAWKES

49       Part of the Fawkes Robot Software Framework. Project website is at
50       http://www.fawkesrobotics.org
51
52
53
54Fawkes 1.3.0                      06/21/2022                    FFGENPLUGIN(1)