]> git.armaanb.net Git - st.git/blob - st.1
Add key to send a break to the serial line
[st.git] / st.1
1 .TH ST 1 st\-VERSION
2 .SH NAME
3 st \- simple terminal
4 .SH SYNOPSIS
5 .B st
6 .RB [ \-a ]
7 .RB [ \-c
8 .IR class ]
9 .RB [ \-f
10 .IR font ]
11 .RB [ \-g
12 .IR geometry ]
13 .RB [ \-i ]
14 .RB [ \-o
15 .IR file ]
16 .RB [ \-t 
17 .IR title ]
18 .RB [ \-T
19 .IR title ]
20 .RB [ \-l
21 .IR line ]
22 .RB [ \-w 
23 .IR windowid ]
24 .RB [ \-v ]
25 .RB [ \-e
26 .IR command ...]
27 .RI [ commands ...]
28 .PP
29 .B st
30 .RB [ \-a ]
31 .RB [ \-c
32 .IR class ]
33 .RB [ \-f
34 .IR font ]
35 .RB [ \-g
36 .IR geometry ]
37 .RB [ \-i ]
38 .RB [ \-o
39 .IR file ]
40 .RB [ \-t
41 .IR title ]
42 .RB [ \-T
43 .IR title ]
44 .RB [ \-w
45 .IR windowid ]
46 .RB [ \-v ]
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 \-o " iofile"
76 writes all the I/O to
77 .I iofile.
78 This feature is useful when recording st sessions. A value of "-" means
79 standard output.
80 .TP
81 .BI \-t " title"
82 defines the window title (default 'st').
83 .TP
84 .BI \-T " title"
85 defines the window title (default 'st').
86 .TP
87 .BI \-w " windowid"
88 embeds st within the window identified by 
89 .I windowid
90 .TP
91 .BI \-l " line"
92 use a tty
93 .I line
94 instead of a pseudo terminal.
95 .I line
96 should be a (pseudo-)serial device (e.g. /dev/ttySO on Linux for serial port
97 0).
98 When this flag is given
99 remaining arguments are used as flags for
100 .BR stty(1).
101 By default st initializes the serial line to 8 bits, no parity, 1 stop bit
102 and a 38400 baud rate. The speed is set by appending it as last argument
103 (e.g. 'st -l 115200'). Arguments before the last one are
104 .BR stty(1)
105 flags. If you want to set odd parity on 115200 baud use for example 'st -l
106 parenb parodd 115200'. Set the number of bits by using for example 'st -l cs7
107 115200'. See
108 .BR stty(1)
109 for more arguments and cases.
110 .TP
111 .B \-v
112 prints version information to stderr, then exits.
113 .TP
114 .BI \-e " program " [ " arguments " "... ]"
115 st executes
116 .I program
117 instead of the shell.  If this is used it
118 .B must be the last option
119 on the command line, as in xterm / rxvt.
120 This option is only intended for compability,
121 and all the remaining arguments are used as a command
122 even without it.
123 .SH SHORTCUTS
124 .TP
125 .B Pause
126 Send a break in the serial line
127 .TP
128 .B Ctrl-Print Screen
129 Toggle if st should print to the
130 .I iofile.
131 .TP
132 .B Shift-Print Screen
133 Print the full screen to the
134 .I iofile.
135 .TP
136 .B Print Screen
137 Print the selection to the
138 .I iofile.
139 .TP
140 .B Alt-Shift-Page Up
141 Increase font size.
142 .TP
143 .B Alt-Shift-Page Down
144 Decrease font size.
145 .TP
146 .B Alt-Shift-Home
147 Reset to default font size.
148 .TP
149 .B Shift-Insert
150 Paste from primary selection (middle mouse button).
151 .TP
152 .B Alt-Shift-Insert
153 Paste from clipboard selection.
154 .TP
155 .B Alt-Shift-c
156 Copy the selected text to the clipboard selection.
157 .TP
158 .B Alt-Shift-v
159 Paste from the clipboard selection.
160 .SH CUSTOMIZATION
161 .B st
162 can be customized by creating a custom config.h and (re)compiling the source
163 code. This keeps it fast, secure and simple.
164 .SH AUTHORS
165 See the LICENSE file for the authors.
166 .SH LICENSE
167 See the LICENSE file for the terms of redistribution.
168 .SH SEE ALSO
169 .BR tabbed (1),
170 .BR utmp (1),
171 .BR stty (1)
172 .SH BUGS
173 See the TODO file in the distribution.
174