.ig Copyright (C) 2000-2002 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be included in translations approved by the Free Software Foundation instead of in the original English. .. .TH GRRUN 1 "02 June 2002" "GNUe Reports Client" .SH NAME grrun \- GNUe Reports Client .SH SYNOPSIS .ll +8 .B grrun [ .I options ] .I file [ .I param1 = .I val ] [ .I param2 = .I val ] .I \&... .SH DESCRIPTION GNUe Reports is the primary reporting agent of the GNU Enterprise system. .SH OPTIONS .TP .B \-\-comment, \-C Include structural comments in the XML output stream. Useful for debugging .grd files. .TP .B \-\-configuration-options Displays a list of valid configuration file entries, their purpose, and their default values. .TP .B \-\-connections Specifies the location of the connection definition file. may specify a file name (/usr/local/gnue/etc/connections.conf), or a URL location (http://localhost/connections.conf). If this option is not specified, the environent variable GNUE_CONNECTIONS is checked. .TP .B \-\-debug-file Sends all debugging messages to a specified file (e.g., "\-\-debug\-file trace.log" sends all output to "trace.log") .TP .B \-\-debug-level Enables debugging messages. Argument specifies the level of messages to display (e.g., "\-\-debug\-level 5" displays all debugging messages at level 5 or below.) .TP .B \-\-destination , \-d Where should the report be output to? The value of this depends on the destination type (e.g., if sending to printer, then \-d specifies the printer name; if sending via email, then \-d specifies the email address.) If is "\-", then output is sent to stdout \-\- NOTE: when sending to stdout, also use the \-q [\-\-quiet] option or you may get junk in your output stream. NOTE: Currently the default value is "\-" \-\- this may change once GNUe Reports is formally released! .TP .B \-\-destination-options Options to pass to the destination process. Available options are specific to the type of destination. Example: \'\-\-destination\-options "\-o nobanner" ' .TP .B \-\-destination-type , \-D This specifies how the report should be output. The currently supported values for are file [default], printer, email, and fax. Note that printer, email, and fax are sent via the server's machine, not the client's machine. To NOTE: Only file, printer, and email are currently implemented! .TP .B \-\-exclude-xml, \-X Do not output GNUe Reports runtime XML markup information. If specified, then the GRDs layout section will be processed and output as\-is; i.e., without any additional information added by GNUe Reports. .TP .B \-\-filter , \-f Select the filter to be used to process report output. is the name of the filtering process as defined on the Report Server machine. If not specified, the "raw" filter is used (i.e., no filtering takes place.) .TP .B \-\-filter-list List the available [predefined] filters available to GNUe Reports .TP .B \-\-filter-options , \-F Options to pass to the filter process. Available options are specific to the filter. \-\-filter\-list will list available filters and their options. Example: '\-\-filter\-options "paper=letter margin=1,1,1,1" ' .TP .B \-\-generate-man-page Generates a groff\-formatted man page as a file in the current directory. .TP .B \-\-help Displays this help screen. .TP .B \-\-interactive-debugger Run the app inside Python's built\-in debugger .TP .B \-\-pass Password used to log into the database. Note that if specified, this will be used for all databases. If not supplied, the program will prompt for password. NOTE: SUPPLYING A PASSWORD VIA THE COMMAND LINE MAY BE CONSIDERED A SECURITY RISK. .TP .B \-\-profile Run Python's built\-in profiler and display the resulting run statistics. .TP .B \-\-quiet, \-q Run GNUe Reports in quiet mode \-\- i.e., display no output. NOTE: if \-\-debug\-level is specified, then suppressed text will be output as debugging information (at debug level 1) .TP .B \-\-sort , \-s Select the "sort\-option" used to sort the report. .TP .B \-\-standalone, \-S Create a standalone, single\-use server instance. Use this option in a non\-client/server environment or in a debugging/development environment. NOTE: Until the Reports Server is operational, this mode is implied .TP .B \-\-user , \-u Username used to log into the database. Note that if specified, this will be used for all databases. If not supplied, the program will prompt for username. .TP .B \-\-version Displays the version information for this program. .SH AUTHOR GNU Enterprise Project .SH BUGS Please report any bugs to info@gnue.org. Include a complete, self-contained example that will allow the bug to be reproduced, and say which version of this tool you are using. .SH COPYRIGHT Copyright \(co 2000-2002 Free Software Foundation, Inc. .LP grrun is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. .LP grrun is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. .LP You should have received a copy of the GNU General Public License along with grrun; see the file COPYING. If not, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.