From 123f083d26fd3195d7f7496f48d0718d71dda3f1 Mon Sep 17 00:00:00 2001 From: Assar Westerlund Date: Fri, 26 Jan 2001 22:46:29 +0000 Subject: [PATCH] mdoc fixed from ru@freebsd.org git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@9512 ec53bebd-3082-4978-b11e-865c3cabbd6b --- kdc/kdc.8 | 1 - kuser/kinit.1 | 2 +- lib/krb5/krb5_425_conv_principal.3 | 9 --------- lib/krb5/krb5_build_principal.3 | 10 ---------- lib/krb5/krb5_create_checksum.3 | 6 ------ lib/krb5/krb5_crypto_init.3 | 4 ---- lib/krb5/krb5_encrypt.3 | 6 ------ lib/krb5/krb5_free_principal.3 | 5 ----- lib/krb5/krb5_openlog.3 | 23 ++++------------------- lib/krb5/krb5_parse_name.3 | 4 ---- lib/krb5/krb5_sname_to_principal.3 | 6 ------ lib/krb5/krb5_unparse_name.3 | 6 ------ lib/krb5/krb5_warn.3 | 12 ------------ 13 files changed, 5 insertions(+), 89 deletions(-) diff --git a/kdc/kdc.8 b/kdc/kdc.8 index a4a19c492..67624d2fa 100644 --- a/kdc/kdc.8 +++ b/kdc/kdc.8 @@ -25,7 +25,6 @@ Kerberos 5 server .Fl -ports= Ns Ar string Oc .Xc .Op Fl -addresses= Ns Ar list of addresses - .Sh DESCRIPTION .Nm serves requests for tickets. When it starts, it first checks the flags diff --git a/kuser/kinit.1 b/kuser/kinit.1 index 5e19146ab..bafe227be 100644 --- a/kuser/kinit.1 +++ b/kuser/kinit.1 @@ -147,7 +147,7 @@ Request an anonymous ticket (which means that the ticket will be issued to an anonymous principal, typically .Dq anonymous@REALM). .El - +.Pp The following options are only available if .Nm has been compiled with support for Kerberos 4. The diff --git a/lib/krb5/krb5_425_conv_principal.3 b/lib/krb5/krb5_425_conv_principal.3 index 626b82cb5..6c5d6e60c 100644 --- a/lib/krb5/krb5_425_conv_principal.3 +++ b/lib/krb5/krb5_425_conv_principal.3 @@ -8,21 +8,15 @@ .Nm krb5_425_conv_principal_ext , .Nm krb5_524_conv_principal .Nd Converts to and from version 4 principals - .Sh SYNOPSIS .Fd #include - .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 .Fn krb5_425_conv_principal_ext "krb5_context context" "const char *name" "const char *instance" "const char *realm" "krb5_boolean (*func)(krb5_context, krb5_principal)" "krb5_boolean resolve" "krb5_principal *principal" - .Ft krb5_error_code .Fn krb5_524_conv_principal "krb5_context context" "const krb5_principal principal" "char *name" "char *instance" "char *realm" - .Sh DESCRIPTION - Converting between version 4 and version 5 principals can at best be described as a mess. .Pp @@ -124,9 +118,7 @@ instances found to belong to a host principal. The and .Fa realm should be at least 40 characters long. - .Sh EXAMPLES - Since this is confusing an example is in place. .Pp Assume that we have the @@ -188,7 +180,6 @@ the second example will result in .Dq ftp/b-host.foo.com (because of the default domain). And all of this is of course only valid if you have working name resolving. - .Sh SEE ALSO .Xr krb5_build_principal 3 , .Xr krb5_free_principal 3 , diff --git a/lib/krb5/krb5_build_principal.3 b/lib/krb5/krb5_build_principal.3 index 9848017bb..f49b05416 100644 --- a/lib/krb5/krb5_build_principal.3 +++ b/lib/krb5/krb5_build_principal.3 @@ -10,28 +10,19 @@ .Nm krb5_build_principal_va_ext , .Nm krb5_make_principal .Nd Principal creation functions - .Sh SYNOPSIS .Fd #include - .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 .Fn krb5_build_principal_ext "krb5_context context" "krb5_principal *principal" "int realm_len" "krb5_const_realm realm" "..." - .Ft krb5_error_code .Fn krb5_build_principal_va "krb5_context context" "krb5_principal *principal" "int realm_len" "krb5_const_realm realm" "va_list ap" - .Ft krb5_error_code .Fn krb5_build_principal_va_ext "krb5_context context" "krb5_principal *principal" "int realm_len" "krb5_const_realm realm" "va_list ap" - .Ft krb5_error_code .Fn krb5_make_principal "krb5_context context" "krb5_principal *principal" "krb5_const_realm realm" "..." - - .Sh DESCRIPTION - These functions create a Kerberos 5 principal from a realm and a list of components. All of these functions return an allocated principal in the @@ -65,7 +56,6 @@ is a wrapper around If the realm is .Dv NULL , the default realm will be used. - .Sh BUGS You can not have a NUL in a component. Until someone can give a good example of where it would be a good idea to have NUL's in a component, diff --git a/lib/krb5/krb5_create_checksum.3 b/lib/krb5/krb5_create_checksum.3 index 05f18559f..56a8cf6d7 100644 --- a/lib/krb5/krb5_create_checksum.3 +++ b/lib/krb5/krb5_create_checksum.3 @@ -12,19 +12,14 @@ .Nd creates and verifies checksums .Sh SYNOPSIS .Fd #include - .Ft krb5_error_code .Fn krb5_create_checksum "krb5_context context" "krb5_crypto crypto" "unsigned usage_or_type" "void *data" "size_t len" "Checksum *result" - .Ft krb5_error_code .Fn krb5_verify_checksum "krb5_context context" "krb5_crypto crypto" "krb5_key_usage usage" "void *data" "size_t len" "Checksum *cksum" - .Ft krb5_boolean .Fn krb5_checksum_is_collision_proof "krb5_context context" "krb5_cksumtype type" - .Ft krb5_boolean .Fn krb5_checksum_is_keyed "krb5_context context" "krb5_cksumtype type" - .Sh DESCRIPTION These functions are used to create and verify checksums. .Fn krb5_create_checksum @@ -60,7 +55,6 @@ value is a function of both the data, and a separate key). Examples of keyed hash algorithms are HMAC-SHA1-DES3, and RSA-MD5-DES. The .Dq plain hash functions MD5, and SHA1 are not keyed. - .\" .Sh EXAMPLE .\" .Sh BUGS .Sh SEE ALSO diff --git a/lib/krb5/krb5_crypto_init.3 b/lib/krb5/krb5_crypto_init.3 index c35fc3eac..407dfb24e 100644 --- a/lib/krb5/krb5_crypto_init.3 +++ b/lib/krb5/krb5_crypto_init.3 @@ -9,13 +9,10 @@ .Nd initialize encryption context .Sh SYNOPSIS .Fd #include - .Ft krb5_error_code .Fn krb5_crypto_init "krb5_context context" "krb5_keyblock *key" "krb5_enctype enctype" "krb5_crypto *crypto" - .Ft krb5_error_code .Fn krb5_crypto_destroy "krb5_context context" "krb5_crypto crypto" - .Sh DESCRIPTION These functions are used to initialize an encryption context that can be used to encrypt or checksum data. @@ -33,7 +30,6 @@ with the .Pp .Fn krb5_crypto_destroy frees a previously allocated encrypion context. - .\" .Sh EXAMPLE .\" .Sh BUGS .Sh SEE ALSO diff --git a/lib/krb5/krb5_encrypt.3 b/lib/krb5/krb5_encrypt.3 index 213bfe049..0577ac12d 100644 --- a/lib/krb5/krb5_encrypt.3 +++ b/lib/krb5/krb5_encrypt.3 @@ -11,19 +11,14 @@ .Nd encrypt and decrypt data .Sh SYNOPSIS .Fd #include - .Ft krb5_error_code .Fn krb5_encrypt "krb5_context context" "krb5_crypto crypto" "unsigned usage" "void *data" "size_t len" "krb5_data *result" - .Ft krb5_error_code .Fn krb5_encrypt_EncryptedData "krb5_context context" "krb5_crypto crypto" "unsigned usage" "void *data" "size_t len" "int kvno" "EncryptedData *result" - .Ft krb5_error_code .Fn krb5_decrypt "krb5_context context" "krb5_crypto crypto" "unsigned usage" "void *data" "size_t len" "krb5_data *result" - .Ft krb5_error_code .Fn krb5_decrypt_EncryptedData "krb5_context context" "krb5_crypto crypto" "unsigned usage" "EncryptedData *e" "krb5_data *result" - .Sh DESCRIPTION These functions are used to encrypt and decrypt data. .Pp @@ -52,7 +47,6 @@ is not zero, it will be put in the and .Fn krb5_decrypt_EncryptedData works similarly. - .\" .Sh EXAMPLE .\" .Sh BUGS .Sh SEE ALSO diff --git a/lib/krb5/krb5_free_principal.3 b/lib/krb5/krb5_free_principal.3 index 53fcf16c8..ae35d812b 100644 --- a/lib/krb5/krb5_free_principal.3 +++ b/lib/krb5/krb5_free_principal.3 @@ -6,22 +6,17 @@ .Sh NAME .Nm krb5_free_principal .Nd Principal free function - .Sh SYNOPSIS .Fd #include - .Ft void .Fn krb5_free_principal "krb5_context context" "krb5_principal principal" - .Sh DESCRIPTION - The .Fn krb5_free_principal will free a principal that has been created with .Fn krb5_build_principal , .Fn krb5_parse_name , or with some other function. - .Sh SEE ALSO .Xr krb5_425_conv_principal 3 , .Xr krb5_build_principal 3 , diff --git a/lib/krb5/krb5_openlog.3 b/lib/krb5/krb5_openlog.3 index 419a849cc..0e2fb0082 100644 --- a/lib/krb5/krb5_openlog.3 +++ b/lib/krb5/krb5_openlog.3 @@ -16,40 +16,28 @@ .Nd Heimdal logging functions .Sh SYNOPSIS .Fd #include - -.\" ouch! -.ds xx \\*(fP\fR(\fP\\*(lI*\\*(fP -.ds xy \fR)\|\fP -.Fn "\\*(lItypedef void \\*(xxkrb5_log_log_func_t\\*(xy" "const char *time" "const char *message" "void *data" -.Fn "\\*(lItypedef void \\*(xxkrb5_log_close_func_t\\*(xy" "void *data" - +.Ft "typedef void" +.Fn "\*(lp*krb5_log_log_func_t\*(rp" "const char *time" "const char *message" "void *data" +.Ft "typedef void" +.Fn "\*(lp*krb5_log_close_func_t\*(rp" "void *data" .Ft krb5_error_code .Fn krb5_addlog_dest "krb5_context context" "krb5_log_facility *facility" "const char *destination" - .Ft krb5_error_code .Fn krb5_addlog_func "krb5_context context" "krb5_log_facility *facility" "int min" "int max" "krb5_log_log_func_t log" "krb5_log_close_func_t close" "void *data" - .Ft krb5_error_code .Fn krb5_closelog "krb5_context context" "krb5_log_facility *facility" - .Ft krb5_error_code .Fn krb5_initlog "krb5_context context" "const char *program" "krb5_log_facility **facility" - .Ft krb5_error_code .Fn krb5_log "krb5_context context" "krb5_log_facility *facility" "int level" "const char *format" "..." - .Ft krb5_error_code .Fn krb5_log_msg "krb5_context context" "krb5_log_facility *facility" "char **reply" "int level" "const char *format" "..." - .Ft krb5_error_code .Fn krb5_openlog "krb5_context context" "const char *program" "krb5_log_facility **facility" - .Ft krb5_error_code .Fn krb5_vlog "krb5_context context" "krb5_log_facility *facility" "int level" "const char *format" "va_list arglist" - .Ft krb5_error_code .Fn krb5_vlog_msg "krb5_context context" "krb5_log_facility *facility" "char **reply" "int level" "const char *format" "va_list arglist" - .Sh DESCRIPTION These functions logs messages to one or more destinations. .Pp @@ -97,7 +85,6 @@ is a standard .Fn printf style format string (but see the BUGS section). .Pp - If you want better control of where things gets logged, you can instead of using .Fn krb5_openlog call @@ -135,9 +122,7 @@ calls and then calls .Fn krb5_addlog_dest for each destination found. - .Ss Destinations - The defined destinations (as specified in .Pa krb5.conf ) follows: diff --git a/lib/krb5/krb5_parse_name.3 b/lib/krb5/krb5_parse_name.3 index a58b1268d..66377a350 100644 --- a/lib/krb5/krb5_parse_name.3 +++ b/lib/krb5/krb5_parse_name.3 @@ -6,15 +6,11 @@ .Sh NAME .Nm krb5_parse_name .Nd String to principal conversion - .Sh SYNOPSIS .Fd #include - .Ft krb5_error_code .Fn krb5_parse_name "krb5_context context" "const char *name" "krb5_principal *principal" - .Sh DESCRIPTION - .Fn krb5_parse_name converts a string representation of a princpal name to .Nm krb5_principal . diff --git a/lib/krb5/krb5_sname_to_principal.3 b/lib/krb5/krb5_sname_to_principal.3 index f4d264ce1..336a6a3b1 100644 --- a/lib/krb5/krb5_sname_to_principal.3 +++ b/lib/krb5/krb5_sname_to_principal.3 @@ -7,18 +7,13 @@ .Nm krb5_sname_to_principal , .Nm krb5_sock_to_principal .Nd Create a service principal - .Sh SYNOPSIS .Fd #include - .Ft krb5_error_code .Fn krb5_sname_to_principal "krb5_context context" "const char *hostname" "const char *sname" "int32_t type" "krb5_principal *principal" - .Ft krb5_error_code .Fn krb5_sock_to_principal "krb5_context context" "int socket" "const char *sname" "int32_t type" "krb5_principal *principal" - .Sh DESCRIPTION - These functions create a .Dq service principal that can, for instance, be used to lookup a key in a keytab. For both these function the @@ -49,7 +44,6 @@ of the passed which should be a bound .Dv AF_INET socket. - .Sh SEE ALSO .Xr krb5_425_conv_principal 3 , .Xr krb5_build_principal 3 , diff --git a/lib/krb5/krb5_unparse_name.3 b/lib/krb5/krb5_unparse_name.3 index f86cd3b5a..c949ea212 100644 --- a/lib/krb5/krb5_unparse_name.3 +++ b/lib/krb5/krb5_unparse_name.3 @@ -7,25 +7,19 @@ .Nm krb5_unparse_name .\" .Nm krb5_unparse_name_ext .Nd Principal to string conversion - .Sh SYNOPSIS .Fd #include - .Ft krb5_error_code .Fn krb5_unparse_name "krb5_context context" "krb5_principal principal" "char **name" - .\" .Ft krb5_error_code .\" .Fn krb5_unparse_name_ext "krb5_context context" "krb5_const_principal principal" "char **name" "size_t *size" - .Sh DESCRIPTION - This function takes a .Fa principal , and will convert in to a printable representation with the same syntax as decribed in .Xr krb5_parse_name 3 . .Fa *name will point to allocated data and should be freed by the caller. - .Sh SEE ALSO .Xr krb5_425_conv_principal 3 , .Xr krb5_build_principal 3 , diff --git a/lib/krb5/krb5_warn.3 b/lib/krb5/krb5_warn.3 index bc824a9e8..4ba29ee87 100644 --- a/lib/krb5/krb5_warn.3 +++ b/lib/krb5/krb5_warn.3 @@ -16,36 +16,25 @@ .Nd Heimdal warning and error functions .Sh SYNOPSIS .Fd #include - .Ft krb5_error_code .Fn krb5_err "krb5_context context" "int eval" "krb5_error_code code" "const char *format" "..." - .Ft krb5_error_code .Fn krb5_errx "krb5_context context" "int eval" "const char *format" "..." - .Ft krb5_error_code .Fn krb5_verr "krb5_context context" "int eval" "krb5_error_code code" "const char *format" "va_list ap" - .Ft krb5_error_code .Fn krb5_verrx "krb5_context context" "int eval" "const char *format" "va_list ap" - .Ft krb5_error_code .Fn krb5_vwarn "krb5_context context" "krb5_error_code code" "const char *format" "va_list ap" - .Ft krb5_error_code .Fn krb5_vwarnx "krb5_context context" "const char *format" "va_list ap" - .Ft krb5_error_code .Fn krb5_warn "krb5_context context" "krb5_error_code code" "const char *format" "..." - .Ft krb5_error_code .Fn krb5_warnx "krb5_context context" "const char *format" "..." - .Ft krb5_error_code .Fn krb5_set_warn_dest "krb5_context context" "krb5_log_facility *facility" - .Sh DESCRIPTION - These functions prints a warning message to some destination. .Fa format is a printf style format specifying the message to print. The forms not ending in an @@ -68,6 +57,5 @@ Messages logged with the functions have a log level of 1, while the .Dq err functions logs with level 0. - .Sh SEE ALSO .Xr krb5_openlog 3