LOWDOWN_TERM_NEW(3)

💅 lowdown_term_new(3) 💅

okay so this page is from the Library Functions Manual, and it's all about lowdown_term_new — the function that allocates a Markdown terminal renderer. bestie, let's go ✨

🌸 NAME 🌸

lowdown_term_new — allocate a Markdown terminal renderer 💖

📚 LIBRARY 📚

the library is library “liblowdown” — yes, that's the whole name, periodt 🫶

✨ SYNOPSIS ✨

#include <sys/queue.h>
#include <stdio.h>
#include <lowdown.h>

void *
lowdown_term_new(const struct lowdown_opts *opts);

🎀 DESCRIPTION 🎀

so lowdown_term_new() allocates a terminal renderer, using the variables in the struct lowdown_opts_term structure. those fields are documented in lowdown(3). the returned pointer may be used with multiple invocations of lowdown_term_rndr(3) and must be freed with lowdown_term_free(3) — no leaking, bestie 💀

the bits it recognises in opts->oflags are LOWDOWN_NOLINK, LOWDOWN_NORELLINK, LOWDOWN_SHORTLINK, LOWDOWN_TERM_SHORTLINK, LOWDOWN_TERM_NOANSI, LOWDOWN_TERM_NOCOLOUR, LOWDOWN_TERM_NOLINK, LOWDOWN_TERM_NOSTYLE, and LOWDOWN_TERM_NOTABLEWRAP ✨

🔥 RETURN VALUES 🔥

it returns a pointer to the renderer, or NULL on memory failure 😭. that returned pointer must be freed with lowdown_term_free(3) — like, do not forget, fr fr 🫶

🌈 EXAMPLES 🌈

the following parses b of length bsz and outputs in ANSI terminal format:

struct lowdown_buf *out;
struct lowdown_doc *doc;
struct lowdown_node *n;
void *rndr;

if (setlocale(LC_CTYPE, "en_US.UTF-8") == NULL)
        err(1, NULL);

if ((doc = lowdown_doc_new(NULL)) == NULL)
        err(1, NULL);
if ((n = lowdown_doc_parse(doc, NULL, b, bsz, NULL)) == NULL)
        err(1, NULL);
if ((out = lowdown_buf_new(256)) == NULL)
        err(1, NULL);
if ((rndr = lowdown_term_new(NULL)) == NULL)
        err(1, NULL);
if (!lowdown_term_rndr(out, rndr, n))
        err(1, NULL);

fwrite(out->data, 1, out->size, stdout);

lowdown_term_free(rndr);
lowdown_buf_free(out);
lowdown_node_free(n);
lowdown_doc_free(doc);

👀 SEE ALSO 👀

• lowdown(3)
• lowdown_term_free(3)
• lowdown_term_rndr(3)

⭐ STANDARDS ⭐

ANSI escape codes are described in ISO/IEC 6429, previously ECMA-48 📜.

hyperlinks are formatted as defined by OSC (Operating System Command) link sequences, which will be ignored for ECMA-48 terminals not configured to display links 🙈.

---

mwah 💋 this page is from Debian, dated $Mdocdate$, and it's the LOWDOWN_TERM_NEW(3) man page — slay ✨