aboutsummaryrefslogtreecommitdiff
path: root/doc/strlwr.3
diff options
context:
space:
mode:
authoraxtloss <axtlos@getcryst.al>2024-07-13 13:32:53 +0200
committeraxtloss <axtlos@getcryst.al>2024-07-14 16:43:24 +0200
commit1a4696492e3cd478080e438950a7664a68fefcd6 (patch)
tree3b6e6658d5d56d3a28c6c83a8c6b64cffaa27555 /doc/strlwr.3
parent3e85fcb0270c9224ab95dac02c737e6676974c8e (diff)
downloadextlib-1a4696492e3cd478080e438950a7664a68fefcd6.tar.gz
extlib-1a4696492e3cd478080e438950a7664a68fefcd6.tar.bz2
Add manpages for each extlib function
Diffstat (limited to '')
-rw-r--r--doc/strlwr.341
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/strlwr.3 b/doc/strlwr.3
new file mode 100644
index 0000000..ca2e971
--- /dev/null
+++ b/doc/strlwr.3
@@ -0,0 +1,41 @@
+'\" t
+.\" Copyright 2024 axtlos (axtlos@disroot.org)
+.\"
+.\" SPDX-License-Identifier: BSD-3-Clause
+
+.TH strlwr 3 2024-07-14 "extlib"
+.SH NAME
+strlwr, strupr \- convert a string to upper/lowercase
+.SH LIBRARY
+extlib extended standard library
+.RI ( libextlib ", " \-lextlib )
+.SH SYNOPSIS
+.nf
+.B #include <extlib.h>
+.P
+.BI "char *strlwr (char *s);"
+.P
+.BI "char *strupr (char *s);"
+.P
+.fi
+.SH DESCRIPTION
+The
+.BR strlwr ()
+function converts
+.I *s
+to a lowercase version of itself.
+The
+.BR strupr ()
+function converts
+.I *s
+to an uppercase version of itself.
+In both functions
+.I *s
+will be consumed and cannot be used after the function completes.
+.fi
+.SH RETURN VALUE
+.BR strlwr ()
+and
+.BR strupr ()
+return the string in the appropriate case, the resulting string will have to be manually free'd.
+.\" SRC END