1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/as-gui.html Fri Nov 28 11:21:08 2008 +0100
1.3 @@ -0,0 +1,238 @@
1.4 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1.5 +<html xmlns="http://www.w3.org/1999/xhtml">
1.6 +<head>
1.7 +<title>as-gui help reference</title>
1.8 +<link rev="made" href="mailto:ms@dt4.dev.de.cw.net" />
1.9 +</head>
1.10 +
1.11 +<body style="background-color: white">
1.12 +
1.13 +<p><a name="__index__"></a></p>
1.14 +<!-- INDEX BEGIN -->
1.15 +
1.16 +<h1><a name="top">AS-GUI</a></h1>
1.17 +<ul>
1.18 + <li><a href="#name">NAME</a></li>
1.19 + <li><a href="#version">VERSION</a></li>
1.20 + <li><a href="#synopsis">SYNOPSIS</a></li>
1.21 + <li><a href="#description">DESCRIPTION</a></li>
1.22 + <li><a href="#x11_options">X11 OPTIONS</a></li>
1.23 + <li><a href="#qt_options">Qt OPTIONS</a></li>
1.24 + <li><a href="#environment">ENVIRONMENT</a></li>
1.25 + <li><a href="#return_values">RETURN VALUES</a></li>
1.26 + <li><a href="#examples">EXAMPLES</a></li>
1.27 + <li><a href="#files">FILES</a></li>
1.28 + <li><a href="#bugs">BUGS</a></li>
1.29 + <li><a href="#see_also">SEE ALSO</a></li>
1.30 + <li><a href="#author">AUTHOR</a></li>
1.31 +</ul>
1.32 +<!-- INDEX END -->
1.33 +
1.34 +<hr /><hr />
1.35 +<h2><a name="name">NAME</a></h2>
1.36 +<p><strong>as-gui</strong> - accounting system graphical client</p>
1.37 +<p>
1.38 +</p>
1.39 +<hr />
1.40 +<h2><a name="version">VERSION</a></h2>
1.41 +<p>as-gui 0.7.2 (06-Mar-2003)</p>
1.42 +<p>
1.43 +</p>
1.44 +<hr />
1.45 +<h2><a name="synopsis">SYNOPSIS</a></h2>
1.46 +<p><strong>as-gui</strong>
1.47 +[<em>X11_options</em>]
1.48 +[<em>Qt_options</em>]
1.49 +[file]</p>
1.50 +<p>
1.51 +</p>
1.52 +<hr />
1.53 +<h2><a name="description">DESCRIPTION</a></h2>
1.54 +<p>The <strong>as-gui</strong> application tracks the time a person spends on a number of
1.55 +predefined tasks. This is the graphical client to the <strong>Accounting System</strong>
1.56 +server (<strong>AS</strong>). Although the two can interact through means of interprocess
1.57 +communication mechanisms, <strong>as-gui</strong> is a generic stand-alone tool which can be
1.58 +used with no <strong>AS</strong> server.</p>
1.59 +<p>When logging to a local file, <strong>as-gui</strong> takes input and waits until receiving
1.60 +a save request from the user. Then, the time sheet will save its data entries
1.61 +to the associated file name (as shown in the title bar).</p>
1.62 +<p>Logging to a remote <strong>AS</strong> server follows a similar input scheme, but at least
1.63 +one <strong>AS</strong> server must be specified in the preferences. A simple 'syncronize
1.64 +with server' operation does the rest.</p>
1.65 +<p>
1.66 +</p>
1.67 +<hr />
1.68 +<h2><a name="x11_options">X11 OPTIONS</a></h2>
1.69 +<p>The following <em>X11 options</em> are passed directly to the X11 subsystem, and
1.70 +allow for the typical customization of a X11 application.</p>
1.71 +<dl>
1.72 +<dt><strong><a name="item_%2ddisplay_display"><strong>-display display</strong></a></strong><br />
1.73 +</dt>
1.74 +<dd>
1.75 +Sets the X display (host:server.screen). The default value is $DISPLAY.
1.76 +</dd>
1.77 +<br>
1.78 +<dt><strong><a name="item_%2dgeometry_geometry"><strong>-geometry geometry</strong></a></strong><br />
1.79 +</dt>
1.80 +<dd>
1.81 +Sets the client geometry (width x height + xoffset + yoffset) of the main widget.
1.82 +</dd>
1.83 +<br>
1.84 +<dt><strong><a name="item_%2dfn_font%2c_%2dfont_font"><strong>-fn font</strong>, <strong>-font font</strong></a></strong><br />
1.85 +</dt>
1.86 +<dd>
1.87 +Defines the application font. The font should be specified using a X logical
1.88 +font description.
1.89 +</dd>
1.90 +<br>
1.91 +<dt><strong><a name="item_%2dbg_color%2c_%2dbackground_color"><strong>-bg color</strong>, <strong>-background color</strong></a></strong><br />
1.92 +</dt>
1.93 +<dd>
1.94 +Sets the default background color and an application palette (light and dark
1.95 +shades are calculated).
1.96 +</dd>
1.97 +<br>
1.98 +<dt><strong><a name="item_%2dfg_color%2c_%2dforeground_color"><strong>-fg color</strong>, <strong>-foreground color</strong></a></strong><br />
1.99 +</dt>
1.100 +<dd>
1.101 +Sets the default foreground color.
1.102 +</dd>
1.103 +<br>
1.104 +<dt><strong><a name="item_%2dbtn_color%2c_%2dbutton_color"><strong>-btn color</strong>, <strong>-button color</strong></a></strong><br />
1.105 +</dt>
1.106 +<dd>
1.107 +Sets the default button color.
1.108 +</dd>
1.109 +<br>
1.110 +<dt><strong><a name="item_%2dname_name"><strong>-name name</strong></a></strong><br />
1.111 +</dt>
1.112 +<dd>
1.113 +Sets the application name.
1.114 +</dd>
1.115 +<br>
1.116 +<dt><strong><a name="item_%2dtitle_title"><strong>-title title</strong></a></strong><br />
1.117 +</dt>
1.118 +<dd>
1.119 +Sets the application title (caption).
1.120 +</dd>
1.121 +<br>
1.122 +<dt><strong><a name="item_%2dvisual_truecolor"><strong>-visual TrueColor</strong></a></strong><br />
1.123 +</dt>
1.124 +<dd>
1.125 +Forces the application to use a TrueColor visual on an 8-bit display.
1.126 +</dd>
1.127 +<br>
1.128 +<dt><strong><a name="item_%2dncols_count"><strong>-ncols count</strong></a></strong><br />
1.129 +</dt>
1.130 +<dd>
1.131 +Limits the number of colors allocated in the color cube on an 8-bit display,
1.132 +if the application is using the QApplication::ManyColor color specification.
1.133 +If count is 216 then a 6x6x6 color cube is used (i.e. 6 levels of red, 6 of
1.134 +green, and 6 of blue). For other values, a cube approximately proportional to
1.135 +a 2x3x1 cube is used.
1.136 +</dd>
1.137 +<br>
1.138 +<dt><strong><a name="item_%2dcmap"><strong>-cmap</strong></a></strong><br />
1.139 +</dt>
1.140 +<dd>
1.141 +Causes the application to install a private color map on an 8-bit display.
1.142 +</dd>
1.143 +<br></dl>
1.144 +<p>
1.145 +</p>
1.146 +<hr />
1.147 +<h2><a name="qt_options">Qt OPTIONS</a></h2>
1.148 +<p>The following <em>Qt options</em> are used when rendering the graphics of the Qt
1.149 +widget library. They are not compatible with other X11 or Win32 applications,
1.150 +unless they were first linked with the Qt widget library.</p>
1.151 +<dl>
1.152 +<dt><strong><a name="item_%2dsession_session"><strong>-session session</strong></a></strong><br />
1.153 +</dt>
1.154 +<dd>
1.155 +Restores the application from an earlier session.
1.156 +</dd>
1.157 +<br>
1.158 +<dt><strong><a name="item_%2dwidgetcount"><strong>-widgetcount</strong></a></strong><br />
1.159 +</dt>
1.160 +<dd>
1.161 +Prints debug message at the end about number of widgets left undestroyed and
1.162 +maximum number of widgets existed at the same time.
1.163 +</dd>
1.164 +<br></dl>
1.165 +<p>
1.166 +</p>
1.167 +<hr />
1.168 +<h2><a name="environment">ENVIRONMENT</a></h2>
1.169 +<p><code>USER</code> The user name to use when accounting.</p>
1.170 +<p><code>HOME</code> The full path of the user's home directory.</p>
1.171 +<p>
1.172 +</p>
1.173 +<hr />
1.174 +<h2><a name="return_values">RETURN VALUES</a></h2>
1.175 +<p><code>0</code> The application exited sucessfully.</p>
1.176 +<p><code>>0 or <0</code> At least one error ocurred.</p>
1.177 +<p>
1.178 +</p>
1.179 +<hr />
1.180 +<h2><a name="examples">EXAMPLES</a></h2>
1.181 +<p>Try out some of these examples to customize <strong>as-gui</strong> from the command
1.182 +line. Remember that options can be mixed.</p>
1.183 +<p>Initially editing the document 'figo.as':
1.184 +<br> $ as-gui figo.as</p>
1.185 +<p>Showing lovely blue shades in most widgets:
1.186 +<br> $ as-gui -bg lightblue -fg darkblue</p>
1.187 +<p>Starting with a title bar that reads 'Yours here':
1.188 +<br> $ as-gui -title 'Yours here'</p>
1.189 +<p>Displaying graphics output on the host borchert:
1.190 +<br> $ as-gui -display borchert:0.0</p>
1.191 +<p>A slim window slightly left of the top right corner:
1.192 +<br> $ as-gui -geometry 761x347-120+0</p>
1.193 +<p>
1.194 +</p>
1.195 +<hr />
1.196 +<h2><a name="files">FILES</a></h2>
1.197 +<dl>
1.198 +<dt><strong><a name="item_%7e%2f%2eas%2dgui">~/.as-gui</a></strong><br />
1.199 +</dt>
1.200 +<dd>
1.201 +User preferences file.
1.202 +</dd>
1.203 +<br>
1.204 +<dt><strong><a name="item_as%2dgui%2ehtml">as-gui.html</a></strong><br />
1.205 +</dt>
1.206 +<dd>
1.207 +Help reference.
1.208 +</dd>
1.209 +<p></p></dl>
1.210 +<p>
1.211 +</p>
1.212 +<hr />
1.213 +<h2><a name="bugs">BUGS</a></h2>
1.214 +<p>Sometimes a click on a widget (like a toolbar button) is seemingly ignored.</p>
1.215 +<p>Consistent row shading is not always maintained. This means that the sharp
1.216 +colour difference between one row and the next may not correctly follow the
1.217 +chosen sort order. Press 'refresh' to work around this problem.</p>
1.218 +<p>The row highlight may be wrong after resorting the entire time sheet. Press
1.219 +the arrow keys a few times to find the currently selected row if this happens.</p>
1.220 +<p>Double clicking on column separators should automatically expand or shrink
1.221 +the corresponding column to the exact size needed. Broken.</p>
1.222 +<p>Local reports only take datewise sorting into account. Attention! This is not
1.223 +a bug, and local reports are almost always only useful when sorted by date.</p>
1.224 +<p>
1.225 +</p>
1.226 +<hr />
1.227 +<h2><a name="see_also">SEE ALSO</a></h2>
1.228 +<p>as-gui(1),
1.229 +<br>as-events(5),
1.230 +<br>as-accounts(5),
1.231 +<br>as-gui.conf(5)
1.232 +<p>
1.233 +</p>
1.234 +<hr />
1.235 +<h2><a name="author">AUTHOR</a></h2>
1.236 +<p>Michael Schloh von Bennewitz
1.237 +<br>michael@schloh.com</p>
1.238 +
1.239 +</body>
1.240 +
1.241 +</html>
