raw/man1/octave-bug.1

   1 .\" Man page for octave-bug
   2 .\"
   3 .\" Copyright (C) 1996 - 2000 John W. Eaton
   4 .\"
   5 .\" This file is part of Octave.
   6 .\"
   7 .\" Octave is free software; you can redistribute it and/or modify it
   8 .\" under the terms of the GNU General Public License as published by the
   9 .\" Free Software Foundation; either version 2, or (at your option) any
  10 .\" later version.
  11 .\"
  12 .\" Octave is distributed in the hope that it will be useful, but WITHOUT
  13 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 .\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 .\" for more details.
  16 .\"
  17 .\" You should have received a copy of the GNU General Public License
  18 .\" along with Octave; see the file COPYING.  If not, write to the Free
  19 .\" Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 .\" 02111-1307, USA.
  21 .\"
  22 .\" This page was contributed by Dirk Eddelbuettel <edd@debian.org>
  23 .\"
  24 .TH octave-bug 1 "6 March 2000" GNU
  25 .LO 1
  26 .SH NAME
  27 octave-bug \- report a bug in GNU Octave
  28 .SH SYNOPSIS
  29 .B octave-bug
  30 .RB [\| \-s
  31 .IR subject \|]
  32 .SH DESCRIPTION
  33 .B octave-bug
  34 is a shell script to help the user compose and mail bug reports
  35 concerning Octave in a standard format.
  36 .B octave-bug
  37 is typically invoked by the Octave command
  38 .B bug_report
  39 which is intended to be called interactively from within Octave. This
  40 provides the best way to submit a bug report for Octave. It creates a
  41 template bug report file and starts an editor on that file.  The bug report
  42 will be sent to the bug-octave mailing list once the editing has been
  43 completed (this assumes of course that your system can use email). However,
  44 the user could also call \fBoctave-bug\fR outside of Octave.
  45 .PP
  46 Please read the `Bugs' chapter in the Octave manual to find out how to submit
  47 a bug report that will enable the Octave maintainers to fix the problem.  If
  48 you are unable to use the bug_report command, send your message to the
  49 bug-octave mailing list, bug-octave@bevo.che.wisc.edu.
  50 .SH OPTIONS
  51 .TP
  52 .BI -s\  subject
  53 Specify a subject line for the bug report.  Spaces in the subject must
  54 be quoted.
  55 .SH ENVIRONMENT VARIABLES
  56 .B
  57 octave-bug
  58 uses the environment variables
  59 .BR USER,
  60 .BR EDITOR,
  61 and
  62 .B PAGER
  63 which can be used for customization.
  64 .SH VERSION
  65 This document was last revised for Octave version 2.0.16.
  66 .SH SEE ALSO
  67 .BR octave (1),
  68 .BR bashbug (1)
  69 .SH AUTHOR
  70 .nf
  71 John W. Eaton
  72 Department of Chemical Engineering
  73 University of Wisconsin-Madison
  74 Madison, WI 53706
  75 USA
  76 <jwe@bevo.che.wisc.edu>