App-SahUtils
view release on metacpan or search on metacpan
script/show-sah-schema-module view on Meta::CPAN
It is recommended, however, that you install modules using L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.
=head2 tcsh
To activate tcsh completion for this script, put:
complete show-sah-schema-module 'p/*/`show-sah-schema-module`/'
in your tcsh startup (e.g. F<~/.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 L<shcompgen> (see above).
=head2 other shells
For fish and zsh, install L<shcompgen> as described above.
=head1 CONFIGURATION FILE
This script can read configuration files. Configuration files are in the format of L<IOD>, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using C<--config-path>): F</home/u1/.config/show-sah-schema-module.conf>, F</home/u1/show-sah-schema-module.conf>, or F</etc/show-sah-schema-module.conf>.
All found files will be read and merged.
To disable searching for configuration files, pass C<--no-config>.
You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]>. 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=NAME ...]> or C<[SOMESECTION program=NAME]>. The section will then only be used when the reading program match...
You can also 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 ...]> or C<[SOMESECTION env=SOMEVAR ...
To load and configure plugins, you can use either the C<-plugins> parameter (e.g. C<< -plugins=DumpArgs >> or C<< -plugins=DumpArgs@before_validate_args >>), or use the C<[plugin=NAME ...]> sections, for example:
[plugin=DumpArgs]
-event=before_validate_args
-prio=99
[plugin=Foo]
-event=after_validate_args
arg1=val1
arg2=val2
which is equivalent to setting C<< -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2 >>.
List of available configuration parameters:
detail (see --detail)
dist (see --dist)
dist.contains (see --dist-contains)
dist.in (see --dist-in)
dist.is (see --dist-is)
dist.isnt (see --dist-isnt)
dist.max (see --dist-max)
dist.min (see --dist-min)
dist.not_contains (see --dist-not-contains)
dist.not_in (see --dist-not-in)
dist.xmax (see --dist-xmax)
dist.xmin (see --dist-xmin)
exclude_fields (see --exclude-field)
fields (see --field)
format (see --format)
might_fail (see --might-fail)
might_fail.is (see --might-fail-is)
might_fail.isnt (see --might-fail-isnt)
naked_res (see --naked-res)
prio (see --prio)
prio.in (see --prio-in)
prio.is (see --prio-is)
prio.isnt (see --prio-isnt)
prio.max (see --prio-max)
prio.min (see --prio-min)
prio.not_in (see --prio-not-in)
prio.xmax (see --prio-xmax)
prio.xmin (see --prio-xmin)
queries (see --query)
query_boolean (see --query-boolean)
random (see --random)
result_limit (see --result-limit)
result_start (see --result-start)
rule (see --rule)
rule.contains (see --rule-contains)
rule.in (see --rule-in)
rule.is (see --rule-is)
rule.isnt (see --rule-isnt)
rule.max (see --rule-max)
rule.min (see --rule-min)
rule.not_contains (see --rule-not-contains)
rule.not_in (see --rule-not-in)
rule.xmax (see --rule-xmax)
rule.xmin (see --rule-xmin)
sort (see --sort)
summary (see --summary)
summary.contains (see --summary-contains)
summary.in (see --summary-in)
summary.is (see --summary-is)
summary.isnt (see --summary-isnt)
summary.max (see --summary-max)
summary.min (see --summary-min)
summary.not_contains (see --summary-not-contains)
summary.not_in (see --summary-not-in)
summary.xmax (see --summary-xmax)
summary.xmin (see --summary-xmin)
v (see --v-arg)
v.contains (see --v-contains)
v.in (see --v-in)
v.is (see --v-is)
v.isnt (see --v-isnt)
v.max (see --v-max)
v.min (see --v-min)
v.not_contains (see --v-not-contains)
v.not_in (see --v-not-in)
v.xmax (see --v-xmax)
v.xmin (see --v-xmin)
with_field_names (see --with-field-names)
=head1 ENVIRONMENT
=head2 SHOW_SAH_SCHEMA_MODULE_OPT
String. Specify additional command-line options.
=head1 FILES
=head2 /home/u1/.config/show-sah-schema-module.conf
=head2 /home/u1/show-sah-schema-module.conf
=head2 /etc/show-sah-schema-module.conf
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-SahUtils>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-App-SahUtils>.
=head1 SEE ALSO
L<list-sah-schema-modules>
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 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 L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,
L<Pod::Weaver::PluginBundle::Author::PERLANCAR>, and sometimes one or two other
Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond
that are considered a bug and can be reported to me.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2024, 2023, 2022, 2020, 2019, 2018, 2017, 2016, 2015 by perlancar <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.
=head1 BUGS
( run in 0.437 second using v1.01-cache-2.11-cpan-39bf76dae61 )