From 0f87b59ee63bf2e21cc38924450f5d8299883025 Mon Sep 17 00:00:00 2001
From: Case Duckworth
Date: Sat, 30 May 2020 16:46:04 -0500
Subject: Update docs

---
 bollux.conf.5 | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)

(limited to 'bollux.conf.5')

diff --git a/bollux.conf.5 b/bollux.conf.5
index eada1de..291dd42 100644
--- a/bollux.conf.5
+++ b/bollux.conf.5
@@ -54,6 +54,63 @@ suppresses even error-level messages.
 I'm going to be honest,
 the difference between the levels is somewhat arbitrary.
 So.
+.SS Typesetting
+.BR bollux (1)
+typesets text/gemini content using the
+.I typeset_gemini
+function.
+While it's probably possible to redefine the function in
+.BR bollux.conf (5),
+the default function is pretty nice (at least in my opinion).
+The following variables control how text/gemini content is rendered:
+.TP
+.BR T_MARGIN " valid values are integers; default is 4."
+The left margin for text.
+Should be at least 3, since line-markers will be displayed in the left margin.
+.TP
+.BR T_WIDTH " valid values are integers; default is 0."
+The total width of the window, including
+.BR T_MARGIN .
+If set to 0, attempts to use the width of the terminal,
+falling back to 80.
+.SS Colors
+The different line-types in text/gemini documents are rendered with
+.I m-class
+terminal escapes (e.g., '\\e[31m').
+The following variables should hold the values between
+.I \\e[
+and
+.IR m ,
+meaning valid values are anything between those that are valid terminal
+color escapes.
+.TP
+.BR C_SIGIL " default: 35 (fg: magenta)"
+The color of the line type as defined by text/gemini.
+.TP
+.BR C_LINK_NUMBER " default: 1 (bold)"
+The color of the link number added by typeset_gemini.
+.TP
+.BR C_LINK_TITLE " default: 4 (underline)"
+The color of the link's title, or if titleless, the URL.
+.TP
+.BR C_LINK_URL " default: 36 (fg: cyan)"
+The color of the link's URL.
+If the link doesn't have a title, this isn't used.
+.TP
+.BI C_HEADER "x where x is 1, 2, or 3"
+The color of text/gemini headers.
+The default for level 1 is
+.IR 1;4 ,
+for level 2 is
+.IR 1 ,
+for level 3 is
+.IR 3 .
+.TP
+.BR C_LIST " default: 0 (no formatting)"
+The color of list items.
+.TP
+.BR C_PRE " default: 0 (no formatting)"
+The color of preformatted lines, as delimited by '```'.
 .SS Variables that could be configured, but probably shouldn't be
 These variables control deeper aspects of
 .BR bollux (1)'s
-- 
cgit 1.4.1-21-gabe81