aboutsummaryrefslogtreecommitdiff
path: root/doc/replace_str.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/replace_str.3
parent3e85fcb0270c9224ab95dac02c737e6676974c8e (diff)
downloadextlib-1a4696492e3cd478080e438950a7664a68fefcd6.tar.gz
extlib-1a4696492e3cd478080e438950a7664a68fefcd6.tar.bz2
Add manpages for each extlib function
Diffstat (limited to 'doc/replace_str.3')
-rw-r--r--doc/replace_str.334
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/replace_str.3 b/doc/replace_str.3
new file mode 100644
index 0000000..230f6d1
--- /dev/null
+++ b/doc/replace_str.3
@@ -0,0 +1,34 @@
+'\" t
+.\" Copyright 2024 axtlos (axtlos@disroot.org)
+.\"
+.\" SPDX-License-Identifier: BSD-3-Clause
+
+.TH replace_str 3 2024-07-14 "extlib"
+.SH NAME
+replace_str \- replace a substring in a string
+.SH LIBRARY
+extlib extended standard library
+.RI ( libextlib ", " \-lextlib )
+.SH SYNOPSIS
+.nf
+.B #include <extlib.h>
+.P
+.BI "char *replace_str (char *s, char *old, char *replace);"
+.P
+.fi
+.SH DESCRIPTION
+The
+.BR replace_str ()
+function replaces any matches of
+.I *old
+in the string
+.I *s
+with the string
+.IR *replace .
+.fi
+.SH RETURN VALUE
+.BR replace_str ()
+returns a copy of
+.I *s
+with all the substrings replaced.
+.\" SRC END