#!perl # Note: This script is a CLI for Riap function /Perinci/Examples/SahSchemas/schema_filesize # and generated automatically using Perinci::CmdLine::Gen version 0.494 our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY our $DATE = '2020-03-14'; # DATE our $DIST = 'Perinci-Examples-Bin-Any-SahSchemas'; # DIST our $VERSION = '0.003'; # VERSION use 5.010001; use strict; use warnings; use Perinci::CmdLine::Any; my $cmdline = Perinci::CmdLine::Any->new( url => "/Perinci/Examples/SahSchemas/schema_filesize", program_name => "peri-eg-schema-filesize", ); $cmdline->run; # ABSTRACT: peri-eg-schema-filesize # PODNAME: peri-eg-schema-filesize __END__ =pod =encoding UTF-8 =head1 NAME peri-eg-schema-filesize - peri-eg-schema-filesize =head1 VERSION This document describes version 0.003 of peri-eg-schema-filesize (from Perl distribution Perinci-Examples-Bin-Any-SahSchemas), released on 2020-03-14. =head1 SYNOPSIS Usage: % peri-eg-schema-filesize [options] =head1 OPTIONS C<*> marks required options. =head2 Main options =over =item B<--mod>=I* =back =head2 Configuration options =over =item B<--config-path>=I, B<-c> Set path to configuration file. =item B<--config-profile>=I, B<-P> Set configuration profile to use. =item B<--no-config>, B<-C> Do not use any configuration file. =back =head2 Environment options =over =item B<--no-env> Do not read environment for default options. =back =head2 Output options =over =item B<--format>=I Choose output format, e.g. json, text. Default value: undef =item B<--json> Set output format to json. =item B<--naked-res> When outputing as JSON, strip result envelope. Default value: 0 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] =item B<--page-result> Filter output through a pager. =back =head2 Other options =over =item B<--help>, B<-h>, B<-?> Display help message and exit. =item B<--version>, B<-v> Display program's version and exit. =back =head1 COMPLETION This script has shell tab completion capability with support for several shells. =head2 bash To activate bash completion for this script, put: complete -C peri-eg-schema-filesize peri-eg-schema-filesize in your bash startup (e.g. F<~/.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 L which can activate shell completion for scripts immediately. =head2 tcsh To activate tcsh completion for this script, put: complete peri-eg-schema-filesize 'p/*/`peri-eg-schema-filesize`/' 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 (see above). =head2 other shells For fish and zsh, install L as described above. =head1 CONFIGURATION FILE This script can read configuration files. Configuration files are in the format of L, 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<~/.config/peri-eg-schema-filesize.conf>, F<~/peri-eg-schema-filesize.conf>, or F. 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 in section names, e.g. C<[program=NAME ...]> or C<[SOMESECTION program=NAME]>. 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 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 ...]>. If you only want a section to be read when the value of an environment variable has value equals something: C<[env=HOSTNAME=blink ...]> or C<[SOMESECTION 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 ...]> or C<[SOMESECTION env=HOSTNAME!=blink ...]>. If you only want a section to be read when an environment variable contains something: C<[env=HOSTNAME*=server ...]> or C<[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. List of available configuration parameters: format (see --format) mod (see --mod) naked_res (see --naked-res) =head1 ENVIRONMENT =head2 PERI_EG_SCHEMA_FILESIZE_OPT => str Specify additional command-line options. =head1 FILES F<~/.config/peri-eg-schema-filesize.conf> F<~/peri-eg-schema-filesize.conf> F =head1 HOMEPAGE Please visit the project's homepage at L. =head1 SOURCE Source repository is at L. =head1 BUGS Please report any bugs or feature requests on the bugtracker website L 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. =head1 AUTHOR perlancar =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2020, 2018 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. =cut