st \- simple terminal
.SH SYNOPSIS
.B st
-.RB [ \-a ]
+.RB [ \-aiv ]
.RB [ \-c
.IR class ]
.RB [ \-f
.IR font ]
.RB [ \-g
.IR geometry ]
-.RB [ \-i ]
+.RB [ \-n
+.IR name ]
.RB [ \-o
-.IR file ]
-.RB [ \-t
+.IR iofile ]
+.RB [ \-T
.IR title ]
-.RB [ \-w
+.RB [ \-t
+.IR title ]
+.RB [ \-l
+.IR line ]
+.RB [ \-w
+.IR windowid ]
+.RB [[ \-e ]
+.IR command
+.RI [ arguments ...]]
+.PP
+.B st
+.RB [ \-aiv ]
+.RB [ \-c
+.IR class ]
+.RB [ \-f
+.IR font ]
+.RB [ \-g
+.IR geometry ]
+.RB [ \-n
+.IR name ]
+.RB [ \-o
+.IR iofile ]
+.RB [ \-T
+.IR title ]
+.RB [ \-t
+.IR title ]
+.RB [ \-w
.IR windowid ]
-.RB [ \-v ]
-.RB [ \-e
-.IR command ...]
+.RB \-l
+.IR line
+.RI [ stty_args ...]
.SH DESCRIPTION
.B st
is a simple terminal emulator.
.B \-i
will fixate the position given with the -g option.
.TP
-.BI \-o " file"
+.BI \-n " name"
+defines the window instance name (default $TERM).
+.TP
+.BI \-o " iofile"
writes all the I/O to
-.I file.
+.I iofile.
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 \-t " title"
defines the window title (default 'st').
.TP
.BI \-w " windowid"
-embeds st within the window identified by
+embeds st within the window identified by
.I windowid
.TP
+.BI \-l " line"
+use a tty
+.I line
+instead of a pseudo terminal.
+.I line
+should be a (pseudo-)serial device (e.g. /dev/ttyS0 on Linux for serial port
+0).
+When this flag is given
+remaining arguments are used as flags for
+.BR stty(1).
+By default st initializes the serial line to 8 bits, no parity, 1 stop bit
+and a 38400 baud rate. The speed is set by appending it as last argument
+(e.g. 'st -l /dev/ttyS0 115200'). Arguments before the last one are
+.BR stty(1)
+flags. If you want to set odd parity on 115200 baud use for example 'st -l
+/dev/ttyS0 parenb parodd 115200'. Set the number of bits by using for
+example 'st -l /dev/ttyS0 cs7 115200'. See
+.BR stty(1)
+for more arguments and cases.
+.TP
.B \-v
prints version information to stderr, then exits.
.TP
-.BI \-e " program " [ " arguments " "... ]"
+.BI \-e " command " [ " arguments " "... ]"
st executes
-.I program
+.I command
instead of the shell. If this is used it
.B must be the last option
on the command line, as in xterm / rxvt.
-.SH USAGE
+This option is only intended for compatibility,
+and all the remaining arguments are used as a command
+even without it.
+.SH SHORTCUTS
+.TP
+.B Break
+Send a break in the serial line.
+Break key is obtained in PC keyboards
+pressing at the same time control and pause.
.TP
.B Ctrl-Print Screen
-toggleprinter()
+Toggle if st should print to the
+.I iofile.
.TP
.B Shift-Print Screen
-printscreen()
+Print the full screen to the
+.I iofile.
.TP
.B Print Screen
-printsel()
+Print the selection to the
+.I iofile.
+.TP
+.B Ctrl-Shift-Page Up
+Increase font size.
.TP
-.B Alt-Shift-Page Up
-increase font size
+.B Ctrl-Shift-Page Down
+Decrease font size.
.TP
-.B Alt-Shift-Page Down
-decrease font size
+.B Ctrl-Shift-Home
+Reset to default font size.
.TP
-.B Alt-Shift-Home
-reset to default font size
+.B Ctrl-Shift-y
+Paste from primary selection (middle mouse button).
.TP
-.B Shift-Insert
-paste from primary selection
+.B Ctrl-Shift-c
+Copy the selected text to the clipboard selection.
.TP
-.B Alt-Shift-Insert
-paste from clipboard selection
+.B Ctrl-Shift-v
+Paste from the clipboard selection.
.SH CUSTOMIZATION
.B st
can be customized by creating a custom config.h and (re)compiling the source
.SH LICENSE
See the LICENSE file for the terms of redistribution.
.SH SEE ALSO
-.BR tabbed (1)
+.BR tabbed (1),
+.BR utmp (1),
+.BR stty (1),
+.BR scroll (1)
.SH BUGS
See the TODO file in the distribution.
projects / st.git / blobdiff