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