'\" t
.\"     Title: rink
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.21
.\"      Date: 2024-05-01
.\"    Manual: Rink Manual
.\"    Source: Rink Manual
.\"  Language: English
.\"
.TH "RINK" "5" "2024-05-01" "Rink Manual" "Rink Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
rink \- TOML configuration file format.
.SH "DESCRIPTION"
.sp
Rink\(cqs configuration file uses the TOML format.
.sp
Duration types accept common suffixes like \f(CRms\fP, \f(CRs\fP, \f(CRh\fP, \f(CRd\fP, \f(CRy\fP.
Size types accept suffixes like \f(CRMB\fP.
.sp
Color strings are a set of keywords separated by spaces. The following
keywords are understood:
.sp
\fBblack\fP, \fBred\fP, \fBgreen\fP, \fByellow\fP, \fBblue\fP, \fBpurple\fP, \fBcyan\fP, \fBwhite\fP
.RS 4
Sets the color to that ANSI color.
.RE
.sp
\fBdim\fP/\fBdimmed\fP
.RS 4
Uses a dimmed variant of the color instead of the bright variant.
.RE
.sp
\fBbold\fP, \fBitalic\fP, \fBunderline\fP/\fBunder\fP, \fBstrikethrough\fP
.RS 4
Formatting.
.RE
.sp
\fBhidden\fP/\fBnone\fP
.RS 4
Makes the text invisible.
.RE
.sp
\fBon\fP
.RS 4
The color keyword after this will apply to the background instead of
the foreground. Example: \f(CRblack on red\fP.
.RE
.sp
\fBdefault\fP/\fBplain\fP
.RS 4
Results in unstyled text.
.RE
.sp
integers 0 to 255
.RS 4
Extended terminal color palette codes.
.RE
.sp
\fB#\fP <\fI6 hex letters\fP>
.RS 4
Hex codes can be used to specify truecolor.
Example: \f(CR#000000\fP
.RE
.sp
\fBrgb(\fP <\fIred\fP> \fB,\fP <\fIgreen\fP> \fB,\fP <\fIblue\fP> \fB)\fP
.RS 4
RGB values can be used to specify truecolor. No spaces are allowed.
Example: \f(CRrgb(10,10,10)\fP
.RE
.SS "Rink"
.sp
The \f(CR[rink]\fP section.
.sp
\fBprompt\fP = <\fIstring\fP>
.RS 4
The text that will be displayed before the cursor, to hint
interactivity. Should include the space character.
Default: \f(CR"> "\fP
.RE
.sp
\fBlong_output\fP = <\fIbool\fP>
.RS 4
Breaks lists, such as search results, over multiple lines. Requires
a Unicode\-capable terminal.
Default: \f(CRfalse\fP
.RE
.SS "Currency"
.sp
The \f(CR[currency]\fP section.
.sp
\fBenabled\fP = <\fIbool\fP>
.RS 4
Currency fetching can be disabled for those that don\(cqt want it.
Default: \f(CRtrue\fP
.RE
.sp
\fBendpoint\fP = <\fIurl\fP>
.RS 4
Allows pointing to alternate Rink\-Web instances, or to any other API
that offers a compatible format.
Default: \f(CR"https://rinkcalc.app/data/currency.json"\fP
.RE
.sp
\fBtimeout\fP = <\fIduration\fP>
.RS 4
How long to wait for currency fetching before giving up.
Default: \f(CR"2s"\fP
.RE
.sp
\fBcache_duration\fP = <\fIduration\fP>
.RS 4
How long to wait before considering the cached currency data stale.
Default: \f(CR"1h"\fP
.RE
.SS "Colors"
.sp
The \f(CR[colors]\fP section.
.sp
\fBenabled\fP = <\fIbool\fP>
.RS 4
Set to true to turn on colored output.
Default: \f(CRtrue\fP, or \f(CRfalse\fP if the \f(CRNO_COLOR\fP environment variable is set.
.RE
.sp
\fBtheme\fP = <\fIstring\fP>
.RS 4
Sets the active theme. See the THEMES section.
Default: \f(CR"default"\fP
.RE
.SS "Themes"
.sp
The \f(CR[themes]\fP section. This section is a dictionary, each theme should be
created as \f(CR[themes.my_theme]\fP. These options are specific to each.
.sp
\fBplain\fP = <\fIcolor\fP>
.RS 4
Generic text. This will be used often.
Default: \f(CR"default"\fP
.RE
.sp
\fBerror\fP = <\fIcolor\fP>
.RS 4
Error messages.
Default: \f(CR"red"\fP
.RE
.sp
\fBunit\fP = <\fIcolor\fP>
.RS 4
The names of units, like \f(CRkilogram\fP.
Default: \f(CR"cyan"\fP
.RE
.sp
\fBquantity\fP = <\fIcolor\fP>
.RS 4
The names of physical quantities, like \f(CRlength\fP and \f(CRtime\fP. These
are shown in parentheses on every query.
Default: \f(CR"dimmed cyan"\fP
.RE
.sp
\fBnumber\fP = <\fIcolor\fP>
.RS 4
Numbers that appear in outputs.
Default: \f(CR"default"\fP
.RE
.sp
\fBuser_input\fP = <\fIcolor\fP>
.RS 4
Used when rink is quoting user input back, such as in unit not found
errors.
Default: \f(CR"bold"\fP
.RE
.sp
\fBdoc_string\fP = <\fIcolor\fP>
.RS 4
Used when rink is showing informational text that\(cqs part of the
definition of a unit, like \f(CRmeter\fP.
Default: \f(CR"italic"\fP
.RE
.sp
\fBpow\fP = <\fIcolor\fP>
.RS 4
The \f(CR^2\fP in \f(CRm/s^2\fP.
Default: \f(CR"default"\fP
.RE
.sp
\fBprop_name\fP = <\fIcolor\fP>
.RS 4
Names of properties in substances, like the \f(CRspeed\fP in \f(CRspeed of
light\fP.
Default: \f(CR"cyan"\fP
.RE
.sp
\fBdate_time\fP = <\fIcolor\fP>
.RS 4
Date time objects, that can be obtained with the hash notation or
\f(CRnow\fP.
Default: \f(CR"default"\fP
.RE
.SH "FILES"
.sp
Linux
.RS 4
__$XDG_CONFIG_DIR__/rink/config.toml
.RE
.sp
Windows
.RS 4
__{FOLDERID_RoamingAppData}__\(rsrink\(rsconfig.toml
.RE
.sp
macOS
.RS 4
__$HOME__/Library/Application Support/rink/config.toml
.RE
.SH "SEE ALSO"
.sp
rink(1), rink(7),
rink\-defs(5),
rink\-dates(5)