Avoid recursive call to ttywrite from ttyread

[st.git] / st.1

diff --git a/st.1 b/st.1
index 82e228a023e952a2139f79c5c06223a9e1998793..187a7349c83e5daf3fa55ad2c6a2e232bdd2b127 100644 (file)
--- a/st.1
+++ b/st.1
@@ -41,13 +41,11 @@ st \- simple terminal
 .IR title ]
 .RB [ \-T
 .IR title ]
-.RB [ \-l
-.IR line ]
 .RB [ \-w
 .IR windowid ]
 .RB [ \-v ]
-.RB [ \-l
-.IR line ]
+.RB \-l
+.IR line
 .RI [ stty_args ...]
 .SH DESCRIPTION
 .B st
@@ -91,9 +89,24 @@ 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.
+use a tty
+.I line
+instead of a pseudo terminal.
+.I line
+should be a (pseudo-)serial device (e.g. /dev/ttySO 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 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
+parenb parodd 115200'. Set the number of bits by using for example 'st -l cs7
+115200'. See
+.BR stty(1)
+for more arguments and cases.
 .TP
 .B \-v
 prints version information to stderr, then exits.
@@ -109,6 +122,11 @@ 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
 Toggle if st should print to the
 .I iofile.