#!perl
# Note: This script is a CLI for Riap function /App/sorted/sorted
# and generated automatically using Perinci::CmdLine::Gen version 0.496
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2020-05-25'; # DATE
our $DIST = 'App-sorted'; # DIST
our $VERSION = '0.002'; # VERSION
use 5.010001;
use strict;
use warnings;
use Perinci::CmdLine::Any;
my $cmdline = Perinci::CmdLine::Any->new(
url => "/App/sorted/sorted",
program_name => "sorted",
read_config => 0,
read_env => 0,
);
$cmdline->run;
# ABSTRACT: Check if lines of a file are sorted
# PODNAME: sorted
__END__
=pod
=encoding UTF-8
=head1 NAME
sorted - Check if lines of a file are sorted
=head1 VERSION
This document describes version 0.002 of sorted (from Perl distribution App-sorted), released on 2020-05-25.
=head1 SYNOPSIS
Usage:
% sorted [-A=s+] [-S=s] [--format=name] [--json] [--(no)naked-res] [--no-quiet] [--noquiet] [--page-result[=program]] [-q] [--quiet] [--sort-arg=s+] [--sort-args-json=s] [--sort-sub=s] [file]
=head1 DESCRIPTION
Assuming C<file.txt>'s content is:
1
2
3
These will return success:
% sorted file.txt
% sorted -S numerically file.txt
But these will not:
% sorted -S 'numerically<r>' file.txt
% sorted -S 'asciibetically<r>' file.txt
Another example, assuming C<file.txt>'s content is:
1
zz
AAA
cccc
then this will return success:
% sorted -S by_length file.txt
% sorted -q -S by_length file.txt ;# -q silences output, it just returns appropriate exit code
while these will not:
% sorted file.txt
% sorted -S 'asciibetically<i>' file.txt
% sorted -S 'by_length<r>' file.txt
=head1 OPTIONS
C<*> marks required options.
=head2 Main options
=over
=item B<--file>=I<s>
Default value:
"-"
=item B<--quiet>, B<-q>
=item B<--sort-arg>=I<s@>, B<-A>
Arguments to pass to the Sort::Sub::* routine.
Can be specified multiple times.
=item B<--sort-args-json>=I<s>
Arguments to pass to the Sort::Sub::* routine (JSON-encoded).
See C<--sort-arg>.
=item B<--sort-sub>=I<s>, B<-S>
Name of a Sort::Sub::* module (without the prefix).
=back
=head2 Output options
=over
=item B<--format>=I<s>
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 sorted sorted
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<cpanm-shcompgen>
which can activate shell completion for scripts immediately.
=head2 tcsh
To activate tcsh completion for this script, put:
complete sorted 'p/*/`sorted`/'
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 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-sorted>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-App-sorted>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-sorted>
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 SEE ALSO
L<is-sorted>. The L<sorted> script is inspired by, and an alternative for,
L<is-sorted> from L<File::IsSorted> by SHLOMIF. C<sorted> adds the ability
to use L<Sort::Sub> routines.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2020, 2019 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