aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2019-08-30 18:16:12 +0000
committerDaniel Eklöf <daniel@ekloef.se>2019-08-30 18:16:12 +0000
commite673bd4ab03d8faca2282a1bc134455458b8d3fe (patch)
tree1cb7f2fdd891183a8a68e81e8d01ae84293ce404 /README.md
parentosc: xparsecolor: parse 'legacy' colors (diff)
parentsearch: ctrl+s searches forward (diff)
Merge branch 'scrollback-search'
Diffstat (limited to 'README.md')
-rw-r--r--README.md171
1 files changed, 135 insertions, 36 deletions
diff --git a/README.md b/README.md
index 0fafc587..923bb34d 100644
--- a/README.md
+++ b/README.md
@@ -2,42 +2,56 @@
**foot** is a fast Wayland terminal emulator.
+## Index
-## Requirements
+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)
-### Running
-* fontconfig
-* freetype
-* pixman
-* wayland (_client_ and _cursor_ libraries)
-* xkbcommon
+## Features
+* Fast (**TODO** insert benchmark results here)
+* Wayland native
+* DE agnostic
+* User configurable font fallback
+* Scrollback search
+* Color emoji support
-### Building
-In addition to the dev variant of the packages above, you need:
+## Non-features
-* meson
-* ninja
-* wayland protocols
-* ncurses
-* scdoc
+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
## Fonts
-**foot** supports all fonts that can be loaded by freetype, including
-**bitmap** fonts and **color emoji** 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).
+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.
-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).
+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.
@@ -51,20 +65,105 @@ 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_
+* <kbd>shift</kbd>+<kbd>page up</kbd>/<kbd>page down</kbd>
+
+ Scroll up/down in history
+
+* <kbd>ctrl</kbd>+<kbd>shift</kbd>+<kbd>c</kbd>
+ Copy selected text to the _clipboard_
+
+* <kbd>ctrl</kbd>+<kbd>shift</kbd>+<kbd>v</kbd>
+
+ Paste from _clipboard_
+
+* <kbd>ctrl</kbd>+<kbd>shift</kbd>+<kbd>r</kbd>
+
+ Start a scrollback search
+
+While doing a scrollback search, the following shortcuts are
+available:
+
+* <kbd>ctrl</kbd>+<kbd>r</kbd>
+
+ Search for next match
+
+* <kbd>escape</kbd>
+
+ Cancel the search
+
+* <kbd>ctrl</kbd>+<kbd>g</kbd>
+
+ Cancel the search (same as <kbd>escape</kbd>)
+
+* <kbd>return</kbd>
+
+ 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
+* <kbd>left</kbd> - **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 <kbd>shift</kbd>.
+
+* <kbd>left</kbd> - **double-click**
+
+ Selects the _word_ (separated by spaces, period, comma, parenthesis
+ etc) under the pointer. Hold <kbd>ctrl</kbd> to select everything
+ under the pointer up to, and until, the next space characters.
+
+* <kbd>left</kbd> - **triple-click**
+
+ Selects the entire row
+
+* <kbd>middle</kbd>
+
+ 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` (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
+
+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.