--- as-gui.pod 2003/03/05 15:23:33 1.3
+++ as-gui.pod 2003/03/05 20:24:52 1.4
@@ -41,7 +41,10 @@
=head1 SYNOPSIS
-B<as-gui> [file]
+B<as-gui>
+[I<X11_options>]
+[I<Qt_options>]
+[file]
=head1 DESCRIPTION
@@ -55,32 +58,189 @@
a save request from the user. Then, the time sheet will save its data entries
to the associated file name (as shown in the title bar).
-Logging to a remote B<AS> server follows the same input scheme, but at least
+Logging to a remote B<AS> server follows a similar input scheme, but at least
one B<AS> server must be specified in the preferences. A simple 'syncronize
with server' operation does the rest.
-=head1 OPTIONS
+=head1 X11 OPTIONS
-=item B<-?>|B<--usage>
+The following I<X11 options> are passed directly to the X11 subsystem, and
+allow for the typical customization of a X11 application.
-print short usage summary, then exit.
+=over 4
+
+=item B<-display display>
+
+Sets the X display (host:server.screen). The default value is $DISPLAY.
+
+=item B<-geometry geometry>
+
+Sets the client geometry (width x height + xoffset + yoffset) of the main widget.
+
+=item B<-fn font>, B<-font font>
+
+Defines the application font. The font should be specified using a X logical
+font description.
+
+=item B<-bg color>, B<-background color>
+
+Sets the default background color and an application palette (light and dark
+shades are calculated).
+
+=item B<-fg color>, B<-foreground color>
+
+Sets the default foreground color.
+
+=item B<-btn color>, B<-button color>
+
+Sets the default button color.
+
+=item B<-name name>
+
+Sets the application name.
+
+=item B<-title title>
+
+Sets the application title (caption).
+
+=item B<-visual TrueColor>
+
+Forces the application to use a TrueColor visual on an 8-bit display.
+
+=item B<-ncols count>
+
+Limits the number of colors allocated in the color cube on an 8-bit display,
+if the application is using the QApplication::ManyColor color specification.
+If count is 216 then a 6x6x6 color cube is used (i.e. 6 levels of red, 6 of
+green, and 6 of blue). For other values, a cube approximately proportional to
+a 2x3x1 cube is used.
+
+=item B<-cmap>
+
+Causes the application to install a private color map on an 8-bit display.
+
+=back
+
+=head1 Qt OPTIONS
+
+The following I<Qt options> are used when rendering the graphics of the Qt
+widget library. They are not compatible with other X11 or Win32 applications,
+unless they were first linked with the Qt widget library.
+
+=over 4
+
+=item B<-style style>
+
+Sets the application GUI style. Possible values are motif, windows, and
+platinum. If you compiled Qt with additional styles or have additional styles
+as plugins these will be available to the -style command line option.
+
+=item B<-session session>
+
+Restores the application from an earlier session.
+
+=item B<-widgetcount>
+
+Prints debug message at the end about number of widgets left undestroyed and
+maximum number of widgets existed at the same time.
+
+=back
=head1 ENVIRONMENT
-=head1 RETURN VALUE
+C<USER> The user name to use when accounting.
+
+C<HOME> The full path of the user's home directory.
+
+=head1 RETURN VALUES
+
+C<0> The application exited sucessfully.
+
+C<E<gt>0 or E<lt>0> At least one error ocurred.
=head1 EXAMPLES
+Try out some of these examples to customize B<as-gui> from the command
+line. Remember that options can be mixed.
+
+Initially editing the document 'figo.as':
+
+=over 4
+
+$ as-gui figo.as
+
+=back
+
+Showing lovely blue shades in most widgets:
+
+=over 4
+
+$ as-gui -bg lightblue -fg darkblue
+
+=back
+
+Starting with a title bar that reads 'Yours here':
+
+=over 4
+
+$ as-gui -title 'Yours here'
+
+=back
+
+Displaying graphics output on the host borchert:
+
+=over 4
+
+$ as-gui -display borchert:0.0
+
+=back
+
+A slim window slightly left of the top right corner:
+
+=over 4
+
+$ as-gui -geometry 761x347-120+0
+
+=back
+
=head1 FILES
+=over 4
+
+=item ~/.as-gui
+
+User preferences file.
+
+=item as-gui.html
+
+Help reference.
+
+=back
+
+=head1 BUGS
+
+Sometimes a click on a widget (like a toolbar button) is seemingly ignored.
+
+Consistent row shading is not always maintained. This means that the sharp
+colour difference between one row and the next may not correctly follow the
+chosen sort order. Press 'refresh' to work around this problem.
+
+The row highlight may be wrong after resorting the entire time sheet. Press
+the arrow keys a few times to find the currently selected row if this happens.
+
+Double clicking on column separators should automatically expand or shrink
+the corresponding column to the exact size needed. Broken.
+
+Local reports only take datewise sorting into account. Attention! This is not
+a bug, and local reports are almost always only useful when sorted by date.
+
=head1 SEE ALSO
-titraq.conf(5)
+as-gui.conf(5)
=head1 AUTHOR
Michael Schloh von Bennewitz
-
-=head1 HISTORY
+(michael@schloh.com)
=cut
|
