.\" 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Getopt::Complete::Compgen 3pm"
.TH Getopt::Complete::Compgen 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"
Getopt::Complete::Compgen \- standard tab\-completion callbacks
.SH "VERSION"
.IX Header "VERSION"
This document describes Getopt::Complete::Compgen 0.26.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& # A completion spec can use any of the following, specified by a single
\& # word, or a single character, automatically:
\& 
\& use Getopt::Complete(
\&    \*(Aqmyfile\*(Aq    => \*(Aqfiles\*(Aq,         # or \*(Aqf\*(Aq
\&    \*(Aqmydir\*(Aq     => \*(Aqdirectories\*(Aq,   # or \*(Aqd\*(Aq
\&    \*(Aqmycommand\*(Aq => \*(Aqcommands\*(Aq,      # or \*(Aqc\*(Aq
\&    \*(Aqmyuser\*(Aq    => \*(Aqusers\*(Aq,         # or \*(Aqu\*(Aq
\&    \*(Aqmygroup\*(Aq   => \*(Aqgroups\*(Aq,        # or \*(Aqd\*(Aq
\&    \*(Aqmyenv\*(Aq     => \*(Aqenvironment\*(Aq,   # or \*(Aqe\*(Aq
\&    \*(Aqmyservice\*(Aq => \*(Aqservices\*(Aq,      # or \*(Aqs\*(Aq
\&    \*(Aqmyalias\*(Aq   => \*(Aqaliases\*(Aq,       # or \*(Aqa\*(Aq
\&    \*(Aqmybuiltin\*(Aq => \*(Aqbuiltins\*(Aq       # or \*(Aqb\*(Aq
\& );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module contains subroutines which can be used as callbacks with Getopt::Complete,
and which implement all of the standard completions supported by the bash \*(L"compgen\*(R" builtin.
.PP
Running \*(L"compgen \-o files abc\*(R" will produce the completion list as though the user typed \*(L"abc<\s-1TAB\s0>\*(R",
with the presumption the user is attempting to complete file names.
.PP
This module provides a subroutine names \*(L"files\*(R", with an alias named \*(L"f\*(R", which returns the same list.
.PP
The subroutine is suitable for use in a callback in a Getopt::Complete competion specification.
.PP
It does the equivalent for directories, executable commands, users, groups, environment variables, services,
aliases and shell builtins.
.PP
These are the same:
.PP
.Vb 1
\& @matches = Getopt::Complete::Compgen::files("whatevercommand","abc","whateverparam",$whatever_other_args);
\& 
\& @same = \`bash \-c "compgen \-f sometext"\`;
\& chomp @same;
.Ve
.PP
These are equivalent in any spec:
.PP
.Vb 6
\&   \e&Getopt::Complete::Compgen::files
\&   \e&Getopt;:Complete::Compgen::f
\&  \*(AqGetopt::Complete::Compgen::files\*(Aq
\&  \*(AqGetopt;:Complete::Compgen::f\*(Aq
\&  \*(Aqfiles\*(Aq
\&  \*(Aqf\*(Aq
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Getopt::Complete
.PP
The manual page for bash details the bash built-in command \*(L"compgen\*(R", which this wraps.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2010 Scott Smith and Washington University School of Medicine
.SH "AUTHORS"
.IX Header "AUTHORS"
Scott Smith (sakoht at cpan .org)
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
.PP
The full text of the license can be found in the \s-1LICENSE\s0 file included with this
module.