JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
Fix the geometry handling.
[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 [ \-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 The form is [=][<width>{xX}<height>][{+-}<xoffset>{+-}<yoffset>]. See
41 .BR XParseGeometry (3)
42 for further details.
43 .TP
44 .BI \-o " file"
45 writes all the I/O to
46 .I file.
47 This feature is useful when recording st sessions. A value of "-" means
48 standard output.
49 .TP
50 .BI \-t " title"
51 defines the window title (default 'st').
52 .TP
53 .BI \-w " windowid"
54 embeds st within the window identified by 
55 .I windowid
56 .TP
57 .B \-v
58 prints version information to stderr, then exits.
59 .TP
60 .BI \-e " program " [ " arguments " "... ]"
61 st executes
62 .I program
63 instead of the shell.  If this is used it
64 .B must be the last option
65 on the command line, as in xterm / rxvt.
66 .SH CUSTOMIZATION
67 .B st
68 can be customized by creating a custom config.h and (re)compiling the source
69 code. This keeps it fast, secure and simple.
70 .SH AUTHORS
71 See the LICENSE file for the authors.
72 .SH LICENSE
73 See the LICENSE file for the terms of redistribution.
74 .SH SEE ALSO
75 .BR tabbed (1)
76 .SH BUGS
77 See the TODO file in the distribution.
78