From 04017fc7a4ca85f49b9c4c9419b7dd53500adb1d Mon Sep 17 00:00:00 2001 From: Allan Jude Date: Thu, 21 May 2015 03:32:44 +0000 Subject: [PATCH] Create links to the libprocstat man pages for all of the libprocstat functions so they can be looked up by name Add a cross refrence to libprocstat in the procstat.1 man page Differential Revision: https://reviews.freebsd.org/D2578 Suggested by: jmg Reviewed by: brueffer Approved by: wblock (mentor) MFC after: 1 week Sponsored by: ScaleEngine Inc. --- lib/libprocstat/Makefile | 30 +++++++++++++++++++ lib/libprocstat/libprocstat.3 | 55 ++++++++++++++++++----------------- usr.bin/procstat/procstat.1 | 3 +- 3 files changed, 60 insertions(+), 28 deletions(-) diff --git a/lib/libprocstat/Makefile b/lib/libprocstat/Makefile index ff9146b4ef38..fc71dbcb666d 100644 --- a/lib/libprocstat/Makefile +++ b/lib/libprocstat/Makefile @@ -22,6 +22,36 @@ SHLIB_MAJOR= 1 LIBADD= elf kvm util MAN= libprocstat.3 +MLINKS+=libprocstat.3 procstat_close.3 \ + libprocstat.3 procstat_freeargv.3 \ + libprocstat.3 procstat_freeauxv.3 \ + libprocstat.3 procstat_freeenvv.3 \ + libprocstat.3 procstat_freefiles.3 \ + libprocstat.3 procstat_freegroups.3 \ + libprocstat.3 procstat_freekstack.3 \ + libprocstat.3 procstat_freeprocs.3 \ + libprocstat.3 procstat_freevmmap.3 \ + libprocstat.3 procstat_get_pipe_info.3 \ + libprocstat.3 procstat_get_pts_info.3 \ + libprocstat.3 procstat_get_sem_info.3 \ + libprocstat.3 procstat_get_shm_info.3 \ + libprocstat.3 procstat_get_socket_info.3 \ + libprocstat.3 procstat_get_vnode_info.3 \ + libprocstat.3 procstat_getargv.3 \ + libprocstat.3 procstat_getauxv.3 \ + libprocstat.3 procstat_getenvv.3 \ + libprocstat.3 procstat_getfiles.3 \ + libprocstat.3 procstat_getgroups.3 \ + libprocstat.3 procstat_getkstack.3 \ + libprocstat.3 procstat_getosrel.3 \ + libprocstat.3 procstat_getpathname.3 \ + libprocstat.3 procstat_getprocs.3 \ + libprocstat.3 procstat_getrlimit.3 \ + libprocstat.3 procstat_getumask.3 \ + libprocstat.3 procstat_getvmmap.3 \ + libprocstat.3 procstat_open_core.3 \ + libprocstat.3 procstat_open_kvm.3 \ + libprocstat.3 procstat_open_sysctl.3 # XXX This is a hack. .if ${MK_CDDL} != "no" diff --git a/lib/libprocstat/libprocstat.3 b/lib/libprocstat/libprocstat.3 index 1c1f811e6017..e8be41c532e1 100644 --- a/lib/libprocstat/libprocstat.3 +++ b/lib/libprocstat/libprocstat.3 @@ -24,25 +24,11 @@ .\" .\" $FreeBSD$ .\" -.Dd May 3, 2013 +.Dd May 18, 2015 .Dt LIBPROCSTAT 3 .Os .Sh NAME -.Nm procstat_open_core , -.Nm procstat_open_kvm , -.Nm procstat_open_sysctl , .Nm procstat_close , -.Nm procstat_getargv , -.Nm procstat_getauxv , -.Nm procstat_getenvv , -.Nm procstat_getfiles , -.Nm procstat_getgroups , -.Nm procstat_getkstack , -.Nm procstat_getosrel , -.Nm procstat_getpathname , -.Nm procstat_getprocs , -.Nm procstat_getumask , -.Nm procstat_getvmmap , .Nm procstat_freeargv , .Nm procstat_freeauxv , .Nm procstat_freeenvv , @@ -56,7 +42,22 @@ .Nm procstat_get_sem_info , .Nm procstat_get_shm_info , .Nm procstat_get_socket_info , -.Nm procstat_get_vnode_info +.Nm procstat_get_vnode_info , +.Nm procstat_getargv , +.Nm procstat_getauxv , +.Nm procstat_getenvv , +.Nm procstat_getfiles , +.Nm procstat_getgroups , +.Nm procstat_getkstack , +.Nm procstat_getosrel , +.Nm procstat_getpathname , +.Nm procstat_getprocs , +.Nm procstat_getrlimit , +.Nm procstat_getumask , +.Nm procstat_getvmmap , +.Nm procstat_open_core , +.Nm procstat_open_kvm , +.Nm procstat_open_sysctl .Nd library interface for file and process information retrieval .Sh LIBRARY .Lb libprocstat @@ -175,24 +176,17 @@ .Fa "struct kinfo_proc *kp" .Fa "unsigned int *count" .Fc -.Ft int -.Fo procstat_getosrel -.Fa "struct procstat *procstat" -.Fa "struct kinfo_proc *kp" -.Fa "int *osrelp" -.Fc .Ft "struct kinfo_kstack *" .Fo procstat_getkstack .Fa "struct procstat *procstat" .Fa "struct kinfo_proc *kp" .Fa "unsigned int *count" .Fc -.Ft "struct kinfo_proc *" -.Fo procstat_getprocs +.Ft int +.Fo procstat_getosrel .Fa "struct procstat *procstat" -.Fa "int what" -.Fa "int arg" -.Fa "unsigned int *count" +.Fa "struct kinfo_proc *kp" +.Fa "int *osrelp" .Fc .Ft "int" .Fo procstat_getpathname @@ -201,6 +195,13 @@ .Fa "char *pathname" .Fa "size_t maxlen" .Fc +.Ft "struct kinfo_proc *" +.Fo procstat_getprocs +.Fa "struct procstat *procstat" +.Fa "int what" +.Fa "int arg" +.Fa "unsigned int *count" +.Fc .Ft "int" .Fo procstat_getrlimit .Fa "struct procstat *procstat" diff --git a/usr.bin/procstat/procstat.1 b/usr.bin/procstat/procstat.1 index 3ef39ebc0c2b..0fd314f5a701 100644 --- a/usr.bin/procstat/procstat.1 +++ b/usr.bin/procstat/procstat.1 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd March 10, 2015 +.Dd May 18, 2015 .Dt PROCSTAT 1 .Os .Sh NAME @@ -530,6 +530,7 @@ auxiliary vector value .Xr sockstat 1 , .Xr cap_enter 2 , .Xr cap_rights_limit 2 , +.Xr libprocstat 3 , .Xr ddb 4 , .Xr stack 9 .Sh AUTHORS