Home

Users

Options

• Introduction
• Setting options in the .inputrc file
• Options

Keymaps & Commands

• Table of Contents
• Keymaps
  • Available keymaps
  • Key dispatch & matching
  • Example
• Commands
  • Movement
  • Modifying Text
  • Arguments
  • Macros
  • History Control
  • Completion
  • Miscellaneous
  • Text Objects

Default Binds & Options

• Options
• Emacs
  • Emacs standard
  • Emacs Meta
  • Emacs CtrlX
• Vim
  • Insert
  • Command
  • Visual
  • Operator Pending
• Completion & Isearch
  • Menu-Select
  • Incremental Search
  • Non-incremental Search

Macros

• Emacs mode
• Vim mode

Vim (additional features)

• Registers
• Text objects (examples)

---

Developers

Introduction

• Current shell libraries
• Original readline compatiblity
• Aims and choices of this package
  • Architecture & inspirations
  • Simpler APIs, same user experience

Configuration File

• Loading configurations
• Global options
• Key bindings

History Sources

• File-based command history
• Adding and removing histories
• Custom history sources

Prompts

• Prompt handlers
• Logging to the shell
  • Transient log
  • Classic prompt log
  • Demo

Programmable Commands

• Introduction
• Accessing readline components
• The keymap engine
• Example 1: Adding a URL-selection command
• Example 2: Adding a surround-change command
• Key-event callbacks

Completions & Hints

• The Completions container
• Completion Candidates
• Autosuffix removal
• Hints and usage strings
• The hint area and its lanes
• Asynchronous updates

Syntax Highlighting

• Builtin highlighting
• Writing the callback

Inline Suggestions

• The API
• Setting a suggestion
• Accepting a suggestion

Bracketed Paste

• The paste transformer
• Example

Multiline support

• Writing the callback
• Example