| ui.3 (206048) | ui.3 (215698) |
|---|---|
| 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.37 | 1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) |
| 2.\" 3.\" Standard preamble: 4.\" ======================================================================== | 2.\" 3.\" Standard preamble: 4.\" ======================================================================== |
| 5.de Sh \" Subsection heading 6.br 7.if t .Sp 8.ne 5 9.PP 10\fB\\$1\fR 11.PP 12.. | |
| 13.de Sp \" Vertical space (when we can't use .PP) 14.if t .sp .5v 15.if n .sp 16.. 17.de Vb \" Begin verbatim text 18.ft CW 19.nf 20.ne \\$1 21.. 22.de Ve \" End verbatim text 23.ft R 24.fi 25.. 26.\" Set up some character translations and predefined strings. \*(-- will 27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | 5.de Sp \" Vertical space (when we can't use .PP) 6.if t .sp .5v 7.if n .sp 8.. 9.de Vb \" Begin verbatim text 10.ft CW 11.nf 12.ne \\$1 13.. 14.de Ve \" End verbatim text 15.ft R 16.fi 17.. 18.\" Set up some character translations and predefined strings. \*(-- will 19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 28.\" double quote, and \*(R" will give a right double quote. | will give a 29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to 30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' 31.\" expand to `' in nroff, nothing in troff, for use with C<>. 32.tr \(*W-|\(bv\*(Tr | 20.\" double quote, and \*(R" will give a right double quote. \*(C+ will 21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and 22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, 23.\" nothing in troff, for use with C<>. 24.tr \(*W- |
| 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 34.ie n \{\ 35. ds -- \(*W- 36. ds PI pi 37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch 39. ds L" "" 40. ds R" "" 41. ds C` "" 42. ds C' "" 43'br\} 44.el\{\ 45. ds -- \|\(em\| 46. ds PI \(*p 47. ds L" `` 48. ds R" '' 49'br\} 50.\" | 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 26.ie n \{\ 27. ds -- \(*W- 28. ds PI pi 29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 30. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch 31. ds L" "" 32. ds R" "" 33. ds C` "" 34. ds C' "" 35'br\} 36.el\{\ 37. ds -- \|\(em\| 38. ds PI \(*p 39. ds L" `` 40. ds R" '' 41'br\} 42.\" |
| 43.\" Escape single quotes in literal strings from groff's Unicode transform. 44.ie \n(.g .ds Aq \(aq 45.el .ds Aq ' 46.\" |
|
| 51.\" If the F register is turned on, we'll generate index entries on stderr for | 47.\" If the F register is turned on, we'll generate index entries on stderr for |
| 52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 53.\" entries marked with X<> in POD. Of course, you'll have to process the 54.\" output yourself in some meaningful fashion. | 49.\" entries marked with X<> in POD. Of course, you'll have to process the 50.\" output yourself in some meaningful fashion. |
| 55.if \nF \{\ | 51.ie \nF \{\ |
| 56. de IX 57. tm Index:\\$1\t\\n%\t"\\$2" 58.. 59. nr % 0 60. rr F 61.\} | 52. de IX 53. tm Index:\\$1\t\\n%\t"\\$2" 54.. 55. nr % 0 56. rr F 57.\} |
| 58.el \{\ 59. de IX 60.. 61.\} |
|
| 62.\" | 62.\" |
| 63.\" For nroff, turn off justification. Always turn off hyphenation; it makes 64.\" way too many mistakes in technical documents. 65.hy 0 66.if n .na 67.\" | |
| 68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 69.\" Fear. Run. Save yourself. No user-serviceable parts. 70. \" fudge factors for nroff and troff 71.if n \{\ 72. ds #H 0 73. ds #V .8m 74. ds #F .3m 75. ds #[ \f1 --- 48 unchanged lines hidden (view full) --- 124. ds Th \o'LP' 125. ds ae ae 126. ds Ae AE 127.\} 128.rm #[ #] #H #V #F C 129.\" ======================================================================== 130.\" 131.IX Title "ui 3" | 63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 64.\" Fear. Run. Save yourself. No user-serviceable parts. 65. \" fudge factors for nroff and troff 66.if n \{\ 67. ds #H 0 68. ds #V .8m 69. ds #F .3m 70. ds #[ \f1 --- 48 unchanged lines hidden (view full) --- 119. ds Th \o'LP' 120. ds ae ae 121. ds Ae AE 122.\} 123.rm #[ #] #H #V #F C 124.\" ======================================================================== 125.\" 126.IX Title "ui 3" |
| 132.TH ui 3 "2010-03-24" "0.9.8n" "OpenSSL" | 127.TH ui 3 "2010-11-16" "0.9.8p" "OpenSSL" 128.\" For nroff, turn off justification. Always turn off hyphenation; it makes 129.\" way too many mistakes in technical documents. 130.if n .ad l 131.nh |
| 133.SH "NAME" 134UI_new, UI_new_method, UI_free, UI_add_input_string, UI_dup_input_string, 135UI_add_verify_string, UI_dup_verify_string, UI_add_input_boolean, 136UI_dup_input_boolean, UI_add_info_string, UI_dup_info_string, 137UI_add_error_string, UI_dup_error_string, UI_construct_prompt, 138UI_add_user_data, UI_get0_user_data, UI_get0_result, UI_process, 139UI_ctrl, UI_set_default_method, UI_get_default_method, UI_get_method, 140UI_set_method, UI_OpenSSL, ERR_load_UI_strings \- New User Interface 141.SH "SYNOPSIS" 142.IX Header "SYNOPSIS" 143.Vb 1 144\& #include <openssl/ui.h> | 132.SH "NAME" 133UI_new, UI_new_method, UI_free, UI_add_input_string, UI_dup_input_string, 134UI_add_verify_string, UI_dup_verify_string, UI_add_input_boolean, 135UI_dup_input_boolean, UI_add_info_string, UI_dup_info_string, 136UI_add_error_string, UI_dup_error_string, UI_construct_prompt, 137UI_add_user_data, UI_get0_user_data, UI_get0_result, UI_process, 138UI_ctrl, UI_set_default_method, UI_get_default_method, UI_get_method, 139UI_set_method, UI_OpenSSL, ERR_load_UI_strings \- New User Interface 140.SH "SYNOPSIS" 141.IX Header "SYNOPSIS" 142.Vb 1 143\& #include <openssl/ui.h> |
| 145.Ve 146.PP 147.Vb 2 | 144\& |
| 148\& typedef struct ui_st UI; 149\& typedef struct ui_method_st UI_METHOD; | 145\& typedef struct ui_st UI; 146\& typedef struct ui_method_st UI_METHOD; |
| 150.Ve 151.PP 152.Vb 3 | 147\& |
| 153\& UI *UI_new(void); 154\& UI *UI_new_method(const UI_METHOD *method); 155\& void UI_free(UI *ui); | 148\& UI *UI_new(void); 149\& UI *UI_new_method(const UI_METHOD *method); 150\& void UI_free(UI *ui); |
| 156.Ve 157.PP 158.Vb 18 | 151\& |
| 159\& int UI_add_input_string(UI *ui, const char *prompt, int flags, 160\& char *result_buf, int minsize, int maxsize); 161\& int UI_dup_input_string(UI *ui, const char *prompt, int flags, 162\& char *result_buf, int minsize, int maxsize); 163\& int UI_add_verify_string(UI *ui, const char *prompt, int flags, 164\& char *result_buf, int minsize, int maxsize, const char *test_buf); 165\& int UI_dup_verify_string(UI *ui, const char *prompt, int flags, 166\& char *result_buf, int minsize, int maxsize, const char *test_buf); 167\& int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc, 168\& const char *ok_chars, const char *cancel_chars, 169\& int flags, char *result_buf); 170\& int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc, 171\& const char *ok_chars, const char *cancel_chars, 172\& int flags, char *result_buf); 173\& int UI_add_info_string(UI *ui, const char *text); 174\& int UI_dup_info_string(UI *ui, const char *text); 175\& int UI_add_error_string(UI *ui, const char *text); 176\& int UI_dup_error_string(UI *ui, const char *text); | 152\& int UI_add_input_string(UI *ui, const char *prompt, int flags, 153\& char *result_buf, int minsize, int maxsize); 154\& int UI_dup_input_string(UI *ui, const char *prompt, int flags, 155\& char *result_buf, int minsize, int maxsize); 156\& int UI_add_verify_string(UI *ui, const char *prompt, int flags, 157\& char *result_buf, int minsize, int maxsize, const char *test_buf); 158\& int UI_dup_verify_string(UI *ui, const char *prompt, int flags, 159\& char *result_buf, int minsize, int maxsize, const char *test_buf); 160\& int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc, 161\& const char *ok_chars, const char *cancel_chars, 162\& int flags, char *result_buf); 163\& int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc, 164\& const char *ok_chars, const char *cancel_chars, 165\& int flags, char *result_buf); 166\& int UI_add_info_string(UI *ui, const char *text); 167\& int UI_dup_info_string(UI *ui, const char *text); 168\& int UI_add_error_string(UI *ui, const char *text); 169\& int UI_dup_error_string(UI *ui, const char *text); |
| 177.Ve 178.PP 179.Vb 3 180\& /* These are the possible flags. They can be or'ed together. */ | 170\& 171\& /* These are the possible flags. They can be or\*(Aqed together. */ |
| 181\& #define UI_INPUT_FLAG_ECHO 0x01 182\& #define UI_INPUT_FLAG_DEFAULT_PWD 0x02 | 172\& #define UI_INPUT_FLAG_ECHO 0x01 173\& #define UI_INPUT_FLAG_DEFAULT_PWD 0x02 |
| 183.Ve 184.PP 185.Vb 2 | 174\& |
| 186\& char *UI_construct_prompt(UI *ui_method, 187\& const char *object_desc, const char *object_name); | 175\& char *UI_construct_prompt(UI *ui_method, 176\& const char *object_desc, const char *object_name); |
| 188.Ve 189.PP 190.Vb 2 | 177\& |
| 191\& void *UI_add_user_data(UI *ui, void *user_data); 192\& void *UI_get0_user_data(UI *ui); | 178\& void *UI_add_user_data(UI *ui, void *user_data); 179\& void *UI_get0_user_data(UI *ui); |
| 193.Ve 194.PP 195.Vb 1 | 180\& |
| 196\& const char *UI_get0_result(UI *ui, int i); | 181\& const char *UI_get0_result(UI *ui, int i); |
| 197.Ve 198.PP 199.Vb 1 | 182\& |
| 200\& int UI_process(UI *ui); | 183\& int UI_process(UI *ui); |
| 201.Ve 202.PP 203.Vb 3 | 184\& |
| 204\& int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)()); 205\& #define UI_CTRL_PRINT_ERRORS 1 206\& #define UI_CTRL_IS_REDOABLE 2 | 185\& int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)()); 186\& #define UI_CTRL_PRINT_ERRORS 1 187\& #define UI_CTRL_IS_REDOABLE 2 |
| 207.Ve 208.PP 209.Vb 4 | 188\& |
| 210\& void UI_set_default_method(const UI_METHOD *meth); 211\& const UI_METHOD *UI_get_default_method(void); 212\& const UI_METHOD *UI_get_method(UI *ui); 213\& const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth); | 189\& void UI_set_default_method(const UI_METHOD *meth); 190\& const UI_METHOD *UI_get_default_method(void); 191\& const UI_METHOD *UI_get_method(UI *ui); 192\& const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth); |
| 214.Ve 215.PP 216.Vb 1 | 193\& |
| 217\& UI_METHOD *UI_OpenSSL(void); 218.Ve 219.SH "DESCRIPTION" 220.IX Header "DESCRIPTION" 221\&\s-1UI\s0 stands for User Interface, and is general purpose set of routines to 222prompt the user for text-based information. Through user-written methods 223(see \fIui_create\fR\|(3)), prompting can be done in any way 224imaginable, be it plain text prompting, through dialog boxes or from a --- 116 unchanged lines hidden --- | 194\& UI_METHOD *UI_OpenSSL(void); 195.Ve 196.SH "DESCRIPTION" 197.IX Header "DESCRIPTION" 198\&\s-1UI\s0 stands for User Interface, and is general purpose set of routines to 199prompt the user for text-based information. Through user-written methods 200(see \fIui_create\fR\|(3)), prompting can be done in any way 201imaginable, be it plain text prompting, through dialog boxes or from a --- 116 unchanged lines hidden --- |