.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.48)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "App::Cmd::Command::help 3"
.TH App::Cmd::Command::help 3 2026-10-26 "perl v5.44.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 DESCRIPTION
.IX Header "DESCRIPTION"
This command will either list all of the application commands and their
abstracts, or display the usage screen for a subcommand with its
description.
.SH USAGE
.IX Header "USAGE"
The help text is generated from three sources:
.PP
The \f(CW\*(C`usage_desc\*(C'\fR method provides the opening usage line, following the
specification described in Getopt::Long::Descriptive.  In some cases,
the default \f(CW\*(C`usage_desc\*(C'\fR in App::Cmd::Command may be sufficient and
you will only need to override it to provide additional command line
usage information.
.PP
The \f(CW\*(C`opt_spec\*(C'\fR data structure is used with Getopt::Long::Descriptive
to generate the description of the options.
.PP
Subcommand classes should override the \f(CW\*(C`discription\*(C'\fR method to provide
additional information that is prepended before the option descriptions.
.PP
For example, consider the following subcommand module:
.PP
.Vb 1
\&  package YourApp::Command::initialize;
\&
\&  # This is the default from App::Cmd::Command
\&  sub usage_desc {
\&    my ($self) = @_;
\&    my $desc = $self\->SUPER::usage_desc; # "%c COMMAND %o"
\&    return "$desc [DIRECTORY]";
\&  }
\&
\&  sub description {
\&    return "The initialize command prepares the application...";
\&  }
\&
\&  sub opt_spec {
\&    return (
\&      [ "skip\-refs|R",  "skip reference checks during init", ],
\&      [ "values|v=s@",  "starting values", { default => [ 0, 1, 3 ] } ],
\&    );
\&  }
\&
\&  ...
.Ve
.PP
That module would generate help output like this:
.PP
.Vb 2
\&  $ yourapp help initialize
\&  yourapp initialize [\-Rv] [long options...] [DIRECTORY]
\&
\&  The initialize command prepares the application...
\&
\&        \-\-help            This usage screen
\&        \-R \-\-skip\-refs    skip reference checks during init
\&        \-v \-\-values       starting values
.Ve