ossp-pkg/as/as-gui/as-gui.conf.pod
##
## OSSP asgui - Accounting system graphical user interface
## Copyright (c) 2002-2004 The OSSP Project (http://www.ossp.org/)
## Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
## Copyright (c) 2002-2004 Michael Schloh von Bennewitz <michael@schloh.com>
## Copyright (c) 2002-2004 Cable & Wireless Telecommunications Services GmbH
##
## This file is part of OSSP asgui, an accounting system graphical user
## interface which can be found at http://www.ossp.org/pkg/tool/asgui/.
##
## Permission to use, copy, modify, and distribute this software for
## any purpose with or without fee is hereby granted, provided that
## the above copyright notice and this permission notice appear in all
## copies.
##
## THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
## SUCH DAMAGE.
##
## as-gui.conf.pod: Plain old documentation file
##
=pod
=head1 NAME
B<as-gui.conf> - as-gui configuration file
=head1 DESCRIPTION
The B<as-gui> accounting system graphical client allows for easy yet flexible
accounting of time and tasks. It caters to a variety of user interface tastes
by offering a variety of parameterized options.
Many such options influence direct rendering of the graphical representation
of all data and the controls which operate on the data. However, other options
control communication with the B<AS> server, local report formatting, or
backup storage.
Features such as macro processing, rulesets, account aliases, and session
tuning will be stored as well (when these future preferences are finally
implemented).
Because of the many possibilities offered, there exists a system to manage the
preferences involved. The system depends on the preferences file F<~/.as-gui>,
reading data from it when starting and running B<as-gui>, and storing data to
it when finally terminating.
The file F<~/.as-gui> is stored in XML format, and is parsed internally by
B<as-gui>. There is no need to edit this file, although there is also no harm
in doing so. Please remember that all parameters may change during runtime, so
it is wisest to edit after quitting the B<as-gui> application.
Attenzione! During runtime, all parameters are user-defined and are accessible
by selecting the 'Preferences...' subitem under the 'Edit' menu.
=head1 EXAMPLES
Entries taken from a preferences file:
=over 4
=item B<Location of events file>
<option key="asfile" value="~/.as/events" />
=item B<Location of accounts file>
<option key="accounts" value="~/.as/accounts" />
=item B<Visibility indicator of the amount column>
<option key="amountcolshow" value="true" />
=item B<Width in pixels of the amount column>
<option key="amountcolwidth" value="60" />
=item B<Flag to enable automatic file backups>
<option key="autobackup" value="true" />
=back
=head1 SEE ALSO
as-gui(1),
as-events(5),
as-accounts(5)
=head1 AUTHOR
Michael Schloh von Bennewitz
(michael@schloh.com)
=cut
