JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
make the backspace and delete keys work like it's the new millenium
[st.git] / st.1
diff --git a/st.1 b/st.1
index 4d00d2f..e655530 100644 (file)
--- a/st.1
+++ b/st.1
@@ -1,21 +1,82 @@
-.TH ST 1 st-VERSION
+.TH ST 1 st\-VERSION
 .SH NAME
 st \- simple terminal
 .SH SYNOPSIS
 .B st
-.RB [ \-e " <cmd>"]
-.RB [ \-t " <title>"]
+.RB [ \-a ]
+.RB [ \-c
+.IR class ]
+.RB [ \-f
+.IR font ]
+.RB [ \-g
+.IR geometry ]
+.RB [ \-i ]
+.RB [ \-o
+.IR file ]
+.RB [ \-t 
+.IR title ]
+.RB [ \-w 
+.IR windowid ]
 .RB [ \-v ]
+.RB [ \-e
+.IR command ...]
 .SH DESCRIPTION
 .B st
 is a simple terminal emulator.
 .SH OPTIONS
 .TP
-.B \-e <cmd>
-Execute cmd instead of the shell
+.B \-a
+disable alternate screens in terminal
 .TP
-.B \-t <title>
-Overrides the default title (st)
+.BI \-c " class"
+defines the window class (default $TERM).
 .TP
-.BI \-v
-Prints version information to standard output, then exits.
+.BI \-f " font"
+defines the
+.I font
+to use when st is run.
+.TP
+.BI \-g " geometry"
+defines the X11 geometry string.
+The form is [=][<cols>{xX}<rows>][{+-}<xoffset>{+-}<yoffset>]. See
+.BR XParseGeometry (3)
+for further details.
+.TP
+.B \-i
+will fixate the position given with the -g option.
+.TP
+.BI \-o " file"
+writes all the I/O to
+.I file.
+This feature is useful when recording st sessions. A value of "-" means
+standard output.
+.TP
+.BI \-t " title"
+defines the window title (default 'st').
+.TP
+.BI \-w " windowid"
+embeds st within the window identified by 
+.I windowid
+.TP
+.B \-v
+prints version information to stderr, then exits.
+.TP
+.BI \-e " program " [ " arguments " "... ]"
+st executes
+.I program
+instead of the shell.  If this is used it
+.B must be the last option
+on the command line, as in xterm / rxvt.
+.SH CUSTOMIZATION
+.B st
+can be customized by creating a custom config.h and (re)compiling the source
+code. This keeps it fast, secure and simple.
+.SH AUTHORS
+See the LICENSE file for the authors.
+.SH LICENSE
+See the LICENSE file for the terms of redistribution.
+.SH SEE ALSO
+.BR tabbed (1)
+.SH BUGS
+See the TODO file in the distribution.
+