dotfiles

[void/arch] linux dotfiles
git clone git://git.mdnr.space/dotfiles
Log | Files | Refs

README.md (2883B)


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