From 0c847cfe7b5b18fa99078554123a2b2c9e9b0fa3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= Date: Sun, 7 Feb 2021 11:39:07 +0100 Subject: [PATCH] doc: foot.1: document the new URL mode --- doc/foot.1.scd | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/doc/foot.1.scd b/doc/foot.1.scd index 9099adc2..4965ca56 100644 --- a/doc/foot.1.scd +++ b/doc/foot.1.scd @@ -236,6 +236,31 @@ _Examples_: - Dina:weight=bold:slant=italic - Courier New:size=12 +# URLs + +Foot supports URL detection. But, unlike many other terminal +emulators, where URLs are highlighted when they are hovered and opened +by clicking on them, foot uses a keyboard driven approach. + +Pressing *ctrl*+*shift*+*u* enters _“URL mode”_, where all currently +visible URLs are underlined, and is associated with a +_“jump-label”_. The jump-label indicates the _key sequence_ +(e.g. *”AF”*) to use to activate the URL. + +The key binding can, of course, be customized, like all other key +bindings in foot. See *show-urls-launch* and *show-urls-copy* in +*foot.ini*(5). + +*show-urls-launch* by default opens the URL with *xdg-open*. This can +be changed with the *url-launch* option. + +*show-urls-copy* is an alternative to *show-urls-launch*, that changes +what activating an URL _does_; instead of opening it, it copies it to +the clipboard. It is unbound by default. + +Both the jump label colors, and the URL underline color can be +configured, independently. + # ALT/META CHARACTERS By default, foot prefixes meta characters with *ESC*. This corresponds