replxx Documentation

replxx is a small, portable GNU readline replacement designed for Linux, Windows, and MacOS. It is UTF-8 aware and uses a BSD license, making it suitable for use in Apache2 or BSD licensed programs.

Key features include:

• Single-line and multi-line editing modes with standard key bindings.
• History handling and completion.
• Syntax highlighting and hints.
• Support for a subset of VT100 escapes (ANSI.SYS compatible).

To build replxx on Windows, use the MS-DOS command prompt and CMake to generate a Visual Studio solution file.

1. Create a build directory.
2. Generate the solution file using the appropriate generator for your architecture (32-bit or 64-bit) using Visual Studio 2013.
3. Open the resulting replxx.sln file in Visual Studio to complete the build.

# 1. Create a build directory
md build
cd build

# 2. Generate Visual Studio solution file (32 bit)
cmake -G "Visual Studio 12 2013" -DCMAKE_BUILD_TYPE=Release ..

# OR Generate Visual Studio solution file (64 bit)
cmake -G "Visual Studio 12 2013 Win64" -DCMAKE_BUILD_TYPE=Release ..

To build and install replxx on Linux or macOS, use CMake and Make. You will need a C++11-enabled compiler and a recent version of CMake.

1. Create a build directory.
2. Run CMake with the Release build type.
3. Compile using make.
4. Install the library using sudo make install. You can customize the installation path by setting the DESTDIR variable.

# 1. Create a build directory
mkdir -p build && cd build

# 2. Build the library
cmake -DCMAKE_BUILD_TYPE=Release .. && make

# 3. Install the library
sudo make install

# Optional: Install to a specific directory
make DESTDIR=/tmp install