FAQ: update typo and escape code for smkx
[st.git] / st.1
blob7174da2882782888f27ba6a9cbe9a221b4dbd2af
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 [ \-w 
19 .IR windowid ]
20 .RB [ \-v ]
21 .RB [ \-e
22 .IR command ...]
23 .SH DESCRIPTION
24 .B st
25 is a simple terminal emulator.
26 .SH OPTIONS
27 .TP
28 .B \-a
29 disable alternate screens in terminal
30 .TP
31 .BI \-c " class"
32 defines the window class (default $TERM).
33 .TP
34 .BI \-f " font"
35 defines the
36 .I font
37 to use when st is run.
38 .TP
39 .BI \-g " geometry"
40 defines the X11 geometry string.
41 The form is [=][<cols>{xX}<rows>][{+-}<xoffset>{+-}<yoffset>]. See
42 .BR XParseGeometry (3)
43 for further details.
44 .TP
45 .B \-f
46 will fixate the position given with the -g option.
47 .TP
48 .BI \-o " file"
49 writes all the I/O to
50 .I file.
51 This feature is useful when recording st sessions. A value of "-" means
52 standard output.
53 .TP
54 .BI \-t " title"
55 defines the window title (default 'st').
56 .TP
57 .BI \-w " windowid"
58 embeds st within the window identified by 
59 .I windowid
60 .TP
61 .B \-v
62 prints version information to stderr, then exits.
63 .TP
64 .BI \-e " program " [ " arguments " "... ]"
65 st executes
66 .I program
67 instead of the shell.  If this is used it
68 .B must be the last option
69 on the command line, as in xterm / rxvt.
70 .SH CUSTOMIZATION
71 .B st
72 can be customized by creating a custom config.h and (re)compiling the source
73 code. This keeps it fast, secure and simple.
74 .SH AUTHORS
75 See the LICENSE file for the authors.
76 .SH LICENSE
77 See the LICENSE file for the terms of redistribution.
78 .SH SEE ALSO
79 .BR tabbed (1)
80 .SH BUGS
81 See the TODO file in the distribution.