1tecla(5) Standards, Environments, and Macros tecla(5)
2
6 tecla, teclarc - User interface provided by the tecla library.
7
9 This man page describes the command-line editing features that are
10 available to users of programs that read keyboard input via the tecla
11 library. Users of the tcsh shell will find the default key bindings
12 very familiar. Users of the bash shell will also find it quite famil‐
13 iar, but with a few minor differences, most notably in how forward and
14 backward searches through the list of historical commands are per‐
15 formed. There are two major editing modes, one with emacs-like key
16 bindings and another with vi-like key bindings. By default emacs mode
17 is enabled, but vi(1) mode can alternatively be selected via the user's
18 configuration file. This file can also be used to change the bindings
19 of individual keys to suit the user's preferences. By default, tab com‐
20 pletion is provided. If the application hasn't reconfigured this to
21 complete other types of symbols, then tab completion completes file
22 names.
23 Key Sequence Notation
25 In the rest of this man page, and also in all tecla configuration
26 files, key sequences are expressed as follows.
27 ^A or C-a This is a 'CONTROL-A', entered by pressing the CONTROL key
29 at the same time as the 'A' key.
30 \fR or M- In key sequences, both of these notations can be entered
33 either by pressing the ESCAPE key, then the following key,
34 or by pressing the META key at the same time as the fol‐
35 lowing key. Thus the key sequence M-p can be typed in two
36 ways, by pressing the ESCAPE key, followed by pressing
37 'P', or by pressing the META key at the same time as 'P'.
38 up This refers to the up-arrow key.
41 down This refers to the down-arrow key.
44 left This refers to the left-arrow key.
47 right This refers to the right-arrow key.
50 a This is just a normal 'A' key.
53 The Tecla Configuration File
56 By default, tecla looks for a file called .teclarc in your home direc‐
57 tory (ie. ~/.teclarc). If it finds this file, it reads it, interpreting
58 each line as defining a new key binding or an editing configuration
59 option. Since the emacs key-bindings are installed by default, if you
60 want to use the non-default vi editing mode, the most important item to
61 go in this file is the following line:
62 edit-mode vi
64 This will re-configure the default bindings for vi-mode. The complete
68 set of arguments that this command accepts are:
69 vi Install key bindings like those of the vi editor.
71 emacs Install key bindings like those of the emacs editor. This is
74 the default.
75 none Use just the native line editing facilities provided by the
78 terminal driver.
79 To prevent the terminal bell from being rung, such as when an unrecog‐
83 nized control-sequence is typed, place the following line in the con‐
84 figuration file:
85 nobeep
87 An example of a key binding line in the configuration file is the fol‐
91 lowing.
92 bind M-[2~ insert-mode
94 On many keyboards, the above key sequence is generated when one presses
98 the insert key, so with this key binding, one can toggle between the
99 emacs-mode insert and overwrite modes by hitting one key. One could
100 also do it by typing out the above sequence of characters one by one.
101 As explained above, the M- part of this sequence can be typed either by
102 pressing the ESCAPE key before the following key, or by pressing the
103 META key at the same time as the following key. Thus if you had set the
104 above key binding, and the insert key on your keyboard didn't generate
105 the above key sequence, you could still type it in either of the fol‐
106 lowing 2 ways.
107 1. Hit the ESCAPE key momentarily, then press '[', then '2',
109 then finally '~'.
110 2. Press the META key at the same time as pressing the '[' key,
112 then press '2', then '~'.
113 If you set a key binding for a key sequence that is already bound to a
116 function, the new binding overrides the old one. If in the new binding
117 you omit the name of the new function to bind to the key sequence, the
118 original binding becomes undefined.
119 Starting with versions of libtecla later than 1.3.3 it is now possible
122 to bind key sequences that begin with a printable character. Previously
123 key sequences were required to start with a CONTROL or META character.
124 Note that the special keywords "up", "down", "left", and "right" refer
127 to the arrow keys, and are thus not treated as key sequences. So, for
128 example, to rebind the up and down arrow keys to use the history search
129 mechanism instead of the simple history recall method, you could place
130 the following in your configuration file:
131 bind up history-search-backwards
133 bind down history-search-backwards
134 To unbind an existing binding, you can do this with the bind command by
138 omitting to name any action to rebind the key sequence to. For example,
139 by not specifying an action function, the following command unbinds the
140 default beginning-of-line action from the ^A key sequence:
141 bind ^A
143 If you create a ~/.teclarc configuration file, but it appears to have
147 no effect on the program, check the documentation of the program to see
148 if the author chose a different name for this file.
149 Filename and Tilde Completion
151 With the default key bindings, pressing the TAB key (aka. ^I) results
152 in tecla attempting to complete the incomplete file name that precedes
153 the cursor. Tecla searches backwards from the cursor, looking for the
154 start of the file name, stopping when it hits either a space or the
155 start of the line. If more than one file has the specified prefix, then
156 tecla completes the file name up to the point at which the ambiguous
157 matches start to differ, then lists the possible matches.
158 In addition to literally written file names, tecla can complete files
161 that start with ~/ and ~user/ expressions and that contain $envvar
162 expressions. In particular, if you hit TAB within an incomplete ~user,
163 expression, tecla will attempt to complete the username, listing any
164 ambiguous matches.
165 The completion binding is implemented using the cpl_complete_word()
168 function, which is also available separately to users of this library.
169 See the cpl_complete_word(3TECLA) man page for more details.
170 Filename Expansion
172 With the default key bindings, pressing ^X* causes tecla to expand the
173 file name that precedes the cursor, replacing ~/ and ~user/ expressions
174 with the corresponding home directories, and replacing $envvar expres‐
175 sions with the value of the specified environment variable, then if
176 there are any wildcards, replacing the so far expanded file name with a
177 space-separated list of the files which match the wild cards.
178 The expansion binding is implemented using the ef_expand_file() func‐
181 tion. See the ef_expand_file(3TECLA) man page for more details.
182 Recalling Previously Typed Lines
184 Every time that a new line is entered by the user, it is appended to a
185 list of historical input lines maintained within the GetLine resource
186 object. You can traverse up and down this list using the up and down
187 arrow keys. Alternatively, you can do the same with the ^P, and ^N
188 keys, and in vi command mode you can alternatively use the k and j
189 characters. Thus pressing up-arrow once, replaces the current input
190 line with the previously entered line. Pressing up-arrow again,
191 replaces this with the line that was entered before it, etc.. Having
192 gone back one or more lines into the history list, one can return to
193 newer lines by pressing down-arrow one or more times. If you do this
194 sufficient times, you will return to the original line that you were
195 entering when you first hit up-arrow.
196 Note that in vi mode, all of the history recall functions switch the
199 library into command mode.
200 In emacs mode the M-p and M-n keys work just like the ^P and ^N keys,
203 except that they skip all but those historical lines which share the
204 prefix that precedes the cursor. In vi command mode the upper case 'K'
205 and 'J' characters do the same thing, except that the string that they
206 search for includes the character under the cursor as well as what pre‐
207 cedes it.
208 Thus for example, suppose that you were in emacs mode, and you had just
211 entered the following list of commands in the order shown:
212 ls ~/tecla/
214 cd ~/tecla
215 ls -l getline.c
216 emacs ~/tecla/getline.c
217 If you next typed:
221 ls
223 and then hit M-p, then rather than returning the previously typed emacs
227 line, which doesn't start with "ls", tecla would recall the "ls -l get‐
228 line.c" line. Pressing M-p again would recall the "ls ~/tecla/" line.
229 Note that if the string that you are searching for, contains any of the
232 special characters, *, ?, or '[', then it is interpretted as a pattern
233 to be matched. Thus, cotinuing with the above example, after typing in
234 the list of commands shown, if you then typed:
235 *tecla*
237 and hit M-p, then the "emacs ~/tecla/getline.c" line would be recalled
241 first, since it contains the word tecla somewhere in the line, Simi‐
242 larly, hitting M-p again, would recall the "ls ~/tecla/" line, and hit‐
243 ting it once more would recall the "ls ~/tecla/" line. The pattern syn‐
244 tax is the same as that described for file name expansion, in the
245 ef_expand_file(3TECLA).
246 History Files
248 Authors of programs that use the tecla library have the option of sav‐
249 ing historical command-lines in a file before exiting, and subsequently
250 reading them back in from this file when the program is next started.
251 There is no standard name for this file, since it makes sense for each
252 application to use its own history file, so that commands from differ‐
253 ent applications don't get mixed up.
254 International Character Sets
256 Since libtecla version 1.4.0, tecla has been 8-bit clean. This means
257 that all 8-bit characters that are printable in the user's current
258 locale are now displayed verbatim and included in the returned input
259 line. Assuming that the calling program correctly contains a call like
260 the following,
261 setlocale(LC_CTYPE, "");
263 then the current locale is determined by the first of the environment
267 variables LC_CTYPE, LC_ALL, and LANG, that is found to contain a valid
268 locale name. If none of these variables are defined, or the program
269 neglects to call setlocale, then the default C locale is used, which is
270 US 7-bit ASCII. On most unix-like platforms, you can get a list of
271 valid locales by typing the command:
272 locale -a
274 at the shell prompt.
278 Meta Keys and Locales
280 Beware that in most locales other than the default C locale, META char‐
281 acters become printable, and they are then no longer considered to
282 match M-c style key bindings. This allows international characters to
283 be entered with the compose key without unexpectedly triggering META
284 key bindings. You can still invoke META bindings, since there are actu‐
285 ally two ways to do this. For example the binding M-c can also be
286 invoked by pressing the ESCAPE key momentarily, then pressing the c
287 key, and this will work regardless of locale. Moreover, many modern
288 terminal emulators, such as gnome's gnome-terminal's and KDE's konsole
289 terminals, already generate escape pairs like this when you use the
290 META key, rather than a real meta character, and other emulators usu‐
291 ally have a way to request this behavior, so you can continue to use
292 the META key on most systems.
293 For example, although xterm terminal emulators generate real 8-bit meta
296 characters by default when you use the META key, they can be configured
297 to output the equivalent escape pair by setting their EightBitInput X
298 resource to False. You can either do this by placing a line like the
299 following in your ~/.Xdefaults file,
300 XTerm*EightBitInput: False
302 or by starting an xterm with an -xrm '*EightBitInput: False' command-
306 line argument. In recent versions of xterm you can toggle this feature
307 on and off with the 'Meta Sends Escape' option in the menu that is dis‐
308 played when you press the left mouse button and the CONTROL key within
309 an xterm window. In CDE, dtterms can be similarly coerced to generate
310 escape pairs in place of meta characters, by setting the Dtterm*KshMode
311 resource to True.
312 Entering International Characters
314 If you don't have a keyboard that generates all of the international
315 characters that you need, there is usually a compose key that will
316 allow you to enter special characters, or a way to create one. For
317 example, under X windows on unix-like systems, if your keyboard doesn't
318 have a compose key, you can designate a redundant key to serve this
319 purpose with the xmodmap command. For example, on many PC keyboards
320 there is a microsoft-windows key, which is otherwise useless under
321 Linux. On a laptop, for example, the xev program might report that
322 pressing this key generates keycode 115. To turn this key into a COM‐
323 POSE key, do the following:
324 xmodmap -e 'keycode 115 = Multi_key'
326 Type this key followed by a " character to enter an 'I' with a umlaut
330 over it.
331 The Available Key Binding Functions
333 The following is a list of the editing functions provided by the tecla
334 library. The names in the leftmost column of the list can be used in
335 configuration files to specify which function a given key or combina‐
336 tion of keys should invoke. They are also used in the next two sections
337 to list the default key bindings in emacs and vi modes.
338 user-interrupt Send a SIGINT signal to the parent
340 process.
341 suspend Suspend the parent process.
344 stop-output Pause terminal output.
347 start-output Resume paused terminal output.
350 literal-next Arrange for the next character to be
353 treated as a normal character. This
354 allows control characters to be entered.
355 cursor-right Move the cursor one character right.
358 cursor-left Move the cursor one character left.
361 insert-mode Toggle between insert mode and overwrite
364 mode.
365 beginning-of-line Move the cursor to the beginning of the
368 line.
369 end-of-line Move the cursor to the end of the line.
372 delete-line Delete the contents of the current line.
375 kill-line Delete everything that follows the cur‐
378 sor.
379 backward-kill-line Delete all characters between the cursor
382 and the start of the line.
383 forward-word Move to the end of the word which follows
386 the cursor.
387 forward-to-word Move the cursor to the start of the word
390 that follows the cursor.
391 backward-word Move to the start of the word which pre‐
394 cedes the cursor.
395 goto-column Move the cursor to the 1-relative column
398 in the line specified by any preceding
399 digit-argument sequences (see Entering
400 Repeat Counts below).
401 find-parenthesis If the cursor is currently over a paren‐
404 thesis character, move it to the matching
405 parenthesis character. If not over a
406 parenthesis character move right to the
407 next close parenthesis.
408 forward-delete-char Delete the character under the cursor.
411 backward-delete-char Delete the character which precedes the
414 cursor.
415 list-or-eof This is intended for binding to ^D. When
418 invoked when the cursor is within the
419 line it displays all possible completions
420 then redisplays the line unchanged. When
421 invoked on an empty line, it signals end-
422 of-input (EOF) to the caller of
423 gl_get_line().
424 del-char-or-list-or-eof This is intended for binding to ^D. When
427 invoked when the cursor is within the
428 line it invokes forward-delete-char. When
429 invoked at the end of the line it dis‐
430 plays all possible completions then
431 redisplays the line unchanged. When
432 invoked on an empty line, it signals end-
433 of-input (EOF) to the caller of
434 gl_get_line().
435 forward-delete-word Delete the word which follows the cursor.
438 backward-delete-word Delete the word which precedes the cur‐
441 sor.
442 upcase-word Convert all of the characters of the word
445 which follows the cursor, to upper case.
446 downcase-word Convert all of the characters of the word
449 which follows the cursor, to lower case.
450 capitalize-word Capitalize the word which follows the
453 cursor.
454 change-case If the next character is upper case, tog‐
457 gle it to lower case and vice versa.
458 redisplay Redisplay the line.
461 clear-screen Clear the terminal, then redisplay the
464 current line.
465 transpose-chars Swap the character under the cursor with
468 the character just before the cursor.
469 set-mark Set a mark at the position of the cursor.
472 exchange-point-and-mark Move the cursor to the last mark that was
475 set, and move the mark to where the cur‐
476 sor used to be.
477 kill-region Delete the characters that lie between
480 the last mark that was set, and the cur‐
481 sor.
482 copy-region-as-kill Copy the text between the mark and the
485 cursor to the cut buffer, without delet‐
486 ing the original text.
487 yank Insert the text that was last deleted,
490 just before the current position of the
491 cursor.
492 append-yank Paste the current contents of the cut
495 buffer, after the cursor.
496 up-history Recall the next oldest line that was
499 entered. Note that in vi mode you are
500 left in command mode.
501 down-history Recall the next most recent line that was
504 entered. If no history recall session is
505 currently active, the next line from a
506 previous recall session is recalled. Note
507 that in vi mode you are left in command
508 mode.
509 history-search-backward Recall the next oldest line who's prefix
512 matches the string which currently pre‐
513 cedes the cursor (in vi command-mode the
514 character under the cursor is also
515 included in the search string). Note that
516 in vi mode you are left in command mode.
517 history-search-forward Recall the next newest line who's prefix
520 matches the string which currently pre‐
521 cedes the cursor (in vi command-mode the
522 character under the cursor is also
523 included in the search string). Note that
524 in vi mode you are left in command mode.
525 history-re-search-backward Recall the next oldest line who's prefix
528 matches that established by the last
529 invocation of either history-search-for‐
530 ward or history-search-backward.
531 history-re-search-forward Recall the next newest line who's prefix
534 matches that established by the last
535 invocation of either history-search-for‐
536 ward or history-search-backward.
537 complete-word Attempt to complete the incomplete word
540 which precedes the cursor. Unless the
541 host program has customized word comple‐
542 tion, file name completion is attempted.
543 In vi commmand mode the character under
544 the cursor is also included in the word
545 being completed, and you are left in vi
546 insert mode.
547 expand-filename Within the command line, expand wild
550 cards, tilde expressions and dollar
551 expressions in the file name which imme‐
552 diately precedes the cursor. In vi comm‐
553 mand mode the character under the cursor
554 is also included in the file name being
555 expanded, and you are left in vi insert
556 mode.
557 list-glob List any file names which match the wild-
560 card, tilde and dollar expressions in the
561 file name which immediately precedes the
562 cursor, then redraw the input line
563 unchanged.
564 list-history Display the contents of the history list
567 for the current history group. If a
568 repeat count of > 1 is specified, only
569 that many of the most recent lines are
570 displayed. See the Entering Repeat Counts
571 section.
572 read-from-file Temporarily switch to reading input from
575 the file who's name precedes the cursor.
576 read-init-files Re-read teclarc configuration files.
579 beginning-of-history Move to the oldest line in the history
582 list. Note that in vi mode you are left
583 in command mode.
584 end-of-history Move to the newest line in the history
587 list (ie. the current line). Note that in
588 vi mode this leaves you in command mode.
589 digit-argument Enter a repeat count for the next key
592 binding function. For details, see the
593 Entering Repeat Counts section.
594 newline Terminate and return the current contents
597 of the line, after appending a newline
598 character. The newline character is nor‐
599 mally '0, but will be the first character
600 of the key sequence that invoked the new‐
601 line action, if this happens to be a
602 printable character. If the action was
603 invoke'd cbayrritahgee 'r0etnuerwnlincehacrhaacrtaecrt,ertohre
604 the '
605 line is appended to the history buffer.
606 repeat-history Return the line that is being edited,
609 then arrange for the next most recent
610 entry in the history buffer to be
611 recalled when tecla is next called.
612 Repeatedly invoking this action causes
613 successive historical input lines to be
614 re-executed. Note that this action is
615 equivalent to the 'Operate' action in
616 ksh.
617 ring-bell Ring the terminal bell, unless the bell
620 has been silenced via the nobeep configu‐
621 ration option (see The Tecla Configura‐
622 tion File section).
623 forward-copy-char Copy the next character into the cut buf‐
626 fer (NB. use repeat counts to copy more
627 than one).
628 backward-copy-char Copy the previous character into the cut
631 buffer.
632 forward-copy-word Copy the next word into the cut buffer.
635 backward-copy-word Copy the previous word into the cut buf‐
638 fer.
639 forward-find-char Move the cursor to the next occurrence of
642 the next character that you type.
643 backward-find-char Move the cursor to the last occurrence of
646 the next character that you type.
647 forward-to-char Move the cursor to the character just
650 before the next occurrence of the next
651 character that the user types.
652 backward-to-char Move the cursor to the character just
655 after the last occurrence before the cur‐
656 sor of the next character that the user
657 types.
658 repeat-find-char Repeat the last backward-find-char, for‐
661 ward-find-char, backward-to-char or for‐
662 ward-to-char.
663 invert-refind-char Repeat the last backward-find-char, for‐
666 ward-find-char, backward-to-char, or for‐
667 ward-to-char in the opposite direction.
668 delete-to-column Delete the characters from the cursor up
671 to the column that is specified by the
672 repeat count.
673 delete-to-parenthesis Delete the characters from the cursor up
676 to and including the matching parenthe‐
677 sis, or next close parenthesis.
678 forward-delete-find Delete the characters from the cursor up
681 to and including the following occurence
682 of the next character typed.
683 backward-delete-find Delete the characters from the cursor up
686 to and including the preceding occurence
687 of the next character typed.
688 forward-delete-to Delete the characters from the cursor up
691 to, but not including, the following
692 occurence of the next character typed.
693 backward-delete-to Delete the characters from the cursor up
696 to, but not including, the preceding
697 occurence of the next character typed.
698 delete-refind Repeat the last *-delete-find or
701 *-delete-to action.
702 delete-invert-refind Repeat the last *-delete-find or
705 *-delete-to action, in the opposite
706 direction.
707 copy-to-column Copy the characters from the cursor up to
710 the column that is specified by the
711 repeat count, into the cut buffer.
712 copy-to-parenthesis Copy the characters from the cursor up to
715 and including the matching parenthesis,
716 or next close parenthesis, into the cut
717 buffer.
718 forward-copy-find Copy the characters from the cursor up to
721 and including the following occurence of
722 the next character typed, into the cut
723 buffer.
724 backward-copy-find Copy the characters from the cursor up to
727 and including the preceding occurence of
728 the next character typed, into the cut
729 buffer.
730 forward-copy-to Copy the characters from the cursor up
733 to, but not including, the following
734 occurence of the next character typed,
735 into the cut buffer.
736 backward-copy-to Copy the characters from the cursor up
739 to, but not including, the preceding
740 occurence of the next character typed,
741 into the cut buffer.
742 copy-refind Repeat the last *-copy-find or *-copy-to
745 action.
746 copy-invert-refind Repeat the last *-copy-find or *-copy-to
749 action, in the opposite direction.
750 vi-mode Switch to vi mode from emacs mode.
753 emacs-mode Switch to emacs mode from vi mode.
756 vi-insert From vi command mode, switch to insert
759 mode.
760 vi-overwrite From vi command mode, switch to overwrite
763 mode.
764 vi-insert-at-bol From vi command mode, move the cursor to
767 the start of the line and switch to
768 insert mode.
769 vi-append-at-eol From vi command mode, move the cursor to
772 the end of the line and switch to append
773 mode.
774 vi-append From vi command mode, move the cursor one
777 position right, and switch to insert
778 mode.
779 vi-replace-char From vi command mode, replace the charac‐
782 ter under the cursor with the next char‐
783 acter entered.
784 vi-forward-change-char From vi command mode, delete the next
787 character then enter insert mode.
788 vi-backward-change-char From vi command mode, delete the preced‐
791 ing character then enter insert mode.
792 vi-forward-change-word From vi command mode, delete the next
795 word then enter insert mode.
796 vi-backward-change-word From vi command mode, delete the preced‐
799 ing word then enter insert mode.
800 vi-change-rest-of-line From vi command mode, delete from the
803 cursor to the end of the line, then enter
804 insert mode.
805 vi-change-line From vi command mode, delete the current
808 line, then enter insert mode.
809 vi-change-to-bol From vi command mode, delete all charac‐
812 ters between the cursor and the beginning
813 of the line, then enter insert mode.
814 vi-change-to-column From vi command mode, delete the charac‐
817 ters from the cursor up to the column
818 that is specified by the repeat count,
819 then enter insert mode.
820 vi-change-to-parenthesis Delete the characters from the cursor up
823 to and including the matching parenthe‐
824 sis, or next close parenthesis, then
825 enter vi insert mode.
826 vi-forward-change-find From vi command mode, delete the charac‐
829 ters from the cursor up to and including
830 the following occurence of the next char‐
831 acter typed, then enter insert mode.
832 vi-backward-change-find From vi command mode, delete the charac‐
835 ters from the cursor up to and including
836 the preceding occurence of the next char‐
837 acter typed, then enter insert mode.
838 vi-forward-change-to From vi command mode, delete the charac‐
841 ters from the cursor up to, but not
842 including, the following occurence of the
843 next character typed, then enter insert
844 mode.
845 vi-backward-change-to From vi command mode, delete the charac‐
848 ters from the cursor up to, but not
849 including, the preceding occurence of the
850 next character typed, then enter insert
851 mode.
852 vi-change-refind Repeat the last vi-*-change-find or
855 vi-*-change-to action.
856 vi-change-invert-refind Repeat the last vi-*-change-find or
859 vi-*-change-to action, in the opposite
860 direction.
861 vi-undo In vi mode, undo the last editing opera‐
864 tion.
865 vi-repeat-change In vi command mode, repeat the last com‐
868 mand that modified the line.
869 Default Key Bindings In emacs Mode
872 The following default key bindings, which can be overriden by the tecla
873 configuration file, are designed to mimic most of the bindings of the
874 unix tcsh shell shell, when it is in emacs editing mode.
875 This is the default editing mode of the tecla library.
878 Under UNIX the terminal driver sets a number of special keys for cer‐
881 tain functions. The tecla library attempts to use the same key bindings
882 to maintain consistency. The key sequences shown for the following 6
883 bindings are thus just examples of what they will probably be set to.
884 If you have used the stty command to change these keys, then the
885 default bindings should match.
886 ^C user-interrupt
888 ^\fR abort
891 ^Z suspend
894 ^Q start-output
897 ^S stop-output
900 ^V literal-next
903 The cursor keys are refered to by name, as follows. This is necessary
907 because different types of terminals generate different key sequences
908 when their cursor keys are pressed.
909 right cursor-right
911 left cursor-left
914 up up-history
917 down down-history
920 The remaining bindings don't depend on the terminal setttings.
924 ^F cursor-right
926 ^B cursor-left
929 M-i insert-mode
932 ^A beginning-of-line
935 ^E end-of-line
938 ^U delete-line
941 ^K kill-line
944 M-f forward-word
947 M-b backward-word
950 ^D del-char-or-list-or-eof
953 ^H backward-delete-char
956 ^? backward-delete-char
959 M-d forward-delete-word
962 M-^H backward-delete-word
965 M-^? backward-delete-word
968 M-u upcase-word
971 M-l downcase-word
974 M-c capitalize-word
977 ^R redisplay
980 ^L clear-screen
983 ^T transpose-chars
986 ^@ set-mark
989 ^X^X exchange-point-and-mark
992 ^W kill-region
995 M-w copy-region-as-kill
998 ^Y yank
1001 ^P up-history
1004 ^N down-history
1007 M-p history-search-backward
1010 M-n history-search-forward
1013 ^I complete-word
1016 ^X* expand-filename
1019 ^X^F read-from-file
1022 ^X^R read-init-files
1025 ^Xg list-glob
1028 ^Xh list-history
1031 M-< beginning-of-history
1034 M-> end-of-history
1037 0fR newline
1040 newline
1043 M-o repeat-history
1046 M-^V vi-mode
1049 M-0, M-1, ... M-9 digit-argument (see below)
1052 Note that ^I is what the TAB key generates, and that ^@ can be gener‐
1056 ated not only by pressing the CONTROL key and the @ key simultaneously,
1057 but also by pressing the CONTROL key and the space bar at the same
1058 time.
1059 Default Key Bindings in vi Mode
1061 The following default key bindings are designed to mimic the vi style
1062 of editing as closely as possible. This means that very few editing
1063 functions are provided in the initial character input mode, editing
1064 functions instead being provided by the vi command mode. The vi command
1065 mode is entered whenever the ESCAPE character is pressed, or whenever a
1066 key sequence that starts with a meta character is entered. In addition
1067 to mimicing vi, libtecla provides bindings for tab completion, wild-
1068 card expansion of file names, and historical line recall.
1069 To learn how to tell the tecla library to use vi mode instead of the
1072 default emacs editing mode, see the earlier section entitled The Tecla
1073 Configuration File.
1074 Under UNIX the terminal driver sets a number of special keys for cer‐
1077 tain functions. The tecla library attempts to use the same key bindings
1078 to maintain consistency, binding them both in input mode and in command
1079 mode. The key sequences shown for the following 6 bindings are thus
1080 just examples of what they will probably be set to. If you have used
1081 the stty command to change these keys, then the default bindings should
1082 match.
1083 ^C user-interrupt
1085 ^\fR abort
1088 ^Z suspend
1091 ^Q start-output
1094 ^S stop-output
1097 ^V literal-next
1100 M-^C user-interrupt
1103 M-^\fR abort
1106 M-^Z suspend
1109 M-^Q start-output
1112 M-^S stop-output
1115 Note that above, most of the bindings are defined twice, once as a raw
1119 control code like ^C and then a second time as a META character like
1120 M-^C. The former is the binding for vi input mode, whereas the latter
1121 is the binding for vi command mode. Once in command mode all key
1122 sequences that the user types that they don't explicitly start with an
1123 ESCAPE or a META key, have their first key secretly converted to a META
1124 character before the key sequence is looked up in the key binding ta‐
1125 ble. Thus, once in command mode, when you type the letter i, for exam‐
1126 ple, the tecla library actually looks up the binding for M-i.
1127 The cursor keys are refered to by name, as follows. This is necessary
1130 because different types of terminals generate different key sequences
1131 when their cursor keys are pressed.
1132 right cursor-right
1134 left cursor-left
1137 up up-history
1140 down down-history
1143 The cursor keys normally generate a key sequence that start with an
1147 ESCAPE character, so beware that using the arrow keys will put you into
1148 command mode (if you aren't already in command mode).
1149 The following are the terminal-independent key bindings for vi input
1152 mode.
1153 ^D list-or-eof
1155 ^G list-glob
1158 ^H backward-delete-char
1161 ^I complete-word
1164 newline
1167 0fR newline
1170 ^L clear-screen
1173 ^N down-history
1176 ^P up-history
1179 ^R redisplay
1182 ^U backward-kill-line
1185 ^W backward-delete-word
1188 ^X* expand-filename
1191 ^X^F read-from-file
1194 ^X^R read-init-files
1197 ^? backward-delete-char
1200 The following are the key bindings that are defined in vi command mode,
1204 this being specified by them all starting with a META character. As
1205 mentioned above, once in command mode the initial meta character is
1206 optional. For example, you might enter command mode by typing ESCAPE,
1207 and then press 'H' twice to move the cursor two positions to the left.
1208 Both 'H' characters get quietly converted to M-h before being compared
1209 to the key binding table, the first one because ESCAPE followed by a
1210 character is always converted to the equivalent META character, and the
1211 second because command mode was already active.
1212 M-\fR cursor-right (META-space)
1214 M-$ end-of-line
1217 M-* expand-filename
1220 M-+ down-history
1223 M-- up-history
1226 M-< beginning-of-history
1229 M-> end-of-history
1232 M-^ beginning-of-line
1235 M- repeat-find-char
1238 M-, invert-refind-char
1241 M-| goto-column
1244 M-~ change-case
1247 M-. vi-repeat-change
1250 M-% find-parenthesis
1253 M-a vi-append
1256 M-A vi-append-at-eol
1259 M-b backward-word
1262 M-B backward-word
1265 M-C vi-change-rest-of-line
1268 M-cb vi-backward-change-word
1271 M-cB vi-backward-change-word
1274 M-cc vi-change-line
1277 M-ce vi-forward-change-word
1280 M-cE vi-forward-change-word
1283 M-cw vi-forward-change-word
1286 M-cW vi-forward-change-word
1289 M-cF vi-backward-change-find
1292 M-cf vi-forward-change-find
1295 M-cT vi-backward-change-to
1298 M-ct vi-forward-change-to
1301 M-c; vi-change-refind
1304 M-c, vi-change-invert-refind
1307 M-ch vi-backward-change-char
1310 M-c^H vi-backward-change-char
1313 M-c^? vi-backward-change-char
1316 M-cl vi-forward-change-char
1319 M-c\fR vi-forward-change-char (META-c-space)
1322 M-c^ vi-change-to-bol
1325 M-c0 vi-change-to-bol
1328 M-c$ vi-change-rest-of-line
1331 M-c| vi-change-to-column
1334 M-c% vi-change-to-parenthesis
1337 M-dh backward-delete-char
1340 M-d^H backward-delete-char
1343 M-d^? backward-delete-char
1346 M-dl forward-delete-char
1349 M-d forward-delete-char (META-d-space)
1352 M-dd delete-line
1355 M-db backward-delete-word
1358 M-dB backward-delete-word
1361 M-de forward-delete-word
1364 M-dE forward-delete-word
1367 M-dw forward-delete-word
1370 M-dW forward-delete-word
1373 M-dF backward-delete-find
1376 M-df forward-delete-find
1379 M-dT backward-delete-to
1382 M-dt forward-delete-to
1385 M-d; delete-refind
1388 M-d, delete-invert-refind
1391 M-d^ backward-kill-line
1394 M-d0 backward-kill-line
1397 M-d$ kill-line
1400 M-D kill-line
1403 M-d| delete-to-column
1406 M-d% delete-to-parenthesis
1409 M-e forward-word
1412 M-E forward-word
1415 M-f forward-find-char
1418 M-F backward-find-char
1421 M-- up-history
1424 M-h cursor-left
1427 M-H beginning-of-history
1430 M-i vi-insert
1433 M-I vi-insert-at-bol
1436 M-j down-history
1439 M-J history-search-forward
1442 M-k up-history
1445 M-K history-search-backward
1448 M-l cursor-right
1451 M-L end-of-history
1454 M-n history-re-search-forward
1457 M-N history-re-search-backward
1460 M-p append-yank
1463 M-P yank
1466 M-r vi-replace-char
1469 M-R vi-overwrite
1472 M-s vi-forward-change-char
1475 M-S vi-change-line
1478 M-t forward-to-char
1481 M-T backward-to-char
1484 M-u vi-undo
1487 M-w forward-to-word
1490 M-W forward-to-word
1493 M-x forward-delete-char
1496 M-X backward-delete-char
1499 M-yh backward-copy-char
1502 M-y^H backward-copy-char
1505 M-y^? backward-copy-char
1508 M-yl forward-copy-char
1511 M-y\fR forward-copy-char (META-y-space)
1514 M-ye forward-copy-word
1517 M-yE forward-copy-word
1520 M-yw forward-copy-word
1523 M-yW forward-copy-word
1526 M-yb backward-copy-word
1529 M-yB backward-copy-word
1532 M-yf forward-copy-find
1535 M-yF backward-copy-find
1538 M-yt forward-copy-to
1541 M-yT backward-copy-to
1544 M-y; copy-refind
1547 M-y, copy-invert-refind
1550 M-y^ copy-to-bol
1553 M-y0 copy-to-bol
1556 M-y$ copy-rest-of-line
1559 M-yy copy-line
1562 M-Y copy-line
1565 M-y| copy-to-column
1568 M-y% copy-to-parenthesis
1571 M-^E emacs-mode
1574 M-^H cursor-left
1577 M-^? cursor-left
1580 M-^L clear-screen
1583 M-^N down-history
1586 M-^P up-history
1589 M-^R redisplay
1592 M-^D list-or-eof
1595 M-^I complete-word
1598 M- newline
1601 M-0fR newline
1604 M-^X^R read-init-files
1607 M-^Xh list-history
1610 M-0, M-1, ... M-9 digit-argument (see below)
1613 Note that ^I is what the TAB key generates.
1617 Entering Repeat Counts
1619 Many of the key binding functions described previously, take an
1620 optional count, typed in before the target key sequence. This is inter‐
1621 preted as a repeat count by most bindings. A notable exception is the
1622 goto-column binding, which interprets the count as a column number.
1623 By default you can specify this count argument by pressing the META key
1626 while typing in the numeric count. This relies on the digit-argument
1627 action being bound to 'META-0', 'META-1' etc. Once any one of these
1628 bindings has been activated, you can optionally take your finger off
1629 the META key to type in the rest of the number, since every numeric
1630 digit thereafter is treated as part of the number, unless it is pre‐
1631 ceded by the literal-next binding. As soon as a non-digit, or literal
1632 digit key is pressed the repeat count is terminated and either causes
1633 the just typed character to be added to the line that many times, or
1634 causes the next key binding function to be given that argument.
1635 For example, in emacs mode, typing:
1638 M-12a
1640 causes the letter 'a' to be added to the line 12 times, whereas
1644 M-4M-c
1646 Capitalizes the next 4 words.
1650 In vi command mode the meta modifier is automatically added to all
1653 characters typed in, so to enter a count in vi command-mode, just
1654 involves typing in the number, just as it does in the vi editor itself.
1655 So for example, in vi command mode, typing:
1656 4w2x
1658 moves the cursor four words to the right, then deletes two characters.
1662 You can also bind digit-argument to other key sequences. If these end
1665 in a numeric digit, that digit gets appended to the current repeat
1666 count. If it doesn't end in a numeric digit, a new repeat count is
1667 started with a value of zero, and can be completed by typing in the
1668 number, after letting go of the key which triggered the digit-argument
1669 action.
1670
1672 /usr/lib/libtecla.so The tecla library
1673 /usr/include/libtecla.h The tecla header file
1676 ~/.teclarc The personal tecla customization file
1679
1682 See attributes(5) for descriptions of the following attributes:
1683 ┌─────────────────────────────┬─────────────────────────────┐
1688 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
1689 ├─────────────────────────────┼─────────────────────────────┤
1690 │Availability │SUNWtecla │
1691 ├─────────────────────────────┼─────────────────────────────┤
1692 │Interface Stability │Evolving │
1693 └─────────────────────────────┴─────────────────────────────┘
1694
1696 vi(1), cpl_complete_word(3TECLA), ef_expand_file(3TECLA),
1697 gl_get_line(3TECLA), gl_io_mode(3TECLA), libtecla(3LIB),
1698 pca_lookup_file(3TECLA), attributes(5)
1699SunOS 5.11 20 May 2004 tecla(5)