visus
/
toolchain-gcc-arm-embedded
Beobachten 1
Favorisieren 0
Fork 0
Code Issues 0 Pull-Requests 0 Releases 0 Wiki Aktivität
Du kannst nicht mehr als 25 Themen auswählen Themen müssen entweder mit einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.
2 Commits
1 Branch
Branch: main
Branches Tags
${ item.name }
Erstelle Branch ${ searchTerm }
von „main“
${ noResults }
toolchain-gcc-arm-embedded/share/doc/gcc-arm-none-eabi/html/gdb/Readline-Init-File-Syntax.html

673 Zeilen
29KB
Originalformat Permalink Blame Verlauf 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

  2. <html>

  3. <!-- Copyright (C) 1988-2020 Free Software Foundation, Inc.

  4. 

  5. Permission is granted to copy, distribute and/or modify this document

  6. under the terms of the GNU Free Documentation License, Version 1.3 or

  7. any later version published by the Free Software Foundation; with the

  8. Invariant Sections being "Free Software" and "Free Software Needs

  9. Free Documentation", with the Front-Cover Texts being "A GNU Manual,"

  10. and with the Back-Cover Texts as in (a) below.

  11. 

  12. (a) The FSF's Back-Cover Text is: "You are free to copy and modify

  13. this GNU Manual.  Buying copies from GNU Press supports the FSF in

  14. developing GNU and promoting software freedom." -->

  15. <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->

  16. <head>

  17. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">

  18. <title>Readline Init File Syntax (Debugging with GDB)</title>

  19. 

  20. <meta name="description" content="Readline Init File Syntax (Debugging with GDB)">

  21. <meta name="keywords" content="Readline Init File Syntax (Debugging with GDB)">

  22. <meta name="resource-type" content="document">

  23. <meta name="distribution" content="global">

  24. <meta name="Generator" content="makeinfo">

  25. <link href="index.html#Top" rel="start" title="Top">

  26. <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">

  27. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">

  28. <link href="Readline-Init-File.html#Readline-Init-File" rel="up" title="Readline Init File">

  29. <link href="Conditional-Init-Constructs.html#Conditional-Init-Constructs" rel="next" title="Conditional Init Constructs">

  30. <link href="Readline-Init-File.html#Readline-Init-File" rel="prev" title="Readline Init File">

  31. <style type="text/css">

  32. <!--

  33. a.summary-letter {text-decoration: none}

  34. blockquote.indentedblock {margin-right: 0em}

  35. blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}

  36. blockquote.smallquotation {font-size: smaller}

  37. div.display {margin-left: 3.2em}

  38. div.example {margin-left: 3.2em}

  39. div.lisp {margin-left: 3.2em}

  40. div.smalldisplay {margin-left: 3.2em}

  41. div.smallexample {margin-left: 3.2em}

  42. div.smalllisp {margin-left: 3.2em}

  43. kbd {font-style: oblique}

  44. pre.display {font-family: inherit}

  45. pre.format {font-family: inherit}

  46. pre.menu-comment {font-family: serif}

  47. pre.menu-preformatted {font-family: serif}

  48. pre.smalldisplay {font-family: inherit; font-size: smaller}

  49. pre.smallexample {font-size: smaller}

  50. pre.smallformat {font-family: inherit; font-size: smaller}

  51. pre.smalllisp {font-size: smaller}

  52. span.nolinebreak {white-space: nowrap}

  53. span.roman {font-family: initial; font-weight: normal}

  54. span.sansserif {font-family: sans-serif; font-weight: normal}

  55. ul.no-bullet {list-style: none}

  56. -->

  57. </style>

  58. 

  59. 

  60. </head>

  61. 

  62. <body lang="en">

  63. <a name="Readline-Init-File-Syntax"></a>

  64. <div class="header">

  65. <p>

  66. Next: <a href="Conditional-Init-Constructs.html#Conditional-Init-Constructs" accesskey="n" rel="next">Conditional Init Constructs</a>, Up: <a href="Readline-Init-File.html#Readline-Init-File" accesskey="u" rel="up">Readline Init File</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>

  67. </div>

  68. <hr>

  69. <a name="Readline-Init-File-Syntax-1"></a>

  70. <h4 class="subsection">32.3.1 Readline Init File Syntax</h4>

  71. 

  72. <p>There are only a few basic constructs allowed in the

  73. Readline init file.  Blank lines are ignored.

  74. Lines beginning with a &lsquo;<samp>#</samp>&rsquo; are comments.

  75. Lines beginning with a &lsquo;<samp>$</samp>&rsquo; indicate conditional

  76. constructs (see <a href="Conditional-Init-Constructs.html#Conditional-Init-Constructs">Conditional Init Constructs</a>).  Other lines

  77. denote variable settings and key bindings.

  78. </p>

  79. <dl compact="compact">

  80. <dt>Variable Settings</dt>

  81. <dd><p>You can modify the run-time behavior of Readline by

  82. altering the values of variables in Readline

  83. using the <code>set</code> command within the init file.

  84. The syntax is simple:

  85. </p>

  86. <div class="example">

  87. <pre class="example">set <var>variable</var> <var>value</var>

  88. </pre></div>

  89. 

  90. <p>Here, for example, is how to

  91. change from the default Emacs-like key binding to use

  92. <code>vi</code> line editing commands:

  93. </p>

  94. <div class="example">

  95. <pre class="example">set editing-mode vi

  96. </pre></div>

  97. 

  98. <p>Variable names and values, where appropriate, are recognized without regard

  99. to case.  Unrecognized variable names are ignored.

  100. </p>

  101. <p>Boolean variables (those that can be set to on or off) are set to on if

  102. the value is null or empty, <var>on</var> (case-insensitive), or 1.  Any other

  103. value results in the variable being set to off.

  104. </p>

  105. 

  106. <p>A great deal of run-time behavior is changeable with the following

  107. variables.

  108. </p>

  109. <a name="index-variables_002c-readline"></a>

  110. <dl compact="compact">

  111. <dt><code>bell-style</code></dt>

  112. <dd><a name="index-bell_002dstyle"></a>

  113. <p>Controls what happens when Readline wants to ring the terminal bell.

  114. If set to &lsquo;<samp>none</samp>&rsquo;, Readline never rings the bell.  If set to

  115. &lsquo;<samp>visible</samp>&rsquo;, Readline uses a visible bell if one is available.

  116. If set to &lsquo;<samp>audible</samp>&rsquo; (the default), Readline attempts to ring

  117. the terminal&rsquo;s bell.

  118. </p>

  119. </dd>

  120. <dt><code>bind-tty-special-chars</code></dt>

  121. <dd><a name="index-bind_002dtty_002dspecial_002dchars"></a>

  122. <p>If set to &lsquo;<samp>on</samp>&rsquo; (the default), Readline attempts to bind the control

  123. characters   treated specially by the kernel&rsquo;s terminal driver to their

  124. Readline equivalents.

  125. </p>

  126. </dd>

  127. <dt><code>blink-matching-paren</code></dt>

  128. <dd><a name="index-blink_002dmatching_002dparen"></a>

  129. <p>If set to &lsquo;<samp>on</samp>&rsquo;, Readline attempts to briefly move the cursor to an

  130. opening parenthesis when a closing parenthesis is inserted.  The default

  131. is &lsquo;<samp>off</samp>&rsquo;.

  132. </p>

  133. </dd>

  134. <dt><code>colored-completion-prefix</code></dt>

  135. <dd><a name="index-colored_002dcompletion_002dprefix"></a>

  136. <p>If set to &lsquo;<samp>on</samp>&rsquo;, when listing completions, Readline displays the

  137. common prefix of the set of possible completions using a different color.

  138. The color definitions are taken from the value of the <code>LS_COLORS</code>

  139. environment variable.

  140. The default is &lsquo;<samp>off</samp>&rsquo;.

  141. </p>

  142. </dd>

  143. <dt><code>colored-stats</code></dt>

  144. <dd><a name="index-colored_002dstats"></a>

  145. <p>If set to &lsquo;<samp>on</samp>&rsquo;, Readline displays possible completions using different

  146. colors to indicate their file type.

  147. The color definitions are taken from the value of the <code>LS_COLORS</code>

  148. environment variable.

  149. The default is &lsquo;<samp>off</samp>&rsquo;.

  150. </p>

  151. </dd>

  152. <dt><code>comment-begin</code></dt>

  153. <dd><a name="index-comment_002dbegin"></a>

  154. <p>The string to insert at the beginning of the line when the

  155. <code>insert-comment</code> command is executed.  The default value

  156. is <code>&quot;#&quot;</code>.

  157. </p>

  158. </dd>

  159. <dt><code>completion-display-width</code></dt>

  160. <dd><a name="index-completion_002ddisplay_002dwidth"></a>

  161. <p>The number of screen columns used to display possible matches

  162. when performing completion.

  163. The value is ignored if it is less than 0 or greater than the terminal

  164. screen width.

  165. A value of 0 will cause matches to be displayed one per line.

  166. The default value is -1.

  167. </p>

  168. </dd>

  169. <dt><code>completion-ignore-case</code></dt>

  170. <dd><a name="index-completion_002dignore_002dcase"></a>

  171. <p>If set to &lsquo;<samp>on</samp>&rsquo;, Readline performs filename matching and completion

  172. in a case-insensitive fashion.

  173. The default value is &lsquo;<samp>off</samp>&rsquo;.

  174. </p>

  175. </dd>

  176. <dt><code>completion-map-case</code></dt>

  177. <dd><a name="index-completion_002dmap_002dcase"></a>

  178. <p>If set to &lsquo;<samp>on</samp>&rsquo;, and <var>completion-ignore-case</var> is enabled, Readline

  179. treats hyphens (&lsquo;<samp>-</samp>&rsquo;) and underscores (&lsquo;<samp>_</samp>&rsquo;) as equivalent when

  180. performing case-insensitive filename matching and completion.

  181. The default value is &lsquo;<samp>off</samp>&rsquo;.

  182. </p>

  183. </dd>

  184. <dt><code>completion-prefix-display-length</code></dt>

  185. <dd><a name="index-completion_002dprefix_002ddisplay_002dlength"></a>

  186. <p>The length in characters of the common prefix of a list of possible

  187. completions that is displayed without modification.  When set to a

  188. value greater than zero, common prefixes longer than this value are

  189. replaced with an ellipsis when displaying possible completions.

  190. </p>

  191. </dd>

  192. <dt><code>completion-query-items</code></dt>

  193. <dd><a name="index-completion_002dquery_002ditems"></a>

  194. <p>The number of possible completions that determines when the user is

  195. asked whether the list of possibilities should be displayed.

  196. If the number of possible completions is greater than this value,

  197. Readline will ask the user whether or not he wishes to view

  198. them; otherwise, they are simply listed.

  199. This variable must be set to an integer value greater than or equal to 0.

  200. A negative value means Readline should never ask.

  201. The default limit is <code>100</code>.

  202. </p>

  203. </dd>

  204. <dt><code>convert-meta</code></dt>

  205. <dd><a name="index-convert_002dmeta"></a>

  206. <p>If set to &lsquo;<samp>on</samp>&rsquo;, Readline will convert characters with the

  207. eighth bit set to an <small>ASCII</small> key sequence by stripping the eighth

  208. bit and prefixing an <tt class="key">ESC</tt> character, converting them to a

  209. meta-prefixed key sequence.  The default value is &lsquo;<samp>on</samp>&rsquo;, but

  210. will be set to &lsquo;<samp>off</samp>&rsquo; if the locale is one that contains

  211. eight-bit characters.

  212. </p>

  213. </dd>

  214. <dt><code>disable-completion</code></dt>

  215. <dd><a name="index-disable_002dcompletion"></a>

  216. <p>If set to &lsquo;<samp>On</samp>&rsquo;, Readline will inhibit word completion.

  217. Completion  characters will be inserted into the line as if they had

  218. been mapped to <code>self-insert</code>.  The default is &lsquo;<samp>off</samp>&rsquo;.

  219. </p>

  220. </dd>

  221. <dt><code>echo-control-characters</code></dt>

  222. <dd><a name="index-echo_002dcontrol_002dcharacters"></a>

  223. <p>When set to &lsquo;<samp>on</samp>&rsquo;, on operating systems that indicate they support it,

  224. readline echoes a character corresponding to a signal generated from the

  225. keyboard.  The default is &lsquo;<samp>on</samp>&rsquo;.

  226. </p>

  227. </dd>

  228. <dt><code>editing-mode</code></dt>

  229. <dd><a name="index-editing_002dmode"></a>

  230. <p>The <code>editing-mode</code> variable controls which default set of

  231. key bindings is used.  By default, Readline starts up in Emacs editing

  232. mode, where the keystrokes are most similar to Emacs.  This variable can be

  233. set to either &lsquo;<samp>emacs</samp>&rsquo; or &lsquo;<samp>vi</samp>&rsquo;.

  234. </p>

  235. </dd>

  236. <dt><code>emacs-mode-string</code></dt>

  237. <dd><a name="index-emacs_002dmode_002dstring"></a>

  238. <p>If the <var>show-mode-in-prompt</var> variable is enabled,

  239. this string is displayed immediately before the last line of the primary

  240. prompt when emacs editing mode is active.  The value is expanded like a

  241. key binding, so the standard set of meta- and control prefixes and

  242. backslash escape sequences is available.

  243. Use the &lsquo;<samp>\1</samp>&rsquo; and &lsquo;<samp>\2</samp>&rsquo; escapes to begin and end sequences of

  244. non-printing characters, which can be used to embed a terminal control

  245. sequence into the mode string.

  246. The default is &lsquo;<samp>@</samp>&rsquo;.

  247. </p>

  248. </dd>

  249. <dt><code>enable-bracketed-paste</code></dt>

  250. <dd><a name="index-enable_002dbracketed_002dpaste"></a>

  251. <p>When set to &lsquo;<samp>On</samp>&rsquo;, Readline will configure the terminal in a way

  252. that will enable it to insert each paste into the editing buffer as a

  253. single string of characters, instead of treating each character as if

  254. it had been read from the keyboard.  This can prevent pasted characters

  255. from being interpreted as editing commands.  The default is &lsquo;<samp>off</samp>&rsquo;.

  256. </p>

  257. </dd>

  258. <dt><code>enable-keypad</code></dt>

  259. <dd><a name="index-enable_002dkeypad"></a>

  260. <p>When set to &lsquo;<samp>on</samp>&rsquo;, Readline will try to enable the application

  261. keypad when it is called.  Some systems need this to enable the

  262. arrow keys.  The default is &lsquo;<samp>off</samp>&rsquo;.

  263. </p>

  264. </dd>

  265. <dt><code>enable-meta-key</code></dt>

  266. <dd><p>When set to &lsquo;<samp>on</samp>&rsquo;, Readline will try to enable any meta modifier

  267. key the terminal claims to support when it is called.  On many terminals,

  268. the meta key is used to send eight-bit characters.

  269. The default is &lsquo;<samp>on</samp>&rsquo;.

  270. </p>

  271. </dd>

  272. <dt><code>expand-tilde</code></dt>

  273. <dd><a name="index-expand_002dtilde"></a>

  274. <p>If set to &lsquo;<samp>on</samp>&rsquo;, tilde expansion is performed when Readline

  275. attempts word completion.  The default is &lsquo;<samp>off</samp>&rsquo;.

  276. </p>

  277. </dd>

  278. <dt><code>history-preserve-point</code></dt>

  279. <dd><a name="index-history_002dpreserve_002dpoint"></a>

  280. <p>If set to &lsquo;<samp>on</samp>&rsquo;, the history code attempts to place the point (the

  281. current cursor position) at the

  282. same location on each history line retrieved with <code>previous-history</code>

  283. or <code>next-history</code>.  The default is &lsquo;<samp>off</samp>&rsquo;.

  284. </p>

  285. </dd>

  286. <dt><code>history-size</code></dt>

  287. <dd><a name="index-history_002dsize"></a>

  288. <p>Set the maximum number of history entries saved in the history list.

  289. If set to zero, any existing history entries are deleted and no new entries

  290. are saved.

  291. If set to a value less than zero, the number of history entries is not

  292. limited.

  293. By default, the number of history entries is not limited.

  294. If an attempt is made to set <var>history-size</var> to a non-numeric value,

  295. the maximum number of history entries will be set to 500.

  296. </p>

  297. </dd>

  298. <dt><code>horizontal-scroll-mode</code></dt>

  299. <dd><a name="index-horizontal_002dscroll_002dmode"></a>

  300. <p>This variable can be set to either &lsquo;<samp>on</samp>&rsquo; or &lsquo;<samp>off</samp>&rsquo;.  Setting it

  301. to &lsquo;<samp>on</samp>&rsquo; means that the text of the lines being edited will scroll

  302. horizontally on a single screen line when they are longer than the width

  303. of the screen, instead of wrapping onto a new screen line.  By default,

  304. this variable is set to &lsquo;<samp>off</samp>&rsquo;.

  305. </p>

  306. </dd>

  307. <dt><code>input-meta</code></dt>

  308. <dd><a name="index-input_002dmeta"></a>

  309. <a name="index-meta_002dflag"></a>

  310. <p>If set to &lsquo;<samp>on</samp>&rsquo;, Readline will enable eight-bit input (it

  311. will not clear the eighth bit in the characters it reads),

  312. regardless of what the terminal claims it can support.  The

  313. default value is &lsquo;<samp>off</samp>&rsquo;, but Readline will set it to &lsquo;<samp>on</samp>&rsquo; if the 

  314. locale contains eight-bit characters.

  315. The name <code>meta-flag</code> is a synonym for this variable.

  316. </p>

  317. </dd>

  318. <dt><code>isearch-terminators</code></dt>

  319. <dd><a name="index-isearch_002dterminators"></a>

  320. <p>The string of characters that should terminate an incremental search without

  321. subsequently executing the character as a command (see <a href="Searching.html#Searching">Searching</a>).

  322. If this variable has not been given a value, the characters <tt class="key">ESC</tt> and

  323. <kbd>C-J</kbd> will terminate an incremental search.

  324. </p>

  325. </dd>

  326. <dt><code>keymap</code></dt>

  327. <dd><a name="index-keymap"></a>

  328. <p>Sets Readline&rsquo;s idea of the current keymap for key binding commands.

  329. Built-in <code>keymap</code> names are

  330. <code>emacs</code>,

  331. <code>emacs-standard</code>,

  332. <code>emacs-meta</code>,

  333. <code>emacs-ctlx</code>,

  334. <code>vi</code>,

  335. <code>vi-move</code>,

  336. <code>vi-command</code>, and

  337. <code>vi-insert</code>.

  338. <code>vi</code> is equivalent to <code>vi-command</code> (<code>vi-move</code> is also a

  339. synonym); <code>emacs</code> is equivalent to <code>emacs-standard</code>.

  340. Applications may add additional names.

  341. The default value is <code>emacs</code>.

  342. The value of the <code>editing-mode</code> variable also affects the

  343. default keymap.

  344. </p>

  345. </dd>

  346. <dt><code>keyseq-timeout</code></dt>

  347. <dd><p>Specifies the duration Readline will wait for a character when reading an

  348. ambiguous key sequence (one that can form a complete key sequence using

  349. the input read so far, or can take additional input to complete a longer

  350. key sequence).

  351. If no input is received within the timeout, Readline will use the shorter

  352. but complete key sequence.

  353. Readline uses this value to determine whether or not input is

  354. available on the current input source (<code>rl_instream</code> by default).

  355. The value is specified in milliseconds, so a value of 1000 means that

  356. Readline will wait one second for additional input.

  357. If this variable is set to a value less than or equal to zero, or to a

  358. non-numeric value, Readline will wait until another key is pressed to

  359. decide which key sequence to complete.

  360. The default value is <code>500</code>.

  361. </p>

  362. </dd>

  363. <dt><code>mark-directories</code></dt>

  364. <dd><p>If set to &lsquo;<samp>on</samp>&rsquo;, completed directory names have a slash

  365. appended.  The default is &lsquo;<samp>on</samp>&rsquo;.

  366. </p>

  367. </dd>

  368. <dt><code>mark-modified-lines</code></dt>

  369. <dd><a name="index-mark_002dmodified_002dlines"></a>

  370. <p>This variable, when set to &lsquo;<samp>on</samp>&rsquo;, causes Readline to display an

  371. asterisk (&lsquo;<samp>*</samp>&rsquo;) at the start of history lines which have been modified.

  372. This variable is &lsquo;<samp>off</samp>&rsquo; by default.

  373. </p>

  374. </dd>

  375. <dt><code>mark-symlinked-directories</code></dt>

  376. <dd><a name="index-mark_002dsymlinked_002ddirectories"></a>

  377. <p>If set to &lsquo;<samp>on</samp>&rsquo;, completed names which are symbolic links

  378. to directories have a slash appended (subject to the value of

  379. <code>mark-directories</code>).

  380. The default is &lsquo;<samp>off</samp>&rsquo;.

  381. </p>

  382. </dd>

  383. <dt><code>match-hidden-files</code></dt>

  384. <dd><a name="index-match_002dhidden_002dfiles"></a>

  385. <p>This variable, when set to &lsquo;<samp>on</samp>&rsquo;, causes Readline to match files whose

  386. names begin with a &lsquo;<samp>.</samp>&rsquo; (hidden files) when performing filename

  387. completion.

  388. If set to &lsquo;<samp>off</samp>&rsquo;, the leading &lsquo;<samp>.</samp>&rsquo; must be

  389. supplied by the user in the filename to be completed.

  390. This variable is &lsquo;<samp>on</samp>&rsquo; by default.

  391. </p>

  392. </dd>

  393. <dt><code>menu-complete-display-prefix</code></dt>

  394. <dd><a name="index-menu_002dcomplete_002ddisplay_002dprefix"></a>

  395. <p>If set to &lsquo;<samp>on</samp>&rsquo;, menu completion displays the common prefix of the

  396. list of possible completions (which may be empty) before cycling through

  397. the list.  The default is &lsquo;<samp>off</samp>&rsquo;.

  398. </p>

  399. </dd>

  400. <dt><code>output-meta</code></dt>

  401. <dd><a name="index-output_002dmeta"></a>

  402. <p>If set to &lsquo;<samp>on</samp>&rsquo;, Readline will display characters with the

  403. eighth bit set directly rather than as a meta-prefixed escape

  404. sequence.

  405. The default is &lsquo;<samp>off</samp>&rsquo;, but Readline will set it to &lsquo;<samp>on</samp>&rsquo; if the

  406. locale contains eight-bit characters.

  407. </p>

  408. </dd>

  409. <dt><code>page-completions</code></dt>

  410. <dd><a name="index-page_002dcompletions"></a>

  411. <p>If set to &lsquo;<samp>on</samp>&rsquo;, Readline uses an internal <code>more</code>-like pager

  412. to display a screenful of possible completions at a time.

  413. This variable is &lsquo;<samp>on</samp>&rsquo; by default.

  414. </p>

  415. </dd>

  416. <dt><code>print-completions-horizontally</code></dt>

  417. <dd><p>If set to &lsquo;<samp>on</samp>&rsquo;, Readline will display completions with matches

  418. sorted horizontally in alphabetical order, rather than down the screen.

  419. The default is &lsquo;<samp>off</samp>&rsquo;.

  420. </p>

  421. </dd>

  422. <dt><code>revert-all-at-newline</code></dt>

  423. <dd><a name="index-revert_002dall_002dat_002dnewline"></a>

  424. <p>If set to &lsquo;<samp>on</samp>&rsquo;, Readline will undo all changes to history lines

  425. before returning when <code>accept-line</code> is executed.  By default,

  426. history lines may be modified and retain individual undo lists across

  427. calls to <code>readline</code>.  The default is &lsquo;<samp>off</samp>&rsquo;.

  428. </p>

  429. </dd>

  430. <dt><code>show-all-if-ambiguous</code></dt>

  431. <dd><a name="index-show_002dall_002dif_002dambiguous"></a>

  432. <p>This alters the default behavior of the completion functions.  If

  433. set to &lsquo;<samp>on</samp>&rsquo;, 

  434. words which have more than one possible completion cause the

  435. matches to be listed immediately instead of ringing the bell.

  436. The default value is &lsquo;<samp>off</samp>&rsquo;.

  437. </p>

  438. </dd>

  439. <dt><code>show-all-if-unmodified</code></dt>

  440. <dd><a name="index-show_002dall_002dif_002dunmodified"></a>

  441. <p>This alters the default behavior of the completion functions in

  442. a fashion similar to <var>show-all-if-ambiguous</var>.

  443. If set to &lsquo;<samp>on</samp>&rsquo;, 

  444. words which have more than one possible completion without any

  445. possible partial completion (the possible completions don&rsquo;t share

  446. a common prefix) cause the matches to be listed immediately instead

  447. of ringing the bell.

  448. The default value is &lsquo;<samp>off</samp>&rsquo;.

  449. </p>

  450. </dd>

  451. <dt><code>show-mode-in-prompt</code></dt>

  452. <dd><a name="index-show_002dmode_002din_002dprompt"></a>

  453. <p>If set to &lsquo;<samp>on</samp>&rsquo;, add a string to the beginning of the prompt

  454. indicating the editing mode: emacs, vi command, or vi insertion.

  455. The mode strings are user-settable (e.g., <var>emacs-mode-string</var>).

  456. The default value is &lsquo;<samp>off</samp>&rsquo;.

  457. </p>

  458. </dd>

  459. <dt><code>skip-completed-text</code></dt>

  460. <dd><a name="index-skip_002dcompleted_002dtext"></a>

  461. <p>If set to &lsquo;<samp>on</samp>&rsquo;, this alters the default completion behavior when

  462. inserting a single match into the line.  It&rsquo;s only active when

  463. performing completion in the middle of a word.  If enabled, readline

  464. does not insert characters from the completion that match characters

  465. after point in the word being completed, so portions of the word

  466. following the cursor are not duplicated.

  467. For instance, if this is enabled, attempting completion when the cursor

  468. is after the &lsquo;<samp>e</samp>&rsquo; in &lsquo;<samp>Makefile</samp>&rsquo; will result in &lsquo;<samp>Makefile</samp>&rsquo;

  469. rather than &lsquo;<samp>Makefilefile</samp>&rsquo;, assuming there is a single possible

  470. completion.

  471. The default value is &lsquo;<samp>off</samp>&rsquo;.

  472. </p>

  473. </dd>

  474. <dt><code>vi-cmd-mode-string</code></dt>

  475. <dd><a name="index-vi_002dcmd_002dmode_002dstring"></a>

  476. <p>If the <var>show-mode-in-prompt</var> variable is enabled,

  477. this string is displayed immediately before the last line of the primary

  478. prompt when vi editing mode is active and in command mode.

  479. The value is expanded like a

  480. key binding, so the standard set of meta- and control prefixes and

  481. backslash escape sequences is available.

  482. Use the &lsquo;<samp>\1</samp>&rsquo; and &lsquo;<samp>\2</samp>&rsquo; escapes to begin and end sequences of

  483. non-printing characters, which can be used to embed a terminal control

  484. sequence into the mode string.

  485. The default is &lsquo;<samp>(cmd)</samp>&rsquo;.

  486. </p>

  487. </dd>

  488. <dt><code>vi-ins-mode-string</code></dt>

  489. <dd><a name="index-vi_002dins_002dmode_002dstring"></a>

  490. <p>If the <var>show-mode-in-prompt</var> variable is enabled,

  491. this string is displayed immediately before the last line of the primary

  492. prompt when vi editing mode is active and in insertion mode.

  493. The value is expanded like a

  494. key binding, so the standard set of meta- and control prefixes and

  495. backslash escape sequences is available.

  496. Use the &lsquo;<samp>\1</samp>&rsquo; and &lsquo;<samp>\2</samp>&rsquo; escapes to begin and end sequences of

  497. non-printing characters, which can be used to embed a terminal control

  498. sequence into the mode string.

  499. The default is &lsquo;<samp>(ins)</samp>&rsquo;.

  500. </p>

  501. </dd>

  502. <dt><code>visible-stats</code></dt>

  503. <dd><a name="index-visible_002dstats"></a>

  504. <p>If set to &lsquo;<samp>on</samp>&rsquo;, a character denoting a file&rsquo;s type

  505. is appended to the filename when listing possible

  506. completions.  The default is &lsquo;<samp>off</samp>&rsquo;.

  507. </p>

  508. </dd>

  509. </dl>

  510. 

  511. </dd>

  512. <dt>Key Bindings</dt>

  513. <dd><p>The syntax for controlling key bindings in the init file is

  514. simple.  First you need to find the name of the command that you

  515. want to change.  The following sections contain tables of the command

  516. name, the default keybinding, if any, and a short description of what

  517. the command does.

  518. </p>

  519. <p>Once you know the name of the command, simply place on a line

  520. in the init file the name of the key

  521. you wish to bind the command to, a colon, and then the name of the

  522. command.

  523. There can be no space between the key name and the colon &ndash; that will be

  524. interpreted as part of the key name.

  525. The name of the key can be expressed in different ways, depending on

  526. what you find most comfortable.

  527. </p>

  528. <p>In addition to command names, readline allows keys to be bound

  529. to a string that is inserted when the key is pressed (a <var>macro</var>).

  530. </p>

  531. 

  532. <dl compact="compact">

  533. <dt><var>keyname</var>:&nbsp;<var><span class="nolinebreak">function-name</span></var>&nbsp;or&nbsp;<var>macro</var><!-- /@w --></dt>

  534. <dd><p><var>keyname</var> is the name of a key spelled out in English.  For example:

  535. </p><div class="example">

  536. <pre class="example">Control-u: universal-argument

  537. Meta-Rubout: backward-kill-word

  538. Control-o: &quot;&gt; output&quot;

  539. </pre></div>

  540. 

  541. <p>In the example above, <kbd>C-u</kbd> is bound to the function

  542. <code>universal-argument</code>,

  543. <kbd>M-DEL</kbd> is bound to the function <code>backward-kill-word</code>, and

  544. <kbd>C-o</kbd> is bound to run the macro

  545. expressed on the right hand side (that is, to insert the text

  546. &lsquo;<samp>&gt; output</samp>&rsquo; into the line).

  547. </p>

  548. <p>A number of symbolic character names are recognized while

  549. processing this key binding syntax:

  550. <var>DEL</var>,

  551. <var>ESC</var>,

  552. <var>ESCAPE</var>,

  553. <var>LFD</var>,

  554. <var>NEWLINE</var>,

  555. <var>RET</var>,

  556. <var>RETURN</var>,

  557. <var>RUBOUT</var>,

  558. <var>SPACE</var>,

  559. <var>SPC</var>,

  560. and

  561. <var>TAB</var>.

  562. </p>

  563. </dd>

  564. <dt>&quot;<var>keyseq</var>&quot;:&nbsp;<var><span class="nolinebreak">function-name</span></var>&nbsp;or&nbsp;<var>macro</var><!-- /@w --></dt>

  565. <dd><p><var>keyseq</var> differs from <var>keyname</var> above in that strings

  566. denoting an entire key sequence can be specified, by placing

  567. the key sequence in double quotes.  Some <small>GNU</small> Emacs style key

  568. escapes can be used, as in the following example, but the

  569. special character names are not recognized.

  570. </p>

  571. <div class="example">

  572. <pre class="example">&quot;\C-u&quot;: universal-argument

  573. &quot;\C-x\C-r&quot;: re-read-init-file

  574. &quot;\e[11~&quot;: &quot;Function Key 1&quot;

  575. </pre></div>

  576. 

  577. <p>In the above example, <kbd>C-u</kbd> is again bound to the function

  578. <code>universal-argument</code> (just as it was in the first example),

  579. &lsquo;<samp><kbd>C-x</kbd> <kbd>C-r</kbd></samp>&rsquo; is bound to the function <code>re-read-init-file</code>,

  580. and &lsquo;<samp><span class="key">ESC</span> <span class="key">[</span> <span class="key">1</span> <span class="key">1</span> <span class="key">~</span></samp>&rsquo; is bound to insert

  581. the text &lsquo;<samp>Function Key 1</samp>&rsquo;.

  582. </p>

  583. </dd>

  584. </dl>

  585. 

  586. <p>The following <small>GNU</small> Emacs style escape sequences are available when

  587. specifying key sequences:

  588. </p>

  589. <dl compact="compact">

  590. <dt><code><kbd>\C-</kbd></code></dt>

  591. <dd><p>control prefix

  592. </p></dd>

  593. <dt><code><kbd>\M-</kbd></code></dt>

  594. <dd><p>meta prefix

  595. </p></dd>

  596. <dt><code><kbd>\e</kbd></code></dt>

  597. <dd><p>an escape character

  598. </p></dd>

  599. <dt><code><kbd>\\</kbd></code></dt>

  600. <dd><p>backslash

  601. </p></dd>

  602. <dt><code><kbd>\&quot;</kbd></code></dt>

  603. <dd><p><tt class="key">&quot;</tt>, a double quotation mark

  604. </p></dd>

  605. <dt><code><kbd>\'</kbd></code></dt>

  606. <dd><p><tt class="key">'</tt>, a single quote or apostrophe

  607. </p></dd>

  608. </dl>

  609. 

  610. <p>In addition to the <small>GNU</small> Emacs style escape sequences, a second

  611. set of backslash escapes is available:

  612. </p>

  613. <dl compact="compact">

  614. <dt><code>\a</code></dt>

  615. <dd><p>alert (bell)

  616. </p></dd>

  617. <dt><code>\b</code></dt>

  618. <dd><p>backspace

  619. </p></dd>

  620. <dt><code>\d</code></dt>

  621. <dd><p>delete

  622. </p></dd>

  623. <dt><code>\f</code></dt>

  624. <dd><p>form feed

  625. </p></dd>

  626. <dt><code>\n</code></dt>

  627. <dd><p>newline

  628. </p></dd>

  629. <dt><code>\r</code></dt>

  630. <dd><p>carriage return

  631. </p></dd>

  632. <dt><code>\t</code></dt>

  633. <dd><p>horizontal tab

  634. </p></dd>

  635. <dt><code>\v</code></dt>

  636. <dd><p>vertical tab

  637. </p></dd>

  638. <dt><code>\<var>nnn</var></code></dt>

  639. <dd><p>the eight-bit character whose value is the octal value <var>nnn</var>

  640. (one to three digits)

  641. </p></dd>

  642. <dt><code>\x<var>HH</var></code></dt>

  643. <dd><p>the eight-bit character whose value is the hexadecimal value <var>HH</var>

  644. (one or two hex digits)

  645. </p></dd>

  646. </dl>

  647. 

  648. <p>When entering the text of a macro, single or double quotes must

  649. be used to indicate a macro definition.

  650. Unquoted text is assumed to be a function name.

  651. In the macro body, the backslash escapes described above are expanded.

  652. Backslash will quote any other character in the macro text,

  653. including &lsquo;<samp>&quot;</samp>&rsquo; and &lsquo;<samp>'</samp>&rsquo;.

  654. For example, the following binding will make &lsquo;<samp><kbd>C-x</kbd> \</samp>&rsquo;

  655. insert a single &lsquo;<samp>\</samp>&rsquo; into the line:

  656. </p><div class="example">

  657. <pre class="example">&quot;\C-x\\&quot;: &quot;\\&quot;

  658. </pre></div>

  659. 

  660. </dd>

  661. </dl>

  662. 

  663. <hr>

  664. <div class="header">

  665. <p>

  666. Next: <a href="Conditional-Init-Constructs.html#Conditional-Init-Constructs" accesskey="n" rel="next">Conditional Init Constructs</a>, Up: <a href="Readline-Init-File.html#Readline-Init-File" accesskey="u" rel="up">Readline Init File</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>

  667. </div>

  668. 

  669. 

  670. 

  671. </body>

  672. </html>