beagle-config (1) - Linux Manuals

beagle-config: command-line interface to Beagle configuration

NAME

beagle-config - command-line interface to Beagle configuration

SYNOPSIS

beagle-config options
beagle-config sections
beagle-config sections section-options [params]
beagle-config xml-options

DESCRIPTION

beagle-config is a command line tool designed to manipulate the Beagle configuration.

The configuration is stored in a series of files usually located in the ~/.beagle/config directory. The configuration is split up into sections, each section being represented by 1 file.

The format used is the result of serialized objects. Manually modifying the configuration files is not recommended, you should use this utility instead. You can also the graphical interfaces beagle-settings (Gtk) or beagle-settings-qt (Qt4).

Each section configures a different area of the Beagle system. Each section has a number of preset section-options (commands) which you can perform on it via this command-line application.

The available sections, and available options for each section, are discovered at runtime. This manual does not attempt to document the sections in detail. This manual demonstrates how you can retrieve a list of available sections and their options.

beagle-config can be used "offline", it does not require a Beagle daemon to be running for most operations. If a Beagle daemon is running, it will immediately be notified of any configuration changes, and your new settings will come into effect almost immediately. Alternatively, you can force a re-load with the --beagled-reload-config argument.

OPTIONS

--help

Print a brief copyright and usage message.

--beagled-reload-config

Asks the beagle daemon to reload the configuration files.

--list-sections

Lists all of the available sections for use as the sections parameter.

--version

Print version information.

SECTION OPTIONS

Each section has its own unique set of options available. To see a list of supported options for a particular section, run beagle-config section-name with no additional parameters. Note that some of the options are strictly for internal usage by beagle and should not be modified by the user.

PARAMS

To read the value of section-option, you do not need to give any params. Of course you need to supply params if you want to set a section-option. There are 3 types of section options. The params depend on the type of the section-option.

boolean option

PARAMS is "true" or "false"

string option

PARAMS is the value of the section-option.

list option

To add a list option, pass a comma separated list of options value1,value2,.... Run beagle-config section-name section-option for the number of items in the list and their explanations.
To remove a list option, pass - value1,value2,... where value1,value2,... are the exact values of the option that you want to remove.

XML OPTIONS

Non-C# programs who want to get/set configuration values can use these options. If an error occurs, the return value can be checked to determine the kind of the error. The return value is

1: Bad section name

2: Invalid XML

3: XML does not correspond to the section name

Options

--read-xml SECTION

Reads the xml of a section from stdin. Suitable for setting options by other programs.

--write-xml SECTION

Print the section in xml format. Suitable for parsing by other programs.

AUTHOR

Originally written by Daniel Drake <dsd [at] gentoo.org>. Modified by D Bera <dbera.web [at] gmail.com>

REPORTING BUGS

Report bugs to <dashboard-hackers [at] gnome.org>.

COPYRIGHT

Copyright © 2005 Novell, Inc., © 2008 D Bera

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.