st/README.md

85 lines
3.4 KiB
Markdown
Raw Normal View History

2018-01-21 20:15:29 +01:00
# Luke's build of st - the simple (suckless) terminal
2009-05-10 14:17:09 +02:00
2019-05-08 17:26:11 +02:00
The [suckless terminal (st)](https://st.suckless.org/) with some additional features that make it literally the best terminal emulator ever:
## Unique features (using dmenu)
2019-05-08 17:38:15 +02:00
+ **follow urls** by pressing `alt-l`
+ **copy urls** in the same way with `alt-y`
+ **copy the output of commands** with `alt-o`
2019-05-08 17:26:11 +02:00
## Bindings for
+ scroll with `alt-↑/↓` or `alt-pageup/down` or `shift` while scrolling the mouse ([scroll](https://github.com/lukesmithxyz/scroll) must be installed)
2019-05-08 17:38:15 +02:00
+ OR **vim-bindings**: scroll up/down in history with `alt-k` and `alt-j`. Faster with `alt-u`/`alt-d`.
+ **zoom/change font size**: same bindings as above, but holding down shift as well. `alt-home` returns to default
+ **copy text** with `alt-c`, **paste** is `alt-v` or `shift-insert`
2019-05-08 17:26:11 +02:00
## Pretty stuff
2009-05-10 14:17:09 +02:00
2020-05-05 19:52:44 +02:00
+ Compatibility with `Xresources` and `pywal` for dynamic colors.
2018-12-03 20:53:04 +01:00
+ Default [gruvbox](https://github.com/morhetz/gruvbox) colors otherwise.
2019-05-08 17:26:11 +02:00
+ Transparency/alpha, which is also adjustable from your `Xresources`.
2020-02-08 04:44:19 +01:00
+ Default font is system "mono" at 14pt, meaning the font will match your system font.
2019-05-08 17:26:11 +02:00
## Other st patches
+ Boxdraw
+ Ligatures
2019-06-03 23:58:12 +02:00
+ font2
+ updated to latest version 0.8.4
## Installation for newbs
2021-01-24 22:48:11 +01:00
You should have xlib header files and libharfbuzz build files installed.
```
2019-04-23 18:45:03 +02:00
git clone https://github.com/LukeSmithxyz/st
cd st
sudo make install
```
2018-02-06 05:33:39 +01:00
2019-04-23 18:45:03 +02:00
Users of Arch-based distros can also install it from the AUR as [st-luke-git](https://aur.archlinux.org/packages/st-luke-git/).
2019-02-02 17:10:43 +01:00
Obviously, `make` is required to build. `fontconfig` is required for the default build, since it asks `fontconfig` for your system monospace font. It might be obvious, but `libX11` and `libXft` are required as well. Chances are, you have all of this installed already.
2019-02-02 17:10:43 +01:00
On OpenBSD, be sure to edit `config.mk` first and remove `-lrt` from the `$LIBS` before compiling.
Be sure to have a composite manager (`xcompmgr`, `picom`, etc.) running if you want transparency.
2018-11-24 15:17:12 +01:00
2019-01-08 23:50:19 +01:00
## How to configure dynamically with Xresources
2019-02-02 17:10:43 +01:00
For many key variables, this build of `st` will look for X settings set in either `~/.Xdefaults` or `~/.Xresources`. You must run `xrdb` on one of these files to load the settings.
For example, you can define your desired fonts, transparency or colors:
```
*.font: Liberation Mono:pixelsize=12:antialias=true:autohint=true;
*.alpha: 0.9
*.color0: #111
...
```
2019-05-08 17:26:11 +02:00
The `alpha` value (for transparency) goes from `0` (transparent) to `1` (opaque).
### Colors
To be clear about the color settings:
- This build will use gruvbox colors by default and as a fallback.
- If there are Xresources colors defined, those will take priority.
- But if `wal` has run in your session, its colors will take priority.
2019-02-02 17:10:43 +01:00
Note that when you run `wal`, it will negate the transparency of existing windows, but new windows will continue with the previously defined transparency.
2020-02-08 04:44:19 +01:00
## Notes on Emojis and Special Characters
2020-02-02 00:33:22 +01:00
2020-02-08 00:46:12 +01:00
If st crashes when viewing emojis, install [libxft-bgra](https://aur.archlinux.org/packages/libxft-bgra/) from the AUR.
2020-02-02 00:33:22 +01:00
2020-02-08 04:44:19 +01:00
Note that some special characters may appear truncated if too wide. You might want to manually set your prefered emoji/special character font to a lower size in the `config.h` file to avoid this. By default, JoyPixels is used at a smaller size than the usual text.
## Contact
- Luke Smith <luke@lukesmith.xyz>
- [https://lukesmith.xyz](https://lukesmith.xyz)