diff options
author | B. Watson | 2024-03-10 14:55:57 +0100 |
---|---|---|
committer | Willy Sudiarto Raharjo | 2024-03-11 00:47:05 +0100 |
commit | 13c7df01db950ff5ca0638740b512c1464e6bcc2 (patch) | |
tree | cbeaa1bf95505b724f9c4fd2b460d0c0c814705c /network | |
parent | 7b03d490afb1fcdbfce081b3efab3a4b796de169 (diff) | |
download | slackbuilds-13c7df01db950ff5ca0638740b512c1464e6bcc2.tar.gz |
network/amfora-bin: Added (Gemini browser client).
Signed-off-by: Willy Sudiarto Raharjo <willysr@slackbuilds.org>
Diffstat (limited to 'network')
-rw-r--r-- | network/amfora-bin/README | 21 | ||||
-rw-r--r-- | network/amfora-bin/amfora-bin.SlackBuild | 79 | ||||
-rw-r--r-- | network/amfora-bin/amfora-bin.info | 10 | ||||
-rw-r--r-- | network/amfora-bin/amfora.desktop | 11 | ||||
-rw-r--r-- | network/amfora-bin/amfora.png | bin | 0 -> 3738 bytes | |||
-rw-r--r-- | network/amfora-bin/docs/CHANGELOG.md | 332 | ||||
-rw-r--r-- | network/amfora-bin/docs/LICENSE | 674 | ||||
-rw-r--r-- | network/amfora-bin/docs/NOTES.md | 15 | ||||
-rw-r--r-- | network/amfora-bin/docs/README.md | 175 | ||||
-rw-r--r-- | network/amfora-bin/docs/THANKS.md | 32 | ||||
-rw-r--r-- | network/amfora-bin/doinst.sh | 9 | ||||
-rw-r--r-- | network/amfora-bin/slack-desc | 19 |
12 files changed, 1377 insertions, 0 deletions
diff --git a/network/amfora-bin/README b/network/amfora-bin/README new file mode 100644 index 0000000000..d6c1ff3435 --- /dev/null +++ b/network/amfora-bin/README @@ -0,0 +1,21 @@ +amfora-bin (gemini client) + +Amfora aims to be the best looking Gemini client with the most +features... all in the terminal. It does not support Gopher or other +non-Web protocols. It fully passes Sean Conman's client torture test, +as well as the Egsam one. + +This is a repack of the official binary; it does not compile from +source. Only 32-bit x86, 64-bit x86_64, and 64-bit aarch64 are +supported. + +For aarch64, since there's currently no way to give the aarch64 download +URL in the .info file, you'll have to download it manually. The file is: + +https://github.com/makew0rld/amfora/releases/download/v1.9.2/amfora_1.9.2_linux_arm64 + +...and its md5sum is: 5f647762170e9e30df6d0744ec8a21bc + +Note: currently there is no amfora build that compiles from source. +If someday someone submits one, be aware that it will likely conflict +with this build. diff --git a/network/amfora-bin/amfora-bin.SlackBuild b/network/amfora-bin/amfora-bin.SlackBuild new file mode 100644 index 0000000000..f285baf99b --- /dev/null +++ b/network/amfora-bin/amfora-bin.SlackBuild @@ -0,0 +1,79 @@ +#!/bin/bash + +# Slackware build script for amfora-bin + +# Written by B. Watson (urchlay@slackware.uk) + +# Licensed under the WTFPL. See http://www.wtfpl.net/txt/copying/ for details. + +cd $(dirname $0) ; CWD=$(pwd) + +PRGNAM=amfora-bin +SRCNAM=amfora +VERSION=${VERSION:-1.9.2} +BUILD=${BUILD:-1} +TAG=${TAG:-_SBo} +PKGTYPE=${PKGTYPE:-tgz} + +if [ -z "$ARCH" ]; then + case "$( uname -m )" in + i?86) ARCH=i586 ;; + arm*) ARCH=arm ;; + *) ARCH=$( uname -m ) ;; + esac +fi + +if [ ! -z "${PRINT_PACKAGE_NAME}" ]; then + echo "$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.$PKGTYPE" + exit 0 +fi + +TMP=${TMP:-/tmp/SBo} +PKG=$TMP/package-$PRGNAM +OUTPUT=${OUTPUT:-/tmp} + +EXE="" +case "$ARCH" in + i?86) EXE=${SRCNAM}_${VERSION}_linux_32-bit ;; + x86_64) EXE=${SRCNAM}_${VERSION}_linux_64-bit ;; + aarch64) EXE=${SRCNAM}_${VERSION}_linux_arm64 ;; +esac + +if [ "$EXE" = "" ]; then + cat <<EOF +=================================================== +Sorry, ARCH="$ARCH" is not supported. +Only i586, i686, x86_64, and aarch64 are supported. +=================================================== +EOF + exit 1 +fi + +set -e + +rm -rf $PKG +mkdir -p $TMP $PKG $OUTPUT +cd $PKG +install -D -m0755 -oroot -groot $CWD/$EXE usr/bin/$SRCNAM + +# the binary includes no docs, icon, desktop, anything else. so +# they're included with the SlackBuild (taken from the git repo at +# https://github.com/makew0rld/amfora). amfora.png is a scaled-down +# copy of logo.png. + +install -D -m0644 -oroot -groot \ + $CWD/amfora.desktop usr/share/applications/amfora.desktop +install -D -m0644 -oroot -groot \ + $CWD/amfora.png usr/share/icons/hicolor/64x64/apps/amfora.png + +PKGDOC=$PKG/usr/doc/$PRGNAM-$VERSION +mkdir -p $PKGDOC +install -m0644 -oroot -groot $CWD/docs/* $PKGDOC +cat $CWD/$PRGNAM.SlackBuild > $PKGDOC/$PRGNAM.SlackBuild + +mkdir -p $PKG/install +cat $CWD/slack-desc > $PKG/install/slack-desc +cat $CWD/doinst.sh > $PKG/install/doinst.sh + +cd $PKG +/sbin/makepkg -l y -c n $OUTPUT/$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.$PKGTYPE diff --git a/network/amfora-bin/amfora-bin.info b/network/amfora-bin/amfora-bin.info new file mode 100644 index 0000000000..43fffb5b69 --- /dev/null +++ b/network/amfora-bin/amfora-bin.info @@ -0,0 +1,10 @@ +PRGNAM="amfora-bin" +VERSION="1.9.2" +HOMEPAGE="https://github.com/makew0rld/amfora/" +DOWNLOAD="https://github.com/makew0rld/amfora/releases/download/v1.9.2/amfora_1.9.2_linux_32-bit" +MD5SUM="206e195bde0fbc2990d8be2c476bfa98" +DOWNLOAD_x86_64="https://github.com/makew0rld/amfora/releases/download/v1.9.2/amfora_1.9.2_linux_64-bit" +MD5SUM_x86_64="cc8d0f9a519602c9c8a1b96a7f02bec1" +REQUIRES="" +MAINTAINER="B. Watson" +EMAIL="urchlay@slackware.uk" diff --git a/network/amfora-bin/amfora.desktop b/network/amfora-bin/amfora.desktop new file mode 100644 index 0000000000..ba086ea5d0 --- /dev/null +++ b/network/amfora-bin/amfora.desktop @@ -0,0 +1,11 @@ +[Desktop Entry] +Type=Application +Name=Amfora +GenericName=Gemini TUI Browser +Comment=Browse Gemini in the terminal. +Categories=Network;WebBrowser;ConsoleOnly; +Keywords=gemini +Terminal=true +Exec=amfora %u +MimeType=x-scheme-handler/gemini; +Icon=amfora diff --git a/network/amfora-bin/amfora.png b/network/amfora-bin/amfora.png Binary files differnew file mode 100644 index 0000000000..099024ee36 --- /dev/null +++ b/network/amfora-bin/amfora.png diff --git a/network/amfora-bin/docs/CHANGELOG.md b/network/amfora-bin/docs/CHANGELOG.md new file mode 100644 index 0000000000..6381acd535 --- /dev/null +++ b/network/amfora-bin/docs/CHANGELOG.md @@ -0,0 +1,332 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] +### Added +- Syntax highlighting for preformatted text blocks with alt text (#252, #263, [wiki page](https://github.com/makeworld-the-better-one/amfora/wiki/Source-Code-Highlighting)) +- [Client certificates](https://github.com/makeworld-the-better-one/amfora/wiki/Client-Certificates) can be restricted to certain paths of a host (#115) +- `header` config option in `[subscriptions]` to allow disabling the header text on the subscriptions page (#191) +- Selected link and scroll position stays for non-cached pages (#122) +- Keybinding to open URL with URL handler instead of configured proxy (#143) +- `include` theme key to import themes from an external file (#154, #290) +- Support SOCKS5 proxying by setting `AMFORA_SOCKS5` environment variable (#155) +- When bookmarking a page, the first level one heading is suggested as the name (#267, #293) +- Confirmation prompts for URL schemes in new `[url-prompts]` config section (#301, #302) + +### Changed +- Center text automatically, removing `left_margin` from the config (#233) +- `max_width` defaults to 80 columns instead of 100 (#233) +- Tabs have the domain of the current page instead of numbers (#202) +- Closing Amfora with <kbd>q</kbd> was removed in favor of <kbd>Shift-q</kbd> (#243) +- Paging up or down scrolls by 50% instead of 75%, to match `less` (#303) +- Update deps, require Go 1.17 (#336) +- Show local directory index file if available (#319) +- Updated Project Gemini URLs (#342) + +### Fixed +- Modal can't be closed when opening non-gemini text URLs from the commandline (#283, #284) +- External programs started by Amfora remain as zombie processes (#219) +- Prevent link lines (and other types) from being wider than the `max_width` setting (#280) +- `new:7` on new tab page fails to open link (#306) +- Slashes aren't decoded in redirect URLs (#322, #324) +- Typing `localhost` in the bottom bar actually loads localhost instead of searching (#326, #327) + + +## [1.9.2] - 2021-12-10 +### Fixed +- Preformatted text color showing even when `color = false` (bug since v1.8.0 at least) (#278) +- Link numbers and link text in color even when `color = false` (regression in v1.9.0) (#278) + + +## [1.9.1] - 2021-12-08 +### Fixed +- Deadlock when loading an invalid `about:` URL (#277) +- Crash when rendering text from stdin + + +## [1.9.0] - 2021-12-07 +### Added +- Support for version 1.1 JSON feeds +- Copy current URL or selected URL to clipboard (#220, #225) + - Uses <kbd>C</kbd> and <kbd>c</kbd> by default +- Configurable keybindings for scrolling on pages (#211, #222) +- Ability to save `about:` pages (#210, #236) +- `bind_beginning` and `bind_end` keybindings +- Display gemtext from stdin (#205, #242) +- Specifying `default` in the theme config uses the terminal's default background color, including transparency (#244, #245) +- Redirects occur automatically if it only adds a trailing slash (#271) +- Non-gemini links are underlined by default to help color blind users (#189) +- Text and element colors of default theme change to be black on terminals with light backgrounds (#181) +- Support paths with spaces in `[url-handlers]` config settings (#214) +- Display info modal when opening URL with custom application +- Files can be opened by relative path on the commandline (#231, #257) +- Support keybindings that use <kbd>Shift</kbd> (#269) + +### Changed +- Bookmarks are stored using XML in the XBEL format, old bookmarks are transferred (#68) +- Text no longer disappears under the left margin when scrolling (regression in v1.8.0) (#197) +- Default search engine changed to geminispace.info from gus.guru +- The user's terminal theme colors are used by default (#181) +- By default, non-gemini URI schemes are opened in the default application. This requires a config change for previous users, see the [wiki](https://github.com/makeworld-the-better-one/amfora/wiki/Handling-Other-URL-Schemes) (#207) +- Windows uses paths set by `XDG` variables over `APPDATA` if they are set (#255) +- Treat status codes like 22 as equivalent to 20 as per the latest spec (#266) +- Show minimal loading page instead of `about:newtab` when loading a URL in a new tab (#272) + +## Removed +- Favicon support (#199) +- The default Amfora theme, get it back [here](https://github.com/makeworld-the-better-one/amfora/blob/master/contrib/themes/amfora.toml) (#181) + +### Fixed +- Help text is now the same color as `regular_text` in the theme config +- Non-ASCII (multibyte) characters can now be used as keybindings (#198, #200) +- Possible subscription update race condition on startup +- Plaintext documents are escaped properly (regression in v1.8.0) +- Help page scrollbar color matches what's in the theme config +- Regression where lists would not appear if `bullets = false` (#234, #235) +- Support multiple bookmarks with the same name +- Cert change message grammar: "an security" -> "a security" (#274) +- Display an error modal for status codes that can't be handled +- Prevent user from getting trapped in the help menu when keybindings are pressed (#241, #261) + + +## [1.8.0] - 2021-02-17 +### Added +- **Media type handlers** - open non-text files in another application (#121, #134) +- Ability to set custom keybindings in config (#135) +- Added scrollbar, by default only appears on pages that go off-screen (#89, #107) +- More internal about pages, see `about:about` (#160, #187) + +### Changed +- Update cview to `d776e728ef6d2a9990a5cd86a70b31f0678613e2` for large performance and feature updates (#107) +- Update to tcell v2 (dependency of cview) +- Display page even if mediatype params are malformed (#141) +- Sensitive input fields (status code 11) display with asterisks over the text (#106) + +### Fixed +- Don't use cache when URL is typed in bottom bar (#159) +- Fix downloading of pages that are too large or timed out +- `about:` URLs can be typed into the bottom bar (#167) +- Bookmarks modal closes on ESC like the others (#173) +- Handle empty META string (#176) +- Whitespace around the URL entered in the bottom bar is stripped (#184) +- Don't break visiting IPv6 hosts when port 1965 is specified (#195) +- More reliable start, no more flash of unindented text, or text that stays unindented (#107) +- Pages with ANSI resets don't use the terminal's default text and background colors (#107) +- ANSI documents don't leak color into the left margin (#107) +- Rendering very long documents is now ~96% faster, excluding gemtext parsing (#26, #107) +- Due to that same change, less memory is used per-page (#26, #107) + + +## [1.7.2] - 2020-12-21 +### Fixed +- Viewing subscriptions after subscribing to a certain user page won't crash Amfora (#157) + + +## [1.7.1] - 2020-12-21 +### Fixed +- Fixed bug that caused Amfora to crash when subscribing to a page (#151) + + +## [1.7.0] - 2020-12-20 +### Added +- **Subscriptions** to feeds and page changes (#61) +- Opening local files with `file://` URIs (#103, #117) +- `show_link` option added in config to optionally see the URL (#133) +- Support for Unicode in domain names (IDNs) +- Unnecessarily encoded characters in URLs will be decoded (#138) +- URLs are NFC-normalized before any processing (#138) +- Links to the wiki in the new tab +- Cache times out after 30 minutes by default (#110) +- `about:version` page (#126) + +### Changed +- Updated [go-gemini](https://github.com/makeworld-the-better-one/go-gemini) to v0.11.0 + - Supports CN-only wildcard certs + - Time out when header takes too long +- Preformatted text is now light yellow by default +- Downloading a file no longer uses a second request +- You can go back to the new tab page in history (#96) + +### Fixed +- Single quotes are used in the default config for commands and paths so that Windows paths with backslashes will be parsed correctly +- Downloading now uses proxies when appropriate +- User-entered URLs with invalid characters will be percent-encoded (#138) +- Custom downloads dir is actually used (#148) +- Empty quote lines no longer disappear + + +## [1.6.0] - 2020-11-04 +### Added +- **Support client certificates** through config (#112) +- `ansi` config setting, to disable ANSI colors in pages (#79, #86) +- Edit current URL with <kbd>e</kbd> (#87) +- If `emoji_favicons` is enabled, new bookmarks will have the domain's favicon prepended (#69, #90) +- The `BROWSER` env var is now also checked when opening web links on Unix (#93) +- More accurate error messages based on server response code + +### Changed +- Disabling the `color` config setting also disables ANSI colors in pages (#79, #86) +- Updated [go-isemoji](https://github.com/makeworld-the-better-one/go-isemoji) to v1.1.0 to support Emoji 13.1 for favicons +- The web browser code doesn't check for Xorg anymore, just display variables (#93) +- Bookmarks can be made to non-gemini URLs (#94) +- Remove pointless directory fallbacks (#101) +- Don't load page from cache when redirected to it (#114) + +### Fixed +- XDG user dir file is parsed instead of looking for XDG env vars (#97, #100) +- Support paths with spaces in HTTP browser config setting (#77) +- Clicking "Change" on an existing bookmark without changing the text no longer removes it (#91) +- Display HTTP Error if "Open In Portal" fails (#81) +- Support ANSI color codes again, but only in preformatted blocks (#59) +- Make the `..` command work lke it used to in v1.4.0 + + +## [1.5.0] - 2020-09-01 +### Added +- **Proxy support** - see the `[proxies]` section in the config (#66, #80) +- **Emoji favicons** can now be seen if `emoji_favicons` is enabled in the config (#62) +- `shift_numbers` key in the config was added, so that non US keyboard users can navigate tabs (#64) +- <kbd>F1</kbd> and <kbd>F2</kbd> keys for navigating to the previous and next tabs (#64) +- Resolving any relative path (starts with a `.`) in the bottom bar is supported, not just `..` (#71) +- You can now set external programs in the config to open other schemes, like `gopher://` or `magnet:` (#74) +- Auto-redirecting can be enabled - redirect within Gemini up to 5 times automatically (#75) +- Help page now documents paging keys (#78) +- The new tab page can be customized by creating a gemtext file called `newtab.gmi` in the config directory (#67, #83) + +### Changed +- Update to [go-gemini](https://github.com/makeworld-the-better-one/go-gemini) v0.8.4 + +### Fixed +- Two digit (and higher) link texts are now in line with one digit ones (#60) +- Race condition when reloading pages that could have caused the cache to still be used +- Prevent panic (crash) when the server sends an error with an empty meta string (#73) +- URLs with with colon-only schemes (like `mailto:`) are properly recognized +- You can no longer navigate through the history when the help page is open (#55, #78) + + +## [1.4.0] - 2020-07-28 +### Added +- **Theming** - check out [default-config.toml](./default-config.toml) for details (#46) +- <kbd>Tab</kbd> now also enters link selecting mode, like <kbd>Enter</kbd> (#48) +- Number keys can be pressed to navigate to links 1 through 10 (#47) +- Permanent redirects are cached for the session (#22) +- `.ansi` is also supported for `text/x-ansi` files, as well as the already supported `.ans` + +### Changed +- Documented <kbd>Ctrl-C</kbd> as "Hard quit" +- Updated [cview](https://gitlab.com/tslocum/cview/) to latest commit: `cc7796c4ca44e3908f80d93e92e73694562d936a` +- The bottom bar label now uses the same color as the tabs at the top +- Tab and blue link colors were changed very slightly to be part of the 256 Xterm colors, for better terminal support + +### Fixed +- You can't change link selection while the page is loading +- Only one request is made for each URL - `v1.3.0` accidentally made two requests each time (#50) +- Using the `..` command doesn't keep the query string (#49) +- Any error that occurs when downloading a file will be displayed, and the partially downloaded file will be deleted +- Allow for opening a new tab while the current one is loading +- Pressing Escape after typing in the bottom bar no longer jumps you back to the top of the page +- Repeated redirects where the last one is cancelled by the user doesn't leave the `Loading...` text in the bottom bar (#53) + + +## [1.3.0] - 2020-07-10 +### Added +- **Downloading content** (#38) +- Configurable page size limit - `page_max_size` in config (#30) +- Configurable page timeout - `page_max_time` in config +- Link and heading lines are wrapped just like regular text lines +- Wrapped list items are indented to stay behind the bullet (#35) +- Certificate expiry date is stored when the cert IDs match (#39) +- What link was selected is remembered as you browse through history +- Render ANSI codes in `text/x-ansi` pages, or text pages that end with `.ans` (#45) + +### Changed +- Pages are rewrapped dynamically, whenever the terminal size changes (#33) +- TOFU warning message mentions how long the previous cert was still valid for (#34) + +### Fixed +- Many potential network and display race conditions eliminated +- Whether a tab is loading stays indicated when you switch away from it and go back +- Plain text documents are displayed faithfully (there were some edge conditions) +- Opening files in portal.mozz.us uses the `http` setting in the config (#42) + + +## [1.2.0] - 2020-07-02 +### Added +- Alt-Left and Alt-Right for history navigation (#23) +- You can type `..` in the bottom bar to go up a directory in the URL (#21) +- Error popup for when input string would result in a too long out-of-spec URL (#25) +- Paging, using <kbd>d</kbd> and <kbd>u</kbd>, as well as <kbd>Page Up</kbd> and <kbd>Page Down</kbd> (#19) +- <kbd>Esc</kbd> can exit link highlighting mode (#24) +- Selected link URL is displayed in the bottom bar (#24) +- Pressing <kbd>Ctrl-T</kbd> with a link selected opens it in a new tab (#27) +- Writing `new:N` in the bottom bar will open link number N in a new tab (#27) +- Quote lines are now in italics (#28) + +### Changed +- Bottom bar now says `URL/Num./Search: ` when space is pressed +- Update to [go-gemini](https://github.com/makeworld-the-better-one/go-gemini) v0.6.0 +- Help layout doesn't have borders anymore +- Pages with query strings are still cached (#29) +- URLs or searches typed in the bottom bar are not loaded from the cache (#29) + +### Fixed +- Actual unicode bullet symbol is used for lists: U+2022 +- Performance when loading very long cached pages improved (#26) +- Doesn't crash when wrapping certain complex lines (#20) +- Input fields are always in focus when they appear (#5) +- Reloading the new tab page doesn't cause an error popup +- Help table cells are hardwrapped so the text can still be read entirely on an 80-column terminal +- New tab text is wrapped to terminal width like other pages (#31) +- TOFU "continue anyway" popup has a question mark at the end + + +## [1.1.0] - 2020-06-24 +### Added +- **Bookmarks** (#10) +- **Support over 55 charsets** (#3) +- **Search using the bottom bar** +- Add titles to all modals +- Store ports in TOFU database (#7) +- Search from bottom bar +- Wrapping based on terminal width (#1) +- `left_margin` config option (#1) +- Right margin for text (#1) +- Desktop entry file +- Option to continue anyway when cert doesn't match TOFU database +- Display all `text/*` documents, not just gemini and plain (#12) +- Prefer XDG environment variables if they're set, to specify config dir, etc (#11) +- Version and help commands - `-v`, `--version`, `--help`, `-h` (#14) + +### Changed +- Connection timeout is 15 seconds (was 5s) +- Hash `SubjectPublicKeyInfo` for TOFU instead (#7) +- `wrap_width` config option became `max_width` (#1) +- Make the help table look better + +### Removed +- Opening multiple URLs from the command line + +### Fixed +- Reset bottom bar on error / invalid URL +- Side scrolling doesn't cut off text on the left side (#1) +- Mark status code 21 as invalid +- Bottom bar is not in focus after clicking Enter +- Badly formed links on pages can no longer crash the browser +- Disabling color in config affects UI elements (#16) +- Keep bold for headings even with color disabled +- Don't make whole link text bold when color is disabled +- Get domain from URL for TOFU, not from certificate + + +## [1.0.0] - 2020-06-18 +Initial release. + +### Added +- Tabbed browsing +- TOFU +- Styled content +- Basic history for each tab +- Input diff --git a/network/amfora-bin/docs/LICENSE b/network/amfora-bin/docs/LICENSE new file mode 100644 index 0000000000..f288702d2f --- /dev/null +++ b/network/amfora-bin/docs/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/network/amfora-bin/docs/NOTES.md b/network/amfora-bin/docs/NOTES.md new file mode 100644 index 0000000000..d321e3f55a --- /dev/null +++ b/network/amfora-bin/docs/NOTES.md @@ -0,0 +1,15 @@ +# Notes + +## Issues +- URL for each tab should not be stored as a string - in the current code there's lots of reparsing the URL + +## Upstream Bugs +- Bookmark keys aren't deleted, just set to `""` + - Waiting on [this viper PR](https://github.com/spf13/viper/pull/519) to be merged +- [ANSI conversion is messed up](https://code.rocketnine.space/tslocum/cview/issues/48) +- [WordWrap is broken in some cases](https://code.rocketnine.space/tslocum/cview/issues/27) - close #156 if this is fixed +- [Prevent panic when reformatting](https://code.rocketnine.space/tslocum/cview/issues/50) - can't reliably reproduce or debug +- [Unicode bullet symbol mask causes issues with PasswordInput](https://code.rocketnine.space/tslocum/cview/issues/55) + + +## Upstream PRs diff --git a/network/amfora-bin/docs/README.md b/network/amfora-bin/docs/README.md new file mode 100644 index 0000000000..4a73792c99 --- /dev/null +++ b/network/amfora-bin/docs/README.md @@ -0,0 +1,175 @@ +# Amfora + +<img src="logo.png" alt="amphora logo" width="30%"> +<h6>Image modified from: amphora by Alvaro Cabrera from the Noun Project</h6> + + +[![go reportcard](https://goreportcard.com/badge/github.com/makeworld-the-better-one/amfora)](https://goreportcard.com/report/github.com/makeworld-the-better-one/amfora) +[![license GPLv3](https://img.shields.io/github/license/makeworld-the-better-one/amfora)](https://www.gnu.org/licenses/gpl-3.0.en.html) + +<a href="https://raw.githubusercontent.com/makeworld-the-better-one/amfora/master/demo-large.gif"> +<img src="demo-large.gif" alt="Demo GIF" width="80%"> +</a> + +###### Recording of v1.0.0 + +Amfora aims to be the best looking [Gemini](https://geminiquickst.art/) client with the most features... all in the terminal. It does not support Gopher or other non-Web protocols - check out [Bombadillo](http://bombadillo.colorfield.space/) for that. + +It also aims to be completely cross platform, with full Windows support. If you're on Windows, I would not recommend using the default terminal software. Use [Windows Terminal](https://www.microsoft.com/en-us/p/windows-terminal/9n0dx20hk701) instead, and make sure it [works with UTF-8](https://akr.am/blog/posts/using-utf-8-in-the-windows-terminal). Note that some of the application colors might not display correctly on Windows, but all functionality will still work. + +It fully passes Sean Conman's client torture test, as well as the Egsam one. + +## Project Status + +Amfora is in maintenance mode. When possible, I’ll make/merge bug fixes, and maybe slowly merge feature PRs by others. See my [blog post](https://www.makeworld.space/2023/08/bye_gemini.html) for details. + +## Installation + +### Binary + +Download a binary from the [releases](https://github.com/makeworld-the-better-one/amfora/releases) page. On Unix-based systems you will have to make the file executable with `chmod +x <filename>`. You can rename the file to just `amfora` for easy access, and move it to `/usr/local/bin/`. + +On Windows, make sure you click "Advanced > Run anyway" after double-clicking, or something like that. + +Unix systems can install the desktop entry file to get Amfora to appear when they search for applications: +```bash +curl -sSL https://raw.githubusercontent.com/makeworld-the-better-one/amfora/master/amfora.desktop -o ~/.local/share/applications/amfora.desktop +update-desktop-database ~/.local/share/applications +``` + +Make sure to click "Watch" in the top right, then "Custom" > "Releases" to get notified about new releases! + + +### Linux + +<a href="https://repology.org/project/amfora/versions"> + <img src="https://repology.org/badge/vertical-allrepos/amfora.svg" alt="Packaging status" align="right"> +</a> + +Amfora is packaged in many Linux distros. It's also on [Scoop](https://scoop.sh/) for Windows users. + +### macOS (Homebrew) + +If you use [Homebrew](https://brew.sh/), you can install Amfora with: +``` +brew install amfora +``` +You can update it with: +``` +brew upgrade amfora +``` + +### macOS (MacPorts) + +On macOS, Amfora can also be installed through [MacPorts](https://www.macports.org): +``` +sudo port install amfora +``` +You can update it with: +``` +sudo port selfupdate +sudo port upgrade amfora +``` +**NOTE:** this installation source is community-maintained. More information [here](https://ports.macports.org/port/amfora/). + +### Termux + +If you're using [Termux](https://termux.com/) on Android you can't just run Amfora like normal. After installing Amfora, run `pkg install proot`. Then run `termux-chroot` before running the Amfora binary. You can exit out of the chroot after closing Amfora. See [here](https://stackoverflow.com/q/38959067/7361270) for why this is needed. + +### From Source + +This section is for advanced users who want to install the latest (possibly unstable) version of Amfora. + +<details> +<summary>Click to expand</summary> + +**Requirements:** +- Go 1.15 or later +- GNU Make + +Please note the Makefile does not intend to support Windows, and so there may be issues. + +```shell +git clone https://github.com/makeworld-the-better-one/amfora +cd amfora +# git checkout v1.2.3 # Optionally pin to a specific version instead of the latest commit +make # Might be gmake on macOS +sudo make install # If you want to install the binary for all users +``` + +Because you installed with the Makefile, running `amfora -v` will tell you exactly what commit the binary was built from. + +Arch Linux users can also install the latest commit of Amfora from the AUR. It has the package name `amfora-git`, and is maintained by @lovetocode999 + +``` +yay -S amfora-git +``` + +MacOS users can also use [Homebrew](https://brew.sh/) to install the latest commit of Amfora: + +``` +brew install --HEAD amfora +``` +You can update it with: +``` +brew upgrade --fetch-HEAD amfora +``` + +</details> + + +## Features / Roadmap +Features in *italics* are in the master branch, but not in the latest release. + +- [x] URL browsing with TOFU and error handling +- [x] Tabbed browsing +- [x] Support ANSI color codes on pages, even for Windows +- [x] Styled page content (headings, links) +- [x] Basic forward/backward history, for each tab +- [x] Input (Status Code 10 & 11) +- [x] Multiple charset support (over 55) +- [x] Built-in search (uses geminispace.info by default) +- [x] Bookmarks +- [x] Download pages and arbitrary data +- [x] Theming + - Check out the [user contributed themes](https://github.com/makeworld-the-better-one/amfora/tree/master/contrib/themes)! +- [x] Proxying + - Schemes like Gopher or HTTP can be proxied through a Gemini server +- [x] Client certificate support + - [ ] Full client certificate UX within the client + - Create transient and permanent certs within the client, per domain + - Manage and browse them + - Similar to [Kristall](https://github.com/MasterQ32/kristall) + - https://lists.orbitalfox.eu/archives/gemini/2020/001400.html +- [x] Subscriptions + - Subscribing to RSS, Atom, and [JSON Feeds](https://jsonfeed.org/) are all supported + - So is subscribing to a page, to know when it changes +- [x] Open non-text files in another application + - [x] Ability to stream content instead of downloading it first +- [x] *Highlighting of preformatted code blocks that list a language in the alt text* +- [ ] Stream support +- [ ] Table of contents for pages +- [ ] Search in pages with <kbd>Ctrl-F</kbd> +- [ ] Persistent history + + +## Usage & Configuration +Please see [the wiki](https://github.com/makeworld-the-better-one/amfora/wiki) for an introduction on how to use Amfora and configure it. + +## Libraries +Amfora ❤️ open source! + +- [cview](https://code.rocketnine.space/tslocum/cview) for the TUI + - It's a fork of [tview](https://github.com/rivo/tview) with PRs merged and active support + - It uses [tcell](https://github.com/gdamore/tcell) for low level terminal operations +- [Viper](https://github.com/spf13/viper) for configuration and TOFU storing +- [go-gemini](https://github.com/makeworld-the-better-one/go-gemini), my forked and updated Gemini client/server library +- [progressbar](https://github.com/schollz/progressbar) +- [go-humanize](https://github.com/dustin/go-humanize) +- [gofeed](https://github.com/mmcdole/gofeed) +- [chroma](https://github.com/alecthomas/chroma) for source code syntax highlighting +- [clipboard](https://github.com/atotto/clipboard) +- [termenv](https://github.com/muesli/termenv) + +## License +This project is licensed under the GPL v3.0. See the [LICENSE](./LICENSE) file for details. diff --git a/network/amfora-bin/docs/THANKS.md b/network/amfora-bin/docs/THANKS.md new file mode 100644 index 0000000000..2ba5025e4e --- /dev/null +++ b/network/amfora-bin/docs/THANKS.md @@ -0,0 +1,32 @@ +# THANKS + +Thank you to the following contributors, who have helped make Amfora great. FOSS projects are a community effort, and we would be worse off without you. + +* Sotiris Papatheodorou (@sotpapathe) +* Chloe Kudryavtsev (@CosmicToast) +* Adrian Hesketh (@a-h) +* Jansen Price (@sumpygump) +* Alex Wennerberg (@alexwennerberg) +* Timur Ismagilov (@bouncepaw) +* Matt Caroll (@ohiolab) +* Patryk Niedźwiedziński (@pniedzwiedzinski) +* Trevor Slocum (@tsclocum) +* Mattias Jadelius (@jedthehumanoid) +* Lokesh Krishna (@lokesh-krishna) +* Jeff (@phaedrus-jaf) +* Stephen Robinson (@sudobash1) +* Peter Steinberg (@objectliteral) +* Thomas Adam (@ThomasAdam) +* @lostleonardo +* Himanshu (@singalhimanshu) +* @regr4 +* Anas Mohamed (@amohamed11) +* David Jimenez (@dvejmz) +* Michael McDonagh (@m-mcdonagh) +* mooff (@awfulcooking) +* Josias (@justjosias) +* mntn (@mntn-xyz) +* Maxime Bouillot (@Arkaeriit) +* Emily (@emily-is-my-username) +* Autumn! (@autumnull) +* William Rehwinkel (@FiskFan1999) diff --git a/network/amfora-bin/doinst.sh b/network/amfora-bin/doinst.sh new file mode 100644 index 0000000000..65c7e2eeb9 --- /dev/null +++ b/network/amfora-bin/doinst.sh @@ -0,0 +1,9 @@ +if [ -x /usr/bin/update-desktop-database ]; then + /usr/bin/update-desktop-database -q usr/share/applications >/dev/null 2>&1 +fi + +if [ -e usr/share/icons/hicolor/icon-theme.cache ]; then + if [ -x /usr/bin/gtk-update-icon-cache ]; then + /usr/bin/gtk-update-icon-cache -f usr/share/icons/hicolor >/dev/null 2>&1 + fi +fi diff --git a/network/amfora-bin/slack-desc b/network/amfora-bin/slack-desc new file mode 100644 index 0000000000..134aa428c6 --- /dev/null +++ b/network/amfora-bin/slack-desc @@ -0,0 +1,19 @@ +# HOW TO EDIT THIS FILE: +# The "handy ruler" below makes it easier to edit a package description. +# Line up the first '|' above the ':' following the base package name, and +# the '|' on the right side marks the last column you can put a character in. +# You must make exactly 11 lines for the formatting to be correct. It's also +# customary to leave one space after the ':' except on otherwise blank lines. + + |-----handy-ruler------------------------------------------------------| +amfora-bin: amfora-bin (gemini client) +amfora-bin: +amfora-bin: Amfora aims to be the best looking Gemini client with the most +amfora-bin: features... all in the terminal. It does not support Gopher or other +amfora-bin: non-Web protocols. It fully passes Sean Conman's client torture test, +amfora-bin: as well as the Egsam one. +amfora-bin: +amfora-bin: +amfora-bin: +amfora-bin: +amfora-bin: |