Add a keyctl.3 manpage as an index for all the keyctl functions

Add a keyctl.3 manpage as an index for all the keyctl functions.  This means
that I don't have to alter every keyutils manpage each time a new function is
added, just to update the "See Also" sections.

Signed-off-by: David Howells <dhowells@redhat.com>

18 files changed, 106 insertions, 553 deletions

diff --git a/keyctl.3 b/keyctl.3
new file mode 100644
index 0000000..4ed4693
--- /dev/null
+++ b/keyctl.3
@@ -0,0 +1,85 @@
+.\"
+.\" Copyright (C) 2010 Red Hat, Inc. All Rights Reserved.
+.\" Written by David Howells (dhowells@redhat.com)
+.\"
+.\" This program is free software; you can redistribute it and/or
+.\" modify it under the terms of the GNU General Public Licence
+.\" as published by the Free Software Foundation; either version
+.\" 2 of the Licence, or (at your option) any later version.
+.\"
+.TH KEYCTL 3 "18 Mar 2010" Linux "Linux Key Management Calls"
+.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.SH NAME
+keyctl_*() \- Key management function wrappers
+.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.SH DESCRIPTION
+The
+.BR keyctl ()
+system call is a multiplexor for a number of key management functions.  These
+should be called via the wrappers in the libkeyutils library.
+.P
+The functions can be compiled in by including the keyutils header file:
+.sp
+.RS
+.nf
+.B #include <keyutils.h>
+.RE
+.P
+and then telling the linker it should link in the library:
+.sp
+.RS
+.nf
+.B -lkeyutils
+.RE
+.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.SH KEYCTL FUNCTIONS
+.BR keyctl_assume_authority (3)
+.br
+.BR keyctl_clear (3)
+.br
+.BR keyctl_describe (3)
+.br
+.BR keyctl_describe_alloc (3)
+.br
+.BR keyctl_get_keyring_ID (3)
+.br
+.BR keyctl_instantiate (3)
+.br
+.BR keyctl_join_session_keyring (3)
+.br
+.BR keyctl_link (3)
+.br
+.BR keyctl_negate (3)
+.br
+.BR keyctl_read (3)
+.br
+.BR keyctl_read_alloc (3)
+.br
+.BR keyctl_revoke (3)
+.br
+.BR keyctl_search (3)
+.br
+.BR keyctl_security (3)
+.br
+.BR keyctl_security_alloc (3)
+.br
+.BR keyctl_set_reqkey_keyring (3)
+.br
+.BR keyctl_set_timeout (3)
+.br
+.BR keyctl_setperm (3)
+.br
+.BR keyctl_unlink (3)
+.br
+.BR keyctl_update (3)
+.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.SH SEE ALSO
+.BR keyctl (1),
+.br
+.BR add_key (2),
+.br
+.BR keyctl (2),
+.br
+.BR request_key (2),
+.br
+.BR request-key (8)
diff --git a/keyctl_chown.3 b/keyctl_chown.3
index 23dc30d..2492ec1 100644
--- a/keyctl_chown.3
+++ b/keyctl_chown.3
@@ -83,40 +83,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_join_session_keyring (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_describe_alloc (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_clear.3 b/keyctl_clear.3
index 3ec29b6..87e543e 100644
--- a/keyctl_clear.3
+++ b/keyctl_clear.3
@@ -68,40 +68,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_join_session_keyring (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_describe_alloc (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_describe.3 b/keyctl_describe.3
index 473bca5..e125ab8 100644
--- a/keyctl_describe.3
+++ b/keyctl_describe.3
@@ -105,38 +105,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_join_session_keyring (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_get_keyring_ID.3 b/keyctl_get_keyring_ID.3
index b0e2fd0..be9660d 100644
--- a/keyctl_get_keyring_ID.3
+++ b/keyctl_get_keyring_ID.3
@@ -91,40 +91,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_join_session_keyring (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_describe_alloc (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_instantiate.3 b/keyctl_instantiate.3
index 2240597..6c9dd29 100644
--- a/keyctl_instantiate.3
+++ b/keyctl_instantiate.3
@@ -150,36 +150,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_join_session_keyring (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_describe_alloc (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_join_session_keyring.3 b/keyctl_join_session_keyring.3
index b1a3cba..ffbb805 100644
--- a/keyctl_join_session_keyring.3
+++ b/keyctl_join_session_keyring.3
@@ -77,40 +77,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_describe_alloc (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_link.3 b/keyctl_link.3
index b1f599d..f62549e 100644
--- a/keyctl_link.3
+++ b/keyctl_link.3
@@ -103,38 +103,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_join_session_keyring (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_describe_alloc (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_read.3 b/keyctl_read.3
index f0257b5..34c43ef 100644
--- a/keyctl_read.3
+++ b/keyctl_read.3
@@ -104,38 +104,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_join_session_keyring (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_describe_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_revoke.3 b/keyctl_revoke.3
index 47eb227..212c776 100644
--- a/keyctl_revoke.3
+++ b/keyctl_revoke.3
@@ -68,40 +68,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_join_session_keyring (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_describe_alloc (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_search.3 b/keyctl_search.3
index 162a5e1..368584c 100644
--- a/keyctl_search.3
+++ b/keyctl_search.3
@@ -133,40 +133,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_join_session_keyring (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_describe_alloc (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_security.3 b/keyctl_security.3
index 2da7ea8..4383f2b 100644
--- a/keyctl_security.3
+++ b/keyctl_security.3
@@ -95,42 +95,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_join_session_keyring (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_describe_alloc (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_session_to_parent.3 b/keyctl_session_to_parent.3
index 50c68f7..a0da527 100644
--- a/keyctl_session_to_parent.3
+++ b/keyctl_session_to_parent.3
@@ -70,40 +70,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_describe_alloc (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_set_reqkey_keyring.3 b/keyctl_set_reqkey_keyring.3
index 02d9733..fc5946e 100644
--- a/keyctl_set_reqkey_keyring.3
+++ b/keyctl_set_reqkey_keyring.3
@@ -93,40 +93,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_join_session_keyring (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_describe_alloc (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_set_timeout.3 b/keyctl_set_timeout.3
index 3fbb46c..6d6e774 100644
--- a/keyctl_set_timeout.3
+++ b/keyctl_set_timeout.3
@@ -76,40 +76,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_join_session_keyring (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_describe_alloc (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_setperm.3 b/keyctl_setperm.3
index 12ddff3..9bf90f5 100644
--- a/keyctl_setperm.3
+++ b/keyctl_setperm.3
@@ -125,40 +125,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_join_session_keyring (3),
-.br
-.BR keyctl_update (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_describe_alloc (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyctl_update.3 b/keyctl_update.3
index 4ac19d4..ac460c0 100644
--- a/keyctl_update.3
+++ b/keyctl_update.3
@@ -91,40 +91,6 @@ should be specified to the linker.
 .br
 .BR request_key (2),
 .br
-.BR keyctl_get_keyring_ID (3),
-.br
-.BR keyctl_join_session_keyring (3),
-.br
-.BR keyctl_revoke (3),
-.br
-.BR keyctl_chown (3),
-.br
-.BR keyctl_setperm (3),
-.br
-.BR keyctl_describe (3),
-.br
-.BR keyctl_clear (3),
-.br
-.BR keyctl_link (3),
-.br
-.BR keyctl_unlink (3),
-.br
-.BR keyctl_search (3),
-.br
-.BR keyctl_read (3),
-.br
-.BR keyctl_instantiate (3),
-.br
-.BR keyctl_negate (3),
-.br
-.BR keyctl_set_reqkey_keyring (3),
-.br
-.BR keyctl_set_timeout (3),
-.br
-.BR keyctl_assume_authority (3),
-.br
-.BR keyctl_describe_alloc (3),
-.br
-.BR keyctl_read_alloc (3),
+.BR keyctl (3),
 .br
 .BR request-key (8)
diff --git a/keyutils.spec b/keyutils.spec
index 57238f4..7c0469e 100644
--- a/keyutils.spec
+++ b/keyutils.spec
@@ -6,7 +6,7 @@
 Summary: Linux Key Management Utilities
 Name: keyutils
 Version: %{version}
-Release: 2%{?dist}
+Release: 3%{?dist}
 License: GPLv2+ and LGPLv2+
 Group: System Environment/Base
 ExclusiveOS: Linux
@@ -89,6 +89,10 @@ rm -rf $RPM_BUILD_ROOT
 %{_mandir}/man3/*
 
 %changelog
+* Fri Mar 19 2010 David Howells  <dhowells@redhat.com> - 1.3-3
+- Fix spelling mistakes in manpages.
+- Add an index manpage for all the keyctl functions.
+
 * Thu Mar 11 2010 David Howells  <dhowells@redhat.com> - 1.3-2
 - Fix rpmlint warnings.