This directory contains the tools and documentation, which should be used by
Cygnus Support customers, to submit problem reports (PRs) to Cygnus Support in
order to obtain support.

The tools can also be used by users of free software, who would like to submit
a bug report to Cygnus Support for software maintained by Cygnus.


The tools are:

	`send_pr' and `send_pr.1' - a shell script and it's man page for
				    submitting PRs

	`send_pr.elc' - an EMACS interface for send_pr


PLEASE READ THE MAN PAGE FOR SEND_PR VERY CAREFULLY
===================================================

The more precise your description and the more complete your information, the
faster your support team at Cygnus Support can solve your problems. The man
page describes, which information we need and in which form it should be.


IN ORDER TO SUBMIT PRs TO CYGNUS SUPPORT, YOU NEED A UNIQUE CUSTOMER-ID
=======================================================================

You can obtain your customer-id by invoking `send_pr -request-id' (or by
sending mail to `cygnus-bugs@cygnus.com' with the subject line `request for a
customer-id' and the text `>Category: prms'). We prefer however that you use
`send_pr', because then the mail connection gets tested at the same time.


INSTALLATION OF SEND_PR
=======================

Send_pr is part of the Cygnus Support software system and the installation
procedure is the same as for the other components.

To install it isolated from the other tools do the following:

0) If you have not yet your unique customer-id, then execute

	`cd ../send_pr; sh send_pr.sh -request-id'

   or call the Cygnus Support hotline: +1-415-322-7836


1) Store the customer-id and other site specific information in a 
   site specific makefile fragment in ../send_pr/config/ms-* .

   To do that, copy any site specific makefile (eg send_pr/config/ms-cygnus),
   change all fields, which should be different at your site. Store the 
   modified file as ../send_pr/config/ms-MYSITE.

   You can modify the following macros:

	## The unique customer-id
	CUSTOMER_ID = cygnus
	##
	## The address, where the problem reports are sended to
	MAIL_ADDR = cygnus-bugs@cygnus.com
	##
	## To this address copies of the problem reports are mailed 
	CC_ADDR =
	##
	## When using the EMACS interface to send_pr, set this to `send-pr'
	EMACS_PRMS_MODE = send-pr # text
	##
	## Default values for the form (only used in the EMCACS inteface)
	DEFAULT_CATEGORY = other
	DEFAULT_RELEASE = devo


  To use the EMACS interface, set the macro EMACS_PRMS_MODE to `send-pr'.
  Also, the EMACS interface `send_pr.elc' gets installed into 
  `$(datadir)/emacs/lisp' (see `Makefile.in'). If you want the EMACS interface
  to be installed somewhere else, then set the macro `lispdir' in the 
  site specific makefile to the appropriate value.

2) Now you have to configure `send_pr'. I.e. create a Makefile using the site
   specific macros and configuration parameters.

   For example 

	`../configure sun4 -prefix=/usr/local -site=MYSITE' 

   Where you are configuring for a `SUN 4', the prefix for installation
   directories is `/usr/local' and the name of your site specific makefile is
   `mysite'.

3) Then simple type `make all install'. 

   This builds and installs `send_pr', `send_pr.1' and `send_pr.elc'.

4) Installation of the EMACS user interface to send_pr

  To use the EMACS interface, you have to put the following lines either 
  into your `.emacs' file or into the general EMACS startup file`default.el'
  (see also send_pr.els):

	;(autoload 'send-pr-mode "send_pr"
	;	  "Major mode for sending problem reports." t)

	;(autoload 'send-pr "send_pr"
	;	  	  "Command to create and send a problem report." t)

  Now you can invoke send_pr from within EMACS with `M-x send-pr'.




PRMS is free software.  See the file COPYING for copying permission.
