--- name: "gnue-reports" section: "1" platform: "linux" package: "gnue-reports" version: "0.1.7-1" release: "Debian 3.1 (Sarge)" platforms: ["linux"] url: "https://new.carta.tech/gnue-reports" --- # gnue-reports(1) GNUe Reports Client ## NAME gnue-reports - GNUe Reports Client ## SYNOPSIS **gnue-reports** \[ *options* \] *file* \[ *param1* = *val* \] \[ *param2* = *val* \] *...* ## DESCRIPTION GNUe Reports is the primary reporting agent of the GNU Enterprise system. ## OPTIONS - **GENERAL OPTIONS** - - **--batch, -b** Run GNUe Reports in batch mode -- i.e., no login information or runtime parameters will be prompted. If required parameters are not provided, then Reports will terminate with an error - **--comment, -C** Include structural comments in the XML output stream. Useful for debugging .grd files. - **--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.If neither of them is set, "/home/reinhard/gnue/etc/connections.conf" is used as a default. - **--debug-file \** Sends all debugging messages to a specified file (e.g., "--debug-file trace.log" sends all output to "trace.log") - **--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.) - **--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! - **--destination-options \** Options to pass to the destination process. Available options are specific to the type of destination. Example: ´--destination-options "-o nobanner" ' - **--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! - **--exclude-xml, -X** Do not output GNUe Report''s runtime XML markup information. If specified, then the GRD's layout section will be processed and output as-is; i.e., without any additional information added by GNUe Reports. - **--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.) - **--filter-options \, -F** Options to pass to the filter process. Available options are specific to the filter. --list-filters will list available filters and their options. Example: '--filter-options "paper=letter margin=1,1,1,1" ' - **--help** Displays this help screen. - **--help-config** Displays a list of valid configuration file entries, their purpose, and their default values. - **--help-connections** Display help information related to database connections, including a list of available drivers. - **--help-dev** Display all options of interest to core developers. - **--interface \, -u** Run GNUe Reports using a specific UI. Possible UIs are text, wx, gtk2, win32, qt and curses. - **--list-filters** List the available \[predefined\] filters available to GNUe Reports - **--password \** 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 if needed. NOTE: SUPPLYING A PASSWORD VIA THE COMMAND LINE MAY BE CONSIDERED A SECURITY RISK AND IS NOT RECOMMENDED. - **--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) - **--sort \, -s** Select the "sort-option" used to sort the report. - **--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 mature this flag has the opposite meaning - **--username \** 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. - **--version** Displays the version information for this program. - **DEVELOPER OPTIONS** - - **--interactive-debugger** Run the app inside Python's built-in debugger - **--profile** Run Python's built-in profiler and display the resulting run statistics. - **--selfdoc \** Generates self-documentation. - **--selfdoc-file \** Specifies the filename that selfdoc should write to. If not provided,\ output is sent to stdout. - **--selfdoc-format \** Format to output the self-documentation in. Supported formats are dependent on the type of selfdoc being created. - **--selfdoc-options \** Options specific to individual selfdoc types. ## AUTHOR GNU Enterprise Project \ ## 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. ## COPYRIGHT Copyright © 2000-2004 Free Software Foundation, Inc. gnue-reports 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. gnue-reports 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. You should have received a copy of the GNU General Public License along with gnue-reports; see the file COPYING. If not, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.