From 4b67394a5f84c1c8b0bdd803079f11a03981c693 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= Date: Sun, 7 Feb 2021 11:38:52 +0100 Subject: [PATCH] readme: document the new URL mode --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 12622c90..428d4958 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ The fast, lightweight and minimalistic Wayland terminal emulator. 1. [Scrollback search](#scrollback-search) 1. [Mouse](#mouse) 1. [Server (daemon) mode](#server-daemon-mode) +1. [URLs](#urls) 1. [Alt/meta](#alt-meta) 1. [Backspace](#backspace) 1. [Keypad](#keypad) @@ -252,6 +253,32 @@ desktop), and then run `footclient` instead of `foot` whenever you want to launch a new terminal. +## 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 the +`foot.ini` man page. + +`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 By default, foot prefixes _Meta characters_ with ESC. This corresponds