updated README
[k8sterm.git] / dox / sterm.1
blob508331910e9f106dd3018244b5b0ae0b4243ba43
1 .TH STERM 1 sterm\-0.3.0
2 .SH NAME
3 sterm \- simple terminal
4 .SH SYNOPSIS
5 .B sterm
6 .RB [ \-c
7 .IR class ]
8 .RB [ \-t 
9 .IR title ]
10 .RB [ \-w 
11 .IR windowid ]
12 .RB [ \-v ]
13 .RB [ \-e
14 .IR command ...]
15 .SH DESCRIPTION
16 .B sterm
17 is a simple terminal emulator with tabs.
18 .SH OPTIONS
19 .TP
20 .BI \-t " title"
21 defines the window title (default 'sterm').
22 .TP
23 .BI \-c " class"
24 defines the window class (default $TERM).
25 .TP
26 .BI \-T " name"
27 defines terminal name for TERM variable.
28 .TP
29 .BI \-C " file_name"
30 load configuration from
31 .I `filename'
32 .TP
33 .BI \-R " commands"
34 run commands after first tab creation (once!).
35 .TP
36 .BI \-l " encoding"
37 force locale encoding.
38 .TP
39 .BI \-w " windowid"
40 embeds sterm within the window identified by 
41 .I windowid
42 .TP
43 .B \-S
44 disable tabs.
45 .TP
46 .B \-v
47 prints version information to stderr, then exits.
48 .TP
49 .B \-h
50 same as
51 .I \-v
52 .TP
53 .BI \-e " program " [ " arguments " "... ]"
54 sterm executes
55 .I program
56 instead of the shell.  If this is used it
57 .B must be the last option
58 on the command line, as in xterm / rxvt.