1FFCONFIG(1) Fawkes Manual FFCONFIG(1)
2
3
4
6 ffconfig - Query and modify configuration settings remotely.
7
9 ffconfig [-h] [options] <cmd> [args]
10
12 This program connects to a Fawkes instance over the network and can
13 query and modify configuration settings.
14
15 To use this tool, a command string is formed that consists of a command
16 and its arguments. A number of options is available to modify the
17 behavior of the program.
18
20 -h
21 Show help instructions.
22
23 -c
24 Show comments (only available with list and watch cmd).
25
26 -a
27 Show all values, even double if default and host-specific values
28 exist (only available with list).
29
30 -q
31 Quiet mode. Only show important output, suitable for parsing (not
32 supported for all commands yet).
33
34 -r host[:port]
35 Remote host and optionally port to connect to. If not given
36 defaults to localhost:1910.
37
39 list
40 List all configuration items.
41
42 watch
43 Watch configuration changes and print them as they happen.
44
45 get path
46 Get and print the value at path.
47
48 set path value [type]
49 Set a host-specific value for the given path to the given value.
50 The type must be given if the value is newly created. It must be
51 one of float/uint/int/bool/string.
52
53 set_default path value [type]
54 Set a default value for the given path to the given value. The type
55 must be given if the value is newly created. It must be one of
56 float/uint/int/bool/string.
57
58 set_comment path comment
59 Set comment for the given host-specific value at path. The value at
60 the given path must already exist in the host-specific
61 configuration.
62
63 set_default_comment path comment
64 Set default comment for the given path. The value at the given path
65 must already exist in the default configuration.
66
67 erase path
68 Erase value at path from host-specific configuration.
69
70 erase_default path
71 Erase value at path from default configuration.
72
74 ffconfig list
75 List all configuration values on localhost. host.
76
77 ffplugin -r myrobot:1234 set /my_value "test string" string
78 Connect to Fawkes running on the host "myrobot" on port 1234 and
79 set the host-specific value at /my_value to "test string" of type
80 string. If the value already exists it must be of type string, or
81 an error occurs.
82
84 fawkes(8)
85
87 Written by Tim Niemueller <niemueller@kbsg.rwth-aachen.de>
88
90 Documentation by Tim Niemueller <niemueller@kbsg.rwth-aachen.de>
91
93 Part of the Fawkes Robot Software Framework. Project website is at
94 http://www.fawkesrobotics.org
95
96
97
98Fawkes 1.2.0 05/21/2019 FFCONFIG(1)