Add filler man pages for the kinfo functions I added recently.
While here, hook up the hexdump(3) man page which wasn't being installed.
This commit is contained in:
parent
70ba1e8fc1
commit
ce4a8bcbee
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=185729
@ -30,7 +30,8 @@ MAN+= kld.3 login.3 login_auth.3 login_tty.3 logout.3 logwtmp.3 pty.3 \
|
||||
login_cap.3 login_class.3 login_times.3 login_ok.3 \
|
||||
_secure_path.3 uucplock.3 property.3 auth.3 realhostname.3 \
|
||||
realhostname_sa.3 trimdomain.3 fparseln.3 humanize_number.3 \
|
||||
pidfile.3 flopen.3 expand_number.3
|
||||
pidfile.3 flopen.3 expand_number.3 hexdump.3 \
|
||||
kinfo_getfile.3 kinfo_getvmmap.3
|
||||
MAN+= login.conf.5 auth.conf.5
|
||||
MLINKS+= kld.3 kld_isloaded.3 kld.3 kld_load.3
|
||||
MLINKS+= property.3 properties_read.3 property.3 properties_free.3
|
||||
|
74
lib/libutil/kinfo_getfile.3
Normal file
74
lib/libutil/kinfo_getfile.3
Normal file
@ -0,0 +1,74 @@
|
||||
.\"
|
||||
.\" Copyright (c) 2008 Peter Wemm
|
||||
.\" 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 December 6, 2008
|
||||
.Os
|
||||
.Dt KINFO_GETFILE 3
|
||||
.Sh NAME
|
||||
.Nm kinfo_getfile
|
||||
.Nd function for getting per-process file descriptor information
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.In sys/types.h
|
||||
.In libutil.h
|
||||
.Ft struct kinfo_file *
|
||||
.Fn kinfo_getfile "pid_t pid" "int *cntp"
|
||||
.Sh DESCRIPTION
|
||||
This function is used for obtaining the file descriptor information
|
||||
of a particular process.
|
||||
.Pp
|
||||
The
|
||||
.Ar pid
|
||||
field contains the process identifier.
|
||||
This should be the a process that you have privilige to access.
|
||||
The
|
||||
.Ar cntp
|
||||
field is allows the caller to know how many records are returned.
|
||||
.Pp
|
||||
This function is a wrapper around
|
||||
.Xr sysctl 3
|
||||
with the
|
||||
.Dv KERN_PROC_FILEDESC
|
||||
mib.
|
||||
While the kernel returns a packed structure, this function expands the
|
||||
data into a fixed record format.
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn kinfo_getfile
|
||||
function returns a pointer to an array of
|
||||
.Vt struct kinfo_file
|
||||
structures.
|
||||
The array was obtained by an internal call to
|
||||
.Xr malloc 3
|
||||
and must be freed by the caller with a call to
|
||||
.Xr free 3 .
|
||||
.Sh SEE ALSO
|
||||
.Xr free 3 ,
|
||||
.Xr kinfo_getvmmap 3 ,
|
||||
.Xr malloc 3 ,
|
||||
.Xr sysctl 3
|
73
lib/libutil/kinfo_getvmmap.3
Normal file
73
lib/libutil/kinfo_getvmmap.3
Normal file
@ -0,0 +1,73 @@
|
||||
.\"
|
||||
.\" Copyright (c) 2008 Peter Wemm
|
||||
.\" 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 December 6, 2008
|
||||
.Os
|
||||
.Dt KINFO_GETVMMAP 3
|
||||
.Sh NAME
|
||||
.Nm kinfo_getvmmap
|
||||
.Nd function for getting per-process memory map information
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.In sys/types.h
|
||||
.In libutil.h
|
||||
.Ft struct kinfo_vmentry *
|
||||
.Fn kinfo_getfile "pid_t pid" "int *cntp"
|
||||
.Sh DESCRIPTION
|
||||
This function is used for obtaining the file descriptor information
|
||||
of a particular process.
|
||||
.Pp
|
||||
The
|
||||
.Ar pid
|
||||
field contains the process identifier.
|
||||
This should be the a process that you have privilige to access.
|
||||
The
|
||||
.Ar cntp
|
||||
field is allows the caller to know how many records are returned.
|
||||
.Pp
|
||||
This function is a wrapper around
|
||||
.Xr sysctl 3
|
||||
with the
|
||||
.Dv KERN_PROC_VMMAP
|
||||
mib.
|
||||
While the kernel returns a packed structure, this function expands the
|
||||
data into a fixed record format.
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn kinfo_getvmmap
|
||||
function returns a pointer to an array of
|
||||
.Vt struct kinfo_vmentry
|
||||
structures.
|
||||
The array was obtained by an internal call to
|
||||
.Xr malloc 3
|
||||
and must be freed by the caller with a call to
|
||||
.Xr free 3 .
|
||||
.Sh SEE ALSO
|
||||
.Xr free 3 ,
|
||||
.Xr kinfo_getfile 3 ,
|
||||
.Xr malloc 3
|
Loading…
Reference in New Issue
Block a user