1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/as-gui.pod Fri Nov 28 11:21:08 2008 +0100
1.3 @@ -0,0 +1,242 @@
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.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> - accounting system graphical client
1.40 +
1.41 +=head1 VERSION
1.42 +
1.43 +as-gui ASGUI_VERSION_STR
1.44 +
1.45 +=head1 SYNOPSIS
1.46 +
1.47 +B<as-gui>
1.48 +[I<X11_options>]
1.49 +[I<Qt_options>]
1.50 +[file]
1.51 +
1.52 +=head1 DESCRIPTION
1.53 +
1.54 +The B<as-gui> application tracks the time a person spends on a number of
1.55 +predefined tasks. This is the graphical client to the B<Accounting System>
1.56 +server (B<AS>). Although the two can interact through means of interprocess
1.57 +communication mechanisms, B<as-gui> is a generic stand-alone tool which can be
1.58 +used with no B<AS> server.
1.59 +
1.60 +When logging to a local file, B<as-gui> takes input and waits until receiving
1.61 +a save request from the user. Then, the time sheet will save its data entries
1.62 +to the associated file name (as shown in the title bar).
1.63 +
1.64 +Logging to a remote B<AS> server follows a similar input scheme, but at least
1.65 +one B<AS> server must be specified in the preferences. A simple 'syncronize
1.66 +with server' operation does the rest.
1.67 +
1.68 +=head1 X11 OPTIONS
1.69 +
1.70 +The following I<X11 options> are passed directly to the X11 subsystem, and
1.71 +allow for the typical customization of a X11 application.
1.72 +
1.73 +=over 4
1.74 +
1.75 +=item B<-display display>
1.76 +
1.77 +Sets the X display (host:server.screen). The default value is $DISPLAY.
1.78 +
1.79 +=item B<-geometry geometry>
1.80 +
1.81 +Sets the client geometry (width x height + xoffset + yoffset) of the main widget.
1.82 +
1.83 +=item B<-fn font>, B<-font font>
1.84 +
1.85 +Defines the application font. The font should be specified using a X logical
1.86 +font description.
1.87 +
1.88 +=item B<-bg color>, B<-background color>
1.89 +
1.90 +Sets the default background color and an application palette (light and dark
1.91 +shades are calculated).
1.92 +
1.93 +=item B<-fg color>, B<-foreground color>
1.94 +
1.95 +Sets the default foreground color.
1.96 +
1.97 +=item B<-btn color>, B<-button color>
1.98 +
1.99 +Sets the default button color.
1.100 +
1.101 +=item B<-name name>
1.102 +
1.103 +Sets the application name.
1.104 +
1.105 +=item B<-title title>
1.106 +
1.107 +Sets the application title (caption).
1.108 +
1.109 +=item B<-visual TrueColor>
1.110 +
1.111 +Forces the application to use a TrueColor visual on an 8-bit display.
1.112 +
1.113 +=item B<-ncols count>
1.114 +
1.115 +Limits the number of colors allocated in the color cube on an 8-bit display,
1.116 +if the application is using the QApplication::ManyColor color specification.
1.117 +If count is 216 then a 6x6x6 color cube is used (i.e. 6 levels of red, 6 of
1.118 +green, and 6 of blue). For other values, a cube approximately proportional to
1.119 +a 2x3x1 cube is used.
1.120 +
1.121 +=item B<-cmap>
1.122 +
1.123 +Causes the application to install a private color map on an 8-bit display.
1.124 +
1.125 +=back
1.126 +
1.127 +=head1 Qt OPTIONS
1.128 +
1.129 +The following I<Qt options> are used when rendering the graphics of the Qt
1.130 +widget library. They are not compatible with other X11 or Win32 applications,
1.131 +unless they were first linked with the Qt widget library.
1.132 +
1.133 +=over 4
1.134 +
1.135 +=item B<-session session>
1.136 +
1.137 +Restores the application from an earlier session.
1.138 +
1.139 +=item B<-widgetcount>
1.140 +
1.141 +Prints debug message at the end about number of widgets left undestroyed and
1.142 +maximum number of widgets existed at the same time.
1.143 +
1.144 +=back
1.145 +
1.146 +=head1 ENVIRONMENT
1.147 +
1.148 +C<USER> The user name to use when accounting.
1.149 +
1.150 +C<HOME> The full path of the user's home directory.
1.151 +
1.152 +=head1 RETURN VALUES
1.153 +
1.154 +C<0> The application exited sucessfully.
1.155 +
1.156 +C<E<gt>0 or E<lt>0> At least one error ocurred.
1.157 +
1.158 +=head1 EXAMPLES
1.159 +
1.160 +Try out some of these examples to customize B<as-gui> from the command
1.161 +line. Remember that options can be mixed.
1.162 +
1.163 +Initially editing the document 'figo.as':
1.164 +
1.165 +=over 4
1.166 +
1.167 +$ as-gui figo.as
1.168 +
1.169 +=back
1.170 +
1.171 +Showing lovely blue shades in most widgets:
1.172 +
1.173 +=over 4
1.174 +
1.175 +$ as-gui -bg lightblue -fg darkblue
1.176 +
1.177 +=back
1.178 +
1.179 +Starting with a title bar that reads 'Yours here':
1.180 +
1.181 +=over 4
1.182 +
1.183 +$ as-gui -title 'Yours here'
1.184 +
1.185 +=back
1.186 +
1.187 +Displaying graphics output on the host borchert:
1.188 +
1.189 +=over 4
1.190 +
1.191 +$ as-gui -display borchert:0.0
1.192 +
1.193 +=back
1.194 +
1.195 +A slim window slightly left of the top right corner:
1.196 +
1.197 +=over 4
1.198 +
1.199 +$ as-gui -geometry 761x347-120+0
1.200 +
1.201 +=back
1.202 +
1.203 +=head1 FILES
1.204 +
1.205 +=over 4
1.206 +
1.207 +=item ~/.as-gui
1.208 +
1.209 +User preferences file.
1.210 +
1.211 +=item as-gui.html
1.212 +
1.213 +Help reference.
1.214 +
1.215 +=back
1.216 +
1.217 +=head1 BUGS
1.218 +
1.219 +Sometimes a click on a widget (like a toolbar button) is seemingly ignored.
1.220 +
1.221 +Consistent row shading is not always maintained. This means that the sharp
1.222 +colour difference between one row and the next may not correctly follow the
1.223 +chosen sort order. Press 'refresh' to work around this problem.
1.224 +
1.225 +The row highlight may be wrong after resorting the entire time sheet. Press
1.226 +the arrow keys a few times to find the currently selected row if this happens.
1.227 +
1.228 +Double clicking on column separators should automatically expand or shrink
1.229 +the corresponding column to the exact size needed. Broken.
1.230 +
1.231 +Local reports only take datewise sorting into account. Attention! This is not
1.232 +a bug, and local reports are almost always only useful when sorted by date.
1.233 +
1.234 +=head1 SEE ALSO
1.235 +
1.236 +as-gui.conf(5),
1.237 +as-events(5),
1.238 +as-accounts(5)
1.239 +
1.240 +=head1 AUTHOR
1.241 +
1.242 +Michael Schloh von Bennewitz
1.243 +(michael@schloh.com)
1.244 +
1.245 +=cut
