Debian Codegraph @

upstream/debian-unstable/man1/perlbug.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "PERLBUG 1"
58 .TH PERLBUG 1 2026-04-10 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 perlbug \- how to submit bug reports on Perl
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 \&\fBperlbug\fR
68 .PP
69 \&\fBperlbug\fR [\ \fB\-v\fR\ ] [\ \fB\-a\fR\ \fIaddress\fR\ ] [\ \fB\-s\fR\ \fIsubject\fR\ ]
70 [\ \fB\-b\fR\ \fIbody\fR\ |\ \fB\-f\fR\ \fIinputfile\fR\ ] [\ \fB\-F\fR\ \fIoutputfile\fR\ ]
71 [\ \fB\-r\fR\ \fIreturnaddress\fR\ ]
72 [\ \fB\-e\fR\ \fIeditor\fR\ ] [\ \fB\-c\fR\ \fIadminaddress\fR\ |\ \fB\-C\fR\ ]
73 [\ \fB\-S\fR\ ] [\ \fB\-t\fR\ ] [\ \fB\-d\fR\ ] [\ \fB\-h\fR\ ] [\ \fB\-T\fR\ ]
74 .PP
75 \&\fBperlbug\fR [\ \fB\-v\fR\ ] [\ \fB\-r\fR\ \fIreturnaddress\fR\ ]
76 [\ \fB\-ok\fR\ |\ \fB\-okay\fR\ |\ \fB\-nok\fR\ |\ \fB\-nokay\fR\ ]
77 .PP
78 \&\fBperlthanks\fR
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 This program is designed to help you generate bug reports
82 (and thank-you notes) about perl5 and the modules which ship with it.
83 .PP
84 In most cases, you can just run it interactively from a command
85 line without any special arguments and follow the prompts.
86 .PP
87 If you have found a bug with a non-standard port (one that was not
88 part of the \fIstandard distribution\fR), a binary distribution, or a
89 non-core module (such as Tk, DBI, etc), then please see the
90 documentation that came with that distribution to determine the
91 correct place to report bugs.
92 .PP
93 Bug reports should be submitted to the GitHub issue tracker at
94 <https://github.com/Perl/perl5/issues>. The \[email protected]\fR
95 address no longer automatically opens tickets. You can use this tool
96 to compose your report and save it to a file which you can then submit
97 to the issue tracker.
98 .PP
99 In extreme cases, \fBperlbug\fR may not work well enough on your system
100 to guide you through composing a bug report. In those cases, you
101 may be able to use \fBperlbug \-d\fR or \fBperl \-V\fR to get system
102 configuration information to include in your issue report.
103 .PP
104 When reporting a bug, please run through this checklist:
105 .IP "What version of Perl you are running?" 4
106 .IX Item "What version of Perl you are running?"
107 Type \f(CW\*(C`perl \-v\*(C'\fR at the command line to find out.
108 .IP "Are you running the latest released version of perl?" 4
109 .IX Item "Are you running the latest released version of perl?"
110 Look at <http://www.perl.org/> to find out. If you are not using the
111 latest released version, please try to replicate your bug on the
112 latest stable release.
113 .Sp
114 Note that reports about bugs in old versions of Perl, especially
115 those which indicate you haven't also tested the current stable
116 release of Perl, are likely to receive less attention from the
117 volunteers who build and maintain Perl than reports about bugs in
118 the current release.
119 .IP "Are you sure what you have is a bug?" 4
120 .IX Item "Are you sure what you have is a bug?"
121 A significant number of the bug reports we get turn out to be
122 documented features in Perl. Make sure the issue you've run into
123 isn't intentional by glancing through the documentation that comes
124 with the Perl distribution.
125 .Sp
126 Given the sheer volume of Perl documentation, this isn't a trivial
127 undertaking, but if you can point to documentation that suggests
128 the behaviour you're seeing is \fIwrong\fR, your issue is likely to
129 receive more attention. You may want to start with \fBperldoc\fR
130 perltrap for pointers to common traps that new (and experienced)
131 Perl programmers run into.
132 .Sp
133 If you're unsure of the meaning of an error message you've run
134 across, \fBperldoc\fR perldiag for an explanation. If the message
135 isn't in perldiag, it probably isn't generated by Perl. You may
136 have luck consulting your operating system documentation instead.
137 .Sp
138 If you are on a non-UNIX platform \fBperldoc\fR perlport, as some
139 features may be unimplemented or work differently.
140 .Sp
141 You may be able to figure out what's going wrong using the Perl
142 debugger. For information about how to use the debugger \fBperldoc\fR
143 perldebug.
144 .IP "Do you have a proper test case?" 4
145 .IX Item "Do you have a proper test case?"
146 The easier it is to reproduce your bug, the more likely it will be
147 fixed \-\- if nobody can duplicate your problem, it probably won't be
148 addressed.
149 .Sp
150 A good test case has most of these attributes: short, simple code;
151 few dependencies on external commands, modules, or libraries; no
152 platform-dependent code (unless it's a platform-specific bug);
153 clear, simple documentation.
154 .Sp
155 A good test case is almost always a good candidate to be included in
156 Perl's test suite. If you have the time, consider writing your test case so
157 that it can be easily included into the standard test suite.
158 .IP "Have you included all relevant information?" 4
159 .IX Item "Have you included all relevant information?"
160 Be sure to include the \fBexact\fR error messages, if any.
161 "Perl gave an error" is not an exact error message.
162 .Sp
163 If you get a core dump (or equivalent), you may use a debugger
164 (\fBdbx\fR, \fBgdb\fR, etc) to produce a stack trace to include in the bug
165 report.
166 .Sp
167 NOTE: unless your Perl has been compiled with debug info
168 (often \fB\-g\fR), the stack trace is likely to be somewhat hard to use
169 because it will most probably contain only the function names and not
170 their arguments. If possible, recompile your Perl with debug info and
171 reproduce the crash and the stack trace.
172 .IP "Can you describe the bug in plain English?" 4
173 .IX Item "Can you describe the bug in plain English?"
174 The easier it is to understand a reproducible bug, the more likely
175 it will be fixed. Any insight you can provide into the problem
176 will help a great deal. In other words, try to analyze the problem
177 (to the extent you can) and report your discoveries.
178 .IP "Can you fix the bug yourself?" 4
179 .IX Item "Can you fix the bug yourself?"
180 If so, that's great news; bug reports with patches are likely to
181 receive significantly more attention and interest than those without
182 patches. Please submit your patch via the GitHub Pull Request workflow
183 as described in \fBperldoc\fR perlhack. You may also send patches to
184 \&\fBperl5\[email protected]\fR. When sending a patch, create it using
185 \&\f(CW\*(C`git format\-patch\*(C'\fR if possible, though a unified diff created with
186 \&\f(CW\*(C`diff \-pu\*(C'\fR will do nearly as well.
187 .Sp
188 Your patch may be returned with requests for changes, or requests for more
189 detailed explanations about your fix.
190 .Sp
191 Here are a few hints for creating high-quality patches:
192 .Sp
193 Make sure the patch is not reversed (the first argument to diff is
194 typically the original file, the second argument your changed file).
195 Make sure you test your patch by applying it with \f(CW\*(C`git am\*(C'\fR or the
196 \&\f(CW\*(C`patch\*(C'\fR program before you send it on its way. Try to follow the
197 same style as the code you are trying to patch. Make sure your patch
198 really does work (\f(CW\*(C`make test\*(C'\fR, if the thing you're patching is covered
199 by Perl's test suite).
200 .ie n .IP "Can you use ""perlbug"" to submit a thank-you note?" 4
201 .el .IP "Can you use \f(CWperlbug\fR to submit a thank-you note?" 4
202 .IX Item "Can you use perlbug to submit a thank-you note?"
203 Yes, you can do this by either using the \f(CW\*(C`\-T\*(C'\fR option, or by invoking
204 the program as \f(CW\*(C`perlthanks\*(C'\fR. Thank-you notes are good. It makes people
205 smile.
206 .PP
207 Please make your issue title informative. "a bug" is not informative.
208 Neither is "perl crashes" nor is "HELP!!!". These don't help. A compact
209 description of what's wrong is fine.
210 .PP
211 Having done your bit, please be prepared to wait, to be told the
212 bug is in your code, or possibly to get no reply at all. The
213 volunteers who maintain Perl are busy folks, so if your problem is
214 an obvious bug in your own code, is difficult to understand or is
215 a duplicate of an existing report, you may not receive a personal
216 reply.
217 .PP
218 If it is important to you that your bug be fixed, do monitor the
219 issue tracker (you will be subscribed to notifications for issues you
220 submit or comment on) and the commit logs to development
221 versions of Perl, and encourage the maintainers with kind words or
222 offers of frosty beverages. (Please do be kind to the maintainers.
223 Harassing or flaming them is likely to have the opposite effect of the
224 one you want.)
225 .PP
226 Feel free to update the ticket about your bug on
227 <https://github.com/Perl/perl5/issues>
228 if a new version of Perl is released and your bug is still present.
229 .SH OPTIONS
230 .IX Header "OPTIONS"
231 .IP \fB\-a\fR 8
232 .IX Item "-a"
233 Address to send the report to instead of saving to a file.
234 .IP \fB\-b\fR 8
235 .IX Item "-b"
236 Body of the report. If not included on the command line, or
237 in a file with \fB\-f\fR, you will get a chance to edit the report.
238 .IP \fB\-C\fR 8
239 .IX Item "-C"
240 Don't send copy to administrator when sending report by mail.
241 .IP \fB\-c\fR 8
242 .IX Item "-c"
243 Address to send copy of report to when sending report by mail.
244 Defaults to the address of the
245 local perl administrator (recorded when perl was built).
246 .IP \fB\-d\fR 8
247 .IX Item "-d"
248 Data mode (the default if you redirect or pipe output). This prints out
249 your configuration data, without saving or mailing anything. You can use
250 this with \fB\-v\fR to get more complete data.
251 .IP \fB\-e\fR 8
252 .IX Item "-e"
253 Editor to use.
254 .IP \fB\-f\fR 8
255 .IX Item "-f"
256 File containing the body of the report. Use this to quickly send a
257 prepared report.
258 .IP \fB\-F\fR 8
259 .IX Item "-F"
260 File to output the results to. Defaults to \fBperlbug.rep\fR.
261 .IP \fB\-h\fR 8
262 .IX Item "-h"
263 Prints a brief summary of the options.
264 .IP \fB\-ok\fR 8
265 .IX Item "-ok"
266 Report successful build on this system to perl porters. Forces \fB\-S\fR
267 and \fB\-C\fR. Forces and supplies values for \fB\-s\fR and \fB\-b\fR. Only
268 prompts for a return address if it cannot guess it (for use with
269 \&\fBmake\fR). Honors return address specified with \fB\-r\fR. You can use this
270 with \fB\-v\fR to get more complete data. Only makes a report if this
271 system is less than 60 days old.
272 .IP \fB\-okay\fR 8
273 .IX Item "-okay"
274 As \fB\-ok\fR except it will report on older systems.
275 .IP \fB\-nok\fR 8
276 .IX Item "-nok"
277 Report unsuccessful build on this system. Forces \fB\-C\fR. Forces and
278 supplies a value for \fB\-s\fR, then requires you to edit the report
279 and say what went wrong. Alternatively, a prepared report may be
280 supplied using \fB\-f\fR. Only prompts for a return address if it
281 cannot guess it (for use with \fBmake\fR). Honors return address
282 specified with \fB\-r\fR. You can use this with \fB\-v\fR to get more
283 complete data. Only makes a report if this system is less than 60
284 days old.
285 .IP \fB\-nokay\fR 8
286 .IX Item "-nokay"
287 As \fB\-nok\fR except it will report on older systems.
288 .IP \fB\-p\fR 8
289 .IX Item "-p"
290 The names of one or more patch files or other text attachments to be
291 included with the report. Multiple files must be separated with commas.
292 .IP \fB\-r\fR 8
293 .IX Item "-r"
294 Your return address. The program will ask you to confirm its default
295 if you don't use this option.
296 .IP \fB\-S\fR 8
297 .IX Item "-S"
298 Save or send the report without asking for confirmation.
299 .IP \fB\-s\fR 8
300 .IX Item "-s"
301 Subject to include with the report. You will be prompted if you don't
302 supply one on the command line.
303 .IP \fB\-t\fR 8
304 .IX Item "-t"
305 Test mode. Makes it possible to command perlbug from a pipe or file, for
306 testing purposes.
307 .IP \fB\-T\fR 8
308 .IX Item "-T"
309 Send a thank-you note instead of a bug report.
310 .IP \fB\-v\fR 8
311 .IX Item "-v"
312 Include verbose configuration data in the report.
313 .SH AUTHORS
314 .IX Header "AUTHORS"
315 Kenneth Albanowski (<[email protected]>), subsequently
316 \&\fIdoc\fRtored by Gurusamy Sarathy (<[email protected]>),
317 Tom Christiansen (<[email protected]>), Nathan Torkington
318 (<[email protected]>), Charles F. Randall (<[email protected]>),
319 Mike Guy (<[email protected]>), Dominic Dunlop
320 (<[email protected]>), Hugo van der Sanden (<[email protected]>),
321 Jarkko Hietaniemi (<[email protected]>), Chris Nandor
322 (<[email protected]>), Jon Orwant (<[email protected]>,
323 Richard Foley (<[email protected]>), Jesse Vincent
324 (<[email protected]>), and Craig A. Berry (<[email protected]>).
325 .SH "SEE ALSO"
326 .IX Header "SEE ALSO"
327 \&\fBperl\fR\|(1), \fBperldebug\fR\|(1), \fBperldiag\fR\|(1), \fBperlport\fR\|(1), \fBperltrap\fR\|(1),
328 \&\fBdiff\fR\|(1), \fBpatch\fR\|(1), \fBdbx\fR\|(1), \fBgdb\fR\|(1)
329 .SH BUGS
330 .IX Header "BUGS"
331 None known (guess what must have been used to report them?)