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