[src/trunk]: src/crypto/dist/heimdal/lib/krb5 Customise documentation for Net...

To: source-changes-hg%NetBSD.org@localhost
Subject: [src/trunk]: src/crypto/dist/heimdal/lib/krb5 Customise documentation for Net...
From: gmcgarry <gmcgarry%NetBSD.org@localhost>
Date: Fri, 24 Jan 2020 09:58:26 +0000
details:   https://anonhg.NetBSD.org/src/rev/65f894278690
branches:  trunk
changeset: 517207:65f894278690
user:      gmcgarry <gmcgarry%NetBSD.org@localhost>
date:      Thu Nov 08 19:47:37 2001 +0000

description:
Customise documentation for NetBSD:

- introduce krb5.3 as an entry-point to libkrb5 documentation
- add LIBRARY sections
- reference the real headers in <krb5/krb5.h>

diffstat:

 crypto/dist/heimdal/lib/krb5/krb5.3                      |  150 +++++++++++++++
 crypto/dist/heimdal/lib/krb5/krb5_425_conv_principal.3   |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_appdefault.3           |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_auth_context.3         |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_build_principal.3      |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_config.3               |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_context.3              |    4 +-
 crypto/dist/heimdal/lib/krb5/krb5_create_checksum.3      |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_crypto_init.3          |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_encrypt.3              |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_free_principal.3       |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_get_all_client_addrs.3 |    7 +-
 crypto/dist/heimdal/lib/krb5/krb5_get_krbhst.3           |    9 +-
 crypto/dist/heimdal/lib/krb5/krb5_init_context.3         |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_keytab.3               |    8 +-
 crypto/dist/heimdal/lib/krb5/krb5_krbhst_init.3          |    9 +-
 crypto/dist/heimdal/lib/krb5/krb5_openlog.3              |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_parse_name.3           |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_principal_get_realm.3  |    8 +-
 crypto/dist/heimdal/lib/krb5/krb5_sname_to_principal.3   |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_timeofday.3            |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_unparse_name.3         |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_verify_user.3          |    6 +-
 crypto/dist/heimdal/lib/krb5/krb5_warn.3                 |    6 +-
 24 files changed, 246 insertions(+), 51 deletions(-)

diffs (truncated from 666 to 300 lines):

diff -r d31febc82b01 -r 65f894278690 crypto/dist/heimdal/lib/krb5/krb5.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/crypto/dist/heimdal/lib/krb5/krb5.3       Thu Nov 08 19:47:37 2001 +0000
@@ -0,0 +1,150 @@
+.\" $Id: krb5.3,v 1.1 2001/11/08 19:47:37 gmcgarry Exp $
+.\"
+.Dd November 8, 2001
+.Dt krb5 3
+.Os
+.Sh NAME
+.Nm krb5
+.Nd kerberos 5 library
+.Sh LIBRARY
+Kerberos 5 Library (libkrb5, -lkrb5)
+.Sh DESCRIPTION
+These functions constitute the kerberos 5 library,
+.Em libkrb5 .
+Declarations for these functions may be obtained from the include file
+.Pa krb5/krb5.h .
+.Sh LIST OF FUNCTIONS
+.sp 2
+.nf
+.ta \w'krb5_checksum_is_collision_proof.3'u+2n +\w'Description goes here'u
+\fIName/Page\fP        \fIDescription\fP
+.ta \w'krb5_checksum_is_collision_proof.3'u+2n +\w'Description goes here'u+6nC
+.sp 5p
+krb5_425_conv_principal.3
+krb5_425_conv_principal_ext.3
+krb5_524_conv_principal.3
+krb5_addlog_dest.3
+krb5_addlog_func.3
+krb5_appdefault_boolean.3
+krb5_appdefault_string.3
+krb5_appdefault_time.3
+krb5_auth_con_free.3
+krb5_auth_con_genaddrs.3
+krb5_auth_con_getaddrs.3
+krb5_auth_con_getflags.3
+krb5_auth_con_getkey.3
+krb5_auth_con_getlocalsubkey.3
+krb5_auth_con_getrcache.3
+krb5_auth_con_getremotesubkey.3
+krb5_auth_con_getuserkey.3
+krb5_auth_con_init.3
+krb5_auth_con_initivector.3
+krb5_auth_con_setaddrs.3
+krb5_auth_con_setaddrs_from_fd.3
+krb5_auth_con_setflags.3
+krb5_auth_con_setivector.3
+krb5_auth_con_setkey.3
+krb5_auth_con_setlocalsubkey.3
+krb5_auth_con_setrcache.3
+krb5_auth_con_setremotesubkey.3
+krb5_auth_con_setuserkey.3
+krb5_auth_context.3
+krb5_auth_getauthenticator.3
+krb5_auth_getcksumtype.3
+krb5_auth_getkeytype.3
+krb5_auth_getlocalseqnumber.3
+krb5_auth_getremoteseqnumber.3
+krb5_auth_setcksumtype.3
+krb5_auth_setkeytype.3
+krb5_auth_setlocalseqnumber.3
+krb5_auth_setremoteseqnumber.3
+krb5_build_principal.3
+krb5_build_principal_ext.3
+krb5_build_principal_va.3
+krb5_build_principal_va_ext.3
+krb5_checksum_is_collision_proof.3
+krb5_checksum_is_keyed.3
+krb5_checksumsize.3
+krb5_closelog.3
+krb5_config_get_bool_default.3
+krb5_config_get_int_default.3
+krb5_config_get_string_default.3
+krb5_config_get_time_default.3
+krb5_context.3
+krb5_create_checksum.3
+krb5_crypto_destroy.3
+krb5_crypto_init.3
+krb5_decrypt.3
+krb5_decrypt_EncryptedData.3
+krb5_encrypt.3
+krb5_encrypt_EncryptedData.3
+krb5_err.3
+krb5_errx.3
+krb5_free_context.3
+krb5_free_krbhst.3
+krb5_free_principal.3
+krb5_get_all_client_addrs.3
+krb5_get_all_server_addrs.3
+krb5_get_krb524hst.3
+krb5_get_krb_admin_hst.3
+krb5_get_krb_changepw_hst.3
+krb5_get_krbhst.3
+krb5_init_context.3
+krb5_initlog.3
+krb5_keytab_entry.3
+krb5_krbhst_format_string.3
+krb5_krbhst_free.3
+krb5_krbhst_get_addrinfo.3
+krb5_krbhst_init.3
+krb5_krbhst_next.3
+krb5_krbhst_next_as_string.3
+krb5_krbhst_reset.3
+krb5_kt_add_entry.3
+krb5_kt_close.3
+krb5_kt_compare.3
+krb5_kt_copy_entry_contents.3
+krb5_kt_cursor.3
+krb5_kt_cursor.3
+krb5_kt_default.3
+krb5_kt_default_name.3
+krb5_kt_end_seq_get.3
+krb5_kt_free_entry.3
+krb5_kt_get_entry.3
+krb5_kt_get_name.3
+krb5_kt_next_entry.3
+krb5_kt_ops.3
+krb5_kt_read_service_key.3
+krb5_kt_register.3
+krb5_kt_remove_entry.3
+krb5_kt_resolve.3.3
+krb5_kt_start_seq_get
+krb5_log.3
+krb5_log_msg.3
+krb5_make_principal.3
+krb5_openlog.3
+krb5_parse_name.3
+krb5_principal.3
+krb5_principal_get_comp_string.3
+krb5_principal_get_realm.3
+krb5_set_warn_dest.3
+krb5_sname_to_principal.3
+krb5_sock_to_principal.3
+krb5_timeofday.3
+krb5_unparse_name.3
+krb5_us_timeofday.3
+krb5_verify_checksum.3
+krb5_verify_user.3
+krb5_verify_user_lrealm.3
+krb5_verr.3
+krb5_verrx.3
+krb5_vlog.3
+krb5_vlog_msg.3
+krb5_vwarn.3
+krb5_vwarnx.3
+krb5_warn.3
+krb5_warnx.3
+.ta
+.Fi
+.Sh SEE ALSO
+.Xr krb5.conf 5 ,
+.Xr kerberos 8
diff -r d31febc82b01 -r 65f894278690 crypto/dist/heimdal/lib/krb5/krb5_425_conv_principal.3
--- a/crypto/dist/heimdal/lib/krb5/krb5_425_conv_principal.3    Thu Nov 08 19:39:10 2001 +0000
+++ b/crypto/dist/heimdal/lib/krb5/krb5_425_conv_principal.3    Thu Nov 08 19:47:37 2001 +0000
@@ -1,5 +1,5 @@
 .\" Copyright (c) 1997 Kungliga Tekniska Högskolan
-.\" $Id: krb5_425_conv_principal.3,v 1.3 2001/06/19 22:39:58 assar Exp $
+.\" $Id: krb5_425_conv_principal.3,v 1.4 2001/11/08 19:47:37 gmcgarry Exp $
 .Dd April 11, 1999
 .Dt KRB5_425_CONV_PRINCIPAL 3
 .Os
@@ -8,8 +8,10 @@
 .Nm krb5_425_conv_principal_ext ,
 .Nm krb5_524_conv_principal
 .Nd converts to and from version 4 principals
+.Sh LIBRARY
+Kerberos 5 Library (libkrb5, -lkrb5)
 .Sh SYNOPSIS
-.Fd #include <krb5.h>
+.Fd #include <krb5/krb5.h>
 .Ft krb5_error_code
 .Fn krb5_425_conv_principal "krb5_context context" "const char *name" "const char *instance" "const char *realm" "krb5_principal *principal"
 .Ft krb5_error_code
diff -r d31febc82b01 -r 65f894278690 crypto/dist/heimdal/lib/krb5/krb5_appdefault.3
--- a/crypto/dist/heimdal/lib/krb5/krb5_appdefault.3    Thu Nov 08 19:39:10 2001 +0000
+++ b/crypto/dist/heimdal/lib/krb5/krb5_appdefault.3    Thu Nov 08 19:47:37 2001 +0000
@@ -1,5 +1,5 @@
 .\" Copyright (c) 2000 Kungliga Tekniska Högskolan
-.\" $Id: krb5_appdefault.3,v 1.4 2001/09/17 12:32:38 assar Exp $
+.\" $Id: krb5_appdefault.3,v 1.5 2001/11/08 19:47:37 gmcgarry Exp $
 .Dd July 25, 2000
 .Dt KRB5_APPDEFAULT 3
 .Os
@@ -8,8 +8,10 @@
 .Nm krb5_appdefault_string ,
 .Nm krb5_appdefault_time
 .Nd get application configuration value
+.Sh LIBRARY
+Kerberos 5 Library (libkrb5, -lkrb5)
 .Sh SYNOPSIS
-.Fd #include <krb5.h>
+.Fd #include <krb5/krb5.h>
 .Ft void
 .Fn krb5_appdefault_boolean "krb5_context context" "const char *appname" "krb5_realm realm" "const char *option" "krb5_boolean def_val" "krb5_boolean *ret_val"
 .Ft void
diff -r d31febc82b01 -r 65f894278690 crypto/dist/heimdal/lib/krb5/krb5_auth_context.3
--- a/crypto/dist/heimdal/lib/krb5/krb5_auth_context.3  Thu Nov 08 19:39:10 2001 +0000
+++ b/crypto/dist/heimdal/lib/krb5/krb5_auth_context.3  Thu Nov 08 19:47:37 2001 +0000
@@ -1,5 +1,5 @@
 .\" Copyright (c) 2001 Kungliga Tekniska Högskolan
-.\" $Id: krb5_auth_context.3,v 1.4 2001/06/05 12:19:35 wiz Exp $
+.\" $Id: krb5_auth_context.3,v 1.5 2001/11/08 19:47:37 gmcgarry Exp $
 .Dd January 21, 2001
 .Dt KRB5_AUTH_CONTEXT 3
 .Os
@@ -35,8 +35,10 @@
 .Nm krb5_auth_con_initivector ,
 .Nm krb5_auth_con_setivector
 .Nd manage authetication on connection level
+.Sh LIBRARY
+Kerberos 5 Library (libkrb5, -lkrb5)
 .Sh SYNOPSIS
-.Fd #include <krb5.h>
+.Fd #include <krb5/krb5.h>
 .Ft krb5_error_code
 .Fo krb5_auth_con_init
 .Fa "krb5_context context"
diff -r d31febc82b01 -r 65f894278690 crypto/dist/heimdal/lib/krb5/krb5_build_principal.3
--- a/crypto/dist/heimdal/lib/krb5/krb5_build_principal.3       Thu Nov 08 19:39:10 2001 +0000
+++ b/crypto/dist/heimdal/lib/krb5/krb5_build_principal.3       Thu Nov 08 19:47:37 2001 +0000
@@ -1,5 +1,5 @@
 .\" Copyright (c) 1997 Kungliga Tekniska Högskolan
-.\" $Id: krb5_build_principal.3,v 1.3 2001/06/19 22:39:58 assar Exp $
+.\" $Id: krb5_build_principal.3,v 1.4 2001/11/08 19:47:37 gmcgarry Exp $
 .Dd August 8, 1997
 .Dt KRB5_BUILD_PRINCIPAL 3
 .Os
@@ -10,8 +10,10 @@
 .Nm krb5_build_principal_va_ext ,
 .Nm krb5_make_principal
 .Nd principal creation functions
+.Sh LIBRARY
+Kerberos 5 Library (libkrb5, -lkrb5)
 .Sh SYNOPSIS
-.Fd #include <krb5.h>
+.Fd #include <krb5/krb5.h>
 .Ft krb5_error_code
 .Fn krb5_build_principal "krb5_context context" "krb5_principal *principal" "int realm_len" "krb5_const_realm realm" "..."
 .Ft krb5_error_code
diff -r d31febc82b01 -r 65f894278690 crypto/dist/heimdal/lib/krb5/krb5_config.3
--- a/crypto/dist/heimdal/lib/krb5/krb5_config.3        Thu Nov 08 19:39:10 2001 +0000
+++ b/crypto/dist/heimdal/lib/krb5/krb5_config.3        Thu Nov 08 19:47:37 2001 +0000
@@ -1,5 +1,5 @@
 .\" Copyright (c) 2000 Kungliga Tekniska Högskolan
-.\" $Id: krb5_config.3,v 1.3 2001/06/19 22:39:58 assar Exp $
+.\" $Id: krb5_config.3,v 1.4 2001/11/08 19:47:37 gmcgarry Exp $
 .Dd July 25, 2000
 .Dt KRB5_CONFIG 3
 .Os
@@ -9,8 +9,10 @@
 .Nm krb5_config_get_string_default ,
 .Nm krb5_config_get_time_default
 .Nd get configuration value
+.Sh LIBRARY
+Kerberos 5 Library (libkrb5, -lkrb5)
 .Sh SYNOPSIS
-.Fd #include <krb5.h>
+.Fd #include <krb5/krb5.h>
 .Ft krb5_boolean
 .Fn krb5_config_get_bool_default "krb5_context context" "krb5_config_section *c" "krb5_boolean def_value" "..."
 .Ft int
diff -r d31febc82b01 -r 65f894278690 crypto/dist/heimdal/lib/krb5/krb5_context.3
--- a/crypto/dist/heimdal/lib/krb5/krb5_context.3       Thu Nov 08 19:39:10 2001 +0000
+++ b/crypto/dist/heimdal/lib/krb5/krb5_context.3       Thu Nov 08 19:47:37 2001 +0000
@@ -1,11 +1,13 @@
 .\" Copyright (c) 2001 Kungliga Tekniska Högskolan
-.\" $Id: krb5_context.3,v 1.4 2001/09/17 12:32:38 assar Exp $
+.\" $Id: krb5_context.3,v 1.5 2001/11/08 19:47:37 gmcgarry Exp $
 .Dd January 21, 2001
 .Dt KRB5_CONTEXT 3
 .Os
 .Sh NAME
 .Nm krb5_context
 .Nd krb5 state structure
+.Sh LIBRARY
+Kerberos 5 Library (libkrb5, -lkrb5)
 .Sh DESCRIPTION
 The
 .Nm
diff -r d31febc82b01 -r 65f894278690 crypto/dist/heimdal/lib/krb5/krb5_create_checksum.3
--- a/crypto/dist/heimdal/lib/krb5/krb5_create_checksum.3       Thu Nov 08 19:39:10 2001 +0000
+++ b/crypto/dist/heimdal/lib/krb5/krb5_create_checksum.3       Thu Nov 08 19:47:37 2001 +0000
@@ -1,5 +1,5 @@
 .\" Copyright (c) 1999 Kungliga Tekniska Högskolan
-.\" $Id: krb5_create_checksum.3,v 1.2 2001/06/05 10:19:10 wiz Exp $
+.\" $Id: krb5_create_checksum.3,v 1.3 2001/11/08 19:47:37 gmcgarry Exp $
 .Dd April  7, 1999
 .Dt NAME 3
 .Os
@@ -10,8 +10,10 @@
 .Nm krb5_create_checksum , 
 .Nm krb5_verify_checksum
 .Nd creates and verifies checksums
+.Sh LIBRARY
+Kerberos 5 Library (libkrb5, -lkrb5)
 .Sh SYNOPSIS
-.Fd #include <krb5.h>
Prev by Date: [src/trunk]: src/tools XXX...Complete hack for now.
Next by Date: [src/trunk]: src/lib/csu/arm_elf Quiet GCC warnings.
Previous by Thread: [src/trunk]: src/tools XXX...Complete hack for now.
Next by Thread: [src/trunk]: src/lib/csu/arm_elf Quiet GCC warnings.
Indexes:
Home | Main Index | Thread Index | Old Index