aboutsummaryrefslogtreecommitdiff
path: root/lib/krb5/krb5_parse_name.cat3
diff options
context:
space:
mode:
Diffstat (limited to 'lib/krb5/krb5_parse_name.cat3')
-rw-r--r--lib/krb5/krb5_parse_name.cat333
1 files changed, 16 insertions, 17 deletions
diff --git a/lib/krb5/krb5_parse_name.cat3 b/lib/krb5/krb5_parse_name.cat3
index f142b9e1f824..5799ef31bfee 100644
--- a/lib/krb5/krb5_parse_name.cat3
+++ b/lib/krb5/krb5_parse_name.cat3
@@ -1,30 +1,29 @@
-
KRB5_PARSE_NAME(3) BSD Library Functions Manual KRB5_PARSE_NAME(3)
-NNAAMMEE
- kkrrbb55__ppaarrssee__nnaammee -- string to principal conversion
+NAME
+ krb5_parse_name -- string to principal conversion
-LLIIBBRRAARRYY
+LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
-SSYYNNOOPPSSIISS
- ##iinncclluuddee <<kkrrbb55..hh>>
+SYNOPSIS
+ #include <krb5.h>
- _k_r_b_5___e_r_r_o_r___c_o_d_e
- kkrrbb55__ppaarrssee__nnaammee(_k_r_b_5___c_o_n_t_e_x_t _c_o_n_t_e_x_t, _c_o_n_s_t _c_h_a_r _*_n_a_m_e,
- _k_r_b_5___p_r_i_n_c_i_p_a_l _*_p_r_i_n_c_i_p_a_l);
+ krb5_error_code
+ krb5_parse_name(krb5_context context, const char *name,
+ krb5_principal *principal);
-DDEESSCCRRIIPPTTIIOONN
- kkrrbb55__ppaarrssee__nnaammee() converts a string representation of a principal name to
- kkrrbb55__pprriinncciippaall. The _p_r_i_n_c_i_p_a_l will point to allocated data that should
- be freed with kkrrbb55__ffrreeee__pprriinncciippaall().
+DESCRIPTION
+ krb5_parse_name() converts a string representation of a principal name to
+ krb5_principal. The principal will point to allocated data that should
+ be freed with krb5_free_principal().
The string should consist of one or more name components separated with
- slashes (``/''), optionally followed with an ``@'' and a realm name. A
- slash or @ may be contained in a name component by quoting it with a
- backslash (``\''). A realm should not contain slashes or colons.
+ slashes ("/"), optionally followed with an "@" and a realm name. A slash
+ or @ may be contained in a name component by quoting it with a backslash
+ ("\"). A realm should not contain slashes or colons.
-SSEEEE AALLSSOO
+SEE ALSO
krb5_build_principal(3), krb5_free_principal(3),
krb5_sname_to_principal(3), krb5_unparse_name(3)