as-gui.conf.pod

Fri, 28 Nov 2008 11:21:08 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Fri, 28 Nov 2008 11:21:08 +0100
changeset 1
d64aaa7d146f
child 3
c1941114ca88
permissions
-rw-r--r--

Fork project trunk at version 0.7.7 to maintain for future usage.
The original Cable & Wireless development team no longer exists.
The OSSP CVS repository is unavailable (cvs co ossp-pkg/as fails),
however http://cvs.ossp.org/dirview?d=ossp-pkg/as/as-gui is working.

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

mercurial