.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Perinci::CmdLine::Manual::HowTo::Debugging 3pm" .TH Perinci::CmdLine::Manual::HowTo::Debugging 3pm "2022-10-13" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Perinci::CmdLine::Manual::HowTo::Debugging \- How\-to guides related to debugging .SH "VERSION" .IX Header "VERSION" This document describes version 2.000.0 of Perinci::CmdLine::Manual::HowTo::Debugging (from Perl distribution Perinci-CmdLine), released on 2021\-12\-19. .SH "DESCRIPTION" .IX Header "DESCRIPTION" If you encounter issues with Perinci::CmdLine, you can try these things to aid with debugging: .PP \&\fBIncrease log level.\fR Perinci::CmdLine uses Log::ger. If your command-line object is instantiated with \f(CW\*(C`log\*(C'\fR attribute set to true, you just need to specify \f(CW\*(C`\-\-verbose\*(C'\fR, \f(CW\*(C`\-\-debug\*(C'\fR, or \f(CW\*(C`\-\-trace\*(C'\fR command-line options to see more logging statements: .PP .Vb 4 \& % your\-cli \-\-verbose ... \& % your\-cli \-\-debug ... \& % your\-cli \-\-trace ... \& % your\-cli \-\-log\-level trace ... ;# ditto .Ve .PP If your command-line object is not instantiated with \f(CW\*(C`log\*(C'\fR attribute set to true, you can enable logging with: .PP .Vb 3 \& % PERL5OPT=\-MLog::ger::Screen LOG_LEVEL=info your\-cli ... \& % PERL5OPT=\-MLog::ger::Screen DEBUG=1 your\-cli ... \& % PERL5OPT=\-MLog::ger::Screen TRACE=1 your\-cli ... .Ve .PP \&\fBDump parsed arguments, internal data structures.\fR If seeing log statements does not give clue, you can try dumping various data structures. This can be done with plugins. For example, to dump parsed command-line arguments after validation and then exit, you can use the following command (setting log level to trace is helpful to see the program flow and at what points the plugins are triggered): .PP .Vb 1 \& % PERINCI_CMDLINE_PLUGINS=\-DumpArgs,\-Exit@after_validate_args your\-cli \-\-trace ... .Ve .PP \&\fBLogging other components.\fR See Log::ger::For::LWP, Log::ger::For::HTTP::Tiny, Log::ger::For::DBI, Log::ger::DBI::Query. .SH "HOMEPAGE" .IX Header "HOMEPAGE" Please visit the project's homepage at . .SH "SOURCE" .IX Header "SOURCE" Source repository is at . .SH "SEE ALSO" .IX Header "SEE ALSO" Log::ger .SH "AUTHOR" .IX Header "AUTHOR" perlancar .SH "CONTRIBUTING" .IX Header "CONTRIBUTING" To contribute, you can send patches by email/via \s-1RT,\s0 or send pull requests on GitHub. .PP Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via: .PP .Vb 1 \& % prove \-l .Ve .PP If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me. .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2021, 2018, 2017, 2016, 2015 by perlancar . .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests on the bugtracker website .PP When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.