# HG changeset patch # User jwe # Date 952405769 0 # Node ID bebbcd4694a8a84a73298c487da221b7d51d9fc3 # Parent 5446d3f11362ba88615c57fd1366e94f14647a0b [project @ 2000-03-07 05:08:49 by jwe] diff --git a/doc/ChangeLog b/doc/ChangeLog --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2000-03-06 John W. Eaton + + * interpreter/octave-bug.1: New file. + * interpreter/Makefile.in (install install-strip): Install it. + (DISTFILES, BINDISTFILES): Add it to the + 2000-02-23 John W. Eaton * interpreter/Makefile.in (clean): Also delete munge-texi, diff --git a/doc/interpreter/Makefile.in b/doc/interpreter/Makefile.in --- a/doc/interpreter/Makefile.in +++ b/doc/interpreter/Makefile.in @@ -38,13 +38,13 @@ FORMATTED = octave.dvi octave.ps octave.info octave.info-[0-9]* octave_*.html -DISTFILES = Makefile.in dir munge-texi.cc Map-s.cc octave.1 \ +DISTFILES = Makefile.in dir munge-texi.cc Map-s.cc octave.1 octave-bug.1 \ $(SOURCES) $(TEXINFO) $(FORMATTED) ifeq ($(wildcard octave.info), ) - BINDISTFILES = $(addprefix $(srcdir)/, octave.1 $(FORMATTED)) + BINDISTFILES = $(addprefix $(srcdir)/, octave.1 octave-bug.1 $(FORMATTED)) else - BINDISTFILES = $(srcdir)/octave.1 $(FORMATTED) + BINDISTFILES = $(srcdir)/octave.1 $(srcdir)/octave-bug.1 $(FORMATTED) endif # Look for version.h to get version information. @@ -117,6 +117,9 @@ rm -f $(man1dir)/octave$(man1ext); \ echo "installing $(srcdir)/octave.1 in $(man1dir)"; \ $(INSTALL_DATA) $(srcdir)/octave.1 $(man1dir)/octave$(man1ext); \ + rm -f $(man1dir)/octave-bug$(man1ext); \ + echo "installing $(srcdir)/octave-bug.1 in $(man1dir)"; \ + $(INSTALL_DATA) $(srcdir)/octave-bug.1 $(man1dir)/octave-bug$(man1ext); \ fi @if test -d $(infodir); then \ rm -f $(infodir)/octave.info*; \ diff --git a/doc/interpreter/octave-bug.1 b/doc/interpreter/octave-bug.1 new file mode 100644 --- /dev/null +++ b/doc/interpreter/octave-bug.1 @@ -0,0 +1,76 @@ +.\" Man page for octave-bug +.\" +.\" Copyright (C) 1996 - 2000 John W. Eaton +.\" +.\" This file is part of Octave. +.\" +.\" Octave 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. +.\" +.\" Octave 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 Octave; see the file COPYING. If not, write to the Free +.\" Software Foundation, 59 Temple Place - Suite 330, Boston, MA +.\" 02111-1307, USA. +.\" +.\" This page was contributed by Dirk Eddelbuettel +.\" +.TH octave-bug 1 "6 March 2000" GNU +.LO 1 +.SH NAME +octave-bug \- report a bug in GNU Octave +.SH SYNOPSIS +.B octave-bug +.RB [\| \-s +.IR subject \|] +.SH DESCRIPTION +.B octave-bug +is a shell script to help the user compose and mail bug reports +concerning Octave in a standard format. +.B octave-bug +is typically invoked by the Octave command +.B bug_report +which is intended to be called interactively from within Octave. This +provides the best way to submit a bug report for Octave. It creates a +template bug report file and starts an editor on that file. The bug report +will be sent to the bug-octave mailing list once the editing has been +completed (this assumes of course that your system can use email). However, +the user could also call \fBoctave-bug\fR outside of Octave. +.PP +Please read the `Bugs' chapter in the Octave manual to find out how to submit +a bug report that will enable the Octave maintainers to fix the problem. If +you are unable to use the bug_report command, send your message to the +bug-octave mailing list, bug-octave@bevo.che.wisc.edu. +.SH OPTIONS +.TP +.BI -s\ subject +Specify a subject line for the bug report. Spaces in the subject must +be quoted. +.SH ENVIRONMENT VARIABLES +.B +octave-bug +uses the environment variables +.BR USER, +.BR EDITOR, +and +.B PAGER +which can be used for customization. +.SH VERSION +This document was last revised for Octave version 2.0.16. +.SH SEE ALSO +.BR octave (1), +.BR bashbug (1) +.SH AUTHOR +.nf +John W. Eaton +Department of Chemical Engineering +University of Wisconsin-Madison +Madison, WI 53706 +USA +