[ Main Table Of Contents | Table Of Contents | Keyword Index ]

linenoise_introduction(n) 1 doc "Tcl Line Editor"


linenoise_introduction - Introduction To Linenoise

Table Of Contents


Welcome to Linenoise, a binding to Antirez's linenoise minimal line editor library, as modified and extended by Steve Bennet of Workware.au

Linenoise is actually quite simple. Originally starting from Salvatore Sanfilippo's C library for a minimal line editor in tty, coincidentally also called linenoise, a simple wrapper exposing the functionality to Tcl scripts was written. This was later switched to Steve Bennet's fork of the same, due to its enhanced portability and set of features (Windows, UTF-8, more editing commands). Currently my own fork of the same is prefered, due to its support for hidden input, i.e. password prompts and the like.

This here is the result.

The following sections first reference a few related documents which may or may not be of interest to you, depending on if you are just a plain user of the system, trying to get and build/install it, or are going deep into the internals for either edification or modification.

This is followed by a quick overview of the general architecture as seen by a user.

Related Documents

  1. Linenoise - License.

  2. Linenoise - How To Get The Sources.

  3. Linenoise - The Installer's Guide.

  4. Linenoise - Package Reference

  5. Linenoise - The Developer's Guide.

System Architecture

The system's architecture is super simple. There are only two layers, consisting of the linenoise core, and of the binding sitting on top. The user sees only the binding, and nothing else.


Andreas Kupries (Tcl Binding), Steve Bennett (extended linenoise C library), Salvatore Sanfilippo (Antirez, original linenoise C library).

Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report them at the Issues tracker. Ideas for enhancements you may have for either package, application, and/or the documentation are also very welcome and should be reported at the Issues tracker as well.


console, edit line, line editor, line reading, linenoise, raw mode, read line, terminal, tty