summaryrefslogtreecommitdiff
path: root/colorscript.1
blob: 7f5da60c37610832e1ed159c9b3b620e891b252f (plain)
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
.TH "colorscript" "1" 

.SH "NAME"
.PP
colorscript - run various shell color scripts

.SH "SYNOPSIS"
.PP
colorscript [-OPTION] [SCRIPT NAME]

.SH "DESCRIPTION"
.PP
colorscript is the program that selects and runs the scripts that were installed with shell-color-scripts.  colorscript can be used to run a specific shell color script, or you can use colorscript to run a random shell color script.  Many users will want to add the appropriate colorscript command to their bash/fish/zsh configs so that they always get a shell color script when they launch a terminal or enter the shell.

.SH "OPTIONS"
.SS "-h, --help, help"
.PP
Print this help.
.SS "-l, --list, list"
.PP
List all installed color scripts.
.SS "-r, --random, random"
.PP
Run a random color script.
.SS "-e, --exec, exec"
.PP
Run specified color script by SCRIPT NAME or INDEX.
.SS "-b, --blacklist, blacklist"
.PP
Blacklist a color script by SCRIPT NAME or INDEX.

.SH "FILES"
.SS "/usr/bin/colorscript"
.PP
The colorscript binary.
.SS "/opt/shell-color-scripts"
.PP
The shell color scripts directory.

.SH "EXAMPLES"
.SS "colorscript random"
.PP
Runs a random shell colorscript.  Add this command to your bash/fish/zsh config file, and now when you open a terminal or start a new shell, you will get a random shell color script displayed.
.SS "colorscript -l"
.PP
Get a complete listing of available shell color scripts.  You get the INDEX (number) and the NAME.
.SS "colorscript -e [INDEX or NAME]"
.PP
Runs a specific shell color script.

.SH "AUTHOR"
.PP
Derek Taylor (\fIhttps://gitlab.com/dwt1/shell-color-scripts\fP)