feat: manpage + README
This commit is contained in:
David JULIEN
parent
d82d53fcfb
commit
ce1618bbcc
34
README
34
README
@ -1,34 +0,0 @@
|
||||
st - simple terminal
|
||||
--------------------
|
||||
st is a simple terminal emulator for X which sucks less.
|
||||
|
||||
|
||||
Requirements
|
||||
------------
|
||||
In order to build st you need the Xlib header files.
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
Edit config.mk to match your local setup (st is installed into
|
||||
the /usr/local namespace by default).
|
||||
|
||||
Afterwards enter the following command to build and install st (if
|
||||
necessary as root):
|
||||
|
||||
make clean install
|
||||
|
||||
|
||||
Running st
|
||||
----------
|
||||
If you did not install st with make clean install, you must compile
|
||||
the st terminfo entry with the following command:
|
||||
|
||||
tic -sx st.info
|
||||
|
||||
See the man page for additional details.
|
||||
|
||||
Credits
|
||||
-------
|
||||
Based on Aurélien APTEL <aurelien dot aptel at gmail dot com> bt source code.
|
||||
|
||||
75
README.md
Normal file
75
README.md
Normal file
@ -0,0 +1,75 @@
|
||||
Swy7ch' fork of st
|
||||
==================
|
||||
|
||||
This is my fork of suckless' terminal emulator, [st](https://st.suckless.org/). It is tweaked to match my needs and comes with just a few patches:
|
||||
|
||||
- [st-anysize](https://st.suckless.org/patches/anysize/)
|
||||
- [st-clipboard](https://st.suckless.org/patches/clipboard/)
|
||||
- [st-externalpipe](https://st.suckless.org/patches/externalpipe/)
|
||||
- [st-font2](https://st.suckless.org/patches/font2/)
|
||||
- [st-scrollback](https://st.suckless.org/patches/scrollback/)
|
||||
- [st-xresources](https://st.suckless.org/patches/xresources/)
|
||||
|
||||
Keybindings
|
||||
-----------
|
||||
|
||||
- **Alt+u / Alt+d** .....Scroll a whole page up/down
|
||||
- **Alt+k / Alt+j** .....Scroll a line up/down
|
||||
- **Alt+PgUp / Alt+PgDn** .....Zoom in/out
|
||||
- **Alt+c** .....Copy to xclipboard
|
||||
- **Alt+v** .....Paste from xclipboard
|
||||
- **Alt+o** .....Copy a command output to xclipboard, through dmenu [1]
|
||||
- **Alt+l** .....Follow links through dmenu [2]
|
||||
- **Alt+y** .....Copy links through dmenu [2]
|
||||
|
||||
[1] Requires `st-copyout` from my scripts repo
|
||||
|
||||
[2] Requires `st-urlhandler` from my scripts repo
|
||||
|
||||
Colorscheme and font
|
||||
--------------------
|
||||
|
||||
Colors, fonts and other variables are set through `xrdb`, by sourcing a
|
||||
.Xresources file.
|
||||
|
||||
That's it!
|
||||
----------
|
||||
|
||||
No need for anything else. Enjoy!
|
||||
|
||||
---
|
||||
|
||||
st - simple terminal
|
||||
--------------------
|
||||
st is a simple terminal emulator for X which sucks less.
|
||||
|
||||
|
||||
Requirements
|
||||
------------
|
||||
In order to build st you need the Xlib header files.
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
Edit config.mk to match your local setup (st is installed into
|
||||
the /usr/local namespace by default).
|
||||
|
||||
Afterwards enter the following command to build and install st (if
|
||||
necessary as root):
|
||||
|
||||
make clean install
|
||||
|
||||
|
||||
Running st
|
||||
----------
|
||||
If you did not install st with make clean install, you must compile
|
||||
the st terminfo entry with the following command:
|
||||
|
||||
tic -sx st.info
|
||||
|
||||
See the man page for additional details.
|
||||
|
||||
Credits
|
||||
-------
|
||||
Based on Aurélien APTEL <aurelien dot aptel at gmail dot com> bt source code.
|
||||
|
||||
52
st.1
52
st.1
@ -1,6 +1,6 @@
|
||||
.TH ST 1 st\-VERSION
|
||||
.SH NAME
|
||||
st \- simple terminal
|
||||
swy7ch' fork of st \- simple terminal
|
||||
.SH SYNOPSIS
|
||||
.B st
|
||||
.RB [ \-aiv ]
|
||||
@ -50,6 +50,22 @@ st \- simple terminal
|
||||
.SH DESCRIPTION
|
||||
.B st
|
||||
is a simple terminal emulator.
|
||||
.P
|
||||
It comes with 6 patches
|
||||
.P
|
||||
.RS
|
||||
* anysize, to draw windows of the right size
|
||||
.P
|
||||
* clipboard, to use xclipboard in the terminal
|
||||
.P
|
||||
* externalpipe, to handle st output
|
||||
.P
|
||||
* font2, to use multiple fonts
|
||||
.P
|
||||
* scrollback, to scroll in the terminal
|
||||
.P
|
||||
* xresources, for theme setting
|
||||
.RE
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B \-a
|
||||
@ -142,23 +158,44 @@ Print the full screen to the
|
||||
Print the selection to the
|
||||
.I iofile.
|
||||
.TP
|
||||
.B Ctrl-Shift-Page Up
|
||||
.B Alt-PgDn
|
||||
Increase font size.
|
||||
.TP
|
||||
.B Ctrl-Shift-Page Down
|
||||
.B Alt-PgUp
|
||||
Decrease font size.
|
||||
.TP
|
||||
.B Ctrl-Shift-Home
|
||||
.B Alt-r
|
||||
Reset to default font size.
|
||||
.TP
|
||||
.B Ctrl-Shift-y
|
||||
.B Alt-y
|
||||
Paste from primary selection (middle mouse button).
|
||||
.TP
|
||||
.B Ctrl-Shift-c
|
||||
.B Alt-c
|
||||
Copy the selected text to the clipboard selection.
|
||||
.TP
|
||||
.B Ctrl-Shift-v
|
||||
.B Alt-v
|
||||
Paste from the clipboard selection.
|
||||
.TP
|
||||
.B Alt-u
|
||||
Scroll up a full page.
|
||||
.TP
|
||||
.B Alt-k
|
||||
Scroll up a line.
|
||||
.TP
|
||||
.B Alt-d
|
||||
Scroll down a full page.
|
||||
.TP
|
||||
.B Alt-j
|
||||
Scroll down a line.
|
||||
.TP
|
||||
.B Alt-l
|
||||
Follow urls through dmenu.
|
||||
.TP
|
||||
.B Alt-o
|
||||
Copy command output through dmenu.
|
||||
.TP
|
||||
.B Alt-c
|
||||
Copy urls through dmenu.
|
||||
.SH CUSTOMIZATION
|
||||
.B st
|
||||
can be customized by creating a custom config.h and (re)compiling the source
|
||||
@ -174,4 +211,3 @@ See the LICENSE file for the terms of redistribution.
|
||||
.BR scroll (1)
|
||||
.SH BUGS
|
||||
See the TODO file in the distribution.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user