freebsd-skq/lib/libc/sys/kldnext.2

.\"
.\" 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 February 22, 2006
.Dt KLDNEXT 2
.Os
.Sh NAME
.Nm kldnext
.Nd return the fileid of the next kld file
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In sys/param.h
.In sys/linker.h
.Ft int
.Fn kldnext "int fileid"
.Sh DESCRIPTION
The
.Fn kldnext
system call
returns the fileid of the next kld file (that is, the one after
.Fa fileid )
or 0 if
.Fa fileid
is the last file loaded.
To get the fileid of the first kld file, pass
.Fa fileid
of 0 to
.Fn kldnext .
.Sh RETURN VALUES
The
.Fn kldnext
system call
returns the fileid of the next kld file or 0 if successful.
Otherwise
.Fn kldnext
returns the value \-1 and sets the global variable
.Va errno
to indicate the error.
.Sh ERRORS
The only error set by
.Fn kldnext
is
.Er ENOENT ,
which is set when
.Fa fileid
refers to a kld file that does not exist (is not loaded).
.Sh SEE ALSO
.Xr kldfind 2 ,
.Xr kldfirstmod 2 ,
.Xr kldload 2 ,
.Xr kldstat 2 ,
.Xr kldsym 2 ,
.Xr kldunload 2 ,
.Xr modfind 2 ,
.Xr modfnext 2 ,
.Xr modnext 2 ,
.Xr modstat 2 ,
.Xr kld 4 ,
.Xr kldstat 8
.Sh HISTORY
The
.Nm kld
interface first appeared in
.Fx 3.0 .
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.\"`
			`.\" 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.`
			`.\"`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`.\" $FreeBSD$`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.\"`
Tell the truth about a) how to get the first fileid, and b) what return values from kldstat(2) can be expected. Bump .Dd. MFC after: 3 days 2006-02-22 15:11:12 +00:00			`.Dd February 22, 2006`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Dt KLDNEXT 2`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 13:41:46 +00:00			`.Os`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Sh NAME`
			`.Nm kldnext`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`.Nd return the fileid of the next kld file`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/param.h`
			`.In sys/linker.h`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Ft int`
			`.Fn kldnext "int fileid"`
			`.Sh DESCRIPTION`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`The`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Fn kldnext`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`returns the fileid of the next kld file (that is, the one after`
Markup fixes. 2006-09-17 21:27:35 +00:00			`.Fa fileid )`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`or 0 if`
Markup fixes. 2006-09-17 21:27:35 +00:00			`.Fa fileid`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`is the last file loaded.`
Tell the truth about a) how to get the first fileid, and b) what return values from kldstat(2) can be expected. Bump .Dd. MFC after: 3 days 2006-02-22 15:11:12 +00:00			`To get the fileid of the first kld file, pass`
Markup fixes. 2006-09-17 21:27:35 +00:00			`.Fa fileid`
Tell the truth about a) how to get the first fileid, and b) what return values from kldstat(2) can be expected. Bump .Dd. MFC after: 3 days 2006-02-22 15:11:12 +00:00			`of 0 to`
			`.Fn kldnext .`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Sh RETURN VALUES`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`The`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Fn kldnext`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call`
Tell the truth about a) how to get the first fileid, and b) what return values from kldstat(2) can be expected. Bump .Dd. MFC after: 3 days 2006-02-22 15:11:12 +00:00			`returns the fileid of the next kld file or 0 if successful.`
			`Otherwise`
			`.Fn kldnext`
			`returns the value \-1 and sets the global variable`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Va errno`
Tell the truth about a) how to get the first fileid, and b) what return values from kldstat(2) can be expected. Bump .Dd. MFC after: 3 days 2006-02-22 15:11:12 +00:00			`to indicate the error.`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Sh ERRORS`
			`The only error set by`
			`.Fn kldnext`
mdoc(7) police: Er macro usage cleanup. 2000-11-22 16:02:00 +00:00			`is`
			`.Er ENOENT ,`
			`which is set when`
Markup fixes. 2006-09-17 21:27:35 +00:00			`.Fa fileid`
Expand *n't contractions. 2005-02-13 22:25:33 +00:00			`refers to a kld file that does not exist (is not loaded).`
Fix the NAME section of the kldload.2 manpage, which made reference to kldunload. Add proper cross-references to the whole family. PR: 12472 Submitted by: Chris Costello <chris@calldei.com> 1999-07-01 12:16:06 +00:00			`.Sh SEE ALSO`
			`.Xr kldfind 2 ,`
			`.Xr kldfirstmod 2 ,`
			`.Xr kldload 2 ,`
			`.Xr kldstat 2 ,`
Add cross-references for the new kldsym(2) man page. 2001-07-27 03:03:36 +00:00			`.Xr kldsym 2 ,`
Fix the NAME section of the kldload.2 manpage, which made reference to kldunload. Add proper cross-references to the whole family. PR: 12472 Submitted by: Chris Costello <chris@calldei.com> 1999-07-01 12:16:06 +00:00			`.Xr kldunload 2 ,`
Add man pages for mod(2). Shamelessly cut/pasted from the kld(2) man pages by Chris Costello. 2000-09-28 22:39:59 +00:00			`.Xr modfind 2 ,`
Unify SEE ALSO sections of the kld.2 and mod.2 manpages. Previously, some useful xrefs were missing. Now each of the pages refers to all remaining section 2 pages, to the kld(4) page, and to a related utility's (section 8) page. 2001-07-24 07:59:54 +00:00			`.Xr modfnext 2 ,`
Add man pages for mod(2). Shamelessly cut/pasted from the kld(2) man pages by Chris Costello. 2000-09-28 22:39:59 +00:00			`.Xr modnext 2 ,`
			`.Xr modstat 2 ,`
Unify SEE ALSO sections of the kld.2 and mod.2 manpages. Previously, some useful xrefs were missing. Now each of the pages refers to all remaining section 2 pages, to the kld(4) page, and to a related utility's (section 8) page. 2001-07-24 07:59:54 +00:00			`.Xr kld 4 ,`
			`.Xr kldstat 8`
Manpages for the KLD system calls. PR: docs/10412 Submitted by: Chris Costello <chris@calldei.com> 1999-04-04 12:29:31 +00:00			`.Sh HISTORY`
			`The`
			`.Nm kld`
mdoc(7) style fix: FreeBSD -> .Fx Reviewed by: mpp 1999-09-05 06:47:01 +00:00			`interface first appeared in`
			`.Fx 3.0 .`