diff options
Diffstat (limited to 'doc/man3/UI_new.pod')
| -rw-r--r-- | doc/man3/UI_new.pod | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/man3/UI_new.pod b/doc/man3/UI_new.pod index f40b65df40e9..eb80f453d5c6 100644 --- a/doc/man3/UI_new.pod +++ b/doc/man3/UI_new.pod @@ -44,7 +44,7 @@ UI_get_method, UI_set_method, UI_OpenSSL, UI_null - user interface int UI_dup_error_string(UI *ui, const char *text); char *UI_construct_prompt(UI *ui_method, - const char *object_desc, const char *object_name); + const char *phrase_desc, const char *object_name); void *UI_add_user_data(UI *ui, void *user_data); int UI_dup_user_data(UI *ui, void *user_data); @@ -132,7 +132,7 @@ the possible answers (given through the I<action_desc> argument). UI_add_info_string() and UI_add_error_string() add strings that are shown at the same time as the prompt for extra information or to show an error string. -The difference between the two is only conceptual. With the builtin method, +The difference between the two is only conceptual. With the built-in method, there's no technical difference between them. Other methods may make a difference between them, however. @@ -149,16 +149,18 @@ as their UI_add counterparts, except that they make their own copies of all strings. UI_construct_prompt() is a helper function that can be used to create -a prompt from two pieces of information: an description and a name. +a prompt from two pieces of information: a phrase description I<phrase_desc> +and an object name I<object_name>, where the latter may be NULL. The default constructor (if there is none provided by the method used) -creates a string "Enter I<description> for I<name>:". With the -description "pass phrase" and the filename "foo.key", that becomes +creates a string "Enter I<phrase_desc> for I<object_name>:" +where the " for I<object_name>" part is left out if I<object_name> is NULL. +With the description "pass phrase" and the filename "foo.key", that becomes "Enter pass phrase for foo.key:". Other methods may create whatever string and may include encodings that will be processed by the other method functions. UI_add_user_data() adds a user data pointer for the method to use at any -time. The builtin UI method doesn't care about this info. Note that several +time. The built-in UI method doesn't care about this info. Note that several calls to this function doesn't add data, it replaces the previous blob with the one given as argument. @@ -205,7 +207,7 @@ are assumed to be encoded according to the current locale or (for Windows) code page. For applications having different demands, these strings need to be converted appropriately by the caller. -For Windows, if the OPENSSL_WIN32_UTF8 environment variable is set, +For Windows, if the B<OPENSSL_WIN32_UTF8> environment variable is set, the built-in method UI_OpenSSL() will produce UTF-8 encoded strings instead. @@ -245,7 +247,7 @@ The UI_dup_user_data() function was added in OpenSSL 1.1.1. Copyright 2001-2020 The OpenSSL Project Authors. All Rights Reserved. -Licensed under the OpenSSL license (the "License"). 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 LICENSE in the source distribution or at L<https://www.openssl.org/source/license.html>. |