1BEAGLE-CONFIG(1) Linux User's Manual BEAGLE-CONFIG(1)
2
6 beagle-config - command-line interface to Beagle configuration
7
9 beagle-config options
10 beagle-config sections
11 beagle-config sections section-options [params]
12 beagle-config xml-options
13
15 beagle-config is a command line tool designed to manipulate the Beagle
16 configuration.
17 The configuration is stored in a series of files usually located in the
19 ~/.beagle/config directory. The configuration is split up into sec‐
20 tions, each section being represented by 1 file.
21 The format used is the result of serialized objects. Manually modifying
23 the configuration files is not recommended, you should use this utility
24 instead. You can also the graphical interfaces beagle-settings (Gtk) or
25 beagle-settings-qt (Qt4).
26 Each section configures a different area of the Beagle system. Each
28 section has a number of preset section-options (commands) which you can
29 perform on it via this command-line application.
30 The available sections, and available options for each section, are
32 discovered at runtime. This manual does not attempt to document the
33 sections in detail. This manual demonstrates how you can retrieve a
34 list of available sections and their options.
35 beagle-config can be used "offline", it does not require a Beagle dae‐
37 mon to be running for most operations. If a Beagle daemon is running,
38 it will immediately be notified of any configuration changes, and your
39 new settings will come into effect almost immediately. Alternatively,
40 you can force a re-load with the --beagled-reload-config argument.
41
43 --help Print a brief copyright and usage message.
44 --beagled-reload-config
46 Asks the beagle daemon to reload the configuration files.
47 --list-sections
49 Lists all of the available sections for use as the sections
50 parameter.
51 --version
53 Print version information.
54
56 Each section has its own unique set of options available. To see a list
57 of supported options for a particular section, run beagle-config sec‐
58 tion-name with no additional parameters. Note that some of the options
59 are strictly for internal usage by beagle and should not be modified by
60 the user.
61
63 To read the value of section-option, you do not need to give any
64 params. Of course you need to supply params if you want to set a sec‐
65 tion-option. There are 3 types of section options. The params depend on
66 the type of the section-option.
67 boolean option
69 PARAMS is "true" or "false"
70 string option
72 PARAMS is the value of the section-option.
73 list option
75 To add a list option, pass a comma separated list of options
76 value1,value2,... . Run beagle-config section-name section-
77 option for the number of items in the list and their explana‐
78 tions.
79 To remove a list option, pass - value1,value2,... where
80 value1,value2,... are the exact values of the option that you
81 want to remove.
82
84 Non-C# programs who want to get/set configuration values can use these
85 options. If an error occurs, the return value can be checked to deter‐
86 mine the kind of the error. The return value is
87 1: Bad section name
89 2: Invalid XML
91 3: XML does not correspond to the section name
93 Options
95 --read-xml SECTION
96 Reads the xml of a section from stdin. Suitable for setting
97 options by other programs.
98 --write-xml SECTION
100 Print the section in xml format. Suitable for parsing by other
101 programs.
102
104 Originally written by Daniel Drake <dsd@gentoo.org>. Modified by D
105 Bera <dbera.web@gmail.com>
106
108 Report bugs to <dashboard-hackers@gnome.org>.
109
111 Copyright © 2005 Novell, Inc., © 2008 D Bera
112 This is free software; see the source for copying conditions. There is
114 NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
115 PURPOSE.
116
118 beagled(1)
119beagle July 2008 BEAGLE-CONFIG(1)