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