st.1 - st - Simple Terminal
(HTM) git clone git://r-36.net/st
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
st.1 (3712B)
---
1 .TH ST 1 st\-VERSION
2 .SH NAME
3 st \- simple terminal
4 .SH SYNOPSIS
5 .B st
6 .RB [ \-aiv ]
7 .RB [ \-c
8 .IR class ]
9 .RB [ \-f
10 .IR font ]
11 .RB [ \-g
12 .IR geometry ]
13 .RB [ \-n
14 .IR name ]
15 .RB [ \-o
16 .IR iofile ]
17 .RB [ \-T
18 .IR title ]
19 .RB [ \-t
20 .IR title ]
21 .RB [ \-l
22 .IR line ]
23 .RB [ \-w
24 .IR windowid ]
25 .RB [[ \-e ]
26 .IR command
27 .RI [ arguments ...]]
28 .PP
29 .B st
30 .RB [ \-aiv ]
31 .RB [ \-c
32 .IR class ]
33 .RB [ \-f
34 .IR font ]
35 .RB [ \-g
36 .IR geometry ]
37 .RB [ \-n
38 .IR name ]
39 .RB [ \-o
40 .IR iofile ]
41 .RB [ \-T
42 .IR title ]
43 .RB [ \-t
44 .IR title ]
45 .RB [ \-w
46 .IR windowid ]
47 .RB \-l
48 .IR line
49 .RI [ stty_args ...]
50 .SH DESCRIPTION
51 .B st
52 is a simple terminal emulator.
53 .SH OPTIONS
54 .TP
55 .B \-a
56 disable alternate screens in terminal
57 .TP
58 .BI \-c " class"
59 defines the window class (default $TERM).
60 .TP
61 .BI \-f " font"
62 defines the
63 .I font
64 to use when st is run.
65 .TP
66 .BI \-g " geometry"
67 defines the X11 geometry string.
68 The form is [=][<cols>{xX}<rows>][{+-}<xoffset>{+-}<yoffset>]. See
69 .BR XParseGeometry (3)
70 for further details.
71 .TP
72 .B \-i
73 will fixate the position given with the -g option.
74 .TP
75 .BI \-n " name"
76 defines the window instance name (default $TERM).
77 .TP
78 .BI \-o " iofile"
79 writes all the I/O to
80 .I iofile.
81 This feature is useful when recording st sessions. A value of "-" means
82 standard output.
83 .TP
84 .BI \-T " title"
85 defines the window title (default 'st').
86 .TP
87 .BI \-t " title"
88 defines the window title (default 'st').
89 .TP
90 .BI \-w " windowid"
91 embeds st within the window identified by
92 .I windowid
93 .TP
94 .BI \-l " line"
95 use a tty
96 .I line
97 instead of a pseudo terminal.
98 .I line
99 should be a (pseudo-)serial device (e.g. /dev/ttyS0 on Linux for serial port
100 0).
101 When this flag is given
102 remaining arguments are used as flags for
103 .BR stty(1).
104 By default st initializes the serial line to 8 bits, no parity, 1 stop bit
105 and a 38400 baud rate. The speed is set by appending it as last argument
106 (e.g. 'st -l /dev/ttyS0 115200'). Arguments before the last one are
107 .BR stty(1)
108 flags. If you want to set odd parity on 115200 baud use for example 'st -l
109 /dev/ttyS0 parenb parodd 115200'. Set the number of bits by using for
110 example 'st -l /dev/ttyS0 cs7 115200'. See
111 .BR stty(1)
112 for more arguments and cases.
113 .TP
114 .B \-v
115 prints version information to stderr, then exits.
116 .TP
117 .BI \-e " command " [ " arguments " "... ]"
118 st executes
119 .I command
120 instead of the shell. If this is used it
121 .B must be the last option
122 on the command line, as in xterm / rxvt.
123 This option is only intended for compability,
124 and all the remaining arguments are used as a command
125 even without it.
126 .SH SHORTCUTS
127 .TP
128 .B Break
129 Send a break in the serial line.
130 Break key is obtained in PC keyboards
131 pressing at the same time control and pause.
132 .TP
133 .B Ctrl-Print Screen
134 Toggle if st should print to the
135 .I iofile.
136 .TP
137 .B Shift-Print Screen
138 Print the full screen to the
139 .I iofile.
140 .TP
141 .B Print Screen
142 Print the selection to the
143 .I iofile.
144 .TP
145 .B Alt-Shift-Page Up
146 Increase font size.
147 .TP
148 .B Alt-Shift-Page Down
149 Decrease font size.
150 .TP
151 .B Alt-Shift-Home
152 Reset to default font size.
153 .TP
154 .B Shift-Insert
155 Paste from primary selection (middle mouse button).
156 .TP
157 .B Alt-Shift-Insert
158 Paste from clipboard selection.
159 .TP
160 .B Alt-Shift-c
161 Copy the selected text to the clipboard selection.
162 .TP
163 .B Alt-Shift-v
164 Paste from the clipboard selection.
165 .TP
166 .B Alt-Ctrl
167 Launch dmenu to enter a unicode codepoint and send the corresponding glyph
168 to st.
169 .SH CUSTOMIZATION
170 .B st
171 can be customized by creating a custom config.h and (re)compiling the source
172 code. This keeps it fast, secure and simple.
173 .SH AUTHORS
174 See the LICENSE file for the authors.
175 .SH LICENSE
176 See the LICENSE file for the terms of redistribution.
177 .SH SEE ALSO
178 .BR tabbed (1),
179 .BR utmp (1),
180 .BR stty (1)
181 .SH BUGS
182 See the TODO file in the distribution.
183