71 lines
2.6 KiB

.\" Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH KUGAR 1 "May 9, 2003"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
kugar \- a business report maker for the KDE Office Suite
.SH SYNOPSIS
.B kugar
[ \fIgeneric-options\fP ]
[ \fB\-\-print\fP ]
[ \fIxml-data-file\fP ... ]
.SH DESCRIPTION
\fBKugar\fP is a tool for generating business quality reports that can
be viewed and printed. It includes a standalone report viewer and a
KPart report viewer. The latter means that any KDE application can
embed the report viewing functionality and that reports can be viewed
using the Konqueror browser.
.PP
Kugar will create a report for the data stored in the data file
\fIxml-data-file\fP. Data files typically end in \fB.kud\fP.
Note that simply clicking on a data file in Konqueror will cause Kugar
to create a report.
.PP
The data will be displayed according to the layout described in a template
file. This template file is generally named in the data file.
Template files typically end in \fB.kut\fP. See
.BR kudesigner (1)
for a tool for creating template files.
.PP
This application is part of the KDE Office Suite.
.SH OPTIONS
Below are the kugar-specific options.
For a full summary of options, run \fIkugar \-\-help\fP.
.TP
\fB\-\-print\fP
Print the given file(s) and exit.
.SH SEE ALSO
.BR kudesigner (1).
.PP
Full user documentation is available through the KDE Help Centre.
You can also enter the URL
\fIhelp:/kugar/\fP
directly into konqueror or you can run
`\fIkhelpcenter help:/kugar/\fP'
from the command-line.
.PP
If the KDE Help Centre is not installed then you can install the package
\fIkoffice-doc-html\fP and read this documentation in HTML format from
\fI/usr/share/doc/tde/HTML/en/kugar/\fP.
.SH AUTHOR
Kugar was written by Keith Davis (Mutiny Bay Software)
<info@mutinybaysoftware.com>, Phil Thompson <phil@river-bank.demon.co.uk>,
Alexander Dymo <cloudtemple@mksat.net>, Joseph Wenninger <jowenn@jowenn.at>
and Joris Marcillac <joris@marcillac.com>.
.br
This manual page was prepared by Ben Burton <bab@debian.org>
for the Debian GNU/Linux system (but may be used by others).