diff options
| author | Case Duckworth | 2020-06-07 14:02:57 -0500 |
|---|---|---|
| committer | Case Duckworth | 2020-06-07 14:02:57 -0500 |
| commit | 41e2c8da3d3253913fb58a61820b9341b16a8550 (patch) | |
| tree | 68d188217e2d0c6e56585e7269e1841119a2a2f8 /bollux.1 | |
| parent | Set timeout (diff) | |
| download | bollux-41e2c8da3d3253913fb58a61820b9341b16a8550.tar.gz bollux-41e2c8da3d3253913fb58a61820b9341b16a8550.zip | |
Update documentation
Diffstat (limited to 'bollux.1')
| -rw-r--r-- | bollux.1 | 32 |
1 files changed, 22 insertions, 10 deletions
| diff --git a/bollux.1 b/bollux.1 index 4b6948d..122934d 100644 --- a/bollux.1 +++ b/bollux.1 | |||
| @@ -1,6 +1,7 @@ | |||
| 1 | .TH bollux 1 0.3.0 | 1 | .TH bollux 1 0.4.0 |
| 2 | .SH NAME | 2 | .SH NAME |
| 3 | bollux \- gemini protocol browser written in bash(1) | 3 | bollux \- gemini protocol browser written in |
| 4 | .BR bash (1) | ||
| 4 | .SH SYNOPSIS | 5 | .SH SYNOPSIS |
| 5 | .B bollux | 6 | .B bollux |
| 6 | .RI [ \-h ] | 7 | .RI [ \-h ] |
| @@ -26,11 +27,11 @@ Be quiet: don't show any messages, even fatal ones | |||
| 26 | .TP | 27 | .TP |
| 27 | .B \-v | 28 | .B \-v |
| 28 | Be verbose: show all messages, even debug ones | 29 | Be verbose: show all messages, even debug ones |
| 29 | .TP | 30 | .\".TP |
| 30 | .B \-c CONFIG | 31 | .\".B \-c CONFIG |
| 31 | Use CONFIG file to configure | 32 | .\"Use CONFIG file to configure |
| 32 | .BR bollux (1) | 33 | .\".BR bollux (1) |
| 33 | instead of the default: $XDG_CONFIG_HOME/bollux/bollux.conf. | 34 | .\"instead of the default: $XDG_CONFIG_HOME/bollux/bollux.conf. |
| 34 | .TP | 35 | .TP |
| 35 | .B URL | 36 | .B URL |
| 36 | The gemini URL to navigate to | 37 | The gemini URL to navigate to |
| @@ -67,10 +68,21 @@ quit bollux | |||
| 67 | If a new URL is selected, | 68 | If a new URL is selected, |
| 68 | .BR bollux (1) | 69 | .BR bollux (1) |
| 69 | will repeat the download-and-display loop with the new URL. | 70 | will repeat the download-and-display loop with the new URL. |
| 70 | .SH ISSUES | 71 | .PP |
| 71 | There is currently no history storage or recall. | 72 | If the mimetype is other than text/*, |
| 72 | .BR bollux (1) | 73 | .BR bollux (1) |
| 73 | can get confused on some URLs \-\- munging them correctly is an area of active research. | 74 | will attempt to download the file to |
| 75 | .B $BOLLUX_DOWNDIR | ||
| 76 | (which defaults to '.'). | ||
| 77 | .PP | ||
| 78 | .BR bollux (1) | ||
| 79 | also supports the gopher protocol, | ||
| 80 | which is browsed the same way as the gemini protocol | ||
| 81 | (except the URL starts with 'gopher://'). | ||
| 82 | Gopher support is as of now rudimentary. | ||
| 83 | .SH ISSUES | ||
| 84 | Certificate handling needs to be much improved: TOFU needs to be implemented | ||
| 85 | and bollux should be able to generate client certificates. | ||
| 74 | .SH SEE ALSO | 86 | .SH SEE ALSO |
| 75 | .BR bollux.conf (5) | 87 | .BR bollux.conf (5) |
| 76 | .SH BUGS | 88 | .SH BUGS |