tools/beagle-config.1

   1 .\" beagle-config(1) manpage
   2 .\"
   3 .\" Copyright (C) 2005 Novell, Inc.
   4 .\"
   5 .TH BEAGLE-CONFIG "1" "May 2005" "beagle" "Linux User's Manual"
   6 .SH NAME
   7 beagle-config \- command-line interface to the Beagle configuration file
   8 .SH SYNOPSIS
   9 .B beagle-config
  10 \fIoptions\fR
  11 .br
  12 .B beagle-config
  13 \fIsections\fR
  14 .br
  15 .B beagle-config
  16 \fIsections\fR \fIsection-options\fR [\fIparams\fR]
  17 .SH DESCRIPTION
  18 .BR beagle-config
  19 is a command line tool designed to manipulate the Beagle configuration.
  20 .PP
  21 The configuration is stored in a series of files usually located in the \fB~/.beagle/config\fR directory. The configuration is split up into \fIsections\fR, each section being represented by 1 file.
  22 .PP
  23 The format used is the result of serialized objects. Manually modifying the configuration files is not recommended, you should use this utility instead.
  24 .PP
  25 Each \fIsection\fR configures a different area of the Beagle system. Each section has a number of preset \fIsection-options\fR (commands) which you can perform on it via this command-line application.
  26 .PP
  27 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.
  28 .PP
  29 \fIbeagle-config\fR 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 \fB--beagled-reload-config\fR argument.
  30 .SH OPTIONS
  31 .TP
  32 .B --help
  33 Print a brief copyright and usage message.
  34 .TP
  35 .B --beagled-reload-config
  36 Asks the beagle daemon to reload the configuration files.
  37 .TP
  38 .B --list-sections
  39 Lists all of the available sections for use as the \fIsections\fR parameter.
  40 .SH SECTION OPTIONS
  41 Each section has its own unique set of options available. To see a list of supported options for a particular section, run \fBbeagle-config section-name\fR with no additional parameters.
  42 .SH PARAMS
  43 Each option may take a number of parameters (or none). Please refer to online documentation if you require explanations of every available command.
  44 .SH AUTHOR
  45 Originally written by Daniel Drake <dsd@gentoo.org>.
  46 .SH "REPORTING BUGS"
  47 Report bugs to <dashboard-hackers@gnome.org>.
  48 .SH COPYRIGHT
  49 Copyright \(co 2005 Novell, Inc.
  50 .sp
  51 This is free software; see the source for copying conditions.  There is NO
  52 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  53 .SH "SEE ALSO"
  54 .BR beagled (1),