-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathpokemon-colorscripts.1
77 lines (71 loc) · 2.45 KB
/
pokemon-colorscripts.1
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
.TH "POKEMON-COLORSCRIPTS" "1" "2021-08-20" "GNU" "User Commands"
.SH "NAME"
.PP
pokemon-colorscripts - display unicode sprites of pokemon in the terminal
.SH "SYNOPSIS"
.PP
.B pokemon-colorscripts
.RB [-h|--help|help]
.RB [-l|--list|list]
.RB [-r|--random|random
.IR generation ]
.RB [-n|--name
.IR name
.RB [-s|--shiny]]
.SH "DESCRIPTION"
.PP
Pokemon-colorscripts is a CLI utility written in shell script that prints out
unicode sprites of pokemon to the terminal. Almost all pokemon generations 1-8
are available (except may be shiny pokemon or different forms). You can select
specific pokemon to be printed out by name or let the script choose a pokemon
randomly. While choosing randomly you can also filter by generation.
.SH "OPTIONS"
.TP
.B "-h, --help, help"
Print help.
.TP
.B "-l, --list, list"
List all available pokemon.
.TP
\fB -r, --random, random\fR \fI generation\fR
Select a pokemon at random and print it out. Can be followed by an optional
generation number or range 1-8 to print out random pokemon from a specific
generation or range of generations.
If no generation is specified, selects from full list of available pokemon.
.TP
\fB -n, --name\fR \fI name\fR -s, --shiny
Select a specific pokemon to print out by name. Most pokemon are spelled as
expected. A few pokemon with some special characters in their names might be spelled
slightly differently. Examples nidoran-f,nidoran-m,farfetchd,mr-mime etc. You can
check the output of the\fB list\fR option if in doubt. This flag can optionally be
followed by -s or --shiny to print the shiny version of the pokemon instead"
.SH "FILES"
.TP
All the files are present in the directory
"/usr/local/opt/pokemon-colorscripts"
.TP
with the executable script being symlinked to
"/usr/local/bin/pokemon-colorscripts"
.SH "EXAMPLES"
.SS "pokemon-colorscripts -r"
.PP
Prints out a random pokemon. Add this command to your shell config file (.bashrc, .zshrc, fish.config
etc.) to print out a random pokemon every time you open the terminal.
.SS "pokemon-colorscripts -r 1"
.PP
Print out a random pokemon from generation 1.
.SS "pokemon-colorscripts -r 1-3"
.PP
Print out a random pokemon from generations 1-3.
.SS "pokemon-colorscripts -r 1 3 6"
.PP
Print out a random pokemon from generations 1,3 or 6.
.SS "pokemon-colorscripts -l"
.PP
Print out all available pokemon names.
.SS "pokemon-colorscripts -n chikorita"
.PP
Print out the pokemon chikorita.
.SS "pokemon-colorscripts -n mudkip -s"
.PP
Print out the shiny version of mudkip.