The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

PERLANCAR / App-ColorThemeUtils-0.011 / 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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

              
NAME
    App::ColorThemeUtils - CLI utilities related to color themes
VERSION
    This document describes version 0.011 of App::ColorThemeUtils (from Perl
    distribution App-ColorThemeUtils), released on 2021-08-08.
DESCRIPTION
    This distribution contains the following CLI utilities:
    *   list-color-theme-items
    *   list-color-theme-modules
    *   show-color-theme-swatch
FUNCTIONS
  list_color_theme_items
    Usage:
     list_color_theme_items(%args) -> [$status_code, $reason, $payload, \%result_meta]
    This function is not exported.
    Arguments ('*' denotes required arguments):
    *   theme* => *perl::modname_with_optional_args*
    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)
  list_color_theme_modules
    Usage:
     list_color_theme_modules(%args) -> [$status_code, $reason, $payload, \%result_meta]
    List ColorTheme modules.
    This function is not exported.
    Arguments ('*' denotes required arguments):
    *   detail => *bool*
    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)
  show_color_theme_swatch
    Usage:
     show_color_theme_swatch(%args) -> [$status_code, $reason, $payload, \%result_meta]
    This function is not exported.
    Arguments ('*' denotes required arguments):
    *   theme* => *perl::colortheme::modname_with_optional_args*
    *   width => *posint* (default: 80)
    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-ColorThemeUtils>.
SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-App-ColorThemeUtils>.
BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=App-ColorThemeUtils>
    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.
SEE ALSO
    ColorTheme
AUTHOR
    perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
    This software is copyright (c) 2021, 2020, 2019, 2018 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.