1FAWKES(8) Fawkes Manual FAWKES(8)
2
6 fawkes - Main application of the Fawkes Robot Software Framework
7
9 fawkes [-h] [-C] [-c db-file] [-d sql-file] [-q[qqq]] [-l level]
10 [-L loggers] [-p plugins] [-u user] [-g group]
11 [-Dpid-file] [-Dpid-file -k] [-Dpid-file -s]
12
14 This program is the main application that provides the environment for
15 Fawkes plugins to run. When run, it creates the blackboard, loads the
16 configuration files and sets up the basic aspect initializers required
17 to initialize plugins.
18
20 -h
21 Show help instructions.
22 -C
24 Cleanup old BB segments. This is only required when using the old
25 sysvipc shared memory blackboard (off by default).
26 -c db-file
28 Mutable configuration file, created if it does not exist. If it
29 does however it must contain a valid SQLite database. db-file is
30 either the absolute path to the configuration database, or it is a
31 path relative to the system configuration directory or the .fawkes
32 directory in the user’s home directory. In either case it should be
33 suffixed by .db.
34 -d sql-file
36 Default configuration SQL dump file. On program startup the default
37 configuration is imported from this file. On exit, it is written
38 back. sql-file is either an absolute path to the default.sql dump
39 file or a path relative to the system configuration directory or
40 the .fawkes directory in the user’s home directory. In either case
41 it should be suffixed by .sql.
42 -q[qqq]
44 Quiet mode, -q omits debug, -qq debug and info, -qqq omit debug,
45 info and warn, -qqqq no output of logger.
46 -l level
48 Set log level directly mutually exclusive with -q. level is one of
49 debug, info, warn, error and none.
50 -L loggers
52 Define loggers. By default this setting is read from config file
53 (or console logger if unset in config). Format for loggers is:
54 logger:args[;logger2:args2[!...]]. The logger options depend on the
55 logger. Currently supported: console (default), file:file.log,
56 network logger is always enabled.
57 -p plugins
59 Load the given plugins on startup. plugins is a comma-separated
60 list of plugins to load, for example fvbase,fvfountain,fvretriever.
61 The plugins will be loaded in the given order after startup. An
62 error to load any of these plugins will cause the successive
63 plugins not to be loaded.
64 -u user
66 Drop privileges as soon as possible and run as given user.
67 -g group
69 Drop privileges as soon as possible and run as given group.
70 -D[pid-file]
72 Run daemonized in the background, pid-file is optional and defaults
73 to /var/run/fawkes.pid, it must be an absolute path.
74 -D[pid-file] -k
76 Kill a daemonized process running in the background. The pid-file
77 is used to determine the process ID and is optional as above.
78 -D[pid-file] -s
80 Check status of daemon. The exit value can be used to check on the
81 status. The pid-file is used to determine the process ID and is
82 optional as above.
83
85 The configuration is stored in SQLite databases for fast retrieval.
86
88 fawkes
89 Run fawkes and await commands.
90 fawkes -p webview
92 Run fawkes and load the webview plugin after startup. After this,
93 you cann access Fawkes via http://localhost:10117 to load more
94 plugins, read the logs or inspect the blackboard.
95
97 ffplugin(1) ffconfig(1)
98
100 Written by Tim Niemueller <niemueller@kbsg.rwth-aachen.de>
101
103 Documentation by Tim Niemueller <niemueller@kbsg.rwth-aachen.de>
104
106 Part of the Fawkes Robot Software Framework. Project website is at
107 http://www.fawkesrobotics.org
108Fawkes 1.3.0 02/12/2021 FAWKES(8)