summaryrefslogtreecommitdiffstats
path: root/lib/libc/sys/modnext.2
diff options
context:
space:
mode:
authorpeter <peter@FreeBSD.org>2000-09-28 22:39:59 +0000
committerpeter <peter@FreeBSD.org>2000-09-28 22:39:59 +0000
commit13282b896864dd0d93120062a1001858cfaf3ed9 (patch)
treec938df5f07783d72d550ebf9c202a20e20fa04c7 /lib/libc/sys/modnext.2
parent9cd7f92a8872f85ae87cd8fbe02d0f0010351f18 (diff)
downloadFreeBSD-src-13282b896864dd0d93120062a1001858cfaf3ed9.zip
FreeBSD-src-13282b896864dd0d93120062a1001858cfaf3ed9.tar.gz
Add man pages for mod*(2). Shamelessly cut/pasted from the kld*(2) man
pages by Chris Costello.
Diffstat (limited to 'lib/libc/sys/modnext.2')
-rw-r--r--lib/libc/sys/modnext.284
1 files changed, 84 insertions, 0 deletions
diff --git a/lib/libc/sys/modnext.2 b/lib/libc/sys/modnext.2
new file mode 100644
index 0000000..2e301f8
--- /dev/null
+++ b/lib/libc/sys/modnext.2
@@ -0,0 +1,84 @@
+.\"
+.\" Copyright (c) 1999 Chris Costello
+.\" 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.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd September 28, 2000
+.Dt MODNEXT 2
+.Os FreeBSD
+.Sh NAME
+.Nm modnext
+.Nd return the modid of the next kernel module
+.Sh LIBRARY
+.Lb libc
+.Sh SYNOPSIS
+.Fd #include <sys/param.h>
+.Fd #include <sys/module.h>
+.Ft int
+.Fn modnext "int modid"
+.Ft int
+.Fn modfnext "int modid"
+.Sh DESCRIPTION
+The function
+.Fn modnext
+returns the modid of the next kernel module (that is, the one after
+.Va modid )
+or 0 if
+.Va modid
+is the last module in the list.
+.Pp
+If the
+.Va modid
+value is 0, then
+.Fn modnext
+will return the modid of the first module.
+.Fn modfnext
+must always be given a valid modid.
+.Sh RETURN VALUES
+.Fn modnext
+returns the modid of the next module (see DESCRIPTION) or 0. If an error
+occurs,
+.Va errno
+is set to indicate the error.
+.Sh ERRORS
+The only error set by
+.Fn modnext
+is ENOENT, which is set when
+.Va modid
+refers to a kernel module that does not exist (isn't loaded).
+.Sh SEE ALSO
+.Xr kldfind 2 ,
+.Xr kldfirstmod 2 ,
+.Xr kldload 2 ,
+.Xr kldstat 2 ,
+.Xr kldunload 2 ,
+.Xr modfind 2 ,
+.Xr modstat 2 ,
+.Xr kld 4
+.Sh HISTORY
+The
+.Nm kld
+interface first appeared in
+.Fx 3.0 .
OpenPOWER on IntegriCloud