move to doxygen
git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@25102 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
@@ -1,93 +0,0 @@
|
||||
.\" Copyright (c) 2004 - 2006 Kungliga Tekniska Högskolan
|
||||
.\" (Royal Institute of Technology, Stockholm, Sweden).
|
||||
.\" 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.
|
||||
.\"
|
||||
.\" 3. Neither the name of the Institute nor the names of its contributors
|
||||
.\" may be used to endorse or promote products derived from this software
|
||||
.\" without specific prior written permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE 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 INSTITUTE 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.
|
||||
.\"
|
||||
.\" $Id$
|
||||
.\"
|
||||
.Dd May 5, 2006
|
||||
.Dt KRB5_EXPAND_HOSTNAME 3
|
||||
.Os HEIMDAL
|
||||
.Sh NAME
|
||||
.Nm krb5_expand_hostname ,
|
||||
.Nm krb5_expand_hostname_realms
|
||||
.Nd Kerberos 5 host name canonicalization functions
|
||||
.Sh LIBRARY
|
||||
Kerberos 5 Library (libkrb5, -lkrb5)
|
||||
.Sh SYNOPSIS
|
||||
.In krb5.h
|
||||
.Pp
|
||||
.Ft krb5_error_code
|
||||
.Fo krb5_expand_hostname
|
||||
.Fa "krb5_context context"
|
||||
.Fa "const char *orig_hostname"
|
||||
.Fa "char **new_hostname"
|
||||
.Fc
|
||||
.Ft krb5_error_code
|
||||
.Fo krb5_expand_hostname_realms
|
||||
.Fa "krb5_context context"
|
||||
.Fa "const char *orig_hostname"
|
||||
.Fa "char **new_hostname"
|
||||
.Fa "char ***realms"
|
||||
.Fc
|
||||
.Sh DESCRIPTION
|
||||
.Fn krb5_expand_hostname
|
||||
tries to make
|
||||
.Fa orig_hostname
|
||||
into a more canonical one in the newly allocated space returned in
|
||||
.Fa new_hostname .
|
||||
Caller must free the hostname with
|
||||
.Xr free 3 .
|
||||
.Pp
|
||||
.Fn krb5_expand_hostname_realms
|
||||
expands
|
||||
.Fa orig_hostname
|
||||
to a name we believe to be a hostname in newly
|
||||
allocated space in
|
||||
.Fa new_hostname
|
||||
and return the realms
|
||||
.Fa new_hostname
|
||||
is belive to belong to in
|
||||
.Fa realms .
|
||||
.Fa Realms
|
||||
is a array terminated with
|
||||
.Dv NULL .
|
||||
Caller must free the
|
||||
.Fa realms
|
||||
with
|
||||
.Fn krb5_free_host_realm
|
||||
and
|
||||
.Fa new_hostname
|
||||
with
|
||||
.Xr free 3 .
|
||||
.Sh SEE ALSO
|
||||
.Xr krb5 3 ,
|
||||
.Xr krb5_free_host_realm 3 ,
|
||||
.Xr krb5_get_host_realm 3 ,
|
||||
.Xr kerberos 8
|
Reference in New Issue
Block a user