1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/as-gui.conf.pod Fri Nov 28 11:21:08 2008 +0100
1.3 @@ -0,0 +1,105 @@
1.4 +##
1.5 +## OSSP asgui - Accounting system graphical user interface
1.6 +## Copyright (c) 2002-2004 The OSSP Project (http://www.ossp.org/)
1.7 +## Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
1.8 +## Copyright (c) 2002-2004 Michael Schloh von Bennewitz <michael@schloh.com>
1.9 +## Copyright (c) 2002-2004 Cable & Wireless Telecommunications Services GmbH
1.10 +##
1.11 +## This file is part of OSSP asgui, an accounting system graphical user
1.12 +## interface which can be found at http://www.ossp.org/pkg/tool/asgui/.
1.13 +##
1.14 +## Permission to use, copy, modify, and distribute this software for
1.15 +## any purpose with or without fee is hereby granted, provided that
1.16 +## the above copyright notice and this permission notice appear in all
1.17 +## copies.
1.18 +##
1.19 +## THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
1.20 +## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
1.21 +## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1.22 +## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
1.23 +## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1.24 +## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1.25 +## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
1.26 +## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
1.27 +## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
1.28 +## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
1.29 +## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
1.30 +## SUCH DAMAGE.
1.31 +##
1.32 +## as-gui.conf.pod: Plain old documentation file
1.33 +##
1.34 +
1.35 +=pod
1.36 +
1.37 +=head1 NAME
1.38 +
1.39 +B<as-gui.conf> - as-gui configuration file
1.40 +
1.41 +=head1 DESCRIPTION
1.42 +
1.43 +The B<as-gui> accounting system graphical client allows for easy yet flexible
1.44 +accounting of time and tasks. It caters to a variety of user interface tastes
1.45 +by offering a variety of parameterized options.
1.46 +
1.47 +Many such options influence direct rendering of the graphical representation
1.48 +of all data and the controls which operate on the data. However, other options
1.49 +control communication with the B<AS> server, local report formatting, or
1.50 +backup storage.
1.51 +
1.52 +Features such as macro processing, rulesets, account aliases, and session
1.53 +tuning will be stored as well (when these future preferences are finally
1.54 +implemented).
1.55 +
1.56 +Because of the many possibilities offered, there exists a system to manage the
1.57 +preferences involved. The system depends on the preferences file F<~/.as-gui>,
1.58 +reading data from it when starting and running B<as-gui>, and storing data to
1.59 +it when finally terminating.
1.60 +
1.61 +The file F<~/.as-gui> is stored in XML format, and is parsed internally by
1.62 +B<as-gui>. There is no need to edit this file, although there is also no harm
1.63 +in doing so. Please remember that all parameters may change during runtime, so
1.64 +it is wisest to edit after quitting the B<as-gui> application.
1.65 +
1.66 +Attenzione! During runtime, all parameters are user-defined and are accessible
1.67 +by selecting the 'Preferences...' subitem under the 'Edit' menu.
1.68 +
1.69 +=head1 EXAMPLES
1.70 +
1.71 +Entries taken from a preferences file:
1.72 +
1.73 +=over 4
1.74 +
1.75 +=item B<Location of events file>
1.76 +
1.77 +<option key="asfile" value="~/.as/events" />
1.78 +
1.79 +=item B<Location of accounts file>
1.80 +
1.81 +<option key="accounts" value="~/.as/accounts" />
1.82 +
1.83 +=item B<Visibility indicator of the amount column>
1.84 +
1.85 +<option key="amountcolshow" value="true" />
1.86 +
1.87 +=item B<Width in pixels of the amount column>
1.88 +
1.89 +<option key="amountcolwidth" value="60" />
1.90 +
1.91 +=item B<Flag to enable automatic file backups>
1.92 +
1.93 +<option key="autobackup" value="true" />
1.94 +
1.95 +=back
1.96 +
1.97 +=head1 SEE ALSO
1.98 +
1.99 +as-gui(1),
1.100 +as-events(5),
1.101 +as-accounts(5)
1.102 +
1.103 +=head1 AUTHOR
1.104 +
1.105 +Michael Schloh von Bennewitz
1.106 +(michael@schloh.com)
1.107 +
1.108 +=cut
