From d6199aebdf5f05f132d0569837061835a88ed960 Mon Sep 17 00:00:00 2001 From: concussious <79338398+concussious@users.noreply.github.com> Date: Sat, 16 Apr 2022 19:01:18 -0400 Subject: [PATCH 1/9] Initial skeleton manpage --- amfora.1 | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 amfora.1 diff --git a/amfora.1 b/amfora.1 new file mode 100644 index 0000000..6a41654 --- /dev/null +++ b/amfora.1 @@ -0,0 +1,32 @@ +.Dd $Mdocdate$ +.Dt AMFORA 1 +.Os +.Sh NAME +.Nm amfora +.Nd fancy terminal gemini browser +.Sh SYNOPSIS +.Nm amfora +.Ar url +.Sh DESCRIPTION +The +.Nm +is a gemini client in your terminal. +The documentation is maintained at +.Lk https://github.com/makeworld-the-better-one/amfora/wiki +.Sh KEY BINDINGS +.It ? +Open help menu +.It q +Exit amfora +.\" .Sh EXAMPLES +.\" .Sh ERRORS +.\" .Sh ENVIRONMENT +.Sh STANDARDS +.Lk https://gemini.circumlunar.space/docs/specification.gmi +.Sh HISTORY +.Nm +development started in June, 2020. +.\" .Sh AUTHORS +.\" .Sh CAVEATS +.\" .Sh BUGS +.\" .Sh SECURITY CONSIDERATIONS From 8f9b86b892a81cb6e8ad01d7ac822c21e19d16ef Mon Sep 17 00:00:00 2001 From: concussious <79338398+concussious@users.noreply.github.com> Date: Mon, 18 Apr 2022 15:45:42 -0400 Subject: [PATCH 2/9] url is an optional argument --- amfora.1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/amfora.1 b/amfora.1 index 6a41654..2947273 100644 --- a/amfora.1 +++ b/amfora.1 @@ -6,7 +6,7 @@ .Nd fancy terminal gemini browser .Sh SYNOPSIS .Nm amfora -.Ar url +.Op Ar url .Sh DESCRIPTION The .Nm From 787c81d0e4822275baeb3f58a8af4dc1a7190b90 Mon Sep 17 00:00:00 2001 From: concussious <79338398+concussious@users.noreply.github.com> Date: Sun, 24 Apr 2022 16:47:13 -0400 Subject: [PATCH 3/9] WIP rewrite --- amfora.1 | 101 +++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 91 insertions(+), 10 deletions(-) diff --git a/amfora.1 b/amfora.1 index 2947273..563f5b6 100644 --- a/amfora.1 +++ b/amfora.1 @@ -8,24 +8,105 @@ .Nm amfora .Op Ar url .Sh DESCRIPTION -The .Nm -is a gemini client in your terminal. -The documentation is maintained at -.Lk https://github.com/makeworld-the-better-one/amfora/wiki -.Sh KEY BINDINGS -.It ? +is a fancy gemini client in your terminal. +.Nm +also supports subscription through gemini, atom, RSS, and JSON Feed files. +caches documents (aka "pages") it loads, to reduce latency: if you're navigating through history, or simply just returning to the same page again. +.Ss BOOKMARKS +.Nm +stores it's bookmarks in an XML format called XBEL, located at ~/.local/share/amfora/bookmarks.xml by default. +If the $XDG_DATA_HOME variable is set then the configuration file can be found at $XDG_DATA_HOME/amfora/bookmarks.xml. +.Pp +On Windows, the file can be found at %APPDATA%\amfora\bookmarks.xml, which usually expands to C:\Users\\AppData\Roaming\amfora\bookmarks.xml. +.Ss CONFIGURATION +.Nm +configuration file is located at ~/.config/amfora/config.toml by default. +If the $XDG_CONFIG_HOME variable is set then the configuration file can be found at $XDG_CONFIG_HOME/amfora/config.toml. +.Pp +On Windows, the configuration file can be found at %APPDATA%\amfora\config.toml, which usually expands to C:\Users\\AppData\Roaming\amfora\config.toml. +.Pp +The default config file can be viewed at default-config.toml. +.Nm +will place that file in the config file location if it doesn't exist. +.Sh DEFAULT KEY BINDINGS +You can view the keybindings in the help menu, which can be brought up using ? and exited with Esc. +The keybindings in the help will update if you change your keybindings in the config. +.Pp +.Bl -column "Brq, Bro, Brc" description +.It Ic \&? Open help menu -.It q -Exit amfora -.\" .Sh EXAMPLES +.It Ic Space +Open bottom bar +.It Ic Esc +Close menu/bar +.It Ic q +Exit +.Nm +.It Ic 0-9 +Access link 1-10 on page +.It Ic Tab or Enter +Begin link highlighting +.It Ic Shift-Tab +Highlight previous link +.It Ic Tab +Highlight next link +.It Ic Ctrl-T +Open highlighted link in new tab +.It Ic Ctrl-X +Subscribe to current page +.It Ic Ctrl-A +Visit subscription feed +.El +.Sh BOTTOM BAR COMMANDS +.Bl -tag -width Ds -compact +.It Cm new:N +Visit link N +.It Cm about:version +.Nm +version info +.It Cm about:subscriptions +Visit subscription feed +.It Cm about:manage-subscriptions +Visit unsubscribe list +.El +.Sh EXAMPLES +.Ss Bookmarks +.Pp + + + + + Example Bookmark + + +.Pp .\" .Sh ERRORS .\" .Sh ENVIRONMENT +.Sh FILES +.Bl -tag -width Ds -compact +.It Pa ~/.config/amfora/config.toml +.It Pa ~/.local/share/amfora/bookmarks.xml +.It Pa $XDG_CONFIG_HOME/amfora/config.toml +.It Pa $XDG_DATA_HOME/amfora/bookmarks.xml +.El .Sh STANDARDS -.Lk https://gemini.circumlunar.space/docs/specification.gmi +.Bl -tag -width Ds -compact +.It Lk https://gemini.circumlunar.space/docs/specification.gmi +Gemini Protocol +.It Lk https://toml.io/en/ +Configuration syntax +.It Lk http://pyxml.sourceforge.net/topics/xbel/docs/html/xbel.html +Bookmark syntax +.El .Sh HISTORY .Nm development started in June, 2020. +.Sh SEE ALSO +.Lk https://github.com/makeworld-the-better-one/amfora/wiki +.Xr bombadillo .\" .Sh AUTHORS .\" .Sh CAVEATS .\" .Sh BUGS From 9327c119d2f3dd029f56f9bbcc5d7c21943e3324 Mon Sep 17 00:00:00 2001 From: concussious <79338398+concussious@users.noreply.github.com> Date: Sun, 24 Apr 2022 19:52:51 -0400 Subject: [PATCH 4/9] WIP - continue wiki assimilation --- amfora.1 | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 68 insertions(+), 6 deletions(-) diff --git a/amfora.1 b/amfora.1 index 563f5b6..7a2a00f 100644 --- a/amfora.1 +++ b/amfora.1 @@ -11,14 +11,35 @@ .Nm is a fancy gemini client in your terminal. .Nm -also supports subscription through gemini, atom, RSS, and JSON Feed files. +is written in Go and supports tabs, caching, theming, proxying, subscriptions, client certificates, external link handling, and a built in search engine. +Subscriptions are supported through gemini, atom, RSS, and JSON Feed files. +.Nm caches documents (aka "pages") it loads, to reduce latency: if you're navigating through history, or simply just returning to the same page again. +.Nm +supports proxies so that certain types of URLs will not require opening another application. +.Pp +.Nm +allows you to set the command to be run when following links that are non-Gemini URLs. +For example, you may want mailto: links to be opened with your email client, or magnet: links to be opened with your torrent software. +These settings are overriden by the settings in the [proxies] section. +.Pp +By default, when clicking a non-text file, Amfora will present you with options to either Open or Download the file. +If you choose Open, Amfora will download the file to a temporary folder, and then open it using your OS's default application for that file type. +You can configure what applications Amfora uses if you want to override this behaviour. You can also configure whether streaming is used. +.Pp +By default +.Nm +will automatically attempt to highlight blocks of preformatted source code. +This is accomplished by searching for a string at the start of the alt text; if the string corresponds to a supported language name or MIME type, then the syntax will be highlighted if possible. +.Nm .Ss BOOKMARKS .Nm stores it's bookmarks in an XML format called XBEL, located at ~/.local/share/amfora/bookmarks.xml by default. If the $XDG_DATA_HOME variable is set then the configuration file can be found at $XDG_DATA_HOME/amfora/bookmarks.xml. .Pp On Windows, the file can be found at %APPDATA%\amfora\bookmarks.xml, which usually expands to C:\Users\\AppData\Roaming\amfora\bookmarks.xml. +.Pp +.Sx EXAMPLE BOOKMARK .Ss CONFIGURATION .Nm configuration file is located at ~/.config/amfora/config.toml by default. @@ -33,7 +54,7 @@ will place that file in the config file location if it doesn't exist. You can view the keybindings in the help menu, which can be brought up using ? and exited with Esc. The keybindings in the help will update if you change your keybindings in the config. .Pp -.Bl -column "Brq, Bro, Brc" description +.Bl -column .It Ic \&? Open help menu .It Ic Space @@ -60,7 +81,7 @@ Visit subscription feed .El .Sh BOTTOM BAR COMMANDS .Bl -tag -width Ds -compact -.It Cm new:N +.It Cm new: Va N Visit link N .It Cm about:version .Nm @@ -71,7 +92,7 @@ Visit subscription feed Visit unsubscribe list .El .Sh EXAMPLES -.Ss Bookmarks +.Ss Example Bookmark .Pp Example Bookmark -.Pp +.Ss Example Proxy +[proxies] +# Allows setting a Gemini proxy for different schemes. +# The settings are similar to the url-handlers section above. +# E.g. to open a gopher page by connecting to a Gemini proxy server: +# gopher = "example.com:123" +# +# Port 1965 is assumed if no port is specified. +# +# NOTE: These settings override any external handlers specified in +# the url-handlers section. +# +# Note that HTTP and HTTPS are treated as separate protocols here +.Ss Example Certificate +[auth] +# Authentication settings + +[auth.certs] +# Client certificates +# Set domain name equal to path to client cert +# "example.com" = "mycert.crt" +"astrobotany.mozz.us" = "~/.local/share/amfora/astrobotany-cert.pem" + +[auth.keys] +# Client certificate keys +# Set domain name equal to path to key for the client cert above +# "example.com" = "mycert.key" +"astrobotany.mozz.us" = "~/.local/share/amfora/astrobotany-key.pem" .\" .Sh ERRORS .\" .Sh ENVIRONMENT .Sh FILES +.Ss *NIX .Bl -tag -width Ds -compact .It Pa ~/.config/amfora/config.toml .It Pa ~/.local/share/amfora/bookmarks.xml +.El +.Ss XDG +.Bl -tag -width Ds -compact .It Pa $XDG_CONFIG_HOME/amfora/config.toml .It Pa $XDG_DATA_HOME/amfora/bookmarks.xml .El +.Ss WINDOWS +.Bl -tag -width Ds -compact +.It Pa %APPDATA%\eamfora\econfig.toml +.It Pa %APPDATA%\eamfora\ebookmarks.xml +.El .Sh STANDARDS .Bl -tag -width Ds -compact .It Lk https://gemini.circumlunar.space/docs/specification.gmi @@ -100,6 +157,8 @@ Gemini Protocol Configuration syntax .It Lk http://pyxml.sourceforge.net/topics/xbel/docs/html/xbel.html Bookmark syntax +.It Lk https://www.iana.org/assignments/media-types/media-types.xhtml +Media Types .El .Sh HISTORY .Nm @@ -108,6 +167,9 @@ development started in June, 2020. .Lk https://github.com/makeworld-the-better-one/amfora/wiki .Xr bombadillo .\" .Sh AUTHORS -.\" .Sh CAVEATS +.Sh CAVEATS +Using OpenSSL on Windows is not so easy. +One way is to install Chocolatey, and run +.Qq choco install openssl .\" .Sh BUGS .\" .Sh SECURITY CONSIDERATIONS From 206304df2bd2c37fcb617ffff008998dde806100 Mon Sep 17 00:00:00 2001 From: concussious <79338398+concussious@users.noreply.github.com> Date: Mon, 25 Apr 2022 00:28:27 -0400 Subject: [PATCH 5/9] WIP Continue assimilating wiki, readability --- amfora.1 | 100 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 75 insertions(+), 25 deletions(-) diff --git a/amfora.1 b/amfora.1 index 7a2a00f..6021e5c 100644 --- a/amfora.1 +++ b/amfora.1 @@ -14,45 +14,83 @@ is a fancy gemini client in your terminal. is written in Go and supports tabs, caching, theming, proxying, subscriptions, client certificates, external link handling, and a built in search engine. Subscriptions are supported through gemini, atom, RSS, and JSON Feed files. .Nm -caches documents (aka "pages") it loads, to reduce latency: if you're navigating through history, or simply just returning to the same page again. +caches documents +.Pq aka Qq pages +it loads, to reduce latency: if you +.Ap +re navigating through history, or simply just returning to the same page again. .Nm supports proxies so that certain types of URLs will not require opening another application. .Pp +The .Nm -allows you to set the command to be run when following links that are non-Gemini URLs. +config allows you to set the command to be run when following links that are non-Gemini URLs. For example, you may want mailto: links to be opened with your email client, or magnet: links to be opened with your torrent software. -These settings are overriden by the settings in the [proxies] section. +In +.Nm +you can specify proxies so that certain types of URLs will not require opening another application. +In the config, +.Bq proxies +take precedence over +.Bo url-handlers Bc . .Pp -By default, when clicking a non-text file, Amfora will present you with options to either Open or Download the file. -If you choose Open, Amfora will download the file to a temporary folder, and then open it using your OS's default application for that file type. -You can configure what applications Amfora uses if you want to override this behaviour. You can also configure whether streaming is used. +By default, when clicking a non-text file, +.Nm +will present you with options to either Open or Download the file. +If you choose Open, +.Nm +will download the file to a temporary folder, and then open it using your OS +.Ap +s default application for that file type. +You can configure what applications +.Nm +uses if you want to override this behaviour. +You can also configure whether streaming is used. .Pp By default .Nm will automatically attempt to highlight blocks of preformatted source code. This is accomplished by searching for a string at the start of the alt text; if the string corresponds to a supported language name or MIME type, then the syntax will be highlighted if possible. -.Nm .Ss BOOKMARKS .Nm -stores it's bookmarks in an XML format called XBEL, located at ~/.local/share/amfora/bookmarks.xml by default. -If the $XDG_DATA_HOME variable is set then the configuration file can be found at $XDG_DATA_HOME/amfora/bookmarks.xml. +stores it's bookmarks in an XML format called XBEL, located at +.Pa ~/.local/share/amfora/bookmarks.xml +by default. +If the +.Va XDG_DATA_HOME +variable is set then the configuration file can be found at +.Pa XDG_DATA_HOME/amfora/bookmarks.xml . .Pp -On Windows, the file can be found at %APPDATA%\amfora\bookmarks.xml, which usually expands to C:\Users\\AppData\Roaming\amfora\bookmarks.xml. +On Windows, the file can be found at +.Pa %APPDATA%\eamfora\ebookmarks.xml , +which usually expands to +.Pa C:\eUsers\e\eAppData\eRoaming\eamfora\ebookmarks.xml . .Pp +See .Sx EXAMPLE BOOKMARK .Ss CONFIGURATION +A default configuration file is generated on first use if it doesn +.Ap +t already exist. .Nm -configuration file is located at ~/.config/amfora/config.toml by default. -If the $XDG_CONFIG_HOME variable is set then the configuration file can be found at $XDG_CONFIG_HOME/amfora/config.toml. +configuration is located from +.Pa ~/.config/amfora/config.toml +by default. +If the +.Va $XDG_CONFIG_HOME +variable is set then the configuration file can be found at +.Pa $XDG_CONFIG_HOME/amfora/config.toml . .Pp -On Windows, the configuration file can be found at %APPDATA%\amfora\config.toml, which usually expands to C:\Users\\AppData\Roaming\amfora\config.toml. -.Pp -The default config file can be viewed at default-config.toml. -.Nm -will place that file in the config file location if it doesn't exist. +On Windows, the configuration file can be found at +.Pa %APPDATA%\eamfora\econfig.toml , +which usually expands to +.Pa C:\eUsers\e\eAppData\eRoaming\eamfora\econfig.toml . .Sh DEFAULT KEY BINDINGS -You can view the keybindings in the help menu, which can be brought up using ? and exited with Esc. -The keybindings in the help will update if you change your keybindings in the config. +You can view the keybindings in the help menu, which can be brought up using +.Ic \&? +and exited with +.Ic Esc . +The keybindings in the help menu will update if you change your keybindings in the config. .Pp .Bl -column .It Ic \&? @@ -92,7 +130,7 @@ Visit subscription feed Visit unsubscribe list .El .Sh EXAMPLES -.Ss Example Bookmark +.Ss EXAMPLE BOOKMARK .Pp Example Bookmark -.Ss Example Proxy +.Ss EXAMPLE PROXY [proxies] # Allows setting a Gemini proxy for different schemes. # The settings are similar to the url-handlers section above. @@ -116,7 +154,7 @@ Visit unsubscribe list # the url-handlers section. # # Note that HTTP and HTTPS are treated as separate protocols here -.Ss Example Certificate +.Ss EXAMPLE CERTIFICATE [auth] # Authentication settings @@ -164,12 +202,24 @@ Media Types .Nm development started in June, 2020. .Sh SEE ALSO -.Lk https://github.com/makeworld-the-better-one/amfora/wiki -.Xr bombadillo -.\" .Sh AUTHORS +The official documentation is maintained in two places: +.Bl -tag -width Ds -compact +.It Lk gemini://makeworld.space/amfora-wiki/ +.It Lk https://github.com/makeworld-the-better-one/amfora/wiki +.El +.Sh AUTHORS +The principle author of the +.Nm +project is +.An makeworld Aq Mt makeworld@protonmail.com . .Sh CAVEATS Using OpenSSL on Windows is not so easy. One way is to install Chocolatey, and run .Qq choco install openssl +.Pp +.Nm +does not support gopher or other non-web protocols - check out +.Lk https://bombadillo.colorfield.space/ "bombadillo" +for that. .\" .Sh BUGS .\" .Sh SECURITY CONSIDERATIONS From 0cca4b8d7c5662bfcca0e4c2008ac59f2b008eb8 Mon Sep 17 00:00:00 2001 From: concussious <79338398+concussious@users.noreply.github.com> Date: Mon, 25 Apr 2022 19:58:44 -0400 Subject: [PATCH 6/9] WIP continue filling and restructure to convention --- amfora.1 | 122 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 77 insertions(+), 45 deletions(-) diff --git a/amfora.1 b/amfora.1 index 6021e5c..07da9cb 100644 --- a/amfora.1 +++ b/amfora.1 @@ -51,23 +51,6 @@ By default .Nm will automatically attempt to highlight blocks of preformatted source code. This is accomplished by searching for a string at the start of the alt text; if the string corresponds to a supported language name or MIME type, then the syntax will be highlighted if possible. -.Ss BOOKMARKS -.Nm -stores it's bookmarks in an XML format called XBEL, located at -.Pa ~/.local/share/amfora/bookmarks.xml -by default. -If the -.Va XDG_DATA_HOME -variable is set then the configuration file can be found at -.Pa XDG_DATA_HOME/amfora/bookmarks.xml . -.Pp -On Windows, the file can be found at -.Pa %APPDATA%\eamfora\ebookmarks.xml , -which usually expands to -.Pa C:\eUsers\e\eAppData\eRoaming\eamfora\ebookmarks.xml . -.Pp -See -.Sx EXAMPLE BOOKMARK .Ss CONFIGURATION A default configuration file is generated on first use if it doesn .Ap @@ -85,14 +68,18 @@ On Windows, the configuration file can be found at .Pa %APPDATA%\eamfora\econfig.toml , which usually expands to .Pa C:\eUsers\e\eAppData\eRoaming\eamfora\econfig.toml . -.Sh DEFAULT KEY BINDINGS +.Pp +In this directory you can also create a gemtext file called +.Pa newtab.gmi +to customize your new tab page. +.Ss DEFAULT KEY BINDINGS You can view the keybindings in the help menu, which can be brought up using .Ic \&? and exited with .Ic Esc . The keybindings in the help menu will update if you change your keybindings in the config. .Pp -.Bl -column +.Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -compact .It Ic \&? Open help menu .It Ic Space @@ -104,7 +91,11 @@ Exit .Nm .It Ic 0-9 Access link 1-10 on page -.It Ic Tab or Enter +.It Ic F1 +Previous tab +.It Ic F2 +Next tab +.It Ic Tab or Ic Enter Begin link highlighting .It Ic Shift-Tab Highlight previous link @@ -116,11 +107,16 @@ Open highlighted link in new tab Subscribe to current page .It Ic Ctrl-A Visit subscription feed +.It Ic Ctrl-S +Save loaded page to disk +.It Ic Ctrl-C +Hard quit .El -.Sh BOTTOM BAR COMMANDS -.Bl -tag -width Ds -compact +.Ss BOTTOM BAR COMMANDS +.Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -compact .It Cm new: Va N -Visit link N +Visit link +.Va N .It Cm about:version .Nm version info @@ -128,7 +124,44 @@ version info Visit subscription feed .It Cm about:manage-subscriptions Visit unsubscribe list +.It Va foo +Search the geminispace for +.Va foo . .El +.Ss BOOKMARKS +.Nm +stores it's bookmarks in an XML format called XBEL, located at +.Pa ~/.local/share/amfora/bookmarks.xml +by default. +If the +.Va XDG_DATA_HOME +variable is set then the configuration file can be found at +.Pa XDG_DATA_HOME/amfora/bookmarks.xml . +.Pp +On Windows, the file can be found at +.Pa %APPDATA%\eamfora\ebookmarks.xml , +which usually expands to +.Pa C:\eUsers\e\eAppData\eRoaming\eamfora\ebookmarks.xml . +.Pp +See +.Sx EXAMPLE BOOKMARK +.Sh FILES +.Ss *NIX +.Bl -tag -width Ds -compact +.It Pa ~/.config/amfora/config.toml +.It Pa ~/.local/share/amfora/bookmarks.xml +.El +.Ss XDG +.Bl -tag -width Ds -compact +.It Pa $XDG_CONFIG_HOME/amfora/config.toml +.It Pa $XDG_DATA_HOME/amfora/bookmarks.xml +.El +.Ss WINDOWS +.Bl -tag -width Ds -compact +.It Pa %APPDATA%\eamfora\econfig.toml +.It Pa %APPDATA%\eamfora\ebookmarks.xml +.El +.\" .Sh EXIT STATUS .Sh EXAMPLES .Ss EXAMPLE BOOKMARK .Pp @@ -169,23 +202,17 @@ Visit unsubscribe list # Set domain name equal to path to key for the client cert above # "example.com" = "mycert.key" "astrobotany.mozz.us" = "~/.local/share/amfora/astrobotany-key.pem" -.\" .Sh ERRORS -.\" .Sh ENVIRONMENT -.Sh FILES -.Ss *NIX +.\" .Sh DIAGNOSTICS +.Sh SEE ALSO +The official documentation is maintained in two places: .Bl -tag -width Ds -compact -.It Pa ~/.config/amfora/config.toml -.It Pa ~/.local/share/amfora/bookmarks.xml +.It Lk gemini://makeworld.space/amfora-wiki/ +.It Lk https://github.com/makeworld-the-better-one/amfora/wiki .El -.Ss XDG +.Pp .Bl -tag -width Ds -compact -.It Pa $XDG_CONFIG_HOME/amfora/config.toml -.It Pa $XDG_DATA_HOME/amfora/bookmarks.xml -.El -.Ss WINDOWS -.Bl -tag -width Ds -compact -.It Pa %APPDATA%\eamfora\econfig.toml -.It Pa %APPDATA%\eamfora\ebookmarks.xml +.It agena.py gemini-to-gopher proxy. +.It duckling-proxy.go gemini-to-HTTPS proxy. .El .Sh STANDARDS .Bl -tag -width Ds -compact @@ -200,18 +227,22 @@ Media Types .El .Sh HISTORY .Nm -development started in June, 2020. -.Sh SEE ALSO -The official documentation is maintained in two places: -.Bl -tag -width Ds -compact -.It Lk gemini://makeworld.space/amfora-wiki/ -.It Lk https://github.com/makeworld-the-better-one/amfora/wiki -.El +v1.0 was released on GitHub June 1, 2020 with tabs, TOFU, colors, history and input. +Bookmarks, charsets, and search were added in v1.1 on Jun 24. +Downloading was implemented in v1.3 on Jul 2. Themeing came in v1.4 on Jul 28. +Emojies and extended proxy support came in v1.5 on Sep 01. +Client certificates were implemented in v1.6 on Nov 4. +Subscriptions were implemented in v1.7 on Dec 20, and a GitHub wiki was also started. +v1.8 added media type handlers on Feb 17, 2021. +v1.9 began storing bookmarks in XBEL on Dec 7. .Sh AUTHORS The principle author of the .Nm project is .An makeworld Aq Mt makeworld@protonmail.com . +By v1.9.2, 47 people had committed to the amfora repository, see +.Pa THANKS.md +in the source for more information. .Sh CAVEATS Using OpenSSL on Windows is not so easy. One way is to install Chocolatey, and run @@ -221,5 +252,6 @@ One way is to install Chocolatey, and run does not support gopher or other non-web protocols - check out .Lk https://bombadillo.colorfield.space/ "bombadillo" for that. -.\" .Sh BUGS +. Sh BUGS +There are sometimes known UI rendering glitches. .\" .Sh SECURITY CONSIDERATIONS From 49fab1c7c7167eb7c44eca8b4b18b79858dd176f Mon Sep 17 00:00:00 2001 From: concussious <79338398+concussious@users.noreply.github.com> Date: Sat, 30 Apr 2022 20:07:35 -0400 Subject: [PATCH 7/9] Fix Remaining Errors/Clarify --- amfora.1 | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/amfora.1 b/amfora.1 index 07da9cb..edb4f47 100644 --- a/amfora.1 +++ b/amfora.1 @@ -6,7 +6,7 @@ .Nd fancy terminal gemini browser .Sh SYNOPSIS .Nm amfora -.Op Ar url +.Op Ar gemini-url .Sh DESCRIPTION .Nm is a fancy gemini client in your terminal. @@ -16,9 +16,7 @@ Subscriptions are supported through gemini, atom, RSS, and JSON Feed files. .Nm caches documents .Pq aka Qq pages -it loads, to reduce latency: if you -.Ap -re navigating through history, or simply just returning to the same page again. +it loads, to reduce latency: if you're navigating through history, or simply just returning to the same page again. .Nm supports proxies so that certain types of URLs will not require opening another application. .Pp @@ -39,9 +37,7 @@ By default, when clicking a non-text file, will present you with options to either Open or Download the file. If you choose Open, .Nm -will download the file to a temporary folder, and then open it using your OS -.Ap -s default application for that file type. +will download the file to a temporary folder, and then open it using your OS's default application for that file type. You can configure what applications .Nm uses if you want to override this behaviour. @@ -50,11 +46,9 @@ You can also configure whether streaming is used. By default .Nm will automatically attempt to highlight blocks of preformatted source code. -This is accomplished by searching for a string at the start of the alt text; if the string corresponds to a supported language name or MIME type, then the syntax will be highlighted if possible. +This is accomplished by searching for a string at the start of the alt text; if the string corresponds to a language name or MIME type supported by chroma.go, then the syntax will be highlighted if possible. .Ss CONFIGURATION -A default configuration file is generated on first use if it doesn -.Ap -t already exist. +A default configuration file is generated on first use if it doesn't already exist. .Nm configuration is located from .Pa ~/.config/amfora/config.toml @@ -114,7 +108,7 @@ Hard quit .El .Ss BOTTOM BAR COMMANDS .Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -compact -.It Cm new: Va N +.It Cm new: Ns Va N Visit link .Va N .It Cm about:version @@ -164,7 +158,7 @@ See .\" .Sh EXIT STATUS .Sh EXAMPLES .Ss EXAMPLE BOOKMARK -.Pp +.Bd -literal Example Bookmark +.Ed .Ss EXAMPLE PROXY +.Bd -literal [proxies] # Allows setting a Gemini proxy for different schemes. # The settings are similar to the url-handlers section above. @@ -187,7 +183,9 @@ See # the url-handlers section. # # Note that HTTP and HTTPS are treated as separate protocols here +.Ed .Ss EXAMPLE CERTIFICATE +.Bd -literal [auth] # Authentication settings @@ -202,6 +200,7 @@ See # Set domain name equal to path to key for the client cert above # "example.com" = "mycert.key" "astrobotany.mozz.us" = "~/.local/share/amfora/astrobotany-key.pem" +.Ed .\" .Sh DIAGNOSTICS .Sh SEE ALSO The official documentation is maintained in two places: @@ -252,6 +251,6 @@ One way is to install Chocolatey, and run does not support gopher or other non-web protocols - check out .Lk https://bombadillo.colorfield.space/ "bombadillo" for that. -. Sh BUGS +.Sh BUGS There are sometimes known UI rendering glitches. .\" .Sh SECURITY CONSIDERATIONS From 4fb89a641741e69a5db35c085b170cbb22ef33e0 Mon Sep 17 00:00:00 2001 From: concussious <79338398+concussious@users.noreply.github.com> Date: Mon, 2 May 2022 03:06:02 -0400 Subject: [PATCH 8/9] mention exit(n), stderr; spacing portability --- amfora.1 | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/amfora.1 b/amfora.1 index edb4f47..14a83a3 100644 --- a/amfora.1 +++ b/amfora.1 @@ -73,7 +73,7 @@ and exited with .Ic Esc . The keybindings in the help menu will update if you change your keybindings in the config. .Pp -.Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -compact +.Bl -tag -width 16v -compact .It Ic \&? Open help menu .It Ic Space @@ -107,7 +107,7 @@ Save loaded page to disk Hard quit .El .Ss BOTTOM BAR COMMANDS -.Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXXXXXXX" -compact +.Bl -tag -width 16v -compact .It Cm new: Ns Va N Visit link .Va N @@ -141,21 +141,27 @@ See .Sx EXAMPLE BOOKMARK .Sh FILES .Ss *NIX -.Bl -tag -width Ds -compact +.Bl -tag -width 2v -compact .It Pa ~/.config/amfora/config.toml .It Pa ~/.local/share/amfora/bookmarks.xml .El .Ss XDG -.Bl -tag -width Ds -compact +.Bl -tag -width 2v -compact .It Pa $XDG_CONFIG_HOME/amfora/config.toml .It Pa $XDG_DATA_HOME/amfora/bookmarks.xml .El .Ss WINDOWS -.Bl -tag -width Ds -compact +.Bl -tag -width 2v -compact .It Pa %APPDATA%\eamfora\econfig.toml .It Pa %APPDATA%\eamfora\ebookmarks.xml .El -.\" .Sh EXIT STATUS +.Sh EXIT STATUS +.Nm +exits +.Va 0 +on success, and +.Va 1 +if an error occurs. .Sh EXAMPLES .Ss EXAMPLE BOOKMARK .Bd -literal @@ -201,20 +207,22 @@ See # "example.com" = "mycert.key" "astrobotany.mozz.us" = "~/.local/share/amfora/astrobotany-key.pem" .Ed -.\" .Sh DIAGNOSTICS +.Sh DIAGNOSTICS +Errors are printed to +.Dv stderr . .Sh SEE ALSO The official documentation is maintained in two places: -.Bl -tag -width Ds -compact +.Bl -tag -width 2v -compact .It Lk gemini://makeworld.space/amfora-wiki/ .It Lk https://github.com/makeworld-the-better-one/amfora/wiki .El .Pp -.Bl -tag -width Ds -compact +.Bl -tag -width 2v -compact .It agena.py gemini-to-gopher proxy. .It duckling-proxy.go gemini-to-HTTPS proxy. .El .Sh STANDARDS -.Bl -tag -width Ds -compact +.Bl -tag -width 2v -compact .It Lk https://gemini.circumlunar.space/docs/specification.gmi Gemini Protocol .It Lk https://toml.io/en/ From 16d59973f843fd08e90cb4cfbbbb1a66254485ee Mon Sep 17 00:00:00 2001 From: concussious <79338398+concussious@users.noreply.github.com> Date: Sun, 17 Jul 2022 19:06:47 -0400 Subject: [PATCH 9/9] Fixed errors, thanks @aabacchus! --- amfora.1 | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/amfora.1 b/amfora.1 index 14a83a3..27d15e1 100644 --- a/amfora.1 +++ b/amfora.1 @@ -6,7 +6,7 @@ .Nd fancy terminal gemini browser .Sh SYNOPSIS .Nm amfora -.Op Ar gemini-url +.Op Fl h | Fl v | Ar gemini-url .Sh DESCRIPTION .Nm is a fancy gemini client in your terminal. @@ -124,7 +124,7 @@ Search the geminispace for .El .Ss BOOKMARKS .Nm -stores it's bookmarks in an XML format called XBEL, located at +stores its bookmarks in an XML format called XBEL, located at .Pa ~/.local/share/amfora/bookmarks.xml by default. If the @@ -233,15 +233,17 @@ Bookmark syntax Media Types .El .Sh HISTORY -.Nm -v1.0 was released on GitHub June 1, 2020 with tabs, TOFU, colors, history and input. -Bookmarks, charsets, and search were added in v1.1 on Jun 24. -Downloading was implemented in v1.3 on Jul 2. Themeing came in v1.4 on Jul 28. -Emojies and extended proxy support came in v1.5 on Sep 01. -Client certificates were implemented in v1.6 on Nov 4. -Subscriptions were implemented in v1.7 on Dec 20, and a GitHub wiki was also started. -v1.8 added media type handlers on Feb 17, 2021. -v1.9 began storing bookmarks in XBEL on Dec 7. +.Bl -tag -width 2v -compact +.It v1.0 was released on June 1, 2020 with tabs, TOFU, colors, history and input. +.It Bookmarks, charsets, and search were added in v1.1 on Jun 24. +.It Downloading was implemented in v1.3 on Jul 2. +.It Themeing came in v1.4 on Jul 28. +.It Emojies and extended proxy support came in v1.5 on Sep 01. +.It Client certificates were implemented in v1.6 on Nov 4. +.It Subscriptions and a wiki were implemented in v1.7 on Dec 20. +.It v1.8 added media type handlers on Feb 17, 2021. +.It v1.9 began storing bookmarks in XBEL on Dec 7. +.El .Sh AUTHORS The principle author of the .Nm