st/st.1

.TH ST 1 st\-VERSION
.SH NAME
st \- simple terminal
.SH SYNOPSIS
.B st
.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 [ \-l
.IR line ]
.RB [ \-w 
.IR windowid ]
.RB [ \-v ]
.RB [ \-e
.IR command ...]
.RI [ commands ...]
.PP
.B st
.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 [ \-l
.IR line ]
.RB [ \-w
.IR windowid ]
.RB [ \-v ]
.RB [ \-l
.IR line ]
.RI [ stty_args ...]
.SH DESCRIPTION
.B st
is a simple terminal emulator.
.SH OPTIONS
.TP
.B \-a
disable alternate screens in terminal
.TP
.BI \-c " class"
defines the window class (default $TERM).
.TP
.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 " iofile"
writes all the I/O to
.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 \-w " windowid"
embeds st within the window identified by 
.I windowid
.TP
.BI \-l " line"
use a tty line instead of a pseudo terminal.
When this flag is used
remaining arguments are used as flags for stty.
.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.
This option is only intended for compability,
and all the remaining arguments are used as a command
even without it.
.SH SHORTCUTS
.TP
.B Ctrl-Print Screen
Toggle if st should print to the
.I iofile.
.TP
.B Shift-Print Screen
Print the full screen to the
.I iofile.
.TP
.B Print Screen
Print the selection to the
.I iofile.
.TP
.B Alt-Shift-Page Up
Increase font size.
.TP
.B Alt-Shift-Page Down
Decrease font size.
.TP
.B Alt-Shift-Home
Reset to default font size.
.TP
.B Shift-Insert
Paste from primary selection (middle mouse button).
.TP
.B Alt-Shift-Insert
Paste from clipboard selection.
.TP
.B Alt-Shift-c
Copy the selected text to the clipboard selection.
.TP
.B Alt-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
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),
.BR utmp (1),
.BR stty (1)
.SH BUGS
See the TODO file in the distribution.
applied parts of Connor Lane Smith's cleanup patch. 2011-05-14 11:47:37 -04:00			`.TH ST 1 st\-VERSION`
added manpage. 2010-09-01 20:02:56 -04:00			`.SH NAME`
			`st \- simple terminal`
			`.SH SYNOPSIS`
			`.B st`
Add an option to disable alternative screens. 2013-04-03 14:42:27 -04:00			`.RB [ \-a ]`
change -e behaviour and update man page. 2010-11-30 16:55:44 -05:00			`.RB [ \-c`
			`.IR class ]`
This changes -f to be the parameter for the font. Now -f is -o. The parameters were reordered according to the alphabet too. 2012-09-30 14:23:10 -04:00			`.RB [ \-f`
			`.IR font ]`
Add -g geometry to st and the manpage. 2012-09-03 17:02:29 -04:00			`.RB [ \-g`
			`.IR geometry ]`
Conformity in the -g geometry handling. Thanks to Yuri Karaban for suggesting this! These changes make -g correspond to <cols>x<rows> and honor it so non-tiling window managers can work with the size hints afterwards. It also adds a -i flag to force the window size. This is needed so -g keeps being useful in dwm. 2014-04-25 16:34:24 -04:00			`.RB [ \-i ]`
This changes -f to be the parameter for the font. Now -f is -o. The parameters were reordered according to the alphabet too. 2012-09-30 14:23:10 -04:00			`.RB [ \-o`
			`.IR file ]`
change -e behaviour and update man page. 2010-11-30 16:55:44 -05:00			`.RB [ \-t`
			`.IR title ]`
Add tty line support Not always is desirable to create a pseudo terminal, and some times we want to open a terminal emulator over a tty line. With this new patch is possible to do someting like: $ st -l /dev/ttyS0 115200 Without this option was needed to launch another terminal emulator over st (for example minicom, picocom, cu, ...). 2015-04-13 13:03:53 -04:00			`.RB [ \-l`
			`.IR line ]`
add -w option to embed st. (thx nodus cursorius) 2011-06-08 15:35:58 -04:00			`.RB [ \-w`
			`.IR windowid ]`
added manpage. 2010-09-01 20:02:56 -04:00			`.RB [ \-v ]`
change -e behaviour and update man page. 2010-11-30 16:55:44 -05:00			`.RB [ \-e`
applied parts of Connor Lane Smith's cleanup patch. 2011-05-14 11:47:37 -04:00			`.IR command ...]`
Add tty line support Not always is desirable to create a pseudo terminal, and some times we want to open a terminal emulator over a tty line. With this new patch is possible to do someting like: $ st -l /dev/ttyS0 115200 Without this option was needed to launch another terminal emulator over st (for example minicom, picocom, cu, ...). 2015-04-13 13:03:53 -04:00			`.RI [ commands ...]`
			`.PP`
			`.B st`
			`.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 [ \-l`
			`.IR line ]`
			`.RB [ \-w`
			`.IR windowid ]`
			`.RB [ \-v ]`
			`.RB [ \-l`
			`.IR line ]`
			`.RI [ stty_args ...]`
added manpage. 2010-09-01 20:02:56 -04:00			`.SH DESCRIPTION`
			`.B st`
			`is a simple terminal emulator.`
			`.SH OPTIONS`
			`.TP`
Add an option to disable alternative screens. 2013-04-03 14:42:27 -04:00			`.B \-a`
			`disable alternate screens in terminal`
			`.TP`
applied parts of Connor Lane Smith's cleanup patch. 2011-05-14 11:47:37 -04:00			`.BI \-c " class"`
			`defines the window class (default $TERM).`
Add -c option to override the default window class 2010-11-19 11:13:13 -05:00			`.TP`
This changes -f to be the parameter for the font. Now -f is -o. The parameters were reordered according to the alphabet too. 2012-09-30 14:23:10 -04:00			`.BI \-f " font"`
			`defines the`
			`.I font`
			`to use when st is run.`
			`.TP`
			`.BI \-g " geometry"`
Conformity in the -g geometry handling. Thanks to Yuri Karaban for suggesting this! These changes make -g correspond to <cols>x<rows> and honor it so non-tiling window managers can work with the size hints afterwards. It also adds a -i flag to force the window size. This is needed so -g keeps being useful in dwm. 2014-04-25 16:34:24 -04:00			`defines the X11 geometry string.`
			`The form is [=][<cols>{xX}<rows>][{+-}<xoffset>{+-}<yoffset>]. See`
Fix the geometry handling. 2013-04-13 09:24:26 -04:00			`.BR XParseGeometry (3)`
			`for further details.`
This changes -f to be the parameter for the font. Now -f is -o. The parameters were reordered according to the alphabet too. 2012-09-30 14:23:10 -04:00			`.TP`
Fix man page and usage() Man page was repeating -f option, the second time instead of -i, and this option was lost in usage() message. This patch also indent the output of usage(). 2014-08-17 14:49:33 -04:00			`.B \-i`
Conformity in the -g geometry handling. Thanks to Yuri Karaban for suggesting this! These changes make -g correspond to <cols>x<rows> and honor it so non-tiling window managers can work with the size hints afterwards. It also adds a -i flag to force the window size. This is needed so -g keeps being useful in dwm. 2014-04-25 16:34:24 -04:00			`will fixate the position given with the -g option.`
			`.TP`
Add the new selection shortcuts to the manpage. 2015-03-14 03:52:37 -04:00			`.BI \-o " iofile"`
This changes -f to be the parameter for the font. Now -f is -o. The parameters were reordered according to the alphabet too. 2012-09-30 14:23:10 -04:00			`writes all the I/O to`
Add the new selection shortcuts to the manpage. 2015-03-14 03:52:37 -04:00			`.I iofile.`
This changes -f to be the parameter for the font. Now -f is -o. The parameters were reordered according to the alphabet too. 2012-09-30 14:23:10 -04:00			`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`
add -w option to embed st. (thx nodus cursorius) 2011-06-08 15:35:58 -04:00			`.BI \-w " windowid"`
			`embeds st within the window identified by`
			`.I windowid`
			`.TP`
Add tty line support Not always is desirable to create a pseudo terminal, and some times we want to open a terminal emulator over a tty line. With this new patch is possible to do someting like: $ st -l /dev/ttyS0 115200 Without this option was needed to launch another terminal emulator over st (for example minicom, picocom, cu, ...). 2015-04-13 13:03:53 -04:00			`.BI \-l " line"`
			`use a tty line instead of a pseudo terminal.`
			`When this flag is used`
			`remaining arguments are used as flags for stty.`
			`.TP`
change -e behaviour and update man page. 2010-11-30 16:55:44 -05:00			`.B \-v`
applied parts of Connor Lane Smith's cleanup patch. 2011-05-14 11:47:37 -04:00			`prints version information to stderr, then exits.`
change -e behaviour and update man page. 2010-11-30 16:55:44 -05:00			`.TP`
applied parts of Connor Lane Smith's cleanup patch. 2011-05-14 11:47:37 -04:00			`.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.`
Add tty line support Not always is desirable to create a pseudo terminal, and some times we want to open a terminal emulator over a tty line. With this new patch is possible to do someting like: $ st -l /dev/ttyS0 115200 Without this option was needed to launch another terminal emulator over st (for example minicom, picocom, cu, ...). 2015-04-13 13:03:53 -04:00			`This option is only intended for compability,`
			`and all the remaining arguments are used as a command`
			`even without it.`
Add the new selection shortcuts to the manpage. 2015-03-14 03:52:37 -04:00			`.SH SHORTCUTS`
document keys in man page 2015-02-19 16:33:22 -05:00			`.TP`
			`.B Ctrl-Print Screen`
Add the new selection shortcuts to the manpage. 2015-03-14 03:52:37 -04:00			`Toggle if st should print to the`
			`.I iofile.`
document keys in man page 2015-02-19 16:33:22 -05:00			`.TP`
			`.B Shift-Print Screen`
Add the new selection shortcuts to the manpage. 2015-03-14 03:52:37 -04:00			`Print the full screen to the`
			`.I iofile.`
document keys in man page 2015-02-19 16:33:22 -05:00			`.TP`
			`.B Print Screen`
Add the new selection shortcuts to the manpage. 2015-03-14 03:52:37 -04:00			`Print the selection to the`
			`.I iofile.`
document keys in man page 2015-02-19 16:33:22 -05:00			`.TP`
			`.B Alt-Shift-Page Up`
Add the new selection shortcuts to the manpage. 2015-03-14 03:52:37 -04:00			`Increase font size.`
document keys in man page 2015-02-19 16:33:22 -05:00			`.TP`
			`.B Alt-Shift-Page Down`
Add the new selection shortcuts to the manpage. 2015-03-14 03:52:37 -04:00			`Decrease font size.`
document keys in man page 2015-02-19 16:33:22 -05:00			`.TP`
			`.B Alt-Shift-Home`
Add the new selection shortcuts to the manpage. 2015-03-14 03:52:37 -04:00			`Reset to default font size.`
document keys in man page 2015-02-19 16:33:22 -05:00			`.TP`
			`.B Shift-Insert`
Add the new selection shortcuts to the manpage. 2015-03-14 03:52:37 -04:00			`Paste from primary selection (middle mouse button).`
document keys in man page 2015-02-19 16:33:22 -05:00			`.TP`
			`.B Alt-Shift-Insert`
Add the new selection shortcuts to the manpage. 2015-03-14 03:52:37 -04:00			`Paste from clipboard selection.`
			`.TP`
			`.B Alt-Shift-c`
			`Copy the selected text to the clipboard selection.`
			`.TP`
			`.B Alt-Shift-v`
			`Paste from the clipboard selection.`
Adding some more fields to the manpage, like authors, license etc. 2012-09-16 07:59:10 -04:00			`.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`
Add tty line support Not always is desirable to create a pseudo terminal, and some times we want to open a terminal emulator over a tty line. With this new patch is possible to do someting like: $ st -l /dev/ttyS0 115200 Without this option was needed to launch another terminal emulator over st (for example minicom, picocom, cu, ...). 2015-04-13 13:03:53 -04:00			`.BR tabbed (1),`
			`.BR utmp (1),`
			`.BR stty (1)`
Adding some more fields to the manpage, like authors, license etc. 2012-09-16 07:59:10 -04:00			`.SH BUGS`
			`See the TODO file in the distribution.`