lowdown_nroff_rndr(3)

lowdown_nroff_rndr3

Render markdown into roff

Usage

#include <sys/queue.h>

#include <stdio.h>

#include <lowdown.h>

int

lowdown_nroff_rndr(struct lowdown_buf *out, void *arg, const struct lowdown_node *n);

Library

library “liblowdown”

Overview

Renders a node tree n created by lowdown_doc_parse(3) or lowdown_diff(3) using the roff renderer arg as returned by lowdown_nroff_new(3). The output is written into out, which must be initialised and freed by the caller.

The output consists of roff output using the ms or man macro packages.

Return values

Returns zero on failure to allocate memory, non-zero on success.

Examples

The following parses b of length bsz and outputs in groff_ms(7) format.

struct lowdown_buf *out;
struct lowdown_doc *doc;
struct lowdown_node *n;
void *rndr;
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_nroff_new(NULL)) == NULL)
	err(1, NULL);
if (!lowdown_nroff_rndr(out, rndr, n))
	err(1, NULL);
fwrite(out->data, 1, out->size, stdout);
lowdown_nroff_free(rndr);
lowdown_buf_free(out);
lowdown_node_free(n);
lowdown_doc_free(doc);

Releases

3 releases since Debian 11 (Bullseye); the text changed 2 times.

  1. 11
  2. 12
  3. 13

From liblowdown-dev 2.0.2-2 in Debian 13 (Trixie). Parsed by carta from the page's mdoc source.