|
Check-in Number:
|
4100 | |
| Date: |
2003-Mar-05 21:24:52 (local)
2003-Mar-05 20:24:52 (UTC) |
| User: | ms |
| Branch: | |
| Comment: |
Wrote help content and other documentation, modify buildconf to install it
properly, and additionally glue it into the help panel class to be accessible
during runtime. |
| Tickets: |
|
| Inspections: |
|
| Files: |
|
ossp-pkg/as/as-gui/Makefile.in 1.46 -> 1.47
--- Makefile.in 2003/03/05 15:23:33 1.46
+++ Makefile.in 2003/03/05 20:24:52 1.47
@@ -37,6 +37,7 @@
bindir = @bindir@
sbindir = @sbindir@
libdir = @libdir@
+datadir = @datadir@
includedir = @includedir@
mandir = @mandir@
@@ -131,13 +132,17 @@
$(IDL) --c++-suffix=cpp $<
endif
+# Special treatment for help panel class, which needs the $datadir variable
+as_helpanel.o: as_helpanel.cpp
+ $(CXX) -c -DTITRAQ_DOCDIR=\"$(datadir)\" $(CPPFLAGS) $(CXXFLAGS) $<
+
as-gui.1: as-gui.pod
VS=`$(SHTOOL) version -lc -dshort as_version.cpp`; \
VL=`$(SHTOOL) version -lc -dlong as_version.cpp`; \
D=`$(SHTOOL) version -lc -dlong as_version.cpp | sed -e 's;.*(;;' -e 's;).*;;'`; \
$(POD2MAN) --quotes=none \
--section=1 --center="AS Accounting System" \
- --release="$$D" --date="asgui $$VS" as-gui.pod | \
+ --release="$$D" --date="as-gui $$VS" as-gui.pod | \
sed -e "s;ASGUI_VERSION_STR;$$VL;" >as-gui.1
as-gui.conf.5: as-gui.conf.pod
@@ -146,24 +151,28 @@
D=`$(SHTOOL) version -lc -dlong as_version.cpp | sed -e 's;.*(;;' -e 's;).*;;'`; \
$(POD2MAN) --quotes=none \
--section=5 --center="AS Preferences File" \
- --release="$$D" --date="asgui $$VS" as-gui.conf.pod | \
+ --release="$$D" --date="as-gui $$VS" as-gui.conf.pod | \
sed -e "s;ASGUI_VERSION_STR;$$VL;" >as-gui.conf.5
install: all
$(SHTOOL) mkdir -f -p -m 755 $(DESTDIR)$(prefix)
$(SHTOOL) mkdir -f -p -m 755 $(DESTDIR)$(bindir)
-# $(SHTOOL) mkdir -f -p -m 755 $(DESTDIR)$(mandir)/man1
-# $(SHTOOL) mkdir -f -p -m 755 $(DESTDIR)$(mandir)/man5
+ $(SHTOOL) mkdir -f -p -m 755 $(DESTDIR)$(mandir)/man1
+ $(SHTOOL) mkdir -f -p -m 755 $(DESTDIR)$(mandir)/man5
+ $(SHTOOL) mkdir -f -p -m 755 $(DESTDIR)$(datadir)
$(SHTOOL) install -c -s -m 755 as-gui $(DESTDIR)$(bindir)/as-gui
-# $(SHTOOL) install -c -m 644 as-gui.1 $(DESTDIR)$(mandir)/man1/as-gui.1
-# $(SHTOOL) install -c -m 644 as-gui.conf.5 $(DESTDIR)$(mandir)/man5/as-gui.conf.5
+ $(SHTOOL) install -c -m 644 as-gui.1 $(DESTDIR)$(mandir)/man1/as-gui.1
+ $(SHTOOL) install -c -m 644 as-gui.conf.5 $(DESTDIR)$(mandir)/man5/as-gui.conf.5
+ $(SHTOOL) install -c -m 644 as-gui.html $(DESTDIR)$(datadir)/as-gui.html
uninstall:
-# $(RM) $(DESTDIR)$(mandir)/man5/as-gui.conf.5
-# $(RM) $(DESTDIR)$(mandir)/man1/as-gui.1
+ $(RM) $(DESTDIR)$(datadir)/as-gui.html
+ $(RM) $(DESTDIR)$(mandir)/man5/as-gui.conf.5
+ $(RM) $(DESTDIR)$(mandir)/man1/as-gui.1
$(RM) $(DESTDIR)$(bindir)/as-gui
-# $(RMDIR) $(DESTDIR)$(mandir)/man5 >/dev/null 2>&1 || $(TRUE)
-# $(RMDIR) $(DESTDIR)$(mandir)/man1 >/dev/null 2>&1 || $(TRUE)
+ $(RMDIR) $(DESTDIR)$(datadir) >/dev/null 2>&1 || $(TRUE)
+ $(RMDIR) $(DESTDIR)$(mandir)/man5 >/dev/null 2>&1 || $(TRUE)
+ $(RMDIR) $(DESTDIR)$(mandir)/man1 >/dev/null 2>&1 || $(TRUE)
$(RMDIR) $(DESTDIR)$(mandir) >/dev/null 2>&1 || $(TRUE)
$(RMDIR) $(DESTDIR)$(bindir) >/dev/null 2>&1 || $(TRUE)
$(RMDIR) $(DESTDIR)$(prefix) >/dev/null 2>&1 || $(TRUE)
@@ -173,7 +182,6 @@
ifdef CORBABASE
$(RM) $(IDL_OBJ)
endif
- $(RM) as-gui.conf.5 as-gui.1
$(RM) as_gui_pcre.tab *.core
distclean: clean
|
|
ossp-pkg/as/as-gui/as-gui.conf.pod 1.2 -> 1.3
--- as-gui.conf.pod 2002/11/28 20:44:36 1.2
+++ as-gui.conf.pod 2003/03/05 20:24:52 1.3
@@ -26,25 +26,78 @@
## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
## SUCH DAMAGE.
##
-## titraq.conf.pod: Plain old documentation file
+## as-gui.conf.pod: Plain old documentation file
##
=pod
=head1 NAME
-B<titraq.conf> - OSSP AS configuration file
+B<as-gui.conf> - as-gui configuration file
=head1 DESCRIPTION
+The B<as-gui> accounting system graphical client allows for easy yet flexible
+accounting of time and tasks. It caters to a variety of user interface tastes
+by offering a variety of parameterized options.
+
+Many such options influence direct rendering of the graphical representation
+of all data and the controls which operate on the data. However, other options
+control communication with the B<AS> server, local report formatting, or
+backup storage.
+
+Features such as macro processing, rulesets, account aliases, and session
+tuning will be stored as well (when these future preferences are finally
+implemented).
+
+Because of the many possibilities offered, there exists a system to manage the
+preferences involved. The system depends on the preferences file F<~/.as-gui>,
+reading data from it when starting and running B<as-gui>, and storing data to
+it when finally terminating.
+
+The file F<~/.as-gui> is stored in XML format, and is parsed internally by
+B<as-gui>. There is no need to edit this file, although there is also no harm
+in doing so. Please remember that all parameters may change during runtime, so
+it is wisest to edit after quitting the B<as-gui> application.
+
+Attenzione! During runtime, all parameters are user-defined and are accessible
+by selecting the 'Preferences...' subitem under the 'Edit' menu.
+
=head1 EXAMPLES
+Entries taken from a preferences file:
+
+=over 4
+
+=item B<Location of events file>
+
+<option key="asfile" value="~/.as/events" />
+
+=item B<Location of accounts file>
+
+<option key="accounts" value="~/.as/accounts" />
+
+=item B<Visibility indicator of the amount column>
+
+<option key="amountcolshow" value="true" />
+
+=item B<Width in pixels of the amount column>
+
+<option key="amountcolwidth" value="60" />
+
+=item B<Flag to enable automatic file backups>
+
+<option key="autobackup" value="true" />
+
+=back
+
=head1 SEE ALSO
-titraq(1)
+as-gui(1)
=head1 AUTHOR
Michael Schloh von Bennewitz
+(michael@schloh.com)
=cut
|
|
ossp-pkg/as/as-gui/as-gui.pod 1.3 -> 1.4
--- 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
|
|
ossp-pkg/as/as-gui/devtool.conf 1.13 -> 1.14
--- devtool.conf 2003/02/14 14:58:34 1.13
+++ devtool.conf 2003/03/05 20:24:52 1.14
@@ -13,6 +13,7 @@
%configure
./configure \
--prefix=/tmp/as_gui \
+ --datadir=/tmp/as_gui/share \
--with-mico \
--with-esoap \
"$@"
|
|
