Set the path of pkg-config in a variable instead of hardcoding it

[st.git] / st.1

diff --git a/st.1 b/st.1
index 82e228a..e8d6059 100644 (file)
--- a/st.1
+++ b/st.1
@@ -3,51 +3,49 @@
 st \- simple terminal
 .SH SYNOPSIS
 .B st
 st \- simple terminal
 .SH SYNOPSIS
 .B st

-.RB [ \-a ]
+.RB [ \-aiv ]

 .RB [ \-c
 .IR class ]
 .RB [ \-f
 .IR font ]
 .RB [ \-g
 .IR geometry ]
 .RB [ \-c
 .IR class ]
 .RB [ \-f
 .IR font ]
 .RB [ \-g
 .IR geometry ]

-.RB [ \-i ]
+.RB [ \-n
+.IR name ]

 .RB [ \-o
 .RB [ \-o

-.IR file ]
-.RB [ \-t 
-.IR title ]
+.IR iofile ]

 .RB [ \-T
 .IR title ]
 .RB [ \-T
 .IR title ]

+.RB [ \-t
+.IR title ]

 .RB [ \-l
 .IR line ]
 .RB [ \-l
 .IR line ]

-.RB [ \-w 
+.RB [ \-w

 .IR windowid ]
 .IR windowid ]

-.RB [ \-v ]
-.RB [ \-e
-.IR command ...]
-.RI [ commands ...]
+.RB [[ \-e ]
+.IR command
+.RI [ arguments ...]]

 .PP
 .B st
 .PP
 .B st

-.RB [ \-a ]
+.RB [ \-aiv ]

 .RB [ \-c
 .IR class ]
 .RB [ \-f
 .IR font ]
 .RB [ \-g
 .IR geometry ]
 .RB [ \-c
 .IR class ]
 .RB [ \-f
 .IR font ]
 .RB [ \-g
 .IR geometry ]

-.RB [ \-i ]
+.RB [ \-n
+.IR name ]

 .RB [ \-o
 .RB [ \-o

-.IR file ]
-.RB [ \-t
-.IR title ]
+.IR iofile ]

 .RB [ \-T
 .IR title ]
 .RB [ \-T
 .IR title ]

-.RB [ \-l
-.IR line ]
+.RB [ \-t
+.IR title ]

 .RB [ \-w
 .IR windowid ]
 .RB [ \-w
 .IR windowid ]

-.RB [ \-v ]
-.RB [ \-l
-.IR line ]
+.RB \-l
+.IR line

 .RI [ stty_args ...]
 .SH DESCRIPTION
 .B st
 .RI [ stty_args ...]
 .SH DESCRIPTION
 .B st


@@ -74,41 +72,64 @@ for further details.
 .B \-i
 will fixate the position given with the -g option.
 .TP
 .B \-i
 will fixate the position given with the -g option.
 .TP

+.BI \-n " name"
+defines the window instance name (default $TERM).
+.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 \-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"
+.BI \-T " title"

 defines the window title (default 'st').
 .TP
 defines the window title (default 'st').
 .TP

-.BI \-T " title"
+.BI \-t " title"

 defines the window title (default 'st').
 .TP
 .BI \-w " windowid"
 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"
 .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/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
 .TP
 .B \-v
 prints version information to stderr, then exits.
 .TP

-.BI \-e " program " [ " arguments " "... ]"
+.BI \-e " command " [ " arguments " "... ]"

 st executes
 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.
 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,
+This option is only intended for compatibility,

 and all the remaining arguments are used as a command
 even without it.
 .SH SHORTCUTS
 .TP
 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.
 .B Ctrl-Print Screen
 Toggle if st should print to the
 .I iofile.


@@ -121,25 +142,22 @@ Print the full screen to the
 Print the selection to the
 .I iofile.
 .TP
 Print the selection to the
 .I iofile.
 .TP

-.B Alt-Shift-Page Up
+.B Ctrl-Shift-Page Up

 Increase font size.
 .TP
 Increase font size.
 .TP

-.B Alt-Shift-Page Down
+.B Ctrl-Shift-Page Down

 Decrease font size.
 .TP
 Decrease font size.
 .TP

-.B Alt-Shift-Home
+.B Ctrl-Shift-Home

 Reset to default font size.
 .TP
 Reset to default font size.
 .TP

-.B Shift-Insert
+.B Ctrl-Shift-y

 Paste from primary selection (middle mouse button).
 .TP
 Paste from primary selection (middle mouse button).
 .TP

-.B Alt-Shift-Insert
-Paste from clipboard selection.
-.TP
-.B Alt-Shift-c
+.B Ctrl-Shift-c

 Copy the selected text to the clipboard selection.
 .TP
 Copy the selected text to the clipboard selection.
 .TP

-.B Alt-Shift-v
+.B Ctrl-Shift-v

 Paste from the clipboard selection.
 .SH CUSTOMIZATION
 .B st
 Paste from the clipboard selection.
 .SH CUSTOMIZATION
 .B st