---
name: "lowdown_nroff_new"
section: "3"
platform: "linux"
package: "liblowdown-dev"
version: "2.0.2-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/lowdown_nroff_new"
---

# lowdown\_nroff\_new(3)

allocate a roff renderer for lowdown documents

## NAME

**lowdown\_nroff\_new** – allocate a roff renderer for lowdown documents

## LIBRARY

library “liblowdown”

## SYNOPSIS

**#include \<sys/queue.h\>**

**#include \<stdio.h\>**

**#include \<lowdown.h\>**

*void* *\**\

**lowdown\_nroff\_new**(*const struct lowdown\_opts \*opts*);

## DESCRIPTION

Allocates a roff renderer using *opts-\>oflags* and *opts-\>type*, or zero and LOWDODN\_NROFF, respectively, if *opts* is NULL. These are documented in [lowdown(3)](/lowdown/3.md). The returned pointer may be used with multiple invocations of [lowdown\_nroff\_rndr(3)](/lowdown_nroff_rndr/3.md) and must be freed with [lowdown\_nroff\_free(3)](/lowdown_nroff_free/3.md).

The bits recognised in *opts-\>oflags* are LOWDOWN\_NROFF\_ENDNOTES, LOWDOWN\_NROFF\_GROFF, LOWDOWN\_NROFF\_NOLINK, LOWDOWN\_NROFF\_NUMBERED, LOWDOWN\_NROFF\_SHORTLINK, LOWDOWN\_NROFF\_SKIP\_HTML, and LOWDOWN\_STANDALONE.

The values recognised in *opts-\>type* are LOWDOWN\_MAN and LOWDODN\_NROFF: anything else triggers LOWDODN\_NROFF.

If LOWDOWN\_NROFF\_GROFF is set in LOWDOWN\_MAN mode, macros from the *man-ext* package as well as the original *man* are used in output. These are supported by both groff and mandoc. If in LOWDODN\_NROFF mode, GNU extensions to *ms* are used along with *mspdf*. These are only supported by groff.

LOWDOWN\_NROFF\_ENDNOTES delays printing of footnotes until the end of a document. Does not affect LOWDOWN\_MAN documents, which structurally only supports endnotes.

The allocated rendered will use constant-width fonts "CR" (regular), "CB" (bold), "CI" (italic), and "CBI" (bold-italic). Override the defaults with variables in the *struct lowdown\_opts\_nroff* structure.

## RETURN VALUES

Returns a pointer to the renderer or NULL on memory failure. The returned pointer must be freed with [lowdown\_nroff\_free(3)](/lowdown_nroff_free/3.md).

## EXAMPLES

The following parses *b* of length *bsz* and outputs in [groff\_ms(7)](/groff_ms/7.md) 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);
```

## SEE ALSO

[lowdown(3)](/lowdown/3.md), [lowdown\_nroff\_free(3)](/lowdown_nroff_free/3.md), [lowdown\_nroff\_rndr(3)](/lowdown_nroff_rndr/3.md),

This uses both the original troff *man* macros for Version 7 AT&T UNIX, defined in [man(7)](/man/7.md), and the *man-ext* groff extensions. Both are implemented in mandoc.

The troff *ms* macros are defined in [groff\_ms(7)](/groff_ms/7.md), with the *mspdf* groff extensions described in "Portable Document Format Publishing with GNU Troff" by Keith Marshall. Neither are implemented in mandoc.

## CAVEATS

The default constant-width fonts may not available for the formatter's output device (for example, the terminal). In this case, the formatter may raise a warning and ignore the font.