NAME App::wordlist - Grep words from WordList::* VERSION This document describes version 0.278 of App::wordlist (from Perl distribution App-wordlist), released on 2021-10-21. SYNOPSIS See the included script wordlist. FUNCTIONS wordlist Usage: wordlist(%args) -> [$status_code, $reason, $payload, \%result_meta] Grep words from WordList::*. Examples: * By default print all words from all wordlists: wordlist(); * Print all words matching /foo/ and /bar/: wordlist(arg => ["foo", "bar"]); * Print all words matching /foo/ or /bar/: wordlist(arg => ["foo", "bar"], or => 1); * Print wordlist name for each matching words: wordlist(arg => ["foo"], detail => 1); * Select a specific wordlist (multiple -w allowed): wordlist(arg => ["foo"], wordlists => ["ID::KBBI"]); * Select all ID::* wordlists (wildcard will be expanded): wordlist(arg => ["foo"], wordlists => ["ID::**"]); * Print all words from EN::Enable wordlist that are 6 characters long and have the letters BOBLEG (in no particular order); great for cheats in word forming games: wordlist( chars_unordered => "bobleg", ignore_case => 1, len => 6, wordlists => ["EN::Enable"] ); * Print all words from EN::Enable wordlist that are 6 characters long and have the letters B,G,L (in that order); great for finding crossword puzzle answers: wordlist( chars_ordered => "BGL", ignore_case => 1, len => 6, wordlists => ["EN::Enable"] ); * Select French wordlists (multiple --lang allowed): wordlist(arg => ["foo"], langs => ["FR"]); * Filter by regex: wordlist(arg => ["/fof[aeiou]/"]); * List installed wordlist modules: wordlist(action => "list_installed"); * List wordlist modules available on CPAN: wordlist(action => "list_cpan"); This function is not exported. Arguments ('*' denotes required arguments): * action => *str* (default: "grep") * arg => *array[str]* * chars_ordered => *str* Specify possible characters for the word (ordered). * chars_unordered => *str* Specify possible characters for the word (unordered). * color => *str* (default: "auto") When to highlight search string/matching pattern with color. * detail => *bool* Display more information when listing modules/result. When listing installed modules ("-l"), this means also returning a wordlist's language. When returning grep result, this means also returning wordlist name. * ignore_case => *bool* (default: 1) * langs => *array[str]* Only include wordlists of certain language(s). By convention, language code is the first subnamespace of a wordlist module, e.g. WordList::EN::* for English, WordList::FR::* for French, and so on. Wordlist modules which do not follow this convention (e.g. WordList::Password::* or WordList::PersonName::*) are not included. * lcpan => *bool* Use local CPAN mirror first when available (for -L). * len => *int* * max_len => *int* * min_len => *int* * num => *int* (default: 0) Return (at most) this number of words (0 = unlimited). * or => *bool* Match any word in query instead of the default "all". * random => *bool* Pick random words. If set to true, then streaming will be turned off. All words will be gathered first, then words will be chosen randomly from the gathered list. * wordlists => *array[str]* Select one or more wordlist modules. Returns an enveloped result (an array). First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata. Return value: (any) ENVIRONMENT DEBUG => bool COLOR => bool Set color on/off when --color=auto (the default). HOMEPAGE Please visit the project's homepage at . SOURCE Source repository is at . SEE ALSO App::WordListUtils App::GamesWordlist (games-wordlist) which greps from "Games::Word::Wordlist::*" instead. WordList and "WordList::*" modules. arraydata from App::arraydata, hashdata from App::hashdata, and tabledata from App::tabledata. These are newer projects that will supersede WordList one day. AUTHOR perlancar CONTRIBUTOR Ryo CONTRIBUTING To contribute, you can send patches by email/via RT, or send pull requests on GitHub. Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via: % prove -l 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. COPYRIGHT AND LICENSE This software is copyright (c) 2021, 2020, 2018, 2017, 2016, 2015, 2014 by perlancar . This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. BUGS Please report any bugs or feature requests on the bugtracker website 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.