ffplugin(1)

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

NAME

6       ffplugin - Manage loaded Fawkes plugins
7

SYNOPSIS

9       ffplugin [-h] [-l plugin|-u plugin|-R plugin|-w|-a|-L] [-r host[:port]]
10

DESCRIPTION

12       This program connects to a Fawkes instance over the network and can
13       then instruct to load or unload plugins, watch for plugin events, or
14       list available or currently loaded plugins.
15

OPTIONS

17       -h
18           Show help instructions.
19
20       -l plugin
21           Load the plugin named plugin.
22
23       -u plugin
24           Unload the plugin named plugin.
25
26       -R plugin
27           Reload the plugin named plugin. This will first order an unload of
28           the plugin, and then a load.
29
30       -w
31           Watch all load/unload operations and print them on the console as
32           they happen.
33
34       -a
35           Query for a list of all available plugins (loaded or unloaded) and
36           print to the console.
37
38       -L
39           Query for a list of currently loaded plugins and print to the
40           console. If no option is given this is the default action.
41
42       -r host[:port]
43           Remote host and optionally port to connect to. If not given
44           defaults to localhost:1910.
45

EXAMPLES

47       ffplugin -l webview
48           Load the webview plugin on the Fawkes instance on the local host.
49
50       ffplugin -a -r myrobot:1234
51           Query a list of available plugins from the Fawkes instance running
52           on the host "myrobot" on port 1234.
53

AUTHOR

58       Written by Tim Niemueller <niemueller@kbsg.rwth-aachen.de>
59

DOCUMENTATION

61       Documentation by Tim Niemueller <niemueller@kbsg.rwth-aachen.de>
62

FAWKES

64       Part of the Fawkes Robot Software Framework. Project website is at
65       http://www.fawkesrobotics.org
66
67
68
69Fawkes 1.3.0                      09/14/2021                       FFPLUGIN(1)