diff options
| -rw-r--r-- | gemtext_decode.3 | 20 | ||||
| -rw-r--r-- | gemtext_encode.3 | 2 | ||||
| -rw-r--r-- | gemtext_free.3 | 2 | ||||
| -rw-r--r-- | gemtext_text_new.3 | 101 | ||||
| -rw-r--r-- | gemtext_type.3 | 38 |
5 files changed, 151 insertions, 12 deletions
diff --git a/gemtext_decode.3 b/gemtext_decode.3 index 4c0a9aa..3dfc46f 100644 --- a/gemtext_decode.3 +++ b/gemtext_decode.3 @@ -52,16 +52,6 @@ family of functions except text specified in can consist of multiple lines and the returned value would be a list of .Em struct gemtext* terminated by a NULL pointer. -.Pp -pointers returned by -.Fn gemtext_decode -and it's wrappers should be freed using -.Xr gemtext_free(3) . -.Pp -pointers returned by -.Fn gemtext_list_decode -and it's wrappers should be freed using -.Xr gemtext_list_free(3) .Sh RETURN VALUES .Fn gemtext_decode , .Fn gemtext_decode_fd @@ -78,6 +68,16 @@ and return a list of .Em struct gemtext* terminated by NULL pointer, or NULL on error. +.Pp +Pointers returned by +.Fn gemtext_decode +and it's wrappers should be freed using +.Xr gemtext_free(3) . +.Pp +Pointers returned by +.Fn gemtext_list_decode +and it's wrappers should be freed using +.Xr gemtext_list_free(3) . .Sh SEE ALSO .Xr gemtext_encode 3 , .Xr gemtext_text_new 3 , diff --git a/gemtext_encode.3 b/gemtext_encode.3 index dc98d11..6a0c2bd 100644 --- a/gemtext_encode.3 +++ b/gemtext_encode.3 @@ -104,6 +104,6 @@ on error. .Xr gemtext_text_new 3 , .Xr gemtext_type 3 , .Xr gemtext_text_string 3 , -.Xr gemtext_free 3 . +.Xr gemtext_free 3 .Sh AUTHORS .An Ali Fardan Aq Mt raiz@stellarbound.space diff --git a/gemtext_free.3 b/gemtext_free.3 index 8078f3b..a213902 100644 --- a/gemtext_free.3 +++ b/gemtext_free.3 @@ -25,6 +25,6 @@ terminated by a NULL pointer. .Xr gemtext_encode 3 , .Xr gemtext_text_new 3 , .Xr gemtext_type 3 , -.Xr gemtext_text_string 3 . +.Xr gemtext_text_string 3 .Sh AUTHORS .An Ali Fardan Aq Mt raiz@stellarbound.space diff --git a/gemtext_text_new.3 b/gemtext_text_new.3 new file mode 100644 index 0000000..46d0e5e --- /dev/null +++ b/gemtext_text_new.3 @@ -0,0 +1,101 @@ +.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 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_free 3 +.Sh AUTHORS +.An Ali Fardan Aq Mt raiz@stellarbound.space diff --git a/gemtext_type.3 b/gemtext_type.3 new file mode 100644 index 0000000..0498e7e --- /dev/null +++ b/gemtext_type.3 @@ -0,0 +1,38 @@ +.Dd 2020-10-22 +.Dt gemtext 3 +.Os +.Sh NAME +.Nm gemtext_type +.Nd show gemtext line type +.Sh SYNOPSIS +.In gemtext.h +.Ft int +.Fn gemtext_type "struct gemtext *line" +.Sh DESCRIPTION +.Fn gemtext_type +returns the type of gemtext object specified in +.Em line . +.Sh TYPES +This is a list of all possible return values for +.Fn gemtext_type : +.Bd -literal -offset indent +#define GEMTEXT_TEXT 1 /* plain text line */ +#define GEMTEXT_LINK 2 /* link */ +#define GEMTEXT_PRE 3 /* preformatted text */ +#define GEMTEXT_H1 4 /* heading (level 1) */ +#define GEMTEXT_H2 5 /* heading (level 2) */ +#define GEMTEXT_H3 6 /* heading (level 3) */ +#define GEMTEXT_UL 7 /* unordered list */ +#define GEMTEXT_QT 8 /* quoteed text */ +.Ed +.Sh ERRORS +.Fn gemtext_type +never fails. +.Sh SEE ALSO +.Xr gemtext_decode 3 , +.Xr gemtext_encode 3 , +.Xr gemtext_text_new 3 , +.Xr gemtext_text_string 3 , +.Xr gemtext_free 3 +.Sh AUTHORS +.An Ali Fardan Aq Mt raiz@stellarbound.space |