Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
LOWDOWN_TERM_NEW(3)	    Library Functions Manual	   LOWDOWN_TERM_NEW(3)

NAME
       lowdown_term_new	-- allocate a Markdown terminal	renderer

LIBRARY
       library "liblowdown"

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

       void *
       lowdown_term_new(const struct lowdown_opts *opts);

DESCRIPTION
       Allocates   a   terminal	  renderer   using  variables  in  the	struct
       lowdown_opts_term structure.  Its 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).

       The  bits  recognised  in  opts->oflags	 are   LOWDOWN_TERM_SHORTLINK,
       LOWDOWN_TERM_NOCOLOUR, and LOWDOWN_TERM_NOLINK.

RETURN VALUES
       Returns	a  pointer to the renderer or NULL on memory failure.  The re-
       turned pointer must be freed with lowdown_term_free(3).

EXAMPLES
       The following parses b of length	bsz and	outputs	in ANSI	terminal  for-
       mat.

	     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 config-
       ured to display links.

FreeBSD	Ports 14.quarterly	  $Mdocdate$		   LOWDOWN_TERM_NEW(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=lowdown_term_new&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help