link.2: Use .Fn and add .Nm linkat
[dragonfly.git] / lib / libc / sys / kldnext.2
1 .\"
2 .\" Copyright (c) 1999 Chris Costello
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 .\" SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD: src/lib/libc/sys/kldnext.2,v 1.5.2.6 2001/12/14 18:34:01 ru Exp $
27 .\" $DragonFly: src/lib/libc/sys/kldnext.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
28 .\"
29 .Dd March 3, 1999
30 .Dt KLDNEXT 2
31 .Os
32 .Sh NAME
33 .Nm kldnext
34 .Nd return the fileid of the next kld file
35 .Sh LIBRARY
36 .Lb libc
37 .Sh SYNOPSIS
38 .In sys/param.h
39 .In sys/linker.h
40 .Ft int
41 .Fn kldnext "int fileid"
42 .Sh DESCRIPTION
43 The function
44 .Fn kldnext
45 returns the fileid of the next kld file (that is, the one after
46 .Va fileid )
47 or 0 if
48 .Va fileid
49 is the last file loaded.
50 .Sh RETURN VALUES
51 .Fn kldnext
52 returns the fileid of the next kld file (see DESCRIPTION) or 0.  If an error
53 occurs,
54 .Va errno
55 is set to indicate the error.
56 .Sh ERRORS
57 The only error set by
58 .Fn kldnext
59 is
60 .Er ENOENT ,
61 which is set when
62 .Va fileid
63 refers to a kld file that does not exist (isn't loaded).
64 .Sh SEE ALSO
65 .Xr kldfind 2 ,
66 .Xr kldfirstmod 2 ,
67 .Xr kldload 2 ,
68 .Xr kldstat 2 ,
69 .Xr kldsym 2 ,
70 .Xr kldunload 2 ,
71 .Xr modfind 2 ,
72 .Xr modfnext 2 ,
73 .Xr modnext 2 ,
74 .Xr modstat 2 ,
75 .Xr kld 4 ,
76 .Xr kldstat 8
77 .Sh HISTORY
78 The
79 .Nm kld
80 interface first appeared in
81 .Fx 3.0 .