diff options
Diffstat (limited to 'doc/sciteco.7.template')
-rw-r--r-- | doc/sciteco.7.template | 57 |
1 files changed, 48 insertions, 9 deletions
diff --git a/doc/sciteco.7.template b/doc/sciteco.7.template index f9cad80..b274715 100644 --- a/doc/sciteco.7.template +++ b/doc/sciteco.7.template @@ -300,6 +300,15 @@ The default action is \fBnot\fP performed when \(lq^KCLOSE\(rq has merely been masked out in the current parser state (see below). .TP +.SCITECO_TOPIC ^KMOUSE +.B ^KMOUSE +Mouse event occurred. +This will not be delivered on Curses unless bit 7 (64) is set in the +\fBED\fP flags. +You can use \fBEJ\fP with negative keys to retrieve +the event type, mouse coordinates and other information +about the last mouse event. +.TP .BI ^K x Any other key with printable representation and all control codes are looked up with a \(lq^K\(rq prefix. @@ -746,10 +755,12 @@ Global and local Q-Registers are not affected by command line termination. .SS Auto Completion . .SCITECO_TOPIC autocomplete -The immediate editing commands that perform auto-completions, do +The immediate editing commands, that perform auto-completions, do so in a manner similar to Posix shells. Upon first invocation they try to fully or partially complete the file name (or token). +If the token can be fully completed, the current command or Q-Register +specification will also usually be terminated automatically. If no completion can be performed, the invocation will display a list of file names (or tokens) that begin with the token to complete in \*(ST's popup area. @@ -761,6 +772,15 @@ of file names or tokens is displayed in the popup area. I.e. it is possible to cycle through long lists of possible auto-completions. .LP +You can also scroll through the popup area with the mouse wheel. +Furthermore, you can click on entries in the popup area with the +mouse in order to fully complete them. +Often this will also automatically terminate the current command or +Q-Register specification, just like an unambiguous completion via +immediate editing commands. +On Curses, mouse events are not processed unless bit 7 (64) is set +in the \fBED\fP flags. +.LP When completing file names, hidden files are not considered for completion unless a prefix of the hidden file's name has already been typed. @@ -780,6 +800,13 @@ file names with \(lq./\(rq. This is useful for writing cross-platform \*(ST macros (see .BR "FILE NAMES AND DIRECTORIES" ). .LP +File name completions are case-sensitive or insensitive depending +on operating system defaults. +On some operating systems \*(ST can determine the case-sensitivity +of individual directories as well. +\# Should be supported on Mac OS and newer versions of Windows, +\# but it's still untested. +.LP Note that completions take place after string building and tilde-expansion is also performed by file name completions, so for instance both \(lq~/foo\(rq and \(lq^EQ[$HOME]/foo\(rq @@ -1553,10 +1580,10 @@ The existence of a clipboard register can thus be checked in macros to determine whether getting and modifying that particular clipboard is supported natively. .br +\*(ST supports two ways of driving the clipboard on ncurses. .SCITECO_TOPIC OSC-52 xterm -\*(ST does \fBnot\fP generally support clipboards on ncurses, -but has special support for OSC-52 escape sequences, as were -introduced by sufficiently recent versions of +First of all, there is built-in support for OSC-52 escape sequences, +as were introduced by sufficiently recent versions of .BR xterm (1) and have since been adopted by several other terminal emulators. Since the operability of OSC-52 clipboards cannot be tested @@ -1566,6 +1593,7 @@ configured. .BR xterm (1) for instance must be configured for allowing the \fISetSelection\fP and \fIGetSelection\fP window operations. +It is nevertheless observed to be a very buggy and unreliable feature. If running under .BR xterm (1), \*(ST will still check whether the XTerm version is sufficient. @@ -1574,10 +1602,16 @@ Other terminal emulators like Kitty may ask for permission to read the clipboard (\fBread-clipboard-ask\fP). This is not supported by \*(ST and must be disabled (use \fBread-clipboard\fP instead). -.SCITECO_TOPIC xclip -If native clipboard support is unavailable, users may -still fall back to using external tools like \fBxclip\fP(1) -with the \fBEC\fP command. +.br +Alternatively, if OSC-52 clipboards are disabled, you can set the +\fB$SCITECO_CLIPBOARD_SET\fP and \fB$SCITECO_CLIPBOARD_GET\fP +environment variables (or corresponding Q-Registers) to shell +commands, that receive the clipboard +contents on stdin and output the requested clipboard on stdout. +This allows integrating with various windowing environments. +See \fBENVIRONMENT\fP in +.BR sciteco (1) +for more details. .br Setting the string part of a clipboard register will set that clipboard. \*(ST will perform automatic EOL-translation according @@ -2078,7 +2112,7 @@ The most basic flow control command in \*(ST is the Go-to command. Since it is really an ordinary command, exceptional only in setting the program counter and influencing parsing, it is described in this document's command reference. -\*(ST may do simple unconditional and computed gotos. +\*(ST can perform simple unconditional and computed gotos. .LP .SCITECO_TOPIC label Labels are symbolic and are defined with the following syntax: @@ -2093,9 +2127,14 @@ When a label is encountered, it is cached in a macro-invocation level specific goto table if it is not in there already. Therefore every macro invocation has its own label namespace and gotos to a label have constant complexity once a label has been parsed. +\# The table lookup is not constant of course. Terminating a macro execution (or command line) fails if a label that is jumped to has not been defined. Labels are also historically used as comments in TECO code. +That's why \*(ST allows several identical labels in the same scope \(em +goto commands will always jump to the first occurrance of the label. +In case of label redefinition, a warning will be printed, so you are +encouraged to use \(lqtrue\(rq comments as described below. . .SS Comments .SCITECO_TOPIC comment |