The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

PERLANCAR / App-sort_by_sortkey-0.002 / README 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

              
NAME
    App::sort_by_sortkey - Sort lines of text by a SortKey module
VERSION
    This document describes version 0.002 of App::sort_by_sortkey (from Perl
    distribution App-sort_by_sortkey), released on 2024-05-15.
FUNCTIONS
  sort_by_sortkey
    Usage:
     sort_by_sortkey(%args) -> [$status_code, $reason, $payload, \%result_meta]
    Sort lines of text by a SortKey module.
    This utility lets you sort lines of text using one of the available
    SortKey::* perl modules.
    This function is not exported.
    Arguments ('*' denotes required arguments):
    *   dereference_recursive => *true*
        Read all files under each directory, recursively, following all
        symbolic links, unlike -r.
    *   files => *array[filename]*
        (No description)
    *   ignore_case => *bool*
        If set to true, will search case-insensitively.
    *   recursive => *true*
        Read all files under each directory, recursively, following symbolic
        links only if they are on the command line.
    *   reverse => *bool*
        Reverse sort order.
    *   sortkey_module* => *perl::sortkey::modname_with_optional_args*
        (No description)
    Returns an enveloped result (an array).
    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.
    Return value: (any)
HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/App-sort_by_sortkey>.
SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-App-sort_by_sortkey>.
SEE ALSO
    SortKey.
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) 2024 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-sort_by_sortkey>
    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.