diff options
| author | Ali Fardan <raiz@stellarbound.space> | 2020-10-23 16:23:32 +0300 |
|---|---|---|
| committer | Ali Fardan <raiz@stellarbound.space> | 2020-10-23 16:23:32 +0300 |
| commit | b3d5ce68acdeafe6a9c28bc25b44db8061d7ccce (patch) | |
| tree | 0fd288be7e89ca635934b78a638d98c18fe935a7 | |
| parent | 80174efa34409005b58ae6e7ccceb360940ccbf8 (diff) | |
| download | libgemtext-b3d5ce68acdeafe6a9c28bc25b44db8061d7ccce.tar.gz | |
manpages update, plus new manpage for gemtext_text_string(3)
| -rw-r--r-- | gemtext_text_new.3 | 2 | ||||
| -rw-r--r-- | gemtext_text_string.3 | 97 |
2 files changed, 98 insertions, 1 deletions
diff --git a/gemtext_text_new.3 b/gemtext_text_new.3 index 46d0e5e..9439056 100644 --- a/gemtext_text_new.3 +++ b/gemtext_text_new.3 @@ -89,7 +89,7 @@ return a valid pointer to .Em struct gemtext upon success, or NULL on error. .Pp -Pointers returned by all functions should be freed using +Pointers returned by all above functions should be freed using .Xr gemtext_free 3 . .Sh SEE ALSO .Xr gemtext_decode 3 , diff --git a/gemtext_text_string.3 b/gemtext_text_string.3 new file mode 100644 index 0000000..1e082a4 --- /dev/null +++ b/gemtext_text_string.3 @@ -0,0 +1,97 @@ +.Dd 2020-10-22 +.Dt gemtext 3 +.Os +.Sh NAME +.Nm gemtext_text_string , +.Nm gemtext_link_link_string , +.Nm gemtext_link_label_string , +.Nm gemtext_pre_string , +.Nm gemtext_h1_string , +.Nm gemtext_h2_string , +.Nm gemtext_h3_string , +.Nm gemtext_ul_string , +.Nm gemtext_qt_string +.Nd get string representation of gemtext objects +.Sh SYNOPSIS +.In "gemtext.h" +.Ft char * +.Fn gemtext_text_string "struct gemtext *line" +.Ft char * +.Fn gemtext_link_link_string "struct gemtext *line" +.Ft char * +.Fn gemtext_link_label_string "struct gemtext *line" +.Ft char * +.Fn gemtext_pre_string "struct gemtext *line" +.Ft char * +.Fn gemtext_h1_string "struct gemtext *line" +.Ft char * +.Fn gemtext_h2_string "struct gemtext *line" +.Ft char * +.Fn gemtext_h3_string "struct gemtext *line" +.Ft char * +.Fn gemtext_ul_string "struct gemtext *line" +.Ft char * +.Fn gemtext_qt_string "struct gemtext *line" +.Sh DESCRIPTION +Not to be confused with +.Xr gemtext_encode 3 +family of functions, these functions return the underlying string of a +.Em struct gemtext* +object, not the encoded +.Nm text/gemini +representation. +.Pp +.Fn gemtext_text_string +returns pointer to underlying string of +.Em line . +.Pp +.Fn gemtext_link_link_string +returns a pointer to underlying string of +.Em line +containing link. +.Pp +.Fn gemtext_link_label_string +returns a pointer to underlying string of +.Em line +containing link label. +.Pp +.Fn gemtext_pre_string +returns pointer to underlying string of +.Em line . +.Pp +.Fn gemtext_h1_string +returns pointer to underlying string of +.Em line . +.Pp +.Fn gemtext_h2_string +returns pointer to underlying string of +.Em line . +.Pp +.Fn gemtext_h3_string +returns pointer to underlying string of +.Em line . +.Pp +.Fn gemtext_ul_string +returns pointer to underlying string of +.Em line . +.Pp +.Fn gemtext_ul_string +returns pointer to underlying string of +.Em line . +.Pp +.Fn gemtext_qt_string +returns pointer to underlying string of +.Em line . +.Sh ERRORS +All above functions never fail. +.Sh RETURN VALUES +Pointers returned by all above functions should never be freed as they're a part of the object they're derived from. +Also, altering the value of data pointed to by returned pointer will affect the object they're derived from. +.Sh SEE ALSO +.Xr gemtext_decode 3 , +.Xr gemtext_encode 3 , +.Xr gemtext_type 3 , +.Xr gemtext_text_new 3 , +.Xr gemtext_free 3 +.Sh AUTHORS +.An Ali Fardan Aq Mt raiz@stellarbound.space |