# Note: This script is a CLI  for Riap function /App/GamesWordlist/wordlist
# and generated automatically using Perinci::CmdLine::Gen version 0.28

our $DATE = '2016-02-14'; # DATE
our $DIST = 'App-GamesWordlist'; # DIST
our $VERSION = '0.16'; # VERSION

use 5.010001;
use strict;
use warnings;

use Perinci::CmdLine::Any;

    url => "/App/GamesWordlist/wordlist",
    program_name => "games-wordlist",

# ABSTRACT: Grep words from Games::Word::{Wordlist,Phraselist}::*
# PODNAME: games-wordlist



=encoding UTF-8

=head1 NAME

games-wordlist - Grep words from Games::Word::{Wordlist,Phraselist}::*

=head1 VERSION

This document describes version 0.16 of games-wordlist (from Perl distribution App-GamesWordlist), released on 2016-02-14.



 % games-wordlist [options] [arg]...


By default print all words from all wordlists:

 % games-wordlist

Print all words matching /foo/ and /bar/:

 % games-wordlist foo bar

Print all words matching /foo/ or /bar/:

 % games-wordlist --or foo bar

Select a specific wordlist (multiple -w allowed):

 % games-wordlist -w KBBI foo

Filter by regex:

 % games-wordlist '/fof[aeiou]/'

=head1 OPTIONS

C<*> marks required options.

=head2 Configuration options


=item B<--config-path>=I<filename>

Set path to configuration file.

Can be specified multiple times.

=item B<--config-profile>=I<s>

Set configuration profile to use.

=item B<--no-config>

Do not use any configuration file.


=head2 Environment options


=item B<--no-env>

Do not read environment for default options.


=head2 Output options


=item B<--format>=I<s>

Choose output format, e.g. json, text.

Default value:


=item B<--json>

Set output format to json.

=item B<--naked-res>

When outputing as JSON, strip result envelope.

Default value:


By default, when outputing as JSON, the full enveloped result is returned, e.g.:


The reason is so you can get the status (1st element), status message (2nd
element) as well as result metadata/extra result (4th element) instead of just
the result (3rd element). However, sometimes you want just the result, e.g. when
you want to pipe the result for more post-processing. In this case you can use
`--naked-res` so you just get:



=head2 Other options


=item B<--action>=I<s>

Default value:


Valid values:


=item B<--arg-json>=I<s>

See C<--arg>.

=item B<--arg>=I<s@>

Can be specified multiple times.

=item B<--detail>

Display more information when listing modules.

=item B<--help>, B<-h>, B<-?>

Display help message and exit.

=item B<--lcpan>

Use local CPAN mirror first when available.

=item B<--len>=I<i>

=item B<--max-len>=I<i>

=item B<--min-len>=I<i>

=item B<--no-ignore-case>

=item B<--or>

Use OR logic instead of the default AND.

=item B<--version>, B<-v>

Display program's version and exit.

=item B<--wordlist-json>=I<s>, B<-w>

Select one or more wordlist modules (JSON-encoded).

See C<--wordlist>.

=item B<--wordlist>=I<s@>

Select one or more wordlist modules.

Can be specified multiple times.

=item B<-I>=I<s>

Install Games::Word::Wordlist::* module.

See C<--action>.

=item B<-L>

List Games::Word::Wordlist::* modules on CPAN.

See C<--action>.

=item B<-l>

List installed Games::Word::Wordlist::* modules.

See C<--action>.

=item B<-U>=I<s>

Uninstall Games::Word::Wordlist::* module.

See C<--action>.



This script has shell tab completion capability with support for several

=head2 bash

To activate bash completion for this script, put:

 complete -C games-wordlist games-wordlist

in your bash startup (e.g. C<~/.bashrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.

It is recommended, however, that you install L<shcompgen> which allows you to
activate completion scripts for several kinds of scripts on multiple shells.
Some CPAN distributions (those that are built with
L<Dist::Zilla::Plugin::GenShellCompletion>) will even automatically enable shell
completion for their included scripts (using C<shcompgen>) at installation time,
so you can immadiately have tab completion.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete games-wordlist 'p/*/`games-wordlist`/'

in your tcsh startup (e.g. C<~/.tcshrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.

It is also recommended to install C<shcompgen> (see above).

=head2 other shells

For fish and zsh, install C<shcompgen> as described above.


This script can read configuration file, which by default is searched at ~/.config/games-wordlist.conf, ~/games-wordlist.conf or /etc/games-wordlist.conf (can be changed by specifying C<--config-path>). All found files will be read and merged.

To disable searching for configuration files, pass C<--no-config>.

Configuration file is in the format of L<IOD>, which is basically INI with some extra features.

You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> (filter by profile). Those sections will only be read if you specify the matching C<--config-profile SOMENAME>.

You can also put configuration for multiple programs inside a single file, and use filter C<program=NAME> in section names, e.g. C<[program=foo ...]>. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]>. If you only want a section to be read when the value of an environment variable has value equals something: C<[env=HOSTNAME=blink ...]>. If you only want a section to be read when the value of an environment variable does not equal something: C<[env=HOSTNAME!=blink ...]>. If you only want a section to be read when an environment variable contains something: C<[env=HOSTNAME*=server ...]>. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

 action (see --action)
 arg (see --arg)
 detail (see --detail)
 format (see --format)
 ignore_case (see --no-ignore-case)
 lcpan (see --lcpan)
 len (see --len)
 max_len (see --max-len)
 min_len (see --min-len)
 naked_res (see --naked-res)
 or (see --or)
 wordlist (see --wordlist)


=head2 GAMES_WORDLIST_OPT => str

Specify additional command-line options

=head1 FILES





Please visit the project's homepage at L<https://metacpan.org/release/App-GamesWordlist>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-GamesWordlist>.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-GamesWordlist>

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

=head1 AUTHOR

perlancar <perlancar@cpan.org>


This software is copyright (c) 2016 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.