gnue common/etc/sample.gnue.conf common/etc/sam...

[Jason Cater]

CVSROOT:        /cvsroot/gnue
Module name:    gnue
Changes by:     Jason Cater <address@hidden>    02/04/14 17:06:00

Modified files:
        common/etc     : sample.gnue.conf sample.report-filters.conf 
        reports        : INSTALL 

Log message:
        more documentation

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/common/etc/sample.gnue.conf.diff?tr1=1.28&tr2=1.29&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/common/etc/sample.report-filters.conf.diff?tr1=1.6&tr2=1.7&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/reports/INSTALL.diff?tr1=1.4&tr2=1.5&r1=text&r2=text

Patches:
Index: gnue/common/etc/sample.gnue.conf
diff -c gnue/common/etc/sample.gnue.conf:1.28 
gnue/common/etc/sample.gnue.conf:1.29
*** gnue/common/etc/sample.gnue.conf:1.28       Sun Apr 14 16:20:42 2002
--- gnue/common/etc/sample.gnue.conf    Sun Apr 14 17:06:00 2002
***************
*** 233,239 ****
  
  # Sendmail binary (for EmailAdapter=sendmail)
  SendmailBin = /usr/sbin/sendmail
! SendmailFrom = address@hidden
  SendmailSubject = Your Requested Report
  
  # HylaFax sendfax binary (for FaxAdapter = hylafax)
--- 233,239 ----
  
  # Sendmail binary (for EmailAdapter=sendmail)
  SendmailBin = /usr/sbin/sendmail
! SendmailFrom = "GNUe Reports Server" address@hidden
  SendmailSubject = Your Requested Report
  
  # HylaFax sendfax binary (for FaxAdapter = hylafax)
Index: gnue/common/etc/sample.report-filters.conf
diff -c gnue/common/etc/sample.report-filters.conf:1.6 
gnue/common/etc/sample.report-filters.conf:1.7
*** gnue/common/etc/sample.report-filters.conf:1.6      Sun Apr 14 16:21:19 2002
--- gnue/common/etc/sample.report-filters.conf  Sun Apr 14 17:06:00 2002
***************
*** 1,17 ****
! 
  [mappings]
! standard = GNUe:Reports:Standard
! testing = GNUe:Reports:SimpleTabulation
  
  
! [testing:text]
  description = Basic text without any formatting
  engine = sablotron
  script = text.xsl
  mimetype = text/plain
  
  
! [testing:html]
  description = HTML 3.0-compatable markup.
  engine = sablotron
  script = html.xsl
--- 1,19 ----
! #
! # This creates a nickname for the various report types.
! #
  [mappings]
! simple = GNUe:Reports:SimpleTabulation
! #standard = GNUe:Reports:Standard
  
  
! [simple:text]
  description = Basic text without any formatting
  engine = sablotron
  script = text.xsl
  mimetype = text/plain
  
  
! [simple:html]
  description = HTML 3.0-compatable markup.
  engine = sablotron
  script = html.xsl
Index: gnue/reports/INSTALL
diff -c gnue/reports/INSTALL:1.4 gnue/reports/INSTALL:1.5
*** gnue/reports/INSTALL:1.4    Tue Apr  9 18:55:41 2002
--- gnue/reports/INSTALL        Sun Apr 14 17:06:00 2002
***************
*** 5,33 ****
  
  ./setup.py install
  
! Make sure that you've have a valid /usr/local/gnue/etc/gnue.conf
! This is installed by gnue-common package as a sample.gnue.conf
! you have to edit and move rename the file
! 
! Currently, only a non-server report engine will run (i.e., the 
! background server implementation of Reports is not complete). 
! This means Reports is currently useful for evaluation or for 
! small, centralized (2-tier) sites. 
  
  
  General information:
  ====================
  
  GNUe-Reports needs some prerequisites to work. You need a database
! managment system, python as programming language and a xml-handling
! library.  
  
! The following minimum programs are required for running GNUe-Reports: 
  
!  Python 2.0 or later          http://www.python.org/
!  GNUe-Common                  http://www.gnuenterprise.org/downloads/common
  
- To do any useful report conversions based on our samples, you will need:  
-  * An XSLT processor (currently we use Sablotron and PySablot)
  
  
--- 5,153 ----
  
  ./setup.py install
  
! Make sure that you have a valid /usr/local/gnue/etc/gnue.conf and
! a valid /usr/loca/gnue/etc/report-filters.conf.  Sample versions of
! these files are installed by gnue-common as sample.gnue.conf and
! sample.report-filters.conf.  These samples will be sufficient for
! most sites. Simply copy the sample files to the needed files.
! 
! Currently, only a non-server report engine will run (i.e., the
! background server implementation of Reports is not complete).
! This means Reports is currently useful for evaluation or for
! small, centralized (2-tier) sites.
  
  
  General information:
  ====================
  
  GNUe-Reports needs some prerequisites to work. You need a database
! managment system and the scripting language Python (version 2.0 or
! higher).  Most modern Unix platforms have a python package available.
  
! The following minimum programs are required for running GNUe-Reports:
  
!  Python 2.0 or later    http://www.python.org/
!  GNUe-Common            http://www.gnuenterprise.org/downloads/common
!  Sablotron              http://www.gingerall.com/charlie/ga/xml/p_sab.xml
!  PySablot               http://sourceforge.net/projects/pysablot/
! 
! 
! 
! Support for the "printer" destination
! =====================================
! Currently, the only "printer" adapter available is the "bsd" adapter. This
! adapter uses the command-line "lpr".  Most Unix distro's include some form
! of "lpr" command.
! 
! You should modify your gnue.conf and set the EmailAdapter to "bsd":
! 
!   EmailAdapter = bsd
! 
! Also, you can modify the following parameters to better reflect your
! local setup:
! 
!   LprCommand = /usr/bin/lpr -P%s
! 
! Note the "%s" -- this will be replaced with the printer spool specified by
! the end user.  It is important to include this "%s".
! 
! You can now send reports via email. Example grrun:
! 
!   $ grrun -D printer -d lp --filter text myreport.grd
! 
! The report will be run as a "text" document, then sent, via lpr, to
! the printer "lp".
! 
! 
! 
! Support for the "file" destination
! ==================================
! Currently, the only "file" adapter available is the "text" adapter. This
! adapter simply creates a text file with the provided name.
! 
! You should modify your gnue.conf and set the FileAdapter to "text":
! 
!   FileAdapter = text
! 
! Example grrun:
! 
!   $ grrun -D file -d $HOME/myreport.html --filter html myreport.grd
! 
! The report will be run as an "html" document and saved to the file
! "myreport.html" in the user's home directory.
! 
! Note that if the destination is set to "-", then the stdout "file" is used.
! In other words, -d -  will output the report to the console (or through a
! unix pipe.)  When using -d-, it is best to also specify the --quiet option.
! 
! Example grrun:
! 
!   $ grrun -D file -d- --filter html | enscript -P lp
! 
! 
! 
! 
! Support for the "email" destination
! ===================================
! Currently, the only "email" adapter available is the "sendmail" adapter.
! Work is underway for a native SMTP adapter that will communicate directly
! with an SMTP server.
! 
! You should modify your gnue.conf and set the EmailAdapter to "sendmail":
! 
!   EmailAdapter = sendmail
! 
! Also, you can modify the following parameters to better reflect your
! local setup:
! 
!   SendmailBin = /usr/sbin/sendmail
!   SendmailFrom = "GNUe Reports Server" address@hidden
!   SendmailSubject = Your Requested Report
! 
! You can now send reports via email. Example grrun:
! 
!   $ grrun -D email -d address@hidden --filter html myreport.grd
! 
! The report will be sent as an attachment. In the above example, the
! attachment will be an "html" file.
! 
! 
! 
! Support for the "fax" destination
! =================================
! Currently, the only "fax" adapter available is the "hylafax" adapter.
! Support for HylaFax is provided by the "sendfax" command.  The hylafax
! adapter does not communicate directly with the hylafax server, but,
! rather, uses HylaFax's "sendfax" command-line program.
! 
! Before attempting to send faxes via GNUe Reports, be sure to test the
! sendfax command line tool manually and make sure it is properly configured:
! 
!   sendfax -n -d <myfaxnumber> -h <faxhost> /etc/issue
! 
! Once you are satisfied that your local machine is configured properly for
! HylaFax, you should modify your gnue.conf to set the FaxAdapter parameter:
! 
!   FaxAdapter = hylafax
! 
! Also, you can modify the following parameters to better reflect your
! local setup:
! 
!   HylaFaxCommand = /usr/bin/sendfax -n -h faxserver.mydomain.com -d %s
! 
! Note the "%s" -- this will be replaced with the fax number specified by
! the end user.  It is important to include this "%s".
! 
! You can now send reports via HylaFAX. Example grrun:
! 
!   $ grrun -D fax -d 1-901-555-4433 --filter text myreport.grd
! 
! The report will be run as a "text" document, then sent, via sendfax, to
! the fax machine at (901) 555-4433.  Note that --filter must be a type
! that sendfax can convert.  Once Postscript support is added to GNUe
! Reports, "--filter postscript" will be the logical choice. Until then,
! unless you've manually configured sendfax to convert html documents,
! "--filter text" is the only choice.