/ 
App-subsort-0.049
River stage one • 1 direct dependent • 1 total dependent
/ sortsub

NAME

sortsub - Sort lines of text (or records) using Sort::Sub routines

VERSION

This document describes version 0.049 of sortsub (from Perl distribution App-subsort), released on 2023-11-28.

SYNOPSIS

% subsort [OPTIONS] <ROUTINE> [FILE]...

Examples:

% subsort naturally data.txt
% some-cmd-that-outputs-lines | subsort naturally -r  ; # reverse order
% subsort 'naturally<r>' data.txt                     ; # ditto
% some-cmd-that-outputs-line | subsort by_several -A first='by_length<r>' -A second=numerically  ; # multiple sort orders

Some other examples:

# like Unix's tac
% subsort record-by-reverse-order data.txt

To list all available (installed) routines:

% subsort -l

To see all available routines on CPAN (using lcpan):

% lcpan mods --namespace Sort::Sub -l

DESCRIPTION

This program is like the Unix command sort, but it uses routines from Sort::Sub.

TIPS AND TRICKS

Debugging

If you use --key, you can use Log::ger::Screen to check the resulting keys, e.g.:

% some-command-that-produces-lines | PERL5OPT=-MLog::ger::Screen TRACE=1 subsort numerically --key '/(\d+)/; $1 // 0'

Sorting by multiple criteria

The Sort::Sub routine by_several allows you to sort by multiple sort subroutines. For example:

% some-command-that-produces-lines | subsort by_several -A first=numerically -A second=randomly

OPTIONS

--help, -h         Show this help message and exit.
--version, -v      Show version and exit.
--list, -l         List available Sort::Sub routines.

--ignore-case, -f  Do a case-insensitive sort.
--reverse, -r      Do a reverse sort.
--arg=s, -A        Argument to pass to sorter. In the form of name=val. Can
                     be specified multiple times.
--key=s, -k        Perl code to generate sort key to sort against.
-0[octal or hexa]  Specify record separator character (default is newline).
--para             Split input per paragraph (by blank lines).

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C sortsub sortsub

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.

tcsh

To activate tcsh completion for this script, put:

complete sortsub 'p/*/`sortsub`/'

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).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-subsort.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-subsort.

SEE ALSO

The sort Unix command.

App::psort

Sort::Sub, which also provides sorting functionality to various other CLI's e.g. sorted (from App::sorted)).

AUTHOR

perlancar <perlancar@cpan.org>

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, 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.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2020, 2019, 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.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-subsort

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.