wordlist - Grep words from WordList::*
This document describes version 0.260 of main (from Perl distribution App-wordlist), released on 2017-11-07.
Usage:
% wordlist [options] [arg] ...
Examples:
By default print all words from all wordlists:
% wordlist
Print all words matching /foo/ and /bar/:
% wordlist foo bar
Print all words matching /foo/ or /bar/:
% wordlist --or foo bar
Print wordlist name for each matching words:
% wordlist --detail foo
Select a specific wordlist (multiple -w allowed):
% wordlist -w ID::KBBI foo
Select phrase wordlists (multiple -t allowed):
% wordlist -t Phrase foo
Select French wordlists (multiple --lang allowed):
% wordlist --lang FR foo
Filter by regex:
% wordlist '/fof[aeiou]/'
List installed wordlist modules:
% wordlist -l
List wordlist modules available on CPAN:
% wordlist -L
* marks required options.
*
Default value:
"grep"
Valid values:
["list_cpan","list_installed","grep"]
See --arg.
--arg
Can be specified multiple times.
Display more information when listing modules/result.
When listing installed modules (`-l`), this means also returning a wordlist's type and language.
When returning grep result, this means also returning wordlist name.
Only include wordlists of certain language(s).
Only include wordlists of certain language(s) (JSON-encoded).
See --lang.
--lang
Use local CPAN mirror first when available (for -L).
Return (at most) this number of words (0 = unlimited).
0
Match any word in query instead of the default "all".
Pick random words (must set --num to positive number).
Only include wordlists of certain type(s) (JSON-encoded).
See --types.
--types
Only include wordlists of certain type(s).
By convention, language information is encoded in the wordlist's name. For example, English wordlists have names matching `EN::*` or `Word::EN::*` or `Char::EN::*` or `Phrase::EN::*`.
Select one or more wordlist modules.
Select one or more wordlist modules (JSON-encoded).
See --wordlist.
--wordlist
List installed WordList::* modules.
See --action.
--action
List WordList::* modules on CPAN.
Set path to configuration file.
Set configuration profile to use.
Do not use any configuration file.
Do not read environment for default options.
Choose output format, e.g. json, text.
undef
Set output format to json.
When outputing as JSON, strip result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]
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:
[1,2,3]
Display help message and exit.
Display program's version and exit.
The script comes with a companion shell completer script (_wordlist) for this script.
To activate bash completion for this script, put:
complete -C _wordlist wordlist
in your bash startup (e.g. ~/.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 modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
To activate tcsh completion for this script, put:
complete wordlist 'p/*/`wordlist`/'
in your tcsh startup (e.g. ~/.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 shcompgen (see above).
For fish and zsh, install shcompgen as described above.
This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/wordlist.conf, ~/wordlist.conf, or /etc/wordlist.conf.
--config-path
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
--no-config
You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.
[profile=SOMENAME]
[SOMESECTION profile=SOMENAME]
--config-profile SOMENAME
You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.
program=NAME
[program=NAME ...]
[SOMESECTION program=NAME]
Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION 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.
env=CONDITION
[env=SOMEVAR ...]
[SOMESECTION env=SOMEVAR ...]
[env=HOSTNAME=blink ...]
[SOMESECTION env=HOSTNAME=blink ...]
[env=HOSTNAME!=blink ...]
[SOMESECTION env=HOSTNAME!=blink ...]
[env=HOSTNAME*=server ...]
[SOMESECTION env=HOSTNAME*=server ...]
List of available configuration parameters:
action (see --action) arg (see --arg) detail (see --detail) format (see --format) ignore_case (see --no-ignore-case) langs (see --lang) lcpan (see --lcpan) len (see --len) max_len (see --max-len) min_len (see --min-len) naked_res (see --naked-res) num (see --num) or (see --or) random (see --random) types (see --types) wordlists (see --wordlist)
Specify additional command-line options.
~/.config/wordlist.conf
~/wordlist.conf
/etc/wordlist.conf
Please visit the project's homepage at https://metacpan.org/release/App-wordlist.
Source repository is at https://github.com/perlancar/perl-App-wordlist.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-wordlist
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2017, 2016, 2015, 2014 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.
To install App::wordlist, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::wordlist
CPAN shell
perl -MCPAN -e shell install App::wordlist
For more information on module installation, please visit the detailed CPAN module installation guide.