diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/foot.1.scd | 25 | ||||
| -rw-r--r-- | doc/foot.ini.5.scd | 34 |
2 files changed, 59 insertions, 0 deletions
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 diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd index 8684850b..5bf9bbf5 100644 --- a/doc/foot.ini.5.scd +++ b/doc/foot.ini.5.scd @@ -225,6 +225,10 @@ in this order: Default: _notify-send -a foot -i foot ${title} ${body}_. +*url-launch* + Command to execute when opening URLs. _${url}_ will be replaced + with the actual URL. Default: _xdg-open ${url}_. + *selection-target* Clipboard target to automatically copy selected text to. One of *none*, *primary*, *clipboard* or *both*. Default: _primary_. @@ -347,6 +351,15 @@ _alpha_ option. text. Note that *both* options must be set, or the default will be used. Default: _inverse foreground/background_. +*jump-labels* + To RRGGBB values specifying the foreground (text) and background + colors to use when rendering jump labels in URL mode. Default: + _regular0 regular3_. + +*urls* + Color to use for the underline used to highlight URLs in URL + mode. Default: _regular3_. + # SECTION: csd @@ -491,6 +504,16 @@ e.g. *search-start=none*. Default: _not bound_ +*show-urls-launch* + Enter URL mode, where all currently visible URLs are tagged with a + jump label with a key sequence that will open the URL. Default: + _Control+Shift+U_. + +*show-urls-copy* + Enter URL mode, where all currently visible URLs are tagged with a + jump label with a key sequence that will place the URL in the + clipboard. Default: _none_. + # SECTION: search-bindings @@ -569,6 +592,17 @@ scrollback search mode. The syntax is exactly the same as the regular Paste from the _primary selection_ into the search buffer. Default: _Shift+Insert_. + +# SECTION: url-bindings + +This section lets you override the default key bindings used in URL +mode. The syntax is exactly the same as the regular **key-bindings**. + +*cancel* + Exits URL mode without opening an URL. Default: _Control+g + Control+d Escape_. + + # SECTION: mouse-bindings This section lets you override the default mouse bindings. |
