]> git.armaanb.net Git - st.git/blob - st.1
Add tty line support
[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 [ \-l
19 .IR line ]
20 .RB [ \-w 
21 .IR windowid ]
22 .RB [ \-v ]
23 .RB [ \-e
24 .IR command ...]
25 .RI [ commands ...]
26 .PP
27 .B st
28 .RB [ \-a ]
29 .RB [ \-c
30 .IR class ]
31 .RB [ \-f
32 .IR font ]
33 .RB [ \-g
34 .IR geometry ]
35 .RB [ \-i ]
36 .RB [ \-o
37 .IR file ]
38 .RB [ \-t
39 .IR title ]
40 .RB [ \-l
41 .IR line ]
42 .RB [ \-w
43 .IR windowid ]
44 .RB [ \-v ]
45 .RB [ \-l
46 .IR line ]
47 .RI [ stty_args ...]
48 .SH DESCRIPTION
49 .B st
50 is a simple terminal emulator.
51 .SH OPTIONS
52 .TP
53 .B \-a
54 disable alternate screens in terminal
55 .TP
56 .BI \-c " class"
57 defines the window class (default $TERM).
58 .TP
59 .BI \-f " font"
60 defines the
61 .I font
62 to use when st is run.
63 .TP
64 .BI \-g " geometry"
65 defines the X11 geometry string.
66 The form is [=][<cols>{xX}<rows>][{+-}<xoffset>{+-}<yoffset>]. See
67 .BR XParseGeometry (3)
68 for further details.
69 .TP
70 .B \-i
71 will fixate the position given with the -g option.
72 .TP
73 .BI \-o " iofile"
74 writes all the I/O to
75 .I iofile.
76 This feature is useful when recording st sessions. A value of "-" means
77 standard output.
78 .TP
79 .BI \-t " title"
80 defines the window title (default 'st').
81 .TP
82 .BI \-w " windowid"
83 embeds st within the window identified by 
84 .I windowid
85 .TP
86 .BI \-l " line"
87 use a tty line instead of a pseudo terminal.
88 When this flag is used
89 remaining arguments are used as flags for stty.
90 .TP
91 .B \-v
92 prints version information to stderr, then exits.
93 .TP
94 .BI \-e " program " [ " arguments " "... ]"
95 st executes
96 .I program
97 instead of the shell.  If this is used it
98 .B must be the last option
99 on the command line, as in xterm / rxvt.
100 This option is only intended for compability,
101 and all the remaining arguments are used as a command
102 even without it.
103 .SH SHORTCUTS
104 .TP
105 .B Ctrl-Print Screen
106 Toggle if st should print to the
107 .I iofile.
108 .TP
109 .B Shift-Print Screen
110 Print the full screen to the
111 .I iofile.
112 .TP
113 .B Print Screen
114 Print the selection to the
115 .I iofile.
116 .TP
117 .B Alt-Shift-Page Up
118 Increase font size.
119 .TP
120 .B Alt-Shift-Page Down
121 Decrease font size.
122 .TP
123 .B Alt-Shift-Home
124 Reset to default font size.
125 .TP
126 .B Shift-Insert
127 Paste from primary selection (middle mouse button).
128 .TP
129 .B Alt-Shift-Insert
130 Paste from clipboard selection.
131 .TP
132 .B Alt-Shift-c
133 Copy the selected text to the clipboard selection.
134 .TP
135 .B Alt-Shift-v
136 Paste from the clipboard selection.
137 .SH CUSTOMIZATION
138 .B st
139 can be customized by creating a custom config.h and (re)compiling the source
140 code. This keeps it fast, secure and simple.
141 .SH AUTHORS
142 See the LICENSE file for the authors.
143 .SH LICENSE
144 See the LICENSE file for the terms of redistribution.
145 .SH SEE ALSO
146 .BR tabbed (1),
147 .BR utmp (1),
148 .BR stty (1)
149 .SH BUGS
150 See the TODO file in the distribution.
151