.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "MACCHINA" "7" "2023-03-28"
.P
.SH NAME
macchina - theming.\&
.P
.SH SYNOPSIS
\fB$XDG_CONFIG_HOME/macchina/themes\fR, \fB~/.\&config/macchina/themes\fR.\&
.P
.SH DESCRIPTION
Themes are your interface to customizing all visual aspects of macchina.\& The
following manpage covers everything you need to know to design your own theme.\&
.P
.SH GENERAL OPTIONS
General options should be set at the top of the theme'\&s configuration file, as
they do not belong to any particular section.\&
.P
.SS spacing
Defines the amount of spacing to leave between
the separator and the content besides it, e.\&g.\&:
.RS 4
.P
spacing = 1
.P
.RE
.SS padding
Defines the amount of padding to leave between
the content and its surroundings, e.\&g.\&:
.RS 4
.P
padding = 0
.P
.RE
.SS hide_ascii
Disables the rendering of ASCII, whether it be
built-in or custom, e.\&g.\&:
.RS 4
.P
hide_ascii = false
.P
.RE
.SS prefer_small_ascii
For built-in ASCII, always use smaller variants, e.\&g.\&:
.RS 4
.P
prefer_small_ascii = true
.P
.RE
.SS separator
Defines the glyph to use for the separator, e.\&g.\&:
.RS 4
.P
separator = "-->"
.P
.RE
.SS key_color
Defines the color of the keys.\&
.P
Accepts hexadecimal values:
.P
.RS 4
color = "#00FF00"
.P
.RE
Indexed values:
.P
.RS 4
color = "046"
.P
.RE
Predefined color names, where casing is insensitive:
.P
.RS 4
color = "Green"
.P
.RE
.SS separator_color
Defines the color of the separator.\&
.RS 4
.P
.RE
Accepts hexadecimal values:
.P
.RS 4
color = "#00FF00"
.P
.RE
Indexed values:
.P
.RS 4
color = "046"
.P
.RE
Predefined color names, where casing is insensitive:
.P
.RS 4
color = "Green"
.P
.RE
.SH PALETTE SECTION
This section, noted \fB[palette]\fR, offers a visual component that displays and
represents the active colorscheme of your terminal emulator.\&
.P
.SS type
Defines the color set to use for the palette, with possible values of "Dark",
"Light", "Full" (case-sensitive).\&
.P
.SS glyph
Defines the glyph to use for the palette, e.\&g.\&:
.P
.RS 4
glyph = "() "
.P
.RE
You should append a space to leave some room between the glyphs.\&
.P
.SS visible
Defines whether to show or hide the palette, e.\&g.\&:
.RS 4
.P
visible = true
.P
.RE
.SH BAR SECTION
.P
This section, noted \fB[bar]\fR, replaces data that ranges from 0-100% with bars.\&
.P
.SS glyph
Defines the glyph to use for all bars, e.\&g.\&:
.RS 4
.P
glyph = "o"
.P
.RE
.SS symbol_open
Defines the character to use for opening delimiters.\& Be sure
.RS 4
to surround the value with single quotes and not double quotes, e.\&g.\&:
.P
symbol_open = '\&('\&
.P
.RE
.SS symbol_close
Defines the character to use for closing delimiters.\& Be sure
to surround the value with single quotes and not double quotes, e.\&g.\&:
.P
.RS 4
symbol_close = '\&)'\&
.P
.RE
.SS visible
Defines whether to show or hide the bars, e.\&g.\&:
.P
.RS 4
visible = true
.P
.RE
.SS hide_delimiters
Defines whether to show or hide the bars delimiters, i.\&e.\&
the characters that surround the bars themselves, e.\&g.\&:
.P
.RS 4
hide_delimiters = false
.P
.RE
.SH BOX SECTION
.P
The section, noted \fB[box]\fR, offers a box component which is rendered to surround
your system information.\&
.P
.SS title
Defines the title of the box, e.\&g.\&:
.P
.RS 4
title = "Hydrogen"
.P
.RE
.SS border
Defines the type of border to use for the box, with possible values of "plain",
"thick", "rounded" or "double".\&
.P
.SS visible
Defines whether to show or hide the box, e.\&g.\&:
.P
.RS 4
visible = true
.P
.RE
.SH BOX.INNER_MARGIN SECTION
.P
.SS x 
Defines the horizontal margin to leave between
the content and the box, e.\&g.\&:
.RS 4
.P
x = 2
.P
.RE
.SS y
Defines the vertical margin to leave between the content and the box, e.\&g.\&:
.RS 4
.P
y = 1
.P
.RE
.SH CUSTOM_ASCII SECTION
This section, noted \fB[custom_ascii]\fR, allows you to specify your own ASCII art.\&
ANSI escape sequences are supported.\&
.P
.SS color
Defines the color of the ASCII.\&
.RS 4
.P
.RE
Accepts hexadecimal values:
.P
.RS 4
color = "#00FF00"
.P
.RE
Indexed values:
.P
.RS 4
color = "046"
.P
.RE
Predefined color names (case-insensitive):
.P
.RS 4
color = "Green"
.P
.RE
.SS path
Defines the path to a file on your filesystem
which contains the ASCII art you want to display, e.\&g.\&:
.RS 4
.P
path = "~/ascii/arch_linux"
.P
.RE
.SH RANDOMIZE SECTION
This section, noted \fB[randomize]\fR, is used to randomize color selection.\&
.P
.SS key_color
Defines whether to randomize the color of the keys, e.\&g.\&:
.P
.RS 4
key_color = true
.P
.RE
.SS separator_color
Defines whether to randomize the color of the separator, e.\&g.\&:
.P
.RS 4
separator_color = true
.P
.RE
.SS pool
Defines the pool of colors from which to pick a random color, with possible
values of "hexadecimal", "indexed" or "base" (case-insensitive).\&
.RS 4
.P
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
If "hexadecimal" is specified, you'\&ll get a random color ranging

.RE
from #000000 to #FFFFFF
.RS 4
.P
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
If "indexed" is specified, you'\&ll get a random color ranging from 0 to 255
.RS 4

.RE
.P
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
If "base" is specified, you'\&ll see a random color from the following set of

.RE
colors: "black", "white", "red", "green", "blue", "yellow", "magenta" and
"cyan".\&
.P
.SH KEYS SECTION
This section, noted \fB[keys]\fR, allows you to modify the text of each key.\&
.P
For example, the "Processor" readout, which by default shows up as "CPU" in
macchina'\&s output, can be renamed to whatever you like by setting the "cpu"
option.\&
.P
.SS host
Defines the text of the Host readout, e.\&g.\&:
.P
.RS 4
host = "Host"
.P
.RE
.SS kernel
Defines the text of the Kernel readout, e.\&g.\&:
.P
.RS 4
kernel = "Kernel"
.P
.RE
.SS os
Defines the text of the OperatingSystem readout, e.\&g.\&:
.P
.RS 4
os = "OS"
.P
.RE
.SS machine
Defines the text of the Machine readout, e.\&g.\&:
.P
.RS 4
machine= "Machine"
.P
.RE
.SS de
Defines the text of the DesktopEnvironment readout, e.\&g.\&:
.P
.RS 4
de = "DE"
.P
.RE
.SS wm
Defines the text of the WindowManager readout, e.\&g.\&:
.P
.RS 4
wm = "WM"
.P
.RE
.SS distro
Defines the text of the Distribution readout, e.\&g.\&:
.RS 4
.P
distro = "Distro"
.P
.RE
.SS terminal
Defines the text of the Terminal readout, e.\&g.\&:
.P
.RS 4
terminal = "Term"
.P
.RE
.SS shell
Defines the text of the Shell readout, e.\&g.\&:
.P
.RS 4
shell = "Shell"
.P
.RE
.SS packages
Defines the text of the Packages readout, e.\&g.\&:
.P
.RS 4
packages = "Packages"
.P
.RE
.SS uptime
Defines the text of the Uptime readout, e.\&g.\&:
.P
.RS 4
uptime = "Uptime"
.P
.RE
.SS local_ip
Defines the text of the LocalIP readout, e.\&g.\&:
.P
.RS 4
local_ip = "Local IP"
.P
.RE
.SS memory
Defines the text of the Memory readout, e.\&g.\&:
.P
.RS 4
memory = "Memory"
.P
.RE
.SS battery
Defines the text of the Battery readout, e.\&g.\&:
.RS 4
.P
battery = "Battery"
.P
.RE
.SS backlight
Defines the text of the Backlight readout, e.\&g.\&:
.P
.RS 4
backlight = "Brightness"
.P
.RE
.SS resolution
Defines the text of the Resolution readout, e.\&g.\&:
.P
.RS 4
resolution = "Resolution"
.P
.RE
.SS cpu
Defines the text of the Processor readout, e.\&g.\&:
.RS 4
.P
cpu = "CPU"
.P
.RE
.SS cpu_load
Defines the text of the ProcessorLoad readout, e.\&g.\&:
.P
.RS 4
cpu_load = "CPU %"
.P
.RE
.SS gpu
Defines the text of the GPU readout(s), e.\&g.\&:
.P
.RS 4
gpu = "GPU"
.P
.RE
.SS disk_space
Defines the text of the disk space readout, e.\&g.\&:
.P
.RS 4
disk_space = "Disk Space"
.P
.RE
.SH SEE ALSO
macchina(1)