~chrisppy/titan

ref: 17021ce9af427a5abc0c22eb490324b3b383a007 titan/doc/titan-config.5.scd -rw-r--r-- 4.6 KiB
17021ce9Chris Palmer add theming for tabs and scroll bar 3 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
titan-config(5)

# NAME

titan-config - configuration file format for *titan*(1)

# DESCRIPTION

*titan* allows configuring of many of the core functionality within++
the titan configuration file (config). By default it is located in++
~/.config/titan. If no config file is found, a default will be++
created.  The configuration file follows the scfg standard

# OPTIONS

*home-page* <gemini capsule>
	The default gemini capsule to open if no capsule is passed to++
the command.

*display-hidden-links*
	displays links that normally are hidden when a link has a name.

## THEME

Theme is defined within a _theme_ _{_ _}_ block.  Colors must be specified++
either as W3C color names(e.g. Blue) or RGB hexadecimal++
strings(e.g. "#88c0d0").  Also, note that if the object colors are not++
defined, it will inherit the colors from *background-color* and++
*foreground-color*.  Note this is a required block.

*background-color* <color>
	Background color of the application when not set in sub blocks.

*foreground-color* <color>
	Foreground color of the application when not set in sub blocks.

*error-color* <color>
	Text color of error messages.

*scroll-bar-color* <color>
	Color of the scroll bar.

*tab-bar-color* <color>
	Background color of tab bar.

*COMMAND LINE*
	Command line is defined within a _command-line_ _{_ _}_ block inside a++
_theme_ _{_ _}_ block.

	*background-color* <color>
		Background color of the command line.

	*foreground-color* <color>
		Foreground color of the command line.

*STATUS LINE*
	Status line is defined within a _status-line_ _{_ _}_ block inside a++
_theme_ _{_ _}_ block.

	*background-color* <color>
		Background color of the status line.

	*foreground-color* <color>
		Foreground color of the status line.

*TAB*
	Tab is defined within a _tab_ _{_ _}_ block inside a++
_theme_ _{_ _}_ block.

	*background-color* <color>
		Background color of the tab.

	*foreground-color* <color>
		Foreground color of the tab.

*TAB ACTIVE*
	Tab Active  is defined within a _tab-active_ _{_ _}_ block inside a++
_theme_ _{_ _}_ block.

	*background-color* <color>
		Background color of the active tab.

	*foreground-color* <color>
		Foreground color of the active tab.

*TITLE BAR*
	Title bar is defined within a _title-bar_ _{_ _}_ block inside a++
_theme_ _{_ _}_ block.

	*background-color* <color>
		Background color of the title bar.

	*foreground-color* <color>
		Foreground color of the title bar.

*CONTENT*
	Content is defined within a _content_ _{_ _}_ block inside a++
_theme_ _{_ _}_ block.  This will theme the reading panes++
with the LIST, SUBSCRIPTIONS, FAVORITES, and HELP pages.

	*background-color* <color>
		Background color of the content.

	*text-color* <color>
		Text color of the content.

	*header1-color* <color>
		Text color for # headers

	*header2-color* <color>
		Text color for ## headers

	*header3-color* <color>
		Text color for ### headers

	*link-color* <color>
		Text color for gemini links

	*ext-link-color* <color>
		Text color for external links

	*preformatted-text-color* <color>
		Text color for preformatted text

## KEY COMMANDS

Key commands are defined within a _key-commands_ _{_ _}_ block.  Keys++
can be either a single character or defined by the KeyNames in++
the tcell library (e.g. PgUp).  You can make these key combos by++
adding added a + between they keys, i.e. Alt+1. Note this is a ++
required block.


*browser-page* <key>
	Key used to switch the browser page.

*help-page* <key>
	Key used to switch the help page.

*open* <key>
	Key used to enter command mode with :open.

*open-tab* <key>
	Key used to enter command mode with :open-tab.

*close-tab* <key>
	Key used to close the current tab.

*left* <key>
	Key used to navigate to the tab on the left.

*up* <key>
	Key to move up in the current section.

*down* <key>
	Key to move down in the current section.

*right* <key>
	Key used to navigate to the tab on the right.

*page-up* <key>
	Key to navigate upward quicker in the current++
section.

*page-down* <key>
	Key to navigate downward quicker in the current++
section.

*back* <key>
	Key to navigate to the previous page on the++
current tab.

*forward* <key>
	Key to navigate to the next page on the++
current tab.

## EXTERNAL

External is defined within _external_ http|gopher _{_ _}_ blocks.

*command* <command>
	The command to open the browser, must have [URL]++
as one of the arguments as that will substitute the++
url to open.++
Example: command xdg-open [URL]

# SEE ALSO
	*titan*(1)

# AUTHORS

Written and maintained by Chris Palmer

titan v0.2.0 is available under the terms of the GPL-3.0 license.

Copyright © 2020-2021 Chris Palmer <chris@red-oxide.org>