| readline.3 (136758) | readline.3 (157188) |
|---|---|
| 1.\" $FreeBSD: head/contrib/libreadline/doc/readline.3 157188 2006-03-27 23:11:32Z ache $ |
|
| 1.\" 2.\" MAN PAGE COMMENTS to 3.\" 4.\" Chet Ramey 5.\" Information Network Services 6.\" Case Western Reserve University 7.\" chet@ins.CWRU.Edu 8.\" | 2.\" 3.\" MAN PAGE COMMENTS to 4.\" 5.\" Chet Ramey 6.\" Information Network Services 7.\" Case Western Reserve University 8.\" chet@ins.CWRU.Edu 9.\" |
| 9.\" Last Change: Wed Jan 28 15:43:53 EST 2004 | 10.\" Last Change: Tue Sep 13 12:07:26 EDT 2005 |
| 10.\" | 11.\" |
| 11.TH READLINE 3 "2004 January 28" "GNU Readline 5.0" | 12.TH READLINE 3 "2005 Sep 13" "GNU Readline 5.1-beta1" |
| 12.\" 13.\" File Name macro. This used to be `.PN', for Path Name, 14.\" but Sun doesn't seem to like that very much. | 13.\" 14.\" File Name macro. This used to be `.PN', for Path Name, 15.\" but Sun doesn't seem to like that very much. |
| 15.\" $FreeBSD: head/contrib/libreadline/doc/readline.3 136758 2004-10-21 20:02:02Z peter $ | |
| 16.\" 17.de FN 18\fI\|\\$1\|\fP 19.. 20.SH NAME 21readline \- get a line from a user with editing 22.SH SYNOPSIS 23.LP --- 300 unchanged lines hidden (view full) --- 324\fBset\fP \fIvariable\-name\fP \fIvalue\fP 325.RE 326.PP 327Except where noted, readline variables can take the values 328.B On 329or 330.B Off 331(without regard to case). | 16.\" 17.de FN 18\fI\|\\$1\|\fP 19.. 20.SH NAME 21readline \- get a line from a user with editing 22.SH SYNOPSIS 23.LP --- 300 unchanged lines hidden (view full) --- 324\fBset\fP \fIvariable\-name\fP \fIvalue\fP 325.RE 326.PP 327Except where noted, readline variables can take the values 328.B On 329or 330.B Off 331(without regard to case). |
| 332Unrecognized variable names are ignored. 333When a variable value is read, empty or null values, "on" (case-insensitive), 334and "1" are equivalent to \fBOn\fP. All other values are equivalent to 335\fBOff\fP. |
|
| 332The variables and their default values are: 333.PP 334.PD 0 335.TP 336.B bell\-style (audible) 337Controls what happens when readline wants to ring the terminal bell. 338If set to \fBnone\fP, readline never rings the bell. If set to 339\fBvisible\fP, readline uses a visible bell if one is available. 340If set to \fBaudible\fP, readline attempts to ring the terminal's bell. 341.TP | 336The variables and their default values are: 337.PP 338.PD 0 339.TP 340.B bell\-style (audible) 341Controls what happens when readline wants to ring the terminal bell. 342If set to \fBnone\fP, readline never rings the bell. If set to 343\fBvisible\fP, readline uses a visible bell if one is available. 344If set to \fBaudible\fP, readline attempts to ring the terminal's bell. 345.TP |
| 346.B bind\-tty\-special\-chars (On) 347If set to \fBOn\fP, readline attempts to bind the control characters 348treated specially by the kernel's terminal driver to their readline 349equivalents. 350.TP |
|
| 342.B comment\-begin (``#'') 343The string that is inserted in \fBvi\fP mode when the 344.B insert\-comment 345command is executed. 346This command is bound to 347.B M\-# 348in emacs mode and to 349.B # --- 6 unchanged lines hidden (view full) --- 356.B completion\-query\-items (100) 357This determines when the user is queried about viewing 358the number of possible completions 359generated by the \fBpossible\-completions\fP command. 360It may be set to any integer value greater than or equal to 361zero. If the number of possible completions is greater than 362or equal to the value of this variable, the user is asked whether 363or not he wishes to view them; otherwise they are simply listed | 351.B comment\-begin (``#'') 352The string that is inserted in \fBvi\fP mode when the 353.B insert\-comment 354command is executed. 355This command is bound to 356.B M\-# 357in emacs mode and to 358.B # --- 6 unchanged lines hidden (view full) --- 365.B completion\-query\-items (100) 366This determines when the user is queried about viewing 367the number of possible completions 368generated by the \fBpossible\-completions\fP command. 369It may be set to any integer value greater than or equal to 370zero. If the number of possible completions is greater than 371or equal to the value of this variable, the user is asked whether 372or not he wishes to view them; otherwise they are simply listed |
| 364on the terminal. | 373on the terminal. A negative value causes readline to never ask. |
| 365.TP 366.B convert\-meta (On) 367If set to \fBOn\fP, readline will convert characters with the 368eighth bit set to an ASCII key sequence 369by stripping the eighth bit and prefixing it with an 370escape character (in effect, using escape as the \fImeta prefix\fP). 371.TP 372.B disable\-completion (Off) --- 14 unchanged lines hidden (view full) --- 387When set to \fBOn\fP, readline will try to enable the application 388keypad when it is called. Some systems need this to enable the 389arrow keys. 390.TP 391.B expand\-tilde (Off) 392If set to \fBon\fP, tilde expansion is performed when readline 393attempts word completion. 394.TP | 374.TP 375.B convert\-meta (On) 376If set to \fBOn\fP, readline will convert characters with the 377eighth bit set to an ASCII key sequence 378by stripping the eighth bit and prefixing it with an 379escape character (in effect, using escape as the \fImeta prefix\fP). 380.TP 381.B disable\-completion (Off) --- 14 unchanged lines hidden (view full) --- 396When set to \fBOn\fP, readline will try to enable the application 397keypad when it is called. Some systems need this to enable the 398arrow keys. 399.TP 400.B expand\-tilde (Off) 401If set to \fBon\fP, tilde expansion is performed when readline 402attempts word completion. 403.TP |
| 395.B history-preserve-point | 404.B history\-preserve\-point (Off) |
| 396If set to \fBon\fP, the history code attempts to place point at the | 405If set to \fBon\fP, the history code attempts to place point at the |
| 397same location on each history line retrived with \fBprevious-history\fP | 406same location on each history line retrieved with \fBprevious-history\fP |
| 398or \fBnext-history\fP. 399.TP 400.B horizontal\-scroll\-mode (Off) 401When set to \fBOn\fP, makes readline use a single line for display, 402scrolling the input horizontally on a single screen line when it 403becomes longer than the screen width rather than wrapping to a new line. 404.TP 405.B input\-meta (Off) --- 281 unchanged lines hidden (view full) --- 687.B yank\-nth\-arg (M\-C\-y) 688Insert the first argument to the previous command (usually 689the second word on the previous line) at point. 690With an argument 691.IR n , 692insert the \fIn\fPth word from the previous command (the words 693in the previous command begin with word 0). A negative argument 694inserts the \fIn\fPth word from the end of the previous command. | 407or \fBnext-history\fP. 408.TP 409.B horizontal\-scroll\-mode (Off) 410When set to \fBOn\fP, makes readline use a single line for display, 411scrolling the input horizontally on a single screen line when it 412becomes longer than the screen width rather than wrapping to a new line. 413.TP 414.B input\-meta (Off) --- 281 unchanged lines hidden (view full) --- 696.B yank\-nth\-arg (M\-C\-y) 697Insert the first argument to the previous command (usually 698the second word on the previous line) at point. 699With an argument 700.IR n , 701insert the \fIn\fPth word from the previous command (the words 702in the previous command begin with word 0). A negative argument 703inserts the \fIn\fPth word from the end of the previous command. |
| 704Once the argument \fIn\fP is computed, the argument is extracted 705as if the "!\fIn\fP" history expansion had been specified. |
|
| 695.TP 696.B 697yank\-last\-arg (M\-.\^, M\-_\^) 698Insert the last argument to the previous command (the last word of 699the previous history entry). With an argument, 700behave exactly like \fByank\-nth\-arg\fP. 701Successive calls to \fByank\-last\-arg\fP move back through the history 702list, inserting the last argument of each line in turn. | 706.TP 707.B 708yank\-last\-arg (M\-.\^, M\-_\^) 709Insert the last argument to the previous command (the last word of 710the previous history entry). With an argument, 711behave exactly like \fByank\-nth\-arg\fP. 712Successive calls to \fByank\-last\-arg\fP move back through the history 713list, inserting the last argument of each line in turn. |
| 714The history expansion facilities are used to extract the last argument, 715as if the "!$" history expansion had been specified. |
|
| 703.PD 704.SS Commands for Changing Text 705.PP 706.PD 0 707.TP 708.B delete\-char (C\-d) 709Delete the character at point. If point is at the 710beginning of the line, there are no characters in the line, and --- 578 unchanged lines hidden --- | 716.PD 717.SS Commands for Changing Text 718.PP 719.PD 0 720.TP 721.B delete\-char (C\-d) 722Delete the character at point. If point is at the 723beginning of the line, there are no characters in the line, and --- 578 unchanged lines hidden --- |