diff options
| author | Case Duckworth | 2021-02-26 20:42:17 -0600 |
|---|---|---|
| committer | Case Duckworth | 2021-02-26 20:42:17 -0600 |
| commit | f77b42f7cfa749b9146ed590db8cbb6ee9f5e136 (patch) | |
| tree | f48f6ba3830b1ffbba4889b1bf627214c8555964 /bollux.1 | |
| parent | Add BOLLUX_PRE_DISPLAY and functionality (fix #1) (diff) | |
| download | bollux-f77b42f7cfa749b9146ed590db8cbb6ee9f5e136.tar.gz bollux-f77b42f7cfa749b9146ed590db8cbb6ee9f5e136.zip | |
Unix file endings
Diffstat (limited to 'bollux.1')
| -rw-r--r-- | bollux.1 | 186 |
1 files changed, 93 insertions, 93 deletions
| diff --git a/bollux.1 b/bollux.1 index dc397be..ce32e8d 100644 --- a/bollux.1 +++ b/bollux.1 | |||
| @@ -1,93 +1,93 @@ | |||
| 1 | .TH bollux 1 0.4.0 | 1 | .TH bollux 1 0.4.0 |
| 2 | .SH NAME | 2 | .SH NAME |
| 3 | bollux \- gemini protocol browser written in | 3 | bollux \- gemini protocol browser written in |
| 4 | .BR bash (1) | 4 | .BR bash (1) |
| 5 | .SH SYNOPSIS | 5 | .SH SYNOPSIS |
| 6 | .B bollux | 6 | .B bollux |
| 7 | .RI [ \-h ] | 7 | .RI [ \-h ] |
| 8 | .TP | 8 | .TP |
| 9 | .B bollux | 9 | .B bollux |
| 10 | .RI [ \-q ] | 10 | .RI [ \-q ] |
| 11 | .RI [ \-v ] | 11 | .RI [ \-v ] |
| 12 | .\".RI [ \-c | 12 | .\".RI [ \-c |
| 13 | .\".BR CONFIG ] | 13 | .\".BR CONFIG ] |
| 14 | .RB [ URL ] | 14 | .RB [ URL ] |
| 15 | .SH DESCRIPTION | 15 | .SH DESCRIPTION |
| 16 | .BR bollux (1) | 16 | .BR bollux (1) |
| 17 | is a browser for the new Gemini protocol, which aims to be | 17 | is a browser for the new Gemini protocol, which aims to be |
| 18 | "heavier than gopher, but lighter than the web." | 18 | "heavier than gopher, but lighter than the web." |
| 19 | It can follow links, collect user input, download files, and display text/* mimetype pages in geminispace. | 19 | It can follow links, collect user input, download files, and display text/* mimetype pages in geminispace. |
| 20 | .SH OPTIONS | 20 | .SH OPTIONS |
| 21 | .TP | 21 | .TP |
| 22 | .B \-h | 22 | .B \-h |
| 23 | Display an inline help screen and exit | 23 | Display an inline help screen and exit |
| 24 | .TP | 24 | .TP |
| 25 | .B \-q | 25 | .B \-q |
| 26 | Be quiet: don't show any messages, even fatal ones | 26 | Be quiet: don't show any messages, even fatal ones |
| 27 | .TP | 27 | .TP |
| 28 | .B \-v | 28 | .B \-v |
| 29 | Be verbose: show all messages, even debug ones | 29 | Be verbose: show all messages, even debug ones |
| 30 | .\".TP | 30 | .\".TP |
| 31 | .\".B \-c CONFIG | 31 | .\".B \-c CONFIG |
| 32 | .\"Use CONFIG file to configure | 32 | .\"Use CONFIG file to configure |
| 33 | .\".BR bollux (1) | 33 | .\".BR bollux (1) |
| 34 | .\"instead of the default: $XDG_CONFIG_HOME/bollux/bollux.conf. | 34 | .\"instead of the default: $XDG_CONFIG_HOME/bollux/bollux.conf. |
| 35 | .TP | 35 | .TP |
| 36 | .B URL | 36 | .B URL |
| 37 | The gemini URL to navigate to | 37 | The gemini URL to navigate to |
| 38 | .SH USAGE | 38 | .SH USAGE |
| 39 | If | 39 | If |
| 40 | .BR bollux (1) | 40 | .BR bollux (1) |
| 41 | is invoked with a URL, it will download or display that URL. | 41 | is invoked with a URL, it will download or display that URL. |
| 42 | Otherwise, the user will be prompted for a URL to download or display. | 42 | Otherwise, the user will be prompted for a URL to download or display. |
| 43 | If the URL points to a text/* document, it is paged with | 43 | If the URL points to a text/* document, it is paged with |
| 44 | .BR less (1) | 44 | .BR less (1) |
| 45 | with custom keybinds: | 45 | with custom keybinds: |
| 46 | .TP | 46 | .TP |
| 47 | .B o | 47 | .B o |
| 48 | open a link on the current page | 48 | open a link on the current page |
| 49 | .TP | 49 | .TP |
| 50 | .B g | 50 | .B g |
| 51 | goto a new URL | 51 | goto a new URL |
| 52 | .TP | 52 | .TP |
| 53 | .B G | 53 | .B G |
| 54 | goto a new URL - with current URL pre-filled | 54 | goto a new URL - with current URL pre-filled |
| 55 | .TP | 55 | .TP |
| 56 | .B r | 56 | .B r |
| 57 | refresh the current page | 57 | refresh the current page |
| 58 | .TP | 58 | .TP |
| 59 | .B [ | 59 | .B [ |
| 60 | goto the previous page in history | 60 | goto the previous page in history |
| 61 | .TP | 61 | .TP |
| 62 | .B ] | 62 | .B ] |
| 63 | goto the next page in history | 63 | goto the next page in history |
| 64 | .TP | 64 | .TP |
| 65 | .B q | 65 | .B q |
| 66 | quit bollux | 66 | quit bollux |
| 67 | .TP | 67 | .TP |
| 68 | .B \= | 68 | .B \= |
| 69 | show a short help message | 69 | show a short help message |
| 70 | .PP | 70 | .PP |
| 71 | If a new URL is selected, | 71 | If a new URL is selected, |
| 72 | .BR bollux (1) | 72 | .BR bollux (1) |
| 73 | will repeat the download-and-display loop with the new URL. | 73 | will repeat the download-and-display loop with the new URL. |
| 74 | .PP | 74 | .PP |
| 75 | If the mimetype is other than text/*, | 75 | If the mimetype is other than text/*, |
| 76 | .BR bollux (1) | 76 | .BR bollux (1) |
| 77 | will attempt to download the file to | 77 | will attempt to download the file to |
| 78 | .B $BOLLUX_DOWNDIR | 78 | .B $BOLLUX_DOWNDIR |
| 79 | (which defaults to '.'). | 79 | (which defaults to '.'). |
| 80 | .PP | 80 | .PP |
| 81 | .BR bollux (1) | 81 | .BR bollux (1) |
| 82 | also supports the gopher protocol, | 82 | also supports the gopher protocol, |
| 83 | which is browsed the same way as the gemini protocol | 83 | which is browsed the same way as the gemini protocol |
| 84 | (except the URL starts with 'gopher://'). | 84 | (except the URL starts with 'gopher://'). |
| 85 | Gopher support is as of now rudimentary. | 85 | Gopher support is as of now rudimentary. |
| 86 | .SH ISSUES | 86 | .SH ISSUES |
| 87 | Certificate handling needs to be much improved: TOFU needs to be implemented | 87 | Certificate handling needs to be much improved: TOFU needs to be implemented |
| 88 | and bollux should be able to generate client certificates. | 88 | and bollux should be able to generate client certificates. |
| 89 | .SH SEE ALSO | 89 | .SH SEE ALSO |
| 90 | .BR bollux.conf (5) | 90 | .BR bollux.conf (5) |
| 91 | .SH BUGS | 91 | .SH BUGS |
| 92 | The development repo is located at https://sr.ht/~acdw/bollux. | 92 | The development repo is located at https://sr.ht/~acdw/bollux. |
| 93 | Please direct all bug reports, patches, or general complaints there. | 93 | Please direct all bug reports, patches, or general complaints there. |