st

simple terminal with alpha focus highlight and selenized colorscheme
git clone https://git.beauhilton.com/st.git
Log | Files | Refs | README | LICENSE

README.md (3269B)


      1 ### I use kitty terminal most of the time now. It's great. st is also good.
      2 
      3 ### Note
      4 There seems to be some evidence suggesting that some of the people responsible at suckless e.V. are sympathizing with far-right ideas and Neo-nazi symbols [[1](https://twitter.com/pid_eins/status/1113738769289625602?lang=en), [2](https://chaos.social/@raichoo/101880564196043164)]. If you like this patch, please consider donating to an organization that fights xenophobia and antisemitism (e.g. [schwarz-rot-bunt (German)](https://schwarz-rot-bunt.de/ziele/) or similar organizations).
      5 
      6 ### Patches
      7 This repository contains the latest version of the `alpha-focus` and the `vim`
      8 patches for suckless simple terminal (`st`) merged with other useful patches
      9 in my personal `st` build.
     10 This repository can be cloned in order to try out one of the aforementioned
     11 patches in a functional environment. It also serves to port the patches to
     12 new versions of `st` and thus holds the most recent releases in the release
     13 page. Pull requests are to be issued in the development repositories for
     14 [vim browse](https://github.com/juliusHuelsmann/st-history-vim) and
     15 [alpha focus](https://github.com/juliusHuelsmann/st-focus) respectively.
     16 
     17 **Vim Browse** adds history-functionality to the terminal, and allows to -- among
     18 other things -- select, yank, search it via keyboard using vim-like motions and
     19 operations. It operates on top of the `st-history` patch, which can be
     20 configured with a set of optional patches.
     21 The **Alpha Focus Highlight** patch applies transparency to the configured
     22 background, and allows to use different transparency levels and background
     23 colors for focused and unfocused windows.
     24 This patch requires a running X composite manager.
     25 
     26 ## Build process
     27 
     28 ```bash
     29 # If required: Install Build dependencies (if you're on Arch)
     30 sudo pacman -S make git picom
     31 # Clone
     32 git clone https://github.com/juliusHuelsmann/st.git
     33 cd st
     34 # Optional: Use my xresources
     35 xrdb -merge .Xresources
     36 # Build
     37 rm config.h
     38 make clean
     39 make
     40 ```
     41 
     42 ## Launch st:
     43 After building, make sure that you launch your compositor if you want to enable
     44 transparency.
     45 ```bash
     46 picom -b # optional, for the alpha focus patch; can be replaced by different
     47          # compositor
     48 ./st
     49 ```
     50 
     51 # install
     52 After building, you can install this `st` build via
     53 ```
     54 sudo make install
     55 ```
     56 
     57 In case you want to install this `st` build and use the shipped `.Xresources`
     58 (color scheme and opacity), be sure to copy  them into your home directory,
     59 ```bash
     60 cp -i .Xresources $HOME/.Xresources
     61 ```
     62 and to merge them after booting
     63 ```bash
     64 xrdb -merge $HOME/.Xresources
     65 ```
     66 
     67 You also need to make sure that your composite manager is launched on startup.
     68 
     69 ## Patching and Documentation
     70 The patches are released [here](https://github.com/juliusHuelsmann/st/releases).
     71 Documentation on how to use the patches can be found in the dev repositories
     72 -  [st-focus](https://github.com/juliusHuelsmann/st-focus)
     73 -  [st-history-vim](https://github.com/juliusHuelsmann/st-history-vim)
     74 and in the [wiki](https://github.com/juliusHuelsmann/st-history-vim/wiki/Vim-browse-manual) of the vim-patch repo.
     75 
     76 Patches can be applied to `st`'s source code via
     77 ```bash
     78 patch < [PATCH_NAME]
     79 ```
     80 and then build as usual (e.g. after removing the old `config.h` file).
     81