.Dd 2020-10-22
.Dt gemtext 3
.Os
.Sh NAME
.Nm gemtext_text_new ,
.Nm gemtext_link_new ,
.Nm gemtext_pre_new ,
.Nm gemtext_h1_new ,
.Nm gemtext_h2_new ,
.Nm gemtext_h3_new ,
.Nm gemtext_ul_new ,
.Nm gemtext_qt_new
.Nd create gemtext objects
.Sh SYNOPSIS
.In gemtext.h
.Ft struct gemtext *
.Fn gemtext_text_new "const char *text"
.Ft struct gemtext *
.Fo gemtext_link_new
.Fa "const char *link"
.Fa "const char *label"
.Fc
.Ft struct gemtext *
.Fn gemtext_pre_new "const char *pre"
.Ft struct gemtext *
.Fn gemtext_h1_new "const char *h1"
.Ft struct gemtext *
.Fn gemtext_h2_new "const char *h2"
.Ft struct gemtext *
.Fn gemtext_h3_new "const char *h3"
.Ft struct gemtext *
.Fn gemtext_ul_new "const char *ul"
.Ft struct gemtext *
.Fn gemtext_qt_new "const char *qt"
.Sh DESCRIPTION
.Fn gemtext_text_new
returns a gemtext object of type
.Nm GEMTEXT_TEXT
containing text provided in
.Em text .
.Pp
.Fn gemtext_link_new
returns a gemtext object of type
.Nm GEMTEXT_LINK
where
.Em link
is the link and
.Em label
is an optional label that can be discarded by setting to NULL.
.Pp
.Fn gemtext_pre_new
returns a gemtext object of type
.Nm GEMTEXT_PRE
containing text provided in
.Em pre .
.Pp
.Fn gemtext_h1_new ,
.Fn gemtext_h2_new
and
.Fn gemtext_h3_new
return a gemtext object of type
.Nm GEMTEXT_H1 ,
.Nm GEMTEXT_H2 ,
.Nm GEMTEXT_H3
respectively.
.Pp
.Fn gemtext_ul_new
returns a gemtext object of type
.Nm GEMTEXT_UL
containing text provided in
.Em ul .
.Pp
.Fn gemtext_qt_new
returns a gemtext object of type
.Nm GEMTEXT_QT
containing text provided in
.Em qt .
.Sh RETURN VALUES
.Fn gemtext_text_new ,
.Fn gemtext_link_new ,
.Fn gemtext_pre_new ,
.Fn gemtext_h1_new ,
.Fn gemtext_h2_new ,
.Fn gemtext_h3_new ,
.Fn gemtext_ul_new
and
.Fn gemtext_qt_new
return a valid pointer to
.Em struct gemtext
upon success, or NULL on error.
.Pp
Pointers returned by all above functions should be freed using
.Xr gemtext_free 3 .
.Sh SEE ALSO
.Xr gemtext_decode 3 ,
.Xr gemtext_encode 3 ,
.Xr gemtext_type 3 ,
.Xr gemtext_text_string 3 ,
.Xr gemtext_text_strlen 3 ,
.Xr gemtext_list_append 3 ,
.Xr gemtext_free 3
.Sh AUTHORS
.An Ali Fardan Aq Mt raiz@stellarbound.space