ARIF_RL_ENABLE(3)

📦 version 0.3.0, in alpine 3.24

💖 ARIF_RL_ENABLE(3) 💖

okay bestie, this is the ARIF User Manual page for arif_rl_enable, and it’s literally here to help you set up Readline for ARIF. slay. ✨

🌸 NAME 🌸

arif_rl_enable — setup Readline for ARIF 💅

🦋 SYNOPSIS 🦋

#include <arif_rl.h>

void
arif_rl_enable (
    rl_completion_func_t *complete_func,
    rl_compdisp_func_t   *display_func,
    char const           *word_break_chars
);

💅 DESCRIPTION 💅

The arif_rl_enable() function enables using Readline as an ARIF frontend. iconic behavior, fr fr 💖

🚨 bestie, if it’s already enabled, the function behavior is undefined. like, literally undefined. not me making this up — that’s the spec. 🙈

The function updates several Readline completion variables. Some of them shall be provided by the caller — yes, that means you, bestie 🫶:

  • Readline completion variable rl_attempted_completion_function → replacement complete_func
  • Readline completion variable rl_completion_display_matches_hook → replacement display_func
  • Readline completion variable rl_completer_word_break_characters → replacement word_break_chars

The complete_func and display_func functions shall be implemented using arif_rl_complete(3) and arif_rl_display(3), accordingly. no cap, that’s the assignment 💅

Original values of the Readline completion variables are saved before they get updated, so that they could be restored later by calling arif_rl_disable(3). the way that’s lowkey thoughtful 🎀

Copyright (C) 2025 CismonX <admin@cismon.net>

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.

You should have received a copy of the license along with this document. If not, see https://www.gnu.org/licenses/fdl-1.3.html.

🌈 SEE ALSO 🌈

okay that’s the whole ARIF User Manual page, version 0.2.0, dated Aug 03, 2025 — bye bestie, go make Readline serve ARIF main character energy 💅🫶💖

📦 where this page comes from