Back (Current repo: lowdown)

lowdown_nroff_new.3 (3378B)

.\"	$Id$
.\"
.\" Copyright (c) 2017--2021 Kristaps Dzonsons <kristaps@bsd.lv>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate$
.Dt LOWDOWN_NROFF_NEW 3
.Os
.Sh NAME
.Nm lowdown_nroff_new
.Nd allocate a roff renderer for lowdown documents
.Sh LIBRARY
.Lb liblowdown
.Sh SYNOPSIS
.In sys/queue.h
.In stdio.h
.In lowdown.h
.Ft void *
.Fo lowdown_nroff_new
.Fa "const struct lowdown_opts *opts"
.Fc
.Sh DESCRIPTION
Allocates a roff renderer using
.Fa opts->oflags
and
.Fa opts->type ,
or zero and
.Dv LOWDODN_NROFF ,
respectively, if
.Fa opts
is
.Dv NULL .
These are documented in
.Xr lowdown 3 .
The returned pointer may be used with multiple invocations of
.Xr lowdown_nroff_rndr 3
and must be freed with
.Xr lowdown_nroff_free 3 .
.Pp
The bits recognised in
.Fa opts->oflags
are
.Dv LOWDOWN_NROFF_GROFF ,
.Dv LOWDOWN_NROFF_NOLINK ,
.Dv LOWDOWN_NROFF_NUMBERED ,
.Dv LOWDOWN_NROFF_SHORTLINK ,
.Dv LOWDOWN_NROFF_SKIP_HTML ,
and
.Dv LOWDOWN_STANDALONE .
.Pp
The values recognised in
.Fa opts->type
are
.Dv LOWDOWN_MAN
and
.Dv LOWDODN_NROFF :
anything else triggers
.Dv LOWDODN_NROFF .
.Pp
If
.Dv LOWDOWN_NROFF_GROFF
is set in
.Dv LOWDOWN_MAN
mode, macros from the
.Ar man-ext
package as well as the original
.Ar man
are used in output.
These are supported by both groff and mandoc.
If in
.Dv LOWDODN_NROFF
mode, GNU extensions to
.Ar ms
are used along with
.Ar mspdf .
These are only supported by groff.
.Sh RETURN VALUES
Returns a pointer to the renderer or
.Dv NULL
on memory failure.
The returned pointer must be freed with
.Xr lowdown_nroff_free 3 .
.Sh EXAMPLES
The following parses
.Va b
of length
.Va bsz
and outputs in
.Xr groff_ms 7
format.
.Bd -literal -offset indent
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);
.Ed
.Sh SEE ALSO
.Xr lowdown 3 ,
.Xr lowdown_nroff_free 3 ,
.Xr lowdown_nroff_rndr 3 ,
.Pp
This uses both the original troff
.Ar man
macros for
.At v7 ,
defined in
.Xr man 7 ,
and the
.Ar man-ext
groff extensions.
Both are implemented in mandoc.
.Pp
The troff
.Ar ms
macros are defined in
.Xr groff_ms 7 ,
with the
.Ar mspdf
groff extensions described in
.Qq Portable Document Format Publishing with GNU Troff
by Keith Marshall.
Neither are implemented in mandoc.