Add Makefiles

author: Case Duckworth 2020-05-26 19:31:06 -0500
committer: Case Duckworth 2020-05-26 19:31:06 -0500
commit: 4a1bcfd6d9da2a8acce81ff74f871182cd933dde (patch)
tree: e203e5882de0afb8089c1e531779c9a90d4fa8f5 /bollux.conf.5
parent: Fix dumb mistake (diff)
download: bollux-4a1bcfd6d9da2a8acce81ff74f871182cd933dde.tar.gz
bollux-4a1bcfd6d9da2a8acce81ff74f871182cd933dde.zip
1 files changed, 89 insertions, 0 deletions
diff --git a/bollux.conf.5 b/bollux.conf.5
new file mode 100644
index 0000000..eada1de
--- /dev/null
+++ b/bollux.conf.5

@@ -0,0 +1,89 @@
+.TH bollux.conf 5 2020-05-26
+.SH NAME
+.B bollux.conf
+\- configuration file for
+.BR bollux (1)
+.SH DESCRIPTION
+.BR bollux (1)
+uses a number of environment variables that can be sourced from an external file,
+usually placed in
+.IR $XDG_CONFIG_HOME/bollux/bollux.conf .
+The location can be changed at runtime by invoking
+.BR "bollux \-c CONFIG" .
+.SH VARIABLES
+.SS Variables you might actually want to set
+Here are actually useful variables that are good things to set in your
+.IR bollux.conf ,
+in order of usefulness.
+.TP
+.BR BOLLUX_URL " valid values are URLs; default is ''."
+If
+.B BOLLUX_URL
+is set,
+.BR bollux (1)
+loads that resource;
+otherwise it asks the user for where to go.
+Setting this variable works like setting a home page.
+.TP
+.BR BOLLUX_DOWNDIR " valid values are directories; default is '.'."
+The directory to attempt to save downloads in.
+.BR bollux (1)
+will attempt to download anything whose mimetype isn't
+.IR text/* ,
+and it tries to place it in
+.BR BOLLUX_DOWNDIR .
+If it can't open the directory, save the file,
+or if there's another file with the same name,
+.BR bollux (1)
+will report the name of the temporary file it saved.
+.TP
+.BR BOLLUX_MAXREDIR " valid values are integers; default is '5'."
+The maximum number of redirects before
+.BR bollux (1)
+decides to quit.
+The default is 5 as per some RFC spec.
+.TP
+.BR BOLLUX_LOGLEVEL " valid values are '', DEBUG or QUIET; default is ''."
+How verbose
+.BR bollux (1)
+should be.
+.I DEBUG
+prints debug-level messages.
+.I QUIET
+suppresses even error-level messages.
+I'm going to be honest,
+the difference between the levels is somewhat arbitrary.
+So.
+.SS Variables that could be configured, but probably shouldn't be
+These variables control deeper aspects of
+.BR bollux (1)'s
+workings.
+It's possible they could be tweaked to make
+.BR bollux (1)
+work differently, like browsing gopher instead of gemini,
+but that capability has not been tested.
+.TP
+.BR BOLLUX_PORT " valid values are port numbers (1-65535); default is '1965'."
+The port
+.BR bollux (1)
+tries to connect to on the server.
+.TP
+.BR BOLLUX_PROTO " valid values are protocol names (strings); default is 'gemini'."
+The protocol to use.
+.TP
+.BR BOLLUX_LESSKEY " valid values are files; default is '/tmp/bollux-lesskey'."
+Where to store the generated
+.BR lesskey (1)
+file.
+.TP
+.BR BOLLUX_PAGESRC " valid values are files; default is '/tmp/bollux-src'."
+Where to store the page source of the site being visited.
+It's not used right now by
+.BR bollux (1),
+but you could ...
+.BR cat (1)
+it?
+.SH FILES
+.I $XDG_CONFIG_HOME/bollux/bollux.conf
+.SH SEE ALSO
+.BR bollux (1)
author	Case Duckworth	2020-05-26 19:31:06 -0500
committer	Case Duckworth	2020-05-26 19:31:06 -0500
commit	4a1bcfd6d9da2a8acce81ff74f871182cd933dde (patch)
tree	e203e5882de0afb8089c1e531779c9a90d4fa8f5 /bollux.conf.5
parent	Fix dumb mistake (diff)
download	bollux-4a1bcfd6d9da2a8acce81ff74f871182cd933dde.tar.gz bollux-4a1bcfd6d9da2a8acce81ff74f871182cd933dde.zip

diff --git a/bollux.conf.5 b/bollux.conf.5 new file mode 100644 index 0000000..eada1de --- /dev/null +++ b/bollux.conf.5
@@ -0,0 +1,89 @@
	1	.TH bollux.conf 5 2020-05-26
	2	.SH NAME
	3	.B bollux.conf
	4	\- configuration file for
	5	.BR bollux (1)
	6	.SH DESCRIPTION
	7	.BR bollux (1)
	8	uses a number of environment variables that can be sourced from an external file,
	9	usually placed in
	10	.IR $XDG_CONFIG_HOME/bollux/bollux.conf .
	11	The location can be changed at runtime by invoking
	12	.BR "bollux \-c CONFIG" .
	13	.SH VARIABLES
	14	.SS Variables you might actually want to set
	15	Here are actually useful variables that are good things to set in your
	16	.IR bollux.conf ,
	17	in order of usefulness.
	18	.TP
	19	.BR BOLLUX_URL " valid values are URLs; default is ''."
	20	If
	21	.B BOLLUX_URL
	22	is set,
	23	.BR bollux (1)
	24	loads that resource;
	25	otherwise it asks the user for where to go.
	26	Setting this variable works like setting a home page.
	27	.TP
	28	.BR BOLLUX_DOWNDIR " valid values are directories; default is '.'."
	29	The directory to attempt to save downloads in.
	30	.BR bollux (1)
	31	will attempt to download anything whose mimetype isn't
	32	.IR text/* ,
	33	and it tries to place it in
	34	.BR BOLLUX_DOWNDIR .
	35	If it can't open the directory, save the file,
	36	or if there's another file with the same name,
	37	.BR bollux (1)
	38	will report the name of the temporary file it saved.
	39	.TP
	40	.BR BOLLUX_MAXREDIR " valid values are integers; default is '5'."
	41	The maximum number of redirects before
	42	.BR bollux (1)
	43	decides to quit.
	44	The default is 5 as per some RFC spec.
	45	.TP
	46	.BR BOLLUX_LOGLEVEL " valid values are '', DEBUG or QUIET; default is ''."
	47	How verbose
	48	.BR bollux (1)
	49	should be.
	50	.I DEBUG
	51	prints debug-level messages.
	52	.I QUIET
	53	suppresses even error-level messages.
	54	I'm going to be honest,
	55	the difference between the levels is somewhat arbitrary.
	56	So.
	57	.SS Variables that could be configured, but probably shouldn't be
	58	These variables control deeper aspects of
	59	.BR bollux (1)'s
	60	workings.
	61	It's possible they could be tweaked to make
	62	.BR bollux (1)
	63	work differently, like browsing gopher instead of gemini,
	64	but that capability has not been tested.
	65	.TP
	66	.BR BOLLUX_PORT " valid values are port numbers (1-65535); default is '1965'."
	67	The port
	68	.BR bollux (1)
	69	tries to connect to on the server.
	70	.TP
	71	.BR BOLLUX_PROTO " valid values are protocol names (strings); default is 'gemini'."
	72	The protocol to use.
	73	.TP
	74	.BR BOLLUX_LESSKEY " valid values are files; default is '/tmp/bollux-lesskey'."
	75	Where to store the generated
	76	.BR lesskey (1)
	77	file.
	78	.TP
	79	.BR BOLLUX_PAGESRC " valid values are files; default is '/tmp/bollux-src'."
	80	Where to store the page source of the site being visited.
	81	It's not used right now by
	82	.BR bollux (1),
	83	but you could ...
	84	.BR cat (1)
	85	it?
	86	.SH FILES
	87	.I $XDG_CONFIG_HOME/bollux/bollux.conf
	88	.SH SEE ALSO
	89	.BR bollux (1)