141 lines
2.8 KiB
Groff
141 lines
2.8 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
|
|
.PP
|
|
See also: \f[V]create_theme\f[R]
|
|
.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]
|
|
\f[V]convert_tinted_scheme\f[R]
|
|
.SS convert_tinted_scheme
|
|
.PP
|
|
Converts a tinted-theming scheme to a .properties format for use in
|
|
shchemes.
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
shchemes convert_tinted_scheme pico.yaml
|
|
cat pico.yaml > shchemes convert_tinted_scheme
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
See also: \f[V]install_tinted_scheme\f[R]
|
|
.SS install_tinted_template
|
|
.PP
|
|
Downloads, converts, and installs a tinted-theming template from a given
|
|
url.
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
shchemes install_tinted_template https://raw.githubusercontent.com/tinted-theming/base16-emacs/main/templates/default.mustache
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
It is recommended that you use already-maintained shchemes templates
|
|
rather than just installing and converting third party ones.
|
|
.PP
|
|
See also: \f[V]convert_tinted_template\f[R]
|
|
.SS convert_tinted_template
|
|
.PP
|
|
Converts a tinted-theming .mustache template to a shchemes template.
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
shchemes convert_tinted_template default.mustache > \[ti]/shchemes/base16/templates/emacs.mustache
|
|
\f[R]
|
|
.fi
|
|
.PP
|
|
See also: \f[V]install_tinted_template\f[R]
|
|
.SS manual, man, help
|
|
.PP
|
|
Opens this manual
|
|
.SH AUTHOR
|
|
.PP
|
|
Shchemes is written by Dakedres
|