README.md (3306B)
1 # Luke's build of st - the simple (suckless) terminal 2 3 The [suckless terminal (st)](https://st.suckless.org/) with some additional features that make it literally the best terminal emulator ever: 4 5 ## Unique features (using dmenu) 6 7 + **follow urls** by pressing `alt-l` 8 + **copy urls** in the same way with `alt-y` 9 + **copy the output of commands** with `alt-o` 10 11 ## Bindings for 12 13 + **scrollback** with `alt-↑/↓` or `alt-pageup/down` or `shift` while scrolling the mouse 14 + OR **vim-bindings**: scroll up/down in history with `alt-k` and `alt-j`. Faster with `alt-u`/`alt-d`. 15 + **zoom/change font size**: same bindings as above, but holding down shift as well. `alt-home` returns to default 16 + **copy text** with `alt-c`, **paste** is `alt-v` or `shift-insert` 17 18 ## Pretty stuff 19 20 + Compatibility with `Xresources` and `pywal` for dynamic colors. 21 + Default [gruvbox](https://github.com/morhetz/gruvbox) colors otherwise. 22 + Transparency/alpha, which is also adjustable from your `Xresources`. 23 + Default font is system "mono" at 14pt, meaning the font will match your system font. 24 25 ## Other st patches 26 27 + Vertcenter 28 + Scrollback 29 + font2 30 + updated to latest version 0.8.2 31 32 ## Installation for newbs 33 34 ``` 35 git clone https://github.com/LukeSmithxyz/st 36 cd st 37 sudo make install 38 ``` 39 40 Users of Arch-based distros can also install it from the AUR as [st-luke-git](https://aur.archlinux.org/packages/st-luke-git/). 41 42 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. 43 44 On OpenBSD, be sure to edit `config.mk` first and remove `-lrt` from the `$LIBS` before compiling. 45 46 Be sure to have a composite manager (`xcompmgr`, `picom`, etc.) running if you want transparency. 47 48 ## How to configure dynamically with Xresources 49 50 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. 51 52 For example, you can define your desired fonts, transparency or colors: 53 54 ``` 55 *.font: Liberation Mono:pixelsize=12:antialias=true:autohint=true; 56 *.alpha: 0.9 57 *.color0: #111 58 ... 59 ``` 60 61 The `alpha` value (for transparency) goes from `0` (transparent) to `1` (opaque). 62 63 ### Colors 64 65 To be clear about the color settings: 66 67 - This build will use gruvbox colors by default and as a fallback. 68 - If there are Xresources colors defined, those will take priority. 69 - But if `wal` has run in your session, its colors will take priority. 70 71 Note that when you run `wal`, it will negate the transparency of existing windows, but new windows will continue with the previously defined transparency. 72 73 ## Notes on Emojis and Special Characters 74 75 If st crashes when viewing emojis, install [libxft-bgra](https://aur.archlinux.org/packages/libxft-bgra/) from the AUR. 76 77 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. 78 79 ## Contact 80 81 - Luke Smith <luke@lukesmith.xyz> 82 - [https://lukesmith.xyz](https://lukesmith.xyz)