commit 1c1e3e26ede69b7186bce991a7873d56bc07dd83 from: Omar Polo date: Thu Sep 08 15:49:06 2022 UTC refresh the site - be more like the kamid site: generate the HTML from a mixture of text/gemini and (bits of) html. - include the awesome logo by freezr - use (a modified version of) kamid' style.css - use mandoc.css - minor styling tweaks commit - 05d87bafea0acc2bb9f304b9c1f6f09f13f54dd1 commit + 1c1e3e26ede69b7186bce991a7873d56bc07dd83 blob - 0b1a3d571cbdfade194800ea8f90c6cb211b8d99 blob + c71788165a8053523f8dfbf8316c38ba7ab0cca8 --- site/Makefile +++ site/Makefile @@ -1,19 +1,72 @@ -.PHONY: all serve-www serve-gemini upload +RSYNC = openrsync --rsync-path=openrsync -all: telescope.1.html telescope.1.txt +MANPAGES = ../telescope.1 -telescope.1.html: ../telescope.1 - ./mdoc2html.sh $? $@ +PAGES = index.gmi \ + gallery.gmi +# changelog.gmi -telescope.1.txt: ../telescope.1 - MANWIDTH=72 man -Tutf8 -l $? | col -b > $@ +TITLE_index.gmi = Home +TITLE_changelog.gmi = ChangeLog +TITLE_gallery.gmi = Gallery +REPOLOGY_BANNER = https://repology.org/badge/vertical-allrepos/telescope.svg +REPOLOGY_URL = https://repology.org/project/telescope/versions + +SUBST = ./subst CURRV=0.8.1 NEXTV=0.9 \ + GH=https://github.com/omar-polo/telescope \ + CURRSIGN=RWQ12hzRNC/1NhZD56pU1YaRg5AYSEWg9gId5M3e9zwuufmwnbd7WrMb \ + NEXTSIGN=RWSmshjFM8Q0IDYUd4I/8G2q9Y0DUaZLac4enOtQh5rzsIcVF+ePXCy7 \ + REPOLOGY_BANNER=${REPOLOGY_BANNER} \ + REPOLOGY_URL=${REPOLOGY_URL} + +SUBST_GEM = ${SUBST} MANEXT=txt EXT=gmi +SUBST_WWW = ${SUBST} MANEXT=html EXT=html + +.PHONY: all dirs manpages serve-www serve-gemini upload clean titles + +all: dirs manpages pages + cp logo.png gemini/ + cp mandoc.css style.css www/ + cp logo.png www/ + cp -R gallery gemini + cp -R gallery www + convert logo.png -resize 200x200 www/logo.small.png + +dirs: + mkdir -p gemini www + +manpages: +.for m in ${MANPAGES} + man -O style=mandoc.css -Thtml -l $m > www/${m:T}.html + man -O width=64 -Tutf8 -l $m | col -b > gemini/${m:T}.txt +.endfor + +pages: +.for p in ${PAGES} + grep -v '^<' $p | ${SUBST_GEM} > gemini/$p + + ${SUBST_WWW} TITLE=${TITLE_${p}:Q} header.html > www/$p + ${MAKE} titles | ./menu.pl "${p:.gmi=.html}" >> www/$p + ${SUBST_WWW} $p | ./gem2html >> www/$p + cat footer.html >> www/$p + cd www && mv $p ${p:.gmi=.html} +.endfor + serve-www: - python3 -m http.server 8888 + python3 -m http.server --directory www 8888 serve-gemini: - gmid -p 1966 . + ge -p 1966 gemini upload: - openrsync --rsync-path=openrsync --del -a . antartica:/var/www/telescope.omarpolo.com - openrsync --rsync-path=openrsync --del -a . antartica:/var/gemini/telescope.omarpolo.com + ${RSYNC} --del -a . antartica:/var/www/telescope.omarpolo.com + ${RSYNC} --del -a . antartica:/var/gemini/telescope.omarpolo.com + +clean: + rm -rf gemini www + +titles: +.for p in ${PAGES} + @printf "%s %s\n" "${p:.gmi=.html}" ${TITLE_${p}:Q} +.endfor blob - 41ccc459cd6ee5580d49717898287c038862af1e (mode 644) blob + /dev/null --- site/gallery/index.gmi +++ /dev/null @@ -1,18 +0,0 @@ -=> / Home -=> /telescope.1.txt Docs - -# Gallery - -=> xterm-default-look.png default look on bright terminal -=> kitty-default-look.png default look on dark terminal - -=> xterm-contrib-light.png the contrib/light theme -=> kitty-contrib-dark.png the contrib/dark theme - -=> xterm-contrib-light-swiper.png swiper with the contrib/light theme -=> kitty-contrib-dark-swiper.png swiper with the contrib/dark theme - -=> xterm-contrib-light-about-help.png about:help with the contrib/light theme -=> kitty-contrib-dark-about-help.png about:help with the contrib/dark theme - -=> contrib-brutalist.png Brutalist theme blob - 71690c81c7272991672606de578b89c5136bf673 (mode 644) blob + /dev/null --- site/gallery/index.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - Gallery | Telescope - - - - - -

- -

- -

- -

- -

- -

- -

- -

- -

- -

- -

- - blob - /dev/null blob + 0b1a491b5687a2f04fc2899785ab32d9ad570866 (mode 644) --- /dev/null +++ site/footer.html @@ -0,0 +1,10 @@ + + + blob - 1ea617af1ca3336baf364364422d6a1c3067eca4 blob + 37260e1d055893b0745e2e3e0d916d3b23c930c8 --- site/index.gmi +++ site/index.gmi @@ -1,27 +1,34 @@ -=> /gallery/ Gallery -=> /telescope.1.txt Docs - -# Telescope - -> Telescope is a w3m-like browser for Gemini. - -``` Ascii art of the word “Telescope” and “v0.8.1” + +> Telescope is a w3m-like browser for Gemini. + +

+ Telescope is written entirely for fun, as a hobbystic project in my free time. As such, it lacks a ton of features you’ll find in more mature Gemini browsers, but it also has some unique ones. +=> telescope.1.MANEXT documentation + The UI is strongly inspired from Emacs and W3M, so you’ll find some familiar concepts, such as the minibuffer or the tabline, and the default keybindigs also reflect this, but care has been taken to add keys familiar for vi and CUA users too. +

=> https://asciinema.org/a/426862 Asciinema record ## Install -=> https://repology.org/project/telescope/versions Some distros provide a package — thanks to the maintainers! +

+=> REPOLOGY_URL Some distros provide a package — thanks to the maintainers! Source code and precompiled binaries for linux are available: blob - b14dfdf26f91f3d4f921a78bc9ae964c9fe21051 (mode 644) blob + /dev/null --- site/index.html +++ /dev/null @@ -1,262 +0,0 @@ - - - - Telescope - - - - - -

- -

 _______         __
-|_     _|.-----.|  |.-----.-----.----.-----.-----.-----.
-  |   |  |  -__||  ||  -__|__ --|  __|  _  |  _  |  -__|
-  |___|  |_____||__||_____|_____|____|_____|   __|_____|
-                                           |__| v0.8.1

-
Telescope is a w3m-like browser for Gemini
-

- Telescope is written entirely for fun, as a hobbystic project in - my free time. As such, it lacks a ton of features you’ll find - in more mature Gemini browsers, but it also has some unique - ones. -

- The UI is strongly inspired from Emacs and W3M, so you’ll find - some familiar concepts, such as the minibuffer or the tabline, - and the default keybindigs also reflect this, but keys familiar - for vi and CUA users are also present by default. -

- - - -

Install

Some distros provide a package — thanks to the maintainers!

- -

Source code and precompiled binaries for linux are available:

The dependencies are:

libncurses
libevent
libtls (from either LibreSSL or libretls)
yacc (or GNU bison)

Once all the dependencies are installed, building is as easy as:

$ curl -LO https://github.com/omar-polo/telescope/releases/download/0.8.1/telescope-0.8.1.tar.gz
-$ tar xzvf telescope-0.8.1.tar.gz
-$ cd telescope-0.8.1
-$ ./configure
-$ make
-$ sudo make install # eventually
-

- A SHA256 file containing the checksums is available. However, - that only checks for accidental corruption: you can use signify - (SHA256.sig and the public key telescope-0.8.pub). - The hash of the current and next signify public key is also - included in the SHA256. -

How to verify the signature with signify:

$ signify -C -p telescope-0.8.1.pub -x SHA256.sig
-Signature Verified
-telescope-0.8.1.tar.gz: OK
-telescope-0.8.pub: OK
-telescope-0.9.pub: OK
-telescope.amd64: OK
-

Changelog

0.8.1 “Le Scarpe Volanti” buildfix release — Released May 25, 2022

Fix the build on macos. Reported by sikmir, thanks!

0.8 “Le Scarpe Volanti” — Released May 25, 2022

New features

save and restore scroll position
new command reply-last-input; idea from a conversation with thfr@, thanks!
allow push urls to an already opened telescope session
autocompletions for load-url and load-current-url
new command write-buffer (with alias w)
new command mini-kill-whole-line for the minibuffer
split the minibuffer input into words and try to match out of order

Improvements

move aliases at the top of the completions
add alias `open' for load-url; suggested by Florian, thanks!
update emoji-data.txt to 14.0.0
persist the list of visited URLs to the disk
fix builds out-of-tree
correctly mark variables in the manpage so it's possible to jump to them
rework completions selection: the selected entry is *always* the one used. if nothing is selected, the minibuffer content is used instead.
merge the ui and fs processes
rate-limit the update of the download pane

Bug fixes

fix parsing of invalid link lines
initialize each tab' loadingev timer event
fix the build on recent version of musl

- - blob - /dev/null blob + 66e06dc172e2cd00cee7c3b9b4fb5bfc6cf5e877 (mode 644) --- /dev/null +++ site/gallery.gmi @@ -0,0 +1,15 @@ +

+=> gallery/xterm-default-look.png default look on bright terminal +=> gallery/kitty-default-look.png default look on dark terminal + +=> gallery/xterm-contrib-light.png the contrib/light theme +=> gallery/kitty-contrib-dark.png the contrib/dark theme + +=> gallery/xterm-contrib-light-swiper.png swiper with the contrib/light theme +=> gallery/kitty-contrib-dark-swiper.png swiper with the contrib/dark theme + +=> gallery/xterm-contrib-light-about-help.png about:help with the contrib/light theme +=> gallery/kitty-contrib-dark-about-help.png about:help with the contrib/dark theme + +=> gallery/contrib-brutalist.png Brutalist theme +

blob - 4cb718f9d31ec09d1bd023b5bd5aa3322e21f601 (mode 755) blob + /dev/null --- site/mdoc2html.sh +++ /dev/null @@ -1,30 +0,0 @@ -#!/bin/sh -# -# usage: mdoc2html.sh src out -# -# converts the manpage `src' to the HTML file `out', tweaking the -# style - -set -e - -: ${1:?missing input file} -: ${2:?missing output file} - -man -Thtml -l "$1" > "$2" - -exec ed "$2" < -a - body { - max-width: 960px; - margin: 0 auto; - padding: 0 10px; - font-size: 1rem; - } - - pre { - overflow: auto; - } -. -wq -EOF blob - /dev/null blob + b6c8b70e8bb9be4afb7a39648555fe81cdb833b9 (mode 755) --- /dev/null +++ site/gem2html @@ -0,0 +1,124 @@ +#!/usr/bin/env perl +# +# Copyright (c) 2022 Omar Polo +# +# Permission to use, copy, modify, and distribute this software for any +# purpose with or without fee is hereby granted, provided that the above +# copyright notice and this permission notice appear in all copies. +# +# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +use v5.10; +use strict; +use warnings; + +my $in_pre = 0; +my $in_list = 0; + +while (<>) { + chomp; + if ($in_pre && m/^```/) { + $in_pre = 0; + say ""; + } elsif (!$in_pre && m/^```/) { + if ($in_list) { + $in_list = 0; + say ""; + } + $in_pre = 1; + print "

";
+	} elsif ($in_pre) {
+		say san($_);
+	} elsif (m/^";
+		$in_list = 0;
+	} elsif (m/^\*\s+(.*)/) { # NB: at least one space
+		if (!$in_list) {
+			$in_list = "item";
+			say "";
+		} elsif ($in_list eq "link") {
+			$in_list = "item";
+			say "";
+			say "";
+		}
+		output("li", $1);
+	} elsif (m/^=>\s*([^\s]*)\s*(.*)$/) {
+		my $href = $1;
+		my $alt = $2 || $1;
+
+		# special case: images
+		if ($1 =~ /\.(png|jpg|svg)$/) {
+			if ($in_list) {
+				say "";
+				$in_list = 0;
+			}
+			print "";
+			print "";
+			print "";
+			print "";
+			print "$alt";
+			print "\n";
+			next;
+		}
+
+		if (!$in_list) {
+			$in_list = "link";
+			say "";
+		} elsif ($in_list eq "item") {
+			$in_list = "link";
+			say "";
+			say "";
+		}
+		$_ = $alt;
+		say "". san() ."";
+	} elsif (m/^###\s*(.*)$/) {
+		output("h3", $1);
+	} elsif (m/^##\s*(.*)$/) {
+		output("h2", $1);
+	} elsif (m/^#\s*(.*)$/) {
+		output("h1", $1);
+	} elsif (m/^>\s*(.*)$/) {
+		output("blockquote", $1);
+	} else {
+		output("p", $_);
+	}
+}
+
+say "" if $in_list;
+say "

" if $in_pre; + +sub san { + s/&/\&/g; + s//\>/g; + return $_; +} + +sub output { + my ($tn, $content) = @_; + + if (!$in_list && $tn eq "li") { + $in_list = 1; + say "

"; + } + + if ($in_list && $tn ne "li") { + $in_list = 0; + say ""; + } + + if ($tn eq "p" && $content eq "") { + return; + } + + $_ = $content; + say "<$tn>". san() .""; +} blob - 9e8dadd5bb86dd8a11352bf966f2952a2f66b863 (mode 644) blob + /dev/null --- site/telescope.1.html +++ /dev/null @@ -1,1016 +0,0 @@ - - - - - - - - TELESCOPE(1) - - - - - - - - -

TELESCOPE(1)

General Commands Manual

TELESCOPE(1)

NAME

telescope — - multi-protocol browser

SYNOPSIS

- - - - - -

telescope [-ChnSv] - [-c config] - [URL]

DESCRIPTION

telescope is an interactive browser that - supports the Finger, Gemini and Gopher protocols. - telescope features tabs, a minibuffer, interactive - completions, bookmarks and out-of-band TOFU verification.

The arguments are as follows:

-C, - --colours: Show all available colors and exit. This option can also be spelled - --colors.
-c - config: Specify an alternative configuration file. By default - ~/.config/telescope/config is loaded.
-h, - --help: Display version, usage and exit.
-n: Configtest mode. Only check the configuration file for validity.
-S, - --safe: “Safe” (or “sandbox”) mode. Prevent - telescope from writing files to the disk and to - acquire the lock, allowing to run multiple instances at the same time. - telescope still loads the session file and the - custom about pages.
-v, - --version: Display version and exit.

UI - CONCEPTS

telescope interface is divided into four - areas: the tabline, the body, the modeline and the echoarea/minibuffer.

The tabline is always at the top of the screen and displays the - tabs separated by a vertical line. When there are more tabs than the size of - the window allow to display, the characters ‘<’ or - ‘>’ are shown at the start/end of the tabline to indicate - that there are more tabs in that direction.

The body occupies the majority of the visible area. It contains - the current page and optionally a side window.

The modeline is the second to last row of the screen. It shows - some information about the page: a spinner when the page is loading, the - trust level, the document type, the scroll offset and the URL.

The echoarea is usually the last line of the screen. Messages are - often showed there, and link addresses too. The echoarea is also used to - obtain input from the user. When commands like - swiper or link-select are - invoked, the minibuffer area grows to show possible completions.

TOFU

telescope aims to use the “Trust, - but Verify (where appropriate)” approach for TOFU (“Trust On - First Use”). The idea is to define three level of verification for a - certificate:

untrusted: (‘!’) the server fingerprint does NOT match the stored - value.
trusted: (‘v’) the server fingerprint matches the store one.
verified: (‘V’) the fingerprint matches and has been verified - out-of-band.

The trust level of the page is indicated in the modeline with the - indicated character.

Most of the time the “trusted” level is enough, but - where is appropriate users should be able to verify out-of-band the - certificate.

At the moment, there is no built-in support for an out-of-band - verification though.

SUPPORTED - PROTOCOLS

The following protocols are supported:

about:

About pages are telescope internal page. See - about:about for a list of all these pages.

file://

File types know to telescope, such as .gmi, - .gemini, .txt, .md, .markdown, .diff or .patch, can be viewed inside the - application. Types of local files are detected solely based on the file - extension. On some systems, such as OpenBSD, only - files inside special directories (like /tmp - or ~/Downloads) are - available.

finger://

Finger URLs are interpreted as follows: -

the host is determined by the host name portion of the URL
if the user portion of the URL is provided, it's interpreted as the - user to finger, otherwise the path component will be used

- thus finger://user@hostname - and finger://hostname/user - are treated as the same URL.

gemini://

Gemini is fully supported, with the exception of client-certificates.

gopher://

Gopher support is limited to items type 0, 1 and 7. All text is assumed to - be encoded in UTF-8 (or ASCII).

User-entered URLs, given as argument on the command line or - entered with load-url, are intepreted with a simple - heuristic:

if it's a proper absolute URL then use it as-is,
if it starts with “./” or “/” assume it's a - file:// URL,
otherwise assume it's a Gemini URL.

CONFIGURATION - FILE

During the startup, telescope reads the - configuration file at ~/.config/telescope/config or - ~/.telescope/config.

It's possible to load a custom configuration file using the - -c flag.

telescope will also load a file called - config-TERM, where “TERM” is the name - of the terminal type (i.e. the TERM environment variable), if it exists.

The format of the configuration file is fairly flexible. The - current line can be extended over multiple ones using a backslash - (‘\’). Comments can be put anywhere in the file using a hash - mark (‘#’), and extend to the end of the current line, but - backslashes can't be used to extend comments over multiple lines.

The following constructs are available:

bind - map key - cmd

Bind key to the function cmd - in the keymap map. Valid values for map are - “global-map” (i.e. when the user is viewing a page) and - “minibuffer-map” (i.e. when the minibuffer has the focus.) - key follows the same syntax described in - DEFAULT KEY BINDINGS and - all the possible functions are listed in - INTERACTIVE COMMANDS.

proxy - proto via - url

Use url as proxy for all URLs with protocol - proto. url must be a Gemini - URI without path, query and fragment component.

set - opt = - val

Set the option opt to the value - val. Valid options are: -

autosave: (integer) If greater than zero, save the session after the specified - amount of seconds after some events happens (new or closed tabs, - visited a link ...) Defaults to 20.
dont-wrap-pre: (integer) If nonzero, don't wrap preformatted blocks. Defaults to - 0.
download-path: (string) The default download path. Defaults to - /tmp.
emojify-link: (integer) If nonzero, when the text of a link starts with an emoji - followed by a space, use that emoji as line prefix. Defaults to - 1.
enable-colors: (integer) If nonzero, enable colours. Defaults to 0 if - NO_COLORS is set, 1 otherwise.
fill-column: (integer) If greater than zero, lines of text will be formatted in a - way that don't exceed the given number of columns. Defaults to - 80.
fringe-ignore-offset: (integer) If nonzero, the fringe doesn't obey to - olivetti-mode. Defaults to 1.
hide-pre-blocks: (integer) If nonzero, hide by default the body of the preformatted - blocks. Defaults to zero. push-button can be - used to toggle the visibility per-block.
hide-pre-closing-line: (integer) If nonzero, hide the closing line of preformatted blocks. - Defaults to 0.
hide-pre-context: (integer) If nonzero, hide the start and end line of the preformatted - blocks. If both hide-pre-context and hide-pre-blocks are nonzero, - preformatted blocks are irremediably hidden. Defaults to zero.
new-tab-url: (string) URL for the new tab page. Defaults to - “about:new”.
max-killed-tabs: (integer) The maximum number of closed tabs to keep track of, defaults - to 10. Must be a positive number; if zero, don't save closed tabs at - all.
olivetti-mode: (integer) If nonzero, enable olivetti-mode - Defaults to 1.
tab-bar-show: (integer) If tab-bar-show is -1 hide the tab bar permanently, if 0 - show it unconditionally. If it's 1, show the bar only when there is - more than one tab. Defaults to 1.
update-title: (integer) If nonzero, set the terminal title to the page title. - Defaults to 1.

style - name option

Change the styling of the element identified by - name. Multiple options may be specified within curly - braces. Valid style identifiers are: -

line: the area outside the lines in the body of the page.
line.compl: the completions.
line.compl.current: the current completion.
line.help: text in the *Help* buffer.
line.download.ongoing: an ongoing download
line.download.done: a completed download
line.download.info: informational text in the *Downloads* buffer.
line.fringe: (virtual) lines draw after the end of a buffer.
line.text: text lines.
line.link: link lines.
line.title1..3: headings
line.item: item lines.
line.quote: quotes.
line.pre.start: the heading of a preformatted block.
line.pre: the content of a preformatted block.
line.pre.end: the closing line of a preformatted block.
download: the download pane
minibuffer: the minibuffer.
modeline: the modeline.
tabline: the tabline.
tabline.tab: the non-focused tabs.
tabline.current: the focused tab.

Valid options are:

attr - prefix [line - [trail]]

Sets the text attributes. If only one value is given, - line and trail default to - that; if two values are given then trail - defaults to prefix. Each attribute is a - comma-separated list of keywords: -

normal: no attributes.
standout: best highlighting mode for the terminal.
underline: underlines the text.
reverse: reverses background/foreground colors.
blink: makes the text blinking.
dim: half bright.
bold: extra bright or bold.

Only the style identifiers with the “line.” - prefix accept up to three attributes. The other will only use the - first one given.

bg - prefix [line - [trail]]

Sets the background color. Follows the same behaviour as - attr regarding the optional parameters. The - colour is one of black, red, green, yellow, blue, magenta, cyan and - white; colour0 to colour255 (or color0 to color255) from the - 256-colour set; default for the default colour.

fg - prefix [line - [trail]]

Sets the foreground color. It behaves just like - bg.

prefix - prfx [cont]

Sets the prefix for the current line type to - prfx and cont as the - prefix for the continuation lines (i.e. when a long line gets - wrapped.) If cont is not given its value will be - the same of prfx.

DEFAULT - KEY BINDINGS

The default key bindings are very similar to GNU Emacs, but care - has been taken to include also bindings familiar for vi(1) - and “CUA” users. In the following examples, C-x means - Control-x, M-x means Meta-x, where the Meta key may be either a special key - on the keyboard or the ALT key; otherwise ESC followed by the key X works as - well, and C-M-x means to press the key X together with both Control and - Meta.

Keys are usually a single character, like ‘p’ or - ‘n’, but some special keys are accepted as well.

<up>: Up arrow
<down>: Down arrow
<left>: Left arrow
<right>: Right arrow
<prior>: Previous page/Page up
<next>: Next page/Page down
<home>: Home
<end>: End
<f0> thru <f63>: Function keys
del or backspace: Backspace
esc: Escape
space or spc: Space
enter or ret: Enter
tab: Tab
backtab: Depends on the configuration of the terminal emulator; usually shift - tab.

GNU - Emacs-like keys

C-p: previous-line
C-n: next-line
C-f: forward-char
C-b: backward-char
M-{: backward-paragraph
M-}: forward-paragraph
C-a: move-beginning-of-line
C-e: move-end-of-line
M-v, M-space: scroll-up
C-v, space: scroll-down
M-<: beginning-of-buffer
M->: end-of-buffer
C-x C-c: kill-telescope
C-x C-w: write-buffer
C-g: clear-minibuf
M-x: execute-extended-command
C-c {: dec-fill-column
C-c }: inc-fill-column
C-c p: previous-heading
C-c n: next-heading
>: load-url
<: load-current-url
C-x C-f: load-url
C-x M-f: load-current-url
C-x o: other-window
C-x t 0: tab-close
C-x t 1: tab-close-other
C-x t 2: tab-new
C-x t o: tab-next
C-x t O: tab-previous
C-x t m: tab-move
C-x t M: tab-move-to
B, C-M-b: previous-page
F, C-M-f: next-page
<f7> a: bookmark-page
<f7> <f7>: list-bookmarks
C-z: suspend-telescope

vi(1)-like - keys

k: previous-line
j: next-line
l: forward-char
h: backward-char
{: backward-paragraph
}: forward-paragraph
^: move-beginning-of-line
$: move-end-of-line
K: scroll-line-up
J: scroll-line-down
g g: beginning-of-buffer
G: end-of-buffer
g D: tab-close
g N: tab-new
g t: tab-next
g T: tab-previous
g M-t: tab-move
g M-T: tab-move-to
H: previous-page
L: next-page
u: tab-undo-close
q: kill-telescope
ESC: clear-minibuf
:: execute-extended-command

CUA-like - keys

<up>: previous-line
<down>: next-line
<right>: forward-char
<left>: backward-char
<home>: move-beginning-of-line
<end>: move-end-of-line
<prior>: scroll-up
<next>: scroll-down
C-w: tab-close
C-t: tab-new
M-<prior>: tab-previous
M-<next>: tab-next
del: previous-page
M-<left>: previous-page
M-<right>: next-page
<f5>: reload-page
r: reload-page

Neither - Emacs nor vi specific

<f1>: toggle-help
enter: push-button
M-enter: push-button-new-tab
M-tab: previous-button
backtab: previous-button
tab: next-button
M-t: tab-select
[: tab-previous
]: tab-next
M-[: tab-move-to
M-]: tab-move
M-l: link-select
M-/: swiper
M-r: reply-last-input

Minibuffer-specific - keys

enter: mini-complete-and-exit
C-g: mini-abort
ESC: mini-abort
C-d: mini-delete-char
del: mini-delete-backward-char
backspace: mini-delete-backward-char
C-h: mini-delete-backward-char
C-b: backward-char
C-f: forward-char
<left>: backward-char
<right>: forward-char
C-e: move-end-of-line
C-a: move-beginning-of-line
<end>: move-end-of-line
<home>: move-beginning-of-line
C-k: mini-kill-line
C-u: mini-kill-whole-line
M-p: mini-previous-history-element
M-n: mini-next-history-element
C-p: previous-completion
C-n: next-completion
<up>: previous-completion
<down>: next-completion
tab: insert-current-candidate
M-<: mini-goto-beginning
M->: mini-goto-end

INTERACTIVE - COMMANDS

Follows the documentation for the interactive commands. These - commands can be bound to a key or executed with - execute-extended-command.

Movement - commands

backward-char: Move point one character backward.
backward-paragraph: Move point one paragraph backward.
beginning-of-buffer: Move point to the beginning of the buffer.
end-of-buffer: Move point to the end of the buffer.
forward-char: Move point one character forward.
forward-paragraph: Move point one paragraph forward.
insert-current-candidate: Copy the current selection text as minibuffer input.
move-beginning-of-line: Move point at the beginning of the current (visual) line.
move-end-of-line: Move point at the end of the current (visual) line.
next-button: Move point to the next link.
next-completion: Select the next completion.
next-heading: Move point to the next heading.
next-line: Move point to the next (visual) line, in the same column if possible.
previous-button: Move point to the previous link.
previous-completion: Select the previous completion.
previous-heading: Move point to the previous heading.
previous-line: Move point to the previous (visual) line.

Bookmark-related - commands

bookmark-page: Save a page in the bookmark file. It preloads the minibuffer with the - current URL.
list-bookmarks: Load the bookmarks page.

Tab-related - commands

tab-close: Close the current tab.
tab-close-other: Close all tabs but the current one.
tab-move: Move the current tab after the next one, wrapping around if needed.
tab-move-to: Move the current tab before the previous one, wrapping around if - needed.
tab-new: Open a new tab.
tab-next: Focus next tab, wrapping around eventually.
tab-previous: Focus the previous tab, wrapping around eventually.
tab-select: Switch to a tab using the minibuffer.
tab-undo-close: Re-open the most recently closed tab, if any.

Misc - commands

cache-info: Show cache stats.
clear-minibuf: Clear the echo area.
dec-fill-column: Decrement fill-column by two.
execute-extended-command: Execute an internal command.
kill-telescope: Quit telescope.
inc-fill-column: Increment fill-column by two.
link-select: Select and visit a link using the minibuffer.
load-current-url: Edit the current URL.
load-url: Prompt for an URL.
next-page: Go forward in the page history.
olivetti-mode: Toggle olivetti mode (i.e. horizontal centering of the lines of the - window.)
other-window: Select the other window.
previous-page: Go backward in the page history.
push-button: Follow link at point, or toggle the visibility of the following - preformatted block if called when the cursor is on the heading of the - block.
push-button-new-tab: Follow link at point in a new tab.
redraw: Redraw the screen, useful if some background program messed up the - display.
reload-page: Reload the current page.
reply-last-input: Reply the last input request.
scroll-down: Scroll down by one visual page.
scroll-line-down: Scroll down by one line.
scroll-line-up: Scroll up by one line.
scroll-up: Scroll up by one visual page.
suspend-telescope: Suspend the current telescope session.
swiper: Jump to a line using the minibuffer.
toc: Jump to a heading using the minibuffer.
toggle-help: Toggle side window with help about available keys and their associated - interactive command.
toggle-pre-wrap: Toggle the wrapping of preformatted blocks.
write-buffer: Save the current buffer to the disk.

Minibuffer - commands

mini-abort: Abort the current minibuffer action.
mini-complete-and-exit: Complete the current minibuffer action.
mini-delete-backward-char: Delete the character before the point.
mini-delete-char: Delete the character after the point.
mini-goto-beginning: Select the first completion, if any.
mini-goto-end: Select the last completion, if any.
mini-kill-line: Delete from point until the end of the line.
mini-kill-whole-line: Delete the whole line.
mini-next-history-element: Load the previous history element.
mini-previous-history-element: Load the next history element.

Aliases

The following aliases are available during - execute-extended-command:

open: load-url
tabn: tab-next
tabnew: tab-new
tabp: tab-previous
q - and wq: kill-telescope
w: write-buffer

ENVIRONMENT

When telescope is started, it inspects the - following environment variables:

HOME: The user's login directory.
NO_COLORS: To decide whether to use colors or not. The content of the variable - doesn't matter.
TERM: The user's terminal name.
XDG_CACHE_HOME, - XDG_CONFIG_HOME, - XDG_DATA_HOME: If defined can alter the default location of the files used.

FILES

By default telescope follows the XDG Base - Directory Specification. However, if ~/.telescope - exists, XDG is ignored and all the files are stored inside it. The usage of - XDG_CACHE_HOME, - XDG_CONFIG_HOME and - XDG_DATA_HOME can further alter the location of - these files.

~/.config/telescope/config: Default configuration file.
~/.local/share/telescope/pages/about_*.gmi: Overrides for built-in about: pages.
~/.local/share/telescope/bookmarks.gmi: Bookmarks file.
~/.local/share/telescope/known_hosts: Hash of the certificates for all the known hosts. Each line contains three - fields: hostname with optional port number, hash of the certificate and a - numeric flag.
~/.cache/telescope/lock: Lock file used to prevent multiple instance of - telescope from running at the same time.
~/.cache/telescope/session: The list of tabs from the last session.

EXAMPLES

It's possible to browse “the small web” (i.e. simple - websites) by using programs like the duckling-proxy by defining a proxy in - ~/.config/telescope/config:

proxy http via "gemini://127.0.0.1:1965"
-proxy https via "gemini://127.0.0.1:1965"

To load telescope without any - configuration

telescope -c /dev/null

STANDARDS

XDG Base Directory - Specification, - https://specifications.freedesktop.org/basedir-spec/latest/.

ACKNOWLEDGEMENTS

The “Trust, but verify (where appropriate)” TOFU - scheme was firstly suggested by thfr: - gemini://thfr.info/gemini/modified-trust-verify.gmi.

AUTHORS

The telescope program was written by - Omar Polo - <op@omarpolo.com>.

CAVEATS

telescope assumes a UTF-8 environment and - doesn't try to cope with other encodings. This can cause strange rendering - issues if you're lucky, or possibly weird thing happening depending on your - locale and terminal emulator.

The algorithm used for text-wrapping is naive and doesn't really - work for languages that make heavily use of glyphs composed by multiple - UNICODE codepoints.

BUGS

There's no UI for out-of-band certificates validation.

- - - - - -

January 5, 2022

OpenBSD 7.1

- - blob - /dev/null blob + 7a59d27fc1b4d5d758b240672c3ac74a29ac4652 (mode 644) --- /dev/null +++ site/header.html @@ -0,0 +1,9 @@ + + + + TITLE | telescope + + + + + blob - 01d2fb8b21be50b1f0496b8d8736c9f2b2937516 (mode 644) blob + /dev/null --- site/telescope.1.txt +++ /dev/null @@ -1,591 +0,0 @@ -TELESCOPE(1) General Commands Manual TELESCOPE(1) - -NAME - telescope multi-protocol browser - -SYNOPSIS - telescope [-ChnSv] [-c config] [URL] - -DESCRIPTION - telescope is an interactive browser that supports the Finger, Gemini and - Gopher protocols. telescope features tabs, a minibuffer, interactive - completions, bookmarks and out-of-band TOFU verification. - - The arguments are as follows: - - -C, --colours Show all available colors and exit. This option can also - be spelled --colors. - - -c config Specify an alternative configuration file. By default - ~/.config/telescope/config is loaded. - - -h, --help Display version, usage and exit. - - -n Configtest mode. Only check the configuration file for - validity. - - -S, --safe Safe (or sandbox) mode. Prevent telescope from - writing files to the disk and to acquire the lock, - allowing to run multiple instances at the same time. - telescope still loads the session file and the custom - about pages. - - -v, --version Display version and exit. - -UI CONCEPTS - telescope interface is divided into four areas: the tabline, the body, - the modeline and the echoarea/minibuffer. - - The tabline is always at the top of the screen and displays the tabs - separated by a vertical line. When there are more tabs than the size of - the window allow to display, the characters < or > are shown at the - start/end of the tabline to indicate that there are more tabs in that - direction. - - The body occupies the majority of the visible area. It contains the - current page and optionally a side window. - - The modeline is the second to last row of the screen. It shows some - information about the page: a spinner when the page is loading, the trust - level, the document type, the scroll offset and the URL. - - The echoarea is usually the last line of the screen. Messages are often - showed there, and link addresses too. The echoarea is also used to - obtain input from the user. When commands like swiper or link-select are - invoked, the minibuffer area grows to show possible completions. - -TOFU - telescope aims to use the Trust, but Verify (where appropriate) - approach for TOFU (Trust On First Use). The idea is to define three - level of verification for a certificate: - - untrusted (!) the server fingerprint does NOT match the stored - value. - - trusted (v) the server fingerprint matches the store one. - - verified (V) the fingerprint matches and has been verified out-of- - band. - - The trust level of the page is indicated in the modeline with the - indicated character. - - Most of the time the trusted level is enough, but where is appropriate - users should be able to verify out-of-band the certificate. - - At the moment, there is no built-in support for an out-of-band - verification though. - -SUPPORTED PROTOCOLS - The following protocols are supported: - - about: About pages are telescope internal page. See about:about for - a list of all these pages. - - file:// File types know to telescope, such as .gmi, .gemini, .txt, - .md, .markdown, .diff or .patch, can be viewed inside the - application. Types of local files are detected solely based - on the file extension. On some systems, such as OpenBSD, only - files inside special directories (like /tmp or ~/Downloads) - are available. - - finger:// Finger URLs are interpreted as follows: - the host is determined by the host name portion of the URL - if the user portion of the URL is provided, it's - interpreted as the user to finger, otherwise the path - component will be used - thus finger://user@hostname and finger://hostname/user are - treated as the same URL. - - gemini:// Gemini is fully supported, with the exception of client- - certificates. - - gopher:// Gopher support is limited to items type 0, 1 and 7. All text - is assumed to be encoded in UTF-8 (or ASCII). - - User-entered URLs, given as argument on the command line or entered with - load-url, are intepreted with a simple heuristic: - if it's a proper absolute URL then use it as-is, - if it starts with ./ or / assume it's a file:// URL, - otherwise assume it's a Gemini URL. - -CONFIGURATION FILE - During the startup, telescope reads the configuration file at - ~/.config/telescope/config or ~/.telescope/config. - - It's possible to load a custom configuration file using the -c flag. - - telescope will also load a file called config-TERM, where TERM is the - name of the terminal type (i.e. the TERM environment variable), if it - exists. - - The format of the configuration file is fairly flexible. The current - line can be extended over multiple ones using a backslash (\). - Comments can be put anywhere in the file using a hash mark (#), and - extend to the end of the current line, but backslashes can't be used to - extend comments over multiple lines. - - The following constructs are available: - - bind map key cmd - Bind key to the function cmd in the keymap map. Valid values for - map are global-map (i.e. when the user is viewing a page) and - minibuffer-map (i.e. when the minibuffer has the focus.) key - follows the same syntax described in DEFAULT KEY BINDINGS and all - the possible functions are listed in INTERACTIVE COMMANDS. - - proxy proto via url - Use url as proxy for all URLs with protocol proto. url must be a - Gemini URI without path, query and fragment component. - - set opt = val - Set the option opt to the value val. Valid options are: - - autosave (integer) If greater than zero, save the session - after the specified amount of seconds after some - events happens (new or closed tabs, visited a link - ...) Defaults to 20. - dont-wrap-pre (integer) If nonzero, don't wrap preformatted - blocks. Defaults to 0. - download-path (string) The default download path. Defaults to - /tmp. - emojify-link (integer) If nonzero, when the text of a link - starts with an emoji followed by a space, use that - emoji as line prefix. Defaults to 1. - enable-colors (integer) If nonzero, enable colours. Defaults to - 0 if NO_COLORS is set, 1 otherwise. - fill-column (integer) If greater than zero, lines of text will - be formatted in a way that don't exceed the given - number of columns. Defaults to 80. - fringe-ignore-offset - (integer) If nonzero, the fringe doesn't obey to - olivetti-mode. Defaults to 1. - hide-pre-blocks - (integer) If nonzero, hide by default the body of - the preformatted blocks. Defaults to zero. - push-button can be used to toggle the visibility - per-block. - hide-pre-closing-line - (integer) If nonzero, hide the closing line of - preformatted blocks. Defaults to 0. - hide-pre-context - (integer) If nonzero, hide the start and end line - of the preformatted blocks. If both hide-pre- - context and hide-pre-blocks are nonzero, - preformatted blocks are irremediably hidden. - Defaults to zero. - new-tab-url (string) URL for the new tab page. Defaults to - about:new. - max-killed-tabs - (integer) The maximum number of closed tabs to - keep track of, defaults to 10. Must be a positive - number; if zero, don't save closed tabs at all. - olivetti-mode (integer) If nonzero, enable olivetti-mode - Defaults to 1. - tab-bar-show (integer) If tab-bar-show is -1 hide the tab bar - permanently, if 0 show it unconditionally. If - it's 1, show the bar only when there is more than - one tab. Defaults to 1. - update-title (integer) If nonzero, set the terminal title to - the page title. Defaults to 1. - - style name option - Change the styling of the element identified by name. Multiple - options may be specified within curly braces. Valid style - identifiers are: - line the area outside the lines in the - body of the page. - line.compl the completions. - line.compl.current the current completion. - line.help text in the *Help* buffer. - line.download.ongoing an ongoing download - line.download.done a completed download - line.download.info informational text in the - *Downloads* buffer. - line.fringe (virtual) lines draw after the end - of a buffer. - line.text text lines. - line.link link lines. - line.title1..3 headings - line.item item lines. - line.quote quotes. - line.pre.start the heading of a preformatted block. - line.pre the content of a preformatted block. - line.pre.end the closing line of a preformatted - block. - download the download pane - minibuffer the minibuffer. - modeline the modeline. - tabline the tabline. - tabline.tab the non-focused tabs. - tabline.current the focused tab. - - Valid options are: - - attr prefix [line [trail]] - Sets the text attributes. If only one value is given, - line and trail default to that; if two values are given - then trail defaults to prefix. Each attribute is a - comma-separated list of keywords: - normal no attributes. - standout best highlighting mode for the terminal. - underline underlines the text. - reverse reverses background/foreground colors. - blink makes the text blinking. - dim half bright. - bold extra bright or bold. - - Only the style identifiers with the line. prefix accept - up to three attributes. The other will only use the - first one given. - - bg prefix [line [trail]] - Sets the background color. Follows the same behaviour as - attr regarding the optional parameters. The colour is - one of black, red, green, yellow, blue, magenta, cyan and - white; colour0 to colour255 (or color0 to color255) from - the 256-colour set; default for the default colour. - - fg prefix [line [trail]] - Sets the foreground color. It behaves just like bg. - - prefix prfx [cont] - Sets the prefix for the current line type to prfx and - cont as the prefix for the continuation lines (i.e. when - a long line gets wrapped.) If cont is not given its value - will be the same of prfx. - -DEFAULT KEY BINDINGS - The default key bindings are very similar to GNU Emacs, but care has been - taken to include also bindings familiar for vi(1) and CUA users. In - the following examples, C-x means Control-x, M-x means Meta-x, where the - Meta key may be either a special key on the keyboard or the ALT key; - otherwise ESC followed by the key X works as well, and C-M-x means to - press the key X together with both Control and Meta. - - Keys are usually a single character, like p or n, but some special - keys are accepted as well. - - Up arrow - Down arrow - Left arrow - Right arrow - Previous page/Page up - Next page/Page down - Home - End - thru Function keys - del or backspace Backspace - esc Escape - space or spc Space - enter or ret Enter - tab Tab - backtab Depends on the configuration of the terminal - emulator; usually shift tab. - - GNU Emacs-like keys - C-p previous-line - C-n next-line - C-f forward-char - C-b backward-char - M-{ backward-paragraph - M-} forward-paragraph - C-a move-beginning-of-line - C-e move-end-of-line - M-v, M-space scroll-up - C-v, space scroll-down - M-< beginning-of-buffer - M-> end-of-buffer - C-x C-c kill-telescope - C-x C-w write-buffer - C-g clear-minibuf - M-x execute-extended-command - C-c { dec-fill-column - C-c } inc-fill-column - C-c p previous-heading - C-c n next-heading - > load-url - < load-current-url - C-x C-f load-url - C-x M-f load-current-url - C-x o other-window - C-x t 0 tab-close - C-x t 1 tab-close-other - C-x t 2 tab-new - C-x t o tab-next - C-x t O tab-previous - C-x t m tab-move - C-x t M tab-move-to - B, C-M-b previous-page - F, C-M-f next-page - a bookmark-page - list-bookmarks - C-z suspend-telescope - - vi(1)-like keys - k previous-line - j next-line - l forward-char - h backward-char - { backward-paragraph - } forward-paragraph - ^ move-beginning-of-line - $ move-end-of-line - K scroll-line-up - J scroll-line-down - g g beginning-of-buffer - G end-of-buffer - g D tab-close - g N tab-new - g t tab-next - g T tab-previous - g M-t tab-move - g M-T tab-move-to - H previous-page - L next-page - u tab-undo-close - q kill-telescope - ESC clear-minibuf - : execute-extended-command - - CUA-like keys - previous-line - next-line - forward-char - backward-char - move-beginning-of-line - move-end-of-line - scroll-up - scroll-down - C-w tab-close - C-t tab-new - M- tab-previous - M- tab-next - del previous-page - M- previous-page - M- next-page - reload-page - r reload-page - - Neither Emacs nor vi specific - toggle-help - enter push-button - M-enter push-button-new-tab - M-tab previous-button - backtab previous-button - tab next-button - M-t tab-select - [ tab-previous - ] tab-next - M-[ tab-move-to - M-] tab-move - M-l link-select - M-/ swiper - M-r reply-last-input - - Minibuffer-specific keys - enter mini-complete-and-exit - C-g mini-abort - ESC mini-abort - C-d mini-delete-char - del mini-delete-backward-char - backspace mini-delete-backward-char - C-h mini-delete-backward-char - C-b backward-char - C-f forward-char - backward-char - forward-char - C-e move-end-of-line - C-a move-beginning-of-line - move-end-of-line - move-beginning-of-line - C-k mini-kill-line - C-u mini-kill-whole-line - M-p mini-previous-history-element - M-n mini-next-history-element - C-p previous-completion - C-n next-completion - previous-completion - next-completion - tab insert-current-candidate - M-< mini-goto-beginning - M-> mini-goto-end - -INTERACTIVE COMMANDS - Follows the documentation for the interactive commands. These commands - can be bound to a key or executed with execute-extended-command. - - Movement commands - backward-char Move point one character backward. - backward-paragraph Move point one paragraph backward. - beginning-of-buffer Move point to the beginning of the buffer. - end-of-buffer Move point to the end of the buffer. - forward-char Move point one character forward. - forward-paragraph Move point one paragraph forward. - insert-current-candidate Copy the current selection text as minibuffer - input. - move-beginning-of-line Move point at the beginning of the current - (visual) line. - move-end-of-line Move point at the end of the current (visual) - line. - next-button Move point to the next link. - next-completion Select the next completion. - next-heading Move point to the next heading. - next-line Move point to the next (visual) line, in the - same column if possible. - previous-button Move point to the previous link. - previous-completion Select the previous completion. - previous-heading Move point to the previous heading. - previous-line Move point to the previous (visual) line. - - Bookmark-related commands - bookmark-page Save a page in the bookmark file. It preloads - the minibuffer with the current URL. - list-bookmarks Load the bookmarks page. - - Tab-related commands - tab-close Close the current tab. - tab-close-other Close all tabs but the current one. - tab-move Move the current tab after the next one, - wrapping around if needed. - tab-move-to Move the current tab before the previous one, - wrapping around if needed. - tab-new Open a new tab. - tab-next Focus next tab, wrapping around eventually. - tab-previous Focus the previous tab, wrapping around - eventually. - tab-select Switch to a tab using the minibuffer. - tab-undo-close Re-open the most recently closed tab, if any. - - Misc commands - cache-info Show cache stats. - clear-minibuf Clear the echo area. - dec-fill-column Decrement fill-column by two. - execute-extended-command Execute an internal command. - kill-telescope Quit telescope. - inc-fill-column Increment fill-column by two. - link-select Select and visit a link using the minibuffer. - load-current-url Edit the current URL. - load-url Prompt for an URL. - next-page Go forward in the page history. - olivetti-mode Toggle olivetti mode (i.e. horizontal centering - of the lines of the window.) - other-window Select the other window. - previous-page Go backward in the page history. - push-button Follow link at point, or toggle the visibility - of the following preformatted block if called - when the cursor is on the heading of the block. - push-button-new-tab Follow link at point in a new tab. - redraw Redraw the screen, useful if some background - program messed up the display. - reload-page Reload the current page. - reply-last-input Reply the last input request. - scroll-down Scroll down by one visual page. - scroll-line-down Scroll down by one line. - scroll-line-up Scroll up by one line. - scroll-up Scroll up by one visual page. - suspend-telescope Suspend the current telescope session. - swiper Jump to a line using the minibuffer. - toc Jump to a heading using the minibuffer. - toggle-help Toggle side window with help about available - keys and their associated interactive command. - toggle-pre-wrap Toggle the wrapping of preformatted blocks. - write-buffer Save the current buffer to the disk. - - Minibuffer commands - mini-abort Abort the current minibuffer action. - mini-complete-and-exit Complete the current minibuffer action. - mini-delete-backward-char - Delete the character before the point. - mini-delete-char Delete the character after the point. - mini-goto-beginning Select the first completion, if any. - mini-goto-end Select the last completion, if any. - mini-kill-line Delete from point until the end of the line. - mini-kill-whole-line Delete the whole line. - mini-next-history-element - Load the previous history element. - mini-previous-history-element - Load the next history element. - - Aliases - The following aliases are available during execute-extended-command: - open load-url - tabn tab-next - tabnew tab-new - tabp tab-previous - q and wq kill-telescope - w write-buffer - -ENVIRONMENT - When telescope is started, it inspects the following environment - variables: - - HOME The user's login directory. - - NO_COLORS To decide whether to use colors or not. The content of the - variable doesn't matter. - - TERM The user's terminal name. - - XDG_CACHE_HOME, XDG_CONFIG_HOME, XDG_DATA_HOME - If defined can alter the default location of the files used. - -FILES - By default telescope follows the XDG Base Directory Specification. - However, if ~/.telescope exists, XDG is ignored and all the files are - stored inside it. The usage of XDG_CACHE_HOME, XDG_CONFIG_HOME and - XDG_DATA_HOME can further alter the location of these files. - - ~/.config/telescope/config - Default configuration file. - ~/.local/share/telescope/pages/about_*.gmi - Overrides for built-in about: pages. - ~/.local/share/telescope/bookmarks.gmi - Bookmarks file. - ~/.local/share/telescope/known_hosts - Hash of the certificates for all the known hosts. Each line - contains three fields: hostname with optional port number, hash - of the certificate and a numeric flag. - ~/.cache/telescope/lock - Lock file used to prevent multiple instance of telescope from - running at the same time. - ~/.cache/telescope/session - The list of tabs from the last session. - -EXAMPLES - It's possible to browse the small web (i.e. simple websites) by using - programs like the duckling-proxy by defining a proxy in - ~/.config/telescope/config: - - proxy http via "gemini://127.0.0.1:1965" - proxy https via "gemini://127.0.0.1:1965" - - To load telescope without any configuration - - telescope -c /dev/null - -STANDARDS - XDG Base Directory Specification, - https://specifications.freedesktop.org/basedir-spec/latest/. - -ACKNOWLEDGEMENTS - The Trust, but verify (where appropriate) TOFU scheme was firstly - suggested by thfr: gemini://thfr.info/gemini/modified-trust-verify.gmi. - -AUTHORS - The telescope program was written by Omar Polo . - -CAVEATS - telescope assumes a UTF-8 environment and doesn't try to cope with other - encodings. This can cause strange rendering issues if you're lucky, or - possibly weird thing happening depending on your locale and terminal - emulator. - - The algorithm used for text-wrapping is naive and doesn't really work for - languages that make heavily use of glyphs composed by multiple UNICODE - codepoints. - -BUGS - There's no UI for out-of-band certificates validation. - -OpenBSD 7.1 January 5, 2022 OpenBSD 7.1 blob - /dev/null blob + 1fbed6ffab6a3c8f0c5749ed0bc0f23d4e80c31e (mode 644) Binary files /dev/null and site/logo.png differ blob - /dev/null blob + 6bfce467d643df97843c961798ba94e767ec4c72 (mode 644) --- /dev/null +++ site/mandoc.css @@ -0,0 +1,368 @@ +/* $OpenBSD: mandoc.css,v 1.39 2022/07/06 14:27:55 schwarze Exp $ */ +/* + * Standard style sheet for mandoc(1) -Thtml and man.cgi(8). + * + * Written by Ingo Schwarze . + * I place this file into the public domain. + * Permission to use, copy, modify, and distribute it for any purpose + * with or without fee is hereby granted, without any conditions. + */ + +/* Global defaults. */ + +html { max-width: 65em; + --bg: #FFFFFF; + --fg: #000000; } +body { background: var(--bg); + color: var(--fg); + font-family: Helvetica,Arial,sans-serif; } +h1, h2 { font-size: 110%; } +table { margin-top: 0em; + margin-bottom: 0em; + border-collapse: collapse; } +/* Some browsers set border-color in a browser style for tbody, + * but not for table, resulting in inconsistent border styling. */ +tbody { border-color: inherit; } +tr { border-color: inherit; } +td { vertical-align: top; + padding-left: 0.2em; + padding-right: 0.2em; + border-color: inherit; } +ul, ol, dl { margin-top: 0em; + margin-bottom: 0em; } +li, dt { margin-top: 1em; } +pre { font-family: inherit; } + +.permalink { border-bottom: thin dotted; + color: inherit; + font: inherit; + text-decoration: inherit; } +* { clear: both } + +/* Search form and search results. */ + +fieldset { border: thin solid silver; + border-radius: 1em; + text-align: center; } +input[name=expr] { + width: 25%; } + +table.results { margin-top: 1em; + margin-left: 2em; + font-size: smaller; } + +/* Header and footer lines. */ + +div[role=doc-pageheader] { + display: flex; + border-bottom: 1px dotted #808080; + margin-bottom: 1em; + font-size: smaller; } +.head-ltitle { flex: 1; } +.head-vol { flex: 0 1 auto; + text-align: center; } +.head-rtitle { flex: 1; + text-align: right; } + +div[role=doc-pagefooter] { + display: flex; + justify-content: space-between; + border-top: 1px dotted #808080; + margin-top: 1em; + font-size: smaller; } +.foot-left { flex: 1; } +.foot-date { flex: 0 1 auto; + text-align: center; } +.foot-os { flex: 1; + text-align: right; } + +/* Sections and paragraphs. */ + +main { margin-left: 3.8em; } +.Nd { } +section.Sh { } +h2.Sh { margin-top: 1.2em; + margin-bottom: 0.6em; + margin-left: -3.2em; } +section.Ss { } +h3.Ss { margin-top: 1.2em; + margin-bottom: 0.6em; + margin-left: -1.2em; + font-size: 105%; } +.Pp { margin: 0.6em 0em; } +.Sx { } +.Xr { } + +/* Displays and lists. */ + +.Bd { } +.Bd-indent { margin-left: 3.8em; } + +.Bl-bullet { list-style-type: disc; + padding-left: 1em; } +.Bl-bullet > li { } +.Bl-dash { list-style-type: none; + padding-left: 0em; } +.Bl-dash > li:before { + content: "\2014 "; } +.Bl-item { list-style-type: none; + padding-left: 0em; } +.Bl-item > li { } +.Bl-compact > li { + margin-top: 0em; } + +.Bl-enum { padding-left: 2em; } +.Bl-enum > li { } +.Bl-compact > li { + margin-top: 0em; } + +.Bl-diag { } +.Bl-diag > dt { + font-style: normal; + font-weight: bold; } +.Bl-diag > dd { + margin-left: 0em; } +.Bl-hang { } +.Bl-hang > dt { } +.Bl-hang > dd { + margin-left: 5.5em; } +.Bl-inset { } +.Bl-inset > dt { } +.Bl-inset > dd { + margin-left: 0em; } +.Bl-ohang { } +.Bl-ohang > dt { } +.Bl-ohang > dd { + margin-left: 0em; } +.Bl-tag { margin-top: 0.6em; + margin-left: 5.5em; } +.Bl-tag > dt { + float: left; + margin-top: 0em; + margin-left: -5.5em; + padding-right: 0.5em; + vertical-align: top; } +.Bl-tag > dd { + clear: right; + column-count: 1; /* Force block formatting context. */ + width: 100%; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0.6em; + vertical-align: top; } +.Bl-compact { margin-top: 0em; } +.Bl-compact > dd { + margin-bottom: 0em; } +.Bl-compact > dt { + margin-top: 0em; } + +.Bl-column { } +.Bl-column > tbody > tr { } +.Bl-column > tbody > tr > td { + margin-top: 1em; } +.Bl-compact > tbody > tr > td { + margin-top: 0em; } + +.Rs { font-style: normal; + font-weight: normal; } +.RsA { } +.RsB { font-style: italic; + font-weight: normal; } +.RsC { } +.RsD { } +.RsI { font-style: italic; + font-weight: normal; } +.RsJ { font-style: italic; + font-weight: normal; } +.RsN { } +.RsO { } +.RsP { } +.RsQ { } +.RsR { } +.RsT { text-decoration: underline; } +.RsU { } +.RsV { } + +.eqn { } +.tbl td { vertical-align: middle; } + +.HP { margin-left: 3.8em; + text-indent: -3.8em; } + +/* Semantic markup for command line utilities. */ + +table.Nm { } +code.Nm { font-style: normal; + font-weight: bold; + font-family: inherit; } +.Fl { font-style: normal; + font-weight: bold; + font-family: inherit; } +.Cm { font-style: normal; + font-weight: bold; + font-family: inherit; } +.Ar { font-style: italic; + font-weight: normal; } +.Op { display: inline flow; } +.Ic { font-style: normal; + font-weight: bold; + font-family: inherit; } +.Ev { font-style: normal; + font-weight: normal; + font-family: monospace; } +.Pa { font-style: italic; + font-weight: normal; } + +/* Semantic markup for function libraries. */ + +.Lb { } +code.In { font-style: normal; + font-weight: bold; + font-family: inherit; } +a.In { } +.Fd { font-style: normal; + font-weight: bold; + font-family: inherit; } +.Ft { font-style: italic; + font-weight: normal; } +.Fn { font-style: normal; + font-weight: bold; + font-family: inherit; } +.Fa { font-style: italic; + font-weight: normal; } +.Vt { font-style: italic; + font-weight: normal; } +.Va { font-style: italic; + font-weight: normal; } +.Dv { font-style: normal; + font-weight: normal; + font-family: monospace; } +.Er { font-style: normal; + font-weight: normal; + font-family: monospace; } + +/* Various semantic markup. */ + +.An { } +.Lk { } +.Mt { } +.Cd { font-style: normal; + font-weight: bold; + font-family: inherit; } +.Ad { font-style: italic; + font-weight: normal; } +.Ms { font-style: normal; + font-weight: bold; } +.St { } +.Ux { } + +/* Physical markup. */ + +.Bf { display: inline flow; } +.No { font-style: normal; + font-weight: normal; } +.Em { font-style: italic; + font-weight: normal; } +.Sy { font-style: normal; + font-weight: bold; } +.Li { font-style: normal; + font-weight: normal; + font-family: monospace; } + +/* Tooltip support. */ + +h2.Sh, h3.Ss { position: relative; } +.An, .Ar, .Cd, .Cm, .Dv, .Em, .Er, .Ev, .Fa, .Fd, .Fl, .Fn, .Ft, +.Ic, code.In, .Lb, .Lk, .Ms, .Mt, .Nd, code.Nm, .Pa, .Rs, +.St, .Sx, .Sy, .Va, .Vt, .Xr { + display: inline flow; + position: relative; } + +.An::before { content: "An"; } +.Ar::before { content: "Ar"; } +.Cd::before { content: "Cd"; } +.Cm::before { content: "Cm"; } +.Dv::before { content: "Dv"; } +.Em::before { content: "Em"; } +.Er::before { content: "Er"; } +.Ev::before { content: "Ev"; } +.Fa::before { content: "Fa"; } +.Fd::before { content: "Fd"; } +.Fl::before { content: "Fl"; } +.Fn::before { content: "Fn"; } +.Ft::before { content: "Ft"; } +.Ic::before { content: "Ic"; } +code.In::before { content: "In"; } +.Lb::before { content: "Lb"; } +.Lk::before { content: "Lk"; } +.Ms::before { content: "Ms"; } +.Mt::before { content: "Mt"; } +.Nd::before { content: "Nd"; } +code.Nm::before { content: "Nm"; } +.Pa::before { content: "Pa"; } +.Rs::before { content: "Rs"; } +h2.Sh::before { content: "Sh"; } +h3.Ss::before { content: "Ss"; } +.St::before { content: "St"; } +.Sx::before { content: "Sx"; } +.Sy::before { content: "Sy"; } +.Va::before { content: "Va"; } +.Vt::before { content: "Vt"; } +.Xr::before { content: "Xr"; } + +.An::before, .Ar::before, .Cd::before, .Cm::before, +.Dv::before, .Em::before, .Er::before, .Ev::before, +.Fa::before, .Fd::before, .Fl::before, .Fn::before, .Ft::before, +.Ic::before, code.In::before, .Lb::before, .Lk::before, +.Ms::before, .Mt::before, .Nd::before, code.Nm::before, +.Pa::before, .Rs::before, +h2.Sh::before, h3.Ss::before, .St::before, .Sx::before, .Sy::before, +.Va::before, .Vt::before, .Xr::before { + opacity: 0; + transition: .15s ease opacity; + pointer-events: none; + position: absolute; + bottom: 100%; + box-shadow: 0 0 .35em var(--fg); + padding: .15em .25em; + white-space: nowrap; + font-family: Helvetica,Arial,sans-serif; + font-style: normal; + font-weight: bold; + background: var(--bg); + color: var(--fg); } +.An:hover::before, .Ar:hover::before, .Cd:hover::before, .Cm:hover::before, +.Dv:hover::before, .Em:hover::before, .Er:hover::before, .Ev:hover::before, +.Fa:hover::before, .Fd:hover::before, .Fl:hover::before, .Fn:hover::before, +.Ft:hover::before, .Ic:hover::before, code.In:hover::before, +.Lb:hover::before, .Lk:hover::before, .Ms:hover::before, .Mt:hover::before, +.Nd:hover::before, code.Nm:hover::before, .Pa:hover::before, +.Rs:hover::before, h2.Sh:hover::before, h3.Ss:hover::before, .St:hover::before, +.Sx:hover::before, .Sy:hover::before, .Va:hover::before, .Vt:hover::before, +.Xr:hover::before { + opacity: 1; + pointer-events: inherit; } + +/* Overrides to avoid excessive margins on small devices. */ + +@media (max-width: 37.5em) { +main { margin-left: 0.5em; } +h2.Sh, h3.Ss { margin-left: 0em; } +.Bd-indent { margin-left: 2em; } +.Bl-hang > dd { + margin-left: 2em; } +.Bl-tag { margin-left: 2em; } +.Bl-tag > dt { + margin-left: -2em; } +.HP { margin-left: 2em; + text-indent: -2em; } +} + +/* Overrides for a dark color scheme for accessibility. */ + +@media (prefers-color-scheme: dark) { +html { --bg: #1E1F21; + --fg: #EEEFF1; } +:link { color: #BAD7FF; } +:visited { color: #F6BAFF; } +} blob - /dev/null blob + dd06bc51a0deff1384a56013dfafbfebe9ea4f11 (mode 755) --- /dev/null +++ site/menu.pl @@ -0,0 +1,32 @@ +#!/usr/bin/env perl + +use v5.10; +use strict; +use warnings; + +my $page = shift or die 'missing page'; +my @pages = (); + +while (<>) { + chomp; + @pages = (@pages, $_); +} + +say ""; blob - /dev/null blob + c4f375d1422033f65e993b4deab8887d659675d8 (mode 644) --- /dev/null +++ site/style.css @@ -0,0 +1,182 @@ +body { + font-family: monospace; + font-size: 14px; + max-width: 780px; + margin: 0 auto; + padding: 20px; +} + +.banner { + display: flex; + flex-direction: row; + justify-content: center; +} + +.banner pre { + background-color: transparent; +} + +h1::before { + content: "# "; +} + +h2 { + margin-top: 40px; +} + +h2::before { + content: "## "; +} + +h3::before { + content: "### "; +} + +.gallery { + display: flex; + flex-direction: row; + flex-wrap: wrap; + justify-content: space-around; +} + +.gallery figure { + width: 40%; + margin: 1rem; +} + +img { + max-width: 100%; + height: auto; +} + +.repology { + text-align: center; +} + +@media only screen and (min-width: 768px) { + .repology { + text-align: unset; + float: right; + } +} + +blockquote { + margin: 0; + padding: 0; +} + +blockquote::before { + content: "> "; +} + +blockquote p { + font-style: italic; + display: inline; +} + +p.link::before { + content: "→ "; +} + +strong::before { content: "*" } +strong::after { content: "*" } + +hr { + border: 0; + height: 1px; + background-color: #222; + width: 100%; + display: block; + margin: 2em auto; +} + +img { + margin: 10px; + display: inline-block; +} + +section.with-image { + margin-top: 1rem; +} + +@media only screen and (min-width: 768px) { + section.with-image { + display: flex; + flex-direction: row; + } +} + +section.with-image img { + object-fit: contain; +} + +section.with-image div { + overflow: auto; +} + +pre { + overflow: auto; + padding: 1rem; + background-color: #f0f0f0; + border-radius: 3px; +} + +pre.banner { + display: flex; + flex-direction: row; + justify-content: center; +} + +code, kbd { + color: #9d109d; +} + +ul.link-list { + list-style: disclosure-closed; +} + +footer { + margin-top: 4rem; + font-size: 0.8rem; + border-top: 1px solid; +} + +@media (prefers-color-scheme: dark) { + body { + background-color: #222; + color: white; + } + + a { + color: aqua; + } + + hr { + background-color: #ddd; + } + + pre { + background-color: #353535; + } + + code, kbd { + color: #ff4cff; + } + + img { + opacity: 0.8; + transition: opacity .2s ease-in-out; + } + + img:hover { + opacity: 1; + } +} + +@media (max-width: 400px) { + pre.banner { font-size: 9px; } +} + +@media (max-width: 500px) { + pre.banner { font-size: 10px; } +} blob - /dev/null blob + e2506f108b914844d1ebee9c0ec1d7f8c494cb00 (mode 755) --- /dev/null +++ site/subst @@ -0,0 +1,46 @@ +#!/usr/bin/env perl +# +# Copyright (c) 2022 Omar Polo +# +# Permission to use, copy, modify, and distribute this software for any +# purpose with or without fee is hereby granted, provided that the above +# copyright notice and this permission notice appear in all copies. +# +# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +# +# subst -- filter that replaces key=values pairs +# +# usage: subst key1=val1 [... keyn=valn] [files...] +# +# Use `--' before the first file if it may contain an = in its name. +# If no files are given, read and substitute from standard input. + +use v5.10; +use strict; +use warnings; + +my @args = (); + +while (1) { + $_ = shift; + last if !$_; + + if ($_ eq '--') { + last; + } elsif ($_ !~ m/=/) { + unshift @ARGV, $_; + last; + } + + my ($match, $repl) = m/^([^\s]*)=(.*)$/; + push @args, "-e", "s!$match!$repl!g"; +} + +# OK, shelling out to sed is a bit lame... +exec "sed", @args, @ARGV;