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