about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorCase Duckworth2020-05-30 16:46:04 -0500
committerCase Duckworth2020-05-30 16:46:04 -0500
commit0f87b59ee63bf2e21cc38924450f5d8299883025 (patch)
treeaf224c85aa2dea9f9b4d4e0a8be07b82960841c9
parentChange margin stuff (diff)
downloadbollux-0f87b59ee63bf2e21cc38924450f5d8299883025.tar.gz
bollux-0f87b59ee63bf2e21cc38924450f5d8299883025.zip
Update docs
-rw-r--r--README.md8
-rw-r--r--bollux.conf.557
2 files changed, 62 insertions, 3 deletions
diff --git a/README.md b/README.md index 4c9d694..c987eed 100644 --- a/README.md +++ b/README.md
@@ -15,16 +15,18 @@ inspired by
15* use `dd` to show a nice little download status 15* use `dd` to show a nice little download status
16* use `less` to display text/* files 16* use `less` to display text/* files
17* link navigation 17* link navigation
18* man page
19* configuration
18 20
19# STILL TO DO 21# STILL TO DO
20 22
21* bookmarks/history 23* test configuring capabilities
22* configuration 24* bookmarks
25* history
23* mailcap something 26* mailcap something
24* generate certificates? 27* generate certificates?
25* implement TOFU? 28* implement TOFU?
26* recognize more protocols 29* recognize more protocols
27* write man page
28 30
29# LICENSE 31# LICENSE
30 32
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.
54I'm going to be honest, 54I'm going to be honest,
55the difference between the levels is somewhat arbitrary. 55the difference between the levels is somewhat arbitrary.
56So. 56So.
57.SS Typesetting
58.BR bollux (1)
59typesets text/gemini content using the
60.I typeset_gemini
61function.
62While it's probably possible to redefine the function in
63.BR bollux.conf (5),
64the default function is pretty nice (at least in my opinion).
65The following variables control how text/gemini content is rendered:
66.TP
67.BR T_MARGIN " valid values are integers; default is 4."
68The left margin for text.
69Should be at least 3, since line-markers will be displayed in the left margin.
70.TP
71.BR T_WIDTH " valid values are integers; default is 0."
72The total width of the window, including
73.BR T_MARGIN .
74If set to 0, attempts to use the width of the terminal,
75falling back to 80.
76.SS Colors
77The different line-types in text/gemini documents are rendered with
78.I m-class
79terminal escapes (e.g., '\\e[31m').
80The following variables should hold the values between
81.I \\e[
82and
83.IR m ,
84meaning valid values are anything between those that are valid terminal
85color escapes.
86.TP
87.BR C_SIGIL " default: 35 (fg: magenta)"
88The color of the line type as defined by text/gemini.
89.TP
90.BR C_LINK_NUMBER " default: 1 (bold)"
91The color of the link number added by typeset_gemini.
92.TP
93.BR C_LINK_TITLE " default: 4 (underline)"
94The color of the link's title, or if titleless, the URL.
95.TP
96.BR C_LINK_URL " default: 36 (fg: cyan)"
97The color of the link's URL.
98If the link doesn't have a title, this isn't used.
99.TP
100.BI C_HEADER "x where x is 1, 2, or 3"
101The color of text/gemini headers.
102The default for level 1 is
103.IR 1;4 ,
104for level 2 is
105.IR 1 ,
106for level 3 is
107.IR 3 .
108.TP
109.BR C_LIST " default: 0 (no formatting)"
110The color of list items.
111.TP
112.BR C_PRE " default: 0 (no formatting)"
113The color of preformatted lines, as delimited by '```'.
57.SS Variables that could be configured, but probably shouldn't be 114.SS Variables that could be configured, but probably shouldn't be
58These variables control deeper aspects of 115These variables control deeper aspects of
59.BR bollux (1)'s 116.BR bollux (1)'s