From 4a1bcfd6d9da2a8acce81ff74f871182cd933dde Mon Sep 17 00:00:00 2001
From: Case Duckworth
Date: Tue, 26 May 2020 19:31:06 -0500
Subject: Add Makefiles

---
 bollux.1 | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 bollux.1

(limited to 'bollux.1')

diff --git a/bollux.1 b/bollux.1
new file mode 100644
index 0000000..e4184d5
--- /dev/null
+++ b/bollux.1
@@ -0,0 +1,69 @@
+.TH bollux 1 2020-05-26
+.SH NAME
+bollux \- gemini protocol browser written in bash(1)
+.SH SYNOPSIS
+.B bollux
+.RI [ \-h ]
+.TP
+.B bollux
+.RI [ \-q ]
+.RI [ \-v ]
+.RI [ \-c
+.BR CONFIG ]
+.RB [ URL ]
+.SH DESCRIPTION
+.BR bollux (1)
+is a browser for the new Gemini protocol, which aims to be
+"heavier than gopher, but lighter than the web."
+It can follow links, collect user input, download files, and display text/* mimetype pages in geminispace.
+.SH OPTIONS
+.TP
+.B \-h
+Display an inline help screen and exit
+.TP
+.B \-q
+Be quiet: don't show any messages, even fatal ones
+.TP
+.B \-v
+Be verbose: show all messages, even debug ones
+.TP
+.B \-c CONFIG
+Use CONFIG file to configure
+.BR bollux (1)
+instead of the default: $XDG_CONFIG_HOME/bollux/bollux.conf.
+.TP
+.B URL
+The gemini URL to navigate to
+.SH USAGE
+If
+.BR bollux (1)
+is invoked with a URL, it will download or display that URL.
+Otherwise, the user will be prompted for a URL to download or display.
+If the URL points to a text/* document, it is paged with
+.BR less (1)
+with custom keybinds:
+.TP
+.B o
+open a link on the current page
+.TP
+.B g
+goto a new URL
+.TP
+.B r
+refresh the current page
+.TP
+.B q
+quit bollux
+.PP
+If a new URL is selected, 
+.BR bollux (1)
+will repeat the download-and-display loop with the new URL.
+.SH ISSUES
+There is currently no history storage or recall.
+.BR bollux (1)
+can get confused on some URLs \-\- munging them correctly is an area of active research.
+.SH SEE ALSO
+.BR bollux.conf (5)
+.SH BUGS
+The development repo is located at https://sr.ht/~acdw/bollux.
+Please direct all bug reports, patches, or general complaints there.
-- 
cgit 1.4.1-21-gabe81