https://github.com/murarth/linefeed

Configurable, extensible, interactive line reader
https://github.com/murarth/linefeed

readline rust terminal

Last synced: 7 days ago
JSON representation

Configurable, extensible, interactive line reader

• Host: GitHub
• URL: https://github.com/murarth/linefeed
• Owner: murarth
• License: apache-2.0
• Created: 2016-08-24T02:24:19.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-08-25T12:41:00.000Z (about 4 years ago)
• Last Synced: 2024-06-19T02:04:39.826Z (5 months ago)
• Topics: readline, rust, terminal
• Language: Rust
• Size: 5.92 MB
• Stars: 184
• Watchers: 6
• Forks: 17
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

• awesome-rust-cn - murarth/linefeed - ci.org/murarth/linefeed.svg">](https://travis-ci.org/murarth/linefeed) (Libraries / Command-line)
• awesome-rust - murarth/linefeed - ci.org/murarth/linefeed.svg">](https://travis-ci.org/murarth/linefeed) (Libraries / Command-line)
• awesome-rust - murarth/linefeed
• awesome-rust-cn - murarth/linefeed
• awesome-rust-zh - murarth/linefeed - 可配置，可扩展的交互式线路阅读器[<img src="https://api.travis-ci.org/murarth/linefeed.svg">](https://travis-ci.org/murarth/linefeed) (库 / 命令行)
• awesome-rust - murarth/linefeed - Configurable, extensible, interactive line reader (Libraries / Command-line)
• awesome-rust - murarth/linefeed - ci.org/murarth/linefeed.svg">](https://travis-ci.org/murarth/linefeed) (库 Libraries / 命令行 Command-line)
• fucking-awesome-rust - murarth/linefeed - Configurable, extensible, interactive line reader (Libraries / Command-line)
• fucking-awesome-rust - murarth/linefeed - Configurable, extensible, interactive line reader (Libraries / Command-line)

README

        
# `linefeed`

`linefeed` is a configurable, concurrent, extensible, interactive input reader

for Unix terminals and Windows console.

[API Documentation](https://docs.rs/linefeed/)

`linefeed` follows the paradigm of GNU Readline, binding key sequences to

commands that modify input state. `linefeed` supports many GNU Readline commands.

However, `linefeed` does not implement all commands supported by GNU Readline.

If there's a command you want to be implemented, file an issue!

`linefeed` also interprets GNU Readline `inputrc` configuration files.

First, it will check for a filename in the environment variable `INPUTRC`.

Then, on Unix, it will check `$HOME/.inputrc` or `/etc/inputrc`;

while, on Windows, it will check `%APPDATA%\linefeed\inputrc`.

Only the first of these that is present is parsed and evaluated.

## Building

To include `linefeed` in your project, add the following to your `Cargo.toml`:

```toml

[dependencies]

linefeed = "0.6"

```

### Demo

The `linefeed` project contains a demo program for testing functionality.

To run the demo, run the following from a clone of the `linefeed` project:

    cargo run --example demo

## License

`linefeed` is distributed under the terms of both the MIT license and the

Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.