OpenCores
URL https://opencores.org/ocsvn/openrisc_me/openrisc_me/trunk

Subversion Repositories openrisc_me

[/] [openrisc/] [trunk/] [gnu-src/] [gdb-6.8/] [readline/] [doc/] [readline.3] - Blame information for rev 247

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 24 jeremybenn
.\"
2
.\" MAN PAGE COMMENTS to
3
.\"
4
.\"     Chet Ramey
5
.\"     Information Network Services
6
.\"     Case Western Reserve University
7
.\"     chet@ins.CWRU.Edu
8
.\"
9
.\"     Last Change: Tue Sep 13 12:07:26 EDT 2005
10
.\"
11
.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.
15
.\"
16
.de FN
17
\fI\|\\$1\|\fP
18
..
19
.SH NAME
20
readline \- get a line from a user with editing
21
.SH SYNOPSIS
22
.LP
23
.nf
24
.ft B
25
#include 
26
#include 
27
#include 
28
.ft
29
.fi
30
.LP
31
.nf
32
\fIchar *\fP
33
.br
34
\fBreadline\fP (\fIconst char *prompt\fP);
35
.fi
36
.SH COPYRIGHT
37
.if n Readline is Copyright (C) 1989\-2004 by the Free Software Foundation, Inc.
38
.if t Readline is Copyright \(co 1989\-2004 by the Free Software Foundation, Inc.
39
.SH DESCRIPTION
40
.LP
41
.B readline
42
will read a line from the terminal
43
and return it, using
44
.B prompt
45
as a prompt.  If
46
.B prompt
47
is \fBNULL\fP or the empty string, no prompt is issued.
48
The line returned is allocated with
49
.IR malloc (3);
50
the caller must free it when finished.  The line returned
51
has the final newline removed, so only the text of the line
52
remains.
53
.LP
54
.B readline
55
offers editing capabilities while the user is entering the
56
line.
57
By default, the line editing commands
58
are similar to those of emacs.
59
A vi\-style line editing interface is also available.
60
.LP
61
This manual page describes only the most basic use of \fBreadline\fP.
62
Much more functionality is available; see
63
\fIThe GNU Readline Library\fP and \fIThe GNU History Library\fP
64
for additional information.
65
.SH RETURN VALUE
66
.LP
67
.B readline
68
returns the text of the line read.  A blank line
69
returns the empty string.  If
70
.B EOF
71
is encountered while reading a line, and the line is empty,
72
.B NULL
73
is returned.  If an
74
.B EOF
75
is read with a non\-empty line, it is
76
treated as a newline.
77
.SH NOTATION
78
.LP
79
An emacs-style notation is used to denote
80
keystrokes.  Control keys are denoted by C\-\fIkey\fR, e.g., C\-n
81
means Control\-N.  Similarly,
82
.I meta
83
keys are denoted by M\-\fIkey\fR, so M\-x means Meta\-X.  (On keyboards
84
without a
85
.I meta
86
key, M\-\fIx\fP means ESC \fIx\fP, i.e., press the Escape key
87
then the
88
.I x
89
key.  This makes ESC the \fImeta prefix\fP.
90
The combination M\-C\-\fIx\fP means ESC\-Control\-\fIx\fP,
91
or press the Escape key
92
then hold the Control key while pressing the
93
.I x
94
key.)
95
.PP
96
Readline commands may be given numeric
97
.IR arguments ,
98
which normally act as a repeat count.  Sometimes, however, it is the
99
sign of the argument that is significant.  Passing a negative argument
100
to a command that acts in the forward direction (e.g., \fBkill\-line\fP)
101
causes that command to act in a backward direction.  Commands whose
102
behavior with arguments deviates from this are noted.
103
.PP
104
When a command is described as \fIkilling\fP text, the text
105
deleted is saved for possible future retrieval
106
(\fIyanking\fP).  The killed text is saved in a
107
\fIkill ring\fP.  Consecutive kills cause the text to be
108
accumulated into one unit, which can be yanked all at once.
109
Commands which do not kill text separate the chunks of text
110
on the kill ring.
111
.SH INITIALIZATION FILE
112
.LP
113
Readline is customized by putting commands in an initialization
114
file (the \fIinputrc\fP file).
115
The name of this file is taken from the value of the
116
.B INPUTRC
117
environment variable.  If that variable is unset, the default is
118
.IR ~/.inputrc .
119
When a program which uses the readline library starts up, the
120
init file is read, and the key bindings and variables are set.
121
There are only a few basic constructs allowed in the
122
readline init file.  Blank lines are ignored.
123
Lines beginning with a \fB#\fP are comments.
124
Lines beginning with a \fB$\fP indicate conditional constructs.
125
Other lines denote key bindings and variable settings.
126
Each program using this library may add its own commands
127
and bindings.
128
.PP
129
For example, placing
130
.RS
131
.PP
132
M\-Control\-u: universal\-argument
133
.RE
134
or
135
.RS
136
C\-Meta\-u: universal\-argument
137
.RE
138
.sp
139
into the
140
.I inputrc
141
would make M\-C\-u execute the readline command
142
.IR universal\-argument .
143
.PP
144
The following symbolic character names are recognized while
145
processing key bindings:
146
.IR DEL ,
147
.IR ESC ,
148
.IR ESCAPE ,
149
.IR LFD ,
150
.IR NEWLINE ,
151
.IR RET ,
152
.IR RETURN ,
153
.IR RUBOUT ,
154
.IR SPACE ,
155
.IR SPC ,
156
and
157
.IR TAB .
158
.PP
159
In addition to command names, readline allows keys to be bound
160
to a string that is inserted when the key is pressed (a \fImacro\fP).
161
.PP
162
.SS Key Bindings
163
.PP
164
The syntax for controlling key bindings in the
165
.I inputrc
166
file is simple.  All that is required is the name of the
167
command or the text of a macro and a key sequence to which
168
it should be bound. The name may be specified in one of two ways:
169
as a symbolic key name, possibly with \fIMeta\-\fP or \fIControl\-\fP
170
prefixes, or as a key sequence.
171
.PP
172
When using the form \fBkeyname\fP:\^\fIfunction-name\fP or \fImacro\fP,
173
.I keyname
174
is the name of a key spelled out in English.  For example:
175
.sp
176
.RS
177
Control\-u: universal\-argument
178
.br
179
Meta\-Rubout: backward\-kill\-word
180
.br
181
Control\-o: "> output"
182
.RE
183
.LP
184
In the above example,
185
.I C\-u
186
is bound to the function
187
.BR universal\-argument ,
188
.I M-DEL
189
is bound to the function
190
.BR backward\-kill\-word ,
191
and
192
.I C\-o
193
is bound to run the macro
194
expressed on the right hand side (that is, to insert the text
195
.if t \f(CW> output\fP
196
.if n ``> output''
197
into the line).
198
.PP
199
In the second form, \fB"keyseq"\fP:\^\fIfunction\-name\fP or \fImacro\fP,
200
.B keyseq
201
differs from
202
.B keyname
203
above in that strings denoting
204
an entire key sequence may be specified by placing the sequence
205
within double quotes.  Some GNU Emacs style key escapes can be
206
used, as in the following example, but the symbolic character names
207
are not recognized.
208
.sp
209
.RS
210
"\eC\-u": universal\-argument
211
.br
212
"\eC\-x\eC\-r": re\-read\-init\-file
213
.br
214
"\ee[11~": "Function Key 1"
215
.RE
216
.PP
217
In this example,
218
.I C-u
219
is again bound to the function
220
.BR universal\-argument .
221
.I "C-x C-r"
222
is bound to the function
223
.BR re\-read\-init\-file ,
224
and
225
.I "ESC [ 1 1 ~"
226
is bound to insert the text
227
.if t \f(CWFunction Key 1\fP.
228
.if n ``Function Key 1''.
229
.PP
230
The full set of GNU Emacs style escape sequences available when specifying
231
key sequences is
232
.RS
233
.PD 0
234
.TP
235
.B \eC\-
236
control prefix
237
.TP
238
.B \eM\-
239
meta prefix
240
.TP
241
.B \ee
242
an escape character
243
.TP
244
.B \e\e
245
backslash
246
.TP
247
.B \e"
248
literal ", a double quote
249
.TP
250
.B \e'
251
literal ', a single quote
252
.RE
253
.PD
254
.PP
255
In addition to the GNU Emacs style escape sequences, a second
256
set of backslash escapes is available:
257
.RS
258
.PD 0
259
.TP
260
.B \ea
261
alert (bell)
262
.TP
263
.B \eb
264
backspace
265
.TP
266
.B \ed
267
delete
268
.TP
269
.B \ef
270
form feed
271
.TP
272
.B \en
273
newline
274
.TP
275
.B \er
276
carriage return
277
.TP
278
.B \et
279
horizontal tab
280
.TP
281
.B \ev
282
vertical tab
283
.TP
284
.B \e\fInnn\fP
285
the eight-bit character whose value is the octal value \fInnn\fP
286
(one to three digits)
287
.TP
288
.B \ex\fIHH\fP
289
the eight-bit character whose value is the hexadecimal value \fIHH\fP
290
(one or two hex digits)
291
.RE
292
.PD
293
.PP
294
When entering the text of a macro, single or double quotes should
295
be used to indicate a macro definition.  Unquoted text
296
is assumed to be a function name.
297
In the macro body, the backslash escapes described above are expanded.
298
Backslash will quote any other character in the macro text,
299
including " and '.
300
.PP
301
.B Bash
302
allows the current readline key bindings to be displayed or modified
303
with the
304
.B bind
305
builtin command.  The editing mode may be switched during interactive
306
use by using the
307
.B \-o
308
option to the
309
.B set
310
builtin command.  Other programs using this library provide
311
similar mechanisms.  The
312
.I inputrc
313
file may be edited and re-read if a program does not provide
314
any other means to incorporate new bindings.
315
.SS Variables
316
.PP
317
Readline has variables that can be used to further customize its
318
behavior.  A variable may be set in the
319
.I inputrc
320
file with a statement of the form
321
.RS
322
.PP
323
\fBset\fP \fIvariable\-name\fP \fIvalue\fP
324
.RE
325
.PP
326
Except where noted, readline variables can take the values
327
.B On
328
or
329
.B Off
330
(without regard to case).
331
Unrecognized variable names are ignored.
332
When a variable value is read, empty or null values, "on" (case-insensitive),
333
and "1" are equivalent to \fBOn\fP.  All other values are equivalent to
334
\fBOff\fP.
335
The variables and their default values are:
336
.PP
337
.PD 0
338
.TP
339
.B bell\-style (audible)
340
Controls what happens when readline wants to ring the terminal bell.
341
If set to \fBnone\fP, readline never rings the bell.  If set to
342
\fBvisible\fP, readline uses a visible bell if one is available.
343
If set to \fBaudible\fP, readline attempts to ring the terminal's bell.
344
.TP
345
.B bind\-tty\-special\-chars (On)
346
If set to \fBOn\fP, readline attempts to bind the control characters
347
treated specially by the kernel's terminal driver to their readline
348
equivalents.
349
.TP
350
.B comment\-begin (``#'')
351
The string that is inserted in \fBvi\fP mode when the
352
.B insert\-comment
353
command is executed.
354
This command is bound to
355
.B M\-#
356
in emacs mode and to
357
.B #
358
in vi command mode.
359
.TP
360
.B completion\-ignore\-case (Off)
361
If set to \fBOn\fP, readline performs filename matching and completion
362
in a case\-insensitive fashion.
363
.TP
364
.B completion\-query\-items (100)
365
This determines when the user is queried about viewing
366
the number of possible completions
367
generated by the \fBpossible\-completions\fP command.
368
It may be set to any integer value greater than or equal to
369
zero.  If the number of possible completions is greater than
370
or equal to the value of this variable, the user is asked whether
371
or not he wishes to view them; otherwise they are simply listed
372
on the terminal.  A negative value causes readline to never ask.
373
.TP
374
.B convert\-meta (On)
375
If set to \fBOn\fP, readline will convert characters with the
376
eighth bit set to an ASCII key sequence
377
by stripping the eighth bit and prefixing it with an
378
escape character (in effect, using escape as the \fImeta prefix\fP).
379
.TP
380
.B disable\-completion (Off)
381
If set to \fBOn\fP, readline will inhibit word completion.  Completion
382
characters will be inserted into the line as if they had been
383
mapped to \fBself-insert\fP.
384
.TP
385
.B editing\-mode (emacs)
386
Controls whether readline begins with a set of key bindings similar
387
to emacs or vi.
388
.B editing\-mode
389
can be set to either
390
.B emacs
391
or
392
.BR vi .
393
.TP
394
.B enable\-keypad (Off)
395
When set to \fBOn\fP, readline will try to enable the application
396
keypad when it is called.  Some systems need this to enable the
397
arrow keys.
398
.TP
399
.B expand\-tilde (Off)
400
If set to \fBon\fP, tilde expansion is performed when readline
401
attempts word completion.
402
.TP
403
.B history\-preserve\-point (Off)
404
If set to \fBon\fP, the history code attempts to place point at the
405
same location on each history line retrieved with \fBprevious-history\fP
406
or \fBnext-history\fP.
407
.TP
408
.B horizontal\-scroll\-mode (Off)
409
When set to \fBOn\fP, makes readline use a single line for display,
410
scrolling the input horizontally on a single screen line when it
411
becomes longer than the screen width rather than wrapping to a new line.
412
.TP
413
.B input\-meta (Off)
414
If set to \fBOn\fP, readline will enable eight-bit input (that is,
415
it will not clear the eighth bit in the characters it reads),
416
regardless of what the terminal claims it can support.  The name
417
.B meta\-flag
418
is a synonym for this variable.
419
.TP
420
.B isearch\-terminators (``C\-[ C\-J'')
421
The string of characters that should terminate an incremental
422
search without subsequently executing the character as a command.
423
If this variable has not been given a value, the characters
424
\fIESC\fP and \fIC\-J\fP will terminate an incremental search.
425
.TP
426
.B keymap (emacs)
427
Set the current readline keymap.  The set of legal keymap names is
428
\fIemacs, emacs-standard, emacs-meta, emacs-ctlx, vi, vi-move,
429
vi-command\fP, and
430
.IR vi-insert .
431
\fIvi\fP is equivalent to \fIvi-command\fP; \fIemacs\fP is
432
equivalent to \fIemacs-standard\fP.  The default value is
433
.IR emacs .
434
The value of
435
.B editing\-mode
436
also affects the default keymap.
437
.TP
438
.B mark\-directories (On)
439
If set to \fBOn\fP, completed directory names have a slash
440
appended.
441
.TP
442
.B mark\-modified\-lines (Off)
443
If set to \fBOn\fP, history lines that have been modified are displayed
444
with a preceding asterisk (\fB*\fP).
445
.TP
446
.B mark\-symlinked\-directories (Off)
447
If set to \fBOn\fP, completed names which are symbolic links to directories
448
have a slash appended (subject to the value of
449
\fBmark\-directories\fP).
450
.TP
451
.B match\-hidden\-files (On)
452
This variable, when set to \fBOn\fP, causes readline to match files whose
453
names begin with a `.' (hidden files) when performing filename
454
completion, unless the leading `.' is
455
supplied by the user in the filename to be completed.
456
.TP
457
.B output\-meta (Off)
458
If set to \fBOn\fP, readline will display characters with the
459
eighth bit set directly rather than as a meta-prefixed escape
460
sequence.
461
.TP
462
.B page\-completions (On)
463
If set to \fBOn\fP, readline uses an internal \fImore\fP-like pager
464
to display a screenful of possible completions at a time.
465
.TP
466
.B print\-completions\-horizontally (Off)
467
If set to \fBOn\fP, readline will display completions with matches
468
sorted horizontally in alphabetical order, rather than down the screen.
469
.TP
470
.B show\-all\-if\-ambiguous (Off)
471
This alters the default behavior of the completion functions.  If
472
set to
473
.BR on ,
474
words which have more than one possible completion cause the
475
matches to be listed immediately instead of ringing the bell.
476
.TP
477
.B show\-all\-if\-unmodified (Off)
478
This alters the default behavior of the completion functions in
479
a fashion similar to \fBshow\-all\-if\-ambiguous\fP.
480
If set to
481
.BR on ,
482
words which have more than one possible completion without any
483
possible partial completion (the possible completions don't share
484
a common prefix) cause the matches to be listed immediately instead
485
of ringing the bell.
486
.TP
487
.B visible\-stats (Off)
488
If set to \fBOn\fP, a character denoting a file's type as reported
489
by \fIstat\fP(2) is appended to the filename when listing possible
490
completions.
491
.PD
492
.SS Conditional Constructs
493
.PP
494
Readline implements a facility similar in spirit to the conditional
495
compilation features of the C preprocessor which allows key
496
bindings and variable settings to be performed as the result
497
of tests.  There are four parser directives used.
498
.IP \fB$if\fP
499
The
500
.B $if
501
construct allows bindings to be made based on the
502
editing mode, the terminal being used, or the application using
503
readline.  The text of the test extends to the end of the line;
504
no characters are required to isolate it.
505
.RS
506
.IP \fBmode\fP
507
The \fBmode=\fP form of the \fB$if\fP directive is used to test
508
whether readline is in emacs or vi mode.
509
This may be used in conjunction
510
with the \fBset keymap\fP command, for instance, to set bindings in
511
the \fIemacs-standard\fP and \fIemacs-ctlx\fP keymaps only if
512
readline is starting out in emacs mode.
513
.IP \fBterm\fP
514
The \fBterm=\fP form may be used to include terminal-specific
515
key bindings, perhaps to bind the key sequences output by the
516
terminal's function keys.  The word on the right side of the
517
.B =
518
is tested against the full name of the terminal and the portion
519
of the terminal name before the first \fB\-\fP.  This allows
520
.I sun
521
to match both
522
.I sun
523
and
524
.IR sun\-cmd ,
525
for instance.
526
.IP \fBapplication\fP
527
The \fBapplication\fP construct is used to include
528
application-specific settings.  Each program using the readline
529
library sets the \fIapplication name\fP, and an initialization
530
file can test for a particular value.
531
This could be used to bind key sequences to functions useful for
532
a specific program.  For instance, the following command adds a
533
key sequence that quotes the current or previous word in Bash:
534
.sp 1
535
.RS
536
.nf
537
\fB$if\fP Bash
538
# Quote the current or previous word
539
"\eC-xq": "\eeb\e"\eef\e""
540
\fB$endif\fP
541
.fi
542
.RE
543
.RE
544
.IP \fB$endif\fP
545
This command, as seen in the previous example, terminates an
546
\fB$if\fP command.
547
.IP \fB$else\fP
548
Commands in this branch of the \fB$if\fP directive are executed if
549
the test fails.
550
.IP \fB$include\fP
551
This directive takes a single filename as an argument and reads commands
552
and bindings from that file.  For example, the following directive
553
would read \fI/etc/inputrc\fP:
554
.sp 1
555
.RS
556
.nf
557
\fB$include\fP \^ \fI/etc/inputrc\fP
558
.fi
559
.RE
560
.SH SEARCHING
561
.PP
562
Readline provides commands for searching through the command history
563
for lines containing a specified string.
564
There are two search modes:
565
.I incremental
566
and
567
.IR non-incremental .
568
.PP
569
Incremental searches begin before the user has finished typing the
570
search string.
571
As each character of the search string is typed, readline displays
572
the next entry from the history matching the string typed so far.
573
An incremental search requires only as many characters as needed to
574
find the desired history entry.
575
To search backward in the history for a particular string, type
576
\fBC\-r\fP.  Typing \fBC\-s\fP searches forward through the history.
577
The characters present in the value of the \fBisearch-terminators\fP
578
variable are used to terminate an incremental search.
579
If that variable has not been assigned a value the \fIEscape\fP and
580
\fBC\-J\fP characters will terminate an incremental search.
581
\fBC\-G\fP will abort an incremental search and restore the original
582
line.
583
When the search is terminated, the history entry containing the
584
search string becomes the current line.
585
.PP
586
To find other matching entries in the history list, type \fBC\-s\fP or
587
\fBC\-r\fP as appropriate.
588
This will search backward or forward in the history for the next
589
line matching the search string typed so far.
590
Any other key sequence bound to a readline command will terminate
591
the search and execute that command.
592
For instance, a newline will terminate the search and accept
593
the line, thereby executing the command from the history list.
594
A movement command will terminate the search, make the last line found
595
the current line, and begin editing.
596
.PP
597
Non-incremental searches read the entire search string before starting
598
to search for matching history lines.  The search string may be
599
typed by the user or be part of the contents of the current line.
600
.SH EDITING COMMANDS
601
.PP
602
The following is a list of the names of the commands and the default
603
key sequences to which they are bound.
604
Command names without an accompanying key sequence are unbound by default.
605
.PP
606
In the following descriptions, \fIpoint\fP refers to the current cursor
607
position, and \fImark\fP refers to a cursor position saved by the
608
\fBset\-mark\fP command.
609
The text between the point and mark is referred to as the \fIregion\fP.
610
.SS Commands for Moving
611
.PP
612
.PD 0
613
.TP
614
.B beginning\-of\-line (C\-a)
615
Move to the start of the current line.
616
.TP
617
.B end\-of\-line (C\-e)
618
Move to the end of the line.
619
.TP
620
.B forward\-char (C\-f)
621
Move forward a character.
622
.TP
623
.B backward\-char (C\-b)
624
Move back a character.
625
.TP
626
.B forward\-word (M\-f)
627
Move forward to the end of the next word.  Words are composed of
628
alphanumeric characters (letters and digits).
629
.TP
630
.B backward\-word (M\-b)
631
Move back to the start of the current or previous word.  Words are
632
composed of alphanumeric characters (letters and digits).
633
.TP
634
.B clear\-screen (C\-l)
635
Clear the screen leaving the current line at the top of the screen.
636
With an argument, refresh the current line without clearing the
637
screen.
638
.TP
639
.B redraw\-current\-line
640
Refresh the current line.
641
.PD
642
.SS Commands for Manipulating the History
643
.PP
644
.PD 0
645
.TP
646
.B accept\-line (Newline, Return)
647
Accept the line regardless of where the cursor is.
648
If this line is
649
non-empty, it may be added to the history list for future recall with
650
\fBadd_history()\fP.
651
If the line is a modified history line, the history line is restored to its original state.
652
.TP
653
.B previous\-history (C\-p)
654
Fetch the previous command from the history list, moving back in
655
the list.
656
.TP
657
.B next\-history (C\-n)
658
Fetch the next command from the history list, moving forward in the
659
list.
660
.TP
661
.B beginning\-of\-history (M\-<)
662
Move to the first line in the history.
663
.TP
664
.B end\-of\-history (M\->)
665
Move to the end of the input history, i.e., the line currently being
666
entered.
667
.TP
668
.B reverse\-search\-history (C\-r)
669
Search backward starting at the current line and moving `up' through
670
the history as necessary.  This is an incremental search.
671
.TP
672
.B forward\-search\-history (C\-s)
673
Search forward starting at the current line and moving `down' through
674
the history as necessary.  This is an incremental search.
675
.TP
676
.B non\-incremental\-reverse\-search\-history (M\-p)
677
Search backward through the history starting at the current line
678
using a non-incremental search for a string supplied by the user.
679
.TP
680
.B non\-incremental\-forward\-search\-history (M\-n)
681
Search forward through the history using a non-incremental search
682
for a string supplied by the user.
683
.TP
684
.B history\-search\-forward
685
Search forward through the history for the string of characters
686
between the start of the current line and the current cursor
687
position (the \fIpoint\fP).
688
This is a non-incremental search.
689
.TP
690
.B history\-search\-backward
691
Search backward through the history for the string of characters
692
between the start of the current line and the point.
693
This is a non-incremental search.
694
.TP
695
.B yank\-nth\-arg (M\-C\-y)
696
Insert the first argument to the previous command (usually
697
the second word on the previous line) at point.
698
With an argument
699
.IR n ,
700
insert the \fIn\fPth word from the previous command (the words
701
in the previous command begin with word 0).  A negative argument
702
inserts the \fIn\fPth word from the end of the previous command.
703
Once the argument \fIn\fP is computed, the argument is extracted
704
as if the "!\fIn\fP" history expansion had been specified.
705
.TP
706
.B
707
yank\-last\-arg (M\-.\^, M\-_\^)
708
Insert the last argument to the previous command (the last word of
709
the previous history entry).  With an argument,
710
behave exactly like \fByank\-nth\-arg\fP.
711
Successive calls to \fByank\-last\-arg\fP move back through the history
712
list, inserting the last argument of each line in turn.
713
The history expansion facilities are used to extract the last argument,
714
as if the "!$" history expansion had been specified.
715
.PD
716
.SS Commands for Changing Text
717
.PP
718
.PD 0
719
.TP
720
.B delete\-char (C\-d)
721
Delete the character at point.  If point is at the
722
beginning of the line, there are no characters in the line, and
723
the last character typed was not bound to \fBdelete\-char\fP, then return
724
.SM
725
.BR EOF .
726
.TP
727
.B backward\-delete\-char (Rubout)
728
Delete the character behind the cursor.  When given a numeric argument,
729
save the deleted text on the kill ring.
730
.TP
731
.B forward\-backward\-delete\-char
732
Delete the character under the cursor, unless the cursor is at the
733
end of the line, in which case the character behind the cursor is
734
deleted.
735
.TP
736
.B quoted\-insert (C\-q, C\-v)
737
Add the next character that you type to the line verbatim.  This is
738
how to insert characters like \fBC\-q\fP, for example.
739
.TP
740
.B tab\-insert (M-TAB)
741
Insert a tab character.
742
.TP
743
.B self\-insert (a,\ b,\ A,\ 1,\ !,\ ...)
744
Insert the character typed.
745
.TP
746
.B transpose\-chars (C\-t)
747
Drag the character before point forward over the character at point,
748
moving point forward as well.
749
If point is at the end of the line, then this transposes
750
the two characters before point.
751
Negative arguments have no effect.
752
.TP
753
.B transpose\-words (M\-t)
754
Drag the word before point past the word after point,
755
moving point over that word as well.
756
If point is at the end of the line, this transposes
757
the last two words on the line.
758
.TP
759
.B upcase\-word (M\-u)
760
Uppercase the current (or following) word.  With a negative argument,
761
uppercase the previous word, but do not move point.
762
.TP
763
.B downcase\-word (M\-l)
764
Lowercase the current (or following) word.  With a negative argument,
765
lowercase the previous word, but do not move point.
766
.TP
767
.B capitalize\-word (M\-c)
768
Capitalize the current (or following) word.  With a negative argument,
769
capitalize the previous word, but do not move point.
770
.TP
771
.B overwrite\-mode
772
Toggle overwrite mode.  With an explicit positive numeric argument,
773
switches to overwrite mode.  With an explicit non-positive numeric
774
argument, switches to insert mode.  This command affects only
775
\fBemacs\fP mode; \fBvi\fP mode does overwrite differently.
776
Each call to \fIreadline()\fP starts in insert mode.
777
In overwrite mode, characters bound to \fBself\-insert\fP replace
778
the text at point rather than pushing the text to the right.
779
Characters bound to \fBbackward\-delete\-char\fP replace the character
780
before point with a space.  By default, this command is unbound.
781
.PD
782
.SS Killing and Yanking
783
.PP
784
.PD 0
785
.TP
786
.B kill\-line (C\-k)
787
Kill the text from point to the end of the line.
788
.TP
789
.B backward\-kill\-line (C\-x Rubout)
790
Kill backward to the beginning of the line.
791
.TP
792
.B unix\-line\-discard (C\-u)
793
Kill backward from point to the beginning of the line.
794
The killed text is saved on the kill-ring.
795
.\" There is no real difference between this and backward-kill-line
796
.TP
797
.B kill\-whole\-line
798
Kill all characters on the current line, no matter where point is.
799
.TP
800
.B kill\-word  (M\-d)
801
Kill from point the end of the current word, or if between
802
words, to the end of the next word.  Word boundaries are the same as
803
those used by \fBforward\-word\fP.
804
.TP
805
.B backward\-kill\-word (M\-Rubout)
806
Kill the word behind point.
807
Word boundaries are the same as those used by \fBbackward\-word\fP.
808
.TP
809
.B unix\-word\-rubout (C\-w)
810
Kill the word behind point, using white space as a word boundary.
811
The killed text is saved on the kill-ring.
812
.TP
813
.B unix\-filename\-rubout
814
Kill the word behind point, using white space and the slash character
815
as the word boundaries.
816
The killed text is saved on the kill-ring.
817
.TP
818
.B delete\-horizontal\-space (M\-\e)
819
Delete all spaces and tabs around point.
820
.TP
821
.B kill\-region
822
Kill the text between the point and \fImark\fP (saved cursor position).
823
This text is referred to as the \fIregion\fP.
824
.TP
825
.B copy\-region\-as\-kill
826
Copy the text in the region to the kill buffer.
827
.TP
828
.B copy\-backward\-word
829
Copy the word before point to the kill buffer.
830
The word boundaries are the same as \fBbackward\-word\fP.
831
.TP
832
.B copy\-forward\-word
833
Copy the word following point to the kill buffer.
834
The word boundaries are the same as \fBforward\-word\fP.
835
.TP
836
.B yank (C\-y)
837
Yank the top of the kill ring into the buffer at point.
838
.TP
839
.B yank\-pop (M\-y)
840
Rotate the kill ring, and yank the new top.  Only works following
841
.B yank
842
or
843
.BR yank\-pop .
844
.PD
845
.SS Numeric Arguments
846
.PP
847
.PD 0
848
.TP
849
.B digit\-argument (M\-0, M\-1, ..., M\-\-)
850
Add this digit to the argument already accumulating, or start a new
851
argument.  M\-\- starts a negative argument.
852
.TP
853
.B universal\-argument
854
This is another way to specify an argument.
855
If this command is followed by one or more digits, optionally with a
856
leading minus sign, those digits define the argument.
857
If the command is followed by digits, executing
858
.B universal\-argument
859
again ends the numeric argument, but is otherwise ignored.
860
As a special case, if this command is immediately followed by a
861
character that is neither a digit or minus sign, the argument count
862
for the next command is multiplied by four.
863
The argument count is initially one, so executing this function the
864
first time makes the argument count four, a second time makes the
865
argument count sixteen, and so on.
866
.PD
867
.SS Completing
868
.PP
869
.PD 0
870
.TP
871
.B complete (TAB)
872
Attempt to perform completion on the text before point.
873
The actual completion performed is application-specific.
874
.BR Bash ,
875
for instance, attempts completion treating the text as a variable
876
(if the text begins with \fB$\fP), username (if the text begins with
877
\fB~\fP), hostname (if the text begins with \fB@\fP), or
878
command (including aliases and functions) in turn.  If none
879
of these produces a match, filename completion is attempted.
880
.BR Gdb ,
881
on the other hand,
882
allows completion of program functions and variables, and
883
only attempts filename completion under certain circumstances.
884
.TP
885
.B possible\-completions (M\-?)
886
List the possible completions of the text before point.
887
.TP
888
.B insert\-completions (M\-*)
889
Insert all completions of the text before point
890
that would have been generated by
891
\fBpossible\-completions\fP.
892
.TP
893
.B menu\-complete
894
Similar to \fBcomplete\fP, but replaces the word to be completed
895
with a single match from the list of possible completions.
896
Repeated execution of \fBmenu\-complete\fP steps through the list
897
of possible completions, inserting each match in turn.
898
At the end of the list of completions, the bell is rung
899
(subject to the setting of \fBbell\-style\fP)
900
and the original text is restored.
901
An argument of \fIn\fP moves \fIn\fP positions forward in the list
902
of matches; a negative argument may be used to move backward
903
through the list.
904
This command is intended to be bound to \fBTAB\fP, but is unbound
905
by default.
906
.TP
907
.B delete\-char\-or\-list
908
Deletes the character under the cursor if not at the beginning or
909
end of the line (like \fBdelete-char\fP).
910
If at the end of the line, behaves identically to
911
\fBpossible-completions\fP.
912
.PD
913
.SS Keyboard Macros
914
.PP
915
.PD 0
916
.TP
917
.B start\-kbd\-macro (C\-x (\^)
918
Begin saving the characters typed into the current keyboard macro.
919
.TP
920
.B end\-kbd\-macro (C\-x )\^)
921
Stop saving the characters typed into the current keyboard macro
922
and store the definition.
923
.TP
924
.B call\-last\-kbd\-macro (C\-x e)
925
Re-execute the last keyboard macro defined, by making the characters
926
in the macro appear as if typed at the keyboard.
927
.PD
928
.SS Miscellaneous
929
.PP
930
.PD 0
931
.TP
932
.B re\-read\-init\-file (C\-x C\-r)
933
Read in the contents of the \fIinputrc\fP file, and incorporate
934
any bindings or variable assignments found there.
935
.TP
936
.B abort (C\-g)
937
Abort the current editing command and
938
ring the terminal's bell (subject to the setting of
939
.BR bell\-style ).
940
.TP
941
.B do\-uppercase\-version (M\-a, M\-b, M\-\fIx\fP, ...)
942
If the metafied character \fIx\fP is lowercase, run the command
943
that is bound to the corresponding uppercase character.
944
.TP
945
.B prefix\-meta (ESC)
946
Metafy the next character typed.
947
.SM
948
.B ESC
949
.B f
950
is equivalent to
951
.BR Meta\-f .
952
.TP
953
.B undo (C\-_, C\-x C\-u)
954
Incremental undo, separately remembered for each line.
955
.TP
956
.B revert\-line (M\-r)
957
Undo all changes made to this line.  This is like executing the
958
.B undo
959
command enough times to return the line to its initial state.
960
.TP
961
.B tilde\-expand (M\-&)
962
Perform tilde expansion on the current word.
963
.TP
964
.B set\-mark (C\-@, M\-)
965
Set the mark to the point.  If a
966
numeric argument is supplied, the mark is set to that position.
967
.TP
968
.B exchange\-point\-and\-mark (C\-x C\-x)
969
Swap the point with the mark.  The current cursor position is set to
970
the saved position, and the old cursor position is saved as the mark.
971
.TP
972
.B character\-search (C\-])
973
A character is read and point is moved to the next occurrence of that
974
character.  A negative count searches for previous occurrences.
975
.TP
976
.B character\-search\-backward (M\-C\-])
977
A character is read and point is moved to the previous occurrence of that
978
character.  A negative count searches for subsequent occurrences.
979
.TP
980
.B insert\-comment (M\-#)
981
Without a numeric argument, the value of the readline
982
.B comment\-begin
983
variable is inserted at the beginning of the current line.
984
If a numeric argument is supplied, this command acts as a toggle:  if
985
the characters at the beginning of the line do not match the value
986
of \fBcomment\-begin\fP, the value is inserted, otherwise
987
the characters in \fBcomment-begin\fP are deleted from the beginning of
988
the line.
989
In either case, the line is accepted as if a newline had been typed.
990
The default value of
991
.B comment\-begin
992
makes the current line a shell comment.
993
If a numeric argument causes the comment character to be removed, the line
994
will be executed by the shell.
995
.TP
996
.B dump\-functions
997
Print all of the functions and their key bindings to the
998
readline output stream.  If a numeric argument is supplied,
999
the output is formatted in such a way that it can be made part
1000
of an \fIinputrc\fP file.
1001
.TP
1002
.B dump\-variables
1003
Print all of the settable variables and their values to the
1004
readline output stream.  If a numeric argument is supplied,
1005
the output is formatted in such a way that it can be made part
1006
of an \fIinputrc\fP file.
1007
.TP
1008
.B dump\-macros
1009
Print all of the readline key sequences bound to macros and the
1010
strings they output.  If a numeric argument is supplied,
1011
the output is formatted in such a way that it can be made part
1012
of an \fIinputrc\fP file.
1013
.TP
1014
.B emacs\-editing\-mode (C\-e)
1015
When in
1016
.B vi
1017
command mode, this causes a switch to
1018
.B emacs
1019
editing mode.
1020
.TP
1021
.B vi\-editing\-mode (M\-C\-j)
1022
When in
1023
.B emacs
1024
editing mode, this causes a switch to
1025
.B vi
1026
editing mode.
1027
.PD
1028
.SH DEFAULT KEY BINDINGS
1029
.LP
1030
The following is a list of the default emacs and vi bindings.
1031
Characters with the eighth bit set are written as M\-, and
1032
are referred to as
1033
.I metafied
1034
characters.
1035
The printable ASCII characters not mentioned in the list of emacs
1036
standard bindings are bound to the
1037
.B self\-insert
1038
function, which just inserts the given character into the input line.
1039
In vi insertion mode, all characters not specifically mentioned are
1040
bound to
1041
.BR self\-insert .
1042
Characters assigned to signal generation by
1043
.IR stty (1)
1044
or the terminal driver, such as C-Z or C-C,
1045
retain that function.
1046
Upper and lower case metafied characters are bound to the same function in
1047
the emacs mode meta keymap.
1048
The remaining characters are unbound, which causes readline
1049
to ring the bell (subject to the setting of the
1050
.B bell\-style
1051
variable).
1052
.SS Emacs Mode
1053
.RS +.6i
1054
.nf
1055
.ta 2.5i
1056
.sp
1057
Emacs Standard bindings
1058
.sp
1059
"C-@"  set-mark
1060
"C-A"  beginning-of-line
1061
"C-B"  backward-char
1062
"C-D"  delete-char
1063
"C-E"  end-of-line
1064
"C-F"  forward-char
1065
"C-G"  abort
1066
"C-H"  backward-delete-char
1067
"C-I"  complete
1068
"C-J"  accept-line
1069
"C-K"  kill-line
1070
"C-L"  clear-screen
1071
"C-M"  accept-line
1072
"C-N"  next-history
1073
"C-P"  previous-history
1074
"C-Q"  quoted-insert
1075
"C-R"  reverse-search-history
1076
"C-S"  forward-search-history
1077
"C-T"  transpose-chars
1078
"C-U"  unix-line-discard
1079
"C-V"  quoted-insert
1080
"C-W"  unix-word-rubout
1081
"C-Y"  yank
1082
"C-]"  character-search
1083
"C-_"  undo
1084
"\^ " to "/"  self-insert
1085
"0"  to "9"  self-insert
1086
":"  to "~"  self-insert
1087
"C-?"  backward-delete-char
1088
.PP
1089
Emacs Meta bindings
1090
.sp
1091
"M-C-G"  abort
1092
"M-C-H"  backward-kill-word
1093
"M-C-I"  tab-insert
1094
"M-C-J"  vi-editing-mode
1095
"M-C-M"  vi-editing-mode
1096
"M-C-R"  revert-line
1097
"M-C-Y"  yank-nth-arg
1098
"M-C-["  complete
1099
"M-C-]"  character-search-backward
1100
"M-space"  set-mark
1101
"M-#"  insert-comment
1102
"M-&"  tilde-expand
1103
"M-*"  insert-completions
1104
"M--"  digit-argument
1105
"M-."  yank-last-arg
1106
"M-0"  digit-argument
1107
"M-1"  digit-argument
1108
"M-2"  digit-argument
1109
"M-3"  digit-argument
1110
"M-4"  digit-argument
1111
"M-5"  digit-argument
1112
"M-6"  digit-argument
1113
"M-7"  digit-argument
1114
"M-8"  digit-argument
1115
"M-9"  digit-argument
1116
"M-<"  beginning-of-history
1117
"M-="  possible-completions
1118
"M->"  end-of-history
1119
"M-?"  possible-completions
1120
"M-B"  backward-word
1121
"M-C"  capitalize-word
1122
"M-D"  kill-word
1123
"M-F"  forward-word
1124
"M-L"  downcase-word
1125
"M-N"  non-incremental-forward-search-history
1126
"M-P"  non-incremental-reverse-search-history
1127
"M-R"  revert-line
1128
"M-T"  transpose-words
1129
"M-U"  upcase-word
1130
"M-Y"  yank-pop
1131
"M-\e"  delete-horizontal-space
1132
"M-~"  tilde-expand
1133
"M-C-?"  backward-kill-word
1134
"M-_"  yank-last-arg
1135
.PP
1136
Emacs Control-X bindings
1137
.sp
1138
"C-XC-G"  abort
1139
"C-XC-R"  re-read-init-file
1140
"C-XC-U"  undo
1141
"C-XC-X"  exchange-point-and-mark
1142
"C-X("  start-kbd-macro
1143
"C-X)"  end-kbd-macro
1144
"C-XE"  call-last-kbd-macro
1145
"C-XC-?"  backward-kill-line
1146
.sp
1147
.RE
1148
.SS VI Mode bindings
1149
.RS +.6i
1150
.nf
1151
.ta 2.5i
1152
.sp
1153
.PP
1154
VI Insert Mode functions
1155
.sp
1156
"C-D"  vi-eof-maybe
1157
"C-H"  backward-delete-char
1158
"C-I"  complete
1159
"C-J"  accept-line
1160
"C-M"  accept-line
1161
"C-R"  reverse-search-history
1162
"C-S"  forward-search-history
1163
"C-T"  transpose-chars
1164
"C-U"  unix-line-discard
1165
"C-V"  quoted-insert
1166
"C-W"  unix-word-rubout
1167
"C-Y"  yank
1168
"C-["  vi-movement-mode
1169
"C-_"  undo
1170
"\^ " to "~"  self-insert
1171
"C-?"  backward-delete-char
1172
.PP
1173
VI Command Mode functions
1174
.sp
1175
"C-D"  vi-eof-maybe
1176
"C-E"  emacs-editing-mode
1177
"C-G"  abort
1178
"C-H"  backward-char
1179
"C-J"  accept-line
1180
"C-K"  kill-line
1181
"C-L"  clear-screen
1182
"C-M"  accept-line
1183
"C-N"  next-history
1184
"C-P"  previous-history
1185
"C-Q"  quoted-insert
1186
"C-R"  reverse-search-history
1187
"C-S"  forward-search-history
1188
"C-T"  transpose-chars
1189
"C-U"  unix-line-discard
1190
"C-V"  quoted-insert
1191
"C-W"  unix-word-rubout
1192
"C-Y"  yank
1193
"C-_"  vi-undo
1194
"\^ "  forward-char
1195
"#"  insert-comment
1196
"$"  end-of-line
1197
"%"  vi-match
1198
"&"  vi-tilde-expand
1199
"*"  vi-complete
1200
"+"  next-history
1201
","  vi-char-search
1202
"-"  previous-history
1203
"."  vi-redo
1204
"/"  vi-search
1205
"0"  beginning-of-line
1206
"1" to "9"  vi-arg-digit
1207
";"  vi-char-search
1208
"="  vi-complete
1209
"?"  vi-search
1210
"A"  vi-append-eol
1211
"B"  vi-prev-word
1212
"C"  vi-change-to
1213
"D"  vi-delete-to
1214
"E"  vi-end-word
1215
"F"  vi-char-search
1216
"G"  vi-fetch-history
1217
"I"  vi-insert-beg
1218
"N"  vi-search-again
1219
"P"  vi-put
1220
"R"  vi-replace
1221
"S"  vi-subst
1222
"T"  vi-char-search
1223
"U"  revert-line
1224
"W"  vi-next-word
1225
"X"  backward-delete-char
1226
"Y"  vi-yank-to
1227
"\e"  vi-complete
1228
"^"  vi-first-print
1229
"_"  vi-yank-arg
1230
"`"  vi-goto-mark
1231
"a"  vi-append-mode
1232
"b"  vi-prev-word
1233
"c"  vi-change-to
1234
"d"  vi-delete-to
1235
"e"  vi-end-word
1236
"f"  vi-char-search
1237
"h"  backward-char
1238
"i"  vi-insertion-mode
1239
"j"  next-history
1240
"k"  prev-history
1241
"l"  forward-char
1242
"m"  vi-set-mark
1243
"n"  vi-search-again
1244
"p"  vi-put
1245
"r"  vi-change-char
1246
"s"  vi-subst
1247
"t"  vi-char-search
1248
"u"  vi-undo
1249
"w"  vi-next-word
1250
"x"  vi-delete
1251
"y"  vi-yank-to
1252
"|"  vi-column
1253
"~"  vi-change-case
1254
.RE
1255
.SH "SEE ALSO"
1256
.PD 0
1257
.TP
1258
\fIThe Gnu Readline Library\fP, Brian Fox and Chet Ramey
1259
.TP
1260
\fIThe Gnu History Library\fP, Brian Fox and Chet Ramey
1261
.TP
1262
\fIbash\fP(1)
1263
.PD
1264
.SH FILES
1265
.PD 0
1266
.TP
1267
.FN ~/.inputrc
1268
Individual \fBreadline\fP initialization file
1269
.PD
1270
.SH AUTHORS
1271
Brian Fox, Free Software Foundation
1272
.br
1273
bfox@gnu.org
1274
.PP
1275
Chet Ramey, Case Western Reserve University
1276
.br
1277
chet@ins.CWRU.Edu
1278
.SH BUG REPORTS
1279
If you find a bug in
1280
.B readline,
1281
you should report it.  But first, you should
1282
make sure that it really is a bug, and that it appears in the latest
1283
version of the
1284
.B readline
1285
library that you have.
1286
.PP
1287
Once you have determined that a bug actually exists, mail a
1288
bug report to \fIbug\-readline\fP@\fIgnu.org\fP.
1289
If you have a fix, you are welcome to mail that
1290
as well!  Suggestions and `philosophical' bug reports may be mailed
1291
to \fPbug-readline\fP@\fIgnu.org\fP or posted to the Usenet
1292
newsgroup
1293
.BR gnu.bash.bug .
1294
.PP
1295
Comments and bug reports concerning
1296
this manual page should be directed to
1297
.IR chet@ins.CWRU.Edu .
1298
.SH BUGS
1299
.PP
1300
It's too big and too slow.

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.