{
"mode": "info",
"parameter": "rluserman",
"section": "",
"url": "https://www.chedong.com/phpMan.php/info/rluserman/json",
"generated": "2026-11-15T13:46:16Z",
"sections": {
"File: rluserman.info, Node: Top, Next: Command Line Editing, Up: (dir)": {
"content": "",
"subsections": []
},
"GNU Readline Library": {
"content": "",
"subsections": []
},
"This document describes the end user interface of the GNU Readline": {
"content": "",
"subsections": []
},
"Library, a utility which aids in the consistency of user interface": {
"content": "across discrete programs which provide a command line interface. The\nReadline home page is .\n\n* Menu:\n\n* Command Line Editing::\t GNU Readline User's Manual.\n* GNU Free Documentation License::\tLicense for copying this manual.\n",
"subsections": []
},
"File: rluserman.info, Node: Command Line Editing, Next: GNU Free Documentation License, Prev: Top, Up: Top": {
"content": "",
"subsections": []
},
"1 Command Line Editing": {
"content": "",
"subsections": []
},
"This chapter describes the basic features of the GNU command line": {
"content": "editing interface.\n\n* Menu:\n\n* Introduction and Notation::\tNotation used in this text.\n* Readline Interaction::\tThe minimum set of commands for editing a line.\n* Readline Init File::\t\tCustomizing Readline from a user's view.\n* Bindable Readline Commands::\tA description of most of the Readline commands\navailable for binding\n* Readline vi Mode::\t\tA short description of how to make Readline\nbehave like the vi editor.\n",
"subsections": []
},
"File: rluserman.info, Node: Introduction and Notation, Next: Readline Interaction, Up: Command Line Editing": {
"content": "",
"subsections": [
{
"name": "1.1 Introduction to Line Editing",
"content": ""
}
]
},
"The following paragraphs describe the notation used to represent": {
"content": "keystrokes.\n\nThe text 'C-k' is read as 'Control-K' and describes the character\nproduced when the key is pressed while the Control key is depressed.\n\nThe text 'M-k' is read as 'Meta-K' and describes the character\nproduced when the Meta key (if you have one) is depressed, and the \nkey is pressed. The Meta key is labeled on many keyboards. On\nkeyboards with two keys labeled (usually to either side of the\nspace bar), the on the left side is generally set to work as a\nMeta key. The key on the right may also be configured to work as\na Meta key or may be configured as some other modifier, such as a\nCompose key for typing accented characters.\n\nIf you do not have a Meta or key, or another key working as a\nMeta key, the identical keystroke can be generated by typing \nfirst, and then typing . Either process is known as \"metafying\"\nthe key.\n\nThe text 'M-C-k' is read as 'Meta-Control-k' and describes the\ncharacter produced by \"metafying\" 'C-k'.\n\nIn addition, several keys have their own names. Specifically, ,\n, , , , and all stand for themselves when seen\nin this text, or in an init file (*note Readline Init File::). If your\nkeyboard lacks a key, typing will produce the desired\ncharacter. The key may be labeled or on some\nkeyboards.\n",
"subsections": []
},
"File: rluserman.info, Node: Readline Interaction, Next: Readline Init File, Prev: Introduction and Notation, Up: Command Line Editing": {
"content": "",
"subsections": [
{
"name": "1.2 Readline Interaction",
"content": ""
}
]
},
"Often during an interactive session you type in a long line of text,": {
"content": "only to notice that the first word on the line is misspelled. The",
"subsections": []
},
"Readline library gives you a set of commands for manipulating the text": {
"content": "as you type it in, allowing you to just fix your typo, and not forcing\nyou to retype the majority of the line. Using these editing commands,\nyou move the cursor to the place that needs correction, and delete or\ninsert the text of the corrections. Then, when you are satisfied with\nthe line, you simply press . You do not have to be at the end of\nthe line to press ; the entire line is accepted regardless of the\nlocation of the cursor within the line.\n\n* Menu:\n\n* Readline Bare Essentials::\tThe least you need to know about Readline.\n* Readline Movement Commands::\tMoving about the input line.\n* Readline Killing Commands::\tHow to delete text, and how to get it back!\n* Readline Arguments::\t\tGiving numeric arguments to commands.\n* Searching::\t\t\tSearching through previous lines.\n",
"subsections": []
},
"File: rluserman.info, Node: Readline Bare Essentials, Next: Readline Movement Commands, Up: Readline Interaction": {
"content": "",
"subsections": []
},
"In order to enter characters into the line, simply type them. The typed": {
"content": "character appears where the cursor was, and then the cursor moves one\nspace to the right. If you mistype a character, you can use your erase\ncharacter to back up and delete the mistyped character.\n\nSometimes you may mistype a character, and not notice the error until\nyou have typed several other characters. In that case, you can type\n'C-b' to move the cursor to the left, and then correct your mistake.\nAfterwards, you can move the cursor to the right with 'C-f'.\n\nWhen you add text in the middle of a line, you will notice that\ncharacters to the right of the cursor are 'pushed over' to make room for\nthe text that you have inserted. Likewise, when you delete text behind\nthe cursor, characters to the right of the cursor are 'pulled back' to\nfill in the blank space created by the removal of the text. A list of\nthe bare essentials for editing the text of an input line follows.\n\n'C-b'\nMove back one character.\n'C-f'\nMove forward one character.\n or \nDelete the character to the left of the cursor.\n'C-d'\nDelete the character underneath the cursor.",
"subsections": []
},
"Printing characters": {
"content": "Insert the character into the line at the cursor.\n'C-' or 'C-x C-u'\nUndo the last editing command. You can undo all the way back to an\nempty line.\n\n(Depending on your configuration, the key might be set to\ndelete the character to the left of the cursor and the key set to\ndelete the character underneath the cursor, like 'C-d', rather than the\ncharacter to the left of the cursor.)\n",
"subsections": []
},
"File: rluserman.info, Node: Readline Movement Commands, Next: Readline Killing Commands, Prev: Readline Bare Essentials, Up: Readline Interaction": {
"content": "",
"subsections": []
},
"The above table describes the most basic keystrokes that you need in": {
"content": "order to do editing of the input line. For your convenience, many other\ncommands have been added in addition to 'C-b', 'C-f', 'C-d', and .\nHere are some commands for moving more rapidly about the line.\n\n'C-a'\nMove to the start of the line.\n'C-e'\nMove to the end of the line.\n'M-f'\nMove forward a word, where a word is composed of letters and\ndigits.\n'M-b'\nMove backward a word.\n'C-l'\nClear the screen, reprinting the current line at the top.\n\nNotice how 'C-f' moves forward a character, while 'M-f' moves forward\na word. It is a loose convention that control keystrokes operate on\ncharacters while meta keystrokes operate on words.\n",
"subsections": []
},
"File: rluserman.info, Node: Readline Killing Commands, Next: Readline Arguments, Prev: Readline Movement Commands, Up: Readline Interaction": {
"content": "\"Killing\" text means to delete the text from the line, but to save it\naway for later use, usually by \"yanking\" (re-inserting) it back into the\nline. ('Cut' and 'paste' are more recent jargon for 'kill' and 'yank'.)\n\nIf the description for a command says that it 'kills' text, then you\ncan be sure that you can get the text back in a different (or the same)\nplace later.\n\nWhen you use a kill command, the text is saved in a \"kill-ring\". Any\nnumber of consecutive kills save all of the killed text together, so\nthat when you yank it back, you get it all. The kill ring is not line\nspecific; the text that you killed on a previously typed line is\navailable to be yanked back later, when you are typing another line.\n\nHere is the list of commands for killing text.\n\n'C-k'\nKill the text from the current cursor position to the end of the\nline.\n\n'M-d'\nKill from the cursor to the end of the current word, or, if between\nwords, to the end of the next word. Word boundaries are the same\nas those used by 'M-f'.\n\n'M-'\nKill from the cursor to the start of the current word, or, if\nbetween words, to the start of the previous word. Word boundaries\nare the same as those used by 'M-b'.\n\n'C-w'\nKill from the cursor to the previous whitespace. This is different\nthan 'M-' because the word boundaries differ.\n\nHere is how to \"yank\" the text back into the line. Yanking means to\ncopy the most-recently-killed text from the kill buffer.\n\n'C-y'\nYank the most recently killed text back into the buffer at the\ncursor.\n\n'M-y'\nRotate the kill-ring, and yank the new top. You can only do this\nif the prior command is 'C-y' or 'M-y'.\n",
"subsections": []
},
"File: rluserman.info, Node: Readline Arguments, Next: Searching, Prev: Readline Killing Commands, Up: Readline Interaction": {
"content": "",
"subsections": []
},
"You can pass numeric arguments to Readline commands. Sometimes the": {
"content": "argument acts as a repeat count, other times it is the sign of the\nargument that is significant. If you pass a negative argument to a\ncommand which normally acts in a forward direction, that command will\nact in a backward direction. For example, to kill text back to the\nstart of the line, you might type 'M-- C-k'.\n\nThe general way to pass numeric arguments to a command is to type\nmeta digits before the command. If the first 'digit' typed is a minus\nsign ('-'), then the sign of the argument will be negative. Once you\nhave typed one meta digit to get the argument started, you can type the\nremainder of the digits, and then the command. For example, to give the\n'C-d' command an argument of 10, you could type 'M-1 0 C-d', which will\ndelete the next ten characters on the input line.\n",
"subsections": []
},
"File: rluserman.info, Node: Searching, Prev: Readline Arguments, Up: Readline Interaction": {
"content": "",
"subsections": []
},
"Readline provides commands for searching through the command history for": {
"content": "lines containing a specified string. There are two search modes:\n\"incremental\" and \"non-incremental\".\n\nIncremental searches begin before the user has finished typing the\nsearch string. As each character of the search string is typed,",
"subsections": []
},
"Readline displays the next entry from the history matching the string": {
"content": "typed so far. An incremental search requires only as many characters as\nneeded to find the desired history entry. To search backward in the\nhistory for a particular string, type 'C-r'. Typing 'C-s' searches\nforward through the history. The characters present in the value of the\n'isearch-terminators' variable are used to terminate an incremental\nsearch. If that variable has not been assigned a value, the and\n'C-J' characters will terminate an incremental search. 'C-g' will abort\nan incremental search and restore the original line. When the search is\nterminated, the history entry containing the search string becomes the\ncurrent line.\n\nTo find other matching entries in the history list, type 'C-r' or\n'C-s' as appropriate. This will search backward or forward in the\nhistory for the next entry matching the search string typed so far. Any\nother key sequence bound to a Readline command will terminate the search\nand execute that command. For instance, a will terminate the\nsearch and accept the line, thereby executing the command from the\nhistory list. A movement command will terminate the search, make the\nlast line found the current line, and begin editing.\n\nReadline remembers the last incremental search string. If two 'C-r's\nare typed without any intervening characters defining a new search\nstring, any remembered search string is used.\n\nNon-incremental searches read the entire search string before\nstarting to search for matching history lines. The search string may be\ntyped by the user or be part of the contents of the current line.\n",
"subsections": []
},
"File: rluserman.info, Node: Readline Init File, Next: Bindable Readline Commands, Prev: Readline Interaction, Up: Command Line Editing": {
"content": "",
"subsections": [
{
"name": "1.3 Readline Init File",
"content": ""
}
]
},
"Although the Readline library comes with a set of Emacs-like keybindings": {
"content": "installed by default, it is possible to use a different set of\nkeybindings. Any user can customize programs that use Readline by\nputting commands in an \"inputrc\" file, conventionally in their home\ndirectory. The name of this file is taken from the value of the\nenvironment variable 'INPUTRC'. If that variable is unset, the default\nis '~/.inputrc'. If that file does not exist or cannot be read, the\nultimate default is '/etc/inputrc'.\n\nWhen a program which uses the Readline library starts up, the init\nfile is read, and the key bindings are set.\n\nIn addition, the 'C-x C-r' command re-reads this init file, thus\nincorporating any changes that you might have made to it.\n\n* Menu:\n\n* Readline Init File Syntax::\tSyntax for the commands in the inputrc file.\n\n* Conditional Init Constructs::\tConditional key bindings in the inputrc file.\n\n* Sample Init File::\t\tAn example inputrc file.\n",
"subsections": []
},
"File: rluserman.info, Node: Readline Init File Syntax, Next: Conditional Init Constructs, Up: Readline Init File": {
"content": "There are only a few basic constructs allowed in the Readline init file.\nBlank lines are ignored. Lines beginning with a '#' are comments.\nLines beginning with a '$' indicate conditional constructs (*note",
"subsections": []
},
"Conditional Init Constructs::). Other lines denote variable settings": {
"content": "and key bindings.\n",
"subsections": []
},
"Variable Settings": {
"content": "You can modify the run-time behavior of Readline by altering the\nvalues of variables in Readline using the 'set' command within the\ninit file. The syntax is simple:\n\nset VARIABLE VALUE\n\nHere, for example, is how to change from the default Emacs-like key\nbinding to use 'vi' line editing commands:\n\nset editing-mode vi\n\nVariable names and values, where appropriate, are recognized\nwithout regard to case. Unrecognized variable names are ignored.\n\nBoolean variables (those that can be set to on or off) are set to\non if the value is null or empty, ON (case-insensitive), or 1. Any\nother value results in the variable being set to off.\n\nA great deal of run-time behavior is changeable with the following\nvariables.\n\n'active-region-start-color'\nA string variable that controls the text color and background\nwhen displaying the text in the active region (see the\ndescription of 'enable-active-region' below). This string\nmust not take up any physical character positions on the\ndisplay, so it should consist only of terminal escape\nsequences. It is output to the terminal before displaying the\ntext in the active region. This variable is reset to the\ndefault value whenever the terminal type changes. The default\nvalue is the string that puts the terminal in standout mode,\nas obtained from the terminal's terminfo description. A\nsample value might be '\\e[01;33m'.\n\n'active-region-end-color'\nA string variable that \"undoes\" the effects of\n'active-region-start-color' and restores \"normal\" terminal\ndisplay appearance after displaying text in the active region.\nThis string must not take up any physical character positions\non the display, so it should consist only of terminal escape\nsequences. It is output to the terminal after displaying the\ntext in the active region. This variable is reset to the\ndefault value whenever the terminal type changes. The default\nvalue is the string that restores the terminal from standout\nmode, as obtained from the terminal's terminfo description. A\nsample value might be '\\e[0m'.\n\n'bell-style'\nControls what happens when Readline wants to ring the terminal\nbell. If set to 'none', Readline never rings the bell. If\nset to 'visible', Readline uses a visible bell if one is\navailable. If set to 'audible' (the default), Readline\nattempts to ring the terminal's bell.\n\n'bind-tty-special-chars'\nIf set to 'on' (the default), Readline attempts to bind the\ncontrol characters treated specially by the kernel's terminal\ndriver to their Readline equivalents.\n\n'blink-matching-paren'\nIf set to 'on', Readline attempts to briefly move the cursor\nto an opening parenthesis when a closing parenthesis is\ninserted. The default is 'off'.\n\n'colored-completion-prefix'\nIf set to 'on', when listing completions, Readline displays\nthe common prefix of the set of possible completions using a\ndifferent color. The color definitions are taken from the\nvalue of the 'LSCOLORS' environment variable. If there is a\ncolor definition in 'LSCOLORS' for the custom suffix\n'readline-colored-completion-prefix', Readline uses this color\nfor the common prefix instead of its default. The default is\n'off'.\n\n'colored-stats'\nIf set to 'on', Readline displays possible completions using\ndifferent colors to indicate their file type. The color\ndefinitions are taken from the value of the 'LSCOLORS'\nenvironment variable. The default is 'off'.\n\n'comment-begin'\nThe string to insert at the beginning of the line when the\n'insert-comment' command is executed. The default value is\n'\"#\"'.\n\n'completion-display-width'\nThe number of screen columns used to display possible matches\nwhen performing completion. The value is ignored if it is\nless than 0 or greater than the terminal screen width. A\nvalue of 0 will cause matches to be displayed one per line.\nThe default value is -1.\n\n'completion-ignore-case'\nIf set to 'on', Readline performs filename matching and\ncompletion in a case-insensitive fashion. The default value\nis 'off'.\n\n'completion-map-case'\nIf set to 'on', and COMPLETION-IGNORE-CASE is enabled,\nReadline treats hyphens ('-') and underscores ('') as\nequivalent when performing case-insensitive filename matching\nand completion. The default value is 'off'.\n\n'completion-prefix-display-length'\nThe length in characters of the common prefix of a list of\npossible completions that is displayed without modification.\nWhen set to a value greater than zero, common prefixes longer\nthan this value are replaced with an ellipsis when displaying\npossible completions.\n\n'completion-query-items'\nThe number of possible completions that determines when the\nuser is asked whether the list of possibilities should be\ndisplayed. If the number of possible completions is greater\nthan or equal to this value, Readline will ask whether or not\nthe user wishes to view them; otherwise, they are simply\nlisted. This variable must be set to an integer value greater\nthan or equal to zero. A zero value means Readline should\nnever ask; negative values are treated as zero. The default\nlimit is '100'.\n\n'convert-meta'\nIf set to 'on', Readline will convert characters with the\neighth bit set to an ASCII key sequence by stripping the\neighth bit and prefixing an character, converting them\nto a meta-prefixed key sequence. The default value is 'on',\nbut will be set to 'off' if the locale is one that contains\neight-bit characters. This variable is dependent on the\n'LCCTYPE' locale category, and may change if the locale is\nchanged.\n\n'disable-completion'\nIf set to 'On', Readline will inhibit word completion.\nCompletion characters will be inserted into the line as if\nthey had been mapped to 'self-insert'. The default is 'off'.\n\n'echo-control-characters'\nWhen set to 'on', on operating systems that indicate they\nsupport it, Readline echoes a character corresponding to a\nsignal generated from the keyboard. The default is 'on'.\n\n'editing-mode'\nThe 'editing-mode' variable controls which default set of key\nbindings is used. By default, Readline starts up in Emacs\nediting mode, where the keystrokes are most similar to Emacs.\nThis variable can be set to either 'emacs' or 'vi'.\n\n'emacs-mode-string'\nIf the SHOW-MODE-IN-PROMPT variable is enabled, this string is\ndisplayed immediately before the last line of the primary\nprompt when emacs editing mode is active. The value is\nexpanded like a key binding, so the standard set of meta- and\ncontrol prefixes and backslash escape sequences is available.\nUse the '\\1' and '\\2' escapes to begin and end sequences of\nnon-printing characters, which can be used to embed a terminal\ncontrol sequence into the mode string. The default is '@'.\n\n'enable-active-region'\nThe \"point\" is the current cursor position, and \"mark\" refers\nto a saved cursor position (*note Commands For Moving::). The\ntext between the point and mark is referred to as the\n\"region\". When this variable is set to 'On', Readline allows\ncertain commands to designate the region as \"active\". When\nthe region is active, Readline highlights the text in the\nregion using the value of the 'active-region-start-color',\nwhich defaults to the string that enables the terminal's\nstandout mode. The active region shows the text inserted by\nbracketed-paste and any matching text found by incremental and\nnon-incremental history searches. The default is 'On'.\n\n'enable-bracketed-paste'\nWhen set to 'On', Readline configures the terminal to insert\neach paste into the editing buffer as a single string of\ncharacters, instead of treating each character as if it had\nbeen read from the keyboard. This is called putting the\nterminal into \"bracketed paste mode\"; it prevents Readline\nfrom executing any editing commands bound to key sequences\nappearing in the pasted text. The default is 'On'.\n\n'enable-keypad'\nWhen set to 'on', Readline will try to enable the application\nkeypad when it is called. Some systems need this to enable\nthe arrow keys. The default is 'off'.\n\n'enable-meta-key'\nWhen set to 'on', Readline will try to enable any meta\nmodifier key the terminal claims to support when it is called.\nOn many terminals, the meta key is used to send eight-bit\ncharacters. The default is 'on'.\n\n'expand-tilde'\nIf set to 'on', tilde expansion is performed when Readline\nattempts word completion. The default is 'off'.\n\n'history-preserve-point'\nIf set to 'on', the history code attempts to place the point\n(the current cursor position) at the same location on each\nhistory line retrieved with 'previous-history' or\n'next-history'. The default is 'off'.\n\n'history-size'\nSet the maximum number of history entries saved in the history\nlist. If set to zero, any existing history entries are\ndeleted and no new entries are saved. If set to a value less\nthan zero, the number of history entries is not limited. By\ndefault, the number of history entries is not limited. If an\nattempt is made to set HISTORY-SIZE to a non-numeric value,\nthe maximum number of history entries will be set to 500.\n\n'horizontal-scroll-mode'\nThis variable can be set to either 'on' or 'off'. Setting it\nto 'on' means that the text of the lines being edited will\nscroll horizontally on a single screen line when they are\nlonger than the width of the screen, instead of wrapping onto\na new screen line. This variable is automatically set to 'on'\nfor terminals of height 1. By default, this variable is set\nto 'off'.\n\n'input-meta'\nIf set to 'on', Readline will enable eight-bit input (it will\nnot clear the eighth bit in the characters it reads),\nregardless of what the terminal claims it can support. The\ndefault value is 'off', but Readline will set it to 'on' if\nthe locale contains eight-bit characters. The name\n'meta-flag' is a synonym for this variable. This variable is\ndependent on the 'LCCTYPE' locale category, and may change if\nthe locale is changed.\n\n'isearch-terminators'\nThe string of characters that should terminate an incremental\nsearch without subsequently executing the character as a\ncommand (*note Searching::). If this variable has not been\ngiven a value, the characters and 'C-J' will terminate\nan incremental search.\n\n'keymap'\nSets Readline's idea of the current keymap for key binding\ncommands. Built-in 'keymap' names are 'emacs',\n'emacs-standard', 'emacs-meta', 'emacs-ctlx', 'vi', 'vi-move',\n'vi-command', and 'vi-insert'. 'vi' is equivalent to\n'vi-command' ('vi-move' is also a synonym); 'emacs' is\nequivalent to 'emacs-standard'. Applications may add\nadditional names. The default value is 'emacs'. The value of\nthe 'editing-mode' variable also affects the default keymap.\n\n'keyseq-timeout'\nSpecifies the duration Readline will wait for a character when\nreading an ambiguous key sequence (one that can form a\ncomplete key sequence using the input read so far, or can take\nadditional input to complete a longer key sequence). If no\ninput is received within the timeout, Readline will use the\nshorter but complete key sequence. Readline uses this value\nto determine whether or not input is available on the current\ninput source ('rlinstream' by default). The value is\nspecified in milliseconds, so a value of 1000 means that\nReadline will wait one second for additional input. If this\nvariable is set to a value less than or equal to zero, or to a\nnon-numeric value, Readline will wait until another key is\npressed to decide which key sequence to complete. The default\nvalue is '500'.\n\n'mark-directories'\nIf set to 'on', completed directory names have a slash\nappended. The default is 'on'.\n\n'mark-modified-lines'\nThis variable, when set to 'on', causes Readline to display an\nasterisk ('*') at the start of history lines which have been\nmodified. This variable is 'off' by default.\n\n'mark-symlinked-directories'\nIf set to 'on', completed names which are symbolic links to\ndirectories have a slash appended (subject to the value of\n'mark-directories'). The default is 'off'.\n\n'match-hidden-files'\nThis variable, when set to 'on', causes Readline to match\nfiles whose names begin with a '.' (hidden files) when\nperforming filename completion. If set to 'off', the leading\n'.' must be supplied by the user in the filename to be\ncompleted. This variable is 'on' by default.\n\n'menu-complete-display-prefix'\nIf set to 'on', menu completion displays the common prefix of\nthe list of possible completions (which may be empty) before\ncycling through the list. The default is 'off'.\n\n'output-meta'\nIf set to 'on', Readline will display characters with the\neighth bit set directly rather than as a meta-prefixed escape\nsequence. The default is 'off', but Readline will set it to\n'on' if the locale contains eight-bit characters. This\nvariable is dependent on the 'LCCTYPE' locale category, and\nmay change if the locale is changed.\n\n'page-completions'\nIf set to 'on', Readline uses an internal 'more'-like pager to\ndisplay a screenful of possible completions at a time. This\nvariable is 'on' by default.\n\n'print-completions-horizontally'\nIf set to 'on', Readline will display completions with matches\nsorted horizontally in alphabetical order, rather than down\nthe screen. The default is 'off'.\n\n'revert-all-at-newline'\nIf set to 'on', Readline will undo all changes to history\nlines before returning when 'accept-line' is executed. By\ndefault, history lines may be modified and retain individual\nundo lists across calls to 'readline()'. The default is\n'off'.\n\n'show-all-if-ambiguous'\nThis alters the default behavior of the completion functions.\nIf set to 'on', words which have more than one possible\ncompletion cause the matches to be listed immediately instead\nof ringing the bell. The default value is 'off'.\n\n'show-all-if-unmodified'\nThis alters the default behavior of the completion functions\nin a fashion similar to SHOW-ALL-IF-AMBIGUOUS. If set to\n'on', words which have more than one possible completion\nwithout any possible partial completion (the possible\ncompletions don't share a common prefix) cause the matches to\nbe listed immediately instead of ringing the bell. The\ndefault value is 'off'.\n\n'show-mode-in-prompt'\nIf set to 'on', add a string to the beginning of the prompt\nindicating the editing mode: emacs, vi command, or vi\ninsertion. The mode strings are user-settable (e.g.,\nEMACS-MODE-STRING). The default value is 'off'.\n\n'skip-completed-text'\nIf set to 'on', this alters the default completion behavior\nwhen inserting a single match into the line. It's only active\nwhen performing completion in the middle of a word. If\nenabled, Readline does not insert characters from the\ncompletion that match characters after point in the word being\ncompleted, so portions of the word following the cursor are\nnot duplicated. For instance, if this is enabled, attempting\ncompletion when the cursor is after the 'e' in 'Makefile' will\nresult in 'Makefile' rather than 'Makefilefile', assuming\nthere is a single possible completion. The default value is\n'off'.\n\n'vi-cmd-mode-string'\nIf the SHOW-MODE-IN-PROMPT variable is enabled, this string is\ndisplayed immediately before the last line of the primary\nprompt when vi editing mode is active and in command mode.\nThe value is expanded like a key binding, so the standard set\nof meta- and control prefixes and backslash escape sequences\nis available. Use the '\\1' and '\\2' escapes to begin and end\nsequences of non-printing characters, which can be used to\nembed a terminal control sequence into the mode string. The\ndefault is '(cmd)'.\n\n'vi-ins-mode-string'\nIf the SHOW-MODE-IN-PROMPT variable is enabled, this string is\ndisplayed immediately before the last line of the primary\nprompt when vi editing mode is active and in insertion mode.\nThe value is expanded like a key binding, so the standard set\nof meta- and control prefixes and backslash escape sequences\nis available. Use the '\\1' and '\\2' escapes to begin and end\nsequences of non-printing characters, which can be used to\nembed a terminal control sequence into the mode string. The\ndefault is '(ins)'.\n\n'visible-stats'\nIf set to 'on', a character denoting a file's type is appended\nto the filename when listing possible completions. The\ndefault is 'off'.\n",
"subsections": []
},
"Key Bindings": {
"content": "The syntax for controlling key bindings in the init file is simple.\nFirst you need to find the name of the command that you want to\nchange. The following sections contain tables of the command name,\nthe default keybinding, if any, and a short description of what the\ncommand does.\n\nOnce you know the name of the command, simply place on a line in\nthe init file the name of the key you wish to bind the command to,\na colon, and then the name of the command. There can be no space\nbetween the key name and the colon - that will be interpreted as\npart of the key name. The name of the key can be expressed in\ndifferent ways, depending on what you find most comfortable.\n\nIn addition to command names, Readline allows keys to be bound to a\nstring that is inserted when the key is pressed (a MACRO).\n\nKEYNAME: FUNCTION-NAME or MACRO\nKEYNAME is the name of a key spelled out in English. For\nexample:\nControl-u: universal-argument\nMeta-Rubout: backward-kill-word\nControl-o: \"> output\"\n\nIn the example above, 'C-u' is bound to the function\n'universal-argument', 'M-DEL' is bound to the function\n'backward-kill-word', and 'C-o' is bound to run the macro\nexpressed on the right hand side (that is, to insert the text\n'> output' into the line).\n\nA number of symbolic character names are recognized while\nprocessing this key binding syntax: DEL, ESC, ESCAPE, LFD,\nNEWLINE, RET, RETURN, RUBOUT, SPACE, SPC, and TAB.\n\n\"KEYSEQ\": FUNCTION-NAME or MACRO\nKEYSEQ differs from KEYNAME above in that strings denoting an\nentire key sequence can be specified, by placing the key\nsequence in double quotes. Some GNU Emacs style key escapes\ncan be used, as in the following example, but the special\ncharacter names are not recognized.\n\n\"\\C-u\": universal-argument\n\"\\C-x\\C-r\": re-read-init-file\n\"\\e[11~\": \"Function Key 1\"\n\nIn the above example, 'C-u' is again bound to the function\n'universal-argument' (just as it was in the first example),\n''C-x' 'C-r'' is bound to the function 're-read-init-file',\nand ' <[> <1> <1> <~>' is bound to insert the text\n'Function Key 1'.\n\nThe following GNU Emacs style escape sequences are available when\nspecifying key sequences:\n\n'\\C-'\ncontrol prefix\n'\\M-'\nmeta prefix\n'\\e'\nan escape character\n'\\\\'\nbackslash\n'\\\"'\n<\">, a double quotation mark\n'\\''\n<'>, a single quote or apostrophe\n\nIn addition to the GNU Emacs style escape sequences, a second set\nof backslash escapes is available:\n\n'\\a'\nalert (bell)\n'\\b'\nbackspace\n'\\d'\ndelete\n'\\f'\nform feed\n'\\n'\nnewline\n'\\r'\ncarriage return\n'\\t'\nhorizontal tab\n'\\v'\nvertical tab\n'\\NNN'\nthe eight-bit character whose value is the octal value NNN\n(one to three digits)\n'\\xHH'\nthe eight-bit character whose value is the hexadecimal value\nHH (one or two hex digits)\n\nWhen entering the text of a macro, single or double quotes must be\nused to indicate a macro definition. Unquoted text is assumed to\nbe a function name. In the macro body, the backslash escapes\ndescribed above are expanded. Backslash will quote any other\ncharacter in the macro text, including '\"' and '''. For example,\nthe following binding will make ''C-x' \\' insert a single '\\' into\nthe line:\n\"\\C-x\\\\\": \"\\\\\"\n",
"subsections": []
},
"File: rluserman.info, Node: Conditional Init Constructs, Next: Sample Init File, Prev: Readline Init File Syntax, Up: Readline Init File": {
"content": "",
"subsections": []
},
"Readline implements a facility similar in spirit to the conditional": {
"content": "compilation features of the C preprocessor which allows key bindings and\nvariable settings to be performed as the result of tests. There are\nfour parser directives used.\n\n'$if'\nThe '$if' construct allows bindings to be made based on the editing\nmode, the terminal being used, or the application using Readline.\nThe text of the test, after any comparison operator, extends to the\nend of the line; unless otherwise noted, no characters are required\nto isolate it.\n\n'mode'\nThe 'mode=' form of the '$if' directive is used to test\nwhether Readline is in 'emacs' or 'vi' mode. This may be used\nin conjunction with the 'set keymap' command, for instance, to\nset bindings in the 'emacs-standard' and 'emacs-ctlx' keymaps\nonly if Readline is starting out in 'emacs' mode.\n\n'term'\nThe 'term=' form may be used to include terminal-specific key\nbindings, perhaps to bind the key sequences output by the\nterminal's function keys. The word on the right side of the\n'=' is tested against both the full name of the terminal and\nthe portion of the terminal name before the first '-'. This\nallows 'sun' to match both 'sun' and 'sun-cmd', for instance.\n\n'version'\nThe 'version' test may be used to perform comparisons against\nspecific Readline versions. The 'version' expands to the\ncurrent Readline version. The set of comparison operators\nincludes '=' (and '=='), '!=', '<=', '>=', '<', and '>'. The\nversion number supplied on the right side of the operator\nconsists of a major version number, an optional decimal point,\nand an optional minor version (e.g., '7.1'). If the minor\nversion is omitted, it is assumed to be '0'. The operator may\nbe separated from the string 'version' and from the version\nnumber argument by whitespace. The following example sets a\nvariable if the Readline version being used is 7.0 or newer:\n$if version >= 7.0\nset show-mode-in-prompt on\n$endif\n\n'application'\nThe APPLICATION construct is used to include\napplication-specific settings. Each program using the\nReadline library sets the APPLICATION NAME, and you can test\nfor a particular value. This could be used to bind key\nsequences to functions useful for a specific program. For\ninstance, the following command adds a key sequence that\nquotes the current or previous word in Bash:\n$if Bash\n# Quote the current or previous word\n\"\\C-xq\": \"\\eb\\\"\\ef\\\"\"\n$endif\n\n'variable'\nThe VARIABLE construct provides simple equality tests for\nReadline variables and values. The permitted comparison\noperators are '=', '==', and '!='. The variable name must be\nseparated from the comparison operator by whitespace; the\noperator may be separated from the value on the right hand\nside by whitespace. Both string and boolean variables may be\ntested. Boolean variables must be tested against the values\nON and OFF. The following example is equivalent to the\n'mode=emacs' test described above:\n$if editing-mode == emacs\nset show-mode-in-prompt on\n$endif\n\n'$endif'\nThis command, as seen in the previous example, terminates an '$if'\ncommand.\n\n'$else'\nCommands in this branch of the '$if' directive are executed if the\ntest fails.\n\n'$include'\nThis directive takes a single filename as an argument and reads\ncommands and bindings from that file. For example, the following\ndirective reads from '/etc/inputrc':\n$include /etc/inputrc\n",
"subsections": []
},
"File: rluserman.info, Node: Sample Init File, Prev: Conditional Init Constructs, Up: Readline Init File": {
"content": "",
"subsections": []
},
"Here is an example of an INPUTRC file. This illustrates key binding,": {
"content": "variable assignment, and conditional syntax.\n\n# This file controls the behaviour of line input editing for\n# programs that use the GNU Readline library. Existing\n# programs include FTP, Bash, and GDB.\n#\n# You can re-read the inputrc file with C-x C-r.\n# Lines beginning with '#' are comments.\n#\n# First, include any system-wide bindings and variable\n# assignments from /etc/Inputrc\n$include /etc/Inputrc\n\n#\n# Set various bindings for emacs mode.\n\nset editing-mode emacs\n\n$if mode=emacs\n\nMeta-Control-h:\tbackward-kill-word\tText after the function name is ignored\n\n#\n# Arrow keys in keypad mode\n#\n#\"\\M-OD\": backward-char\n#\"\\M-OC\": forward-char\n#\"\\M-OA\": previous-history\n#\"\\M-OB\": next-history\n#\n# Arrow keys in ANSI mode\n#\n\"\\M-[D\": backward-char\n\"\\M-[C\": forward-char\n\"\\M-[A\": previous-history\n\"\\M-[B\": next-history\n#\n# Arrow keys in 8 bit keypad mode\n#\n#\"\\M-\\C-OD\": backward-char\n#\"\\M-\\C-OC\": forward-char\n#\"\\M-\\C-OA\": previous-history\n#\"\\M-\\C-OB\": next-history\n#\n# Arrow keys in 8 bit ANSI mode\n#\n#\"\\M-\\C-[D\": backward-char\n#\"\\M-\\C-[C\": forward-char\n#\"\\M-\\C-[A\": previous-history\n#\"\\M-\\C-[B\": next-history\n\nC-q: quoted-insert\n\n$endif\n\n# An old-style binding. This happens to be the default.\nTAB: complete\n\n# Macros that are convenient for shell interaction\n$if Bash\n# edit the path\n\"\\C-xp\": \"PATH=${PATH}\\e\\C-e\\C-a\\ef\\C-f\"\n# prepare to type a quoted word --\n# insert open and close double quotes\n# and move to just after the open quote\n\"\\C-x\\\"\": \"\\\"\\\"\\C-b\"\n# insert a backslash (testing backslash escapes\n# in sequences and macros)\n\"\\C-x\\\\\": \"\\\\\"\n# Quote the current or previous word\n\"\\C-xq\": \"\\eb\\\"\\ef\\\"\"\n# Add a binding to refresh the line, which is unbound\n\"\\C-xr\": redraw-current-line\n# Edit variable on current line.\n\"\\M-\\C-v\": \"\\C-a\\C-k$\\C-y\\M-\\C-e\\C-a\\C-y=\"\n$endif\n\n# use a visible bell if one is available\nset bell-style visible\n\n# don't strip characters to 7 bits when reading\nset input-meta on\n\n# allow iso-latin1 characters to be inserted rather\n# than converted to prefix-meta sequences\nset convert-meta off\n\n# display characters with the eighth bit set directly\n# rather than as meta-prefixed characters\nset output-meta on\n\n# if there are 150 or more possible completions for a word,\n# ask whether or not the user wants to see all of them\nset completion-query-items 150\n\n# For FTP\n$if Ftp\n\"\\C-xg\": \"get \\M-?\"\n\"\\C-xt\": \"put \\M-?\"\n\"\\M-.\": yank-last-arg\n$endif\n",
"subsections": []
},
"File: rluserman.info, Node: Bindable Readline Commands, Next: Readline vi Mode, Prev: Readline Init File, Up: Command Line Editing": {
"content": "",
"subsections": [
{
"name": "1.4 Bindable Readline Commands",
"content": "* Menu:\n\n* Commands For Moving::\t\tMoving about the line.\n* Commands For History::\tGetting at previous lines.\n* Commands For Text::\t\tCommands for changing text.\n* Commands For Killing::\tCommands for killing and yanking.\n* Numeric Arguments::\t\tSpecifying numeric arguments, repeat counts.\n* Commands For Completion::\tGetting Readline to do the typing for you.\n* Keyboard Macros::\t\tSaving and re-executing typed characters\n* Miscellaneous Commands::\tOther miscellaneous commands.\n"
}
]
},
"This section describes Readline commands that may be bound to key": {
"content": "sequences. Command names without an accompanying key sequence are\nunbound by default.\n\nIn the following descriptions, \"point\" refers to the current cursor\nposition, and \"mark\" refers to a cursor position saved by the 'set-mark'\ncommand. The text between the point and mark is referred to as the\n\"region\".\n",
"subsections": []
},
"File: rluserman.info, Node: Commands For Moving, Next: Commands For History, Up: Bindable Readline Commands": {
"content": "'beginning-of-line (C-a)'\nMove to the start of the current line.\n\n'end-of-line (C-e)'\nMove to the end of the line.\n\n'forward-char (C-f)'\nMove forward a character.\n\n'backward-char (C-b)'\nMove back a character.\n\n'forward-word (M-f)'\nMove forward to the end of the next word. Words are composed of\nletters and digits.\n\n'backward-word (M-b)'\nMove back to the start of the current or previous word. Words are\ncomposed of letters and digits.\n\n'previous-screen-line ()'\nAttempt to move point to the same physical screen column on the\nprevious physical screen line. This will not have the desired\neffect if the current Readline line does not take up more than one\nphysical line or if point is not greater than the length of the\nprompt plus the screen width.\n\n'next-screen-line ()'\nAttempt to move point to the same physical screen column on the\nnext physical screen line. This will not have the desired effect\nif the current Readline line does not take up more than one\nphysical line or if the length of the current Readline line is not\ngreater than the length of the prompt plus the screen width.\n\n'clear-display (M-C-l)'\nClear the screen and, if possible, the terminal's scrollback\nbuffer, then redraw the current line, leaving the current line at\nthe top of the screen.\n\n'clear-screen (C-l)'\nClear the screen, then redraw the current line, leaving the current\nline at the top of the screen.\n\n'redraw-current-line ()'\nRefresh the current line. By default, this is unbound.\n",
"subsections": []
},
"File: rluserman.info, Node: Commands For History, Next: Commands For Text, Prev: Commands For Moving, Up: Bindable Readline Commands": {
"content": "'accept-line (Newline or Return)'\nAccept the line regardless of where the cursor is. If this line is\nnon-empty, it may be added to the history list for future recall\nwith 'addhistory()'. If this line is a modified history line, the\nhistory line is restored to its original state.\n\n'previous-history (C-p)'\nMove 'back' through the history list, fetching the previous\ncommand.\n\n'next-history (C-n)'\nMove 'forward' through the history list, fetching the next command.\n\n'beginning-of-history (M-<)'\nMove to the first line in the history.\n\n'end-of-history (M->)'\nMove to the end of the input history, i.e., the line currently\nbeing entered.\n\n'reverse-search-history (C-r)'\nSearch backward starting at the current line and moving 'up'\nthrough the history as necessary. This is an incremental search.\nThis command sets the region to the matched text and activates the\nmark.\n\n'forward-search-history (C-s)'\nSearch forward starting at the current line and moving 'down'\nthrough the history as necessary. This is an incremental search.\nThis command sets the region to the matched text and activates the\nmark.\n\n'non-incremental-reverse-search-history (M-p)'\nSearch backward starting at the current line and moving 'up'\nthrough the history as necessary using a non-incremental search for\na string supplied by the user. The search string may match\nanywhere in a history line.\n\n'non-incremental-forward-search-history (M-n)'\nSearch forward starting at the current line and moving 'down'\nthrough the history as necessary using a non-incremental search for\na string supplied by the user. The search string may match\nanywhere in a history line.\n\n'history-search-forward ()'\nSearch forward through the history for the string of characters\nbetween the start of the current line and the point. The search\nstring must match at the beginning of a history line. This is a\nnon-incremental search. By default, this command is unbound.\n\n'history-search-backward ()'\nSearch backward through the history for the string of characters\nbetween the start of the current line and the point. The search\nstring must match at the beginning of a history line. This is a\nnon-incremental search. By default, this command is unbound.\n\n'history-substring-search-forward ()'\nSearch forward through the history for the string of characters\nbetween the start of the current line and the point. The search\nstring may match anywhere in a history line. This is a\nnon-incremental search. By default, this command is unbound.\n\n'history-substring-search-backward ()'\nSearch backward through the history for the string of characters\nbetween the start of the current line and the point. The search\nstring may match anywhere in a history line. This is a\nnon-incremental search. By default, this command is unbound.\n\n'yank-nth-arg (M-C-y)'\nInsert the first argument to the previous command (usually the\nsecond word on the previous line) at point. With an argument N,\ninsert the Nth word from the previous command (the words in the\nprevious command begin with word 0). A negative argument inserts\nthe Nth word from the end of the previous command. Once the\nargument N is computed, the argument is extracted as if the '!N'\nhistory expansion had been specified.\n\n'yank-last-arg (M-. or M-)'\nInsert last argument to the previous command (the last word of the\nprevious history entry). With a numeric argument, behave exactly\nlike 'yank-nth-arg'. Successive calls to 'yank-last-arg' move back\nthrough the history list, inserting the last word (or the word\nspecified by the argument to the first call) of each line in turn.\nAny numeric argument supplied to these successive calls determines\nthe direction to move through the history. A negative argument\nswitches the direction through the history (back or forward). The\nhistory expansion facilities are used to extract the last argument,\nas if the '!$' history expansion had been specified.\n\n'operate-and-get-next (C-o)'\nAccept the current line for return to the calling application as if\na newline had been entered, and fetch the next line relative to the\ncurrent line from the history for editing. A numeric argument, if\nsupplied, specifies the history entry to use instead of the current\nline.\n\n'fetch-history ()'\nWith a numeric argument, fetch that entry from the history list and\nmake it the current line. Without an argument, move back to the\nfirst entry in the history list.\n",
"subsections": []
},
"File: rluserman.info, Node: Commands For Text, Next: Commands For Killing, Prev: Commands For History, Up: Bindable Readline Commands": {
"content": "'end-of-file (usually C-d)'\nThe character indicating end-of-file as set, for example, by\n'stty'. If this character is read when there are no characters on\nthe line, and point is at the beginning of the line, Readline\ninterprets it as the end of input and returns EOF.\n\n'delete-char (C-d)'\nDelete the character at point. If this function is bound to the\nsame character as the tty EOF character, as 'C-d' commonly is, see\nabove for the effects.\n\n'backward-delete-char (Rubout)'\nDelete the character behind the cursor. A numeric argument means\nto kill the characters instead of deleting them.\n\n'forward-backward-delete-char ()'\nDelete the character under the cursor, unless the cursor is at the\nend of the line, in which case the character behind the cursor is\ndeleted. By default, this is not bound to a key.\n\n'quoted-insert (C-q or C-v)'\nAdd the next character typed to the line verbatim. This is how to\ninsert key sequences like 'C-q', for example.\n\n'tab-insert (M-)'\nInsert a tab character.\n\n'self-insert (a, b, A, 1, !, ...)'\nInsert yourself.\n\n'bracketed-paste-begin ()'\nThis function is intended to be bound to the \"bracketed paste\"\nescape sequence sent by some terminals, and such a binding is\nassigned by default. It allows Readline to insert the pasted text\nas a single unit without treating each character as if it had been\nread from the keyboard. The characters are inserted as if each one\nwas bound to 'self-insert' instead of executing any editing\ncommands.\n\nBracketed paste sets the region (the characters between point and\nthe mark) to the inserted text. It uses the concept of an active\nmark: when the mark is active, Readline redisplay uses the\nterminal's standout mode to denote the region.\n\n'transpose-chars (C-t)'\nDrag the character before the cursor forward over the character at\nthe cursor, moving the cursor forward as well. If the insertion\npoint is at the end of the line, then this transposes the last two\ncharacters of the line. Negative arguments have no effect.\n\n'transpose-words (M-t)'\nDrag the word before point past the word after point, moving point\npast that word as well. If the insertion point is at the end of\nthe line, this transposes the last two words on the line.\n\n'upcase-word (M-u)'\nUppercase the current (or following) word. With a negative\nargument, uppercase the previous word, but do not move the cursor.\n\n'downcase-word (M-l)'\nLowercase the current (or following) word. With a negative\nargument, lowercase the previous word, but do not move the cursor.\n\n'capitalize-word (M-c)'\nCapitalize the current (or following) word. With a negative\nargument, capitalize the previous word, but do not move the cursor.\n\n'overwrite-mode ()'\nToggle overwrite mode. With an explicit positive numeric argument,\nswitches to overwrite mode. With an explicit non-positive numeric\nargument, switches to insert mode. This command affects only\n'emacs' mode; 'vi' mode does overwrite differently. Each call to\n'readline()' starts in insert mode.\n\nIn overwrite mode, characters bound to 'self-insert' replace the\ntext at point rather than pushing the text to the right.\nCharacters bound to 'backward-delete-char' replace the character\nbefore point with a space.\n\nBy default, this command is unbound.\n",
"subsections": []
},
"File: rluserman.info, Node: Commands For Killing, Next: Numeric Arguments, Prev: Commands For Text, Up: Bindable Readline Commands": {
"content": "'kill-line (C-k)'\nKill the text from point to the end of the line. With a negative\nnumeric argument, kill backward from the cursor to the beginning of\nthe current line.\n\n'backward-kill-line (C-x Rubout)'\nKill backward from the cursor to the beginning of the current line.\nWith a negative numeric argument, kill forward from the cursor to\nthe end of the current line.\n\n'unix-line-discard (C-u)'\nKill backward from the cursor to the beginning of the current line.\n\n'kill-whole-line ()'\nKill all characters on the current line, no matter where point is.\nBy default, this is unbound.\n\n'kill-word (M-d)'\nKill from point to the end of the current word, or if between\nwords, to the end of the next word. Word boundaries are the same\nas 'forward-word'.\n\n'backward-kill-word (M-)'\nKill the word behind point. Word boundaries are the same as\n'backward-word'.\n\n'shell-transpose-words (M-C-t)'\nDrag the word before point past the word after point, moving point\npast that word as well. If the insertion point is at the end of\nthe line, this transposes the last two words on the line. Word\nboundaries are the same as 'shell-forward-word' and\n'shell-backward-word'.\n\n'unix-word-rubout (C-w)'\nKill the word behind point, using white space as a word boundary.\nThe killed text is saved on the kill-ring.\n\n'unix-filename-rubout ()'\nKill the word behind point, using white space and the slash\ncharacter as the word boundaries. The killed text is saved on the\nkill-ring.\n\n'delete-horizontal-space ()'\nDelete all spaces and tabs around point. By default, this is\nunbound.\n\n'kill-region ()'\nKill the text in the current region. By default, this command is\nunbound.\n\n'copy-region-as-kill ()'\nCopy the text in the region to the kill buffer, so it can be yanked\nright away. By default, this command is unbound.\n\n'copy-backward-word ()'\nCopy the word before point to the kill buffer. The word boundaries\nare the same as 'backward-word'. By default, this command is\nunbound.\n\n'copy-forward-word ()'\nCopy the word following point to the kill buffer. The word\nboundaries are the same as 'forward-word'. By default, this\ncommand is unbound.\n\n'yank (C-y)'\nYank the top of the kill ring into the buffer at point.\n\n'yank-pop (M-y)'\nRotate the kill-ring, and yank the new top. You can only do this\nif the prior command is 'yank' or 'yank-pop'.\n",
"subsections": []
},
"File: rluserman.info, Node: Numeric Arguments, Next: Commands For Completion, Prev: Commands For Killing, Up: Bindable Readline Commands": {
"content": "'digit-argument (M-0, M-1, ... M--)'\nAdd this digit to the argument already accumulating, or start a new\nargument. 'M--' starts a negative argument.\n\n'universal-argument ()'\nThis is another way to specify an argument. If this command is\nfollowed by one or more digits, optionally with a leading minus\nsign, those digits define the argument. If the command is followed\nby digits, executing 'universal-argument' again ends the numeric\nargument, but is otherwise ignored. As a special case, if this\ncommand is immediately followed by a character that is neither a\ndigit nor minus sign, the argument count for the next command is\nmultiplied by four. The argument count is initially one, so\nexecuting this function the first time makes the argument count\nfour, a second time makes the argument count sixteen, and so on.\nBy default, this is not bound to a key.\n",
"subsections": []
},
"File: rluserman.info, Node: Commands For Completion, Next: Keyboard Macros, Prev: Numeric Arguments, Up: Bindable Readline Commands": {
"content": "'complete ()'\nAttempt to perform completion on the text before point. The actual\ncompletion performed is application-specific. The default is\nfilename completion.\n\n'possible-completions (M-?)'\nList the possible completions of the text before point. When\ndisplaying completions, Readline sets the number of columns used\nfor display to the value of 'completion-display-width', the value\nof the environment variable 'COLUMNS', or the screen width, in that\norder.\n\n'insert-completions (M-*)'\nInsert all completions of the text before point that would have\nbeen generated by 'possible-completions'.\n\n'menu-complete ()'\nSimilar to 'complete', but replaces the word to be completed with a\nsingle match from the list of possible completions. Repeated\nexecution of 'menu-complete' steps through the list of possible\ncompletions, inserting each match in turn. At the end of the list\nof completions, the bell is rung (subject to the setting of\n'bell-style') and the original text is restored. An argument of N\nmoves N positions forward in the list of matches; a negative\nargument may be used to move backward through the list. This\ncommand is intended to be bound to , but is unbound by\ndefault.\n\n'menu-complete-backward ()'\nIdentical to 'menu-complete', but moves backward through the list\nof possible completions, as if 'menu-complete' had been given a\nnegative argument.\n\n'delete-char-or-list ()'\nDeletes the character under the cursor if not at the beginning or\nend of the line (like 'delete-char'). If at the end of the line,\nbehaves identically to 'possible-completions'. This command is\nunbound by default.\n",
"subsections": []
},
"File: rluserman.info, Node: Keyboard Macros, Next: Miscellaneous Commands, Prev: Commands For Completion, Up: Bindable Readline Commands": {
"content": "'start-kbd-macro (C-x ()'\nBegin saving the characters typed into the current keyboard macro.\n\n'end-kbd-macro (C-x ))'\nStop saving the characters typed into the current keyboard macro\nand save the definition.\n\n'call-last-kbd-macro (C-x e)'\nRe-execute the last keyboard macro defined, by making the\ncharacters in the macro appear as if typed at the keyboard.\n\n'print-last-kbd-macro ()'\nPrint the last keyboard macro defined in a format suitable for the\nINPUTRC file.\n",
"subsections": []
},
"File: rluserman.info, Node: Miscellaneous Commands, Prev: Keyboard Macros, Up: Bindable Readline Commands": {
"content": "'re-read-init-file (C-x C-r)'\nRead in the contents of the INPUTRC file, and incorporate any\nbindings or variable assignments found there.\n\n'abort (C-g)'\nAbort the current editing command and ring the terminal's bell\n(subject to the setting of 'bell-style').\n\n'do-lowercase-version (M-A, M-B, M-X, ...)'\nIf the metafied character X is upper case, run the command that is\nbound to the corresponding metafied lower case character. The\nbehavior is undefined if X is already lower case.\n\n'prefix-meta ()'\nMetafy the next character typed. This is for keyboards without a\nmeta key. Typing ' f' is equivalent to typing 'M-f'.\n\n'undo (C- or C-x C-u)'\nIncremental undo, separately remembered for each line.\n\n'revert-line (M-r)'\nUndo all changes made to this line. This is like executing the\n'undo' command enough times to get back to the beginning.\n\n'tilde-expand (M-~)'\nPerform tilde expansion on the current word.\n\n'set-mark (C-@)'\nSet the mark to the point. If a numeric argument is supplied, the\nmark is set to that position.\n\n'exchange-point-and-mark (C-x C-x)'\nSwap the point with the mark. The current cursor position is set\nto the saved position, and the old cursor position is saved as the\nmark.\n\n'character-search (C-])'\nA character is read and point is moved to the next occurrence of\nthat character. A negative argument searches for previous\noccurrences.\n\n'character-search-backward (M-C-])'\nA character is read and point is moved to the previous occurrence\nof that character. A negative argument searches for subsequent\noccurrences.\n\n'skip-csi-sequence ()'\nRead enough characters to consume a multi-key sequence such as\nthose defined for keys like Home and End. Such sequences begin\nwith a Control Sequence Indicator (CSI), usually ESC-[. If this\nsequence is bound to \"\\e[\", keys producing such sequences will have\nno effect unless explicitly bound to a Readline command, instead of\ninserting stray characters into the editing buffer. This is\nunbound by default, but usually bound to ESC-[.\n\n'insert-comment (M-#)'\nWithout a numeric argument, the value of the 'comment-begin'\nvariable is inserted at the beginning of the current line. If a\nnumeric argument is supplied, this command acts as a toggle: if the\ncharacters at the beginning of the line do not match the value of\n'comment-begin', the value is inserted, otherwise the characters in\n'comment-begin' are deleted from the beginning of the line. In\neither case, the line is accepted as if a newline had been typed.\n\n'dump-functions ()'\nPrint all of the functions and their key bindings to the Readline\noutput stream. If a numeric argument is supplied, the output is\nformatted in such a way that it can be made part of an INPUTRC\nfile. This command is unbound by default.\n\n'dump-variables ()'\nPrint all of the settable variables and their values to the\nReadline output stream. If a numeric argument is supplied, the\noutput is formatted in such a way that it can be made part of an\nINPUTRC file. This command is unbound by default.\n\n'dump-macros ()'\nPrint all of the Readline key sequences bound to macros and the\nstrings they output. If a numeric argument is supplied, the output\nis formatted in such a way that it can be made part of an INPUTRC\nfile. This command is unbound by default.\n\n'emacs-editing-mode (C-e)'\nWhen in 'vi' command mode, this causes a switch to 'emacs' editing\nmode.\n\n'vi-editing-mode (M-C-j)'\nWhen in 'emacs' editing mode, this causes a switch to 'vi' editing\nmode.\n",
"subsections": []
},
"File: rluserman.info, Node: Readline vi Mode, Prev: Bindable Readline Commands, Up: Command Line Editing": {
"content": "",
"subsections": [
{
"name": "1.5 Readline vi Mode",
"content": ""
}
]
},
"While the Readline library does not have a full set of 'vi' editing": {
"content": "functions, it does contain enough to allow simple editing of the line.\nThe Readline 'vi' mode behaves as specified in the POSIX standard.\n\nIn order to switch interactively between 'emacs' and 'vi' editing\nmodes, use the command 'M-C-j' (bound to emacs-editing-mode when in 'vi'\nmode and to vi-editing-mode in 'emacs' mode). The Readline default is\n'emacs' mode.\n\nWhen you enter a line in 'vi' mode, you are already placed in\n'insertion' mode, as if you had typed an 'i'. Pressing switches\nyou into 'command' mode, where you can edit the text of the line with\nthe standard 'vi' movement keys, move to previous history lines with 'k'\nand subsequent lines with 'j', and so forth.\n",
"subsections": []
},
"File: rluserman.info, Node: GNU Free Documentation License, Prev: Command Line Editing, Up: Top": {
"content": "",
"subsections": []
},
"Appendix A GNU Free Documentation License": {
"content": "Version 1.3, 3 November 2008\n\nCopyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.\n\n\nEveryone is permitted to copy and distribute verbatim copies\nof this license document, but changing it is not allowed.\n\n0. PREAMBLE\n\nThe purpose of this License is to make a manual, textbook, or other\nfunctional and useful document \"free\" in the sense of freedom: to\nassure everyone the effective freedom to copy and redistribute it,\nwith or without modifying it, either commercially or\nnoncommercially. Secondarily, this License preserves for the\nauthor and publisher a way to get credit for their work, while not\nbeing considered responsible for modifications made by others.\n\nThis License is a kind of \"copyleft\", which means that derivative\nworks of the document must themselves be free in the same sense.\nIt complements the GNU General Public License, which is a copyleft\nlicense designed for free software.\n\nWe have designed this License in order to use it for manuals for\nfree software, because free software needs free documentation: a\nfree program should come with manuals providing the same freedoms\nthat the software does. But this License is not limited to\nsoftware manuals; it can be used for any textual work, regardless\nof subject matter or whether it is published as a printed book. We\nrecommend this License principally for works whose purpose is\ninstruction or reference.\n\n1. APPLICABILITY AND DEFINITIONS\n\nThis License applies to any manual or other work, in any medium,\nthat contains a notice placed by the copyright holder saying it can\nbe distributed under the terms of this License. Such a notice\ngrants a world-wide, royalty-free license, unlimited in duration,\nto use that work under the conditions stated herein. The\n\"Document\", below, refers to any such manual or work. Any member\nof the public is a licensee, and is addressed as \"you\". You accept\nthe license if you copy, modify or distribute the work in a way\nrequiring permission under copyright law.\n\nA \"Modified Version\" of the Document means any work containing the\nDocument or a portion of it, either copied verbatim, or with\nmodifications and/or translated into another language.\n\nA \"Secondary Section\" is a named appendix or a front-matter section\nof the Document that deals exclusively with the relationship of the\npublishers or authors of the Document to the Document's overall\nsubject (or to related matters) and contains nothing that could\nfall directly within that overall subject. (Thus, if the Document\nis in part a textbook of mathematics, a Secondary Section may not\nexplain any mathematics.) The relationship could be a matter of\nhistorical connection with the subject or with related matters, or\nof legal, commercial, philosophical, ethical or political position\nregarding them.\n\nThe \"Invariant Sections\" are certain Secondary Sections whose\ntitles are designated, as being those of Invariant Sections, in the\nnotice that says that the Document is released under this License.\nIf a section does not fit the above definition of Secondary then it\nis not allowed to be designated as Invariant. The Document may\ncontain zero Invariant Sections. If the Document does not identify\nany Invariant Sections then there are none.\n\nThe \"Cover Texts\" are certain short passages of text that are\nlisted, as Front-Cover Texts or Back-Cover Texts, in the notice\nthat says that the Document is released under this License. A\nFront-Cover Text may be at most 5 words, and a Back-Cover Text may\nbe at most 25 words.\n\nA \"Transparent\" copy of the Document means a machine-readable copy,\nrepresented in a format whose specification is available to the\ngeneral public, that is suitable for revising the document\nstraightforwardly with generic text editors or (for images composed\nof pixels) generic paint programs or (for drawings) some widely\navailable drawing editor, and that is suitable for input to text\nformatters or for automatic translation to a variety of formats\nsuitable for input to text formatters. A copy made in an otherwise\nTransparent file format whose markup, or absence of markup, has\nbeen arranged to thwart or discourage subsequent modification by\nreaders is not Transparent. An image format is not Transparent if\nused for any substantial amount of text. A copy that is not\n\"Transparent\" is called \"Opaque\".\n\nExamples of suitable formats for Transparent copies include plain\nASCII without markup, Texinfo input format, LaTeX input format,\nSGML or XML using a publicly available DTD, and standard-conforming\nsimple HTML, PostScript or PDF designed for human modification.\nExamples of transparent image formats include PNG, XCF and JPG.\nOpaque formats include proprietary formats that can be read and\nedited only by proprietary word processors, SGML or XML for which\nthe DTD and/or processing tools are not generally available, and\nthe machine-generated HTML, PostScript or PDF produced by some word\nprocessors for output purposes only.\n\nThe \"Title Page\" means, for a printed book, the title page itself,\nplus such following pages as are needed to hold, legibly, the\nmaterial this License requires to appear in the title page. For\nworks in formats which do not have any title page as such, \"Title\nPage\" means the text near the most prominent appearance of the\nwork's title, preceding the beginning of the body of the text.\n\nThe \"publisher\" means any person or entity that distributes copies\nof the Document to the public.\n\nA section \"Entitled XYZ\" means a named subunit of the Document\nwhose title either is precisely XYZ or contains XYZ in parentheses\nfollowing text that translates XYZ in another language. (Here XYZ\nstands for a specific section name mentioned below, such as\n\"Acknowledgements\", \"Dedications\", \"Endorsements\", or \"History\".)\nTo \"Preserve the Title\" of such a section when you modify the\nDocument means that it remains a section \"Entitled XYZ\" according\nto this definition.\n\nThe Document may include Warranty Disclaimers next to the notice\nwhich states that this License applies to the Document. These\nWarranty Disclaimers are considered to be included by reference in\nthis License, but only as regards disclaiming warranties: any other\nimplication that these Warranty Disclaimers may have is void and\nhas no effect on the meaning of this License.\n\n2. VERBATIM COPYING\n\nYou may copy and distribute the Document in any medium, either\ncommercially or noncommercially, provided that this License, the\ncopyright notices, and the license notice saying this License\napplies to the Document are reproduced in all copies, and that you\nadd no other conditions whatsoever to those of this License. You\nmay not use technical measures to obstruct or control the reading\nor further copying of the copies you make or distribute. However,\nyou may accept compensation in exchange for copies. If you\ndistribute a large enough number of copies you must also follow the\nconditions in section 3.\n\nYou may also lend copies, under the same conditions stated above,\nand you may publicly display copies.\n\n3. COPYING IN QUANTITY\n\nIf you publish printed copies (or copies in media that commonly\nhave printed covers) of the Document, numbering more than 100, and\nthe Document's license notice requires Cover Texts, you must\nenclose the copies in covers that carry, clearly and legibly, all\nthese Cover Texts: Front-Cover Texts on the front cover, and\nBack-Cover Texts on the back cover. Both covers must also clearly\nand legibly identify you as the publisher of these copies. The\nfront cover must present the full title with all words of the title\nequally prominent and visible. You may add other material on the\ncovers in addition. Copying with changes limited to the covers, as\nlong as they preserve the title of the Document and satisfy these\nconditions, can be treated as verbatim copying in other respects.\n\nIf the required texts for either cover are too voluminous to fit\nlegibly, you should put the first ones listed (as many as fit\nreasonably) on the actual cover, and continue the rest onto\nadjacent pages.\n\nIf you publish or distribute Opaque copies of the Document\nnumbering more than 100, you must either include a machine-readable\nTransparent copy along with each Opaque copy, or state in or with\neach Opaque copy a computer-network location from which the general\nnetwork-using public has access to download using public-standard\nnetwork protocols a complete Transparent copy of the Document, free\nof added material. If you use the latter option, you must take\nreasonably prudent steps, when you begin distribution of Opaque\ncopies in quantity, to ensure that this Transparent copy will\nremain thus accessible at the stated location until at least one\nyear after the last time you distribute an Opaque copy (directly or\nthrough your agents or retailers) of that edition to the public.\n\nIt is requested, but not required, that you contact the authors of\nthe Document well before redistributing any large number of copies,\nto give them a chance to provide you with an updated version of the\nDocument.\n\n4. MODIFICATIONS\n\nYou may copy and distribute a Modified Version of the Document\nunder the conditions of sections 2 and 3 above, provided that you\nrelease the Modified Version under precisely this License, with the\nModified Version filling the role of the Document, thus licensing\ndistribution and modification of the Modified Version to whoever\npossesses a copy of it. In addition, you must do these things in\nthe Modified Version:\n\nA. Use in the Title Page (and on the covers, if any) a title\ndistinct from that of the Document, and from those of previous\nversions (which should, if there were any, be listed in the\nHistory section of the Document). You may use the same title\nas a previous version if the original publisher of that\nversion gives permission.\n\nB. List on the Title Page, as authors, one or more persons or\nentities responsible for authorship of the modifications in\nthe Modified Version, together with at least five of the\nprincipal authors of the Document (all of its principal\nauthors, if it has fewer than five), unless they release you\nfrom this requirement.\n\nC. State on the Title page the name of the publisher of the\nModified Version, as the publisher.\n\nD. Preserve all the copyright notices of the Document.\n\nE. Add an appropriate copyright notice for your modifications\nadjacent to the other copyright notices.\n\nF. Include, immediately after the copyright notices, a license\nnotice giving the public permission to use the Modified\nVersion under the terms of this License, in the form shown in\nthe Addendum below.\n\nG. Preserve in that license notice the full lists of Invariant\nSections and required Cover Texts given in the Document's\nlicense notice.\n\nH. Include an unaltered copy of this License.\n\nI. Preserve the section Entitled \"History\", Preserve its Title,\nand add to it an item stating at least the title, year, new\nauthors, and publisher of the Modified Version as given on the\nTitle Page. If there is no section Entitled \"History\" in the\nDocument, create one stating the title, year, authors, and\npublisher of the Document as given on its Title Page, then add\nan item describing the Modified Version as stated in the\nprevious sentence.\n\nJ. Preserve the network location, if any, given in the Document\nfor public access to a Transparent copy of the Document, and\nlikewise the network locations given in the Document for\nprevious versions it was based on. These may be placed in the\n\"History\" section. You may omit a network location for a work\nthat was published at least four years before the Document\nitself, or if the original publisher of the version it refers\nto gives permission.\n\nK. For any section Entitled \"Acknowledgements\" or \"Dedications\",\nPreserve the Title of the section, and preserve in the section\nall the substance and tone of each of the contributor\nacknowledgements and/or dedications given therein.\n\nL. Preserve all the Invariant Sections of the Document, unaltered\nin their text and in their titles. Section numbers or the\nequivalent are not considered part of the section titles.\n\nM. Delete any section Entitled \"Endorsements\". Such a section\nmay not be included in the Modified Version.\n\nN. Do not retitle any existing section to be Entitled\n\"Endorsements\" or to conflict in title with any Invariant\nSection.\n\nO. Preserve any Warranty Disclaimers.\n\nIf the Modified Version includes new front-matter sections or\nappendices that qualify as Secondary Sections and contain no\nmaterial copied from the Document, you may at your option designate\nsome or all of these sections as invariant. To do this, add their\ntitles to the list of Invariant Sections in the Modified Version's\nlicense notice. These titles must be distinct from any other\nsection titles.\n\nYou may add a section Entitled \"Endorsements\", provided it contains\nnothing but endorsements of your Modified Version by various\nparties--for example, statements of peer review or that the text\nhas been approved by an organization as the authoritative\ndefinition of a standard.\n\nYou may add a passage of up to five words as a Front-Cover Text,\nand a passage of up to 25 words as a Back-Cover Text, to the end of\nthe list of Cover Texts in the Modified Version. Only one passage\nof Front-Cover Text and one of Back-Cover Text may be added by (or\nthrough arrangements made by) any one entity. If the Document\nalready includes a cover text for the same cover, previously added\nby you or by arrangement made by the same entity you are acting on\nbehalf of, you may not add another; but you may replace the old\none, on explicit permission from the previous publisher that added\nthe old one.\n\nThe author(s) and publisher(s) of the Document do not by this\nLicense give permission to use their names for publicity for or to\nassert or imply endorsement of any Modified Version.\n\n5. COMBINING DOCUMENTS\n\nYou may combine the Document with other documents released under\nthis License, under the terms defined in section 4 above for\nmodified versions, provided that you include in the combination all\nof the Invariant Sections of all of the original documents,\nunmodified, and list them all as Invariant Sections of your\ncombined work in its license notice, and that you preserve all\ntheir Warranty Disclaimers.\n\nThe combined work need only contain one copy of this License, and\nmultiple identical Invariant Sections may be replaced with a single\ncopy. If there are multiple Invariant Sections with the same name\nbut different contents, make the title of each such section unique\nby adding at the end of it, in parentheses, the name of the\noriginal author or publisher of that section if known, or else a\nunique number. Make the same adjustment to the section titles in\nthe list of Invariant Sections in the license notice of the\ncombined work.\n\nIn the combination, you must combine any sections Entitled\n\"History\" in the various original documents, forming one section\nEntitled \"History\"; likewise combine any sections Entitled\n\"Acknowledgements\", and any sections Entitled \"Dedications\". You\nmust delete all sections Entitled \"Endorsements.\"\n\n6. COLLECTIONS OF DOCUMENTS\n\nYou may make a collection consisting of the Document and other\ndocuments released under this License, and replace the individual\ncopies of this License in the various documents with a single copy\nthat is included in the collection, provided that you follow the\nrules of this License for verbatim copying of each of the documents\nin all other respects.\n\nYou may extract a single document from such a collection, and\ndistribute it individually under this License, provided you insert\na copy of this License into the extracted document, and follow this\nLicense in all other respects regarding verbatim copying of that\ndocument.\n\n7. AGGREGATION WITH INDEPENDENT WORKS\n\nA compilation of the Document or its derivatives with other\nseparate and independent documents or works, in or on a volume of a\nstorage or distribution medium, is called an \"aggregate\" if the\ncopyright resulting from the compilation is not used to limit the\nlegal rights of the compilation's users beyond what the individual\nworks permit. When the Document is included in an aggregate, this\nLicense does not apply to the other works in the aggregate which\nare not themselves derivative works of the Document.\n\nIf the Cover Text requirement of section 3 is applicable to these\ncopies of the Document, then if the Document is less than one half\nof the entire aggregate, the Document's Cover Texts may be placed\non covers that bracket the Document within the aggregate, or the\nelectronic equivalent of covers if the Document is in electronic\nform. Otherwise they must appear on printed covers that bracket\nthe whole aggregate.\n\n8. TRANSLATION\n\nTranslation is considered a kind of modification, so you may\ndistribute translations of the Document under the terms of section\n4. Replacing Invariant Sections with translations requires special\npermission from their copyright holders, but you may include\ntranslations of some or all Invariant Sections in addition to the\noriginal versions of these Invariant Sections. You may include a\ntranslation of this License, and all the license notices in the\nDocument, and any Warranty Disclaimers, provided that you also\ninclude the original English version of this License and the\noriginal versions of those notices and disclaimers. In case of a\ndisagreement between the translation and the original version of\nthis License or a notice or disclaimer, the original version will\nprevail.\n\nIf a section in the Document is Entitled \"Acknowledgements\",\n\"Dedications\", or \"History\", the requirement (section 4) to\nPreserve its Title (section 1) will typically require changing the\nactual title.\n\n9. TERMINATION\n\nYou may not copy, modify, sublicense, or distribute the Document\nexcept as expressly provided under this License. Any attempt\notherwise to copy, modify, sublicense, or distribute it is void,\nand will automatically terminate your rights under this License.\n\nHowever, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the\ncopyright holder fails to notify you of the violation by some\nreasonable means prior to 60 days after the cessation.\n\nMoreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from\nthat copyright holder, and you cure the violation prior to 30 days\nafter your receipt of the notice.\n\nTermination of your rights under this section does not terminate\nthe licenses of parties who have received copies or rights from you\nunder this License. If your rights have been terminated and not\npermanently reinstated, receipt of a copy of some or all of the\nsame material does not give you any rights to use it.\n\n10. FUTURE REVISIONS OF THIS LICENSE\n\nThe Free Software Foundation may publish new, revised versions of\nthe GNU Free Documentation License from time to time. Such new\nversions will be similar in spirit to the present version, but may\ndiffer in detail to address new problems or concerns. See\n.\n\nEach version of the License is given a distinguishing version\nnumber. If the Document specifies that a particular numbered\nversion of this License \"or any later version\" applies to it, you\nhave the option of following the terms and conditions either of\nthat specified version or of any later version that has been\npublished (not as a draft) by the Free Software Foundation. If the\nDocument does not specify a version number of this License, you may\nchoose any version ever published (not as a draft) by the Free\nSoftware Foundation. If the Document specifies that a proxy can\ndecide which future versions of this License can be used, that\nproxy's public statement of acceptance of a version permanently\nauthorizes you to choose that version for the Document.\n\n11. RELICENSING\n\n\"Massive Multiauthor Collaboration Site\" (or \"MMC Site\") means any\nWorld Wide Web server that publishes copyrightable works and also\nprovides prominent facilities for anybody to edit those works. A\npublic wiki that anybody can edit is an example of such a server.\nA \"Massive Multiauthor Collaboration\" (or \"MMC\") contained in the\nsite means any set of copyrightable works thus published on the MMC\nsite.\n\n\"CC-BY-SA\" means the Creative Commons Attribution-Share Alike 3.0\nlicense published by Creative Commons Corporation, a not-for-profit\ncorporation with a principal place of business in San Francisco,\nCalifornia, as well as future copyleft versions of that license\npublished by that same organization.\n\n\"Incorporate\" means to publish or republish a Document, in whole or\nin part, as part of another Document.\n\nAn MMC is \"eligible for relicensing\" if it is licensed under this\nLicense, and if all works that were first published under this\nLicense somewhere other than this MMC, and subsequently\nincorporated in whole or in part into the MMC, (1) had no cover\ntexts or invariant sections, and (2) were thus incorporated prior\nto November 1, 2008.\n\nThe operator of an MMC Site may republish an MMC contained in the\nsite under CC-BY-SA on the same site at any time before August 1,\n2009, provided the MMC is eligible for relicensing.\n",
"subsections": [
{
"name": "ADDENDUM: How to use this License for your documents",
"content": ""
}
]
},
"To use this License in a document you have written, include a copy of": {
"content": "the License in the document and put the following copyright and license\nnotices just after the title page:\n\nCopyright (C) YEAR YOUR NAME.\nPermission is granted to copy, distribute and/or modify this document\nunder the terms of the GNU Free Documentation License, Version 1.3\nor any later version published by the Free Software Foundation;\nwith no Invariant Sections, no Front-Cover Texts, and no Back-Cover\nTexts. A copy of the license is included in the section entitled ``GNU\nFree Documentation License''.\n\nIf you have Invariant Sections, Front-Cover Texts and Back-Cover\nTexts, replace the \"with...Texts.\" line with this:\n\nwith the Invariant Sections being LIST THEIR TITLES, with\nthe Front-Cover Texts being LIST, and with the Back-Cover Texts\nbeing LIST.\n\nIf you have Invariant Sections without Cover Texts, or some other\ncombination of the three, merge those two alternatives to suit the\nsituation.\n\nIf your document contains nontrivial examples of program code, we\nrecommend releasing these examples in parallel under your choice of free\nsoftware license, such as the GNU General Public License, to permit\ntheir use in free software.\n\n",
"subsections": []
}
},
"flags": [],
"examples": [],
"see_also": []
}