My build of suckless st terminal
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

172 lines
3.4 KiB

14 years ago
14 years ago
  1. .TH ST 1 st\-VERSION
  2. .SH NAME
  3. st \- simple terminal
  4. .SH SYNOPSIS
  5. .B st
  6. .RB [ \-aiv ]
  7. .RB [ \-c
  8. .IR class ]
  9. .RB [ \-f
  10. .IR font ]
  11. .RB [ \-g
  12. .IR geometry ]
  13. .RB [ \-o
  14. .IR iofile ]
  15. .RB [ \-T
  16. .IR title ]
  17. .RB [ \-t
  18. .IR title ]
  19. .RB [ \-l
  20. .IR line ]
  21. .RB [ \-w
  22. .IR windowid ]
  23. .RB [[ \-e ]
  24. .IR command
  25. .RI [ arguments ...]]
  26. .PP
  27. .B st
  28. .RB [ \-aiv ]
  29. .RB [ \-c
  30. .IR class ]
  31. .RB [ \-f
  32. .IR font ]
  33. .RB [ \-g
  34. .IR geometry ]
  35. .RB [ \-o
  36. .IR iofile ]
  37. .RB [ \-T
  38. .IR title ]
  39. .RB [ \-t
  40. .IR title ]
  41. .RB [ \-w
  42. .IR windowid ]
  43. .RB \-l
  44. .IR line
  45. .RI [ stty_args ...]
  46. .SH DESCRIPTION
  47. .B st
  48. is a simple terminal emulator.
  49. .SH OPTIONS
  50. .TP
  51. .B \-a
  52. disable alternate screens in terminal
  53. .TP
  54. .BI \-c " class"
  55. defines the window class (default $TERM).
  56. .TP
  57. .BI \-f " font"
  58. defines the
  59. .I font
  60. to use when st is run.
  61. .TP
  62. .BI \-g " geometry"
  63. defines the X11 geometry string.
  64. The form is [=][<cols>{xX}<rows>][{+-}<xoffset>{+-}<yoffset>]. See
  65. .BR XParseGeometry (3)
  66. for further details.
  67. .TP
  68. .B \-i
  69. will fixate the position given with the -g option.
  70. .TP
  71. .BI \-o " iofile"
  72. writes all the I/O to
  73. .I iofile.
  74. This feature is useful when recording st sessions. A value of "-" means
  75. standard output.
  76. .TP
  77. .BI \-T " title"
  78. defines the window title (default 'st').
  79. .TP
  80. .BI \-t " title"
  81. defines the window title (default 'st').
  82. .TP
  83. .BI \-w " windowid"
  84. embeds st within the window identified by
  85. .I windowid
  86. .TP
  87. .BI \-l " line"
  88. use a tty
  89. .I line
  90. instead of a pseudo terminal.
  91. .I line
  92. should be a (pseudo-)serial device (e.g. /dev/ttySO on Linux for serial port
  93. 0).
  94. When this flag is given
  95. remaining arguments are used as flags for
  96. .BR stty(1).
  97. By default st initializes the serial line to 8 bits, no parity, 1 stop bit
  98. and a 38400 baud rate. The speed is set by appending it as last argument
  99. (e.g. 'st -l 115200'). Arguments before the last one are
  100. .BR stty(1)
  101. flags. If you want to set odd parity on 115200 baud use for example 'st -l
  102. parenb parodd 115200'. Set the number of bits by using for example 'st -l cs7
  103. 115200'. See
  104. .BR stty(1)
  105. for more arguments and cases.
  106. .TP
  107. .B \-v
  108. prints version information to stderr, then exits.
  109. .TP
  110. .BI \-e " command " [ " arguments " "... ]"
  111. st executes
  112. .I command
  113. instead of the shell. If this is used it
  114. .B must be the last option
  115. on the command line, as in xterm / rxvt.
  116. This option is only intended for compability,
  117. and all the remaining arguments are used as a command
  118. even without it.
  119. .SH SHORTCUTS
  120. .TP
  121. .B Break
  122. Send a break in the serial line.
  123. Break key is obtained in PC keyboards
  124. pressing at the same time control and pause.
  125. .TP
  126. .B Ctrl-Print Screen
  127. Toggle if st should print to the
  128. .I iofile.
  129. .TP
  130. .B Shift-Print Screen
  131. Print the full screen to the
  132. .I iofile.
  133. .TP
  134. .B Print Screen
  135. Print the selection to the
  136. .I iofile.
  137. .TP
  138. .B Alt-Shift-Page Up
  139. Increase font size.
  140. .TP
  141. .B Alt-Shift-Page Down
  142. Decrease font size.
  143. .TP
  144. .B Alt-Shift-Home
  145. Reset to default font size.
  146. .TP
  147. .B Shift-Insert
  148. Paste from primary selection (middle mouse button).
  149. .TP
  150. .B Alt-Shift-Insert
  151. Paste from clipboard selection.
  152. .TP
  153. .B Alt-Shift-c
  154. Copy the selected text to the clipboard selection.
  155. .TP
  156. .B Alt-Shift-v
  157. Paste from the clipboard selection.
  158. .SH CUSTOMIZATION
  159. .B st
  160. can be customized by creating a custom config.h and (re)compiling the source
  161. code. This keeps it fast, secure and simple.
  162. .SH AUTHORS
  163. See the LICENSE file for the authors.
  164. .SH LICENSE
  165. See the LICENSE file for the terms of redistribution.
  166. .SH SEE ALSO
  167. .BR tabbed (1),
  168. .BR utmp (1),
  169. .BR stty (1)
  170. .SH BUGS
  171. See the TODO file in the distribution.