From 6fa1734468e0663c579cc0ab21f080e3c8be7262 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Tue, 27 Aug 2019 21:20:24 +0200 Subject: README: document keyboard shortcuts related to scrollback searching --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 0fafc587..23afee5b 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,15 @@ is **not** possible to define new key bindings. * `shift+page up/down` - scroll up/down in history * `ctrl+shift+c` - copy selected text to the _clipboard_ * `ctrl+shift+v` - paste from _clipboard_ +* `ctrl+shift+r` - start a scrollback search + +While doing a scrollback search, the following shortcuts are +available: + +* `ctrl+r` - search for next match +* `esc` - cancel the search +* `ctrl+g` - cancel the search (same as `esc`) +* `return` - finish the search and put the current match to the primary selection ### Mouse -- cgit v1.3 From 425d221e02e2ef5b61e2487647a692b4cf8b9e95 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 22:40:44 +0200 Subject: README: try markup --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 23afee5b..008f85fd 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ is **not** possible to define new key bindings. ### Keyboard -* `shift+page up/down` - scroll up/down in history +* shift+page up/down` - scroll up/down in history * `ctrl+shift+c` - copy selected text to the _clipboard_ * `ctrl+shift+v` - paste from _clipboard_ * `ctrl+shift+r` - start a scrollback search -- cgit v1.3 From 03534a327cd862233f919c2fe7c04c2ff3267ba3 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 22:44:06 +0200 Subject: README: use for keyboard key combos --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 008f85fd..437f67a1 100644 --- a/README.md +++ b/README.md @@ -51,29 +51,29 @@ is **not** possible to define new key bindings. ### Keyboard -* shift+page up/down` - scroll up/down in history -* `ctrl+shift+c` - copy selected text to the _clipboard_ -* `ctrl+shift+v` - paste from _clipboard_ -* `ctrl+shift+r` - start a scrollback search +* shift+page up/page down - scroll up/down in history +* ctrl+shift+c - copy selected text to the _clipboard_ +* ctrl+shift+v - paste from _clipboard_ +* ctrl+shift+r, - start a scrollback search While doing a scrollback search, the following shortcuts are available: -* `ctrl+r` - search for next match -* `esc` - cancel the search -* `ctrl+g` - cancel the search (same as `esc`) -* `return` - finish the search and put the current match to the primary selection +* ctrl+r - search for next match +* escape - cancel the search +* ctrl+g - cancel the search (same as `esc`) +* return - finish the search and put the current match to the primary selection ### Mouse -* `left` - single-click: drag to select; when released, the selected +* left - **single-click**: drag to select; when released, the selected text is copied to the _primary_ selection. Note that this feature is normally disabled whenever the client has enabled mouse tracking, but can be forced by holding `shift`. -* `left` - double-click: selects the _word_ (separated by spaces, +* left - **double-click**: selects the _word_ (separated by spaces, period, comma, parenthesis etc) under the pointer. Hold `ctrl` to select everything under the pointer up to, and until, the next space characters. -* `left` - triple-click: selects the entire row -* `middle` - paste from _primary_ selection +* left - **triple-click**: selects the entire row +* middle - paste from _primary_ selection -- cgit v1.3 From 63da83a9cc253683eb74f50841a31f939a88dfcf Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 22:46:26 +0200 Subject: README: test indented paragraph in list --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 437f67a1..5df7b7a7 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,9 @@ is **not** possible to define new key bindings. ### Keyboard -* shift+page up/page down - scroll up/down in history +* shift+page up/page down + + scroll up/down in history * ctrl+shift+c - copy selected text to the _clipboard_ * ctrl+shift+v - paste from _clipboard_ * ctrl+shift+r, - start a scrollback search -- cgit v1.3 From ff7566c46d7debe9c96e6cb8f6b9bedf62c158f7 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 22:48:25 +0200 Subject: README: use poor man's markdown version of definition lists --- README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 47 insertions(+), 18 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5df7b7a7..3966fde0 100644 --- a/README.md +++ b/README.md @@ -53,29 +53,58 @@ is **not** possible to define new key bindings. * shift+page up/page down - scroll up/down in history -* ctrl+shift+c - copy selected text to the _clipboard_ -* ctrl+shift+v - paste from _clipboard_ -* ctrl+shift+r, - start a scrollback search + scroll up/down in history + +* ctrl+shift+c + + copy selected text to the _clipboard_ + +* ctrl+shift+v + + paste from _clipboard_ + +* ctrl+shift+r + + start a scrollback search While doing a scrollback search, the following shortcuts are available: -* ctrl+r - search for next match -* escape - cancel the search -* ctrl+g - cancel the search (same as `esc`) -* return - finish the search and put the current match to the primary selection +* ctrl+r + + search for next match + +* escape + + cancel the search + +* ctrl+g + cancel the search (same as `esc`) + +* return + + finish the search and put the current match to the primary selection ### Mouse -* left - **single-click**: drag to select; when released, the selected - text is copied to the _primary_ selection. Note that this feature is - normally disabled whenever the client has enabled mouse tracking, - but can be forced by holding `shift`. -* left - **double-click**: selects the _word_ (separated by spaces, - period, comma, parenthesis etc) under the pointer. Hold `ctrl` to - select everything under the pointer up to, and until, the next space - characters. -* left - **triple-click**: selects the entire row -* middle - paste from _primary_ selection +* left - **single-click** + + drag to select; when released, the selected text is copied to the + _primary_ selection. Note that this feature is normally disabled + whenever the client has enabled mouse tracking, but can be forced by + holding `shift`. + +* left - **double-click** + + selects the _word_ (separated by spaces, period, comma, parenthesis + etc) under the pointer. Hold `ctrl` to select everything under the + pointer up to, and until, the next space characters. + +* left - **triple-click** + + selects the entire row + +* middle + + paste from _primary_ selection -- cgit v1.3 From 5c47fac893781c1dc538e94b90bfcd025bc06fae Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 22:49:33 +0200 Subject: README: upper case initial letters --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3966fde0..2a4f8822 100644 --- a/README.md +++ b/README.md @@ -53,58 +53,58 @@ is **not** possible to define new key bindings. * shift+page up/page down - scroll up/down in history + Scroll up/down in history * ctrl+shift+c - copy selected text to the _clipboard_ + Copy selected text to the _clipboard_ * ctrl+shift+v - paste from _clipboard_ + Paste from _clipboard_ * ctrl+shift+r - start a scrollback search + Start a scrollback search While doing a scrollback search, the following shortcuts are available: * ctrl+r - search for next match + Search for next match * escape - cancel the search + Cancel the search * ctrl+g - cancel the search (same as `esc`) + Cancel the search (same as `esc`) * return - finish the search and put the current match to the primary selection + Finish the search and put the current match to the primary selection ### Mouse * left - **single-click** - drag to select; when released, the selected text is copied to the + Drag to select; when released, the selected text is copied to the _primary_ selection. Note that this feature is normally disabled whenever the client has enabled mouse tracking, but can be forced by holding `shift`. * left - **double-click** - selects the _word_ (separated by spaces, period, comma, parenthesis + Selects the _word_ (separated by spaces, period, comma, parenthesis etc) under the pointer. Hold `ctrl` to select everything under the pointer up to, and until, the next space characters. * left - **triple-click** - selects the entire row + Selects the entire row * middle - paste from _primary_ selection + Paste from _primary_ selection -- cgit v1.3 From c8494e7efa016c3fd9056664e0534e6249265782 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 22:50:35 +0200 Subject: README: use for remaining keyboard key combos --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2a4f8822..10371158 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ available: * ctrl+g - Cancel the search (same as `esc`) + Cancel the search (same as escape) * return @@ -93,13 +93,13 @@ available: Drag to select; when released, the selected text is copied to the _primary_ selection. Note that this feature is normally disabled whenever the client has enabled mouse tracking, but can be forced by - holding `shift`. + holding shift. * left - **double-click** Selects the _word_ (separated by spaces, period, comma, parenthesis - etc) under the pointer. Hold `ctrl` to select everything under the - pointer up to, and until, the next space characters. + etc) under the pointer. Hold ctrl to select everything + under the pointer up to, and until, the next space characters. * left - **triple-click** -- cgit v1.3 From a6eec9a6a6dd70888ed6d03dbf3d2225f766450b Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 22:55:49 +0200 Subject: README: add a feature list --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 10371158..19998028 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,26 @@ **foot** is a fast Wayland terminal emulator. +## Features + +* Fast (**TODO** insert benchmark results here) +* Wayland native +* DE agnostic +* User configurable font fallback +* Scrollback search +* Color emoji support + + +## Non-features + +This is a non-exhaustive list of things some people might consider +being important features (i.e. _"must-haves"_), that are unlikely to +ever be supported by foot. + +* Tabs +* Multiple windows + + ## Requirements ### Running -- cgit v1.3 From da9b2d12e77263c6f280973551715a8b8a6513f6 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 23:00:49 +0200 Subject: README: re-write font section --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 19998028..27ab6f5b 100644 --- a/README.md +++ b/README.md @@ -47,17 +47,18 @@ In addition to the dev variant of the packages above, you need: ## Fonts -**foot** supports all fonts that can be loaded by freetype, including -**bitmap** fonts and **color emoji** fonts. - -Foot uses its own font fallback mechanism, rather than relying on -fontconfig's fallback. This is because fontconfig is quite bad at -selecting fallback fonts suitable for a terminal (i.e. monospaced -fonts). - -Instead, foot allows you to specify a font fallback list, where _each_ -font can be configured independently (for example, you can configure -the size for each font individually). +**foot** supports all fonts that can be loaded by _freetype_, +including **bitmap** fonts and **color emoji** fonts. + +Foot uses _fontconfig_ to locate and configure the font(s) to +use. Since fontconfig's fallback mechanism is imperfect, especially +for monospace fonts (it doesn't prefer monospace fonts even though the +requested font is one), foot allows you, the user, to configure the +fallback fonts to use. + +This also means you can configure _each_ fallback font individually; +you want _that_ fallback font to use _this_ size, and you want that +_other_ fallback font to be _italic_? No problem! If a glyph cannot be found in _any_ of the user configured fallback fonts, _then_ fontconfig's list is used. -- cgit v1.3 From 72d918da922c00acfbbb79e4495d5c52fd3ef2e6 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 23:02:18 +0200 Subject: README: more emphasis --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 27ab6f5b..a77dd271 100644 --- a/README.md +++ b/README.md @@ -112,9 +112,9 @@ available: * left - **single-click** Drag to select; when released, the selected text is copied to the - _primary_ selection. Note that this feature is normally disabled - whenever the client has enabled mouse tracking, but can be forced by - holding shift. + _primary_ selection. Note that this feature is normally **disabled** + whenever the client has enabled _mouse tracking_, but can be forced + by holding shift. * left - **double-click** -- cgit v1.3 From 9bdc3a84387d877af45bc4ad1dd902f9cd29f199 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 23:05:19 +0200 Subject: README: add index --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index a77dd271..98058003 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,18 @@ **foot** is a fast Wayland terminal emulator. +## Index + +1. [Features](#features) +1. [Non-features](#non-features) +1. [Requirements](#requirements) + 1. [Running](#running) + 1. [Building](#building) +1. [Fonts](#fonts) +1. [Shortcuts](#shortcuts) + 1. [Keyboard](#keyboard) + 1. [Mouse](#mouse) + ## Features -- cgit v1.3 From f43fb5f13f171ef778f635d14f172af3e6dba93b Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 23:05:38 +0200 Subject: README: hopefully fix nested lists --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 98058003..c79c9525 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@ 1. [Features](#features) 1. [Non-features](#non-features) 1. [Requirements](#requirements) - 1. [Running](#running) - 1. [Building](#building) + 1. [Running](#running) + 1. [Building](#building) 1. [Fonts](#fonts) 1. [Shortcuts](#shortcuts) - 1. [Keyboard](#keyboard) - 1. [Mouse](#mouse) + 1. [Keyboard](#keyboard) + 1. [Mouse](#mouse) ## Features -- cgit v1.3 From 8fa6b5fa2dc2d31700ce92391cfa7e095296f562 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 23:11:11 +0200 Subject: README: add an 'installation' section --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index c79c9525..dc08ce83 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,9 @@ 1. [Requirements](#requirements) 1. [Running](#running) 1. [Building](#building) +1. [Installing](#installing) + 1. [Arch Linux](#arch-linux) + 1. [Other](#other) 1. [Fonts](#fonts) 1. [Shortcuts](#shortcuts) 1. [Keyboard](#keyboard) @@ -57,6 +60,24 @@ In addition to the dev variant of the packages above, you need: * scdoc +## Installing + +### Arch Linux + +Use [makepkg](https://wiki.archlinux.org/index.php/Makepkg) to build +the bundled `PKGBUILD`. + + +### Other + +Foot uses _meson_. If you are unfamiliar with it, the official +[tutorial](https://mesonbuild.com/Tutorial.html) might be a good +starting point. + +I also recommend taking a look at that bundled Arch `PKGBUILD` file, +to see how it builds foot. + + ## Fonts **foot** supports all fonts that can be loaded by _freetype_, -- cgit v1.3 From 0c0deef4f0e02613270688478cd2b0b30fc3d110 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 23:12:39 +0200 Subject: README: re-arrange: put requirements+installation last --- README.md | 88 +++++++++++++++++++++++++++++++-------------------------------- 1 file changed, 44 insertions(+), 44 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index dc08ce83..c3060ee4 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,16 @@ 1. [Features](#features) 1. [Non-features](#non-features) +1. [Fonts](#fonts) +1. [Shortcuts](#shortcuts) + 1. [Keyboard](#keyboard) + 1. [Mouse](#mouse) 1. [Requirements](#requirements) 1. [Running](#running) 1. [Building](#building) 1. [Installing](#installing) 1. [Arch Linux](#arch-linux) 1. [Other](#other) -1. [Fonts](#fonts) -1. [Shortcuts](#shortcuts) - 1. [Keyboard](#keyboard) - 1. [Mouse](#mouse) ## Features @@ -38,46 +38,6 @@ ever be supported by foot. * Multiple windows -## Requirements - -### Running - -* fontconfig -* freetype -* pixman -* wayland (_client_ and _cursor_ libraries) -* xkbcommon - - -### Building - -In addition to the dev variant of the packages above, you need: - -* meson -* ninja -* wayland protocols -* ncurses -* scdoc - - -## Installing - -### Arch Linux - -Use [makepkg](https://wiki.archlinux.org/index.php/Makepkg) to build -the bundled `PKGBUILD`. - - -### Other - -Foot uses _meson_. If you are unfamiliar with it, the official -[tutorial](https://mesonbuild.com/Tutorial.html) might be a good -starting point. - -I also recommend taking a look at that bundled Arch `PKGBUILD` file, -to see how it builds foot. - - ## Fonts **foot** supports all fonts that can be loaded by _freetype_, @@ -162,3 +122,43 @@ available: * middle Paste from _primary_ selection + + +## Requirements + +### Running + +* fontconfig +* freetype +* pixman +* wayland (_client_ and _cursor_ libraries) +* xkbcommon + + +### Building + +In addition to the dev variant of the packages above, you need: + +* meson +* ninja +* wayland protocols +* ncurses +* scdoc + + +## Installing + +### Arch Linux + +Use [makepkg](https://wiki.archlinux.org/index.php/Makepkg) to build +the bundled `PKGBUILD`. + + +### Other + +Foot uses _meson_. If you are unfamiliar with it, the official +[tutorial](https://mesonbuild.com/Tutorial.html) might be a good +starting point. + +I also recommend taking a look at that bundled Arch `PKGBUILD` file, +to see how it builds foot. -- cgit v1.3 From 0c8e5d39b06c7c6b6628b63cae75c940054ecd73 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 23:13:56 +0200 Subject: README: clarify _how_ and _where_ makepkg is supposed to be run --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index c3060ee4..c3a9adb7 100644 --- a/README.md +++ b/README.md @@ -151,7 +151,8 @@ In addition to the dev variant of the packages above, you need: ### Arch Linux Use [makepkg](https://wiki.archlinux.org/index.php/Makepkg) to build -the bundled `PKGBUILD`. +the bundled `PKGBUILD` (just run `makepkg` in the source root +directory).. ### Other -- cgit v1.3 From f2fda437e78488037a171ca3b1d8bf29dcc528c2 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Thu, 29 Aug 2019 23:15:13 +0200 Subject: README: mention that the PKGBUILD requires a running wayland session --- README.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index c3a9adb7..923bb34d 100644 --- a/README.md +++ b/README.md @@ -154,6 +154,10 @@ Use [makepkg](https://wiki.archlinux.org/index.php/Makepkg) to build the bundled `PKGBUILD` (just run `makepkg` in the source root directory).. +Note that it will do a profiling-guided build, and that this requires +a running wayland session since it needs to run an intermediate build +of foot. + ### Other -- cgit v1.3