JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
Adding some more fields to the manpage, like authors, license etc.
[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 [ \-c
7 .IR class ]
8 .RB [ \-g
9 .IR geometry ]
10 .RB [ \-t 
11 .IR title ]
12 .RB [ \-w 
13 .IR windowid ]
14 .RB [ \-v ]
15 .RB [ \-f
16 .IR file ]
17 .RB [ \-e
18 .IR command ...]
19 .SH DESCRIPTION
20 .B st
21 is a simple terminal emulator.
22 .SH OPTIONS
23 .TP
24 .BI \-t " title"
25 defines the window title (default 'st').
26 .TP
27 .BI \-c " class"
28 defines the window class (default $TERM).
29 .TP
30 .BI \-w " windowid"
31 embeds st within the window identified by 
32 .I windowid
33 .TP
34 .B \-g " geometry"
35 defines the X11 geometry string, which will fixate the height and width of st. 
36 .B \-v
37 prints version information to stderr, then exits.
38 .TP
39 .BI \-f " file"
40 writes all the I/O to
41 .I file.
42 This feature is useful when recording st sessions.
43 .TP
44 .BI \-e " program " [ " arguments " "... ]"
45 st executes
46 .I program
47 instead of the shell.  If this is used it
48 .B must be the last option
49 on the command line, as in xterm / rxvt.
50 .SH CUSTOMIZATION
51 .B st
52 can be customized by creating a custom config.h and (re)compiling the source
53 code. This keeps it fast, secure and simple.
54 .SH AUTHORS
55 See the LICENSE file for the authors.
56 .SH LICENSE
57 See the LICENSE file for the terms of redistribution.
58 .SH SEE ALSO
59 .BR tabbed (1)
60 .SH BUGS
61 See the TODO file in the distribution.
62