{
    "mode": "perldoc",
    "parameter": "perlbug",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/perlbug/json",
    "generated": "2026-07-05T15:55:16Z",
    "synopsis": "perlbug\nperlbug [ -v ] [ -a *address* ] [ -s *subject* ] [ -b *body* | -f *inputfile* ]\n[ -F *outputfile* ] [ -r *returnaddress* ] [ -e *editor* ] [ -c *adminaddress* | -C ] [ -S ]\n[ -t ] [ -d ] [ -h ] [ -T ]\nperlbug [ -v ] [ -r *returnaddress* ] [ -ok | -okay | -nok | -nokay ]\nperlthanks",
    "sections": {
        "NAME": {
            "content": "perlbug - how to submit bug reports on Perl\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "perlbug\n\nperlbug [ -v ] [ -a *address* ] [ -s *subject* ] [ -b *body* | -f *inputfile* ]\n[ -F *outputfile* ] [ -r *returnaddress* ] [ -e *editor* ] [ -c *adminaddress* | -C ] [ -S ]\n[ -t ] [ -d ] [ -h ] [ -T ]\n\nperlbug [ -v ] [ -r *returnaddress* ] [ -ok | -okay | -nok | -nokay ]\n\nperlthanks\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "This program is designed to help you generate bug reports (and thank-you notes) about perl5 and\nthe modules which ship with it.\n\nIn most cases, you can just run it interactively from a command line without any special\narguments and follow the prompts.\n\nIf you have found a bug with a non-standard port (one that was not part of the *standard\ndistribution*), a binary distribution, or a non-core module (such as Tk, DBI, etc), then please\nsee the documentation that came with that distribution to determine the correct place to report\nbugs.\n\nBug reports should be submitted to the GitHub issue tracker at\n<https://github.com/Perl/perl5/issues>. The perlbug@perl.org address no longer automatically\nopens tickets. You can use this tool to compose your report and save it to a file which you can\nthen submit to the issue tracker.\n\nIn extreme cases, perlbug may not work well enough on your system to guide you through composing\na bug report. In those cases, you may be able to use perlbug -d or perl -V to get system\nconfiguration information to include in your issue report.\n\nWhen reporting a bug, please run through this checklist:\n\nWhat version of Perl you are running?\nType \"perl -v\" at the command line to find out.\n\nAre you running the latest released version of perl?\nLook at <http://www.perl.org/> to find out. If you are not using the latest released\nversion, please try to replicate your bug on the latest stable release.\n\nNote that reports about bugs in old versions of Perl, especially those which indicate you\nhaven't also tested the current stable release of Perl, are likely to receive less attention\nfrom the volunteers who build and maintain Perl than reports about bugs in the current\nrelease.\n\nAre you sure what you have is a bug?\nA significant number of the bug reports we get turn out to be documented features in Perl.\nMake sure the issue you've run into isn't intentional by glancing through the documentation\nthat comes with the Perl distribution.\n\nGiven the sheer volume of Perl documentation, this isn't a trivial undertaking, but if you\ncan point to documentation that suggests the behaviour you're seeing is *wrong*, your issue\nis likely to receive more attention. You may want to start with perldoc perltrap for\npointers to common traps that new (and experienced) Perl programmers run into.\n\nIf you're unsure of the meaning of an error message you've run across, perldoc perldiag for\nan explanation. If the message isn't in perldiag, it probably isn't generated by Perl. You\nmay have luck consulting your operating system documentation instead.\n\nIf you are on a non-UNIX platform perldoc perlport, as some features may be unimplemented or\nwork differently.\n\nYou may be able to figure out what's going wrong using the Perl debugger. For information\nabout how to use the debugger perldoc perldebug.\n\nDo you have a proper test case?\nThe easier it is to reproduce your bug, the more likely it will be fixed -- if nobody can\nduplicate your problem, it probably won't be addressed.\n\nA good test case has most of these attributes: short, simple code; few dependencies on\nexternal commands, modules, or libraries; no platform-dependent code (unless it's a\nplatform-specific bug); clear, simple documentation.\n\nA good test case is almost always a good candidate to be included in Perl's test suite. If\nyou have the time, consider writing your test case so that it can be easily included into\nthe standard test suite.\n\nHave you included all relevant information?\nBe sure to include the exact error messages, if any. \"Perl gave an error\" is not an exact\nerror message.\n\nIf you get a core dump (or equivalent), you may use a debugger (dbx, gdb, etc) to produce a\nstack trace to include in the bug report.\n\nNOTE: unless your Perl has been compiled with debug info (often -g), the stack trace is\nlikely to be somewhat hard to use because it will most probably contain only the function\nnames and not their arguments. If possible, recompile your Perl with debug info and\nreproduce the crash and the stack trace.\n\nCan you describe the bug in plain English?\nThe easier it is to understand a reproducible bug, the more likely it will be fixed. Any\ninsight you can provide into the problem will help a great deal. In other words, try to\nanalyze the problem (to the extent you can) and report your discoveries.\n\nCan you fix the bug yourself?\nIf so, that's great news; bug reports with patches are likely to receive significantly more\nattention and interest than those without patches. Please submit your patch via the GitHub\nPull Request workflow as described in perldoc perlhack. You may also send patches to\nperl5-porters@perl.org. When sending a patch, create it using \"git format-patch\" if\npossible, though a unified diff created with \"diff -pu\" will do nearly as well.\n\nYour patch may be returned with requests for changes, or requests for more detailed\nexplanations about your fix.\n\nHere are a few hints for creating high-quality patches:\n\nMake sure the patch is not reversed (the first argument to diff is typically the original\nfile, the second argument your changed file). Make sure you test your patch by applying it\nwith \"git am\" or the \"patch\" program before you send it on its way. Try to follow the same\nstyle as the code you are trying to patch. Make sure your patch really does work (\"make\ntest\", if the thing you're patching is covered by Perl's test suite).\n\nCan you use \"perlbug\" to submit a thank-you note?\nYes, you can do this by either using the \"-T\" option, or by invoking the program as\n\"perlthanks\". Thank-you notes are good. It makes people smile.\n\nPlease make your issue title informative. \"a bug\" is not informative. Neither is \"perl crashes\"\nnor is \"HELP!!!\". These don't help. A compact description of what's wrong is fine.\n\nHaving done your bit, please be prepared to wait, to be told the bug is in your code, or\npossibly to get no reply at all. The volunteers who maintain Perl are busy folks, so if your\nproblem is an obvious bug in your own code, is difficult to understand or is a duplicate of an\nexisting report, you may not receive a personal reply.\n\nIf it is important to you that your bug be fixed, do monitor the issue tracker (you will be\nsubscribed to notifications for issues you submit or comment on) and the commit logs to\ndevelopment versions of Perl, and encourage the maintainers with kind words or offers of frosty\nbeverages. (Please do be kind to the maintainers. Harassing or flaming them is likely to have\nthe opposite effect of the one you want.)\n\nFeel free to update the ticket about your bug on <https://github.com/Perl/perl5/issues> if a new\nversion of Perl is released and your bug is still present.\n",
            "subsections": []
        },
        "OPTIONS": {
            "content": "-a      Address to send the report to instead of saving to a file.\n\n-b      Body of the report. If not included on the command line, or in a file with -f, you will\nget a chance to edit the report.\n\n-C      Don't send copy to administrator when sending report by mail.\n\n-c      Address to send copy of report to when sending report by mail. Defaults to the address\nof the local perl administrator (recorded when perl was built).\n\n-d      Data mode (the default if you redirect or pipe output). This prints out your\nconfiguration data, without saving or mailing anything. You can use this with -v to get\nmore complete data.\n\n-e      Editor to use.\n\n-f      File containing the body of the report. Use this to quickly send a prepared report.\n\n-F      File to output the results to. Defaults to perlbug.rep.\n\n-h      Prints a brief summary of the options.\n\n-ok     Report successful build on this system to perl porters. Forces -S and -C. Forces and\nsupplies values for -s and -b. Only prompts for a return address if it cannot guess it\n(for use with make). Honors return address specified with -r. You can use this with -v\nto get more complete data. Only makes a report if this system is less than 60 days old.\n\n-okay   As -ok except it will report on older systems.\n\n-nok    Report unsuccessful build on this system. Forces -C. Forces and supplies a value for -s,\nthen requires you to edit the report and say what went wrong. Alternatively, a prepared\nreport may be supplied using -f. Only prompts for a return address if it cannot guess it\n(for use with make). Honors return address specified with -r. You can use this with -v\nto get more complete data. Only makes a report if this system is less than 60 days old.\n\n-nokay  As -nok except it will report on older systems.\n\n-p      The names of one or more patch files or other text attachments to be included with the\nreport. Multiple files must be separated with commas.\n\n-r      Your return address. The program will ask you to confirm its default if you don't use\nthis option.\n\n-S      Save or send the report without asking for confirmation.\n\n-s      Subject to include with the report. You will be prompted if you don't supply one on the\ncommand line.\n\n-t      Test mode. Makes it possible to command perlbug from a pipe or file, for testing\npurposes.\n\n-T      Send a thank-you note instead of a bug report.\n\n-v      Include verbose configuration data in the report.\n",
            "subsections": []
        },
        "AUTHORS": {
            "content": "Kenneth Albanowski (<kjahds@kjahds.com>), subsequently *doc*tored by Gurusamy Sarathy\n(<gsar@activestate.com>), Tom Christiansen (<tchrist@perl.com>), Nathan Torkington\n(<gnat@frii.com>), Charles F. Randall (<cfr@pobox.com>), Mike Guy (<mjtg@cam.ac.uk>), Dominic\nDunlop (<domo@computer.org>), Hugo van der Sanden (<hv@crypt.org>), Jarkko Hietaniemi\n(<jhi@iki.fi>), Chris Nandor (<pudge@pobox.com>), Jon Orwant (<orwant@media.mit.edu>, Richard\nFoley (<richard.foley@rfi.net>), Jesse Vincent (<jesse@bestpractical.com>), and Craig A. Berry\n(<craigberry@mac.com>).\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "",
            "subsections": [
                {
                    "name": "perl",
                    "content": ""
                }
            ]
        },
        "BUGS": {
            "content": "None known (guess what must have been used to report them?)\n",
            "subsections": []
        }
    },
    "summary": "perlbug - how to submit bug reports on Perl",
    "flags": [],
    "examples": [],
    "see_also": []
}