File: apsfilter-bug.1.in

package info (click to toggle)
apsfilter 7.2.6-2
  • links: PTS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 2,496 kB
  • sloc: sh: 450; ansic: 236; perl: 175; makefile: 159
file content (140 lines) | stat: -rw-r--r-- 3,968 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
.\"
.\" $ApsCVS: src/apsfilter/man/apsfilter-bug.1.in,v 1.1.2.3 2002/02/24 20:47:52 andreas Exp $
.\"
.Dd Dec 26, 2001
.Dt APSFILTER-BUG 1
.Os
.Sh NAME
.Nm apsfilter-bug
.Nd create a half-automatic bug report for apsfilter
.Sh SYNOPSIS
.Nm apsfilter-bug
.Sh OPTIONS
none
.Sh DESCRIPTION
With the
.Nm apsfilter-bug
script you can automatically create a bug report for
.Xr apsfilter 1 .
A template report file is created which you can edit with your
favourite editor (
.Xr emacs 1
by default, or whatever is entered in the environment variable
.Ic EDITOR ).
.Pp
You will see a couple of lines starting with '#'; these lines
will be removed before the report is sent. So if you want to use
the '#' character at the beginning of a line, just indent it with
a space.
.Pp
A very important piece of the bug report is the debugging log
created by
.Xr aps2file 1 ,
probably with a command like
.Dl aps2file -D -o /dev/null [-P...] [-Z...] [input] 2> log.txt
Unless you don't even have a chance to create a debugging log, it
is crucial for serious bug hunting.
.Pp
After you have filled in as much (useful) information as possible,
you must save the file under its original name, then exit your
editor.
.Pp
If you invoked
.Nm
by accident, or if you need some additional system information
to include into the bug report, just exit your editor without
saving the file.
.Sh NOTES
In addition to the stuff you've edited, some more information is
appended to the bug report automatically:
.Pp
.Bl -tag -width ghostscript_version -compact
.It apsfilter version
@VERSION@-@branch@
.It ghostscript version
(from 'gs --version')
.It system id
(from 'uname -a')
.It configure options
@confopts@
.It shell executable
@shell@
.It awk executable
@awk@
.It sendmail executable
@sendmail@
.Sh FILES
.Bl -tag -width @bindir@/aps2file -compact
.It Pa @bindir@/aps2file
script to create debugging output
.Sh SEE ALSO
.Xr apsfilter 1 ,
.Xr aps2file 1
.Sh BUGS
See apsfilter software center -
.Li http://www.apsfilter.org/
- for new versions, bugfixes and known bugs.
.Pp
Please use the new tool
.Xr apsfilter-bug 1
to release bug- or problem reports. It automatically presents you a
.Nm form
in an editor window which asks you some standard questions.
If you save and quit the editor session, then this report is
sent automatically via 
.Nm e-mail
to the proper apsfilter mailinglist.
.Pp
If apsfilter fails to print something or prints it in a way
you wouldn't expect and you want to report an apsfilter error
then please save the debugging output of one print session
using the new
.Xr aps2file 1
utility by typing
.Nm aps2file -D -Z options file > /dev/null 2> file.debug
and including the debugging output in the file
.Nm file.debug
into the edit session of the
.Nm apsfilter-bug
utility, so that it is included into the mail to the apsfilter
mailinglist.
.Pp
Please note that you need to run /bin/sh (Bourne Shell), bash
or a compatible shell, so that the above mentioned output
redirection works. Under C-shell (/bin/csh) or tcsh it would't
work. If you don't know, then simply make sure you use the
Bournce shell by typing
.Nm /bin/sh
or
.Nm bash ,
then you should have no problems with redirection of
.Nm stdout
and
.Nm stderr
(> /dev/null 2> file.debug).
.Sh DOCUMENTATION
See official apsfilter homepage
.Bl -tag -width XXXXXXXXXXXXXTHIS_MUCH_SPACEXXXXXXXXXXX -compact
.It Pa http://www.apsfilter.org/handbook.html
Apsfilter Handbook including the Frequently Asked Questions (FAQ)
.Sh USER FORUM
Please send questions to the official apsfilter help channel
.Ic apsfilter-help@apsfilter.org .
The above section
.Nm BUGS
and the file
.Ic HOWTO-BUGREPORTS
tells you how to report bugs.
If you want to know how to troubleshoot your apsfilter installation,
please read the manpage
.Xr aps2file 1
and
.Xr apsfilter-bug 1
as well as the
.Ic Apsfilter Handbook
carefully.
.Sh HISTORY
The
.Nm
manpage has been written by Michael Loin <phallobst@web.de>
and first appeared in apsfilter V 7.1.0.