Add a small kstrdup.9 manpage.
authorSascha Wildner <saw@online.de>
Thu, 14 Jan 2016 13:05:28 +0000 (14:05 +0100)
committerSascha Wildner <saw@online.de>
Thu, 14 Jan 2016 13:05:28 +0000 (14:05 +0100)
share/man/man9/Makefile
share/man/man9/kmalloc.9
share/man/man9/kstrdup.9 [new file with mode: 0644]

index 80d738e..18c229f 100644 (file)
@@ -112,6 +112,7 @@ MAN=        accept_filter.9 \
        kobj.9 \
        kprintf.9 \
        ksignal.9 \
+       kstrdup.9 \
        ktr.9 \
        lock.9 \
         locking.9 \
index 9f7f5d7..8d9fd64 100644 (file)
@@ -311,5 +311,6 @@ message.
 .Sh SEE ALSO
 .Xr vmstat 8 ,
 .Xr contigmalloc 9 ,
+.Xr kstrdup 9 ,
 .Xr memory 9 ,
 .Xr vnode 9
diff --git a/share/man/man9/kstrdup.9 b/share/man/man9/kstrdup.9
new file mode 100644 (file)
index 0000000..4f92cbf
--- /dev/null
@@ -0,0 +1,55 @@
+.\"
+.\" Copyright (c) 2016 The DragonFly Project.  All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in
+.\"    the documentation and/or other materials provided with the
+.\"    distribution.
+.\" 3. Neither the name of The DragonFly Project nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific, prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
+.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
+.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd January 14, 2016
+.Dt KSTRDUP 9
+.Os
+.Sh NAME
+.Nm kstrdup
+.Nd save a copy of a string
+.Sh SYNOPSIS
+.In sys/malloc.h
+.Ft char *
+.Fn kstrdup "const char *str" "struct malloc_type *type"
+.Sh DESCRIPTION
+The
+.Fn strdup
+function
+allocates sufficient memory of type
+.Fa type
+for a copy of the string
+.Fa str ,
+does the copy, and returns a pointer to it.
+The pointer may subsequently be used as an
+argument to the function
+.Xr kfree 9 .
+.Sh SEE ALSO
+.Xr kfree 9 ,
+.Xr kmalloc 9