shchemes/doc/shchemes.1
2024-03-20 14:47:27 -06:00

96 lines
1.7 KiB
Groff

.SH NAME
.PP
shchemes - Automatically theming your apps with the power of the shell.
.SH SYNOPSIS
.IP
.nf
\f[C]
shchemes METHOD [OPTIONS]
\f[R]
.fi
.SH DESCRIPTION
.SS SCHEME
.PP
SCHEME is an environment variable that determines the default color
scheme to operate on.
.PP
Schemes are in a format of <scheme format>:<scheme name>.
.PP
If no format is provided, base16 is assumed.
.SS Examples
.IP
.nf
\f[C]
SCHEME=\[dq]base16:heetch\[dq]
SCHEME=\[dq]base24:monokai\[dq]
\f[R]
.fi
.PP
See also: \f[V]--scheme\f[R]
.SS OPTIONS
.SS \f[V]--scheme\f[R]
.PP
Sets the color scheme to operate on, regardless of the value of SCHEME.
.SS Example
.IP
.nf
\f[C]
shchemes create_theme kitty --scheme=base16:blueforest
\f[R]
.fi
.PP
See also: SCHEME
.SS \f[V]--format\f[R]
.PP
Sets the color scheme format of the output file.
This defaults to the same format as your color scheme.
.SS Example
.IP
.nf
\f[C]
shchemes create_theme alacritty --format=base24
\f[R]
.fi
.SS METHODS
.SS create_theme
.PP
Apply the color scheme to the template for a given app
.IP
.nf
\f[C]
shchemes create_theme TARGET
\f[R]
.fi
.PP
See also: \f[V]--format\f[R]
.SS inject
.PP
In the given file, looks for a comment that indicates a Shchemes
injection block, runs its command in a shell with Shchemes sourced, and
pipes the stdout into the content of the injection block.
.IP
.nf
\f[C]
shchemes inject PATH
\f[R]
.fi
.SS install_tinted_scheme
.PP
Installs a color scheme from the
tinted-theming/schemes (https://github.com/tinted-theming/schemes).
.PP
You can find a gallery of the base16 themes here:
<https://tinted-theming.github.io/base16-gallery/>
.IP
.nf
\f[C]
shchemes install_tinted_scheme
\f[R]
.fi
.PP
See also: \f[V]SCHEME\f[R] \f[V]--scheme\f[R]
.SH AUTHOR
.PP
Shchemes is written by Dakedres