diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/UI_create_method.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/UI_create_method.3 | 140 |
1 files changed, 32 insertions, 108 deletions
diff --git a/secure/lib/libcrypto/man/man3/UI_create_method.3 b/secure/lib/libcrypto/man/man3/UI_create_method.3 index 3da1b82e898c..9ba2fcac5372 100644 --- a/secure/lib/libcrypto/man/man3/UI_create_method.3 +++ b/secure/lib/libcrypto/man/man3/UI_create_method.3 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .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. \*(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<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .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' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,75 +52,15 @@ . \} .\} .rr rF -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. 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 #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.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' -.\} -. \" 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 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 \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.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 -.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) -.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 -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "UI_CREATE_METHOD 3ossl" -.TH UI_CREATE_METHOD 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH UI_CREATE_METHOD 3ossl 2025-07-01 3.5.1 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME UI_METHOD, UI_create_method, UI_destroy_method, UI_method_set_opener, UI_method_set_writer, UI_method_set_flusher, UI_method_set_reader, @@ -147,7 +71,7 @@ UI_method_get_reader, UI_method_get_closer, UI_method_get_data_duplicator, UI_method_get_data_destructor, UI_method_get_prompt_constructor, UI_method_get_ex_data \- user interface method creation and destruction -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/ui.h> @@ -184,38 +108,38 @@ interface method creation and destruction \& void (*UI_method_get_data_destructor(const UI_METHOD *method)) (UI *, void *); \& const void *UI_method_get_ex_data(const UI_METHOD *method, int idx); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" A method contains a few functions that implement the low-level of the User Interface. These functions are: .IP "an opener" 4 .IX Item "an opener" -This function takes a reference to a \s-1UI\s0 and starts a session, for +This function takes a reference to a UI and starts a session, for example by opening a channel to a tty, or by creating a dialog box. .IP "a writer" 4 .IX Item "a writer" -This function takes a reference to a \s-1UI\s0 and a \s-1UI\s0 String, and writes +This function takes a reference to a UI and a UI String, and writes the string where appropriate, maybe to the tty, maybe added as a field label in a dialog box. -Note that this gets fed all strings associated with a \s-1UI,\s0 one after +Note that this gets fed all strings associated with a UI, one after the other, so care must be taken which ones it actually uses. .IP "a flusher" 4 .IX Item "a flusher" -This function takes a reference to a \s-1UI,\s0 and flushes everything that +This function takes a reference to a UI, and flushes everything that has been output so far. For example, if the method builds up a dialog box, this can be used to actually display it and accepting input ended with a pressed button. .IP "a reader" 4 .IX Item "a reader" -This function takes a reference to a \s-1UI\s0 and a \s-1UI\s0 string and reads off +This function takes a reference to a UI and a UI string and reads off the given prompt, maybe from the tty, maybe from a field in a dialog box. -Note that this gets fed all strings associated with a \s-1UI,\s0 one after +Note that this gets fed all strings associated with a UI, one after the other, so care must be taken which ones it actually uses. .IP "a closer" 4 .IX Item "a closer" -This function takes a reference to a \s-1UI,\s0 and closes the session, maybe +This function takes a reference to a UI, and closes the session, maybe by closing the channel to the tty, maybe by destroying a dialog box. .PP All of these functions are expected to return 0 on error, 1 on @@ -241,26 +165,26 @@ fetch those results. .PP The central function that uses these method functions is \fBUI_process()\fR, and it does it in five steps: -.IP "1." 4 +.IP 1. 4 Open the session using the opener function if that one's defined. If an error occurs, jump to 5. -.IP "2." 4 -For every \s-1UI\s0 String associated with the \s-1UI,\s0 call the writer function +.IP 2. 4 +For every UI String associated with the UI, call the writer function if that one's defined. If an error occurs, jump to 5. -.IP "3." 4 +.IP 3. 4 Flush everything using the flusher function if that one's defined. If an error occurs, jump to 5. -.IP "4." 4 -For every \s-1UI\s0 String associated with the \s-1UI,\s0 call the reader function +.IP 4. 4 +For every UI String associated with the UI, call the reader function if that one's defined. If an error occurs, jump to 5. -.IP "5." 4 +.IP 5. 4 Close the session using the closer function if that one's defined. .PP -\&\fBUI_create_method()\fR creates a new \s-1UI\s0 method with a given \fBname\fR. +\&\fBUI_create_method()\fR creates a new UI method with a given \fBname\fR. .PP -\&\fBUI_destroy_method()\fR destroys the given \s-1UI\s0 method \fBui_method\fR. +\&\fBUI_destroy_method()\fR destroys the given UI method \fBui_method\fR. .PP \&\fBUI_method_set_opener()\fR, \fBUI_method_set_writer()\fR, \&\fBUI_method_set_flusher()\fR, \fBUI_method_set_reader()\fR and @@ -274,7 +198,7 @@ See \fBUI_dup_user_data\fR\|(3). See \fBUI_construct_prompt\fR\|(3). .PP \&\fBUI_method_set_ex_data()\fR sets application specific data with a given -\&\s-1EX_DATA\s0 index. +EX_DATA index. See \fBCRYPTO_get_ex_new_index\fR\|(3) for general information on how to get that index. .PP @@ -288,14 +212,14 @@ return the different method functions. with \fBUI_method_set_ex_data()\fR. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fBUI_create_method()\fR returns a \s-1UI_METHOD\s0 pointer on success, \s-1NULL\s0 on +\&\fBUI_create_method()\fR returns a UI_METHOD pointer on success, NULL on error. .PP \&\fBUI_method_set_opener()\fR, \fBUI_method_set_writer()\fR, \&\fBUI_method_set_flusher()\fR, \fBUI_method_set_reader()\fR, \&\fBUI_method_set_closer()\fR, \fBUI_method_set_data_duplicator()\fR and \&\fBUI_method_set_prompt_constructor()\fR -return 0 on success, \-1 if the given \fBmethod\fR is \s-1NULL.\s0 +return 0 on success, \-1 if the given \fBmethod\fR is NULL. .PP \&\fBUI_method_set_ex_data()\fR returns 1 on success and 0 on error (because \&\fBCRYPTO_set_ex_data()\fR does so). @@ -305,22 +229,22 @@ return 0 on success, \-1 if the given \fBmethod\fR is \s-1NULL.\s0 \&\fBUI_method_get_closer()\fR, \fBUI_method_get_data_duplicator()\fR, \&\fBUI_method_get_data_destructor()\fR and \fBUI_method_get_prompt_constructor()\fR return the requested function pointer if it's set in the method, -otherwise \s-1NULL.\s0 +otherwise NULL. .PP \&\fBUI_method_get_ex_data()\fR returns a pointer to the application specific data associated with the method. .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\s-1\fBUI\s0\fR\|(3), \fBCRYPTO_get_ex_data\fR\|(3), \s-1\fBUI_STRING\s0\fR\|(3) -.SH "HISTORY" +\&\fBUI\fR\|(3), \fBCRYPTO_get_ex_data\fR\|(3), \fBUI_STRING\fR\|(3) +.SH HISTORY .IX Header "HISTORY" The \fBUI_method_set_data_duplicator()\fR, \fBUI_method_get_data_duplicator()\fR and \fBUI_method_get_data_destructor()\fR functions were added in OpenSSL 1.1.1. -.SH "COPYRIGHT" +.SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2001\-2020 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy -in the file \s-1LICENSE\s0 in the source distribution or at +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |