File Coverage

blib/lib/App/Cheats.pm
Criterion Covered Total %
statement 8 8 100.0
branch n/a
condition n/a
subroutine 3 3 100.0
pod n/a
total 11 11 100.0


line stmt bran cond sub pod time code
1             package App::Cheats;
2              
3 1     1   211313 use 5.006;
  1         5  
4 1     1   14 use strict;
  1         2  
  1         44  
5 1     1   5 use warnings;
  1         2  
  1         225  
6              
7             our $VERSION = '0.08';
8              
9             =head1 LOGO
10              
11             ~ __ __ ~
12             ~ _____/ /_ ___ ____ _/ /______ ~
13             ~ / ___/ __ \/ _ \/ __ `/ __/ ___/ ~
14             ~ / /__/ / / / __/ /_/ / /_(__ ) ~
15             ~ \___/_/ /_/\___/\__,_/\__/____/ ~
16             ~ ~
17              
18             =cut
19              
20             =head1 NAME
21              
22             App::Cheats - Cheatsheet
23              
24             =cut
25              
26             =head1 Summary
27              
28             Useful commands collected over the years
29              
30             =head1 Installation:
31              
32             Install bash completion support.
33              
34             % apt install bash-completion
35              
36             Install cpanm.
37              
38             % cpan App::cpanminus
39              
40             Install module dependencies.
41              
42             % cpanm --installdeps .
43              
44             Install tab completion.
45              
46             % source bashrc_pod
47              
48             =head1 Usage:
49              
50             # Show help.
51             pod
52             pod -h
53              
54             =head1 Examples:
55              
56             View summary of Mojo::UserAgent:
57              
58             % pod Mojo::UserAgent
59              
60             View summary of a specific method.
61              
62             % pod Mojo::UserAgent get
63              
64             Edit the module
65              
66             % pod Mojo::UserAgent -e
67              
68             Edit the module and jump to the specific method definition right away.
69             (Press "n" to next match if neeeded).
70              
71             % pod Mojo::UserAgent get -e
72              
73             Run perldoc on the module (for convience)
74              
75             % pod Mojo::UserAgent -d
76              
77             List all available methods.
78             If no methods are found normally, then this will automatically be enabled.
79             (pod was made to work with Mojo pod styling).
80              
81             % pod Mojo::UserAgent -a
82              
83             =head1 ENVIRONMENT
84              
85             cheat expects to find a cheat* file somewhere
86             in $CHEAT_DIRS.
87              
88             You can start with mine as an example:
89             https://github.com/poti1/cheats/blob/main/cheats.txt
90              
91             Save it and set this variable:
92             export CHEAT_DIRS="PATH_TO_CHEAT_DIRS"
93              
94             Optionally you can set this flag:
95             --cheat_dirs "PATH_TO_CHEAT_DIRS"
96              
97             If neither is provided, will search for a cheat
98             file in the same location as this script.
99              
100             =cut
101              
102             =head1 LICENSE AND COPYRIGHT
103              
104             This software is Copyright (c) 2024 by Tim Potapov.
105              
106             This is free software, licensed under:
107              
108             The Artistic License 2.0 (GPL Compatible)
109              
110             =cut
111              
112             =head1 AUTHOR
113              
114             Tim Potapov, C<< >>
115              
116             =cut
117              
118             1;