st/README.md

Similar to dwm-flexipatch this st 0.8.2 (ed68fe7dce) project has a different take on st patching. It uses preprocessor directives to decide whether or not to include a patch during build time. Essentially this means that this build, for better or worse, contains both the patched and the original code. The aim being that you can select which patches to include and the build will contain that code and nothing more.

For example to include the alpha patch then you would only need to flip this setting from 0 to 1 in patches.h:

#define ALPHA_PATCH 1

Once you have found out what works for you and what doesn't then you should be in a better position to choose patches should you want to start patching from scratch.

Alternatively if you have found the patches you want, but don't want the rest of the flexipatch entanglement on your plate then you may want to have a look at flexipatch-finalizer; a custom pre-processor tool that removes all the unused flexipatch code leaving you with a build that contains the patches you selected.

Refer to https://st.suckless.org/ for details on the st terminal, how to install it and how it works.

---

Changelog:

2020-03-21 - Added font2 patch

2020-01-07 - Added st embedder patch

2019-10-16 - Introduced flexipatch-finalizer

2019-09-17 - Added relativeborder, fix-keyboard-input, iso14755, visualbell, right-click-to-plumb, boxdraw and keyboard-select patches

2019-09-16 - Added alpha, anysize, bold-is-not-bright, clipboard, copyurl, disable-fonts, externalpipe, fixime, hidecursor, newterm, open-copied-url, vertcenter, scrollback, spoiler, themed cursor and xresources patches

Patches included:

• alpha

  • adds transparency for the terminal

• anysize

  • allows st to reize to any pixel size rather than snapping to character width / height

• bold-is-not-bright

  • by default bold text is rendered with a bold font in the bright variant of the current color
  • this patch makes bold text rendered simply as bold, leaving the color unaffected

• boxdraw

  • adds dustom rendering of lines/blocks/braille characters for gapless alignment

• clipboard

  • by default st only sets PRIMARY on selection
  • this patch makes st set CLIPBOARD on selection

• copyurl

  • this patch allows you to select and copy the last URL displayed with Mod+l
  • multiple invocations cycle through the available URLs

• disable-fonts

  • this patch adds the option of disabling bold/italic/roman fonts globally

• externalpipe

  • this patch allows for eading and writing st's screen through a pipe, e.g. to pass info to dmenu

• fixime

  • adds better Input Method Editor (IME) support
  • (included in the base as per 35f7db)

• fix-keyboard-input

  • allows cli applications to use all the fancy key combinations that are available to GUI applications

• font2

  • allows you to add a spare font besides the default

• hidecursor

  • hides the X cursor whenever a key is pressed and show it back when the mouse is moved in the terminal window

• iso14755

  • pressing the default binding Ctrl+Shift-i will popup dmenu, asking you to enter a unicode codepoint that will be converted to a glyph and then pushed to st

• keyboard-select

  • allows you to select text on the terminal using keyboard shortcuts

• newterm

  • allows you to spawn a new st terminal using Ctrl-Shift-Return
  • it will have the same CWD (current working directory) as the original st instance

• open-copied-url

  • open contents of the clipboard in a user-defined browser

• relativeborder

  • allows you to specify a border that is relative in size to the width of a cell in the terminal

• right-click-to-plumb

  • allows you to right-click on some selected text to send it to the plumbing program of choice

• scrollback

  • allows you scroll back through terminal output using keyboard shortcuts or mousewheel

• st-embedder

  • this patch allows clients to embed into the st window and can be useful if you tend to start X applications from the terminal
  • the behavior is similar to Plan 9 where applications can take over windows

• spoiler

  • use inverted defaultbg/fg for selection when bg/fg are the same

• themed-cursor

  • instead of a default X cursor, use the xterm cursor from your cursor theme

• vertcenter

  • vertically center lines in the space available if you have set a larger chscale in config.h

• visualbell

  • adds visual indicators for the terminal bell event

• xresources

  • adds the ability to configure st via Xresources
  • during startup, st will read and apply the resources named in the resources[] array in config.h