Commit manual pages after running 'man-update' and add new manual pages.
[dragonfly.git] / secure / lib / libcrypto / man / RSA_get_ex_new_index.3
index f1d097b..1f03894 100644 (file)
@@ -1,9 +1,9 @@
-.\" Automatically generated by Pod::Man version 1.15
-.\" Wed Feb 19 16:42:58 2003
-.\"
-.\" Standard preamble:
-.\" ======================================================================
-.de Sh \" Subsection heading
+.rn '' }`
+''' $RCSfile$$Revision$$Date$
+'''
+''' $Log$
+'''
+.de Sh
 .br
 .if t .Sp
 .ne 5
 \fB\\$1\fR
 .PP
 ..
-.de Sp \" Vertical space (when we can't use .PP)
+.de Sp
 .if t .sp .5v
 .if n .sp
 ..
-.de Ip \" List item
+.de Ip
 .br
 .ie \\n(.$>=3 .ne \\$3
 .el .ne 3
 .IP "\\$1" \\$2
 ..
-.de Vb \" Begin verbatim text
+.de Vb
 .ft CW
 .nf
 .ne \\$1
 ..
-.de Ve \" End verbatim text
+.de Ve
 .ft R
 
 .fi
 ..
-.\" Set up some character translations and predefined strings.  \*(-- will
-.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote.  | will give a
-.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
-.\" to do unbreakable dashes and therefore won't be available.  \*(C` and
-.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
+'''
+'''
+'''     Set up \*(-- to give an unbreakable dash;
+'''     string Tr holds user defined translation string.
+'''     Bell System Logo is used as a dummy character.
+'''
 .tr \(*W-|\(bv\*(Tr
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
-.    ds -- \(*W-
-.    ds PI pi
-.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
-.    ds L" ""
-.    ds R" ""
-.    ds C` ""
-.    ds C' ""
+.ds -- \(*W-
+.ds PI pi
+.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+.ds L" ""
+.ds R" ""
+'''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
+'''   \*(L" and \*(R", except that they are used on ".xx" lines,
+'''   such as .IP and .SH, which do another additional levels of
+'''   double-quote interpretation
+.ds M" """
+.ds S" """
+.ds N" """""
+.ds T" """""
+.ds L' '
+.ds R' '
+.ds M' '
+.ds S' '
+.ds N' '
+.ds T' '
 'br\}
 .el\{\
-.    ds -- \|\(em\|
-.    ds PI \(*p
-.    ds L" ``
-.    ds R" ''
+.ds -- \(em\|
+.tr \*(Tr
+.ds L" ``
+.ds R" ''
+.ds M" ``
+.ds S" ''
+.ds N" ``
+.ds T" ''
+.ds L' `
+.ds R' '
+.ds M' `
+.ds S' '
+.ds N' `
+.ds T' '
+.ds PI \(*p
 'br\}
-.\"
-.\" If the F register is turned on, we'll generate index entries on stderr
-.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
-.\" index entries marked with X<> in POD.  Of course, you'll have to process
-.\" the output yourself in some meaningful fashion.
-.if \nF \{\
-.    de IX
-.    tm Index:\\$1\t\\n%\t"\\$2"
+.\"    If the F register is turned on, we'll generate
+.\"    index entries out stderr for the following things:
+.\"            TH      Title 
+.\"            SH      Header
+.\"            Sh      Subsection 
+.\"            Ip      Item
+.\"            X<>     Xref  (embedded
+.\"    Of course, you have to process the output yourself
+.\"    in some meaninful fashion.
+.if \nF \{
+.de IX
+.tm Index:\\$1\t\\n%\t"\\$2"
 ..
-.    nr % 0
-.    rr F
+.nr % 0
+.rr F
 .\}
-.\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it
-.\" makes way too many mistakes in technical documents.
-.hy 0
+.TH RSA_get_ex_new_index 3 "0.9.7d" "2/Sep/2004" "OpenSSL"
+.UC
+.if n .hy 0
 .if n .na
-.\"
-.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
-.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.de CQ          \" put $1 in typewriter font
+.ft CW
+'if n "\c
+'if t \\&\\$1\c
+'if n \\&\\$1\c
+'if n \&"
+\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
+'.ft R
+..
+.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
+.      \" AM - accent mark definitions
 .bd B 3
-.    \" fudge factors for nroff and troff
+.      \" fudge factors for nroff and troff
 .if n \{\
-.    ds #H 0
-.    ds #V .8m
-.    ds #F .3m
-.    ds #[ \f1
-.    ds #] \fP
+.      ds #H 0
+.      ds #V .8m
+.      ds #F .3m
+.      ds #[ \f1
+.      ds #] \fP
 .\}
 .if t \{\
-.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-.    ds #V .6m
-.    ds #F 0
-.    ds #[ \&
-.    ds #] \&
+.      ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.      ds #V .6m
+.      ds #F 0
+.      ds #[ \&
+.      ds #] \&
 .\}
-.    \" simple accents for nroff and troff
+.      \" simple accents for nroff and troff
 .if n \{\
-.    ds ' \&
-.    ds ` \&
-.    ds ^ \&
-.    ds , \&
-.    ds ~ ~
-.    ds /
+.      ds ' \&
+.      ds ` \&
+.      ds ^ \&
+.      ds , \&
+.      ds ~ ~
+.      ds ? ?
+.      ds ! !
+.      ds /
+.      ds q
 .\}
 .if t \{\
-.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
-.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
-.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
-.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
-.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
-.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.      ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.      ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.      ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.      ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.      ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.      ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
+.      ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
+.      ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.      ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
 .\}
-.    \" troff and (daisy-wheel) nroff accents
+.      \" troff and (daisy-wheel) nroff accents
 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
+.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
+.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
+.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 .ds ae a\h'-(\w'a'u*4/10)'e
 .ds Ae A\h'-(\w'A'u*4/10)'E
-.    \" corrections for vroff
+.ds oe o\h'-(\w'o'u*4/10)'e
+.ds Oe O\h'-(\w'O'u*4/10)'E
+.      \" corrections for vroff
 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
-.    \" for low resolution devices (crt and lpr)
+.      \" for low resolution devices (crt and lpr)
 .if \n(.H>23 .if \n(.V>19 \
 \{\
-.    ds : e
-.    ds 8 ss
-.    ds o a
-.    ds d- d\h'-1'\(ga
-.    ds D- D\h'-1'\(hy
-.    ds th \o'bp'
-.    ds Th \o'LP'
-.    ds ae ae
-.    ds Ae AE
+.      ds : e
+.      ds 8 ss
+.      ds v \h'-1'\o'\(aa\(ga'
+.      ds _ \h'-1'^
+.      ds . \h'-1'.
+.      ds 3 3
+.      ds o a
+.      ds d- d\h'-1'\(ga
+.      ds D- D\h'-1'\(hy
+.      ds th \o'bp'
+.      ds Th \o'LP'
+.      ds ae ae
+.      ds Ae AE
+.      ds oe oe
+.      ds Oe OE
 .\}
 .rm #[ #] #H #V #F C
-.\" ======================================================================
-.\"
-.IX Title "RSA_get_ex_new_index 3"
-.TH RSA_get_ex_new_index 3 "0.9.7a" "2003-02-19" "OpenSSL"
-.UC
 .SH "NAME"
-RSA_get_ex_new_index, RSA_set_ex_data, RSA_get_ex_data \- add application specific data to \s-1RSA\s0 structures
+RSA_get_ex_new_index, RSA_set_ex_data, RSA_get_ex_data \- add application specific data to RSA structures
 .SH "SYNOPSIS"
-.IX Header "SYNOPSIS"
+.PP
 .Vb 1
 \& #include <openssl/rsa.h>
 .Ve
@@ -168,7 +215,6 @@ RSA_get_ex_new_index, RSA_set_ex_data, RSA_get_ex_data \- add application specif
 \&                int idx, long argl, void *argp);
 .Ve
 .SH "DESCRIPTION"
-.IX Header "DESCRIPTION"
 Several OpenSSL structures can have application specific data attached to them.
 This has several potential uses, it can be used to cache data associated with
 a structure (for example the hash of some part of the structure) or some
@@ -177,81 +223,96 @@ additional data (for example a handle to the data in an external library).
 Since the application data can be anything at all it is passed and retrieved
 as a \fBvoid *\fR type.
 .PP
-The \fB\f(BIRSA_get_ex_new_index()\fB\fR function is initially called to \*(L"register\*(R" some
+The \fBRSA_get_ex_new_index()\fR function is initially called to \*(L"register\*(R" some
 new application specific data. It takes three optional function pointers which
-are called when the parent structure (in this case an \s-1RSA\s0 structure) is
+are called when the parent structure (in this case an RSA structure) is
 initially created, when it is copied and when it is freed up. If any or all of
-these function pointer arguments are not used they should be set to \s-1NULL\s0. The
+these function pointer arguments are not used they should be set to NULL. The
 precise manner in which these function pointers are called is described in more
-detail below. \fB\f(BIRSA_get_ex_new_index()\fB\fR also takes additional long and pointer
+detail below. \fBRSA_get_ex_new_index()\fR also takes additional long and pointer
 parameters which will be passed to the supplied functions but which otherwise
 have no special meaning. It returns an \fBindex\fR which should be stored
 (typically in a static variable) and passed used in the \fBidx\fR parameter in
-the remaining functions. Each successful call to \fB\f(BIRSA_get_ex_new_index()\fB\fR
+the remaining functions. Each successful call to \fBRSA_get_ex_new_index()\fR
 will return an index greater than any previously returned, this is important
 because the optional functions are called in order of increasing index value.
 .PP
-\&\fB\f(BIRSA_set_ex_data()\fB\fR is used to set application specific data, the data is
+\fBRSA_set_ex_data()\fR is used to set application specific data, the data is
 supplied in the \fBarg\fR parameter and its precise meaning is up to the
 application.
 .PP
-\&\fB\f(BIRSA_get_ex_data()\fB\fR is used to retrieve application specific data. The data
+\fBRSA_get_ex_data()\fR is used to retrieve application specific data. The data
 is returned to the application, this will be the same value as supplied to
-a previous \fB\f(BIRSA_set_ex_data()\fB\fR call.
+a previous \fBRSA_set_ex_data()\fR call.
 .PP
-\&\fB\f(BInew_func()\fB\fR is called when a structure is initially allocated (for example
-with \fB\f(BIRSA_new()\fB\fR. The parent structure members will not have any meaningful
+\fBnew_func()\fR is called when a structure is initially allocated (for example
+with \fBRSA_new()\fR. The parent structure members will not have any meaningful
 values at this point. This function will typically be used to allocate any
 application specific structure.
 .PP
-\&\fB\f(BIfree_func()\fB\fR is called when a structure is being freed up. The dynamic parent
+\fBfree_func()\fR is called when a structure is being freed up. The dynamic parent
 structure members should not be accessed because they will be freed up when
 this function is called.
 .PP
-\&\fB\f(BInew_func()\fB\fR and \fB\f(BIfree_func()\fB\fR take the same parameters. \fBparent\fR is a
-pointer to the parent \s-1RSA\s0 structure. \fBptr\fR is a the application specific data
-(this wont be of much use in \fB\f(BInew_func()\fB\fR. \fBad\fR is a pointer to the
-\&\fB\s-1CRYPTO_EX_DATA\s0\fR structure from the parent \s-1RSA\s0 structure: the functions
-\&\fB\f(BICRYPTO_get_ex_data()\fB\fR and \fB\f(BICRYPTO_set_ex_data()\fB\fR can be called to manipulate
+\fBnew_func()\fR and \fBfree_func()\fR take the same parameters. \fBparent\fR is a
+pointer to the parent RSA structure. \fBptr\fR is a the application specific data
+(this wont be of much use in \fBnew_func()\fR. \fBad\fR is a pointer to the
+\fBCRYPTO_EX_DATA\fR structure from the parent RSA structure: the functions
+\fBCRYPTO_get_ex_data()\fR and \fBCRYPTO_set_ex_data()\fR can be called to manipulate
 it. The \fBidx\fR parameter is the index: this will be the same value returned by
-\&\fB\f(BIRSA_get_ex_new_index()\fB\fR when the functions were initially registered. Finally
+\fBRSA_get_ex_new_index()\fR when the functions were initially registered. Finally
 the \fBargl\fR and \fBargp\fR parameters are the values originally passed to the same
-corresponding parameters when \fB\f(BIRSA_get_ex_new_index()\fB\fR was called.
+corresponding parameters when \fBRSA_get_ex_new_index()\fR was called.
 .PP
-\&\fB\f(BIdup_func()\fB\fR is called when a structure is being copied. Pointers to the
-destination and source \fB\s-1CRYPTO_EX_DATA\s0\fR structures are passed in the \fBto\fR and
-\&\fBfrom\fR parameters respectively. The \fBfrom_d\fR parameter is passed a pointer to
+\fBdup_func()\fR is called when a structure is being copied. Pointers to the
+destination and source \fBCRYPTO_EX_DATA\fR structures are passed in the \fBto\fR and
+\fBfrom\fR parameters respectively. The \fBfrom_d\fR parameter is passed a pointer to
 the source application data when the function is called, when the function returns
 the value is copied to the destination: the application can thus modify the data
 pointed to by \fBfrom_d\fR and have different values in the source and destination.
-The \fBidx\fR, \fBargl\fR and \fBargp\fR parameters are the same as those in \fB\f(BInew_func()\fB\fR
-and \fB\f(BIfree_func()\fB\fR.
+The \fBidx\fR, \fBargl\fR and \fBargp\fR parameters are the same as those in \fBnew_func()\fR
+and \fBfree_func()\fR.
 .SH "RETURN VALUES"
-.IX Header "RETURN VALUES"
-\&\fB\f(BIRSA_get_ex_new_index()\fB\fR returns a new index or \-1 on failure (note 0 is a valid
+\fBRSA_get_ex_new_index()\fR returns a new index or \-1 on failure (note 0 is a valid
 index value).
 .PP
-\&\fB\f(BIRSA_set_ex_data()\fB\fR returns 1 on success or 0 on failure.
+\fBRSA_set_ex_data()\fR returns 1 on success or 0 on failure.
 .PP
-\&\fB\f(BIRSA_get_ex_data()\fB\fR returns the application data or 0 on failure. 0 may also
+\fBRSA_get_ex_data()\fR returns the application data or 0 on failure. 0 may also
 be valid application data but currently it can only fail if given an invalid \fBidx\fR
 parameter.
 .PP
-\&\fB\f(BInew_func()\fB\fR and \fB\f(BIdup_func()\fB\fR should return 0 for failure and 1 for success.
+\fBnew_func()\fR and \fBdup_func()\fR should return 0 for failure and 1 for success.
 .PP
 On failure an error code can be obtained from ERR_get_error(3).
 .SH "BUGS"
-.IX Header "BUGS"
-\&\fB\f(BIdup_func()\fB\fR is currently never called.
+\fBdup_func()\fR is currently never called.
 .PP
-The return value of \fB\f(BInew_func()\fB\fR is ignored.
+The return value of \fBnew_func()\fR is ignored.
 .PP
-The \fB\f(BInew_func()\fB\fR function isn't very useful because no meaningful values are
-present in the parent \s-1RSA\s0 structure when it is called.
+The \fBnew_func()\fR function isn't very useful because no meaningful values are
+present in the parent RSA structure when it is called.
 .SH "SEE ALSO"
-.IX Header "SEE ALSO"
 rsa(3), CRYPTO_set_ex_data(3)
 .SH "HISTORY"
-.IX Header "HISTORY"
-\&\fIRSA_get_ex_new_index()\fR, \fIRSA_set_ex_data()\fR and \fIRSA_get_ex_data()\fR are
+\fIRSA_get_ex_new_index()\fR, \fIRSA_set_ex_data()\fR and \fIRSA_get_ex_data()\fR are
 available since SSLeay 0.9.0.
+
+.rn }` ''
+.IX Title "RSA_get_ex_new_index 3"
+.IX Name "RSA_get_ex_new_index, RSA_set_ex_data, RSA_get_ex_data - add application specific data to RSA structures"
+
+.IX Header "NAME"
+
+.IX Header "SYNOPSIS"
+
+.IX Header "DESCRIPTION"
+
+.IX Header "RETURN VALUES"
+
+.IX Header "BUGS"
+
+.IX Header "SEE ALSO"
+
+.IX Header "HISTORY"
+