diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-17 10:52:33 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-17 10:52:33 +0000 |
| commit | 2c3307fb903f427be3d021c5780b75cac9af2ce8 (patch) | |
| tree | 65cf431f40b7481d81ae2dfce9576342686448f7 /upstream/archlinux/man3 | |
| parent | Releasing progress-linux version 4.22.0-1~progress7.99u1. (diff) | |
| download | manpages-l10n-2c3307fb903f427be3d021c5780b75cac9af2ce8.tar.xz manpages-l10n-2c3307fb903f427be3d021c5780b75cac9af2ce8.zip | |
Merging upstream version 4.23.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/archlinux/man3')
1384 files changed, 15543 insertions, 11035 deletions
diff --git a/upstream/archlinux/man3/ADMISSIONS.3ssl b/upstream/archlinux/man3/ADMISSIONS.3ssl index 4679a3be..e164ecb2 100644 --- a/upstream/archlinux/man3/ADMISSIONS.3ssl +++ b/upstream/archlinux/man3/ADMISSIONS.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ADMISSIONS 3ssl" -.TH ADMISSIONS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ADMISSIONS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_EXTERN_FUNCS.3ssl b/upstream/archlinux/man3/ASN1_EXTERN_FUNCS.3ssl index e10d2f77..ce233b74 100644 --- a/upstream/archlinux/man3/ASN1_EXTERN_FUNCS.3ssl +++ b/upstream/archlinux/man3/ASN1_EXTERN_FUNCS.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_EXTERN_FUNCS 3ssl" -.TH ASN1_EXTERN_FUNCS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_EXTERN_FUNCS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_INTEGER_get_int64.3ssl b/upstream/archlinux/man3/ASN1_INTEGER_get_int64.3ssl index 0b2010e6..dcc1b45a 100644 --- a/upstream/archlinux/man3/ASN1_INTEGER_get_int64.3ssl +++ b/upstream/archlinux/man3/ASN1_INTEGER_get_int64.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_INTEGER_GET_INT64 3ssl" -.TH ASN1_INTEGER_GET_INT64 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_INTEGER_GET_INT64 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_INTEGER_new.3ssl b/upstream/archlinux/man3/ASN1_INTEGER_new.3ssl index 043d1fd7..fb42d124 100644 --- a/upstream/archlinux/man3/ASN1_INTEGER_new.3ssl +++ b/upstream/archlinux/man3/ASN1_INTEGER_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_INTEGER_NEW 3ssl" -.TH ASN1_INTEGER_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_INTEGER_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_ITEM_lookup.3ssl b/upstream/archlinux/man3/ASN1_ITEM_lookup.3ssl index 4ef1a87a..90956abd 100644 --- a/upstream/archlinux/man3/ASN1_ITEM_lookup.3ssl +++ b/upstream/archlinux/man3/ASN1_ITEM_lookup.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_ITEM_LOOKUP 3ssl" -.TH ASN1_ITEM_LOOKUP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_ITEM_LOOKUP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_OBJECT_new.3ssl b/upstream/archlinux/man3/ASN1_OBJECT_new.3ssl index 50db8f48..ea2ecb61 100644 --- a/upstream/archlinux/man3/ASN1_OBJECT_new.3ssl +++ b/upstream/archlinux/man3/ASN1_OBJECT_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_OBJECT_NEW 3ssl" -.TH ASN1_OBJECT_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_OBJECT_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_STRING_TABLE_add.3ssl b/upstream/archlinux/man3/ASN1_STRING_TABLE_add.3ssl index ea25649e..08d093db 100644 --- a/upstream/archlinux/man3/ASN1_STRING_TABLE_add.3ssl +++ b/upstream/archlinux/man3/ASN1_STRING_TABLE_add.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_STRING_TABLE_ADD 3ssl" -.TH ASN1_STRING_TABLE_ADD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_STRING_TABLE_ADD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_STRING_length.3ssl b/upstream/archlinux/man3/ASN1_STRING_length.3ssl index 5ede5b99..d9129c3b 100644 --- a/upstream/archlinux/man3/ASN1_STRING_length.3ssl +++ b/upstream/archlinux/man3/ASN1_STRING_length.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_STRING_LENGTH 3ssl" -.TH ASN1_STRING_LENGTH 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_STRING_LENGTH 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_STRING_new.3ssl b/upstream/archlinux/man3/ASN1_STRING_new.3ssl index 49e3ea2b..a93cd6fb 100644 --- a/upstream/archlinux/man3/ASN1_STRING_new.3ssl +++ b/upstream/archlinux/man3/ASN1_STRING_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_STRING_NEW 3ssl" -.TH ASN1_STRING_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_STRING_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_STRING_print_ex.3ssl b/upstream/archlinux/man3/ASN1_STRING_print_ex.3ssl index e498be64..b9c18f6c 100644 --- a/upstream/archlinux/man3/ASN1_STRING_print_ex.3ssl +++ b/upstream/archlinux/man3/ASN1_STRING_print_ex.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_STRING_PRINT_EX 3ssl" -.TH ASN1_STRING_PRINT_EX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_STRING_PRINT_EX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_TIME_set.3ssl b/upstream/archlinux/man3/ASN1_TIME_set.3ssl index 475fef72..40e145b1 100644 --- a/upstream/archlinux/man3/ASN1_TIME_set.3ssl +++ b/upstream/archlinux/man3/ASN1_TIME_set.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_TIME_SET 3ssl" -.TH ASN1_TIME_SET 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_TIME_SET 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_TYPE_get.3ssl b/upstream/archlinux/man3/ASN1_TYPE_get.3ssl index 902433ef..cc0f5e95 100644 --- a/upstream/archlinux/man3/ASN1_TYPE_get.3ssl +++ b/upstream/archlinux/man3/ASN1_TYPE_get.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_TYPE_GET 3ssl" -.TH ASN1_TYPE_GET 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_TYPE_GET 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_aux_cb.3ssl b/upstream/archlinux/man3/ASN1_aux_cb.3ssl index 0f7e20b2..94cb2e5f 100644 --- a/upstream/archlinux/man3/ASN1_aux_cb.3ssl +++ b/upstream/archlinux/man3/ASN1_aux_cb.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_AUX_CB 3ssl" -.TH ASN1_AUX_CB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_AUX_CB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_generate_nconf.3ssl b/upstream/archlinux/man3/ASN1_generate_nconf.3ssl index 59d33bdd..d90d5221 100644 --- a/upstream/archlinux/man3/ASN1_generate_nconf.3ssl +++ b/upstream/archlinux/man3/ASN1_generate_nconf.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_GENERATE_NCONF 3ssl" -.TH ASN1_GENERATE_NCONF 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_GENERATE_NCONF 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_item_d2i_bio.3ssl b/upstream/archlinux/man3/ASN1_item_d2i_bio.3ssl index 16a18b6d..a7ac9ea1 100644 --- a/upstream/archlinux/man3/ASN1_item_d2i_bio.3ssl +++ b/upstream/archlinux/man3/ASN1_item_d2i_bio.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_ITEM_D2I_BIO 3ssl" -.TH ASN1_ITEM_D2I_BIO 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_ITEM_D2I_BIO 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_item_new.3ssl b/upstream/archlinux/man3/ASN1_item_new.3ssl index 7c9cdb9c..6af1735b 100644 --- a/upstream/archlinux/man3/ASN1_item_new.3ssl +++ b/upstream/archlinux/man3/ASN1_item_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_ITEM_NEW 3ssl" -.TH ASN1_ITEM_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_ITEM_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASN1_item_sign.3ssl b/upstream/archlinux/man3/ASN1_item_sign.3ssl index 50459661..8653dc41 100644 --- a/upstream/archlinux/man3/ASN1_item_sign.3ssl +++ b/upstream/archlinux/man3/ASN1_item_sign.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASN1_ITEM_SIGN 3ssl" -.TH ASN1_ITEM_SIGN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASN1_ITEM_SIGN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASYNC_WAIT_CTX_new.3ssl b/upstream/archlinux/man3/ASYNC_WAIT_CTX_new.3ssl index 7f75a70c..615f5105 100644 --- a/upstream/archlinux/man3/ASYNC_WAIT_CTX_new.3ssl +++ b/upstream/archlinux/man3/ASYNC_WAIT_CTX_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASYNC_WAIT_CTX_NEW 3ssl" -.TH ASYNC_WAIT_CTX_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASYNC_WAIT_CTX_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ASYNC_start_job.3ssl b/upstream/archlinux/man3/ASYNC_start_job.3ssl index 9e7e5dfe..a0fa3c32 100644 --- a/upstream/archlinux/man3/ASYNC_start_job.3ssl +++ b/upstream/archlinux/man3/ASYNC_start_job.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ASYNC_START_JOB 3ssl" -.TH ASYNC_START_JOB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ASYNC_START_JOB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BF_encrypt.3ssl b/upstream/archlinux/man3/BF_encrypt.3ssl index 18edaca7..76f1c29f 100644 --- a/upstream/archlinux/man3/BF_encrypt.3ssl +++ b/upstream/archlinux/man3/BF_encrypt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BF_ENCRYPT 3ssl" -.TH BF_ENCRYPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BF_ENCRYPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_ADDR.3ssl b/upstream/archlinux/man3/BIO_ADDR.3ssl index c9edaabd..cb1d8853 100644 --- a/upstream/archlinux/man3/BIO_ADDR.3ssl +++ b/upstream/archlinux/man3/BIO_ADDR.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_ADDR 3ssl" -.TH BIO_ADDR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_ADDR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_ADDRINFO.3ssl b/upstream/archlinux/man3/BIO_ADDRINFO.3ssl index 6cd4c226..548118c3 100644 --- a/upstream/archlinux/man3/BIO_ADDRINFO.3ssl +++ b/upstream/archlinux/man3/BIO_ADDRINFO.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_ADDRINFO 3ssl" -.TH BIO_ADDRINFO 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_ADDRINFO 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_connect.3ssl b/upstream/archlinux/man3/BIO_connect.3ssl index 2b275274..d0704b27 100644 --- a/upstream/archlinux/man3/BIO_connect.3ssl +++ b/upstream/archlinux/man3/BIO_connect.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_CONNECT 3ssl" -.TH BIO_CONNECT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_CONNECT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_ctrl.3ssl b/upstream/archlinux/man3/BIO_ctrl.3ssl index a123f5c8..dd46e6bf 100644 --- a/upstream/archlinux/man3/BIO_ctrl.3ssl +++ b/upstream/archlinux/man3/BIO_ctrl.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_CTRL 3ssl" -.TH BIO_CTRL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_CTRL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_f_base64.3ssl b/upstream/archlinux/man3/BIO_f_base64.3ssl index 67b28746..f96a08ff 100644 --- a/upstream/archlinux/man3/BIO_f_base64.3ssl +++ b/upstream/archlinux/man3/BIO_f_base64.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_F_BASE64 3ssl" -.TH BIO_F_BASE64 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_F_BASE64 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_f_buffer.3ssl b/upstream/archlinux/man3/BIO_f_buffer.3ssl index 28a07254..95710081 100644 --- a/upstream/archlinux/man3/BIO_f_buffer.3ssl +++ b/upstream/archlinux/man3/BIO_f_buffer.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_F_BUFFER 3ssl" -.TH BIO_F_BUFFER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_F_BUFFER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_f_cipher.3ssl b/upstream/archlinux/man3/BIO_f_cipher.3ssl index f9c7a35e..e49a76ac 100644 --- a/upstream/archlinux/man3/BIO_f_cipher.3ssl +++ b/upstream/archlinux/man3/BIO_f_cipher.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_F_CIPHER 3ssl" -.TH BIO_F_CIPHER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_F_CIPHER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_f_md.3ssl b/upstream/archlinux/man3/BIO_f_md.3ssl index 5bf7f357..db4a7f2f 100644 --- a/upstream/archlinux/man3/BIO_f_md.3ssl +++ b/upstream/archlinux/man3/BIO_f_md.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_F_MD 3ssl" -.TH BIO_F_MD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_F_MD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_f_null.3ssl b/upstream/archlinux/man3/BIO_f_null.3ssl index dd4ba778..89230cfb 100644 --- a/upstream/archlinux/man3/BIO_f_null.3ssl +++ b/upstream/archlinux/man3/BIO_f_null.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_F_NULL 3ssl" -.TH BIO_F_NULL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_F_NULL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_f_prefix.3ssl b/upstream/archlinux/man3/BIO_f_prefix.3ssl index 40aec342..62539b40 100644 --- a/upstream/archlinux/man3/BIO_f_prefix.3ssl +++ b/upstream/archlinux/man3/BIO_f_prefix.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_F_PREFIX 3ssl" -.TH BIO_F_PREFIX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_F_PREFIX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_f_readbuffer.3ssl b/upstream/archlinux/man3/BIO_f_readbuffer.3ssl index 4d37624c..431bee36 100644 --- a/upstream/archlinux/man3/BIO_f_readbuffer.3ssl +++ b/upstream/archlinux/man3/BIO_f_readbuffer.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_F_READBUFFER 3ssl" -.TH BIO_F_READBUFFER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_F_READBUFFER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_f_ssl.3ssl b/upstream/archlinux/man3/BIO_f_ssl.3ssl index 3a646213..7a18a8e8 100644 --- a/upstream/archlinux/man3/BIO_f_ssl.3ssl +++ b/upstream/archlinux/man3/BIO_f_ssl.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_F_SSL 3ssl" -.TH BIO_F_SSL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_F_SSL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_find_type.3ssl b/upstream/archlinux/man3/BIO_find_type.3ssl index 2920e472..20c59677 100644 --- a/upstream/archlinux/man3/BIO_find_type.3ssl +++ b/upstream/archlinux/man3/BIO_find_type.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_FIND_TYPE 3ssl" -.TH BIO_FIND_TYPE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_FIND_TYPE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -73,12 +73,12 @@ BIO_find_type, BIO_next, BIO_method_type \- BIO chain traversal .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" -The \fBBIO_find_type()\fR searches for a BIO of a given type in a chain, starting -at BIO \fBb\fR. If \fBtype\fR is a specific type (such as \fBBIO_TYPE_MEM\fR) then a search -is made for a BIO of that type. If \fBtype\fR is a general type (such as -\&\fBBIO_TYPE_SOURCE_SINK\fR) then the next matching BIO of the given general type is -searched for. \fBBIO_find_type()\fR returns the next matching BIO or NULL if none is -found. +The \fBBIO_find_type()\fR searches for a \fBBIO\fR of a given type in a chain, starting +at \fBBIO\fR \fIb\fR. If \fItype\fR is a specific type (such as \fBBIO_TYPE_MEM\fR) then a +search is made for a \fBBIO\fR of that type. If \fItype\fR is a general type (such as +\&\fBBIO_TYPE_SOURCE_SINK\fR) then the next matching \fBBIO\fR of the given general type is +searched for. \fBBIO_find_type()\fR returns the next matching \fBBIO\fR or NULL if none is +found. If \fItype\fR is \fBBIO_TYPE_NONE\fR it will not find a match. .PP The following general types are defined: \&\fBBIO_TYPE_DESCRIPTOR\fR, \fBBIO_TYPE_FILTER\fR, and \fBBIO_TYPE_SOURCE_SINK\fR. @@ -96,7 +96,7 @@ certain type. .PP \&\fBBIO_next()\fR returns the next BIO in a chain. .PP -\&\fBBIO_method_type()\fR returns the type of the BIO \fBb\fR. +\&\fBBIO_method_type()\fR returns the type of the BIO \fIb\fR. .SH EXAMPLES .IX Header "EXAMPLES" Traverse a chain looking for digest BIOs: @@ -117,7 +117,7 @@ Traverse a chain looking for digest BIOs: .Ve .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/BIO_get_data.3ssl b/upstream/archlinux/man3/BIO_get_data.3ssl index a4c33f86..439f2153 100644 --- a/upstream/archlinux/man3/BIO_get_data.3ssl +++ b/upstream/archlinux/man3/BIO_get_data.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_GET_DATA 3ssl" -.TH BIO_GET_DATA 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_GET_DATA 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_get_ex_new_index.3ssl b/upstream/archlinux/man3/BIO_get_ex_new_index.3ssl index 141e2629..a76e0cea 100644 --- a/upstream/archlinux/man3/BIO_get_ex_new_index.3ssl +++ b/upstream/archlinux/man3/BIO_get_ex_new_index.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_GET_EX_NEW_INDEX 3ssl" -.TH BIO_GET_EX_NEW_INDEX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_GET_EX_NEW_INDEX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_get_rpoll_descriptor.3ssl b/upstream/archlinux/man3/BIO_get_rpoll_descriptor.3ssl index 2e517d29..322d3359 100644 --- a/upstream/archlinux/man3/BIO_get_rpoll_descriptor.3ssl +++ b/upstream/archlinux/man3/BIO_get_rpoll_descriptor.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_GET_RPOLL_DESCRIPTOR 3ssl" -.TH BIO_GET_RPOLL_DESCRIPTOR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_GET_RPOLL_DESCRIPTOR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_meth_new.3ssl b/upstream/archlinux/man3/BIO_meth_new.3ssl index d4088215..f6531e10 100644 --- a/upstream/archlinux/man3/BIO_meth_new.3ssl +++ b/upstream/archlinux/man3/BIO_meth_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_METH_NEW 3ssl" -.TH BIO_METH_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_METH_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -140,9 +140,13 @@ The \fBBIO_METHOD\fR type is a structure used for the implementation of new BIO types. It provides a set of functions used by OpenSSL for the implementation of the various BIO capabilities. See the \fBbio\fR\|(7) page for more information. .PP -\&\fBBIO_meth_new()\fR creates a new \fBBIO_METHOD\fR structure. It should be given a -unique integer \fBtype\fR and a string that represents its \fBname\fR. -Use \fBBIO_get_new_index()\fR to get the value for \fBtype\fR. +\&\fBBIO_meth_new()\fR creates a new \fBBIO_METHOD\fR structure that contains a type +identifier \fItype\fR and a string that represents its \fBname\fR. +\&\fBtype\fR can be set to either \fBBIO_TYPE_NONE\fR or via \fBBIO_get_new_index()\fR if +a unique type is required for searching (See \fBBIO_find_type\fR\|(3)) +.PP +Note that \fBBIO_get_new_index()\fR can only be used 127 times before it returns an +error. .PP The set of standard OpenSSL provided BIO types is provided in \fI<openssl/bio.h>\fR. @@ -236,7 +240,7 @@ The \fBBIO_meth_get\fR functions return the corresponding function pointers. The functions described here were added in OpenSSL 1.1.0. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2016\-2022 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2016\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/BIO_new.3ssl b/upstream/archlinux/man3/BIO_new.3ssl index c0b24404..13e7a1bf 100644 --- a/upstream/archlinux/man3/BIO_new.3ssl +++ b/upstream/archlinux/man3/BIO_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_NEW 3ssl" -.TH BIO_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_new_CMS.3ssl b/upstream/archlinux/man3/BIO_new_CMS.3ssl index 3f3963c7..6465a829 100644 --- a/upstream/archlinux/man3/BIO_new_CMS.3ssl +++ b/upstream/archlinux/man3/BIO_new_CMS.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_NEW_CMS 3ssl" -.TH BIO_NEW_CMS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_NEW_CMS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_parse_hostserv.3ssl b/upstream/archlinux/man3/BIO_parse_hostserv.3ssl index 1ee0815c..cf7c916f 100644 --- a/upstream/archlinux/man3/BIO_parse_hostserv.3ssl +++ b/upstream/archlinux/man3/BIO_parse_hostserv.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_PARSE_HOSTSERV 3ssl" -.TH BIO_PARSE_HOSTSERV 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_PARSE_HOSTSERV 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_printf.3ssl b/upstream/archlinux/man3/BIO_printf.3ssl index 191ab5d2..5be3773f 100644 --- a/upstream/archlinux/man3/BIO_printf.3ssl +++ b/upstream/archlinux/man3/BIO_printf.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_PRINTF 3ssl" -.TH BIO_PRINTF 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_PRINTF 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_push.3ssl b/upstream/archlinux/man3/BIO_push.3ssl index ca433e1f..1700cd66 100644 --- a/upstream/archlinux/man3/BIO_push.3ssl +++ b/upstream/archlinux/man3/BIO_push.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_PUSH 3ssl" -.TH BIO_PUSH 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_PUSH 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_read.3ssl b/upstream/archlinux/man3/BIO_read.3ssl index 98daccac..7882f0a9 100644 --- a/upstream/archlinux/man3/BIO_read.3ssl +++ b/upstream/archlinux/man3/BIO_read.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_READ 3ssl" -.TH BIO_READ 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_READ 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_s_accept.3ssl b/upstream/archlinux/man3/BIO_s_accept.3ssl index fd206396..90b7af6e 100644 --- a/upstream/archlinux/man3/BIO_s_accept.3ssl +++ b/upstream/archlinux/man3/BIO_s_accept.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_S_ACCEPT 3ssl" -.TH BIO_S_ACCEPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_S_ACCEPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_s_bio.3ssl b/upstream/archlinux/man3/BIO_s_bio.3ssl index 31530acc..8fb371d4 100644 --- a/upstream/archlinux/man3/BIO_s_bio.3ssl +++ b/upstream/archlinux/man3/BIO_s_bio.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_S_BIO 3ssl" -.TH BIO_S_BIO 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_S_BIO 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_s_connect.3ssl b/upstream/archlinux/man3/BIO_s_connect.3ssl index 90a80b48..e343f28f 100644 --- a/upstream/archlinux/man3/BIO_s_connect.3ssl +++ b/upstream/archlinux/man3/BIO_s_connect.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_S_CONNECT 3ssl" -.TH BIO_S_CONNECT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_S_CONNECT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_s_core.3ssl b/upstream/archlinux/man3/BIO_s_core.3ssl index 91482dc8..edfe3067 100644 --- a/upstream/archlinux/man3/BIO_s_core.3ssl +++ b/upstream/archlinux/man3/BIO_s_core.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_S_CORE 3ssl" -.TH BIO_S_CORE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_S_CORE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_s_datagram.3ssl b/upstream/archlinux/man3/BIO_s_datagram.3ssl index cb4462f0..7a59786c 100644 --- a/upstream/archlinux/man3/BIO_s_datagram.3ssl +++ b/upstream/archlinux/man3/BIO_s_datagram.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_S_DATAGRAM 3ssl" -.TH BIO_S_DATAGRAM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_S_DATAGRAM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_s_dgram_pair.3ssl b/upstream/archlinux/man3/BIO_s_dgram_pair.3ssl index a0f62394..bca6df16 100644 --- a/upstream/archlinux/man3/BIO_s_dgram_pair.3ssl +++ b/upstream/archlinux/man3/BIO_s_dgram_pair.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_S_DGRAM_PAIR 3ssl" -.TH BIO_S_DGRAM_PAIR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_S_DGRAM_PAIR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_s_fd.3ssl b/upstream/archlinux/man3/BIO_s_fd.3ssl index b7817e6a..bca0a146 100644 --- a/upstream/archlinux/man3/BIO_s_fd.3ssl +++ b/upstream/archlinux/man3/BIO_s_fd.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_S_FD 3ssl" -.TH BIO_S_FD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_S_FD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_s_file.3ssl b/upstream/archlinux/man3/BIO_s_file.3ssl index f1588eff..6814fe6f 100644 --- a/upstream/archlinux/man3/BIO_s_file.3ssl +++ b/upstream/archlinux/man3/BIO_s_file.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_S_FILE 3ssl" -.TH BIO_S_FILE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_S_FILE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_s_mem.3ssl b/upstream/archlinux/man3/BIO_s_mem.3ssl index b8448a4e..5bbb8679 100644 --- a/upstream/archlinux/man3/BIO_s_mem.3ssl +++ b/upstream/archlinux/man3/BIO_s_mem.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_S_MEM 3ssl" -.TH BIO_S_MEM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_S_MEM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_s_null.3ssl b/upstream/archlinux/man3/BIO_s_null.3ssl index e0c602ba..517b6b23 100644 --- a/upstream/archlinux/man3/BIO_s_null.3ssl +++ b/upstream/archlinux/man3/BIO_s_null.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_S_NULL 3ssl" -.TH BIO_S_NULL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_S_NULL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_s_socket.3ssl b/upstream/archlinux/man3/BIO_s_socket.3ssl index b4cf14c6..39872343 100644 --- a/upstream/archlinux/man3/BIO_s_socket.3ssl +++ b/upstream/archlinux/man3/BIO_s_socket.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_S_SOCKET 3ssl" -.TH BIO_S_SOCKET 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_S_SOCKET 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_sendmmsg.3ssl b/upstream/archlinux/man3/BIO_sendmmsg.3ssl index 37d66c59..c71c4803 100644 --- a/upstream/archlinux/man3/BIO_sendmmsg.3ssl +++ b/upstream/archlinux/man3/BIO_sendmmsg.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_SENDMMSG 3ssl" -.TH BIO_SENDMMSG 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_SENDMMSG 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_set_callback.3ssl b/upstream/archlinux/man3/BIO_set_callback.3ssl index 3c053ba1..95e72756 100644 --- a/upstream/archlinux/man3/BIO_set_callback.3ssl +++ b/upstream/archlinux/man3/BIO_set_callback.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_SET_CALLBACK 3ssl" -.TH BIO_SET_CALLBACK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_SET_CALLBACK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -367,7 +367,7 @@ The \fBBIO_debug_callback_ex()\fR function was added in OpenSSL 3.0. deprecated in OpenSSL 3.0. Use the non-deprecated _ex functions instead. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/BIO_should_retry.3ssl b/upstream/archlinux/man3/BIO_should_retry.3ssl index 585eb7de..37a4a239 100644 --- a/upstream/archlinux/man3/BIO_should_retry.3ssl +++ b/upstream/archlinux/man3/BIO_should_retry.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_SHOULD_RETRY 3ssl" -.TH BIO_SHOULD_RETRY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_SHOULD_RETRY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BIO_socket_wait.3ssl b/upstream/archlinux/man3/BIO_socket_wait.3ssl index eb9f53c2..72406fdf 100644 --- a/upstream/archlinux/man3/BIO_socket_wait.3ssl +++ b/upstream/archlinux/man3/BIO_socket_wait.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BIO_SOCKET_WAIT 3ssl" -.TH BIO_SOCKET_WAIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BIO_SOCKET_WAIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_BLINDING_new.3ssl b/upstream/archlinux/man3/BN_BLINDING_new.3ssl index f8f11f86..cb647ba1 100644 --- a/upstream/archlinux/man3/BN_BLINDING_new.3ssl +++ b/upstream/archlinux/man3/BN_BLINDING_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_BLINDING_NEW 3ssl" -.TH BN_BLINDING_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_BLINDING_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_CTX_new.3ssl b/upstream/archlinux/man3/BN_CTX_new.3ssl index f0922e1b..99e06c53 100644 --- a/upstream/archlinux/man3/BN_CTX_new.3ssl +++ b/upstream/archlinux/man3/BN_CTX_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_CTX_NEW 3ssl" -.TH BN_CTX_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_CTX_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_CTX_start.3ssl b/upstream/archlinux/man3/BN_CTX_start.3ssl index 4536cf04..7d87deb6 100644 --- a/upstream/archlinux/man3/BN_CTX_start.3ssl +++ b/upstream/archlinux/man3/BN_CTX_start.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_CTX_START 3ssl" -.TH BN_CTX_START 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_CTX_START 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_add.3ssl b/upstream/archlinux/man3/BN_add.3ssl index 1ecf0085..20013017 100644 --- a/upstream/archlinux/man3/BN_add.3ssl +++ b/upstream/archlinux/man3/BN_add.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_ADD 3ssl" -.TH BN_ADD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_ADD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -190,7 +190,7 @@ The error codes can be obtained by \fBERR_get_error\fR\|(3). \&\fBBN_add_word\fR\|(3), \fBBN_set_bit\fR\|(3) .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2022 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/BN_add_word.3ssl b/upstream/archlinux/man3/BN_add_word.3ssl index 10ceab5f..9f81e15b 100644 --- a/upstream/archlinux/man3/BN_add_word.3ssl +++ b/upstream/archlinux/man3/BN_add_word.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_ADD_WORD 3ssl" -.TH BN_ADD_WORD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_ADD_WORD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_bn2bin.3ssl b/upstream/archlinux/man3/BN_bn2bin.3ssl index 313a558f..9486d9f9 100644 --- a/upstream/archlinux/man3/BN_bn2bin.3ssl +++ b/upstream/archlinux/man3/BN_bn2bin.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_BN2BIN 3ssl" -.TH BN_BN2BIN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_BN2BIN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_cmp.3ssl b/upstream/archlinux/man3/BN_cmp.3ssl index 94ff5c48..ef17a0e0 100644 --- a/upstream/archlinux/man3/BN_cmp.3ssl +++ b/upstream/archlinux/man3/BN_cmp.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_CMP 3ssl" -.TH BN_CMP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_CMP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_copy.3ssl b/upstream/archlinux/man3/BN_copy.3ssl index f6937950..b3fb5ff5 100644 --- a/upstream/archlinux/man3/BN_copy.3ssl +++ b/upstream/archlinux/man3/BN_copy.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_COPY 3ssl" -.TH BN_COPY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_COPY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_generate_prime.3ssl b/upstream/archlinux/man3/BN_generate_prime.3ssl index 3a0783a0..d5e01b46 100644 --- a/upstream/archlinux/man3/BN_generate_prime.3ssl +++ b/upstream/archlinux/man3/BN_generate_prime.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_GENERATE_PRIME 3ssl" -.TH BN_GENERATE_PRIME 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_GENERATE_PRIME 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_mod_exp_mont.3ssl b/upstream/archlinux/man3/BN_mod_exp_mont.3ssl index fb6d4d96..24b217e4 100644 --- a/upstream/archlinux/man3/BN_mod_exp_mont.3ssl +++ b/upstream/archlinux/man3/BN_mod_exp_mont.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_MOD_EXP_MONT 3ssl" -.TH BN_MOD_EXP_MONT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_MOD_EXP_MONT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_mod_inverse.3ssl b/upstream/archlinux/man3/BN_mod_inverse.3ssl index 2544a428..e80e5604 100644 --- a/upstream/archlinux/man3/BN_mod_inverse.3ssl +++ b/upstream/archlinux/man3/BN_mod_inverse.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_MOD_INVERSE 3ssl" -.TH BN_MOD_INVERSE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_MOD_INVERSE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -90,7 +90,7 @@ NULL on error. The error codes can be obtained by \fBERR_get_error\fR\|(3). \&\fBERR_get_error\fR\|(3), \fBBN_add\fR\|(3) .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2017 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/BN_mod_mul_montgomery.3ssl b/upstream/archlinux/man3/BN_mod_mul_montgomery.3ssl index 22efd184..836a6dd5 100644 --- a/upstream/archlinux/man3/BN_mod_mul_montgomery.3ssl +++ b/upstream/archlinux/man3/BN_mod_mul_montgomery.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_MOD_MUL_MONTGOMERY 3ssl" -.TH BN_MOD_MUL_MONTGOMERY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_MOD_MUL_MONTGOMERY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_mod_mul_reciprocal.3ssl b/upstream/archlinux/man3/BN_mod_mul_reciprocal.3ssl index b4e697c7..863f1a09 100644 --- a/upstream/archlinux/man3/BN_mod_mul_reciprocal.3ssl +++ b/upstream/archlinux/man3/BN_mod_mul_reciprocal.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_MOD_MUL_RECIPROCAL 3ssl" -.TH BN_MOD_MUL_RECIPROCAL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_MOD_MUL_RECIPROCAL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_new.3ssl b/upstream/archlinux/man3/BN_new.3ssl index 6bbdb31d..fcbb3ed2 100644 --- a/upstream/archlinux/man3/BN_new.3ssl +++ b/upstream/archlinux/man3/BN_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_NEW 3ssl" -.TH BN_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_num_bytes.3ssl b/upstream/archlinux/man3/BN_num_bytes.3ssl index 1c2b7e71..96af5f9b 100644 --- a/upstream/archlinux/man3/BN_num_bytes.3ssl +++ b/upstream/archlinux/man3/BN_num_bytes.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_NUM_BYTES 3ssl" -.TH BN_NUM_BYTES 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_NUM_BYTES 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_rand.3ssl b/upstream/archlinux/man3/BN_rand.3ssl index 7bd77185..49a531ca 100644 --- a/upstream/archlinux/man3/BN_rand.3ssl +++ b/upstream/archlinux/man3/BN_rand.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_RAND 3ssl" -.TH BN_RAND 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_RAND 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_security_bits.3ssl b/upstream/archlinux/man3/BN_security_bits.3ssl index 465dda01..d17cab6d 100644 --- a/upstream/archlinux/man3/BN_security_bits.3ssl +++ b/upstream/archlinux/man3/BN_security_bits.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_SECURITY_BITS 3ssl" -.TH BN_SECURITY_BITS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_SECURITY_BITS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_set_bit.3ssl b/upstream/archlinux/man3/BN_set_bit.3ssl index ce3470b6..5d280946 100644 --- a/upstream/archlinux/man3/BN_set_bit.3ssl +++ b/upstream/archlinux/man3/BN_set_bit.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_SET_BIT 3ssl" -.TH BN_SET_BIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_SET_BIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_swap.3ssl b/upstream/archlinux/man3/BN_swap.3ssl index 0c13842e..4e2a05fa 100644 --- a/upstream/archlinux/man3/BN_swap.3ssl +++ b/upstream/archlinux/man3/BN_swap.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_SWAP 3ssl" -.TH BN_SWAP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_SWAP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BN_zero.3ssl b/upstream/archlinux/man3/BN_zero.3ssl index 0039aca4..07f888ca 100644 --- a/upstream/archlinux/man3/BN_zero.3ssl +++ b/upstream/archlinux/man3/BN_zero.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BN_ZERO 3ssl" -.TH BN_ZERO 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BN_ZERO 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/BUF_MEM_new.3ssl b/upstream/archlinux/man3/BUF_MEM_new.3ssl index e454ffc0..2b7be344 100644 --- a/upstream/archlinux/man3/BUF_MEM_new.3ssl +++ b/upstream/archlinux/man3/BUF_MEM_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "BUF_MEM_NEW 3ssl" -.TH BUF_MEM_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH BUF_MEM_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_EncryptedData_decrypt.3ssl b/upstream/archlinux/man3/CMS_EncryptedData_decrypt.3ssl index 5dade976..c3e6b76d 100644 --- a/upstream/archlinux/man3/CMS_EncryptedData_decrypt.3ssl +++ b/upstream/archlinux/man3/CMS_EncryptedData_decrypt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_ENCRYPTEDDATA_DECRYPT 3ssl" -.TH CMS_ENCRYPTEDDATA_DECRYPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_ENCRYPTEDDATA_DECRYPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_EncryptedData_encrypt.3ssl b/upstream/archlinux/man3/CMS_EncryptedData_encrypt.3ssl index 2fe199a9..c5361572 100644 --- a/upstream/archlinux/man3/CMS_EncryptedData_encrypt.3ssl +++ b/upstream/archlinux/man3/CMS_EncryptedData_encrypt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_ENCRYPTEDDATA_ENCRYPT 3ssl" -.TH CMS_ENCRYPTEDDATA_ENCRYPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_ENCRYPTEDDATA_ENCRYPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_EnvelopedData_create.3ssl b/upstream/archlinux/man3/CMS_EnvelopedData_create.3ssl index ec0038dc..9917e14a 100644 --- a/upstream/archlinux/man3/CMS_EnvelopedData_create.3ssl +++ b/upstream/archlinux/man3/CMS_EnvelopedData_create.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_ENVELOPEDDATA_CREATE 3ssl" -.TH CMS_ENVELOPEDDATA_CREATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_ENVELOPEDDATA_CREATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_add0_cert.3ssl b/upstream/archlinux/man3/CMS_add0_cert.3ssl index deb5ab8e..a575004f 100644 --- a/upstream/archlinux/man3/CMS_add0_cert.3ssl +++ b/upstream/archlinux/man3/CMS_add0_cert.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_ADD0_CERT 3ssl" -.TH CMS_ADD0_CERT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_ADD0_CERT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_add1_recipient_cert.3ssl b/upstream/archlinux/man3/CMS_add1_recipient_cert.3ssl index e01fbf32..8deef2d8 100644 --- a/upstream/archlinux/man3/CMS_add1_recipient_cert.3ssl +++ b/upstream/archlinux/man3/CMS_add1_recipient_cert.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_ADD1_RECIPIENT_CERT 3ssl" -.TH CMS_ADD1_RECIPIENT_CERT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_ADD1_RECIPIENT_CERT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_add1_signer.3ssl b/upstream/archlinux/man3/CMS_add1_signer.3ssl index b87f4b68..e3446218 100644 --- a/upstream/archlinux/man3/CMS_add1_signer.3ssl +++ b/upstream/archlinux/man3/CMS_add1_signer.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_ADD1_SIGNER 3ssl" -.TH CMS_ADD1_SIGNER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_ADD1_SIGNER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -154,7 +154,7 @@ structure just added or NULL if an error occurs. \&\fBCMS_final\fR\|(3), .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2014\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2014\-2016 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/CMS_compress.3ssl b/upstream/archlinux/man3/CMS_compress.3ssl index 0b2194f1..8015041b 100644 --- a/upstream/archlinux/man3/CMS_compress.3ssl +++ b/upstream/archlinux/man3/CMS_compress.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_COMPRESS 3ssl" -.TH CMS_COMPRESS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_COMPRESS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_data_create.3ssl b/upstream/archlinux/man3/CMS_data_create.3ssl index 84b9fbae..698b660d 100644 --- a/upstream/archlinux/man3/CMS_data_create.3ssl +++ b/upstream/archlinux/man3/CMS_data_create.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_DATA_CREATE 3ssl" -.TH CMS_DATA_CREATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_DATA_CREATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_decrypt.3ssl b/upstream/archlinux/man3/CMS_decrypt.3ssl index 1b0554de..ec57b05d 100644 --- a/upstream/archlinux/man3/CMS_decrypt.3ssl +++ b/upstream/archlinux/man3/CMS_decrypt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_DECRYPT 3ssl" -.TH CMS_DECRYPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_DECRYPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_digest_create.3ssl b/upstream/archlinux/man3/CMS_digest_create.3ssl index d1f3428d..0f3ea021 100644 --- a/upstream/archlinux/man3/CMS_digest_create.3ssl +++ b/upstream/archlinux/man3/CMS_digest_create.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_DIGEST_CREATE 3ssl" -.TH CMS_DIGEST_CREATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_DIGEST_CREATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_encrypt.3ssl b/upstream/archlinux/man3/CMS_encrypt.3ssl index 110d84df..0e653b9e 100644 --- a/upstream/archlinux/man3/CMS_encrypt.3ssl +++ b/upstream/archlinux/man3/CMS_encrypt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_ENCRYPT 3ssl" -.TH CMS_ENCRYPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_ENCRYPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_final.3ssl b/upstream/archlinux/man3/CMS_final.3ssl index 254f0d86..92abe5cb 100644 --- a/upstream/archlinux/man3/CMS_final.3ssl +++ b/upstream/archlinux/man3/CMS_final.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_FINAL 3ssl" -.TH CMS_FINAL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_FINAL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_get0_RecipientInfos.3ssl b/upstream/archlinux/man3/CMS_get0_RecipientInfos.3ssl index ac32047c..d95d587b 100644 --- a/upstream/archlinux/man3/CMS_get0_RecipientInfos.3ssl +++ b/upstream/archlinux/man3/CMS_get0_RecipientInfos.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_GET0_RECIPIENTINFOS 3ssl" -.TH CMS_GET0_RECIPIENTINFOS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_GET0_RECIPIENTINFOS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_get0_SignerInfos.3ssl b/upstream/archlinux/man3/CMS_get0_SignerInfos.3ssl index b50daf88..8fb5e408 100644 --- a/upstream/archlinux/man3/CMS_get0_SignerInfos.3ssl +++ b/upstream/archlinux/man3/CMS_get0_SignerInfos.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_GET0_SIGNERINFOS 3ssl" -.TH CMS_GET0_SIGNERINFOS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_GET0_SIGNERINFOS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_get0_type.3ssl b/upstream/archlinux/man3/CMS_get0_type.3ssl index 3e7549af..1af764b4 100644 --- a/upstream/archlinux/man3/CMS_get0_type.3ssl +++ b/upstream/archlinux/man3/CMS_get0_type.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_GET0_TYPE 3ssl" -.TH CMS_GET0_TYPE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_GET0_TYPE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_get1_ReceiptRequest.3ssl b/upstream/archlinux/man3/CMS_get1_ReceiptRequest.3ssl index b4b4c7f6..bbf321fa 100644 --- a/upstream/archlinux/man3/CMS_get1_ReceiptRequest.3ssl +++ b/upstream/archlinux/man3/CMS_get1_ReceiptRequest.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_GET1_RECEIPTREQUEST 3ssl" -.TH CMS_GET1_RECEIPTREQUEST 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_GET1_RECEIPTREQUEST 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_sign.3ssl b/upstream/archlinux/man3/CMS_sign.3ssl index c990171f..133f01ea 100644 --- a/upstream/archlinux/man3/CMS_sign.3ssl +++ b/upstream/archlinux/man3/CMS_sign.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_SIGN 3ssl" -.TH CMS_SIGN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_SIGN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_sign_receipt.3ssl b/upstream/archlinux/man3/CMS_sign_receipt.3ssl index 2f2c3c06..f5469282 100644 --- a/upstream/archlinux/man3/CMS_sign_receipt.3ssl +++ b/upstream/archlinux/man3/CMS_sign_receipt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_SIGN_RECEIPT 3ssl" -.TH CMS_SIGN_RECEIPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_SIGN_RECEIPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_signed_get_attr.3ssl b/upstream/archlinux/man3/CMS_signed_get_attr.3ssl index e9558ec1..37dfe0d7 100644 --- a/upstream/archlinux/man3/CMS_signed_get_attr.3ssl +++ b/upstream/archlinux/man3/CMS_signed_get_attr.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_SIGNED_GET_ATTR 3ssl" -.TH CMS_SIGNED_GET_ATTR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_SIGNED_GET_ATTR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_uncompress.3ssl b/upstream/archlinux/man3/CMS_uncompress.3ssl index c6390b6f..59914da7 100644 --- a/upstream/archlinux/man3/CMS_uncompress.3ssl +++ b/upstream/archlinux/man3/CMS_uncompress.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_UNCOMPRESS 3ssl" -.TH CMS_UNCOMPRESS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_UNCOMPRESS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_verify.3ssl b/upstream/archlinux/man3/CMS_verify.3ssl index d9c5422c..ead7cacb 100644 --- a/upstream/archlinux/man3/CMS_verify.3ssl +++ b/upstream/archlinux/man3/CMS_verify.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_VERIFY 3ssl" -.TH CMS_VERIFY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_VERIFY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CMS_verify_receipt.3ssl b/upstream/archlinux/man3/CMS_verify_receipt.3ssl index ceaefee4..a474c5cc 100644 --- a/upstream/archlinux/man3/CMS_verify_receipt.3ssl +++ b/upstream/archlinux/man3/CMS_verify_receipt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CMS_VERIFY_RECEIPT 3ssl" -.TH CMS_VERIFY_RECEIPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CMS_VERIFY_RECEIPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/COMP_CTX_new.3ssl b/upstream/archlinux/man3/COMP_CTX_new.3ssl index f8e5db97..e6bd9121 100644 --- a/upstream/archlinux/man3/COMP_CTX_new.3ssl +++ b/upstream/archlinux/man3/COMP_CTX_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "COMP_CTX_NEW 3ssl" -.TH COMP_CTX_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH COMP_CTX_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CONF_modules_free.3ssl b/upstream/archlinux/man3/CONF_modules_free.3ssl index fbe04dec..8ab3aa76 100644 --- a/upstream/archlinux/man3/CONF_modules_free.3ssl +++ b/upstream/archlinux/man3/CONF_modules_free.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CONF_MODULES_FREE 3ssl" -.TH CONF_MODULES_FREE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CONF_MODULES_FREE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CONF_modules_load_file.3ssl b/upstream/archlinux/man3/CONF_modules_load_file.3ssl index 30d23778..3119391b 100644 --- a/upstream/archlinux/man3/CONF_modules_load_file.3ssl +++ b/upstream/archlinux/man3/CONF_modules_load_file.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CONF_MODULES_LOAD_FILE 3ssl" -.TH CONF_MODULES_LOAD_FILE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CONF_MODULES_LOAD_FILE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CPU_SET.3 b/upstream/archlinux/man3/CPU_SET.3 index 9f3c9a72..e4b3082b 100644 --- a/upstream/archlinux/man3/CPU_SET.3 +++ b/upstream/archlinux/man3/CPU_SET.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH CPU_SET 3 2023-10-31 "Linux man-pages 6.06" +.TH CPU_SET 3 2024-05-02 "Linux man-pages 6.8" .SH NAME CPU_SET, CPU_CLR, CPU_ISSET, CPU_ZERO, CPU_COUNT, CPU_AND, CPU_OR, CPU_XOR, CPU_EQUAL, diff --git a/upstream/archlinux/man3/CRYPTO_THREAD_run_once.3ssl b/upstream/archlinux/man3/CRYPTO_THREAD_run_once.3ssl index 199a20cd..6e6a78fa 100644 --- a/upstream/archlinux/man3/CRYPTO_THREAD_run_once.3ssl +++ b/upstream/archlinux/man3/CRYPTO_THREAD_run_once.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CRYPTO_THREAD_RUN_ONCE 3ssl" -.TH CRYPTO_THREAD_RUN_ONCE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CRYPTO_THREAD_RUN_ONCE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CRYPTO_get_ex_new_index.3ssl b/upstream/archlinux/man3/CRYPTO_get_ex_new_index.3ssl index c6cb2679..46553660 100644 --- a/upstream/archlinux/man3/CRYPTO_get_ex_new_index.3ssl +++ b/upstream/archlinux/man3/CRYPTO_get_ex_new_index.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CRYPTO_GET_EX_NEW_INDEX 3ssl" -.TH CRYPTO_GET_EX_NEW_INDEX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CRYPTO_GET_EX_NEW_INDEX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CRYPTO_memcmp.3ssl b/upstream/archlinux/man3/CRYPTO_memcmp.3ssl index 1a4c5dda..637685db 100644 --- a/upstream/archlinux/man3/CRYPTO_memcmp.3ssl +++ b/upstream/archlinux/man3/CRYPTO_memcmp.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CRYPTO_MEMCMP 3ssl" -.TH CRYPTO_MEMCMP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CRYPTO_MEMCMP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CTLOG_STORE_get0_log_by_id.3ssl b/upstream/archlinux/man3/CTLOG_STORE_get0_log_by_id.3ssl index acee8f9b..ea8d9478 100644 --- a/upstream/archlinux/man3/CTLOG_STORE_get0_log_by_id.3ssl +++ b/upstream/archlinux/man3/CTLOG_STORE_get0_log_by_id.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CTLOG_STORE_GET0_LOG_BY_ID 3ssl" -.TH CTLOG_STORE_GET0_LOG_BY_ID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CTLOG_STORE_GET0_LOG_BY_ID 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CTLOG_STORE_new.3ssl b/upstream/archlinux/man3/CTLOG_STORE_new.3ssl index abd54853..5d868de7 100644 --- a/upstream/archlinux/man3/CTLOG_STORE_new.3ssl +++ b/upstream/archlinux/man3/CTLOG_STORE_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CTLOG_STORE_NEW 3ssl" -.TH CTLOG_STORE_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CTLOG_STORE_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CTLOG_new.3ssl b/upstream/archlinux/man3/CTLOG_new.3ssl index d7151831..9fa304a7 100644 --- a/upstream/archlinux/man3/CTLOG_new.3ssl +++ b/upstream/archlinux/man3/CTLOG_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CTLOG_NEW 3ssl" -.TH CTLOG_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CTLOG_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/CT_POLICY_EVAL_CTX_new.3ssl b/upstream/archlinux/man3/CT_POLICY_EVAL_CTX_new.3ssl index d491bfc8..fa9e22c9 100644 --- a/upstream/archlinux/man3/CT_POLICY_EVAL_CTX_new.3ssl +++ b/upstream/archlinux/man3/CT_POLICY_EVAL_CTX_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "CT_POLICY_EVAL_CTX_NEW 3ssl" -.TH CT_POLICY_EVAL_CTX_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH CT_POLICY_EVAL_CTX_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DEFINE_STACK_OF.3ssl b/upstream/archlinux/man3/DEFINE_STACK_OF.3ssl index 6bb620e9..d89444c2 100644 --- a/upstream/archlinux/man3/DEFINE_STACK_OF.3ssl +++ b/upstream/archlinux/man3/DEFINE_STACK_OF.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DEFINE_STACK_OF 3ssl" -.TH DEFINE_STACK_OF 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DEFINE_STACK_OF 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -98,8 +98,8 @@ OPENSSL_sk_unshift, OPENSSL_sk_value, OPENSSL_sk_zero \& STACK_OF(TYPE) *sk_TYPE_new(sk_TYPE_compfunc compare); \& STACK_OF(TYPE) *sk_TYPE_new_null(void); \& int sk_TYPE_reserve(STACK_OF(TYPE) *sk, int n); -\& void sk_TYPE_free(const STACK_OF(TYPE) *sk); -\& void sk_TYPE_zero(const STACK_OF(TYPE) *sk); +\& void sk_TYPE_free(STACK_OF(TYPE) *sk); +\& void sk_TYPE_zero(STACK_OF(TYPE) *sk); \& TYPE *sk_TYPE_delete(STACK_OF(TYPE) *sk, int i); \& TYPE *sk_TYPE_delete_ptr(STACK_OF(TYPE) *sk, TYPE *ptr); \& int sk_TYPE_push(STACK_OF(TYPE) *sk, const TYPE *ptr); @@ -333,7 +333,6 @@ on error. .PP \&\fBsk_\fR\f(BITYPE\fR\fB_insert\fR(), \fBsk_\fR\f(BITYPE\fR\fB_push\fR() and \fBsk_\fR\f(BITYPE\fR\fB_unshift\fR() return the total number of elements in the stack and 0 if an error occurred. -\&\fBsk_\fR\f(BITYPE\fR\fB_push\fR() further returns \-1 if \fIsk\fR is NULL. .PP \&\fBsk_\fR\f(BITYPE\fR\fB_set\fR() returns a pointer to the replacement element or NULL on error. @@ -358,9 +357,12 @@ From OpenSSL 3.2.0, the \fBsk_\fR\f(BITYPE\fR\fB_find\fR(), \fBsk_\fR\f(BITYPE\f and \fBsk_\fR\f(BITYPE\fR\fB_find_all\fR() calls are read-only and do not sort the stack. To avoid any performance implications this change introduces, \&\fBsk_\fR\f(BITYPE\fR\fB_sort\fR() should be called before these find operations. +.PP +Before OpenSSL 3.3.0 \fBsk_\fR\f(BITYPE\fR\fB_push\fR() returned \-1 if \fIsk\fR was NULL. It +was changed to return 0 in this condition as for other errors. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/DES_random_key.3ssl b/upstream/archlinux/man3/DES_random_key.3ssl index aa43433b..4a44bfe7 100644 --- a/upstream/archlinux/man3/DES_random_key.3ssl +++ b/upstream/archlinux/man3/DES_random_key.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DES_RANDOM_KEY 3ssl" -.TH DES_RANDOM_KEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DES_RANDOM_KEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DH_generate_key.3ssl b/upstream/archlinux/man3/DH_generate_key.3ssl index 7ce8696e..eddd01cb 100644 --- a/upstream/archlinux/man3/DH_generate_key.3ssl +++ b/upstream/archlinux/man3/DH_generate_key.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DH_GENERATE_KEY 3ssl" -.TH DH_GENERATE_KEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DH_GENERATE_KEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DH_generate_parameters.3ssl b/upstream/archlinux/man3/DH_generate_parameters.3ssl index 9c01f5f7..ef8f556d 100644 --- a/upstream/archlinux/man3/DH_generate_parameters.3ssl +++ b/upstream/archlinux/man3/DH_generate_parameters.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DH_GENERATE_PARAMETERS 3ssl" -.TH DH_GENERATE_PARAMETERS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DH_GENERATE_PARAMETERS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -204,7 +204,7 @@ All of these functions were deprecated in OpenSSL 3.0. \&\fBDH_generate_parameters_ex()\fR instead. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/DH_get0_pqg.3ssl b/upstream/archlinux/man3/DH_get0_pqg.3ssl index 9ab55ebe..7e05682b 100644 --- a/upstream/archlinux/man3/DH_get0_pqg.3ssl +++ b/upstream/archlinux/man3/DH_get0_pqg.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DH_GET0_PQG 3ssl" -.TH DH_GET0_PQG 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DH_GET0_PQG 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DH_get_1024_160.3ssl b/upstream/archlinux/man3/DH_get_1024_160.3ssl index 0d6b5ce9..2e1edf10 100644 --- a/upstream/archlinux/man3/DH_get_1024_160.3ssl +++ b/upstream/archlinux/man3/DH_get_1024_160.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DH_GET_1024_160 3ssl" -.TH DH_GET_1024_160 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DH_GET_1024_160 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DH_meth_new.3ssl b/upstream/archlinux/man3/DH_meth_new.3ssl index 27a946f0..397ce3df 100644 --- a/upstream/archlinux/man3/DH_meth_new.3ssl +++ b/upstream/archlinux/man3/DH_meth_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DH_METH_NEW 3ssl" -.TH DH_METH_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DH_METH_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DH_new.3ssl b/upstream/archlinux/man3/DH_new.3ssl index 03c5c0e0..d272bece 100644 --- a/upstream/archlinux/man3/DH_new.3ssl +++ b/upstream/archlinux/man3/DH_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DH_NEW 3ssl" -.TH DH_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DH_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DH_new_by_nid.3ssl b/upstream/archlinux/man3/DH_new_by_nid.3ssl index 8a9279eb..78c01ec7 100644 --- a/upstream/archlinux/man3/DH_new_by_nid.3ssl +++ b/upstream/archlinux/man3/DH_new_by_nid.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DH_NEW_BY_NID 3ssl" -.TH DH_NEW_BY_NID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DH_NEW_BY_NID 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DH_set_method.3ssl b/upstream/archlinux/man3/DH_set_method.3ssl index 8b89ef30..bfed3e11 100644 --- a/upstream/archlinux/man3/DH_set_method.3ssl +++ b/upstream/archlinux/man3/DH_set_method.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DH_SET_METHOD 3ssl" -.TH DH_SET_METHOD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DH_SET_METHOD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DH_size.3ssl b/upstream/archlinux/man3/DH_size.3ssl index 2bcada52..4d3431ba 100644 --- a/upstream/archlinux/man3/DH_size.3ssl +++ b/upstream/archlinux/man3/DH_size.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DH_SIZE 3ssl" -.TH DH_SIZE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DH_SIZE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DSA_SIG_new.3ssl b/upstream/archlinux/man3/DSA_SIG_new.3ssl index cfaf6124..d3b985d6 100644 --- a/upstream/archlinux/man3/DSA_SIG_new.3ssl +++ b/upstream/archlinux/man3/DSA_SIG_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DSA_SIG_NEW 3ssl" -.TH DSA_SIG_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DSA_SIG_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DSA_do_sign.3ssl b/upstream/archlinux/man3/DSA_do_sign.3ssl index 78c5ca10..194e1152 100644 --- a/upstream/archlinux/man3/DSA_do_sign.3ssl +++ b/upstream/archlinux/man3/DSA_do_sign.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DSA_DO_SIGN 3ssl" -.TH DSA_DO_SIGN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DSA_DO_SIGN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DSA_dup_DH.3ssl b/upstream/archlinux/man3/DSA_dup_DH.3ssl index e8581943..c4df384d 100644 --- a/upstream/archlinux/man3/DSA_dup_DH.3ssl +++ b/upstream/archlinux/man3/DSA_dup_DH.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DSA_DUP_DH 3ssl" -.TH DSA_DUP_DH 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DSA_DUP_DH 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DSA_generate_key.3ssl b/upstream/archlinux/man3/DSA_generate_key.3ssl index c1ed7ad9..7735b825 100644 --- a/upstream/archlinux/man3/DSA_generate_key.3ssl +++ b/upstream/archlinux/man3/DSA_generate_key.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DSA_GENERATE_KEY 3ssl" -.TH DSA_GENERATE_KEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DSA_GENERATE_KEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DSA_generate_parameters.3ssl b/upstream/archlinux/man3/DSA_generate_parameters.3ssl index 3bca4a67..e57c442e 100644 --- a/upstream/archlinux/man3/DSA_generate_parameters.3ssl +++ b/upstream/archlinux/man3/DSA_generate_parameters.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DSA_GENERATE_PARAMETERS 3ssl" -.TH DSA_GENERATE_PARAMETERS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DSA_GENERATE_PARAMETERS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -166,7 +166,7 @@ Seed lengths greater than 20 are not supported. \&\fBDSA_generate_parameters_ex()\fR instead. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/DSA_get0_pqg.3ssl b/upstream/archlinux/man3/DSA_get0_pqg.3ssl index 546afc26..7a4b60ce 100644 --- a/upstream/archlinux/man3/DSA_get0_pqg.3ssl +++ b/upstream/archlinux/man3/DSA_get0_pqg.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DSA_GET0_PQG 3ssl" -.TH DSA_GET0_PQG 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DSA_GET0_PQG 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DSA_meth_new.3ssl b/upstream/archlinux/man3/DSA_meth_new.3ssl index 6b112812..cb712f2e 100644 --- a/upstream/archlinux/man3/DSA_meth_new.3ssl +++ b/upstream/archlinux/man3/DSA_meth_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DSA_METH_NEW 3ssl" -.TH DSA_METH_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DSA_METH_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DSA_new.3ssl b/upstream/archlinux/man3/DSA_new.3ssl index 4ebc2334..c561c834 100644 --- a/upstream/archlinux/man3/DSA_new.3ssl +++ b/upstream/archlinux/man3/DSA_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DSA_NEW 3ssl" -.TH DSA_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DSA_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DSA_set_method.3ssl b/upstream/archlinux/man3/DSA_set_method.3ssl index 59ac0670..45a8aaca 100644 --- a/upstream/archlinux/man3/DSA_set_method.3ssl +++ b/upstream/archlinux/man3/DSA_set_method.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DSA_SET_METHOD 3ssl" -.TH DSA_SET_METHOD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DSA_SET_METHOD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DSA_sign.3ssl b/upstream/archlinux/man3/DSA_sign.3ssl index 3ee20fe2..c1a8a3b2 100644 --- a/upstream/archlinux/man3/DSA_sign.3ssl +++ b/upstream/archlinux/man3/DSA_sign.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DSA_SIGN 3ssl" -.TH DSA_SIGN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DSA_SIGN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DSA_size.3ssl b/upstream/archlinux/man3/DSA_size.3ssl index bd6be01a..d22339b2 100644 --- a/upstream/archlinux/man3/DSA_size.3ssl +++ b/upstream/archlinux/man3/DSA_size.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DSA_SIZE 3ssl" -.TH DSA_SIZE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DSA_SIZE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DTLS_get_data_mtu.3ssl b/upstream/archlinux/man3/DTLS_get_data_mtu.3ssl index 49666798..d5ba1321 100644 --- a/upstream/archlinux/man3/DTLS_get_data_mtu.3ssl +++ b/upstream/archlinux/man3/DTLS_get_data_mtu.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DTLS_GET_DATA_MTU 3ssl" -.TH DTLS_GET_DATA_MTU 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DTLS_GET_DATA_MTU 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DTLS_set_timer_cb.3ssl b/upstream/archlinux/man3/DTLS_set_timer_cb.3ssl index ad1644a4..4ce4b810 100644 --- a/upstream/archlinux/man3/DTLS_set_timer_cb.3ssl +++ b/upstream/archlinux/man3/DTLS_set_timer_cb.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DTLS_SET_TIMER_CB 3ssl" -.TH DTLS_SET_TIMER_CB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DTLS_SET_TIMER_CB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DTLSv1_get_timeout.3ssl b/upstream/archlinux/man3/DTLSv1_get_timeout.3ssl index b3ed2e63..a444c5dd 100644 --- a/upstream/archlinux/man3/DTLSv1_get_timeout.3ssl +++ b/upstream/archlinux/man3/DTLSv1_get_timeout.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DTLSV1_GET_TIMEOUT 3ssl" -.TH DTLSV1_GET_TIMEOUT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DTLSV1_GET_TIMEOUT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DTLSv1_handle_timeout.3ssl b/upstream/archlinux/man3/DTLSv1_handle_timeout.3ssl index d9d4c822..bff1b1e7 100644 --- a/upstream/archlinux/man3/DTLSv1_handle_timeout.3ssl +++ b/upstream/archlinux/man3/DTLSv1_handle_timeout.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DTLSV1_HANDLE_TIMEOUT 3ssl" -.TH DTLSV1_HANDLE_TIMEOUT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DTLSV1_HANDLE_TIMEOUT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/DTLSv1_listen.3ssl b/upstream/archlinux/man3/DTLSv1_listen.3ssl index 7bff7957..0bcdf593 100644 --- a/upstream/archlinux/man3/DTLSv1_listen.3ssl +++ b/upstream/archlinux/man3/DTLSv1_listen.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "DTLSV1_LISTEN 3ssl" -.TH DTLSV1_LISTEN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH DTLSV1_LISTEN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ECDSA_SIG_new.3ssl b/upstream/archlinux/man3/ECDSA_SIG_new.3ssl index 44b3b84f..565815d8 100644 --- a/upstream/archlinux/man3/ECDSA_SIG_new.3ssl +++ b/upstream/archlinux/man3/ECDSA_SIG_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ECDSA_SIG_NEW 3ssl" -.TH ECDSA_SIG_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ECDSA_SIG_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ECDSA_sign.3ssl b/upstream/archlinux/man3/ECDSA_sign.3ssl index db9a9642..854767f2 100644 --- a/upstream/archlinux/man3/ECDSA_sign.3ssl +++ b/upstream/archlinux/man3/ECDSA_sign.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ECDSA_SIGN 3ssl" -.TH ECDSA_SIGN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ECDSA_SIGN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ECPKParameters_print.3ssl b/upstream/archlinux/man3/ECPKParameters_print.3ssl index a0950a2e..e555dfc2 100644 --- a/upstream/archlinux/man3/ECPKParameters_print.3ssl +++ b/upstream/archlinux/man3/ECPKParameters_print.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ECPKPARAMETERS_PRINT 3ssl" -.TH ECPKPARAMETERS_PRINT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ECPKPARAMETERS_PRINT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EC_GFp_simple_method.3ssl b/upstream/archlinux/man3/EC_GFp_simple_method.3ssl index cdb2abe4..7a8c4314 100644 --- a/upstream/archlinux/man3/EC_GFp_simple_method.3ssl +++ b/upstream/archlinux/man3/EC_GFp_simple_method.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EC_GFP_SIMPLE_METHOD 3ssl" -.TH EC_GFP_SIMPLE_METHOD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EC_GFP_SIMPLE_METHOD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EC_GROUP_copy.3ssl b/upstream/archlinux/man3/EC_GROUP_copy.3ssl index 1fd5cfa6..b9a43613 100644 --- a/upstream/archlinux/man3/EC_GROUP_copy.3ssl +++ b/upstream/archlinux/man3/EC_GROUP_copy.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EC_GROUP_COPY 3ssl" -.TH EC_GROUP_COPY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EC_GROUP_COPY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EC_GROUP_new.3ssl b/upstream/archlinux/man3/EC_GROUP_new.3ssl index 29764228..08ac779e 100644 --- a/upstream/archlinux/man3/EC_GROUP_new.3ssl +++ b/upstream/archlinux/man3/EC_GROUP_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EC_GROUP_NEW 3ssl" -.TH EC_GROUP_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EC_GROUP_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EC_KEY_get_enc_flags.3ssl b/upstream/archlinux/man3/EC_KEY_get_enc_flags.3ssl index 310fff79..63a9fd82 100644 --- a/upstream/archlinux/man3/EC_KEY_get_enc_flags.3ssl +++ b/upstream/archlinux/man3/EC_KEY_get_enc_flags.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EC_KEY_GET_ENC_FLAGS 3ssl" -.TH EC_KEY_GET_ENC_FLAGS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EC_KEY_GET_ENC_FLAGS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EC_KEY_new.3ssl b/upstream/archlinux/man3/EC_KEY_new.3ssl index f5674d00..c89196b2 100644 --- a/upstream/archlinux/man3/EC_KEY_new.3ssl +++ b/upstream/archlinux/man3/EC_KEY_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EC_KEY_NEW 3ssl" -.TH EC_KEY_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EC_KEY_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EC_POINT_add.3ssl b/upstream/archlinux/man3/EC_POINT_add.3ssl index bc032ab1..24026428 100644 --- a/upstream/archlinux/man3/EC_POINT_add.3ssl +++ b/upstream/archlinux/man3/EC_POINT_add.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EC_POINT_ADD 3ssl" -.TH EC_POINT_ADD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EC_POINT_ADD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EC_POINT_new.3ssl b/upstream/archlinux/man3/EC_POINT_new.3ssl index 6ef12719..9a45d0fa 100644 --- a/upstream/archlinux/man3/EC_POINT_new.3ssl +++ b/upstream/archlinux/man3/EC_POINT_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EC_POINT_NEW 3ssl" -.TH EC_POINT_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EC_POINT_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ENGINE_add.3ssl b/upstream/archlinux/man3/ENGINE_add.3ssl index 3ffc1a8a..d100ebaf 100644 --- a/upstream/archlinux/man3/ENGINE_add.3ssl +++ b/upstream/archlinux/man3/ENGINE_add.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ENGINE_ADD 3ssl" -.TH ENGINE_ADD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ENGINE_ADD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ERR_GET_LIB.3ssl b/upstream/archlinux/man3/ERR_GET_LIB.3ssl index 4af870a6..3cc8bcf2 100644 --- a/upstream/archlinux/man3/ERR_GET_LIB.3ssl +++ b/upstream/archlinux/man3/ERR_GET_LIB.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ERR_GET_LIB 3ssl" -.TH ERR_GET_LIB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ERR_GET_LIB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ERR_clear_error.3ssl b/upstream/archlinux/man3/ERR_clear_error.3ssl index 83ce5c97..57650d12 100644 --- a/upstream/archlinux/man3/ERR_clear_error.3ssl +++ b/upstream/archlinux/man3/ERR_clear_error.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ERR_CLEAR_ERROR 3ssl" -.TH ERR_CLEAR_ERROR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ERR_CLEAR_ERROR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ERR_error_string.3ssl b/upstream/archlinux/man3/ERR_error_string.3ssl index 19ca9490..28abe50e 100644 --- a/upstream/archlinux/man3/ERR_error_string.3ssl +++ b/upstream/archlinux/man3/ERR_error_string.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ERR_ERROR_STRING 3ssl" -.TH ERR_ERROR_STRING 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ERR_ERROR_STRING 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ERR_get_error.3ssl b/upstream/archlinux/man3/ERR_get_error.3ssl index 8bce4af2..88788151 100644 --- a/upstream/archlinux/man3/ERR_get_error.3ssl +++ b/upstream/archlinux/man3/ERR_get_error.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ERR_GET_ERROR 3ssl" -.TH ERR_GET_ERROR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ERR_GET_ERROR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ERR_load_crypto_strings.3ssl b/upstream/archlinux/man3/ERR_load_crypto_strings.3ssl index ee7d10cd..bbb94fbb 100644 --- a/upstream/archlinux/man3/ERR_load_crypto_strings.3ssl +++ b/upstream/archlinux/man3/ERR_load_crypto_strings.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ERR_LOAD_CRYPTO_STRINGS 3ssl" -.TH ERR_LOAD_CRYPTO_STRINGS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ERR_LOAD_CRYPTO_STRINGS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ERR_load_strings.3ssl b/upstream/archlinux/man3/ERR_load_strings.3ssl index 876cebc6..995fcae9 100644 --- a/upstream/archlinux/man3/ERR_load_strings.3ssl +++ b/upstream/archlinux/man3/ERR_load_strings.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ERR_LOAD_STRINGS 3ssl" -.TH ERR_LOAD_STRINGS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ERR_LOAD_STRINGS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ERR_new.3ssl b/upstream/archlinux/man3/ERR_new.3ssl index e93ed45b..ba24e273 100644 --- a/upstream/archlinux/man3/ERR_new.3ssl +++ b/upstream/archlinux/man3/ERR_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ERR_NEW 3ssl" -.TH ERR_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ERR_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ERR_print_errors.3ssl b/upstream/archlinux/man3/ERR_print_errors.3ssl index 7762f6a8..203c4ace 100644 --- a/upstream/archlinux/man3/ERR_print_errors.3ssl +++ b/upstream/archlinux/man3/ERR_print_errors.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ERR_PRINT_ERRORS 3ssl" -.TH ERR_PRINT_ERRORS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ERR_PRINT_ERRORS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ERR_put_error.3ssl b/upstream/archlinux/man3/ERR_put_error.3ssl index 5df8e269..0d6dd49e 100644 --- a/upstream/archlinux/man3/ERR_put_error.3ssl +++ b/upstream/archlinux/man3/ERR_put_error.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ERR_PUT_ERROR 3ssl" -.TH ERR_PUT_ERROR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ERR_PUT_ERROR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ERR_remove_state.3ssl b/upstream/archlinux/man3/ERR_remove_state.3ssl index 635cecdb..a60c139f 100644 --- a/upstream/archlinux/man3/ERR_remove_state.3ssl +++ b/upstream/archlinux/man3/ERR_remove_state.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ERR_REMOVE_STATE 3ssl" -.TH ERR_REMOVE_STATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ERR_REMOVE_STATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/ERR_set_mark.3ssl b/upstream/archlinux/man3/ERR_set_mark.3ssl index 1c8dc3b6..08d804d3 100644 --- a/upstream/archlinux/man3/ERR_set_mark.3ssl +++ b/upstream/archlinux/man3/ERR_set_mark.3ssl @@ -55,14 +55,14 @@ .\" ======================================================================== .\" .IX Title "ERR_SET_MARK 3ssl" -.TH ERR_SET_MARK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH ERR_SET_MARK 3ssl 2024-04-28 3.3.0 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 -ERR_set_mark, ERR_clear_last_mark, ERR_pop_to_mark, ERR_count_to_mark \- set -mark, clear mark and pop errors until mark +ERR_set_mark, ERR_clear_last_mark, ERR_pop_to_mark, ERR_count_to_mark, ERR_pop \- +set mark, clear mark, pop errors until mark and pop last error .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 @@ -72,6 +72,7 @@ mark, clear mark and pop errors until mark \& int ERR_pop_to_mark(void); \& int ERR_clear_last_mark(void); \& int ERR_count_to_mark(void); +\& int ERR_pop(void); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" @@ -86,6 +87,9 @@ The mark is then removed. If there is no mark, the whole stack is removed. \&\fBERR_count_to_mark()\fR returns the number of entries on the error stack above the most recently marked entry, not including that entry. If there is no mark in the error stack, the number of entries in the error stack is returned. +.PP +\&\fBERR_pop()\fR unconditionally pops a single error entry from the top of the error +stack (which is the entry obtainable via \fBERR_peek_last_error\fR\|(3)). .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBERR_set_mark()\fR returns 0 if the error stack is empty, otherwise 1. @@ -95,6 +99,11 @@ error stack, which implies that the stack became empty, otherwise 1. .PP \&\fBERR_count_to_mark()\fR returns the number of error stack entries found above the most recent mark, if any, or the total number of error stack entries. +.PP +\&\fBERR_pop()\fR returns 1 if an error was popped or 0 if the error stack was empty. +.SH HISTORY +.IX Header "HISTORY" +\&\fBERR_pop()\fR was added in OpenSSL 3.3. .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2003\-2023 The OpenSSL Project Authors. All Rights Reserved. diff --git a/upstream/archlinux/man3/EVP_ASYM_CIPHER_free.3ssl b/upstream/archlinux/man3/EVP_ASYM_CIPHER_free.3ssl index 6873ddba..223db80a 100644 --- a/upstream/archlinux/man3/EVP_ASYM_CIPHER_free.3ssl +++ b/upstream/archlinux/man3/EVP_ASYM_CIPHER_free.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_ASYM_CIPHER_FREE 3ssl" -.TH EVP_ASYM_CIPHER_FREE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_ASYM_CIPHER_FREE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_BytesToKey.3ssl b/upstream/archlinux/man3/EVP_BytesToKey.3ssl index c0f9f6e7..f32808f0 100644 --- a/upstream/archlinux/man3/EVP_BytesToKey.3ssl +++ b/upstream/archlinux/man3/EVP_BytesToKey.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_BYTESTOKEY 3ssl" -.TH EVP_BYTESTOKEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_BYTESTOKEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_CIPHER_CTX_get_cipher_data.3ssl b/upstream/archlinux/man3/EVP_CIPHER_CTX_get_cipher_data.3ssl index c7c33efc..3e819cf4 100644 --- a/upstream/archlinux/man3/EVP_CIPHER_CTX_get_cipher_data.3ssl +++ b/upstream/archlinux/man3/EVP_CIPHER_CTX_get_cipher_data.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_CIPHER_CTX_GET_CIPHER_DATA 3ssl" -.TH EVP_CIPHER_CTX_GET_CIPHER_DATA 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_CIPHER_CTX_GET_CIPHER_DATA 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_CIPHER_CTX_get_original_iv.3ssl b/upstream/archlinux/man3/EVP_CIPHER_CTX_get_original_iv.3ssl index cf8f738b..59ed3a0b 100644 --- a/upstream/archlinux/man3/EVP_CIPHER_CTX_get_original_iv.3ssl +++ b/upstream/archlinux/man3/EVP_CIPHER_CTX_get_original_iv.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_CIPHER_CTX_GET_ORIGINAL_IV 3ssl" -.TH EVP_CIPHER_CTX_GET_ORIGINAL_IV 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_CIPHER_CTX_GET_ORIGINAL_IV 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_CIPHER_meth_new.3ssl b/upstream/archlinux/man3/EVP_CIPHER_meth_new.3ssl index fa26fa90..b989527d 100644 --- a/upstream/archlinux/man3/EVP_CIPHER_meth_new.3ssl +++ b/upstream/archlinux/man3/EVP_CIPHER_meth_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_CIPHER_METH_NEW 3ssl" -.TH EVP_CIPHER_METH_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_CIPHER_METH_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_DigestInit.3ssl b/upstream/archlinux/man3/EVP_DigestInit.3ssl index e0417ebf..89d4bad8 100644 --- a/upstream/archlinux/man3/EVP_DigestInit.3ssl +++ b/upstream/archlinux/man3/EVP_DigestInit.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_DIGESTINIT 3ssl" -.TH EVP_DIGESTINIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_DIGESTINIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -71,6 +71,7 @@ EVP_MD_CTX_settable_params, EVP_MD_CTX_gettable_params, EVP_MD_CTX_set_flags, EVP_MD_CTX_clear_flags, EVP_MD_CTX_test_flags, EVP_Q_digest, EVP_Digest, EVP_DigestInit_ex2, EVP_DigestInit_ex, EVP_DigestInit, EVP_DigestUpdate, EVP_DigestFinal_ex, EVP_DigestFinalXOF, EVP_DigestFinal, +EVP_DigestSqueeze, EVP_MD_is_a, EVP_MD_get0_name, EVP_MD_get0_description, EVP_MD_names_do_all, EVP_MD_get0_provider, EVP_MD_get_type, EVP_MD_get_pkey_type, EVP_MD_get_size, EVP_MD_get_block_size, EVP_MD_get_flags, @@ -120,7 +121,8 @@ EVP_MD_CTX_type, EVP_MD_CTX_pkey_ctx, EVP_MD_CTX_md_data \& int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl); \& int EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt); \& int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *s); -\& int EVP_DigestFinalXOF(EVP_MD_CTX *ctx, unsigned char *md, size_t len); +\& int EVP_DigestFinalXOF(EVP_MD_CTX *ctx, unsigned char *out, size_t outlen); +\& int EVP_DigestSqueeze(EVP_MD_CTX *ctx, unsigned char *out, size_t outlen); \& \& EVP_MD_CTX *EVP_MD_CTX_dup(const EVP_MD_CTX *in); \& int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out, const EVP_MD_CTX *in); @@ -329,9 +331,15 @@ initialize a new digest operation. .IP \fBEVP_DigestFinalXOF()\fR 4 .IX Item "EVP_DigestFinalXOF()" Interfaces to extendable-output functions, XOFs, such as SHAKE128 and SHAKE256. -It retrieves the digest value from \fIctx\fR and places it in \fIlen\fR\-sized \fImd\fR. +It retrieves the digest value from \fIctx\fR and places it in \fIoutlen\fR\-sized \fIout\fR. After calling this function no additional calls to \fBEVP_DigestUpdate()\fR can be made, but \fBEVP_DigestInit_ex2()\fR can be called to initialize a new operation. +\&\fBEVP_DigestFinalXOF()\fR may only be called once +.IP \fBEVP_DigestSqueeze()\fR 4 +.IX Item "EVP_DigestSqueeze()" +Similar to \fBEVP_DigestFinalXOF()\fR but allows multiple calls to be made to +squeeze variable length output data. +\&\fBEVP_DigestFinalXOF()\fR should not be called after this. .IP \fBEVP_MD_CTX_dup()\fR 4 .IX Item "EVP_MD_CTX_dup()" Can be used to duplicate the message digest state from \fIin\fR. This is useful @@ -480,16 +488,17 @@ See \fBOSSL_PARAM\fR\|(3) for information about passing parameters. .IP """xoflen"" (\fBOSSL_DIGEST_PARAM_XOFLEN\fR) <unsigned integer>" 4 .IX Item """xoflen"" (OSSL_DIGEST_PARAM_XOFLEN) <unsigned integer>" Sets the digest length for extendable output functions. -It is used by the SHAKE algorithm and should not exceed what can be given -using a \fBsize_t\fR. +The value should not exceed what can be given using a \fBsize_t\fR. +It may be used by BLAKE2B\-512, SHAKE\-128 and SHAKE\-256 to set the +output length used by \fBEVP_DigestFinal_ex()\fR and \fBEVP_DigestFinal()\fR. .IP """pad-type"" (\fBOSSL_DIGEST_PARAM_PAD_TYPE\fR) <unsigned integer>" 4 .IX Item """pad-type"" (OSSL_DIGEST_PARAM_PAD_TYPE) <unsigned integer>" Sets the padding type. It is used by the MDC2 algorithm. .PP \&\fBEVP_MD_CTX_get_params()\fR can be used with the following OSSL_PARAM keys: -.IP """micalg"" (\fBOSSL_PARAM_DIGEST_KEY_MICALG\fR) <UTF8 string>." 4 -.IX Item """micalg"" (OSSL_PARAM_DIGEST_KEY_MICALG) <UTF8 string>." +.IP """micalg"" (\fBOSSL_DIGEST_PARAM_MICALG\fR) <UTF8 string>." 4 +.IX Item """micalg"" (OSSL_DIGEST_PARAM_MICALG) <UTF8 string>." Gets the digest Message Integrity Check algorithm string. This is used when creating S/MIME multipart/signed messages, as specified in RFC 3851. It may be used by external engines or providers. @@ -731,10 +740,12 @@ The \fBEVP_MD_CTX_md()\fR function was deprecated in OpenSSL 3.0; use \&\fBEVP_MD_CTX_update_fn()\fR and \fBEVP_MD_CTX_set_update_fn()\fR were deprecated in OpenSSL 3.0. .PP -\&\fBEVP_MD_CTX_dup()\fR was added in OpenSSL 3.2. +The \fBEVP_MD_CTX_dup()\fR function was added in OpenSSL 3.1. +.PP +The \fBEVP_DigestSqueeze()\fR function was added in OpenSSL 3.3. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/EVP_DigestSignInit.3ssl b/upstream/archlinux/man3/EVP_DigestSignInit.3ssl index 874bc8f1..6717c509 100644 --- a/upstream/archlinux/man3/EVP_DigestSignInit.3ssl +++ b/upstream/archlinux/man3/EVP_DigestSignInit.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_DIGESTSIGNINIT 3ssl" -.TH EVP_DIGESTSIGNINIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_DIGESTSIGNINIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -175,13 +175,12 @@ the \fIsiglen\fR parameter. If \fIsig\fR is not NULL then before the call the call is successful the signature is written to \fIsig\fR and the amount of data written to \fIsiglen\fR. .PP -\&\fBEVP_DigestSign()\fR signs \fItbslen\fR bytes of data at \fItbs\fR and places the -signature in \fIsig\fR and its length in \fIsiglen\fR in a similar way to -\&\fBEVP_DigestSignFinal()\fR. In the event of a failure \fBEVP_DigestSign()\fR cannot be -called again without reinitialising the EVP_MD_CTX. If \fIsig\fR is NULL before the -call then \fIsiglen\fR will be populated with the required size for the \fIsig\fR -buffer. If \fIsig\fR is non-NULL before the call then \fIsiglen\fR should contain the -length of the \fIsig\fR buffer. +\&\fBEVP_DigestSign()\fR is similar to a single call to \fBEVP_DigestSignUpdate()\fR and +\&\fBEVP_DigestSignFinal()\fR. +Unless \fIsig\fR is NULL, \fBEVP_DigestSign()\fR signs the data \fItbs\fR of length \fItbslen\fR +bytes and places the signature in a buffer \fIsig\fR of size \fIsiglen\fR. +If \fIsig\fR is NULL, the maximum necessary size of the signature buffer is written +to the \fIsiglen\fR parameter. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBEVP_DigestSignInit()\fR, \fBEVP_DigestSignUpdate()\fR, \fBEVP_DigestSignFinal()\fR and @@ -224,6 +223,10 @@ multiple times on a context and the parameters set by previous calls should be preserved if the \fIpkey\fR parameter is NULL. The call then just resets the state of the \fIctx\fR. .PP +\&\fBEVP_DigestSign()\fR can not be called again, once a signature is generated (by +passing \fIsig\fR as non NULL), unless the \fBEVP_MD_CTX\fR is reinitialised by +calling \fBEVP_DigestSignInit_ex()\fR. +.PP Ignoring failure returns of \fBEVP_DigestSignInit()\fR and \fBEVP_DigestSignInit_ex()\fR functions can lead to subsequent undefined behavior when calling \&\fBEVP_DigestSignUpdate()\fR, \fBEVP_DigestSignFinal()\fR, or \fBEVP_DigestSign()\fR. @@ -250,7 +253,7 @@ were added in OpenSSL 1.0.0. \&\fBEVP_DigestSignUpdate()\fR was converted from a macro to a function in OpenSSL 3.0. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2006\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2006\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/EVP_DigestVerifyInit.3ssl b/upstream/archlinux/man3/EVP_DigestVerifyInit.3ssl index 7003e199..7eacc49c 100644 --- a/upstream/archlinux/man3/EVP_DigestVerifyInit.3ssl +++ b/upstream/archlinux/man3/EVP_DigestVerifyInit.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_DIGESTVERIFYINIT 3ssl" -.TH EVP_DIGESTVERIFYINIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_DIGESTVERIFYINIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -213,6 +213,9 @@ multiple times on a context and the parameters set by previous calls should be preserved if the \fIpkey\fR parameter is NULL. The call then just resets the state of the \fIctx\fR. .PP +\&\fBEVP_DigestVerify()\fR can only be called once, and cannot be used again without +reinitialising the \fBEVP_MD_CTX\fR by calling \fBEVP_DigestVerifyInit_ex()\fR. +.PP Ignoring failure returns of \fBEVP_DigestVerifyInit()\fR and \fBEVP_DigestVerifyInit_ex()\fR functions can lead to subsequent undefined behavior when calling \&\fBEVP_DigestVerifyUpdate()\fR, \fBEVP_DigestVerifyFinal()\fR, or \fBEVP_DigestVerify()\fR. @@ -235,7 +238,7 @@ were added in OpenSSL 1.0.0. 3.0. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2006\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2006\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/EVP_EncodeInit.3ssl b/upstream/archlinux/man3/EVP_EncodeInit.3ssl index 5ef19ed6..9c8fbf02 100644 --- a/upstream/archlinux/man3/EVP_EncodeInit.3ssl +++ b/upstream/archlinux/man3/EVP_EncodeInit.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_ENCODEINIT 3ssl" -.TH EVP_ENCODEINIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_ENCODEINIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_EncryptInit.3ssl b/upstream/archlinux/man3/EVP_EncryptInit.3ssl index 352e1206..05b77551 100644 --- a/upstream/archlinux/man3/EVP_EncryptInit.3ssl +++ b/upstream/archlinux/man3/EVP_EncryptInit.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_ENCRYPTINIT 3ssl" -.TH EVP_ENCRYPTINIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_ENCRYPTINIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -520,7 +520,9 @@ The cipher objects returned from these functions do not need to be freed with .IX Item "EVP_CIPHER_get_nid() and EVP_CIPHER_CTX_get_nid()" Return the NID of a cipher when passed an \fBEVP_CIPHER\fR or \fBEVP_CIPHER_CTX\fR structure. The actual NID value is an internal value which may not have a -corresponding OBJECT IDENTIFIER. +corresponding OBJECT IDENTIFIER. NID_undef is returned in the event that the +nid is unknown or if the cipher has not been properly initialized via a call to +\&\fBEVP_CipherInit\fR. .IP "\fBEVP_CIPHER_CTX_set_flags()\fR, \fBEVP_CIPHER_CTX_clear_flags()\fR and \fBEVP_CIPHER_CTX_test_flags()\fR" 4 .IX Item "EVP_CIPHER_CTX_set_flags(), EVP_CIPHER_CTX_clear_flags() and EVP_CIPHER_CTX_test_flags()" Sets, clears and tests \fIctx\fR flags. See "FLAGS" below for more information. @@ -552,8 +554,10 @@ length to any value other than the fixed value is an error. .IP "\fBEVP_CIPHER_get_iv_length()\fR and \fBEVP_CIPHER_CTX_get_iv_length()\fR" 4 .IX Item "EVP_CIPHER_get_iv_length() and EVP_CIPHER_CTX_get_iv_length()" Return the IV length of a cipher when passed an \fBEVP_CIPHER\fR or -\&\fBEVP_CIPHER_CTX\fR. It will return zero if the cipher does not use an IV. -The constant \fBEVP_MAX_IV_LENGTH\fR is the maximum IV length for all ciphers. +\&\fBEVP_CIPHER_CTX\fR. It will return zero if the cipher does not use an IV, if +the cipher has not yet been initialized within the \fBEVP_CIPHER_CTX\fR, or if the +passed cipher is NULL. The constant \fBEVP_MAX_IV_LENGTH\fR is the maximum IV +length for all ciphers. .IP \fBEVP_CIPHER_CTX_get_tag_length()\fR 4 .IX Item "EVP_CIPHER_CTX_get_tag_length()" Returns the tag length of an AEAD cipher when passed a \fBEVP_CIPHER_CTX\fR. It will @@ -563,7 +567,8 @@ the tag length has not been set. .IX Item "EVP_CIPHER_get_block_size() and EVP_CIPHER_CTX_get_block_size()" Return the block size of a cipher when passed an \fBEVP_CIPHER\fR or \&\fBEVP_CIPHER_CTX\fR structure. The constant \fBEVP_MAX_BLOCK_LENGTH\fR is also the -maximum block length for all ciphers. +maximum block length for all ciphers. A value of 0 is returned if the cipher +has not been properly initialized with a call to \fBEVP_CipherInit\fR. .IP "\fBEVP_CIPHER_get_type()\fR and \fBEVP_CIPHER_CTX_get_type()\fR" 4 .IX Item "EVP_CIPHER_get_type() and EVP_CIPHER_CTX_get_type()" Return the type of the passed cipher or context. This "type" is the actual NID @@ -598,7 +603,7 @@ Returns an \fBOSSL_PROVIDER\fR pointer to the provider that implements the given .IX Item "EVP_CIPHER_CTX_get0_cipher()" Returns the \fBEVP_CIPHER\fR structure when passed an \fBEVP_CIPHER_CTX\fR structure. \&\fBEVP_CIPHER_CTX_get1_cipher()\fR is the same except the ownership is passed to -the caller. +the caller. Both functions return NULL on error. .IP "\fBEVP_CIPHER_get_mode()\fR and \fBEVP_CIPHER_CTX_get_mode()\fR" 4 .IX Item "EVP_CIPHER_get_mode() and EVP_CIPHER_CTX_get_mode()" Return the block cipher mode: @@ -628,7 +633,8 @@ Sets the AlgorithmIdentifier "parameter" based on the passed cipher. This will typically include any parameters and an IV. The cipher IV (if any) must be set when this call is made. This call should be made before the cipher is actually "used" (before any \fBEVP_EncryptUpdate()\fR, \fBEVP_DecryptUpdate()\fR calls for example). -This function may fail if the cipher does not have any ASN1 support. +This function may fail if the cipher does not have any ASN1 support, or if an +uninitialized cipher is passed to it. .IP \fBEVP_CIPHER_asn1_to_param()\fR 4 .IX Item "EVP_CIPHER_asn1_to_param()" Sets the cipher parameters based on an ASN1 AlgorithmIdentifier "parameter". @@ -1144,8 +1150,9 @@ return 1 for success and 0 for failure. \&\fBEVP_CipherInit_ex2()\fR and \fBEVP_CipherUpdate()\fR return 1 for success and 0 for failure. \&\fBEVP_CipherFinal_ex()\fR returns 0 for a decryption failure or 1 for success. .PP -\&\fBEVP_Cipher()\fR returns 1 on success or 0 on failure, if the flag -\&\fBEVP_CIPH_FLAG_CUSTOM_CIPHER\fR is not set for the cipher. +\&\fBEVP_Cipher()\fR returns 1 on success and <= 0 on failure, if the flag +\&\fBEVP_CIPH_FLAG_CUSTOM_CIPHER\fR is not set for the cipher, or if the cipher has +not been initialized via a call to \fBEVP_CipherInit_ex2\fR. \&\fBEVP_Cipher()\fR returns the number of bytes written to \fIout\fR for encryption / decryption, or the number of bytes authenticated in a call specifying AAD for an AEAD cipher, if the flag \&\fBEVP_CIPH_FLAG_CUSTOM_CIPHER\fR is set for the cipher. @@ -1158,7 +1165,7 @@ return an \fBEVP_CIPHER\fR structure or NULL on error. \&\fBEVP_CIPHER_get_nid()\fR and \fBEVP_CIPHER_CTX_get_nid()\fR return a NID. .PP \&\fBEVP_CIPHER_get_block_size()\fR and \fBEVP_CIPHER_CTX_get_block_size()\fR return the -block size. +block size, or 0 on error. .PP \&\fBEVP_CIPHER_get_key_length()\fR and \fBEVP_CIPHER_CTX_get_key_length()\fR return the key length. @@ -1649,7 +1656,7 @@ The \fBEVP_CIPHER_CTX_flags()\fR macro was deprecated in OpenSSL 1.1.0. \&\fBEVP_CIPHER_CTX_dup()\fR was added in OpenSSL 3.2. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/EVP_KDF.3ssl b/upstream/archlinux/man3/EVP_KDF.3ssl index 010f7cf7..3b39e0a5 100644 --- a/upstream/archlinux/man3/EVP_KDF.3ssl +++ b/upstream/archlinux/man3/EVP_KDF.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_KDF 3ssl" -.TH EVP_KDF 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_KDF 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -79,7 +79,7 @@ EVP_KDF_CTX_gettable_params, EVP_KDF_CTX_settable_params \- EVP KDF routines \& typedef struct evp_kdf_st EVP_KDF; \& typedef struct evp_kdf_ctx_st EVP_KDF_CTX; \& -\& EVP_KDF_CTX *EVP_KDF_CTX_new(const EVP_KDF *kdf); +\& EVP_KDF_CTX *EVP_KDF_CTX_new(EVP_KDF *kdf); \& const EVP_KDF *EVP_KDF_CTX_kdf(EVP_KDF_CTX *ctx); \& void EVP_KDF_CTX_free(EVP_KDF_CTX *ctx); \& EVP_KDF_CTX *EVP_KDF_CTX_dup(const EVP_KDF_CTX *src); @@ -342,7 +342,7 @@ not be considered a breaking change to the API. This functionality was added in OpenSSL 3.0. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2019\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2019\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/EVP_KEM_free.3ssl b/upstream/archlinux/man3/EVP_KEM_free.3ssl index aba4fab7..b6839b97 100644 --- a/upstream/archlinux/man3/EVP_KEM_free.3ssl +++ b/upstream/archlinux/man3/EVP_KEM_free.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_KEM_FREE 3ssl" -.TH EVP_KEM_FREE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_KEM_FREE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_KEYEXCH_free.3ssl b/upstream/archlinux/man3/EVP_KEYEXCH_free.3ssl index 5d5be28c..0d7f68c6 100644 --- a/upstream/archlinux/man3/EVP_KEYEXCH_free.3ssl +++ b/upstream/archlinux/man3/EVP_KEYEXCH_free.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_KEYEXCH_FREE 3ssl" -.TH EVP_KEYEXCH_FREE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_KEYEXCH_FREE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_KEYMGMT.3ssl b/upstream/archlinux/man3/EVP_KEYMGMT.3ssl index 0ca6e087..78950b9c 100644 --- a/upstream/archlinux/man3/EVP_KEYMGMT.3ssl +++ b/upstream/archlinux/man3/EVP_KEYMGMT.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_KEYMGMT 3ssl" -.TH EVP_KEYMGMT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_KEYMGMT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_MAC.3ssl b/upstream/archlinux/man3/EVP_MAC.3ssl index 544b4191..b7e7c597 100644 --- a/upstream/archlinux/man3/EVP_MAC.3ssl +++ b/upstream/archlinux/man3/EVP_MAC.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_MAC 3ssl" -.TH EVP_MAC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_MAC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -327,13 +327,15 @@ This option is used by KMAC. A simple flag to set the MAC digest to not initialise the implementation specific data. The value 0 or 1 is expected. .Sp -This option is used by HMAC. +This option is deprecated and will be removed in a future release. +The option may be set, but is ignored. .IP """digest-oneshot"" (\fBOSSL_MAC_PARAM_DIGEST_ONESHOT\fR) <integer>" 4 .IX Item """digest-oneshot"" (OSSL_MAC_PARAM_DIGEST_ONESHOT) <integer>" A simple flag to set the MAC digest to be a oneshot operation. The value 0 or 1 is expected. .Sp -This option is used by HMAC. +This option is deprecated and will be removed in a future release. +The option may be set, but is ignored. .IP """properties"" (\fBOSSL_MAC_PARAM_PROPERTIES\fR) <UTF8 string>" 4 .IX Item """properties"" (OSSL_MAC_PARAM_PROPERTIES) <UTF8 string>" .PD 0 diff --git a/upstream/archlinux/man3/EVP_MD_meth_new.3ssl b/upstream/archlinux/man3/EVP_MD_meth_new.3ssl index 91905a4e..ce13af2f 100644 --- a/upstream/archlinux/man3/EVP_MD_meth_new.3ssl +++ b/upstream/archlinux/man3/EVP_MD_meth_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_MD_METH_NEW 3ssl" -.TH EVP_MD_METH_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_MD_METH_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_OpenInit.3ssl b/upstream/archlinux/man3/EVP_OpenInit.3ssl index 5850428e..a6c54348 100644 --- a/upstream/archlinux/man3/EVP_OpenInit.3ssl +++ b/upstream/archlinux/man3/EVP_OpenInit.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_OPENINIT 3ssl" -.TH EVP_OPENINIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_OPENINIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PBE_CipherInit.3ssl b/upstream/archlinux/man3/EVP_PBE_CipherInit.3ssl index fc078193..603aa9ff 100644 --- a/upstream/archlinux/man3/EVP_PBE_CipherInit.3ssl +++ b/upstream/archlinux/man3/EVP_PBE_CipherInit.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PBE_CIPHERINIT 3ssl" -.TH EVP_PBE_CIPHERINIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PBE_CIPHERINIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY2PKCS8.3ssl b/upstream/archlinux/man3/EVP_PKEY2PKCS8.3ssl index d97b119f..9d4a7061 100644 --- a/upstream/archlinux/man3/EVP_PKEY2PKCS8.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY2PKCS8.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY2PKCS8 3ssl" -.TH EVP_PKEY2PKCS8 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY2PKCS8 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_ASN1_METHOD.3ssl b/upstream/archlinux/man3/EVP_PKEY_ASN1_METHOD.3ssl index 056eb998..08cbf46b 100644 --- a/upstream/archlinux/man3/EVP_PKEY_ASN1_METHOD.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_ASN1_METHOD.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_ASN1_METHOD 3ssl" -.TH EVP_PKEY_ASN1_METHOD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_ASN1_METHOD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_CTX_ctrl.3ssl b/upstream/archlinux/man3/EVP_PKEY_CTX_ctrl.3ssl index d7516249..bcbf6189 100644 --- a/upstream/archlinux/man3/EVP_PKEY_CTX_ctrl.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_CTX_ctrl.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_CTX_CTRL 3ssl" -.TH EVP_PKEY_CTX_CTRL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_CTX_CTRL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_CTX_get0_libctx.3ssl b/upstream/archlinux/man3/EVP_PKEY_CTX_get0_libctx.3ssl index 4fd8c27b..cc92395c 100644 --- a/upstream/archlinux/man3/EVP_PKEY_CTX_get0_libctx.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_CTX_get0_libctx.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_CTX_GET0_LIBCTX 3ssl" -.TH EVP_PKEY_CTX_GET0_LIBCTX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_CTX_GET0_LIBCTX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_CTX_get0_pkey.3ssl b/upstream/archlinux/man3/EVP_PKEY_CTX_get0_pkey.3ssl index c68b4913..e7464252 100644 --- a/upstream/archlinux/man3/EVP_PKEY_CTX_get0_pkey.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_CTX_get0_pkey.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_CTX_GET0_PKEY 3ssl" -.TH EVP_PKEY_CTX_GET0_PKEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_CTX_GET0_PKEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_CTX_new.3ssl b/upstream/archlinux/man3/EVP_PKEY_CTX_new.3ssl index efec1d93..1f3d07c1 100644 --- a/upstream/archlinux/man3/EVP_PKEY_CTX_new.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_CTX_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_CTX_NEW 3ssl" -.TH EVP_PKEY_CTX_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_CTX_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_CTX_set1_pbe_pass.3ssl b/upstream/archlinux/man3/EVP_PKEY_CTX_set1_pbe_pass.3ssl index e4883b76..c5c60461 100644 --- a/upstream/archlinux/man3/EVP_PKEY_CTX_set1_pbe_pass.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_CTX_set1_pbe_pass.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_CTX_SET1_PBE_PASS 3ssl" -.TH EVP_PKEY_CTX_SET1_PBE_PASS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_CTX_SET1_PBE_PASS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_CTX_set_hkdf_md.3ssl b/upstream/archlinux/man3/EVP_PKEY_CTX_set_hkdf_md.3ssl index b07ea1dd..ea459398 100644 --- a/upstream/archlinux/man3/EVP_PKEY_CTX_set_hkdf_md.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_CTX_set_hkdf_md.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_CTX_SET_HKDF_MD 3ssl" -.TH EVP_PKEY_CTX_SET_HKDF_MD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_CTX_SET_HKDF_MD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_CTX_set_params.3ssl b/upstream/archlinux/man3/EVP_PKEY_CTX_set_params.3ssl index e99ee06f..15da92ff 100644 --- a/upstream/archlinux/man3/EVP_PKEY_CTX_set_params.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_CTX_set_params.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_CTX_SET_PARAMS 3ssl" -.TH EVP_PKEY_CTX_SET_PARAMS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_CTX_SET_PARAMS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_CTX_set_rsa_pss_keygen_md.3ssl b/upstream/archlinux/man3/EVP_PKEY_CTX_set_rsa_pss_keygen_md.3ssl index 13d6d8ec..157275ea 100644 --- a/upstream/archlinux/man3/EVP_PKEY_CTX_set_rsa_pss_keygen_md.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_CTX_set_rsa_pss_keygen_md.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_CTX_SET_RSA_PSS_KEYGEN_MD 3ssl" -.TH EVP_PKEY_CTX_SET_RSA_PSS_KEYGEN_MD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_CTX_SET_RSA_PSS_KEYGEN_MD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_CTX_set_scrypt_N.3ssl b/upstream/archlinux/man3/EVP_PKEY_CTX_set_scrypt_N.3ssl index 933fe4ff..6e38a1ad 100644 --- a/upstream/archlinux/man3/EVP_PKEY_CTX_set_scrypt_N.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_CTX_set_scrypt_N.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_CTX_SET_SCRYPT_N 3ssl" -.TH EVP_PKEY_CTX_SET_SCRYPT_N 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_CTX_SET_SCRYPT_N 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_CTX_set_tls1_prf_md.3ssl b/upstream/archlinux/man3/EVP_PKEY_CTX_set_tls1_prf_md.3ssl index 21ff29e7..9abd72ba 100644 --- a/upstream/archlinux/man3/EVP_PKEY_CTX_set_tls1_prf_md.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_CTX_set_tls1_prf_md.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_CTX_SET_TLS1_PRF_MD 3ssl" -.TH EVP_PKEY_CTX_SET_TLS1_PRF_MD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_CTX_SET_TLS1_PRF_MD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_asn1_get_count.3ssl b/upstream/archlinux/man3/EVP_PKEY_asn1_get_count.3ssl index a319a080..2650c3a3 100644 --- a/upstream/archlinux/man3/EVP_PKEY_asn1_get_count.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_asn1_get_count.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_ASN1_GET_COUNT 3ssl" -.TH EVP_PKEY_ASN1_GET_COUNT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_ASN1_GET_COUNT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_check.3ssl b/upstream/archlinux/man3/EVP_PKEY_check.3ssl index e8715a1a..8b4ff7c7 100644 --- a/upstream/archlinux/man3/EVP_PKEY_check.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_check.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_CHECK 3ssl" -.TH EVP_PKEY_CHECK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_CHECK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_copy_parameters.3ssl b/upstream/archlinux/man3/EVP_PKEY_copy_parameters.3ssl index 622a0ce3..4a78b571 100644 --- a/upstream/archlinux/man3/EVP_PKEY_copy_parameters.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_copy_parameters.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_COPY_PARAMETERS 3ssl" -.TH EVP_PKEY_COPY_PARAMETERS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_COPY_PARAMETERS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_decapsulate.3ssl b/upstream/archlinux/man3/EVP_PKEY_decapsulate.3ssl index d3e39268..e9c94de7 100644 --- a/upstream/archlinux/man3/EVP_PKEY_decapsulate.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_decapsulate.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_DECAPSULATE 3ssl" -.TH EVP_PKEY_DECAPSULATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_DECAPSULATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_decrypt.3ssl b/upstream/archlinux/man3/EVP_PKEY_decrypt.3ssl index d5611297..1f06c7f0 100644 --- a/upstream/archlinux/man3/EVP_PKEY_decrypt.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_decrypt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_DECRYPT 3ssl" -.TH EVP_PKEY_DECRYPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_DECRYPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_derive.3ssl b/upstream/archlinux/man3/EVP_PKEY_derive.3ssl index dffb35b0..9dec47ef 100644 --- a/upstream/archlinux/man3/EVP_PKEY_derive.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_derive.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_DERIVE 3ssl" -.TH EVP_PKEY_DERIVE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_DERIVE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_digestsign_supports_digest.3ssl b/upstream/archlinux/man3/EVP_PKEY_digestsign_supports_digest.3ssl index b2f34bc8..09c024fb 100644 --- a/upstream/archlinux/man3/EVP_PKEY_digestsign_supports_digest.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_digestsign_supports_digest.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_DIGESTSIGN_SUPPORTS_DIGEST 3ssl" -.TH EVP_PKEY_DIGESTSIGN_SUPPORTS_DIGEST 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_DIGESTSIGN_SUPPORTS_DIGEST 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_encapsulate.3ssl b/upstream/archlinux/man3/EVP_PKEY_encapsulate.3ssl index eb686707..f6362633 100644 --- a/upstream/archlinux/man3/EVP_PKEY_encapsulate.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_encapsulate.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_ENCAPSULATE 3ssl" -.TH EVP_PKEY_ENCAPSULATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_ENCAPSULATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_encrypt.3ssl b/upstream/archlinux/man3/EVP_PKEY_encrypt.3ssl index 475ba8d6..319354c0 100644 --- a/upstream/archlinux/man3/EVP_PKEY_encrypt.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_encrypt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_ENCRYPT 3ssl" -.TH EVP_PKEY_ENCRYPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_ENCRYPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_fromdata.3ssl b/upstream/archlinux/man3/EVP_PKEY_fromdata.3ssl index 7305c88e..c09f3d6f 100644 --- a/upstream/archlinux/man3/EVP_PKEY_fromdata.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_fromdata.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_FROMDATA 3ssl" -.TH EVP_PKEY_FROMDATA 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_FROMDATA 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_get_attr.3ssl b/upstream/archlinux/man3/EVP_PKEY_get_attr.3ssl index b4e1aded..5f648238 100644 --- a/upstream/archlinux/man3/EVP_PKEY_get_attr.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_get_attr.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_GET_ATTR 3ssl" -.TH EVP_PKEY_GET_ATTR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_GET_ATTR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_get_default_digest_nid.3ssl b/upstream/archlinux/man3/EVP_PKEY_get_default_digest_nid.3ssl index 566fc8eb..e3ab227c 100644 --- a/upstream/archlinux/man3/EVP_PKEY_get_default_digest_nid.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_get_default_digest_nid.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_GET_DEFAULT_DIGEST_NID 3ssl" -.TH EVP_PKEY_GET_DEFAULT_DIGEST_NID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_GET_DEFAULT_DIGEST_NID 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_get_field_type.3ssl b/upstream/archlinux/man3/EVP_PKEY_get_field_type.3ssl index 7e7e98a2..05ed2ee3 100644 --- a/upstream/archlinux/man3/EVP_PKEY_get_field_type.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_get_field_type.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_GET_FIELD_TYPE 3ssl" -.TH EVP_PKEY_GET_FIELD_TYPE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_GET_FIELD_TYPE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_get_group_name.3ssl b/upstream/archlinux/man3/EVP_PKEY_get_group_name.3ssl index daee8955..2e4090e1 100644 --- a/upstream/archlinux/man3/EVP_PKEY_get_group_name.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_get_group_name.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_GET_GROUP_NAME 3ssl" -.TH EVP_PKEY_GET_GROUP_NAME 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_GET_GROUP_NAME 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_get_size.3ssl b/upstream/archlinux/man3/EVP_PKEY_get_size.3ssl index 14a6350d..d28da27c 100644 --- a/upstream/archlinux/man3/EVP_PKEY_get_size.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_get_size.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_GET_SIZE 3ssl" -.TH EVP_PKEY_GET_SIZE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_GET_SIZE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -139,7 +139,7 @@ were renamed to include \f(CW\*(C`get\*(C'\fR in their names in OpenSSL 3.0, res The old names are kept as non-deprecated alias macros. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2020\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2020\-2021 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/EVP_PKEY_gettable_params.3ssl b/upstream/archlinux/man3/EVP_PKEY_gettable_params.3ssl index 2b5f5274..60ab4f3a 100644 --- a/upstream/archlinux/man3/EVP_PKEY_gettable_params.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_gettable_params.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_GETTABLE_PARAMS 3ssl" -.TH EVP_PKEY_GETTABLE_PARAMS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_GETTABLE_PARAMS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_is_a.3ssl b/upstream/archlinux/man3/EVP_PKEY_is_a.3ssl index 9fa89a56..9c7ced97 100644 --- a/upstream/archlinux/man3/EVP_PKEY_is_a.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_is_a.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_IS_A 3ssl" -.TH EVP_PKEY_IS_A 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_IS_A 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_keygen.3ssl b/upstream/archlinux/man3/EVP_PKEY_keygen.3ssl index b48d0b2f..90626f20 100644 --- a/upstream/archlinux/man3/EVP_PKEY_keygen.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_keygen.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_KEYGEN 3ssl" -.TH EVP_PKEY_KEYGEN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_KEYGEN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_meth_get_count.3ssl b/upstream/archlinux/man3/EVP_PKEY_meth_get_count.3ssl index 28f76fcb..928cc647 100644 --- a/upstream/archlinux/man3/EVP_PKEY_meth_get_count.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_meth_get_count.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_METH_GET_COUNT 3ssl" -.TH EVP_PKEY_METH_GET_COUNT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_METH_GET_COUNT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_meth_new.3ssl b/upstream/archlinux/man3/EVP_PKEY_meth_new.3ssl index b9ca9c93..a47d7ae4 100644 --- a/upstream/archlinux/man3/EVP_PKEY_meth_new.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_meth_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_METH_NEW 3ssl" -.TH EVP_PKEY_METH_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_METH_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_new.3ssl b/upstream/archlinux/man3/EVP_PKEY_new.3ssl index c11407dc..c1b82f18 100644 --- a/upstream/archlinux/man3/EVP_PKEY_new.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_NEW 3ssl" -.TH EVP_PKEY_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_print_private.3ssl b/upstream/archlinux/man3/EVP_PKEY_print_private.3ssl index d9b4ad57..f0353dd9 100644 --- a/upstream/archlinux/man3/EVP_PKEY_print_private.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_print_private.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_PRINT_PRIVATE 3ssl" -.TH EVP_PKEY_PRINT_PRIVATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_PRINT_PRIVATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_set1_RSA.3ssl b/upstream/archlinux/man3/EVP_PKEY_set1_RSA.3ssl index db850654..2ca442d3 100644 --- a/upstream/archlinux/man3/EVP_PKEY_set1_RSA.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_set1_RSA.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_SET1_RSA 3ssl" -.TH EVP_PKEY_SET1_RSA 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_SET1_RSA 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_set1_encoded_public_key.3ssl b/upstream/archlinux/man3/EVP_PKEY_set1_encoded_public_key.3ssl index 4e3ed54d..25df5f5b 100644 --- a/upstream/archlinux/man3/EVP_PKEY_set1_encoded_public_key.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_set1_encoded_public_key.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_SET1_ENCODED_PUBLIC_KEY 3ssl" -.TH EVP_PKEY_SET1_ENCODED_PUBLIC_KEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_SET1_ENCODED_PUBLIC_KEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_set_type.3ssl b/upstream/archlinux/man3/EVP_PKEY_set_type.3ssl index 1f0bfc17..c7002a56 100644 --- a/upstream/archlinux/man3/EVP_PKEY_set_type.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_set_type.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_SET_TYPE 3ssl" -.TH EVP_PKEY_SET_TYPE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_SET_TYPE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_settable_params.3ssl b/upstream/archlinux/man3/EVP_PKEY_settable_params.3ssl index 2f8acbdd..6fb94b31 100644 --- a/upstream/archlinux/man3/EVP_PKEY_settable_params.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_settable_params.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_SETTABLE_PARAMS 3ssl" -.TH EVP_PKEY_SETTABLE_PARAMS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_SETTABLE_PARAMS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_sign.3ssl b/upstream/archlinux/man3/EVP_PKEY_sign.3ssl index d69388b7..2866a74f 100644 --- a/upstream/archlinux/man3/EVP_PKEY_sign.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_sign.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_SIGN 3ssl" -.TH EVP_PKEY_SIGN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_SIGN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_todata.3ssl b/upstream/archlinux/man3/EVP_PKEY_todata.3ssl index 5f60e620..715578d5 100644 --- a/upstream/archlinux/man3/EVP_PKEY_todata.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_todata.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_TODATA 3ssl" -.TH EVP_PKEY_TODATA 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_TODATA 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_verify.3ssl b/upstream/archlinux/man3/EVP_PKEY_verify.3ssl index 7ea8e14e..59bd7e25 100644 --- a/upstream/archlinux/man3/EVP_PKEY_verify.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_verify.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_VERIFY 3ssl" -.TH EVP_PKEY_VERIFY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_VERIFY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_PKEY_verify_recover.3ssl b/upstream/archlinux/man3/EVP_PKEY_verify_recover.3ssl index 01fbb6c3..ee01a879 100644 --- a/upstream/archlinux/man3/EVP_PKEY_verify_recover.3ssl +++ b/upstream/archlinux/man3/EVP_PKEY_verify_recover.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_PKEY_VERIFY_RECOVER 3ssl" -.TH EVP_PKEY_VERIFY_RECOVER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_PKEY_VERIFY_RECOVER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_RAND.3ssl b/upstream/archlinux/man3/EVP_RAND.3ssl index 8156f5d9..194898a0 100644 --- a/upstream/archlinux/man3/EVP_RAND.3ssl +++ b/upstream/archlinux/man3/EVP_RAND.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_RAND 3ssl" -.TH EVP_RAND 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_RAND 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_SIGNATURE.3ssl b/upstream/archlinux/man3/EVP_SIGNATURE.3ssl index 2bf3cfd3..e5db52cf 100644 --- a/upstream/archlinux/man3/EVP_SIGNATURE.3ssl +++ b/upstream/archlinux/man3/EVP_SIGNATURE.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_SIGNATURE 3ssl" -.TH EVP_SIGNATURE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_SIGNATURE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_SealInit.3ssl b/upstream/archlinux/man3/EVP_SealInit.3ssl index 7176123d..c56b2542 100644 --- a/upstream/archlinux/man3/EVP_SealInit.3ssl +++ b/upstream/archlinux/man3/EVP_SealInit.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_SEALINIT 3ssl" -.TH EVP_SEALINIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_SEALINIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_SignInit.3ssl b/upstream/archlinux/man3/EVP_SignInit.3ssl index 15ddd46a..24448ddc 100644 --- a/upstream/archlinux/man3/EVP_SignInit.3ssl +++ b/upstream/archlinux/man3/EVP_SignInit.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_SIGNINIT 3ssl" -.TH EVP_SIGNINIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_SIGNINIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_VerifyInit.3ssl b/upstream/archlinux/man3/EVP_VerifyInit.3ssl index 91aeac29..5f3789c3 100644 --- a/upstream/archlinux/man3/EVP_VerifyInit.3ssl +++ b/upstream/archlinux/man3/EVP_VerifyInit.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_VERIFYINIT 3ssl" -.TH EVP_VERIFYINIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_VERIFYINIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_aes_128_gcm.3ssl b/upstream/archlinux/man3/EVP_aes_128_gcm.3ssl index 59e064ee..f192969d 100644 --- a/upstream/archlinux/man3/EVP_aes_128_gcm.3ssl +++ b/upstream/archlinux/man3/EVP_aes_128_gcm.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_AES_128_GCM 3ssl" -.TH EVP_AES_128_GCM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_AES_128_GCM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_aria_128_gcm.3ssl b/upstream/archlinux/man3/EVP_aria_128_gcm.3ssl index e6fbb24a..8e215447 100644 --- a/upstream/archlinux/man3/EVP_aria_128_gcm.3ssl +++ b/upstream/archlinux/man3/EVP_aria_128_gcm.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_ARIA_128_GCM 3ssl" -.TH EVP_ARIA_128_GCM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_ARIA_128_GCM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_bf_cbc.3ssl b/upstream/archlinux/man3/EVP_bf_cbc.3ssl index e42bf973..eef11525 100644 --- a/upstream/archlinux/man3/EVP_bf_cbc.3ssl +++ b/upstream/archlinux/man3/EVP_bf_cbc.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_BF_CBC 3ssl" -.TH EVP_BF_CBC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_BF_CBC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_blake2b512.3ssl b/upstream/archlinux/man3/EVP_blake2b512.3ssl index a36504d3..f60c46c4 100644 --- a/upstream/archlinux/man3/EVP_blake2b512.3ssl +++ b/upstream/archlinux/man3/EVP_blake2b512.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_BLAKE2B512 3ssl" -.TH EVP_BLAKE2B512 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_BLAKE2B512 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -90,9 +90,8 @@ calling these functions multiple times and should consider using \&\fBEVP_MD_fetch\fR\|(3) with \fBEVP_MD\-BLAKE2\fR\|(7) instead. See "Performance" in \fBcrypto\fR\|(7) for further information. .PP -While the BLAKE2b and BLAKE2s algorithms supports a variable length digest, -this implementation outputs a digest of a fixed length (the maximum length -supported), which is 512\-bits for BLAKE2b and 256\-bits for BLAKE2s. +Both algorithms support a variable-length digest, +but this is only available through \fBEVP_MD\-BLAKE2\fR\|(7). .SH "RETURN VALUES" .IX Header "RETURN VALUES" These functions return a \fBEVP_MD\fR structure that contains the diff --git a/upstream/archlinux/man3/EVP_camellia_128_ecb.3ssl b/upstream/archlinux/man3/EVP_camellia_128_ecb.3ssl index b094afba..7610bd4e 100644 --- a/upstream/archlinux/man3/EVP_camellia_128_ecb.3ssl +++ b/upstream/archlinux/man3/EVP_camellia_128_ecb.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_CAMELLIA_128_ECB 3ssl" -.TH EVP_CAMELLIA_128_ECB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_CAMELLIA_128_ECB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_cast5_cbc.3ssl b/upstream/archlinux/man3/EVP_cast5_cbc.3ssl index 2cc6b81a..d0f1943d 100644 --- a/upstream/archlinux/man3/EVP_cast5_cbc.3ssl +++ b/upstream/archlinux/man3/EVP_cast5_cbc.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_CAST5_CBC 3ssl" -.TH EVP_CAST5_CBC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_CAST5_CBC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_chacha20.3ssl b/upstream/archlinux/man3/EVP_chacha20.3ssl index 01ff7cb3..24210a59 100644 --- a/upstream/archlinux/man3/EVP_chacha20.3ssl +++ b/upstream/archlinux/man3/EVP_chacha20.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_CHACHA20 3ssl" -.TH EVP_CHACHA20 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_CHACHA20 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_des_cbc.3ssl b/upstream/archlinux/man3/EVP_des_cbc.3ssl index b7f53ef5..1cd4a880 100644 --- a/upstream/archlinux/man3/EVP_des_cbc.3ssl +++ b/upstream/archlinux/man3/EVP_des_cbc.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_DES_CBC 3ssl" -.TH EVP_DES_CBC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_DES_CBC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_desx_cbc.3ssl b/upstream/archlinux/man3/EVP_desx_cbc.3ssl index 3e0f2c5a..8d719412 100644 --- a/upstream/archlinux/man3/EVP_desx_cbc.3ssl +++ b/upstream/archlinux/man3/EVP_desx_cbc.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_DESX_CBC 3ssl" -.TH EVP_DESX_CBC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_DESX_CBC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_idea_cbc.3ssl b/upstream/archlinux/man3/EVP_idea_cbc.3ssl index 3e093686..efdf6f3a 100644 --- a/upstream/archlinux/man3/EVP_idea_cbc.3ssl +++ b/upstream/archlinux/man3/EVP_idea_cbc.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_IDEA_CBC 3ssl" -.TH EVP_IDEA_CBC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_IDEA_CBC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_md2.3ssl b/upstream/archlinux/man3/EVP_md2.3ssl index 7d1cdc62..87e87a02 100644 --- a/upstream/archlinux/man3/EVP_md2.3ssl +++ b/upstream/archlinux/man3/EVP_md2.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_MD2 3ssl" -.TH EVP_MD2 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_MD2 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_md4.3ssl b/upstream/archlinux/man3/EVP_md4.3ssl index d0f631dc..f8c69b3a 100644 --- a/upstream/archlinux/man3/EVP_md4.3ssl +++ b/upstream/archlinux/man3/EVP_md4.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_MD4 3ssl" -.TH EVP_MD4 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_MD4 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_md5.3ssl b/upstream/archlinux/man3/EVP_md5.3ssl index 10d6c2f7..1e49cb2b 100644 --- a/upstream/archlinux/man3/EVP_md5.3ssl +++ b/upstream/archlinux/man3/EVP_md5.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_MD5 3ssl" -.TH EVP_MD5 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_MD5 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_mdc2.3ssl b/upstream/archlinux/man3/EVP_mdc2.3ssl index 05a65492..ea16141b 100644 --- a/upstream/archlinux/man3/EVP_mdc2.3ssl +++ b/upstream/archlinux/man3/EVP_mdc2.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_MDC2 3ssl" -.TH EVP_MDC2 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_MDC2 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_rc2_cbc.3ssl b/upstream/archlinux/man3/EVP_rc2_cbc.3ssl index 1dbd6103..5f696a3f 100644 --- a/upstream/archlinux/man3/EVP_rc2_cbc.3ssl +++ b/upstream/archlinux/man3/EVP_rc2_cbc.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_RC2_CBC 3ssl" -.TH EVP_RC2_CBC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_RC2_CBC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_rc4.3ssl b/upstream/archlinux/man3/EVP_rc4.3ssl index 90124229..35987a8d 100644 --- a/upstream/archlinux/man3/EVP_rc4.3ssl +++ b/upstream/archlinux/man3/EVP_rc4.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_RC4 3ssl" -.TH EVP_RC4 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_RC4 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_rc5_32_12_16_cbc.3ssl b/upstream/archlinux/man3/EVP_rc5_32_12_16_cbc.3ssl index 20e68de2..b24e7368 100644 --- a/upstream/archlinux/man3/EVP_rc5_32_12_16_cbc.3ssl +++ b/upstream/archlinux/man3/EVP_rc5_32_12_16_cbc.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_RC5_32_12_16_CBC 3ssl" -.TH EVP_RC5_32_12_16_CBC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_RC5_32_12_16_CBC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_ripemd160.3ssl b/upstream/archlinux/man3/EVP_ripemd160.3ssl index b3a01c07..125d4c3f 100644 --- a/upstream/archlinux/man3/EVP_ripemd160.3ssl +++ b/upstream/archlinux/man3/EVP_ripemd160.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_RIPEMD160 3ssl" -.TH EVP_RIPEMD160 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_RIPEMD160 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_seed_cbc.3ssl b/upstream/archlinux/man3/EVP_seed_cbc.3ssl index 0a8a2bad..edf22887 100644 --- a/upstream/archlinux/man3/EVP_seed_cbc.3ssl +++ b/upstream/archlinux/man3/EVP_seed_cbc.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_SEED_CBC 3ssl" -.TH EVP_SEED_CBC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_SEED_CBC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_set_default_properties.3ssl b/upstream/archlinux/man3/EVP_set_default_properties.3ssl index 113ea44e..8f96604c 100644 --- a/upstream/archlinux/man3/EVP_set_default_properties.3ssl +++ b/upstream/archlinux/man3/EVP_set_default_properties.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_SET_DEFAULT_PROPERTIES 3ssl" -.TH EVP_SET_DEFAULT_PROPERTIES 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_SET_DEFAULT_PROPERTIES 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_sha1.3ssl b/upstream/archlinux/man3/EVP_sha1.3ssl index 86232b6e..f6b3699e 100644 --- a/upstream/archlinux/man3/EVP_sha1.3ssl +++ b/upstream/archlinux/man3/EVP_sha1.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_SHA1 3ssl" -.TH EVP_SHA1 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_SHA1 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_sha224.3ssl b/upstream/archlinux/man3/EVP_sha224.3ssl index 69c56600..2f6e3ad2 100644 --- a/upstream/archlinux/man3/EVP_sha224.3ssl +++ b/upstream/archlinux/man3/EVP_sha224.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_SHA224 3ssl" -.TH EVP_SHA224 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_SHA224 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_sha3_224.3ssl b/upstream/archlinux/man3/EVP_sha3_224.3ssl index c99d353d..28cf93aa 100644 --- a/upstream/archlinux/man3/EVP_sha3_224.3ssl +++ b/upstream/archlinux/man3/EVP_sha3_224.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_SHA3_224 3ssl" -.TH EVP_SHA3_224 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_SHA3_224 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_sm3.3ssl b/upstream/archlinux/man3/EVP_sm3.3ssl index b1f27f1c..a95d4e9a 100644 --- a/upstream/archlinux/man3/EVP_sm3.3ssl +++ b/upstream/archlinux/man3/EVP_sm3.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_SM3 3ssl" -.TH EVP_SM3 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_SM3 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_sm4_cbc.3ssl b/upstream/archlinux/man3/EVP_sm4_cbc.3ssl index 19aeafc1..08f15efc 100644 --- a/upstream/archlinux/man3/EVP_sm4_cbc.3ssl +++ b/upstream/archlinux/man3/EVP_sm4_cbc.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_SM4_CBC 3ssl" -.TH EVP_SM4_CBC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_SM4_CBC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/EVP_whirlpool.3ssl b/upstream/archlinux/man3/EVP_whirlpool.3ssl index 4b8aa6d4..285fe8c2 100644 --- a/upstream/archlinux/man3/EVP_whirlpool.3ssl +++ b/upstream/archlinux/man3/EVP_whirlpool.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_WHIRLPOOL 3ssl" -.TH EVP_WHIRLPOOL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_WHIRLPOOL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/HMAC.3ssl b/upstream/archlinux/man3/HMAC.3ssl index 7b7252d1..07721bf6 100644 --- a/upstream/archlinux/man3/HMAC.3ssl +++ b/upstream/archlinux/man3/HMAC.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "HMAC 3ssl" -.TH HMAC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH HMAC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/INFINITY.3 b/upstream/archlinux/man3/INFINITY.3 index 9c5f2b0c..10afb4cb 100644 --- a/upstream/archlinux/man3/INFINITY.3 +++ b/upstream/archlinux/man3/INFINITY.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH INFINITY 3 2023-10-31 "Linux man-pages 6.06" +.TH INFINITY 3 2024-05-02 "Linux man-pages 6.8" .SH NAME INFINITY, NAN, HUGE_VAL, HUGE_VALF, HUGE_VALL \- floating-point constants .SH LIBRARY diff --git a/upstream/archlinux/man3/MAX.3 b/upstream/archlinux/man3/MAX.3 index c02c9b6c..9d71f8c4 100644 --- a/upstream/archlinux/man3/MAX.3 +++ b/upstream/archlinux/man3/MAX.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH MAX 3 2023-10-31 "Linux man-pages 6.06" +.TH MAX 3 2024-05-02 "Linux man-pages 6.8" .SH NAME MAX, MIN \- maximum or minimum of two values .SH LIBRARY diff --git a/upstream/archlinux/man3/MB_CUR_MAX.3 b/upstream/archlinux/man3/MB_CUR_MAX.3 index a9a709be..716dffea 100644 --- a/upstream/archlinux/man3/MB_CUR_MAX.3 +++ b/upstream/archlinux/man3/MB_CUR_MAX.3 @@ -9,7 +9,7 @@ .\" .\" Modified, aeb, 990824 .\" -.TH MB_CUR_MAX 3 2023-03-30 "Linux man-pages 6.06" +.TH MB_CUR_MAX 3 2024-05-02 "Linux man-pages 6.8" .SH NAME MB_CUR_MAX \- maximum length of a multibyte character in the current locale .SH LIBRARY diff --git a/upstream/archlinux/man3/MB_LEN_MAX.3 b/upstream/archlinux/man3/MB_LEN_MAX.3 index 77b3a296..95ef2652 100644 --- a/upstream/archlinux/man3/MB_LEN_MAX.3 +++ b/upstream/archlinux/man3/MB_LEN_MAX.3 @@ -9,7 +9,7 @@ .\" .\" Modified, aeb, 990824 .\" -.TH MB_LEN_MAX 3 2023-03-30 "Linux man-pages 6.06" +.TH MB_LEN_MAX 3 2024-05-02 "Linux man-pages 6.8" .SH NAME MB_LEN_MAX \- maximum multibyte length of a character across all locales .SH LIBRARY diff --git a/upstream/archlinux/man3/MD5.3ssl b/upstream/archlinux/man3/MD5.3ssl index bd55067d..290b20db 100644 --- a/upstream/archlinux/man3/MD5.3ssl +++ b/upstream/archlinux/man3/MD5.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "MD5 3ssl" -.TH MD5 3ssl 2024-01-30 3.2.1 OpenSSL +.TH MD5 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/MDC2_Init.3ssl b/upstream/archlinux/man3/MDC2_Init.3ssl index 0e3dff52..1a970420 100644 --- a/upstream/archlinux/man3/MDC2_Init.3ssl +++ b/upstream/archlinux/man3/MDC2_Init.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "MDC2_INIT 3ssl" -.TH MDC2_INIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH MDC2_INIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/NCONF_new_ex.3ssl b/upstream/archlinux/man3/NCONF_new_ex.3ssl index 4fafc234..743be290 100644 --- a/upstream/archlinux/man3/NCONF_new_ex.3ssl +++ b/upstream/archlinux/man3/NCONF_new_ex.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "NCONF_NEW_EX 3ssl" -.TH NCONF_NEW_EX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH NCONF_NEW_EX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OBJ_nid2obj.3ssl b/upstream/archlinux/man3/OBJ_nid2obj.3ssl index b85cbae0..242e9d66 100644 --- a/upstream/archlinux/man3/OBJ_nid2obj.3ssl +++ b/upstream/archlinux/man3/OBJ_nid2obj.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OBJ_NID2OBJ 3ssl" -.TH OBJ_NID2OBJ 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OBJ_NID2OBJ 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OCSP_REQUEST_new.3ssl b/upstream/archlinux/man3/OCSP_REQUEST_new.3ssl index 78ccc0b3..d10f3ce8 100644 --- a/upstream/archlinux/man3/OCSP_REQUEST_new.3ssl +++ b/upstream/archlinux/man3/OCSP_REQUEST_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OCSP_REQUEST_NEW 3ssl" -.TH OCSP_REQUEST_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OCSP_REQUEST_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OCSP_cert_to_id.3ssl b/upstream/archlinux/man3/OCSP_cert_to_id.3ssl index 2fdf73c2..28c5bdfa 100644 --- a/upstream/archlinux/man3/OCSP_cert_to_id.3ssl +++ b/upstream/archlinux/man3/OCSP_cert_to_id.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OCSP_CERT_TO_ID 3ssl" -.TH OCSP_CERT_TO_ID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OCSP_CERT_TO_ID 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OCSP_request_add1_nonce.3ssl b/upstream/archlinux/man3/OCSP_request_add1_nonce.3ssl index 8054b96f..63ddd40d 100644 --- a/upstream/archlinux/man3/OCSP_request_add1_nonce.3ssl +++ b/upstream/archlinux/man3/OCSP_request_add1_nonce.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OCSP_REQUEST_ADD1_NONCE 3ssl" -.TH OCSP_REQUEST_ADD1_NONCE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OCSP_REQUEST_ADD1_NONCE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OCSP_resp_find_status.3ssl b/upstream/archlinux/man3/OCSP_resp_find_status.3ssl index 38a843b7..0e617e8a 100644 --- a/upstream/archlinux/man3/OCSP_resp_find_status.3ssl +++ b/upstream/archlinux/man3/OCSP_resp_find_status.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OCSP_RESP_FIND_STATUS 3ssl" -.TH OCSP_RESP_FIND_STATUS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OCSP_RESP_FIND_STATUS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OCSP_response_status.3ssl b/upstream/archlinux/man3/OCSP_response_status.3ssl index 3351e409..1ecba206 100644 --- a/upstream/archlinux/man3/OCSP_response_status.3ssl +++ b/upstream/archlinux/man3/OCSP_response_status.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OCSP_RESPONSE_STATUS 3ssl" -.TH OCSP_RESPONSE_STATUS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OCSP_RESPONSE_STATUS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OCSP_sendreq_new.3ssl b/upstream/archlinux/man3/OCSP_sendreq_new.3ssl index f8058658..8df922bd 100644 --- a/upstream/archlinux/man3/OCSP_sendreq_new.3ssl +++ b/upstream/archlinux/man3/OCSP_sendreq_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OCSP_SENDREQ_NEW 3ssl" -.TH OCSP_SENDREQ_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OCSP_SENDREQ_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_Applink.3ssl b/upstream/archlinux/man3/OPENSSL_Applink.3ssl index 7e09e51c..fa1a3fea 100644 --- a/upstream/archlinux/man3/OPENSSL_Applink.3ssl +++ b/upstream/archlinux/man3/OPENSSL_Applink.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_APPLINK 3ssl" -.TH OPENSSL_APPLINK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_APPLINK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_FILE.3ssl b/upstream/archlinux/man3/OPENSSL_FILE.3ssl index 2f817204..ba3bbf91 100644 --- a/upstream/archlinux/man3/OPENSSL_FILE.3ssl +++ b/upstream/archlinux/man3/OPENSSL_FILE.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_FILE 3ssl" -.TH OPENSSL_FILE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_FILE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_LH_COMPFUNC.3ssl b/upstream/archlinux/man3/OPENSSL_LH_COMPFUNC.3ssl index 1c86c81d..aa2a5090 100644 --- a/upstream/archlinux/man3/OPENSSL_LH_COMPFUNC.3ssl +++ b/upstream/archlinux/man3/OPENSSL_LH_COMPFUNC.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_LH_COMPFUNC 3ssl" -.TH OPENSSL_LH_COMPFUNC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_LH_COMPFUNC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -71,7 +71,8 @@ lh_TYPE_doall, lh_TYPE_doall_arg, lh_TYPE_num_items, lh_TYPE_get_down_load, lh_TYPE_set_down_load, lh_TYPE_error, OPENSSL_LH_new, OPENSSL_LH_free, OPENSSL_LH_flush, OPENSSL_LH_insert, OPENSSL_LH_delete, OPENSSL_LH_retrieve, -OPENSSL_LH_doall, OPENSSL_LH_doall_arg, OPENSSL_LH_num_items, +OPENSSL_LH_doall, OPENSSL_LH_doall_arg, OPENSSL_LH_doall_arg_thunk, +OPENSSL_LH_set_thunks, OPENSSL_LH_num_items, OPENSSL_LH_get_down_load, OPENSSL_LH_set_down_load, OPENSSL_LH_error \&\- dynamic hash table .SH SYNOPSIS @@ -86,6 +87,11 @@ OPENSSL_LH_get_down_load, OPENSSL_LH_set_down_load, OPENSSL_LH_error \& LHASH_OF(TYPE) *lh_TYPE_new(OPENSSL_LH_HASHFUNC hash, OPENSSL_LH_COMPFUNC compare); \& void lh_TYPE_free(LHASH_OF(TYPE) *table); \& void lh_TYPE_flush(LHASH_OF(TYPE) *table); +\& OPENSSL_LHASH *OPENSSL_LH_set_thunks(OPENSSL_LHASH *lh, +\& OPENSSL_LH_HASHFUNCTHUNK hw, +\& OPENSSL_LH_COMPFUNCTHUNK cw, +\& OPENSSL_LH_DOALL_FUNC_THUNK daw, +\& OPENSSL_LH_DOALL_FUNCARG_THUNK daaw) \& \& TYPE *lh_TYPE_insert(LHASH_OF(TYPE) *table, TYPE *data); \& TYPE *lh_TYPE_delete(LHASH_OF(TYPE) *table, TYPE *data); @@ -94,6 +100,9 @@ OPENSSL_LH_get_down_load, OPENSSL_LH_set_down_load, OPENSSL_LH_error \& void lh_TYPE_doall(LHASH_OF(TYPE) *table, OPENSSL_LH_DOALL_FUNC func); \& void lh_TYPE_doall_arg(LHASH_OF(TYPE) *table, OPENSSL_LH_DOALL_FUNCARG func, \& TYPE *arg); +\& void OPENSSL_LH_doall_arg_thunk(OPENSSL_LHASH *lh, +\& OPENSSL_LH_DOALL_FUNCARG_THUNK daaw, +\& OPENSSL_LH_DOALL_FUNCARG fn, void *arg) \& \& unsigned long lh_TYPE_num_items(OPENSSL_LHASH *lh); \& unsigned long lh_TYPE_get_down_load(OPENSSL_LHASH *lh); @@ -300,6 +309,9 @@ functions except that they return or use a \fBvoid *\fR where the equivalent \&\fBlh_\fR\f(BITYPE\fR\fB\fR functions are implemented as type checked wrappers around the \&\fBOPENSSL_LH\fR functions. Most applications should not call the \fBOPENSSL_LH\fR functions directly. +.PP +\&\fBOPENSSL_LH_set_thunks()\fR and \fBOPENSSL_LH_doall_arg_thunk()\fR, while public by +necessity, are actually internal functions and should not be used. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBlh_\fR\f(BITYPE\fR\fB_new\fR() and \fBOPENSSL_LH_new()\fR return NULL on error, otherwise a @@ -377,7 +389,7 @@ In OpenSSL 3.1, \fBDEFINE_LHASH_OF_EX\fR() was introduced and \fBDEFINE_LHASH_OF was deprecated. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/OPENSSL_LH_stats.3ssl b/upstream/archlinux/man3/OPENSSL_LH_stats.3ssl index 22680093..4ef08ea2 100644 --- a/upstream/archlinux/man3/OPENSSL_LH_stats.3ssl +++ b/upstream/archlinux/man3/OPENSSL_LH_stats.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_LH_STATS 3ssl" -.TH OPENSSL_LH_STATS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_LH_STATS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -126,7 +126,7 @@ when using the LHASH data structure. These functions were deprecated in version 3.1. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2022 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/OPENSSL_config.3ssl b/upstream/archlinux/man3/OPENSSL_config.3ssl index 296cfaa4..244d6613 100644 --- a/upstream/archlinux/man3/OPENSSL_config.3ssl +++ b/upstream/archlinux/man3/OPENSSL_config.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_CONFIG 3ssl" -.TH OPENSSL_CONFIG 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_CONFIG 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_fork_prepare.3ssl b/upstream/archlinux/man3/OPENSSL_fork_prepare.3ssl index 4404eea6..bf11fd35 100644 --- a/upstream/archlinux/man3/OPENSSL_fork_prepare.3ssl +++ b/upstream/archlinux/man3/OPENSSL_fork_prepare.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_FORK_PREPARE 3ssl" -.TH OPENSSL_FORK_PREPARE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_FORK_PREPARE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_gmtime.3ssl b/upstream/archlinux/man3/OPENSSL_gmtime.3ssl index 0193e4ea..485c9af5 100644 --- a/upstream/archlinux/man3/OPENSSL_gmtime.3ssl +++ b/upstream/archlinux/man3/OPENSSL_gmtime.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_GMTIME 3ssl" -.TH OPENSSL_GMTIME 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_GMTIME 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_hexchar2int.3ssl b/upstream/archlinux/man3/OPENSSL_hexchar2int.3ssl index 74d760fd..5a8068fe 100644 --- a/upstream/archlinux/man3/OPENSSL_hexchar2int.3ssl +++ b/upstream/archlinux/man3/OPENSSL_hexchar2int.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_HEXCHAR2INT 3ssl" -.TH OPENSSL_HEXCHAR2INT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_HEXCHAR2INT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_ia32cap.3ssl b/upstream/archlinux/man3/OPENSSL_ia32cap.3ssl index ff0bec28..76bdfecc 100644 --- a/upstream/archlinux/man3/OPENSSL_ia32cap.3ssl +++ b/upstream/archlinux/man3/OPENSSL_ia32cap.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_IA32CAP 3ssl" -.TH OPENSSL_IA32CAP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_IA32CAP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_init_crypto.3ssl b/upstream/archlinux/man3/OPENSSL_init_crypto.3ssl index 5e78e066..5b045754 100644 --- a/upstream/archlinux/man3/OPENSSL_init_crypto.3ssl +++ b/upstream/archlinux/man3/OPENSSL_init_crypto.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_INIT_CRYPTO 3ssl" -.TH OPENSSL_INIT_CRYPTO 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_INIT_CRYPTO 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_init_ssl.3ssl b/upstream/archlinux/man3/OPENSSL_init_ssl.3ssl index 29a726e8..90762306 100644 --- a/upstream/archlinux/man3/OPENSSL_init_ssl.3ssl +++ b/upstream/archlinux/man3/OPENSSL_init_ssl.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_INIT_SSL 3ssl" -.TH OPENSSL_INIT_SSL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_INIT_SSL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_instrument_bus.3ssl b/upstream/archlinux/man3/OPENSSL_instrument_bus.3ssl index bd356c8d..1e2a02a1 100644 --- a/upstream/archlinux/man3/OPENSSL_instrument_bus.3ssl +++ b/upstream/archlinux/man3/OPENSSL_instrument_bus.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_INSTRUMENT_BUS 3ssl" -.TH OPENSSL_INSTRUMENT_BUS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_INSTRUMENT_BUS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_load_builtin_modules.3ssl b/upstream/archlinux/man3/OPENSSL_load_builtin_modules.3ssl index 1c89400f..26eff45e 100644 --- a/upstream/archlinux/man3/OPENSSL_load_builtin_modules.3ssl +++ b/upstream/archlinux/man3/OPENSSL_load_builtin_modules.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_LOAD_BUILTIN_MODULES 3ssl" -.TH OPENSSL_LOAD_BUILTIN_MODULES 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_LOAD_BUILTIN_MODULES 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_malloc.3ssl b/upstream/archlinux/man3/OPENSSL_malloc.3ssl index 70cb9c48..bdaaa06d 100644 --- a/upstream/archlinux/man3/OPENSSL_malloc.3ssl +++ b/upstream/archlinux/man3/OPENSSL_malloc.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_MALLOC 3ssl" -.TH OPENSSL_MALLOC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_MALLOC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_s390xcap.3ssl b/upstream/archlinux/man3/OPENSSL_s390xcap.3ssl index 80e0c7fc..7c31a4c9 100644 --- a/upstream/archlinux/man3/OPENSSL_s390xcap.3ssl +++ b/upstream/archlinux/man3/OPENSSL_s390xcap.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_S390XCAP 3ssl" -.TH OPENSSL_S390XCAP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_S390XCAP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_secure_malloc.3ssl b/upstream/archlinux/man3/OPENSSL_secure_malloc.3ssl index d0efed2b..69fbd2a4 100644 --- a/upstream/archlinux/man3/OPENSSL_secure_malloc.3ssl +++ b/upstream/archlinux/man3/OPENSSL_secure_malloc.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_SECURE_MALLOC 3ssl" -.TH OPENSSL_SECURE_MALLOC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_SECURE_MALLOC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OPENSSL_strcasecmp.3ssl b/upstream/archlinux/man3/OPENSSL_strcasecmp.3ssl index bb63fbe2..9daaae1b 100644 --- a/upstream/archlinux/man3/OPENSSL_strcasecmp.3ssl +++ b/upstream/archlinux/man3/OPENSSL_strcasecmp.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_STRCASECMP 3ssl" -.TH OPENSSL_STRCASECMP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_STRCASECMP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_ALGORITHM.3ssl b/upstream/archlinux/man3/OSSL_ALGORITHM.3ssl index 775b1f1d..e56b42d7 100644 --- a/upstream/archlinux/man3/OSSL_ALGORITHM.3ssl +++ b/upstream/archlinux/man3/OSSL_ALGORITHM.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_ALGORITHM 3ssl" -.TH OSSL_ALGORITHM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_ALGORITHM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_CALLBACK.3ssl b/upstream/archlinux/man3/OSSL_CALLBACK.3ssl index b0401ac5..e5b6e5e3 100644 --- a/upstream/archlinux/man3/OSSL_CALLBACK.3ssl +++ b/upstream/archlinux/man3/OSSL_CALLBACK.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CALLBACK 3ssl" -.TH OSSL_CALLBACK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CALLBACK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_CMP_CTX_new.3ssl b/upstream/archlinux/man3/OSSL_CMP_CTX_new.3ssl index fdbc0c55..4ac855b0 100644 --- a/upstream/archlinux/man3/OSSL_CMP_CTX_new.3ssl +++ b/upstream/archlinux/man3/OSSL_CMP_CTX_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CMP_CTX_NEW 3ssl" -.TH OSSL_CMP_CTX_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CMP_CTX_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -98,6 +98,7 @@ OSSL_CMP_CTX_set1_secretValue, OSSL_CMP_CTX_set1_recipient, OSSL_CMP_CTX_push0_geninfo_ITAV, OSSL_CMP_CTX_reset_geninfo_ITAVs, +OSSL_CMP_CTX_get0_geninfo_ITAVs, OSSL_CMP_CTX_set1_extraCertsOut, OSSL_CMP_CTX_set0_newPkey, OSSL_CMP_CTX_get0_newPkey, @@ -186,6 +187,8 @@ OSSL_CMP_CTX_set1_senderNonce \& int OSSL_CMP_CTX_set1_recipient(OSSL_CMP_CTX *ctx, const X509_NAME *name); \& int OSSL_CMP_CTX_push0_geninfo_ITAV(OSSL_CMP_CTX *ctx, OSSL_CMP_ITAV *itav); \& int OSSL_CMP_CTX_reset_geninfo_ITAVs(OSSL_CMP_CTX *ctx); +\& STACK_OF(OSSL_CMP_ITAV) +\& *OSSL_CMP_CTX_get0_geninfo_ITAVs(const OSSL_CMP_CTX *ctx); \& int OSSL_CMP_CTX_set1_extraCertsOut(OSSL_CMP_CTX *ctx, \& STACK_OF(X509) *extraCertsOut); \& @@ -411,6 +414,12 @@ The following options can be set: \& Allow retrieving a trust anchor from extraCerts and using that \& to validate the certificate chain of an IP message. .Ve +.IP \fBOSSL_CMP_OPT_NO_CACHE_EXTRACERTS\fR 4 +.IX Item "OSSL_CMP_OPT_NO_CACHE_EXTRACERTS" +.Vb 2 +\& Do not cache certificates received in the extraCerts CMP message field. +\& Otherwise they are stored to potentially help validate further messages. +.Ve .PP \&\fBOSSL_CMP_CTX_get_option()\fR reads the current value of the given option (e.g., OSSL_CMP_OPT_IMPLICIT_CONFIRM) from the given OSSL_CMP_CTX structure. @@ -542,6 +551,8 @@ of intermediate CAs that may be useful for path construction for the own CMP signer certificate, for the own TLS certificate (if any), when verifying peer CMP protection certificates, and when verifying newly enrolled certificates. The reference counts of those certificates handled successfully are increased. +This list of untrusted certificates in \fIctx\fR will get augmented by extraCerts +in received CMP messages unless \fBOSSL_CMP_OPT_NO_CACHE_EXTRACERTS\fR is set. .PP \&\fBOSSL_CMP_CTX_get0_untrusted()\fR returns a pointer to the list of untrusted certs in \fIctx\fR, which may be empty if unset. @@ -613,12 +624,16 @@ the issuer of the CMP signer certificate, as far as any of those is present, else the NULL-DN as last resort. .PP \&\fBOSSL_CMP_CTX_push0_geninfo_ITAV()\fR adds \fIitav\fR to the stack in the \fIctx\fR to be -added to the GeneralInfo field of the CMP PKIMessage header of a request +added to the generalInfo field of the CMP PKIMessage header of a request message sent with this context. .PP \&\fBOSSL_CMP_CTX_reset_geninfo_ITAVs()\fR clears any ITAVs that were added by \fBOSSL_CMP_CTX_push0_geninfo_ITAV()\fR. .PP +\&\fBOSSL_CMP_CTX_get0_geninfo_ITAVs()\fR returns the list of ITAVs set in \fIctx\fR +for inclusion in the generalInfo field of the CMP PKIMessage header of requests +or NULL if not set. +.PP \&\fBOSSL_CMP_CTX_set1_extraCertsOut()\fR sets the stack of extraCerts that will be sent to remote. .PP @@ -803,6 +818,7 @@ CMP is defined in RFC 4210 (and CRMF in RFC 4211). \&\fBOSSL_CMP_CTX_get_transfer_cb_arg()\fR, \&\fBOSSL_CMP_CTX_get0_trusted()\fR, \&\fBOSSL_CMP_CTX_get0_untrusted()\fR, +\&\fBOSSL_CMP_CTX_get0_geninfo_ITAVs()\fR, \&\fBOSSL_CMP_CTX_get0_newPkey()\fR, \&\fBOSSL_CMP_CTX_get_certConf_cb_arg()\fR, \&\fBOSSL_CMP_CTX_get0_statusString()\fR, @@ -920,13 +936,14 @@ in OpenSSL 3.2. .PP \&\fBOSSL_CMP_CTX_reset_geninfo_ITAVs()\fR was added in OpenSSL 3.0.8. .PP +\&\fBOSSL_CMP_CTX_set1_serialNumber()\fR, \&\fBOSSL_CMP_CTX_get0_libctx()\fR, \fBOSSL_CMP_CTX_get0_propq()\fR, and \&\fBOSSL_CMP_CTX_get0_validatedSrvCert()\fR were added in OpenSSL 3.2. .PP -\&\fBOSSL_CMP_CTX_set1_serialNumber()\fR was added in OpenSSL 3.2. +\&\fBOSSL_CMP_CTX_get0_geninfo_ITAVs()\fR was added in OpenSSL 3.3. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2007\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2007\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/OSSL_CMP_HDR_get0_transactionID.3ssl b/upstream/archlinux/man3/OSSL_CMP_HDR_get0_transactionID.3ssl index 5cde30d7..84e84b13 100644 --- a/upstream/archlinux/man3/OSSL_CMP_HDR_get0_transactionID.3ssl +++ b/upstream/archlinux/man3/OSSL_CMP_HDR_get0_transactionID.3ssl @@ -55,14 +55,15 @@ .\" ======================================================================== .\" .IX Title "OSSL_CMP_HDR_GET0_TRANSACTIONID 3ssl" -.TH OSSL_CMP_HDR_GET0_TRANSACTIONID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CMP_HDR_GET0_TRANSACTIONID 3ssl 2024-04-28 3.3.0 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 OSSL_CMP_HDR_get0_transactionID, -OSSL_CMP_HDR_get0_recipNonce +OSSL_CMP_HDR_get0_recipNonce, +OSSL_CMP_HDR_get0_geninfo_ITAVs \&\- functions manipulating CMP message headers .SH SYNOPSIS .IX Header "SYNOPSIS" @@ -73,6 +74,8 @@ OSSL_CMP_HDR_get0_recipNonce \& OSSL_CMP_PKIHEADER *hdr); \& ASN1_OCTET_STRING *OSSL_CMP_HDR_get0_recipNonce(const \& OSSL_CMP_PKIHEADER *hdr); +\& STACK_OF(OSSL_CMP_ITAV) +\& *OSSL_CMP_HDR_get0_geninfo_ITAVs(const OSSL_CMP_PKIHEADER *hdr); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" @@ -80,6 +83,9 @@ OSSL_CMP_HDR_get0_transactionID returns the transaction ID of the given PKIHeader. .PP OSSL_CMP_HDR_get0_recipNonce returns the recipient nonce of the given PKIHeader. +.PP +\&\fBOSSL_CMP_HDR_get0_geninfo_ITAVs()\fR returns the list of ITAVs +in the generalInfo field of the given PKIHeader. .SH NOTES .IX Header "NOTES" CMP is defined in RFC 4210. @@ -90,6 +96,8 @@ or NULL if the respective entry does not exist and on error. .SH HISTORY .IX Header "HISTORY" The OpenSSL CMP support was added in OpenSSL 3.0. +.PP +\&\fBOSSL_CMP_HDR_get0_geninfo_ITAVs()\fR was added in OpenSSL 3.3. .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2007\-2019 The OpenSSL Project Authors. All Rights Reserved. diff --git a/upstream/archlinux/man3/OSSL_CMP_ITAV_new_caCerts.3ssl b/upstream/archlinux/man3/OSSL_CMP_ITAV_new_caCerts.3ssl index b1851a3c..9124277d 100644 --- a/upstream/archlinux/man3/OSSL_CMP_ITAV_new_caCerts.3ssl +++ b/upstream/archlinux/man3/OSSL_CMP_ITAV_new_caCerts.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CMP_ITAV_NEW_CACERTS 3ssl" -.TH OSSL_CMP_ITAV_NEW_CACERTS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CMP_ITAV_NEW_CACERTS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_CMP_ITAV_set0.3ssl b/upstream/archlinux/man3/OSSL_CMP_ITAV_set0.3ssl index 1a3aa0b0..fff16c25 100644 --- a/upstream/archlinux/man3/OSSL_CMP_ITAV_set0.3ssl +++ b/upstream/archlinux/man3/OSSL_CMP_ITAV_set0.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CMP_ITAV_SET0 3ssl" -.TH OSSL_CMP_ITAV_SET0 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CMP_ITAV_SET0 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -65,7 +65,9 @@ OSSL_CMP_ITAV_create, OSSL_CMP_ITAV_set0, OSSL_CMP_ITAV_get0_type, OSSL_CMP_ITAV_get0_value, -OSSL_CMP_ITAV_push0_stack_item +OSSL_CMP_ITAV_push0_stack_item, +OSSL_CMP_ITAV_new0_certProfile, +OSSL_CMP_ITAV_get0_certProfile \&\- OSSL_CMP_ITAV utility functions .SH SYNOPSIS .IX Header "SYNOPSIS" @@ -79,6 +81,10 @@ OSSL_CMP_ITAV_push0_stack_item \& ASN1_TYPE *OSSL_CMP_ITAV_get0_value(const OSSL_CMP_ITAV *itav); \& int OSSL_CMP_ITAV_push0_stack_item(STACK_OF(OSSL_CMP_ITAV) **itav_sk_p, \& OSSL_CMP_ITAV *itav); +\& OSSL_CMP_ITAV +\& *OSSL_CMP_ITAV_new0_certProfile(STACK_OF(ASN1_UTF8STRING) *certProfile); +\& int OSSL_CMP_ITAV_get0_certProfile(const OSSL_CMP_ITAV *itav, +\& STACK_OF(ASN1_UTF8STRING) **out); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" @@ -101,20 +107,36 @@ the \fIitav\fR as generic \fBASN1_TYPE\fR pointer. .PP \&\fBOSSL_CMP_ITAV_push0_stack_item()\fR pushes \fIitav\fR to the stack pointed to by \fI*itav_sk_p\fR. It creates a new stack if \fI*itav_sk_p\fR points to NULL. +.PP +\&\fBOSSL_CMP_ITAV_new0_certProfile()\fR creates a new \fBOSSL_CMP_ITAV\fR structure +of type \fBcertProfile\fR that includes the optionally given list of profile names. +On success, ownership of the list is with the new \fBOSSL_CMP_ITAV\fR structure. +.PP +\&\fBOSSL_CMP_ITAV_get0_certProfile()\fR on success assigns to \fI*out\fR +an internal pointer to the +list of certificate profile names contained in the infoValue field of \fIitav\fR. +The pointer may be NULL if no profile name is included. +It is an error if the infoType of \fIitav\fR is not \fBcertProfile\fR. .SH NOTES .IX Header "NOTES" -CMP is defined in RFC 4210 (and CRMF in RFC 4211). +CMP is defined in RFC 4210 and RFC 9480 (and CRMF in RFC 4211). +.PP +OIDs to use as types in \fBOSSL_CMP_ITAV\fR can be found at +<https://datatracker.ietf.org/doc/html/rfc9480#section\-4.2.2>. +The respective OpenSSL NIDs, such as \fBNID_id_it_certProfile\fR, +are defined in the \fI<openssl/obj_mac.h>\fR header file. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fBOSSL_CMP_ITAV_create()\fR returns a pointer to the ITAV structure on success, -or NULL on error. +\&\fBOSSL_CMP_ITAV_create()\fR and \fBOSSL_CMP_ITAV_new0_certProfile()\fR +return a pointer to an ITAV structure on success, or NULL on error. .PP \&\fBOSSL_CMP_ITAV_set0()\fR does not return a value. .PP \&\fBOSSL_CMP_ITAV_get0_type()\fR and \fBOSSL_CMP_ITAV_get0_value()\fR return the respective pointer or NULL if their input is NULL. .PP -\&\fBOSSL_CMP_ITAV_push0_stack_item()\fR returns 1 on success, 0 on error. +\&\fBOSSL_CMP_ITAV_push0_stack_item()\fR and \fBOSSL_CMP_ITAV_get0_certProfile()\fR +return 1 on success, 0 on error. .SH EXAMPLES .IX Header "EXAMPLES" The following code creates and sets a structure representing a generic @@ -151,6 +173,9 @@ included in the requests' PKIHeader's genInfo field. .SH HISTORY .IX Header "HISTORY" The OpenSSL CMP support was added in OpenSSL 3.0. +.PP +\&\fBOSSL_CMP_ITAV_new0_certProfile()\fR and \fBOSSL_CMP_ITAV_get0_certProfile()\fR +were added in OpenSSL 3.3. .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2007\-2021 The OpenSSL Project Authors. All Rights Reserved. diff --git a/upstream/archlinux/man3/OSSL_CMP_MSG_get0_header.3ssl b/upstream/archlinux/man3/OSSL_CMP_MSG_get0_header.3ssl index 5d32aa7c..bdc97778 100644 --- a/upstream/archlinux/man3/OSSL_CMP_MSG_get0_header.3ssl +++ b/upstream/archlinux/man3/OSSL_CMP_MSG_get0_header.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CMP_MSG_GET0_HEADER 3ssl" -.TH OSSL_CMP_MSG_GET0_HEADER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CMP_MSG_GET0_HEADER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -63,6 +63,7 @@ .SH NAME OSSL_CMP_MSG_get0_header, OSSL_CMP_MSG_get_bodytype, +OSSL_CMP_MSG_get0_certreq_publickey, OSSL_CMP_MSG_update_transactionID, OSSL_CMP_MSG_update_recipNonce, OSSL_CMP_CTX_setup_CRM, @@ -78,6 +79,7 @@ i2d_OSSL_CMP_MSG_bio \& \& OSSL_CMP_PKIHEADER *OSSL_CMP_MSG_get0_header(const OSSL_CMP_MSG *msg); \& int OSSL_CMP_MSG_get_bodytype(const OSSL_CMP_MSG *msg); +\& X509_PUBKEY *OSSL_CMP_MSG_get0_certreq_publickey(const OSSL_CMP_MSG *msg); \& int OSSL_CMP_MSG_update_transactionID(OSSL_CMP_CTX *ctx, OSSL_CMP_MSG *msg); \& int OSSL_CMP_MSG_update_recipNonce(OSSL_CMP_CTX *ctx, OSSL_CMP_MSG *msg); \& OSSL_CRMF_MSG *OSSL_CMP_CTX_setup_CRM(OSSL_CMP_CTX *ctx, int for_KUR, int rid); @@ -92,6 +94,9 @@ i2d_OSSL_CMP_MSG_bio .PP \&\fBOSSL_CMP_MSG_get_bodytype()\fR returns the body type of the given CMP message. .PP +\&\fBOSSL_CMP_MSG_get0_certreq_publickey()\fR expects that \fImsg\fR is a certificate request +messsage and returns the public key in its certificate template if present. +.PP \&\fBOSSL_CMP_MSG_update_transactionID()\fR updates the transactionID field in the header of the given message according to the CMP_CTX. If \fIctx\fR does not contain a transaction ID, a fresh one is created before. @@ -165,6 +170,8 @@ or NULL if the respective entry does not exist and on error. .PP \&\fBOSSL_CMP_MSG_get_bodytype()\fR returns the body type or \-1 on error. .PP +\&\fBOSSL_CMP_MSG_get0_certreq_publickey()\fR returns a public key or NULL on error. +.PP \&\fBOSSL_CMP_CTX_setup_CRM()\fR returns a pointer to a \fBOSSL_CRMF_MSG\fR on success, NULL on error. .PP @@ -190,9 +197,11 @@ return 1 on success, 0 on error. The OpenSSL CMP support was added in OpenSSL 3.0. .PP \&\fBOSSL_CMP_MSG_update_recipNonce()\fR was added in OpenSSL 3.0.9. +.PP +\&\fBOSSL_CMP_MSG_get0_certreq_publickey()\fR was added in OpenSSL 3.3. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2007\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2007\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/OSSL_CMP_MSG_http_perform.3ssl b/upstream/archlinux/man3/OSSL_CMP_MSG_http_perform.3ssl index f892bd2a..b8441220 100644 --- a/upstream/archlinux/man3/OSSL_CMP_MSG_http_perform.3ssl +++ b/upstream/archlinux/man3/OSSL_CMP_MSG_http_perform.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CMP_MSG_HTTP_PERFORM 3ssl" -.TH OSSL_CMP_MSG_HTTP_PERFORM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CMP_MSG_HTTP_PERFORM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_CMP_SRV_CTX_new.3ssl b/upstream/archlinux/man3/OSSL_CMP_SRV_CTX_new.3ssl index 3495705b..d4e80083 100644 --- a/upstream/archlinux/man3/OSSL_CMP_SRV_CTX_new.3ssl +++ b/upstream/archlinux/man3/OSSL_CMP_SRV_CTX_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CMP_SRV_CTX_NEW 3ssl" -.TH OSSL_CMP_SRV_CTX_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CMP_SRV_CTX_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -72,6 +72,9 @@ OSSL_CMP_SRV_genm_cb_t, OSSL_CMP_SRV_error_cb_t, OSSL_CMP_SRV_pollReq_cb_t, OSSL_CMP_SRV_CTX_init, +OSSL_CMP_SRV_delayed_delivery_cb_t, +OSSL_CMP_SRV_clean_transaction_cb_t, +OSSL_CMP_SRV_CTX_init_trans, OSSL_CMP_SRV_CTX_get0_cmp_ctx, OSSL_CMP_SRV_CTX_get0_custom_ctx, OSSL_CMP_SRV_CTX_set_send_unprotected_errors, @@ -130,6 +133,13 @@ OSSL_CMP_SRV_CTX_set_grant_implicit_confirm \& OSSL_CMP_SRV_error_cb_t process_error, \& OSSL_CMP_SRV_certConf_cb_t process_certConf, \& OSSL_CMP_SRV_pollReq_cb_t process_pollReq); +\& typedef int (*OSSL_CMP_SRV_delayed_delivery_cb_t)(OSSL_CMP_SRV_CTX *srv_ctx, +\& const OSSL_CMP_MSG *req); +\& typedef int (*OSSL_CMP_SRV_clean_transaction_cb_t)(OSSL_CMP_SRV_CTX *srv_ctx, +\& const ASN1_OCTET_STRING *id); +\& int OSSL_CMP_SRV_CTX_init_trans(OSSL_CMP_SRV_CTX *srv_ctx, +\& OSSL_CMP_SRV_delayed_delivery_cb_t delay, +\& OSSL_CMP_SRV_clean_transaction_cb_t clean); \& \& OSSL_CMP_CTX *OSSL_CMP_SRV_CTX_get0_cmp_ctx(const OSSL_CMP_SRV_CTX *srv_ctx); \& void *OSSL_CMP_SRV_CTX_get0_custom_ctx(const OSSL_CMP_SRV_CTX *srv_ctx); @@ -172,6 +182,20 @@ All arguments except \fIsrv_ctx\fR may be NULL. If a callback for some message type is not given this means that the respective type of CMP message is not supported by the server. .PP +\&\fBOSSL_CMP_SRV_CTX_init_trans()\fR sets in \fIsrv_ctx\fR the optional callback +functions for initiating delayed delivery and cleaning up a transaction. +If the <delay> function is NULL then delivery of responses is never delayed. +Otherwise \fIdelay\fR takes a custom server context and a request message as input. +It must return 1 if delivery of the respective response shall be delayed, +0 if not, and \-1 on error. +If the <clean> function is NULL then no specific cleanup is performed. +Otherwise \fIclean\fR takes a custom server context and a transaction ID pointer +as input, where the pointer is NULL in case a new transaction is being started +and otherwise provides the ID of the transaction being terminated. +The <clean> function should reset the respective portions of the state +and free related memory. +It must return 1 on success and 0 on error. +.PP \&\fBOSSL_CMP_SRV_CTX_get0_cmp_ctx()\fR returns the \fBOSSL_CMP_CTX\fR from the \fIsrv_ctx\fR. .PP \&\fBOSSL_CMP_SRV_CTX_get0_custom_ctx()\fR returns the custom server context from @@ -211,6 +235,10 @@ All other functions return 1 on success, 0 on error. .SH HISTORY .IX Header "HISTORY" The OpenSSL CMP support was added in OpenSSL 3.0. +.PP +\&\fBOSSL_CMP_SRV_CTX_init_trans()\fR +supporting delayed delivery of all types of response messages +was added in OpenSSL 3.3. .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2007\-2021 The OpenSSL Project Authors. All Rights Reserved. diff --git a/upstream/archlinux/man3/OSSL_CMP_STATUSINFO_new.3ssl b/upstream/archlinux/man3/OSSL_CMP_STATUSINFO_new.3ssl index eb7b5a9c..df1f757b 100644 --- a/upstream/archlinux/man3/OSSL_CMP_STATUSINFO_new.3ssl +++ b/upstream/archlinux/man3/OSSL_CMP_STATUSINFO_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CMP_STATUSINFO_NEW 3ssl" -.TH OSSL_CMP_STATUSINFO_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CMP_STATUSINFO_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_CMP_exec_certreq.3ssl b/upstream/archlinux/man3/OSSL_CMP_exec_certreq.3ssl index cc97f934..99128720 100644 --- a/upstream/archlinux/man3/OSSL_CMP_exec_certreq.3ssl +++ b/upstream/archlinux/man3/OSSL_CMP_exec_certreq.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CMP_EXEC_CERTREQ 3ssl" -.TH OSSL_CMP_EXEC_CERTREQ 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CMP_EXEC_CERTREQ 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -137,8 +137,8 @@ Typically \fIcrm\fR is NULL, then the template ingredients are taken from \fIctx and need to be filled in using \fBOSSL_CMP_CTX_set1_subjectName\fR\|(3), \&\fBOSSL_CMP_CTX_set0_newPkey\fR\|(3), \fBOSSL_CMP_CTX_set1_oldCert\fR\|(3), etc. For P10CR, \fBOSSL_CMP_CTX_set1_p10CSR\fR\|(3) needs to be used instead. -The enrollment session may be blocked by sleeping until the addressed -CA (or an intermediate PKI component) can fully process and answer the request. +The enrollment session may be blocked (with polling and sleeping in between) +until the server side can fully process and ultimately answer the request. .PP \&\fBOSSL_CMP_try_certreq()\fR is an alternative to the above functions that is more flexible regarding what to do after receiving a checkAfter value. @@ -177,11 +177,15 @@ We take "accepted" and "grantedWithMods" as clear success and handle typically return them as an indication that the certificate was already revoked. "rejection" is a clear error. The values "waiting" and "keyUpdateWarning" make no sense for revocation and thus are treated as an error as well. +The revocation session may be blocked (with polling and sleeping in between) +until the server can fully process and ultimately answer the request. .PP \&\fBOSSL_CMP_exec_GENM_ses()\fR sends a genm general message containing the sequence of infoType and infoValue pairs (InfoTypeAndValue; short: \fBITAV\fR) optionally provided in the \fIctx\fR using \fBOSSL_CMP_CTX_push0_genm_ITAV\fR\|(3). -On success it records in \fIctx\fR the status \fBOSSL_CMP_PKISTATUS_accepted\fR +The message exchange may be blocked (with polling and sleeping in between) +until the server can fully process and ultimately answer the request. +On success the function records in \fIctx\fR status \fBOSSL_CMP_PKISTATUS_accepted\fR and returns the list of \fBITAV\fRs received in a genp response message. This can be used, for instance, with infoType \f(CW\*(C`signKeyPairTypes\*(C'\fR to obtain the set of signature @@ -269,6 +273,9 @@ The OpenSSL CMP support was added in OpenSSL 3.0. .PP \&\fBOSSL_CMP_get1_caCerts()\fR and \fBOSSL_CMP_get1_rootCaKeyUpdate()\fR were added in OpenSSL 3.2. +.PP +Support for delayed delivery of all types of response messages +was added in OpenSSL 3.3. .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2007\-2023 The OpenSSL Project Authors. All Rights Reserved. diff --git a/upstream/archlinux/man3/OSSL_CMP_log_open.3ssl b/upstream/archlinux/man3/OSSL_CMP_log_open.3ssl index fddbe30b..1fd841a2 100644 --- a/upstream/archlinux/man3/OSSL_CMP_log_open.3ssl +++ b/upstream/archlinux/man3/OSSL_CMP_log_open.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CMP_LOG_OPEN 3ssl" -.TH OSSL_CMP_LOG_OPEN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CMP_LOG_OPEN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_CMP_validate_msg.3ssl b/upstream/archlinux/man3/OSSL_CMP_validate_msg.3ssl index 4cbe1776..ac48ee18 100644 --- a/upstream/archlinux/man3/OSSL_CMP_validate_msg.3ssl +++ b/upstream/archlinux/man3/OSSL_CMP_validate_msg.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CMP_VALIDATE_MSG 3ssl" -.TH OSSL_CMP_VALIDATE_MSG 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CMP_VALIDATE_MSG 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_CORE_MAKE_FUNC.3ssl b/upstream/archlinux/man3/OSSL_CORE_MAKE_FUNC.3ssl index 46b1b669..ff079008 100644 --- a/upstream/archlinux/man3/OSSL_CORE_MAKE_FUNC.3ssl +++ b/upstream/archlinux/man3/OSSL_CORE_MAKE_FUNC.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CORE_MAKE_FUNC 3ssl" -.TH OSSL_CORE_MAKE_FUNC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CORE_MAKE_FUNC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_CRMF_MSG_get0_tmpl.3ssl b/upstream/archlinux/man3/OSSL_CRMF_MSG_get0_tmpl.3ssl index a1c5cdc4..aa580c88 100644 --- a/upstream/archlinux/man3/OSSL_CRMF_MSG_get0_tmpl.3ssl +++ b/upstream/archlinux/man3/OSSL_CRMF_MSG_get0_tmpl.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CRMF_MSG_GET0_TMPL 3ssl" -.TH OSSL_CRMF_MSG_GET0_TMPL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CRMF_MSG_GET0_TMPL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_CRMF_MSG_set0_validity.3ssl b/upstream/archlinux/man3/OSSL_CRMF_MSG_set0_validity.3ssl index 9c832957..87e4e3f9 100644 --- a/upstream/archlinux/man3/OSSL_CRMF_MSG_set0_validity.3ssl +++ b/upstream/archlinux/man3/OSSL_CRMF_MSG_set0_validity.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CRMF_MSG_SET0_VALIDITY 3ssl" -.TH OSSL_CRMF_MSG_SET0_VALIDITY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CRMF_MSG_SET0_VALIDITY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_CRMF_MSG_set1_regCtrl_regToken.3ssl b/upstream/archlinux/man3/OSSL_CRMF_MSG_set1_regCtrl_regToken.3ssl index 08f6b408..a1384f07 100644 --- a/upstream/archlinux/man3/OSSL_CRMF_MSG_set1_regCtrl_regToken.3ssl +++ b/upstream/archlinux/man3/OSSL_CRMF_MSG_set1_regCtrl_regToken.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CRMF_MSG_SET1_REGCTRL_REGTOKEN 3ssl" -.TH OSSL_CRMF_MSG_SET1_REGCTRL_REGTOKEN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CRMF_MSG_SET1_REGCTRL_REGTOKEN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_CRMF_MSG_set1_regInfo_certReq.3ssl b/upstream/archlinux/man3/OSSL_CRMF_MSG_set1_regInfo_certReq.3ssl index e120db60..eb9ed60b 100644 --- a/upstream/archlinux/man3/OSSL_CRMF_MSG_set1_regInfo_certReq.3ssl +++ b/upstream/archlinux/man3/OSSL_CRMF_MSG_set1_regInfo_certReq.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CRMF_MSG_SET1_REGINFO_CERTREQ 3ssl" -.TH OSSL_CRMF_MSG_SET1_REGINFO_CERTREQ 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CRMF_MSG_SET1_REGINFO_CERTREQ 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_CRMF_pbmp_new.3ssl b/upstream/archlinux/man3/OSSL_CRMF_pbmp_new.3ssl index 5ebfd159..c93b5d7d 100644 --- a/upstream/archlinux/man3/OSSL_CRMF_pbmp_new.3ssl +++ b/upstream/archlinux/man3/OSSL_CRMF_pbmp_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_CRMF_PBMP_NEW 3ssl" -.TH OSSL_CRMF_PBMP_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_CRMF_PBMP_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_DECODER.3ssl b/upstream/archlinux/man3/OSSL_DECODER.3ssl index 290e26c1..81297c13 100644 --- a/upstream/archlinux/man3/OSSL_DECODER.3ssl +++ b/upstream/archlinux/man3/OSSL_DECODER.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_DECODER 3ssl" -.TH OSSL_DECODER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_DECODER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_DECODER_CTX.3ssl b/upstream/archlinux/man3/OSSL_DECODER_CTX.3ssl index 2f18c806..e2d622ed 100644 --- a/upstream/archlinux/man3/OSSL_DECODER_CTX.3ssl +++ b/upstream/archlinux/man3/OSSL_DECODER_CTX.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_DECODER_CTX 3ssl" -.TH OSSL_DECODER_CTX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_DECODER_CTX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -106,8 +106,8 @@ OSSL_DECODER_INSTANCE_get_input_structure \& int OSSL_DECODER_CTX_set_input_structure(OSSL_DECODER_CTX *ctx, \& const char *input_structure); \& int OSSL_DECODER_CTX_add_decoder(OSSL_DECODER_CTX *ctx, OSSL_DECODER *decoder); -\& int OSSL_DECODER_CTX_add_extra(OSSL_DECODER_CTX *ctx, -\& OSSL_LIB_CTX *libctx, +\& int OSSL_DECODER_CTX_add_extra(OSSL_DECODER_CTX *ctx, +\& OSSL_LIB_CTX *libctx, \& const char *propq); \& int OSSL_DECODER_CTX_get_num_decoders(OSSL_DECODER_CTX *ctx); \& diff --git a/upstream/archlinux/man3/OSSL_DECODER_CTX_new_for_pkey.3ssl b/upstream/archlinux/man3/OSSL_DECODER_CTX_new_for_pkey.3ssl index 3656f000..4b66d2f8 100644 --- a/upstream/archlinux/man3/OSSL_DECODER_CTX_new_for_pkey.3ssl +++ b/upstream/archlinux/man3/OSSL_DECODER_CTX_new_for_pkey.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_DECODER_CTX_NEW_FOR_PKEY 3ssl" -.TH OSSL_DECODER_CTX_NEW_FOR_PKEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_DECODER_CTX_NEW_FOR_PKEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_DECODER_from_bio.3ssl b/upstream/archlinux/man3/OSSL_DECODER_from_bio.3ssl index 7cfe4698..b922a061 100644 --- a/upstream/archlinux/man3/OSSL_DECODER_from_bio.3ssl +++ b/upstream/archlinux/man3/OSSL_DECODER_from_bio.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_DECODER_FROM_BIO 3ssl" -.TH OSSL_DECODER_FROM_BIO 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_DECODER_FROM_BIO 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_DISPATCH.3ssl b/upstream/archlinux/man3/OSSL_DISPATCH.3ssl index 6e40a618..b8008184 100644 --- a/upstream/archlinux/man3/OSSL_DISPATCH.3ssl +++ b/upstream/archlinux/man3/OSSL_DISPATCH.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_DISPATCH 3ssl" -.TH OSSL_DISPATCH 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_DISPATCH 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_ENCODER.3ssl b/upstream/archlinux/man3/OSSL_ENCODER.3ssl index 50f35ee4..72352757 100644 --- a/upstream/archlinux/man3/OSSL_ENCODER.3ssl +++ b/upstream/archlinux/man3/OSSL_ENCODER.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_ENCODER 3ssl" -.TH OSSL_ENCODER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_ENCODER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_ENCODER_CTX.3ssl b/upstream/archlinux/man3/OSSL_ENCODER_CTX.3ssl index 2a692d56..ca64ced7 100644 --- a/upstream/archlinux/man3/OSSL_ENCODER_CTX.3ssl +++ b/upstream/archlinux/man3/OSSL_ENCODER_CTX.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_ENCODER_CTX 3ssl" -.TH OSSL_ENCODER_CTX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_ENCODER_CTX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_ENCODER_CTX_new_for_pkey.3ssl b/upstream/archlinux/man3/OSSL_ENCODER_CTX_new_for_pkey.3ssl index 1fd09919..2cfd72bb 100644 --- a/upstream/archlinux/man3/OSSL_ENCODER_CTX_new_for_pkey.3ssl +++ b/upstream/archlinux/man3/OSSL_ENCODER_CTX_new_for_pkey.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_ENCODER_CTX_NEW_FOR_PKEY 3ssl" -.TH OSSL_ENCODER_CTX_NEW_FOR_PKEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_ENCODER_CTX_NEW_FOR_PKEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_ENCODER_to_bio.3ssl b/upstream/archlinux/man3/OSSL_ENCODER_to_bio.3ssl index f4f79bf8..57417157 100644 --- a/upstream/archlinux/man3/OSSL_ENCODER_to_bio.3ssl +++ b/upstream/archlinux/man3/OSSL_ENCODER_to_bio.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_ENCODER_TO_BIO 3ssl" -.TH OSSL_ENCODER_TO_BIO 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_ENCODER_TO_BIO 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_ERR_STATE_save.3ssl b/upstream/archlinux/man3/OSSL_ERR_STATE_save.3ssl index 880ee91b..77e45867 100644 --- a/upstream/archlinux/man3/OSSL_ERR_STATE_save.3ssl +++ b/upstream/archlinux/man3/OSSL_ERR_STATE_save.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_ERR_STATE_SAVE 3ssl" -.TH OSSL_ERR_STATE_SAVE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_ERR_STATE_SAVE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_ESS_check_signing_certs.3ssl b/upstream/archlinux/man3/OSSL_ESS_check_signing_certs.3ssl index aca22036..e54b8438 100644 --- a/upstream/archlinux/man3/OSSL_ESS_check_signing_certs.3ssl +++ b/upstream/archlinux/man3/OSSL_ESS_check_signing_certs.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_ESS_CHECK_SIGNING_CERTS 3ssl" -.TH OSSL_ESS_CHECK_SIGNING_CERTS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_ESS_CHECK_SIGNING_CERTS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_HPKE_CTX_new.3ssl b/upstream/archlinux/man3/OSSL_HPKE_CTX_new.3ssl index 64b8cb29..1841fed7 100644 --- a/upstream/archlinux/man3/OSSL_HPKE_CTX_new.3ssl +++ b/upstream/archlinux/man3/OSSL_HPKE_CTX_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_HPKE_CTX_NEW 3ssl" -.TH OSSL_HPKE_CTX_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_HPKE_CTX_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -227,16 +227,16 @@ For further information related to authentication see "Pre-Shared Key HPKE modes" and "Sender-authenticated HPKE Modes". .SS "HPKE Roles" .IX Subsection "HPKE Roles" -HPKE contexts have a role \- either sender or receiver. This is used +HPKE contexts have a role \- either sender or receiver. This is used to control which functions can be called and so that senders do not reuse a key and nonce with different plaintexts. .PP -\&\fBOSSL_HPKE_CTX_free()\fR, \fBOSSL_HPKE_export()\fR, \fBOSSL_HPKE_CTX_set1_psk()\fR, +\&\fBOSSL_HPKE_CTX_free()\fR, \fBOSSL_HPKE_export()\fR, \fBOSSL_HPKE_CTX_set1_psk()\fR, and \fBOSSL_HPKE_CTX_get_seq()\fR can be called regardless of role. .IP "\fBOSSL_HPKE_ROLE_SENDER\fR, 0" 4 .IX Item "OSSL_HPKE_ROLE_SENDER, 0" An \fIOSSL_HPKE_CTX\fR with this role can be used with -\&\fBOSSL_HPKE_encap()\fR, \fBOSSL_HPKE_seal()\fR, \fBOSSL_HPKE_CTX_set1_ikme()\fR and +\&\fBOSSL_HPKE_encap()\fR, \fBOSSL_HPKE_seal()\fR, \fBOSSL_HPKE_CTX_set1_ikme()\fR and \&\fBOSSL_HPKE_CTX_set1_authpriv()\fR. .IP "\fBOSSL_HPKE_ROLE_RECEIVER\fR, 1" 4 .IX Item "OSSL_HPKE_ROLE_RECEIVER, 1" diff --git a/upstream/archlinux/man3/OSSL_HTTP_REQ_CTX.3ssl b/upstream/archlinux/man3/OSSL_HTTP_REQ_CTX.3ssl index a66de294..b8c5d055 100644 --- a/upstream/archlinux/man3/OSSL_HTTP_REQ_CTX.3ssl +++ b/upstream/archlinux/man3/OSSL_HTTP_REQ_CTX.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_HTTP_REQ_CTX 3ssl" -.TH OSSL_HTTP_REQ_CTX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_HTTP_REQ_CTX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -74,7 +74,8 @@ OSSL_HTTP_REQ_CTX_exchange, OSSL_HTTP_REQ_CTX_get0_mem_bio, OSSL_HTTP_REQ_CTX_get_resp_len, OSSL_HTTP_REQ_CTX_set_max_response_length, -OSSL_HTTP_is_alive +OSSL_HTTP_is_alive, +OSSL_HTTP_REQ_CTX_set_max_response_hdr_lines \&\- HTTP client low\-level functions .SH SYNOPSIS .IX Header "SYNOPSIS" @@ -108,6 +109,9 @@ OSSL_HTTP_is_alive \& unsigned long len); \& \& int OSSL_HTTP_is_alive(const OSSL_HTTP_REQ_CTX *rctx); +\& +\& void OSSL_HTTP_REQ_CTX_set_max_response_hdr_lines(OSSL_HTTP_REQ_CTX *rctx, +\& size_t count); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" @@ -251,6 +255,12 @@ else it should call \fIOSSL_HTTP_REQ_CTX_free(rctx)\fR or \fBOSSL_HTTP_close\fR\ In case the client application keeps \fIrctx\fR but the connection then dies for any reason at the server side, it will notice this obtaining an I/O error when trying to send the next request via \fIrctx\fR. +.PP +The \fBOSSL_HTTP_REQ_CTX_set_max_response_hdr_lines()\fR function changes the limit +for the number of HTTP headers which can be received in a response. The default +value is 256. If the number of HTTP headers in a response exceeds the limit, +then the HTTP_R_RESPONSE_TOO_MANY_HDRLINES error is indicated. Setting the +limit to 0 disables the check. .SH WARNINGS .IX Header "WARNINGS" The server's response may be unexpected if the hostname that was used to @@ -321,7 +331,7 @@ and the server did not disagree on keeping the connection open, else 0. The functions described here were added in OpenSSL 3.0. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2015\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2015\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/OSSL_HTTP_parse_url.3ssl b/upstream/archlinux/man3/OSSL_HTTP_parse_url.3ssl index 7313e7db..33aa8cee 100644 --- a/upstream/archlinux/man3/OSSL_HTTP_parse_url.3ssl +++ b/upstream/archlinux/man3/OSSL_HTTP_parse_url.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_HTTP_PARSE_URL 3ssl" -.TH OSSL_HTTP_PARSE_URL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_HTTP_PARSE_URL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_HTTP_transfer.3ssl b/upstream/archlinux/man3/OSSL_HTTP_transfer.3ssl index 0c0288a4..7e3613c7 100644 --- a/upstream/archlinux/man3/OSSL_HTTP_transfer.3ssl +++ b/upstream/archlinux/man3/OSSL_HTTP_transfer.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_HTTP_TRANSFER 3ssl" -.TH OSSL_HTTP_TRANSFER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_HTTP_TRANSFER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_ITEM.3ssl b/upstream/archlinux/man3/OSSL_ITEM.3ssl index c84ec383..9febe8ba 100644 --- a/upstream/archlinux/man3/OSSL_ITEM.3ssl +++ b/upstream/archlinux/man3/OSSL_ITEM.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_ITEM 3ssl" -.TH OSSL_ITEM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_ITEM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_LIB_CTX.3ssl b/upstream/archlinux/man3/OSSL_LIB_CTX.3ssl index b70cd0c9..c000d874 100644 --- a/upstream/archlinux/man3/OSSL_LIB_CTX.3ssl +++ b/upstream/archlinux/man3/OSSL_LIB_CTX.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_LIB_CTX 3ssl" -.TH OSSL_LIB_CTX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_LIB_CTX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_PARAM.3ssl b/upstream/archlinux/man3/OSSL_PARAM.3ssl index 26c0be2b..c19998c8 100644 --- a/upstream/archlinux/man3/OSSL_PARAM.3ssl +++ b/upstream/archlinux/man3/OSSL_PARAM.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_PARAM 3ssl" -.TH OSSL_PARAM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_PARAM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_PARAM_BLD.3ssl b/upstream/archlinux/man3/OSSL_PARAM_BLD.3ssl index 82fdb799..33dd9940 100644 --- a/upstream/archlinux/man3/OSSL_PARAM_BLD.3ssl +++ b/upstream/archlinux/man3/OSSL_PARAM_BLD.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_PARAM_BLD 3ssl" -.TH OSSL_PARAM_BLD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_PARAM_BLD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_PARAM_allocate_from_text.3ssl b/upstream/archlinux/man3/OSSL_PARAM_allocate_from_text.3ssl index f1b0f781..4057af37 100644 --- a/upstream/archlinux/man3/OSSL_PARAM_allocate_from_text.3ssl +++ b/upstream/archlinux/man3/OSSL_PARAM_allocate_from_text.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_PARAM_ALLOCATE_FROM_TEXT 3ssl" -.TH OSSL_PARAM_ALLOCATE_FROM_TEXT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_PARAM_ALLOCATE_FROM_TEXT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_PARAM_dup.3ssl b/upstream/archlinux/man3/OSSL_PARAM_dup.3ssl index bb00812b..64762fcc 100644 --- a/upstream/archlinux/man3/OSSL_PARAM_dup.3ssl +++ b/upstream/archlinux/man3/OSSL_PARAM_dup.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_PARAM_DUP 3ssl" -.TH OSSL_PARAM_DUP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_PARAM_DUP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_PARAM_int.3ssl b/upstream/archlinux/man3/OSSL_PARAM_int.3ssl index ae97b67b..97169e5f 100644 --- a/upstream/archlinux/man3/OSSL_PARAM_int.3ssl +++ b/upstream/archlinux/man3/OSSL_PARAM_int.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_PARAM_INT 3ssl" -.TH OSSL_PARAM_INT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_PARAM_INT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_PROVIDER.3ssl b/upstream/archlinux/man3/OSSL_PROVIDER.3ssl index 0405fdd8..75582271 100644 --- a/upstream/archlinux/man3/OSSL_PROVIDER.3ssl +++ b/upstream/archlinux/man3/OSSL_PROVIDER.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_PROVIDER 3ssl" -.TH OSSL_PROVIDER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_PROVIDER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_QUIC_client_method.3ssl b/upstream/archlinux/man3/OSSL_QUIC_client_method.3ssl index 4975bdb6..e61689be 100644 --- a/upstream/archlinux/man3/OSSL_QUIC_client_method.3ssl +++ b/upstream/archlinux/man3/OSSL_QUIC_client_method.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_QUIC_CLIENT_METHOD 3ssl" -.TH OSSL_QUIC_CLIENT_METHOD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_QUIC_CLIENT_METHOD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_SELF_TEST_new.3ssl b/upstream/archlinux/man3/OSSL_SELF_TEST_new.3ssl index 4d72e07b..bb0bf2ac 100644 --- a/upstream/archlinux/man3/OSSL_SELF_TEST_new.3ssl +++ b/upstream/archlinux/man3/OSSL_SELF_TEST_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_SELF_TEST_NEW 3ssl" -.TH OSSL_SELF_TEST_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_SELF_TEST_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_SELF_TEST_set_callback.3ssl b/upstream/archlinux/man3/OSSL_SELF_TEST_set_callback.3ssl index e49354a6..616e69d9 100644 --- a/upstream/archlinux/man3/OSSL_SELF_TEST_set_callback.3ssl +++ b/upstream/archlinux/man3/OSSL_SELF_TEST_set_callback.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_SELF_TEST_SET_CALLBACK 3ssl" -.TH OSSL_SELF_TEST_SET_CALLBACK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_SELF_TEST_SET_CALLBACK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_STORE_INFO.3ssl b/upstream/archlinux/man3/OSSL_STORE_INFO.3ssl index 6e0185aa..47aae8ab 100644 --- a/upstream/archlinux/man3/OSSL_STORE_INFO.3ssl +++ b/upstream/archlinux/man3/OSSL_STORE_INFO.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_STORE_INFO 3ssl" -.TH OSSL_STORE_INFO 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_STORE_INFO 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_STORE_LOADER.3ssl b/upstream/archlinux/man3/OSSL_STORE_LOADER.3ssl index d310cc96..bdb6a43c 100644 --- a/upstream/archlinux/man3/OSSL_STORE_LOADER.3ssl +++ b/upstream/archlinux/man3/OSSL_STORE_LOADER.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_STORE_LOADER 3ssl" -.TH OSSL_STORE_LOADER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_STORE_LOADER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_STORE_SEARCH.3ssl b/upstream/archlinux/man3/OSSL_STORE_SEARCH.3ssl index 784c70e4..436a49c4 100644 --- a/upstream/archlinux/man3/OSSL_STORE_SEARCH.3ssl +++ b/upstream/archlinux/man3/OSSL_STORE_SEARCH.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_STORE_SEARCH 3ssl" -.TH OSSL_STORE_SEARCH 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_STORE_SEARCH 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_STORE_attach.3ssl b/upstream/archlinux/man3/OSSL_STORE_attach.3ssl index 03625e86..7afb1d17 100644 --- a/upstream/archlinux/man3/OSSL_STORE_attach.3ssl +++ b/upstream/archlinux/man3/OSSL_STORE_attach.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_STORE_ATTACH 3ssl" -.TH OSSL_STORE_ATTACH 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_STORE_ATTACH 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_STORE_expect.3ssl b/upstream/archlinux/man3/OSSL_STORE_expect.3ssl index 9c190eed..eab95738 100644 --- a/upstream/archlinux/man3/OSSL_STORE_expect.3ssl +++ b/upstream/archlinux/man3/OSSL_STORE_expect.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_STORE_EXPECT 3ssl" -.TH OSSL_STORE_EXPECT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_STORE_EXPECT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_STORE_open.3ssl b/upstream/archlinux/man3/OSSL_STORE_open.3ssl index 86340a57..c5bd3a72 100644 --- a/upstream/archlinux/man3/OSSL_STORE_open.3ssl +++ b/upstream/archlinux/man3/OSSL_STORE_open.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_STORE_OPEN 3ssl" -.TH OSSL_STORE_OPEN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_STORE_OPEN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_sleep.3ssl b/upstream/archlinux/man3/OSSL_sleep.3ssl index 7c354e77..d63ebb11 100644 --- a/upstream/archlinux/man3/OSSL_sleep.3ssl +++ b/upstream/archlinux/man3/OSSL_sleep.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_SLEEP 3ssl" -.TH OSSL_SLEEP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_SLEEP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_trace_enabled.3ssl b/upstream/archlinux/man3/OSSL_trace_enabled.3ssl index 6bd67a7f..010acaad 100644 --- a/upstream/archlinux/man3/OSSL_trace_enabled.3ssl +++ b/upstream/archlinux/man3/OSSL_trace_enabled.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_TRACE_ENABLED 3ssl" -.TH OSSL_TRACE_ENABLED 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_TRACE_ENABLED 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_trace_get_category_num.3ssl b/upstream/archlinux/man3/OSSL_trace_get_category_num.3ssl index e6a5989a..f2ed7dd7 100644 --- a/upstream/archlinux/man3/OSSL_trace_get_category_num.3ssl +++ b/upstream/archlinux/man3/OSSL_trace_get_category_num.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_TRACE_GET_CATEGORY_NUM 3ssl" -.TH OSSL_TRACE_GET_CATEGORY_NUM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_TRACE_GET_CATEGORY_NUM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OSSL_trace_set_channel.3ssl b/upstream/archlinux/man3/OSSL_trace_set_channel.3ssl index 452f739f..5e2b9421 100644 --- a/upstream/archlinux/man3/OSSL_trace_set_channel.3ssl +++ b/upstream/archlinux/man3/OSSL_trace_set_channel.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OSSL_TRACE_SET_CHANNEL 3ssl" -.TH OSSL_TRACE_SET_CHANNEL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OSSL_TRACE_SET_CHANNEL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OpenSSL_add_all_algorithms.3ssl b/upstream/archlinux/man3/OpenSSL_add_all_algorithms.3ssl index 9313721d..c7626023 100644 --- a/upstream/archlinux/man3/OpenSSL_add_all_algorithms.3ssl +++ b/upstream/archlinux/man3/OpenSSL_add_all_algorithms.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_ADD_ALL_ALGORITHMS 3ssl" -.TH OPENSSL_ADD_ALL_ALGORITHMS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_ADD_ALL_ALGORITHMS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/OpenSSL_version.3ssl b/upstream/archlinux/man3/OpenSSL_version.3ssl index 87a02c3a..82aec9de 100644 --- a/upstream/archlinux/man3/OpenSSL_version.3ssl +++ b/upstream/archlinux/man3/OpenSSL_version.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "OPENSSL_VERSION 3ssl" -.TH OPENSSL_VERSION 3ssl 2024-01-30 3.2.1 OpenSSL +.TH OPENSSL_VERSION 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PEM_X509_INFO_read_bio_ex.3ssl b/upstream/archlinux/man3/PEM_X509_INFO_read_bio_ex.3ssl index cd6cac7a..62a9a21d 100644 --- a/upstream/archlinux/man3/PEM_X509_INFO_read_bio_ex.3ssl +++ b/upstream/archlinux/man3/PEM_X509_INFO_read_bio_ex.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PEM_X509_INFO_READ_BIO_EX 3ssl" -.TH PEM_X509_INFO_READ_BIO_EX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PEM_X509_INFO_READ_BIO_EX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PEM_bytes_read_bio.3ssl b/upstream/archlinux/man3/PEM_bytes_read_bio.3ssl index bb0e29fb..7614039c 100644 --- a/upstream/archlinux/man3/PEM_bytes_read_bio.3ssl +++ b/upstream/archlinux/man3/PEM_bytes_read_bio.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PEM_BYTES_READ_BIO 3ssl" -.TH PEM_BYTES_READ_BIO 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PEM_BYTES_READ_BIO 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PEM_read.3ssl b/upstream/archlinux/man3/PEM_read.3ssl index 83d433e4..c3c838dc 100644 --- a/upstream/archlinux/man3/PEM_read.3ssl +++ b/upstream/archlinux/man3/PEM_read.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PEM_READ 3ssl" -.TH PEM_READ 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PEM_READ 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PEM_read_CMS.3ssl b/upstream/archlinux/man3/PEM_read_CMS.3ssl index 362c2710..ced8b958 100644 --- a/upstream/archlinux/man3/PEM_read_CMS.3ssl +++ b/upstream/archlinux/man3/PEM_read_CMS.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PEM_READ_CMS 3ssl" -.TH PEM_READ_CMS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PEM_READ_CMS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PEM_read_bio_PrivateKey.3ssl b/upstream/archlinux/man3/PEM_read_bio_PrivateKey.3ssl index 49b8dad2..e555c094 100644 --- a/upstream/archlinux/man3/PEM_read_bio_PrivateKey.3ssl +++ b/upstream/archlinux/man3/PEM_read_bio_PrivateKey.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PEM_READ_BIO_PRIVATEKEY 3ssl" -.TH PEM_READ_BIO_PRIVATEKEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PEM_READ_BIO_PRIVATEKEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PEM_read_bio_ex.3ssl b/upstream/archlinux/man3/PEM_read_bio_ex.3ssl index 16091269..48cda2ab 100644 --- a/upstream/archlinux/man3/PEM_read_bio_ex.3ssl +++ b/upstream/archlinux/man3/PEM_read_bio_ex.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PEM_READ_BIO_EX 3ssl" -.TH PEM_READ_BIO_EX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PEM_READ_BIO_EX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PEM_write_bio_CMS_stream.3ssl b/upstream/archlinux/man3/PEM_write_bio_CMS_stream.3ssl index bb17e57f..b2d03f8d 100644 --- a/upstream/archlinux/man3/PEM_write_bio_CMS_stream.3ssl +++ b/upstream/archlinux/man3/PEM_write_bio_CMS_stream.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PEM_WRITE_BIO_CMS_STREAM 3ssl" -.TH PEM_WRITE_BIO_CMS_STREAM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PEM_WRITE_BIO_CMS_STREAM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PEM_write_bio_PKCS7_stream.3ssl b/upstream/archlinux/man3/PEM_write_bio_PKCS7_stream.3ssl index 2b43eeab..917034b1 100644 --- a/upstream/archlinux/man3/PEM_write_bio_PKCS7_stream.3ssl +++ b/upstream/archlinux/man3/PEM_write_bio_PKCS7_stream.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PEM_WRITE_BIO_PKCS7_STREAM 3ssl" -.TH PEM_WRITE_BIO_PKCS7_STREAM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PEM_WRITE_BIO_PKCS7_STREAM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_PBE_keyivgen.3ssl b/upstream/archlinux/man3/PKCS12_PBE_keyivgen.3ssl index 40315293..1d81805a 100644 --- a/upstream/archlinux/man3/PKCS12_PBE_keyivgen.3ssl +++ b/upstream/archlinux/man3/PKCS12_PBE_keyivgen.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_PBE_KEYIVGEN 3ssl" -.TH PKCS12_PBE_KEYIVGEN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_PBE_KEYIVGEN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_SAFEBAG_create_cert.3ssl b/upstream/archlinux/man3/PKCS12_SAFEBAG_create_cert.3ssl index 76a1e403..0e0eea8a 100644 --- a/upstream/archlinux/man3/PKCS12_SAFEBAG_create_cert.3ssl +++ b/upstream/archlinux/man3/PKCS12_SAFEBAG_create_cert.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_SAFEBAG_CREATE_CERT 3ssl" -.TH PKCS12_SAFEBAG_CREATE_CERT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_SAFEBAG_CREATE_CERT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_SAFEBAG_get0_attrs.3ssl b/upstream/archlinux/man3/PKCS12_SAFEBAG_get0_attrs.3ssl index c3151915..57284700 100644 --- a/upstream/archlinux/man3/PKCS12_SAFEBAG_get0_attrs.3ssl +++ b/upstream/archlinux/man3/PKCS12_SAFEBAG_get0_attrs.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_SAFEBAG_GET0_ATTRS 3ssl" -.TH PKCS12_SAFEBAG_GET0_ATTRS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_SAFEBAG_GET0_ATTRS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_SAFEBAG_get1_cert.3ssl b/upstream/archlinux/man3/PKCS12_SAFEBAG_get1_cert.3ssl index 11b8cc2b..f5ca11c7 100644 --- a/upstream/archlinux/man3/PKCS12_SAFEBAG_get1_cert.3ssl +++ b/upstream/archlinux/man3/PKCS12_SAFEBAG_get1_cert.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_SAFEBAG_GET1_CERT 3ssl" -.TH PKCS12_SAFEBAG_GET1_CERT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_SAFEBAG_GET1_CERT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_SAFEBAG_set0_attrs.3ssl b/upstream/archlinux/man3/PKCS12_SAFEBAG_set0_attrs.3ssl index 759d74d7..9be7d574 100644 --- a/upstream/archlinux/man3/PKCS12_SAFEBAG_set0_attrs.3ssl +++ b/upstream/archlinux/man3/PKCS12_SAFEBAG_set0_attrs.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_SAFEBAG_SET0_ATTRS 3ssl" -.TH PKCS12_SAFEBAG_SET0_ATTRS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_SAFEBAG_SET0_ATTRS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_add1_attr_by_NID.3ssl b/upstream/archlinux/man3/PKCS12_add1_attr_by_NID.3ssl index ce416085..b27c4fce 100644 --- a/upstream/archlinux/man3/PKCS12_add1_attr_by_NID.3ssl +++ b/upstream/archlinux/man3/PKCS12_add1_attr_by_NID.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_ADD1_ATTR_BY_NID 3ssl" -.TH PKCS12_ADD1_ATTR_BY_NID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_ADD1_ATTR_BY_NID 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_add_CSPName_asc.3ssl b/upstream/archlinux/man3/PKCS12_add_CSPName_asc.3ssl index 3c75985a..541d19b9 100644 --- a/upstream/archlinux/man3/PKCS12_add_CSPName_asc.3ssl +++ b/upstream/archlinux/man3/PKCS12_add_CSPName_asc.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_ADD_CSPNAME_ASC 3ssl" -.TH PKCS12_ADD_CSPNAME_ASC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_ADD_CSPNAME_ASC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_add_cert.3ssl b/upstream/archlinux/man3/PKCS12_add_cert.3ssl index cbec2b4c..e5596cc7 100644 --- a/upstream/archlinux/man3/PKCS12_add_cert.3ssl +++ b/upstream/archlinux/man3/PKCS12_add_cert.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_ADD_CERT 3ssl" -.TH PKCS12_ADD_CERT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_ADD_CERT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_add_friendlyname_asc.3ssl b/upstream/archlinux/man3/PKCS12_add_friendlyname_asc.3ssl index 5389ec8d..b8c2040a 100644 --- a/upstream/archlinux/man3/PKCS12_add_friendlyname_asc.3ssl +++ b/upstream/archlinux/man3/PKCS12_add_friendlyname_asc.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_ADD_FRIENDLYNAME_ASC 3ssl" -.TH PKCS12_ADD_FRIENDLYNAME_ASC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_ADD_FRIENDLYNAME_ASC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_add_localkeyid.3ssl b/upstream/archlinux/man3/PKCS12_add_localkeyid.3ssl index ffaee293..db6e9c9d 100644 --- a/upstream/archlinux/man3/PKCS12_add_localkeyid.3ssl +++ b/upstream/archlinux/man3/PKCS12_add_localkeyid.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_ADD_LOCALKEYID 3ssl" -.TH PKCS12_ADD_LOCALKEYID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_ADD_LOCALKEYID 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_add_safe.3ssl b/upstream/archlinux/man3/PKCS12_add_safe.3ssl index 9cb36f5f..4287bb7a 100644 --- a/upstream/archlinux/man3/PKCS12_add_safe.3ssl +++ b/upstream/archlinux/man3/PKCS12_add_safe.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_ADD_SAFE 3ssl" -.TH PKCS12_ADD_SAFE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_ADD_SAFE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_create.3ssl b/upstream/archlinux/man3/PKCS12_create.3ssl index 09bd8f65..f1cf56b6 100644 --- a/upstream/archlinux/man3/PKCS12_create.3ssl +++ b/upstream/archlinux/man3/PKCS12_create.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_CREATE 3ssl" -.TH PKCS12_CREATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_CREATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -102,7 +102,7 @@ iteration count to use and \fImac_iter\fR is the MAC iteration count to use. \&\fIctx\fR and property query \fIpropq\fR to be used to select algorithm implementations. .PP \&\fBPKCS12_create_ex2()\fR is identical to \fBPKCS12_create_ex()\fR but allows for a user defined -callback \fIcb\fR of type \fBPKCS12_create_cb\fR to be specified and also allows for an +callback \fIcb\fR of type \fBPKCS12_create_cb\fR to be specified and also allows for an optional argument \fIcbarg\fR to be passed back to the callback. .PP The \fIcb\fR if specified will be called for every safebag added to the diff --git a/upstream/archlinux/man3/PKCS12_decrypt_skey.3ssl b/upstream/archlinux/man3/PKCS12_decrypt_skey.3ssl index 5279fe09..59c6a976 100644 --- a/upstream/archlinux/man3/PKCS12_decrypt_skey.3ssl +++ b/upstream/archlinux/man3/PKCS12_decrypt_skey.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_DECRYPT_SKEY 3ssl" -.TH PKCS12_DECRYPT_SKEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_DECRYPT_SKEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_gen_mac.3ssl b/upstream/archlinux/man3/PKCS12_gen_mac.3ssl index c99f3d1c..b9a9a2b3 100644 --- a/upstream/archlinux/man3/PKCS12_gen_mac.3ssl +++ b/upstream/archlinux/man3/PKCS12_gen_mac.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_GEN_MAC 3ssl" -.TH PKCS12_GEN_MAC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_GEN_MAC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_get_friendlyname.3ssl b/upstream/archlinux/man3/PKCS12_get_friendlyname.3ssl index 534aa0ca..705078e4 100644 --- a/upstream/archlinux/man3/PKCS12_get_friendlyname.3ssl +++ b/upstream/archlinux/man3/PKCS12_get_friendlyname.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_GET_FRIENDLYNAME 3ssl" -.TH PKCS12_GET_FRIENDLYNAME 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_GET_FRIENDLYNAME 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_init.3ssl b/upstream/archlinux/man3/PKCS12_init.3ssl index b4bb026a..ff3b53b2 100644 --- a/upstream/archlinux/man3/PKCS12_init.3ssl +++ b/upstream/archlinux/man3/PKCS12_init.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_INIT 3ssl" -.TH PKCS12_INIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_INIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_item_decrypt_d2i.3ssl b/upstream/archlinux/man3/PKCS12_item_decrypt_d2i.3ssl index 330746fd..2076e8b8 100644 --- a/upstream/archlinux/man3/PKCS12_item_decrypt_d2i.3ssl +++ b/upstream/archlinux/man3/PKCS12_item_decrypt_d2i.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_ITEM_DECRYPT_D2I 3ssl" -.TH PKCS12_ITEM_DECRYPT_D2I 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_ITEM_DECRYPT_D2I 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_key_gen_utf8_ex.3ssl b/upstream/archlinux/man3/PKCS12_key_gen_utf8_ex.3ssl index 21ed56dc..988cd329 100644 --- a/upstream/archlinux/man3/PKCS12_key_gen_utf8_ex.3ssl +++ b/upstream/archlinux/man3/PKCS12_key_gen_utf8_ex.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_KEY_GEN_UTF8_EX 3ssl" -.TH PKCS12_KEY_GEN_UTF8_EX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_KEY_GEN_UTF8_EX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_newpass.3ssl b/upstream/archlinux/man3/PKCS12_newpass.3ssl index 8a74934a..e6829f8a 100644 --- a/upstream/archlinux/man3/PKCS12_newpass.3ssl +++ b/upstream/archlinux/man3/PKCS12_newpass.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_NEWPASS 3ssl" -.TH PKCS12_NEWPASS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_NEWPASS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_pack_p7encdata.3ssl b/upstream/archlinux/man3/PKCS12_pack_p7encdata.3ssl index e8661a01..120fa830 100644 --- a/upstream/archlinux/man3/PKCS12_pack_p7encdata.3ssl +++ b/upstream/archlinux/man3/PKCS12_pack_p7encdata.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_PACK_P7ENCDATA 3ssl" -.TH PKCS12_PACK_P7ENCDATA 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_PACK_P7ENCDATA 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS12_parse.3ssl b/upstream/archlinux/man3/PKCS12_parse.3ssl index 2fd148cd..aa7c961a 100644 --- a/upstream/archlinux/man3/PKCS12_parse.3ssl +++ b/upstream/archlinux/man3/PKCS12_parse.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS12_PARSE 3ssl" -.TH PKCS12_PARSE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS12_PARSE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS5_PBE_keyivgen.3ssl b/upstream/archlinux/man3/PKCS5_PBE_keyivgen.3ssl index 1a71e52c..f352af06 100644 --- a/upstream/archlinux/man3/PKCS5_PBE_keyivgen.3ssl +++ b/upstream/archlinux/man3/PKCS5_PBE_keyivgen.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS5_PBE_KEYIVGEN 3ssl" -.TH PKCS5_PBE_KEYIVGEN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS5_PBE_KEYIVGEN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS5_PBKDF2_HMAC.3ssl b/upstream/archlinux/man3/PKCS5_PBKDF2_HMAC.3ssl index 17621012..c96df473 100644 --- a/upstream/archlinux/man3/PKCS5_PBKDF2_HMAC.3ssl +++ b/upstream/archlinux/man3/PKCS5_PBKDF2_HMAC.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS5_PBKDF2_HMAC 3ssl" -.TH PKCS5_PBKDF2_HMAC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS5_PBKDF2_HMAC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -122,7 +122,7 @@ It will simply be treated as a byte sequence. \&\fBpassphrase\-encoding\fR\|(7) .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2014\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2014\-2021 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/PKCS7_decrypt.3ssl b/upstream/archlinux/man3/PKCS7_decrypt.3ssl index b737dc33..70f23c9d 100644 --- a/upstream/archlinux/man3/PKCS7_decrypt.3ssl +++ b/upstream/archlinux/man3/PKCS7_decrypt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS7_DECRYPT 3ssl" -.TH PKCS7_DECRYPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS7_DECRYPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS7_encrypt.3ssl b/upstream/archlinux/man3/PKCS7_encrypt.3ssl index f2be56f2..1e6687b4 100644 --- a/upstream/archlinux/man3/PKCS7_encrypt.3ssl +++ b/upstream/archlinux/man3/PKCS7_encrypt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS7_ENCRYPT 3ssl" -.TH PKCS7_ENCRYPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS7_ENCRYPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS7_get_octet_string.3ssl b/upstream/archlinux/man3/PKCS7_get_octet_string.3ssl index d6d16573..8e72f026 100644 --- a/upstream/archlinux/man3/PKCS7_get_octet_string.3ssl +++ b/upstream/archlinux/man3/PKCS7_get_octet_string.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS7_GET_OCTET_STRING 3ssl" -.TH PKCS7_GET_OCTET_STRING 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS7_GET_OCTET_STRING 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS7_sign.3ssl b/upstream/archlinux/man3/PKCS7_sign.3ssl index 3eba5081..eb05482e 100644 --- a/upstream/archlinux/man3/PKCS7_sign.3ssl +++ b/upstream/archlinux/man3/PKCS7_sign.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS7_SIGN 3ssl" -.TH PKCS7_SIGN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS7_SIGN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS7_sign_add_signer.3ssl b/upstream/archlinux/man3/PKCS7_sign_add_signer.3ssl index b7ab7d27..318258db 100644 --- a/upstream/archlinux/man3/PKCS7_sign_add_signer.3ssl +++ b/upstream/archlinux/man3/PKCS7_sign_add_signer.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS7_SIGN_ADD_SIGNER 3ssl" -.TH PKCS7_SIGN_ADD_SIGNER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS7_SIGN_ADD_SIGNER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS7_type_is_other.3ssl b/upstream/archlinux/man3/PKCS7_type_is_other.3ssl index a47b7956..442957a9 100644 --- a/upstream/archlinux/man3/PKCS7_type_is_other.3ssl +++ b/upstream/archlinux/man3/PKCS7_type_is_other.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS7_TYPE_IS_OTHER 3ssl" -.TH PKCS7_TYPE_IS_OTHER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS7_TYPE_IS_OTHER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS7_verify.3ssl b/upstream/archlinux/man3/PKCS7_verify.3ssl index e8279363..27479eff 100644 --- a/upstream/archlinux/man3/PKCS7_verify.3ssl +++ b/upstream/archlinux/man3/PKCS7_verify.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS7_VERIFY 3ssl" -.TH PKCS7_VERIFY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS7_VERIFY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS8_encrypt.3ssl b/upstream/archlinux/man3/PKCS8_encrypt.3ssl index 222b45f4..cfb3953d 100644 --- a/upstream/archlinux/man3/PKCS8_encrypt.3ssl +++ b/upstream/archlinux/man3/PKCS8_encrypt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS8_ENCRYPT 3ssl" -.TH PKCS8_ENCRYPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS8_ENCRYPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/PKCS8_pkey_add1_attr.3ssl b/upstream/archlinux/man3/PKCS8_pkey_add1_attr.3ssl index b805104a..9d81bc2a 100644 --- a/upstream/archlinux/man3/PKCS8_pkey_add1_attr.3ssl +++ b/upstream/archlinux/man3/PKCS8_pkey_add1_attr.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "PKCS8_PKEY_ADD1_ATTR 3ssl" -.TH PKCS8_PKEY_ADD1_ATTR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH PKCS8_PKEY_ADD1_ATTR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RAND_add.3ssl b/upstream/archlinux/man3/RAND_add.3ssl index a0e5043d..f1412cf7 100644 --- a/upstream/archlinux/man3/RAND_add.3ssl +++ b/upstream/archlinux/man3/RAND_add.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RAND_ADD 3ssl" -.TH RAND_ADD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RAND_ADD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RAND_bytes.3ssl b/upstream/archlinux/man3/RAND_bytes.3ssl index c6c5568e..f7b79eb9 100644 --- a/upstream/archlinux/man3/RAND_bytes.3ssl +++ b/upstream/archlinux/man3/RAND_bytes.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RAND_BYTES 3ssl" -.TH RAND_BYTES 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RAND_BYTES 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RAND_cleanup.3ssl b/upstream/archlinux/man3/RAND_cleanup.3ssl index 9f9eeb3b..a00b30b5 100644 --- a/upstream/archlinux/man3/RAND_cleanup.3ssl +++ b/upstream/archlinux/man3/RAND_cleanup.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RAND_CLEANUP 3ssl" -.TH RAND_CLEANUP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RAND_CLEANUP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RAND_egd.3ssl b/upstream/archlinux/man3/RAND_egd.3ssl index 6503b1c5..3cbd56fa 100644 --- a/upstream/archlinux/man3/RAND_egd.3ssl +++ b/upstream/archlinux/man3/RAND_egd.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RAND_EGD 3ssl" -.TH RAND_EGD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RAND_EGD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RAND_get0_primary.3ssl b/upstream/archlinux/man3/RAND_get0_primary.3ssl index f921cf8f..6bb0d30f 100644 --- a/upstream/archlinux/man3/RAND_get0_primary.3ssl +++ b/upstream/archlinux/man3/RAND_get0_primary.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RAND_GET0_PRIMARY 3ssl" -.TH RAND_GET0_PRIMARY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RAND_GET0_PRIMARY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RAND_load_file.3ssl b/upstream/archlinux/man3/RAND_load_file.3ssl index 24290b42..149e8b91 100644 --- a/upstream/archlinux/man3/RAND_load_file.3ssl +++ b/upstream/archlinux/man3/RAND_load_file.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RAND_LOAD_FILE 3ssl" -.TH RAND_LOAD_FILE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RAND_LOAD_FILE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RAND_set_DRBG_type.3ssl b/upstream/archlinux/man3/RAND_set_DRBG_type.3ssl index 447192bc..de4515b7 100644 --- a/upstream/archlinux/man3/RAND_set_DRBG_type.3ssl +++ b/upstream/archlinux/man3/RAND_set_DRBG_type.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RAND_SET_DRBG_TYPE 3ssl" -.TH RAND_SET_DRBG_TYPE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RAND_SET_DRBG_TYPE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RAND_set_rand_method.3ssl b/upstream/archlinux/man3/RAND_set_rand_method.3ssl index 9187b038..52857265 100644 --- a/upstream/archlinux/man3/RAND_set_rand_method.3ssl +++ b/upstream/archlinux/man3/RAND_set_rand_method.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RAND_SET_RAND_METHOD 3ssl" -.TH RAND_SET_RAND_METHOD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RAND_SET_RAND_METHOD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RC4_set_key.3ssl b/upstream/archlinux/man3/RC4_set_key.3ssl index f51ca84f..759c27cf 100644 --- a/upstream/archlinux/man3/RC4_set_key.3ssl +++ b/upstream/archlinux/man3/RC4_set_key.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RC4_SET_KEY 3ssl" -.TH RC4_SET_KEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RC4_SET_KEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RIPEMD160_Init.3ssl b/upstream/archlinux/man3/RIPEMD160_Init.3ssl index 3b26bdcc..f7f07eb6 100644 --- a/upstream/archlinux/man3/RIPEMD160_Init.3ssl +++ b/upstream/archlinux/man3/RIPEMD160_Init.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RIPEMD160_INIT 3ssl" -.TH RIPEMD160_INIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RIPEMD160_INIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RSA_blinding_on.3ssl b/upstream/archlinux/man3/RSA_blinding_on.3ssl index 3bd54e61..5ade0bdb 100644 --- a/upstream/archlinux/man3/RSA_blinding_on.3ssl +++ b/upstream/archlinux/man3/RSA_blinding_on.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RSA_BLINDING_ON 3ssl" -.TH RSA_BLINDING_ON 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RSA_BLINDING_ON 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RSA_check_key.3ssl b/upstream/archlinux/man3/RSA_check_key.3ssl index 52f48cbe..7da2e3fa 100644 --- a/upstream/archlinux/man3/RSA_check_key.3ssl +++ b/upstream/archlinux/man3/RSA_check_key.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RSA_CHECK_KEY 3ssl" -.TH RSA_CHECK_KEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RSA_CHECK_KEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RSA_generate_key.3ssl b/upstream/archlinux/man3/RSA_generate_key.3ssl index d4334588..7dbf2bdb 100644 --- a/upstream/archlinux/man3/RSA_generate_key.3ssl +++ b/upstream/archlinux/man3/RSA_generate_key.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RSA_GENERATE_KEY 3ssl" -.TH RSA_GENERATE_KEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RSA_GENERATE_KEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RSA_get0_key.3ssl b/upstream/archlinux/man3/RSA_get0_key.3ssl index 67b7d710..e41d0c2a 100644 --- a/upstream/archlinux/man3/RSA_get0_key.3ssl +++ b/upstream/archlinux/man3/RSA_get0_key.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RSA_GET0_KEY 3ssl" -.TH RSA_GET0_KEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RSA_GET0_KEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RSA_meth_new.3ssl b/upstream/archlinux/man3/RSA_meth_new.3ssl index cd61b324..910c092d 100644 --- a/upstream/archlinux/man3/RSA_meth_new.3ssl +++ b/upstream/archlinux/man3/RSA_meth_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RSA_METH_NEW 3ssl" -.TH RSA_METH_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RSA_METH_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RSA_new.3ssl b/upstream/archlinux/man3/RSA_new.3ssl index 1437ddf6..7adf50bc 100644 --- a/upstream/archlinux/man3/RSA_new.3ssl +++ b/upstream/archlinux/man3/RSA_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RSA_NEW 3ssl" -.TH RSA_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RSA_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RSA_padding_add_PKCS1_type_1.3ssl b/upstream/archlinux/man3/RSA_padding_add_PKCS1_type_1.3ssl index ac938c6f..3616ae97 100644 --- a/upstream/archlinux/man3/RSA_padding_add_PKCS1_type_1.3ssl +++ b/upstream/archlinux/man3/RSA_padding_add_PKCS1_type_1.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RSA_PADDING_ADD_PKCS1_TYPE_1 3ssl" -.TH RSA_PADDING_ADD_PKCS1_TYPE_1 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RSA_PADDING_ADD_PKCS1_TYPE_1 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RSA_print.3ssl b/upstream/archlinux/man3/RSA_print.3ssl index ef31067f..674e3ab4 100644 --- a/upstream/archlinux/man3/RSA_print.3ssl +++ b/upstream/archlinux/man3/RSA_print.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RSA_PRINT 3ssl" -.TH RSA_PRINT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RSA_PRINT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RSA_private_encrypt.3ssl b/upstream/archlinux/man3/RSA_private_encrypt.3ssl index a2289897..2d07359f 100644 --- a/upstream/archlinux/man3/RSA_private_encrypt.3ssl +++ b/upstream/archlinux/man3/RSA_private_encrypt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RSA_PRIVATE_ENCRYPT 3ssl" -.TH RSA_PRIVATE_ENCRYPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RSA_PRIVATE_ENCRYPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RSA_public_encrypt.3ssl b/upstream/archlinux/man3/RSA_public_encrypt.3ssl index c68ff7a4..c487de08 100644 --- a/upstream/archlinux/man3/RSA_public_encrypt.3ssl +++ b/upstream/archlinux/man3/RSA_public_encrypt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RSA_PUBLIC_ENCRYPT 3ssl" -.TH RSA_PUBLIC_ENCRYPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RSA_PUBLIC_ENCRYPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RSA_set_method.3ssl b/upstream/archlinux/man3/RSA_set_method.3ssl index 7cce04e6..c4bfd372 100644 --- a/upstream/archlinux/man3/RSA_set_method.3ssl +++ b/upstream/archlinux/man3/RSA_set_method.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RSA_SET_METHOD 3ssl" -.TH RSA_SET_METHOD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RSA_SET_METHOD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RSA_sign.3ssl b/upstream/archlinux/man3/RSA_sign.3ssl index 0ee03ae6..084b6d96 100644 --- a/upstream/archlinux/man3/RSA_sign.3ssl +++ b/upstream/archlinux/man3/RSA_sign.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RSA_SIGN 3ssl" -.TH RSA_SIGN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RSA_SIGN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RSA_sign_ASN1_OCTET_STRING.3ssl b/upstream/archlinux/man3/RSA_sign_ASN1_OCTET_STRING.3ssl index 057f14c6..9b86667a 100644 --- a/upstream/archlinux/man3/RSA_sign_ASN1_OCTET_STRING.3ssl +++ b/upstream/archlinux/man3/RSA_sign_ASN1_OCTET_STRING.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RSA_SIGN_ASN1_OCTET_STRING 3ssl" -.TH RSA_SIGN_ASN1_OCTET_STRING 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RSA_SIGN_ASN1_OCTET_STRING 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/RSA_size.3ssl b/upstream/archlinux/man3/RSA_size.3ssl index 05edcb3a..61d148a4 100644 --- a/upstream/archlinux/man3/RSA_size.3ssl +++ b/upstream/archlinux/man3/RSA_size.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "RSA_SIZE 3ssl" -.TH RSA_SIZE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH RSA_SIZE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SCT_new.3ssl b/upstream/archlinux/man3/SCT_new.3ssl index 87131baf..4a104714 100644 --- a/upstream/archlinux/man3/SCT_new.3ssl +++ b/upstream/archlinux/man3/SCT_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SCT_NEW 3ssl" -.TH SCT_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SCT_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SCT_print.3ssl b/upstream/archlinux/man3/SCT_print.3ssl index 7ffd406b..81d006be 100644 --- a/upstream/archlinux/man3/SCT_print.3ssl +++ b/upstream/archlinux/man3/SCT_print.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SCT_PRINT 3ssl" -.TH SCT_PRINT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SCT_PRINT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SCT_validate.3ssl b/upstream/archlinux/man3/SCT_validate.3ssl index 3b0cb0cd..1c648edb 100644 --- a/upstream/archlinux/man3/SCT_validate.3ssl +++ b/upstream/archlinux/man3/SCT_validate.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SCT_VALIDATE 3ssl" -.TH SCT_VALIDATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SCT_VALIDATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SHA256_Init.3ssl b/upstream/archlinux/man3/SHA256_Init.3ssl index 28c74469..8dd4d055 100644 --- a/upstream/archlinux/man3/SHA256_Init.3ssl +++ b/upstream/archlinux/man3/SHA256_Init.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SHA256_INIT 3ssl" -.TH SHA256_INIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SHA256_INIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SMIME_read_ASN1.3ssl b/upstream/archlinux/man3/SMIME_read_ASN1.3ssl index c39dbc55..b9bf79ed 100644 --- a/upstream/archlinux/man3/SMIME_read_ASN1.3ssl +++ b/upstream/archlinux/man3/SMIME_read_ASN1.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SMIME_READ_ASN1 3ssl" -.TH SMIME_READ_ASN1 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SMIME_READ_ASN1 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SMIME_read_CMS.3ssl b/upstream/archlinux/man3/SMIME_read_CMS.3ssl index 675bb662..aa88c217 100644 --- a/upstream/archlinux/man3/SMIME_read_CMS.3ssl +++ b/upstream/archlinux/man3/SMIME_read_CMS.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SMIME_READ_CMS 3ssl" -.TH SMIME_READ_CMS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SMIME_READ_CMS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SMIME_read_PKCS7.3ssl b/upstream/archlinux/man3/SMIME_read_PKCS7.3ssl index c614743a..043ed781 100644 --- a/upstream/archlinux/man3/SMIME_read_PKCS7.3ssl +++ b/upstream/archlinux/man3/SMIME_read_PKCS7.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SMIME_READ_PKCS7 3ssl" -.TH SMIME_READ_PKCS7 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SMIME_READ_PKCS7 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SMIME_write_ASN1.3ssl b/upstream/archlinux/man3/SMIME_write_ASN1.3ssl index c320ae30..746d666a 100644 --- a/upstream/archlinux/man3/SMIME_write_ASN1.3ssl +++ b/upstream/archlinux/man3/SMIME_write_ASN1.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SMIME_WRITE_ASN1 3ssl" -.TH SMIME_WRITE_ASN1 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SMIME_WRITE_ASN1 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SMIME_write_CMS.3ssl b/upstream/archlinux/man3/SMIME_write_CMS.3ssl index b44da8c3..3d3874d1 100644 --- a/upstream/archlinux/man3/SMIME_write_CMS.3ssl +++ b/upstream/archlinux/man3/SMIME_write_CMS.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SMIME_WRITE_CMS 3ssl" -.TH SMIME_WRITE_CMS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SMIME_WRITE_CMS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SMIME_write_PKCS7.3ssl b/upstream/archlinux/man3/SMIME_write_PKCS7.3ssl index a3acd73a..10294307 100644 --- a/upstream/archlinux/man3/SMIME_write_PKCS7.3ssl +++ b/upstream/archlinux/man3/SMIME_write_PKCS7.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SMIME_WRITE_PKCS7 3ssl" -.TH SMIME_WRITE_PKCS7 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SMIME_WRITE_PKCS7 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SRP_Calc_B.3ssl b/upstream/archlinux/man3/SRP_Calc_B.3ssl index c9795d86..a8d03158 100644 --- a/upstream/archlinux/man3/SRP_Calc_B.3ssl +++ b/upstream/archlinux/man3/SRP_Calc_B.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SRP_CALC_B 3ssl" -.TH SRP_CALC_B 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SRP_CALC_B 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SRP_VBASE_new.3ssl b/upstream/archlinux/man3/SRP_VBASE_new.3ssl index 92b0572d..bf20fa17 100644 --- a/upstream/archlinux/man3/SRP_VBASE_new.3ssl +++ b/upstream/archlinux/man3/SRP_VBASE_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SRP_VBASE_NEW 3ssl" -.TH SRP_VBASE_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SRP_VBASE_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SRP_create_verifier.3ssl b/upstream/archlinux/man3/SRP_create_verifier.3ssl index e927164f..f4d534f9 100644 --- a/upstream/archlinux/man3/SRP_create_verifier.3ssl +++ b/upstream/archlinux/man3/SRP_create_verifier.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SRP_CREATE_VERIFIER 3ssl" -.TH SRP_CREATE_VERIFIER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SRP_CREATE_VERIFIER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SRP_user_pwd_new.3ssl b/upstream/archlinux/man3/SRP_user_pwd_new.3ssl index f1359a2b..afbb5a8c 100644 --- a/upstream/archlinux/man3/SRP_user_pwd_new.3ssl +++ b/upstream/archlinux/man3/SRP_user_pwd_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SRP_USER_PWD_NEW 3ssl" -.TH SRP_USER_PWD_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SRP_USER_PWD_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CIPHER_get_name.3ssl b/upstream/archlinux/man3/SSL_CIPHER_get_name.3ssl index d7b6f7a3..93df1545 100644 --- a/upstream/archlinux/man3/SSL_CIPHER_get_name.3ssl +++ b/upstream/archlinux/man3/SSL_CIPHER_get_name.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CIPHER_GET_NAME 3ssl" -.TH SSL_CIPHER_GET_NAME 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CIPHER_GET_NAME 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_COMP_add_compression_method.3ssl b/upstream/archlinux/man3/SSL_COMP_add_compression_method.3ssl index 1bf28676..26b38bfc 100644 --- a/upstream/archlinux/man3/SSL_COMP_add_compression_method.3ssl +++ b/upstream/archlinux/man3/SSL_COMP_add_compression_method.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_COMP_ADD_COMPRESSION_METHOD 3ssl" -.TH SSL_COMP_ADD_COMPRESSION_METHOD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_COMP_ADD_COMPRESSION_METHOD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CONF_CTX_new.3ssl b/upstream/archlinux/man3/SSL_CONF_CTX_new.3ssl index 9bdf2c79..38e1a3f9 100644 --- a/upstream/archlinux/man3/SSL_CONF_CTX_new.3ssl +++ b/upstream/archlinux/man3/SSL_CONF_CTX_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CONF_CTX_NEW 3ssl" -.TH SSL_CONF_CTX_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CONF_CTX_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CONF_CTX_set1_prefix.3ssl b/upstream/archlinux/man3/SSL_CONF_CTX_set1_prefix.3ssl index c1889fa7..78533312 100644 --- a/upstream/archlinux/man3/SSL_CONF_CTX_set1_prefix.3ssl +++ b/upstream/archlinux/man3/SSL_CONF_CTX_set1_prefix.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CONF_CTX_SET1_PREFIX 3ssl" -.TH SSL_CONF_CTX_SET1_PREFIX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CONF_CTX_SET1_PREFIX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CONF_CTX_set_flags.3ssl b/upstream/archlinux/man3/SSL_CONF_CTX_set_flags.3ssl index 1d5ea85a..7968b1cd 100644 --- a/upstream/archlinux/man3/SSL_CONF_CTX_set_flags.3ssl +++ b/upstream/archlinux/man3/SSL_CONF_CTX_set_flags.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CONF_CTX_SET_FLAGS 3ssl" -.TH SSL_CONF_CTX_SET_FLAGS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CONF_CTX_SET_FLAGS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CONF_CTX_set_ssl_ctx.3ssl b/upstream/archlinux/man3/SSL_CONF_CTX_set_ssl_ctx.3ssl index c41bf999..6d07ebc6 100644 --- a/upstream/archlinux/man3/SSL_CONF_CTX_set_ssl_ctx.3ssl +++ b/upstream/archlinux/man3/SSL_CONF_CTX_set_ssl_ctx.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CONF_CTX_SET_SSL_CTX 3ssl" -.TH SSL_CONF_CTX_SET_SSL_CTX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CONF_CTX_SET_SSL_CTX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CONF_cmd.3ssl b/upstream/archlinux/man3/SSL_CONF_cmd.3ssl index 902c6c48..74fa3ad0 100644 --- a/upstream/archlinux/man3/SSL_CONF_cmd.3ssl +++ b/upstream/archlinux/man3/SSL_CONF_cmd.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CONF_CMD 3ssl" -.TH SSL_CONF_CMD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CONF_CMD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -141,6 +141,11 @@ Only used by servers. Requires \fB\-serverpref\fR. .IX Item "-allow_no_dhe_kex" In TLSv1.3 allow a non\-(ec)dhe based key exchange mode on resumption. This means that there will be no forward secrecy for the resumed session. +.IP \fB\-prefer_no_dhe_kex\fR 4 +.IX Item "-prefer_no_dhe_kex" +In TLSv1.3, on resumption let the server prefer a non\-(ec)dhe based key +exchange mode over an (ec)dhe based one. Requires \fB\-allow_no_dhe_kex\fR. +Equivalent to \fBSSL_OP_PREFER_NO_DHE_KEX\fR. Only used by servers. .IP \fB\-strict\fR 4 .IX Item "-strict" Enables strict mode protocol handling. Equivalent to setting @@ -521,6 +526,11 @@ default. Inverse of \fBSSL_OP_NO_ENCRYPT_THEN_MAC\fR: that is, resumption. This means that there will be no forward secrecy for the resumed session. Equivalent to \fBSSL_OP_ALLOW_NO_DHE_KEX\fR. .Sp +\&\fBPreferNoDHEKEX\fR: In TLSv1.3, on resumption let the server prefer a +non\-(ec)dhe based key exchange mode over an (ec)dhe based one. Requires +\&\fBAllowNoDHEKEX\fR. Equivalent to \fBSSL_OP_PREFER_NO_DHE_KEX\fR. Only used by +servers. +.Sp \&\fBMiddleboxCompat\fR: If set then dummy Change Cipher Spec (CCS) messages are sent in TLSv1.3. This has the effect of making TLSv1.3 look more like TLSv1.2 so that middleboxes that do not understand TLSv1.3 will not drop the connection. This @@ -778,6 +788,8 @@ OpenSSL 3.0. .PP The \fBTxCertificateCompression\fR and \fBRxCertificateCompression\fR options were added in OpenSSL 3.2. +.PP +\&\fBPreferNoDHEKEX\fR was added in OpenSSL 3.3. .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2012\-2023 The OpenSSL Project Authors. All Rights Reserved. diff --git a/upstream/archlinux/man3/SSL_CONF_cmd_argv.3ssl b/upstream/archlinux/man3/SSL_CONF_cmd_argv.3ssl index ce6e327b..23de104a 100644 --- a/upstream/archlinux/man3/SSL_CONF_cmd_argv.3ssl +++ b/upstream/archlinux/man3/SSL_CONF_cmd_argv.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CONF_CMD_ARGV 3ssl" -.TH SSL_CONF_CMD_ARGV 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CONF_CMD_ARGV 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_add1_chain_cert.3ssl b/upstream/archlinux/man3/SSL_CTX_add1_chain_cert.3ssl index 277185a2..36abd262 100644 --- a/upstream/archlinux/man3/SSL_CTX_add1_chain_cert.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_add1_chain_cert.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_ADD1_CHAIN_CERT 3ssl" -.TH SSL_CTX_ADD1_CHAIN_CERT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_ADD1_CHAIN_CERT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_add_extra_chain_cert.3ssl b/upstream/archlinux/man3/SSL_CTX_add_extra_chain_cert.3ssl index aee3855e..fc448bbb 100644 --- a/upstream/archlinux/man3/SSL_CTX_add_extra_chain_cert.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_add_extra_chain_cert.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_ADD_EXTRA_CHAIN_CERT 3ssl" -.TH SSL_CTX_ADD_EXTRA_CHAIN_CERT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_ADD_EXTRA_CHAIN_CERT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_add_session.3ssl b/upstream/archlinux/man3/SSL_CTX_add_session.3ssl index a6c0fe2d..f19c6015 100644 --- a/upstream/archlinux/man3/SSL_CTX_add_session.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_add_session.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_ADD_SESSION 3ssl" -.TH SSL_CTX_ADD_SESSION 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_ADD_SESSION 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_config.3ssl b/upstream/archlinux/man3/SSL_CTX_config.3ssl index a565209d..fe67d197 100644 --- a/upstream/archlinux/man3/SSL_CTX_config.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_config.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_CONFIG 3ssl" -.TH SSL_CTX_CONFIG 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_CONFIG 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_ctrl.3ssl b/upstream/archlinux/man3/SSL_CTX_ctrl.3ssl index 0dc9b7ed..118ec9bc 100644 --- a/upstream/archlinux/man3/SSL_CTX_ctrl.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_ctrl.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_CTRL 3ssl" -.TH SSL_CTX_CTRL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_CTRL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_dane_enable.3ssl b/upstream/archlinux/man3/SSL_CTX_dane_enable.3ssl index d19d5cac..a6dc52ef 100644 --- a/upstream/archlinux/man3/SSL_CTX_dane_enable.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_dane_enable.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_DANE_ENABLE 3ssl" -.TH SSL_CTX_DANE_ENABLE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_DANE_ENABLE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_flush_sessions.3ssl b/upstream/archlinux/man3/SSL_CTX_flush_sessions.3ssl index 8e2b3485..f7fbacb4 100644 --- a/upstream/archlinux/man3/SSL_CTX_flush_sessions.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_flush_sessions.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_FLUSH_SESSIONS 3ssl" -.TH SSL_CTX_FLUSH_SESSIONS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_FLUSH_SESSIONS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_free.3ssl b/upstream/archlinux/man3/SSL_CTX_free.3ssl index 552c21af..f39f3921 100644 --- a/upstream/archlinux/man3/SSL_CTX_free.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_free.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_FREE 3ssl" -.TH SSL_CTX_FREE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_FREE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_get0_param.3ssl b/upstream/archlinux/man3/SSL_CTX_get0_param.3ssl index bbbd66dd..191a289c 100644 --- a/upstream/archlinux/man3/SSL_CTX_get0_param.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_get0_param.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_GET0_PARAM 3ssl" -.TH SSL_CTX_GET0_PARAM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_GET0_PARAM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_get_verify_mode.3ssl b/upstream/archlinux/man3/SSL_CTX_get_verify_mode.3ssl index 17b449cd..ee6aceef 100644 --- a/upstream/archlinux/man3/SSL_CTX_get_verify_mode.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_get_verify_mode.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_GET_VERIFY_MODE 3ssl" -.TH SSL_CTX_GET_VERIFY_MODE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_GET_VERIFY_MODE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_has_client_custom_ext.3ssl b/upstream/archlinux/man3/SSL_CTX_has_client_custom_ext.3ssl index 0ebffea6..78198b22 100644 --- a/upstream/archlinux/man3/SSL_CTX_has_client_custom_ext.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_has_client_custom_ext.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_HAS_CLIENT_CUSTOM_EXT 3ssl" -.TH SSL_CTX_HAS_CLIENT_CUSTOM_EXT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_HAS_CLIENT_CUSTOM_EXT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_load_verify_locations.3ssl b/upstream/archlinux/man3/SSL_CTX_load_verify_locations.3ssl index 518824cc..3f3c19c2 100644 --- a/upstream/archlinux/man3/SSL_CTX_load_verify_locations.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_load_verify_locations.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_LOAD_VERIFY_LOCATIONS 3ssl" -.TH SSL_CTX_LOAD_VERIFY_LOCATIONS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_LOAD_VERIFY_LOCATIONS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_new.3ssl b/upstream/archlinux/man3/SSL_CTX_new.3ssl index 98c4b979..f62e3298 100644 --- a/upstream/archlinux/man3/SSL_CTX_new.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_NEW 3ssl" -.TH SSL_CTX_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_sess_number.3ssl b/upstream/archlinux/man3/SSL_CTX_sess_number.3ssl index 6e487fb9..d609e00a 100644 --- a/upstream/archlinux/man3/SSL_CTX_sess_number.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_sess_number.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SESS_NUMBER 3ssl" -.TH SSL_CTX_SESS_NUMBER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SESS_NUMBER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_sess_set_cache_size.3ssl b/upstream/archlinux/man3/SSL_CTX_sess_set_cache_size.3ssl index 0ed4ed80..643759ea 100644 --- a/upstream/archlinux/man3/SSL_CTX_sess_set_cache_size.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_sess_set_cache_size.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SESS_SET_CACHE_SIZE 3ssl" -.TH SSL_CTX_SESS_SET_CACHE_SIZE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SESS_SET_CACHE_SIZE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_sess_set_get_cb.3ssl b/upstream/archlinux/man3/SSL_CTX_sess_set_get_cb.3ssl index 1c4cc0bd..8ec1d6b3 100644 --- a/upstream/archlinux/man3/SSL_CTX_sess_set_get_cb.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_sess_set_get_cb.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SESS_SET_GET_CB 3ssl" -.TH SSL_CTX_SESS_SET_GET_CB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SESS_SET_GET_CB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_sessions.3ssl b/upstream/archlinux/man3/SSL_CTX_sessions.3ssl index 56d32a88..7b603159 100644 --- a/upstream/archlinux/man3/SSL_CTX_sessions.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_sessions.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SESSIONS 3ssl" -.TH SSL_CTX_SESSIONS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SESSIONS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set0_CA_list.3ssl b/upstream/archlinux/man3/SSL_CTX_set0_CA_list.3ssl index 9c34b77c..f730f165 100644 --- a/upstream/archlinux/man3/SSL_CTX_set0_CA_list.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set0_CA_list.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET0_CA_LIST 3ssl" -.TH SSL_CTX_SET0_CA_LIST 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET0_CA_LIST 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set1_cert_comp_preference.3ssl b/upstream/archlinux/man3/SSL_CTX_set1_cert_comp_preference.3ssl index 7d2167ec..49424b2e 100644 --- a/upstream/archlinux/man3/SSL_CTX_set1_cert_comp_preference.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set1_cert_comp_preference.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET1_CERT_COMP_PREFERENCE 3ssl" -.TH SSL_CTX_SET1_CERT_COMP_PREFERENCE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET1_CERT_COMP_PREFERENCE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set1_curves.3ssl b/upstream/archlinux/man3/SSL_CTX_set1_curves.3ssl index cc8ac447..aa48eb0e 100644 --- a/upstream/archlinux/man3/SSL_CTX_set1_curves.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set1_curves.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET1_CURVES 3ssl" -.TH SSL_CTX_SET1_CURVES 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET1_CURVES 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -117,7 +117,8 @@ string \fBlist\fR. The string is a colon separated list of group names, for exam are \fBP\-256\fR, \fBP\-384\fR, \fBP\-521\fR, \fBX25519\fR, \fBX448\fR, \fBbrainpoolP256r1tls13\fR, \&\fBbrainpoolP384r1tls13\fR, \fBbrainpoolP512r1tls13\fR, \fBffdhe2048\fR, \fBffdhe3072\fR, \&\fBffdhe4096\fR, \fBffdhe6144\fR and \fBffdhe8192\fR. Support for other groups may be -added by external providers. +added by external providers. If a group name is preceded with the \f(CW\*(C`?\*(C'\fR +character, it will be ignored if an implementation is missing. .PP \&\fBSSL_set1_groups()\fR and \fBSSL_set1_groups_list()\fR are similar except they set supported groups for the SSL structure \fBssl\fR. @@ -196,9 +197,12 @@ key exchange, or NID_undef if there was no negotiated group. The curve functions were added in OpenSSL 1.0.2. The equivalent group functions were added in OpenSSL 1.1.1. The \fBSSL_get_negotiated_group()\fR function was added in OpenSSL 3.0.0. +.PP +Support for ignoring unknown groups in \fBSSL_CTX_set1_groups_list()\fR and +\&\fBSSL_set1_groups_list()\fR was added in OpenSSL 3.3. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2013\-2022 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2013\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/SSL_CTX_set1_sigalgs.3ssl b/upstream/archlinux/man3/SSL_CTX_set1_sigalgs.3ssl index 61c49bfc..9186e9cd 100644 --- a/upstream/archlinux/man3/SSL_CTX_set1_sigalgs.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set1_sigalgs.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET1_SIGALGS 3ssl" -.TH SSL_CTX_SET1_SIGALGS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET1_SIGALGS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -92,7 +92,8 @@ signature algorithms for \fBctx\fR or \fBssl\fR. The \fBstr\fR parameter must be a null terminated string consisting of a colon separated list of elements, where each element is either a combination of a public key algorithm and a digest separated by \fB+\fR, or a TLS 1.3\-style named -SignatureScheme such as rsa_pss_pss_sha256. +SignatureScheme such as rsa_pss_pss_sha256. If a list entry is preceded +with the \f(CW\*(C`?\*(C'\fR character, it will be ignored if an implementation is missing. .PP \&\fBSSL_CTX_set1_client_sigalgs()\fR, \fBSSL_set1_client_sigalgs()\fR, \&\fBSSL_CTX_set1_client_sigalgs_list()\fR and \fBSSL_set1_client_sigalgs_list()\fR set @@ -164,9 +165,15 @@ using a string: .IX Header "SEE ALSO" \&\fBssl\fR\|(7), \fBSSL_get_shared_sigalgs\fR\|(3), \&\fBSSL_CONF_CTX_new\fR\|(3) +.SH HISTORY +.IX Header "HISTORY" +Support for ignoring unknown signature algorithms in +\&\fBSSL_CTX_set1_sigalgs_list()\fR, \fBSSL_set1_sigalgs_list()\fR, +\&\fBSSL_CTX_set1_client_sigalgs_list()\fR and \fBSSL_set1_client_sigalgs_list()\fR +was added in OpenSSL 3.3. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2015\-2018 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2015\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/SSL_CTX_set1_verify_cert_store.3ssl b/upstream/archlinux/man3/SSL_CTX_set1_verify_cert_store.3ssl index 56d443d3..de968c3d 100644 --- a/upstream/archlinux/man3/SSL_CTX_set1_verify_cert_store.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set1_verify_cert_store.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET1_VERIFY_CERT_STORE 3ssl" -.TH SSL_CTX_SET1_VERIFY_CERT_STORE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET1_VERIFY_CERT_STORE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_alpn_select_cb.3ssl b/upstream/archlinux/man3/SSL_CTX_set_alpn_select_cb.3ssl index 4447eb09..b132cf3a 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_alpn_select_cb.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_alpn_select_cb.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_ALPN_SELECT_CB 3ssl" -.TH SSL_CTX_SET_ALPN_SELECT_CB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_ALPN_SELECT_CB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_cert_cb.3ssl b/upstream/archlinux/man3/SSL_CTX_set_cert_cb.3ssl index 40dfd3f1..89f3415b 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_cert_cb.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_cert_cb.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_CERT_CB 3ssl" -.TH SSL_CTX_SET_CERT_CB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_CERT_CB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_cert_store.3ssl b/upstream/archlinux/man3/SSL_CTX_set_cert_store.3ssl index 9099293b..ad6086dd 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_cert_store.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_cert_store.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_CERT_STORE 3ssl" -.TH SSL_CTX_SET_CERT_STORE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_CERT_STORE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_cert_verify_callback.3ssl b/upstream/archlinux/man3/SSL_CTX_set_cert_verify_callback.3ssl index 1fe5f2dc..f66664c5 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_cert_verify_callback.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_cert_verify_callback.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_CERT_VERIFY_CALLBACK 3ssl" -.TH SSL_CTX_SET_CERT_VERIFY_CALLBACK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_CERT_VERIFY_CALLBACK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_cipher_list.3ssl b/upstream/archlinux/man3/SSL_CTX_set_cipher_list.3ssl index 72ae2c55..5a4c462a 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_cipher_list.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_cipher_list.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_CIPHER_LIST 3ssl" -.TH SSL_CTX_SET_CIPHER_LIST 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_CIPHER_LIST 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_client_cert_cb.3ssl b/upstream/archlinux/man3/SSL_CTX_set_client_cert_cb.3ssl index 3da660e2..e9d2cc53 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_client_cert_cb.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_client_cert_cb.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_CLIENT_CERT_CB 3ssl" -.TH SSL_CTX_SET_CLIENT_CERT_CB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_CLIENT_CERT_CB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_client_hello_cb.3ssl b/upstream/archlinux/man3/SSL_CTX_set_client_hello_cb.3ssl index e32dd3e9..c2581e26 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_client_hello_cb.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_client_hello_cb.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_CLIENT_HELLO_CB 3ssl" -.TH SSL_CTX_SET_CLIENT_HELLO_CB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_CLIENT_HELLO_CB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_ct_validation_callback.3ssl b/upstream/archlinux/man3/SSL_CTX_set_ct_validation_callback.3ssl index 2ac6950a..a859df20 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_ct_validation_callback.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_ct_validation_callback.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_CT_VALIDATION_CALLBACK 3ssl" -.TH SSL_CTX_SET_CT_VALIDATION_CALLBACK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_CT_VALIDATION_CALLBACK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_ctlog_list_file.3ssl b/upstream/archlinux/man3/SSL_CTX_set_ctlog_list_file.3ssl index efaf58fe..f709ee61 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_ctlog_list_file.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_ctlog_list_file.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_CTLOG_LIST_FILE 3ssl" -.TH SSL_CTX_SET_CTLOG_LIST_FILE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_CTLOG_LIST_FILE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_default_passwd_cb.3ssl b/upstream/archlinux/man3/SSL_CTX_set_default_passwd_cb.3ssl index cf18c256..466b5e91 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_default_passwd_cb.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_default_passwd_cb.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_DEFAULT_PASSWD_CB 3ssl" -.TH SSL_CTX_SET_DEFAULT_PASSWD_CB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_DEFAULT_PASSWD_CB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_generate_session_id.3ssl b/upstream/archlinux/man3/SSL_CTX_set_generate_session_id.3ssl index 19dd9abd..1dafee64 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_generate_session_id.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_generate_session_id.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_GENERATE_SESSION_ID 3ssl" -.TH SSL_CTX_SET_GENERATE_SESSION_ID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_GENERATE_SESSION_ID 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_info_callback.3ssl b/upstream/archlinux/man3/SSL_CTX_set_info_callback.3ssl index d81d7840..3174d1e8 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_info_callback.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_info_callback.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_INFO_CALLBACK 3ssl" -.TH SSL_CTX_SET_INFO_CALLBACK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_INFO_CALLBACK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -207,7 +207,7 @@ about alerts being handled and error messages to the \fBbio_err\fR BIO. \&\fBSSL_alert_type_string\fR\|(3) .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2001\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2001\-2020 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/SSL_CTX_set_keylog_callback.3ssl b/upstream/archlinux/man3/SSL_CTX_set_keylog_callback.3ssl index e7f61744..01329b5b 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_keylog_callback.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_keylog_callback.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_KEYLOG_CALLBACK 3ssl" -.TH SSL_CTX_SET_KEYLOG_CALLBACK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_KEYLOG_CALLBACK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_max_cert_list.3ssl b/upstream/archlinux/man3/SSL_CTX_set_max_cert_list.3ssl index 487efd44..68d323fb 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_max_cert_list.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_max_cert_list.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_MAX_CERT_LIST 3ssl" -.TH SSL_CTX_SET_MAX_CERT_LIST 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_MAX_CERT_LIST 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_min_proto_version.3ssl b/upstream/archlinux/man3/SSL_CTX_set_min_proto_version.3ssl index 6d745446..e8ff4d9d 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_min_proto_version.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_min_proto_version.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_MIN_PROTO_VERSION 3ssl" -.TH SSL_CTX_SET_MIN_PROTO_VERSION 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_MIN_PROTO_VERSION 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_mode.3ssl b/upstream/archlinux/man3/SSL_CTX_set_mode.3ssl index 67c8812c..73d0f236 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_mode.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_mode.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_MODE 3ssl" -.TH SSL_CTX_SET_MODE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_MODE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_msg_callback.3ssl b/upstream/archlinux/man3/SSL_CTX_set_msg_callback.3ssl index 82cd4acd..df7ae5c0 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_msg_callback.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_msg_callback.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_MSG_CALLBACK 3ssl" -.TH SSL_CTX_SET_MSG_CALLBACK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_MSG_CALLBACK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_num_tickets.3ssl b/upstream/archlinux/man3/SSL_CTX_set_num_tickets.3ssl index cd4c7aa4..2354d55d 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_num_tickets.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_num_tickets.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_NUM_TICKETS 3ssl" -.TH SSL_CTX_SET_NUM_TICKETS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_NUM_TICKETS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_options.3ssl b/upstream/archlinux/man3/SSL_CTX_set_options.3ssl index adea226f..2341ccbb 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_options.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_options.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_OPTIONS 3ssl" -.TH SSL_CTX_SET_OPTIONS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_OPTIONS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -154,6 +154,11 @@ this option to enable it. .IX Item "SSL_OP_ALLOW_NO_DHE_KEX" In TLSv1.3 allow a non\-(ec)dhe based key exchange mode on resumption. This means that there will be no forward secrecy for the resumed session. +.IP SSL_OP_PREFER_NO_DHE_KEX 4 +.IX Item "SSL_OP_PREFER_NO_DHE_KEX" +In TLSv1.3, on resumption let the server prefer a non\-(ec)dhe based key +exchange mode over an (ec)dhe based one. Ignored without \fBSSL_OP_ALLOW_NO_DHE_KEX\fR +being set as well. Always ignored on the client. .IP SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 4 .IX Item "SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION" Allow legacy insecure renegotiation between OpenSSL and unpatched clients or diff --git a/upstream/archlinux/man3/SSL_CTX_set_psk_client_callback.3ssl b/upstream/archlinux/man3/SSL_CTX_set_psk_client_callback.3ssl index 14971f15..2c6d6633 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_psk_client_callback.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_psk_client_callback.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_PSK_CLIENT_CALLBACK 3ssl" -.TH SSL_CTX_SET_PSK_CLIENT_CALLBACK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_PSK_CLIENT_CALLBACK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_quiet_shutdown.3ssl b/upstream/archlinux/man3/SSL_CTX_set_quiet_shutdown.3ssl index cc4e71b1..b2b1e57c 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_quiet_shutdown.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_quiet_shutdown.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_QUIET_SHUTDOWN 3ssl" -.TH SSL_CTX_SET_QUIET_SHUTDOWN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_QUIET_SHUTDOWN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_read_ahead.3ssl b/upstream/archlinux/man3/SSL_CTX_set_read_ahead.3ssl index b6980c89..3ee193cf 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_read_ahead.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_read_ahead.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_READ_AHEAD 3ssl" -.TH SSL_CTX_SET_READ_AHEAD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_READ_AHEAD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_record_padding_callback.3ssl b/upstream/archlinux/man3/SSL_CTX_set_record_padding_callback.3ssl index 315188a0..c958645f 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_record_padding_callback.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_record_padding_callback.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_RECORD_PADDING_CALLBACK 3ssl" -.TH SSL_CTX_SET_RECORD_PADDING_CALLBACK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_RECORD_PADDING_CALLBACK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_security_level.3ssl b/upstream/archlinux/man3/SSL_CTX_set_security_level.3ssl index ce5371a9..86865996 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_security_level.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_security_level.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_SECURITY_LEVEL 3ssl" -.TH SSL_CTX_SET_SECURITY_LEVEL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_SECURITY_LEVEL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_session_cache_mode.3ssl b/upstream/archlinux/man3/SSL_CTX_set_session_cache_mode.3ssl index 309d4a0b..584de560 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_session_cache_mode.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_session_cache_mode.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_SESSION_CACHE_MODE 3ssl" -.TH SSL_CTX_SET_SESSION_CACHE_MODE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_SESSION_CACHE_MODE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_session_id_context.3ssl b/upstream/archlinux/man3/SSL_CTX_set_session_id_context.3ssl index e9797fc7..f744bc87 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_session_id_context.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_session_id_context.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_SESSION_ID_CONTEXT 3ssl" -.TH SSL_CTX_SET_SESSION_ID_CONTEXT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_SESSION_ID_CONTEXT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_session_ticket_cb.3ssl b/upstream/archlinux/man3/SSL_CTX_set_session_ticket_cb.3ssl index d6209e26..ea7b36cb 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_session_ticket_cb.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_session_ticket_cb.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_SESSION_TICKET_CB 3ssl" -.TH SSL_CTX_SET_SESSION_TICKET_CB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_SESSION_TICKET_CB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_split_send_fragment.3ssl b/upstream/archlinux/man3/SSL_CTX_set_split_send_fragment.3ssl index a9ddc3bb..2c95dc91 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_split_send_fragment.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_split_send_fragment.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_SPLIT_SEND_FRAGMENT 3ssl" -.TH SSL_CTX_SET_SPLIT_SEND_FRAGMENT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_SPLIT_SEND_FRAGMENT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_srp_password.3ssl b/upstream/archlinux/man3/SSL_CTX_set_srp_password.3ssl index f37b67db..2236c923 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_srp_password.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_srp_password.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_SRP_PASSWORD 3ssl" -.TH SSL_CTX_SET_SRP_PASSWORD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_SRP_PASSWORD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_ssl_version.3ssl b/upstream/archlinux/man3/SSL_CTX_set_ssl_version.3ssl index 6e4315c9..93066c44 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_ssl_version.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_ssl_version.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_SSL_VERSION 3ssl" -.TH SSL_CTX_SET_SSL_VERSION 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_SSL_VERSION 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_stateless_cookie_generate_cb.3ssl b/upstream/archlinux/man3/SSL_CTX_set_stateless_cookie_generate_cb.3ssl index 53dd1f20..ad1772b6 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_stateless_cookie_generate_cb.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_stateless_cookie_generate_cb.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_STATELESS_COOKIE_GENERATE_CB 3ssl" -.TH SSL_CTX_SET_STATELESS_COOKIE_GENERATE_CB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_STATELESS_COOKIE_GENERATE_CB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_timeout.3ssl b/upstream/archlinux/man3/SSL_CTX_set_timeout.3ssl index 2456a3fc..d612418e 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_timeout.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_timeout.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_TIMEOUT 3ssl" -.TH SSL_CTX_SET_TIMEOUT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_TIMEOUT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_tlsext_servername_callback.3ssl b/upstream/archlinux/man3/SSL_CTX_set_tlsext_servername_callback.3ssl index 9643190e..851558a6 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_tlsext_servername_callback.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_tlsext_servername_callback.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_TLSEXT_SERVERNAME_CALLBACK 3ssl" -.TH SSL_CTX_SET_TLSEXT_SERVERNAME_CALLBACK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_TLSEXT_SERVERNAME_CALLBACK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_tlsext_status_cb.3ssl b/upstream/archlinux/man3/SSL_CTX_set_tlsext_status_cb.3ssl index 399e50b6..105c4daa 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_tlsext_status_cb.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_tlsext_status_cb.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_TLSEXT_STATUS_CB 3ssl" -.TH SSL_CTX_SET_TLSEXT_STATUS_CB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_TLSEXT_STATUS_CB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_tlsext_ticket_key_cb.3ssl b/upstream/archlinux/man3/SSL_CTX_set_tlsext_ticket_key_cb.3ssl index 6980e4ff..f9c3a069 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_tlsext_ticket_key_cb.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_tlsext_ticket_key_cb.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_TLSEXT_TICKET_KEY_CB 3ssl" -.TH SSL_CTX_SET_TLSEXT_TICKET_KEY_CB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_TLSEXT_TICKET_KEY_CB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_tlsext_use_srtp.3ssl b/upstream/archlinux/man3/SSL_CTX_set_tlsext_use_srtp.3ssl index 015216e4..146e8f0a 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_tlsext_use_srtp.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_tlsext_use_srtp.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_TLSEXT_USE_SRTP 3ssl" -.TH SSL_CTX_SET_TLSEXT_USE_SRTP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_TLSEXT_USE_SRTP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_tmp_dh_callback.3ssl b/upstream/archlinux/man3/SSL_CTX_set_tmp_dh_callback.3ssl index fb17e0c4..90825a45 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_tmp_dh_callback.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_tmp_dh_callback.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_TMP_DH_CALLBACK 3ssl" -.TH SSL_CTX_SET_TMP_DH_CALLBACK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_TMP_DH_CALLBACK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_tmp_ecdh.3ssl b/upstream/archlinux/man3/SSL_CTX_set_tmp_ecdh.3ssl index 49be5f1e..3e43ac9b 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_tmp_ecdh.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_tmp_ecdh.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_TMP_ECDH 3ssl" -.TH SSL_CTX_SET_TMP_ECDH 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_TMP_ECDH 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_set_verify.3ssl b/upstream/archlinux/man3/SSL_CTX_set_verify.3ssl index a545e767..12bff4fd 100644 --- a/upstream/archlinux/man3/SSL_CTX_set_verify.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_set_verify.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SET_VERIFY 3ssl" -.TH SSL_CTX_SET_VERIFY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_SET_VERIFY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_use_certificate.3ssl b/upstream/archlinux/man3/SSL_CTX_use_certificate.3ssl index 51e0e671..b766f988 100644 --- a/upstream/archlinux/man3/SSL_CTX_use_certificate.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_use_certificate.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_USE_CERTIFICATE 3ssl" -.TH SSL_CTX_USE_CERTIFICATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_USE_CERTIFICATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_use_psk_identity_hint.3ssl b/upstream/archlinux/man3/SSL_CTX_use_psk_identity_hint.3ssl index 92765ece..ed12eddf 100644 --- a/upstream/archlinux/man3/SSL_CTX_use_psk_identity_hint.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_use_psk_identity_hint.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_USE_PSK_IDENTITY_HINT 3ssl" -.TH SSL_CTX_USE_PSK_IDENTITY_HINT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_USE_PSK_IDENTITY_HINT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_CTX_use_serverinfo.3ssl b/upstream/archlinux/man3/SSL_CTX_use_serverinfo.3ssl index 06c76dc7..efe960a5 100644 --- a/upstream/archlinux/man3/SSL_CTX_use_serverinfo.3ssl +++ b/upstream/archlinux/man3/SSL_CTX_use_serverinfo.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_USE_SERVERINFO 3ssl" -.TH SSL_CTX_USE_SERVERINFO 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CTX_USE_SERVERINFO 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_SESSION_free.3ssl b/upstream/archlinux/man3/SSL_SESSION_free.3ssl index 6a50a2e9..5e59147b 100644 --- a/upstream/archlinux/man3/SSL_SESSION_free.3ssl +++ b/upstream/archlinux/man3/SSL_SESSION_free.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SESSION_FREE 3ssl" -.TH SSL_SESSION_FREE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SESSION_FREE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_SESSION_get0_cipher.3ssl b/upstream/archlinux/man3/SSL_SESSION_get0_cipher.3ssl index af339e82..b4de42f5 100644 --- a/upstream/archlinux/man3/SSL_SESSION_get0_cipher.3ssl +++ b/upstream/archlinux/man3/SSL_SESSION_get0_cipher.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SESSION_GET0_CIPHER 3ssl" -.TH SSL_SESSION_GET0_CIPHER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SESSION_GET0_CIPHER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_SESSION_get0_hostname.3ssl b/upstream/archlinux/man3/SSL_SESSION_get0_hostname.3ssl index c2ac9e12..3d782a9d 100644 --- a/upstream/archlinux/man3/SSL_SESSION_get0_hostname.3ssl +++ b/upstream/archlinux/man3/SSL_SESSION_get0_hostname.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SESSION_GET0_HOSTNAME 3ssl" -.TH SSL_SESSION_GET0_HOSTNAME 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SESSION_GET0_HOSTNAME 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_SESSION_get0_id_context.3ssl b/upstream/archlinux/man3/SSL_SESSION_get0_id_context.3ssl index 61084e9b..595dd2ce 100644 --- a/upstream/archlinux/man3/SSL_SESSION_get0_id_context.3ssl +++ b/upstream/archlinux/man3/SSL_SESSION_get0_id_context.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SESSION_GET0_ID_CONTEXT 3ssl" -.TH SSL_SESSION_GET0_ID_CONTEXT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SESSION_GET0_ID_CONTEXT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_SESSION_get0_peer.3ssl b/upstream/archlinux/man3/SSL_SESSION_get0_peer.3ssl index beb7f122..37c8cea1 100644 --- a/upstream/archlinux/man3/SSL_SESSION_get0_peer.3ssl +++ b/upstream/archlinux/man3/SSL_SESSION_get0_peer.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SESSION_GET0_PEER 3ssl" -.TH SSL_SESSION_GET0_PEER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SESSION_GET0_PEER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_SESSION_get_compress_id.3ssl b/upstream/archlinux/man3/SSL_SESSION_get_compress_id.3ssl index 60553d44..596755a2 100644 --- a/upstream/archlinux/man3/SSL_SESSION_get_compress_id.3ssl +++ b/upstream/archlinux/man3/SSL_SESSION_get_compress_id.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SESSION_GET_COMPRESS_ID 3ssl" -.TH SSL_SESSION_GET_COMPRESS_ID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SESSION_GET_COMPRESS_ID 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_SESSION_get_protocol_version.3ssl b/upstream/archlinux/man3/SSL_SESSION_get_protocol_version.3ssl index 2be1b043..ff65a815 100644 --- a/upstream/archlinux/man3/SSL_SESSION_get_protocol_version.3ssl +++ b/upstream/archlinux/man3/SSL_SESSION_get_protocol_version.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SESSION_GET_PROTOCOL_VERSION 3ssl" -.TH SSL_SESSION_GET_PROTOCOL_VERSION 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SESSION_GET_PROTOCOL_VERSION 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_SESSION_get_time.3ssl b/upstream/archlinux/man3/SSL_SESSION_get_time.3ssl index 88f430b0..f4b71ea2 100644 --- a/upstream/archlinux/man3/SSL_SESSION_get_time.3ssl +++ b/upstream/archlinux/man3/SSL_SESSION_get_time.3ssl @@ -55,14 +55,14 @@ .\" ======================================================================== .\" .IX Title "SSL_SESSION_GET_TIME 3ssl" -.TH SSL_SESSION_GET_TIME 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SESSION_GET_TIME 3ssl 2024-04-28 3.3.0 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 SSL_SESSION_get_time, SSL_SESSION_set_time, SSL_SESSION_get_timeout, -SSL_SESSION_set_timeout, +SSL_SESSION_set_timeout, SSL_SESSION_get_time_ex, SSL_SESSION_set_time_ex, SSL_get_time, SSL_set_time, SSL_get_timeout, SSL_set_timeout \&\- retrieve and manipulate session time and timeout settings .SH SYNOPSIS @@ -79,6 +79,9 @@ SSL_get_time, SSL_set_time, SSL_get_timeout, SSL_set_timeout \& long SSL_set_time(SSL_SESSION *s, long tm); \& long SSL_get_timeout(const SSL_SESSION *s); \& long SSL_set_timeout(SSL_SESSION *s, long tm); +\& +\& time_t SSL_SESSION_get_time_ex(const SSL_SESSION *s); +\& time_t SSL_SESSION_set_time_ex(SSL_SESSION *s, time_t tm); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" @@ -95,6 +98,10 @@ in seconds. \&\fBSSL_SESSION_set_timeout()\fR sets the timeout value for session \fBs\fR in seconds to \fBtm\fR. .PP +\&\fBSSL_SESSION_get_time_ex()\fR and \fBSSL_SESSION_set_time_ex()\fR extended functions use +the time_t datatype instead of long to fix the Y2038 problem on systems with +64 bit time_t type. +.PP The \fBSSL_get_time()\fR, \fBSSL_set_time()\fR, \fBSSL_get_timeout()\fR, and \fBSSL_set_timeout()\fR functions are synonyms for the SSL_SESSION_*() counterparts. .SH NOTES @@ -114,6 +121,11 @@ valid values. .PP If any of the function is passed the NULL pointer for the session \fBs\fR, 0 is returned. +.SH BUGS +.IX Header "BUGS" +The data type long is typically 32 bits on many systems, hence the old +functions \fBSSL_SESSION_get_time()\fR and \fBSSL_SESSION_set_time()\fR are not always +Y2038 safe. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBssl\fR\|(7), @@ -121,7 +133,7 @@ If any of the function is passed the NULL pointer for the session \fBs\fR, \&\fBSSL_get_default_timeout\fR\|(3) .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2001\-2016 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2001\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/SSL_SESSION_has_ticket.3ssl b/upstream/archlinux/man3/SSL_SESSION_has_ticket.3ssl index cef608cf..11c15ce8 100644 --- a/upstream/archlinux/man3/SSL_SESSION_has_ticket.3ssl +++ b/upstream/archlinux/man3/SSL_SESSION_has_ticket.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SESSION_HAS_TICKET 3ssl" -.TH SSL_SESSION_HAS_TICKET 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SESSION_HAS_TICKET 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_SESSION_is_resumable.3ssl b/upstream/archlinux/man3/SSL_SESSION_is_resumable.3ssl index 8da13b82..75d65c6f 100644 --- a/upstream/archlinux/man3/SSL_SESSION_is_resumable.3ssl +++ b/upstream/archlinux/man3/SSL_SESSION_is_resumable.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SESSION_IS_RESUMABLE 3ssl" -.TH SSL_SESSION_IS_RESUMABLE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SESSION_IS_RESUMABLE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_SESSION_print.3ssl b/upstream/archlinux/man3/SSL_SESSION_print.3ssl index 1797252e..a0667e13 100644 --- a/upstream/archlinux/man3/SSL_SESSION_print.3ssl +++ b/upstream/archlinux/man3/SSL_SESSION_print.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SESSION_PRINT 3ssl" -.TH SSL_SESSION_PRINT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SESSION_PRINT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_SESSION_set1_id.3ssl b/upstream/archlinux/man3/SSL_SESSION_set1_id.3ssl index 4e77c7e6..2cff9bc3 100644 --- a/upstream/archlinux/man3/SSL_SESSION_set1_id.3ssl +++ b/upstream/archlinux/man3/SSL_SESSION_set1_id.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SESSION_SET1_ID 3ssl" -.TH SSL_SESSION_SET1_ID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SESSION_SET1_ID 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_accept.3ssl b/upstream/archlinux/man3/SSL_accept.3ssl index f4226caa..eb0759df 100644 --- a/upstream/archlinux/man3/SSL_accept.3ssl +++ b/upstream/archlinux/man3/SSL_accept.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_ACCEPT 3ssl" -.TH SSL_ACCEPT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_ACCEPT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_accept_stream.3ssl b/upstream/archlinux/man3/SSL_accept_stream.3ssl index cc2e807a..abc02e15 100644 --- a/upstream/archlinux/man3/SSL_accept_stream.3ssl +++ b/upstream/archlinux/man3/SSL_accept_stream.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_ACCEPT_STREAM 3ssl" -.TH SSL_ACCEPT_STREAM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_ACCEPT_STREAM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_alert_type_string.3ssl b/upstream/archlinux/man3/SSL_alert_type_string.3ssl index 27dd1255..7dd61d6a 100644 --- a/upstream/archlinux/man3/SSL_alert_type_string.3ssl +++ b/upstream/archlinux/man3/SSL_alert_type_string.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_ALERT_TYPE_STRING 3ssl" -.TH SSL_ALERT_TYPE_STRING 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_ALERT_TYPE_STRING 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_alloc_buffers.3ssl b/upstream/archlinux/man3/SSL_alloc_buffers.3ssl index 099e75e3..2fa8f9a7 100644 --- a/upstream/archlinux/man3/SSL_alloc_buffers.3ssl +++ b/upstream/archlinux/man3/SSL_alloc_buffers.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_ALLOC_BUFFERS 3ssl" -.TH SSL_ALLOC_BUFFERS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_ALLOC_BUFFERS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_check_chain.3ssl b/upstream/archlinux/man3/SSL_check_chain.3ssl index dc065277..c06f0205 100644 --- a/upstream/archlinux/man3/SSL_check_chain.3ssl +++ b/upstream/archlinux/man3/SSL_check_chain.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CHECK_CHAIN 3ssl" -.TH SSL_CHECK_CHAIN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CHECK_CHAIN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_clear.3ssl b/upstream/archlinux/man3/SSL_clear.3ssl index 7317f33a..e49395a2 100644 --- a/upstream/archlinux/man3/SSL_clear.3ssl +++ b/upstream/archlinux/man3/SSL_clear.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CLEAR 3ssl" -.TH SSL_CLEAR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CLEAR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_connect.3ssl b/upstream/archlinux/man3/SSL_connect.3ssl index 44b365b6..b8687583 100644 --- a/upstream/archlinux/man3/SSL_connect.3ssl +++ b/upstream/archlinux/man3/SSL_connect.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CONNECT 3ssl" -.TH SSL_CONNECT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_CONNECT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_do_handshake.3ssl b/upstream/archlinux/man3/SSL_do_handshake.3ssl index 3c404def..00409488 100644 --- a/upstream/archlinux/man3/SSL_do_handshake.3ssl +++ b/upstream/archlinux/man3/SSL_do_handshake.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_DO_HANDSHAKE 3ssl" -.TH SSL_DO_HANDSHAKE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_DO_HANDSHAKE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_export_keying_material.3ssl b/upstream/archlinux/man3/SSL_export_keying_material.3ssl index d1c4be3b..0c1c0a3a 100644 --- a/upstream/archlinux/man3/SSL_export_keying_material.3ssl +++ b/upstream/archlinux/man3/SSL_export_keying_material.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_EXPORT_KEYING_MATERIAL 3ssl" -.TH SSL_EXPORT_KEYING_MATERIAL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_EXPORT_KEYING_MATERIAL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_extension_supported.3ssl b/upstream/archlinux/man3/SSL_extension_supported.3ssl index 7d119b60..a878de12 100644 --- a/upstream/archlinux/man3/SSL_extension_supported.3ssl +++ b/upstream/archlinux/man3/SSL_extension_supported.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_EXTENSION_SUPPORTED 3ssl" -.TH SSL_EXTENSION_SUPPORTED 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_EXTENSION_SUPPORTED 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_free.3ssl b/upstream/archlinux/man3/SSL_free.3ssl index 22b59690..4eb3fb6f 100644 --- a/upstream/archlinux/man3/SSL_free.3ssl +++ b/upstream/archlinux/man3/SSL_free.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_FREE 3ssl" -.TH SSL_FREE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_FREE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get0_connection.3ssl b/upstream/archlinux/man3/SSL_get0_connection.3ssl index 99a5810c..48f7242d 100644 --- a/upstream/archlinux/man3/SSL_get0_connection.3ssl +++ b/upstream/archlinux/man3/SSL_get0_connection.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET0_CONNECTION 3ssl" -.TH SSL_GET0_CONNECTION 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET0_CONNECTION 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get0_group_name.3ssl b/upstream/archlinux/man3/SSL_get0_group_name.3ssl index 615de7ea..52044d93 100644 --- a/upstream/archlinux/man3/SSL_get0_group_name.3ssl +++ b/upstream/archlinux/man3/SSL_get0_group_name.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET0_GROUP_NAME 3ssl" -.TH SSL_GET0_GROUP_NAME 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET0_GROUP_NAME 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get0_peer_rpk.3ssl b/upstream/archlinux/man3/SSL_get0_peer_rpk.3ssl index 5d183a4b..7d7b6848 100644 --- a/upstream/archlinux/man3/SSL_get0_peer_rpk.3ssl +++ b/upstream/archlinux/man3/SSL_get0_peer_rpk.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET0_PEER_RPK 3ssl" -.TH SSL_GET0_PEER_RPK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET0_PEER_RPK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get0_peer_scts.3ssl b/upstream/archlinux/man3/SSL_get0_peer_scts.3ssl index 62ab9a6b..b0abaab5 100644 --- a/upstream/archlinux/man3/SSL_get0_peer_scts.3ssl +++ b/upstream/archlinux/man3/SSL_get0_peer_scts.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET0_PEER_SCTS 3ssl" -.TH SSL_GET0_PEER_SCTS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET0_PEER_SCTS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_SSL_CTX.3ssl b/upstream/archlinux/man3/SSL_get_SSL_CTX.3ssl index 30a62b46..8c286fda 100644 --- a/upstream/archlinux/man3/SSL_get_SSL_CTX.3ssl +++ b/upstream/archlinux/man3/SSL_get_SSL_CTX.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_SSL_CTX 3ssl" -.TH SSL_GET_SSL_CTX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_SSL_CTX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_all_async_fds.3ssl b/upstream/archlinux/man3/SSL_get_all_async_fds.3ssl index 2cd12c95..caaabd8e 100644 --- a/upstream/archlinux/man3/SSL_get_all_async_fds.3ssl +++ b/upstream/archlinux/man3/SSL_get_all_async_fds.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_ALL_ASYNC_FDS 3ssl" -.TH SSL_GET_ALL_ASYNC_FDS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_ALL_ASYNC_FDS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_certificate.3ssl b/upstream/archlinux/man3/SSL_get_certificate.3ssl index f9fc4570..c0399f98 100644 --- a/upstream/archlinux/man3/SSL_get_certificate.3ssl +++ b/upstream/archlinux/man3/SSL_get_certificate.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_CERTIFICATE 3ssl" -.TH SSL_GET_CERTIFICATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_CERTIFICATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_ciphers.3ssl b/upstream/archlinux/man3/SSL_get_ciphers.3ssl index 3225b157..c98d8f2e 100644 --- a/upstream/archlinux/man3/SSL_get_ciphers.3ssl +++ b/upstream/archlinux/man3/SSL_get_ciphers.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_CIPHERS 3ssl" -.TH SSL_GET_CIPHERS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_CIPHERS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_client_random.3ssl b/upstream/archlinux/man3/SSL_get_client_random.3ssl index a627577f..f805eaf3 100644 --- a/upstream/archlinux/man3/SSL_get_client_random.3ssl +++ b/upstream/archlinux/man3/SSL_get_client_random.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_CLIENT_RANDOM 3ssl" -.TH SSL_GET_CLIENT_RANDOM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_CLIENT_RANDOM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_conn_close_info.3ssl b/upstream/archlinux/man3/SSL_get_conn_close_info.3ssl index 932df840..7980d5b1 100644 --- a/upstream/archlinux/man3/SSL_get_conn_close_info.3ssl +++ b/upstream/archlinux/man3/SSL_get_conn_close_info.3ssl @@ -55,15 +55,36 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_CONN_CLOSE_INFO 3ssl" -.TH SSL_GET_CONN_CLOSE_INFO 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_CONN_CLOSE_INFO 3ssl 2024-04-28 3.3.0 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 SSL_get_conn_close_info, SSL_CONN_CLOSE_FLAG_LOCAL, -SSL_CONN_CLOSE_FLAG_TRANSPORT \- get information about why a QUIC connection was -closed +SSL_CONN_CLOSE_FLAG_TRANSPORT, +OSSL_QUIC_ERR_NO_ERROR, +OSSL_QUIC_ERR_INTERNAL_ERROR, +OSSL_QUIC_ERR_CONNECTION_REFUSED, +OSSL_QUIC_ERR_FLOW_CONTROL_ERROR, +OSSL_QUIC_ERR_STREAM_LIMIT_ERROR, +OSSL_QUIC_ERR_STREAM_STATE_ERROR, +OSSL_QUIC_ERR_FINAL_SIZE_ERROR, +OSSL_QUIC_ERR_FRAME_ENCODING_ERROR, +OSSL_QUIC_ERR_TRANSPORT_PARAMETER_ERROR, +OSSL_QUIC_ERR_CONNECTION_ID_LIMIT_ERROR, +OSSL_QUIC_ERR_PROTOCOL_VIOLATION, +OSSL_QUIC_ERR_INVALID_TOKEN, +OSSL_QUIC_ERR_APPLICATION_ERROR, +OSSL_QUIC_ERR_CRYPTO_BUFFER_EXCEEDED, +OSSL_QUIC_ERR_KEY_UPDATE_ERROR, +OSSL_QUIC_ERR_AEAD_LIMIT_REACHED, +OSSL_QUIC_ERR_NO_VIABLE_PATH, +OSSL_QUIC_ERR_CRYPTO_ERR_BEGIN, +OSSL_QUIC_ERR_CRYPTO_ERR_END, +OSSL_QUIC_ERR_CRYPTO_ERR, +OSSL_QUIC_LOCAL_ERR_IDLE_TIMEOUT +\&\- get information about why a QUIC connection was closed .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 @@ -81,6 +102,32 @@ closed \& \& int SSL_get_conn_close_info(SSL *ssl, SSL_CONN_CLOSE_INFO *info, \& size_t info_len); +\& +\& #define OSSL_QUIC_ERR_NO_ERROR 0x00 +\& #define OSSL_QUIC_ERR_INTERNAL_ERROR 0x01 +\& #define OSSL_QUIC_ERR_CONNECTION_REFUSED 0x02 +\& #define OSSL_QUIC_ERR_FLOW_CONTROL_ERROR 0x03 +\& #define OSSL_QUIC_ERR_STREAM_LIMIT_ERROR 0x04 +\& #define OSSL_QUIC_ERR_STREAM_STATE_ERROR 0x05 +\& #define OSSL_QUIC_ERR_FINAL_SIZE_ERROR 0x06 +\& #define OSSL_QUIC_ERR_FRAME_ENCODING_ERROR 0x07 +\& #define OSSL_QUIC_ERR_TRANSPORT_PARAMETER_ERROR 0x08 +\& #define OSSL_QUIC_ERR_CONNECTION_ID_LIMIT_ERROR 0x09 +\& #define OSSL_QUIC_ERR_PROTOCOL_VIOLATION 0x0A +\& #define OSSL_QUIC_ERR_INVALID_TOKEN 0x0B +\& #define OSSL_QUIC_ERR_APPLICATION_ERROR 0x0C +\& #define OSSL_QUIC_ERR_CRYPTO_BUFFER_EXCEEDED 0x0D +\& #define OSSL_QUIC_ERR_KEY_UPDATE_ERROR 0x0E +\& #define OSSL_QUIC_ERR_AEAD_LIMIT_REACHED 0x0F +\& #define OSSL_QUIC_ERR_NO_VIABLE_PATH 0x10 +\& +\& /* Inclusive range for handshake\-specific errors. */ +\& #define OSSL_QUIC_ERR_CRYPTO_ERR_BEGIN 0x0100 +\& #define OSSL_QUIC_ERR_CRYPTO_ERR_END 0x01FF +\& +\& #define OSSL_QUIC_ERR_CRYPTO_ERR(X) +\& +\& #define OSSL_QUIC_LOCAL_ERR_IDLE_TIMEOUT .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" @@ -129,6 +176,23 @@ If unset, connection closure was remotely triggered. If \fIflags\fR has \fBSSL_CONN_CLOSE_FLAG_TRANSPORT\fR set, connection closure was triggered for QUIC protocol reasons. Otherwise, connection closure was triggered by the local or remote application. +.PP +The \fBOSSL_QUIC_ERR\fR macro definitions provide the QUIC transport error codes as +defined by RFC 9000. The \fBOSSL_QUIC_ERR_CRYPTO_ERR()\fR macro can be used to convert +a TLS alert code into a QUIC transport error code by mapping it into the range +reserved for such codes by RFC 9000. This range begins at +\&\fBOSSL_QUIC_ERR_CRYPTO_ERR_BEGIN\fR and ends at \fBOSSL_QUIC_ERR_CRYPTO_ERR_END\fR +inclusive. +.SH "NON-STANDARD TRANSPORT ERROR CODES" +.IX Header "NON-STANDARD TRANSPORT ERROR CODES" +Some conditions which can cause QUIC connection termination are not signalled on +the wire and therefore do not have standard error codes. OpenSSL indicates these +errors via \fBSSL_get_conn_close_info()\fR by setting \fBSSL_CONN_CLOSE_FLAG_TRANSPORT\fR +and using one of the following error values. These codes are specific to +OpenSSL, and cannot be sent over the wire, as they are above 2**62. +.IP \fBOSSL_QUIC_LOCAL_ERR_IDLE_TIMEOUT\fR 4 +.IX Item "OSSL_QUIC_LOCAL_ERR_IDLE_TIMEOUT" +The connection was terminated immediately due to the idle timeout expiring. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBSSL_get_conn_close_info()\fR returns 1 on success and 0 on failure. This function @@ -143,7 +207,7 @@ SSL object. This function was added in OpenSSL 3.2. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2002\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2002\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/SSL_get_current_cipher.3ssl b/upstream/archlinux/man3/SSL_get_current_cipher.3ssl index 5f158057..467d0846 100644 --- a/upstream/archlinux/man3/SSL_get_current_cipher.3ssl +++ b/upstream/archlinux/man3/SSL_get_current_cipher.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_CURRENT_CIPHER 3ssl" -.TH SSL_GET_CURRENT_CIPHER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_CURRENT_CIPHER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_default_timeout.3ssl b/upstream/archlinux/man3/SSL_get_default_timeout.3ssl index e6b1142c..e47c16b8 100644 --- a/upstream/archlinux/man3/SSL_get_default_timeout.3ssl +++ b/upstream/archlinux/man3/SSL_get_default_timeout.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_DEFAULT_TIMEOUT 3ssl" -.TH SSL_GET_DEFAULT_TIMEOUT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_DEFAULT_TIMEOUT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_error.3ssl b/upstream/archlinux/man3/SSL_get_error.3ssl index 89392cdf..f12569f9 100644 --- a/upstream/archlinux/man3/SSL_get_error.3ssl +++ b/upstream/archlinux/man3/SSL_get_error.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_ERROR 3ssl" -.TH SSL_GET_ERROR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_ERROR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_event_timeout.3ssl b/upstream/archlinux/man3/SSL_get_event_timeout.3ssl index e6421cb1..de357d17 100644 --- a/upstream/archlinux/man3/SSL_get_event_timeout.3ssl +++ b/upstream/archlinux/man3/SSL_get_event_timeout.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_EVENT_TIMEOUT 3ssl" -.TH SSL_GET_EVENT_TIMEOUT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_EVENT_TIMEOUT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_extms_support.3ssl b/upstream/archlinux/man3/SSL_get_extms_support.3ssl index 3c0af8c4..2bfd7132 100644 --- a/upstream/archlinux/man3/SSL_get_extms_support.3ssl +++ b/upstream/archlinux/man3/SSL_get_extms_support.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_EXTMS_SUPPORT 3ssl" -.TH SSL_GET_EXTMS_SUPPORT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_EXTMS_SUPPORT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_fd.3ssl b/upstream/archlinux/man3/SSL_get_fd.3ssl index ddf6fe04..67e2a35f 100644 --- a/upstream/archlinux/man3/SSL_get_fd.3ssl +++ b/upstream/archlinux/man3/SSL_get_fd.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_FD 3ssl" -.TH SSL_GET_FD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_FD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_handshake_rtt.3ssl b/upstream/archlinux/man3/SSL_get_handshake_rtt.3ssl index 86cddfb3..0e63eea0 100644 --- a/upstream/archlinux/man3/SSL_get_handshake_rtt.3ssl +++ b/upstream/archlinux/man3/SSL_get_handshake_rtt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_HANDSHAKE_RTT 3ssl" -.TH SSL_GET_HANDSHAKE_RTT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_HANDSHAKE_RTT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_peer_cert_chain.3ssl b/upstream/archlinux/man3/SSL_get_peer_cert_chain.3ssl index aceac2f7..9586895e 100644 --- a/upstream/archlinux/man3/SSL_get_peer_cert_chain.3ssl +++ b/upstream/archlinux/man3/SSL_get_peer_cert_chain.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_PEER_CERT_CHAIN 3ssl" -.TH SSL_GET_PEER_CERT_CHAIN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_PEER_CERT_CHAIN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_peer_certificate.3ssl b/upstream/archlinux/man3/SSL_get_peer_certificate.3ssl index 8b150b32..723b10cd 100644 --- a/upstream/archlinux/man3/SSL_get_peer_certificate.3ssl +++ b/upstream/archlinux/man3/SSL_get_peer_certificate.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_PEER_CERTIFICATE 3ssl" -.TH SSL_GET_PEER_CERTIFICATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_PEER_CERTIFICATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_peer_signature_nid.3ssl b/upstream/archlinux/man3/SSL_get_peer_signature_nid.3ssl index 7ceceec9..28851f42 100644 --- a/upstream/archlinux/man3/SSL_get_peer_signature_nid.3ssl +++ b/upstream/archlinux/man3/SSL_get_peer_signature_nid.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_PEER_SIGNATURE_NID 3ssl" -.TH SSL_GET_PEER_SIGNATURE_NID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_PEER_SIGNATURE_NID 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_peer_tmp_key.3ssl b/upstream/archlinux/man3/SSL_get_peer_tmp_key.3ssl index 098dd59b..485db1f9 100644 --- a/upstream/archlinux/man3/SSL_get_peer_tmp_key.3ssl +++ b/upstream/archlinux/man3/SSL_get_peer_tmp_key.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_PEER_TMP_KEY 3ssl" -.TH SSL_GET_PEER_TMP_KEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_PEER_TMP_KEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_psk_identity.3ssl b/upstream/archlinux/man3/SSL_get_psk_identity.3ssl index 9615d81e..23dcd2a1 100644 --- a/upstream/archlinux/man3/SSL_get_psk_identity.3ssl +++ b/upstream/archlinux/man3/SSL_get_psk_identity.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_PSK_IDENTITY 3ssl" -.TH SSL_GET_PSK_IDENTITY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_PSK_IDENTITY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_rbio.3ssl b/upstream/archlinux/man3/SSL_get_rbio.3ssl index 015cfc75..ab78a7bb 100644 --- a/upstream/archlinux/man3/SSL_get_rbio.3ssl +++ b/upstream/archlinux/man3/SSL_get_rbio.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_RBIO 3ssl" -.TH SSL_GET_RBIO 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_RBIO 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_rpoll_descriptor.3ssl b/upstream/archlinux/man3/SSL_get_rpoll_descriptor.3ssl index d81b5137..7ea171fd 100644 --- a/upstream/archlinux/man3/SSL_get_rpoll_descriptor.3ssl +++ b/upstream/archlinux/man3/SSL_get_rpoll_descriptor.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_RPOLL_DESCRIPTOR 3ssl" -.TH SSL_GET_RPOLL_DESCRIPTOR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_RPOLL_DESCRIPTOR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_session.3ssl b/upstream/archlinux/man3/SSL_get_session.3ssl index e5609e42..643f6724 100644 --- a/upstream/archlinux/man3/SSL_get_session.3ssl +++ b/upstream/archlinux/man3/SSL_get_session.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_SESSION 3ssl" -.TH SSL_GET_SESSION 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_SESSION 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_shared_sigalgs.3ssl b/upstream/archlinux/man3/SSL_get_shared_sigalgs.3ssl index c75f2b55..b4f33b27 100644 --- a/upstream/archlinux/man3/SSL_get_shared_sigalgs.3ssl +++ b/upstream/archlinux/man3/SSL_get_shared_sigalgs.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_SHARED_SIGALGS 3ssl" -.TH SSL_GET_SHARED_SIGALGS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_SHARED_SIGALGS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_stream_id.3ssl b/upstream/archlinux/man3/SSL_get_stream_id.3ssl index ee957563..70bbbe68 100644 --- a/upstream/archlinux/man3/SSL_get_stream_id.3ssl +++ b/upstream/archlinux/man3/SSL_get_stream_id.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_STREAM_ID 3ssl" -.TH SSL_GET_STREAM_ID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_STREAM_ID 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_stream_read_state.3ssl b/upstream/archlinux/man3/SSL_get_stream_read_state.3ssl index 35329e74..558ece8d 100644 --- a/upstream/archlinux/man3/SSL_get_stream_read_state.3ssl +++ b/upstream/archlinux/man3/SSL_get_stream_read_state.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_STREAM_READ_STATE 3ssl" -.TH SSL_GET_STREAM_READ_STATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_STREAM_READ_STATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_value_uint.3ssl b/upstream/archlinux/man3/SSL_get_value_uint.3ssl new file mode 100644 index 00000000..87b90ada --- /dev/null +++ b/upstream/archlinux/man3/SSL_get_value_uint.3ssl @@ -0,0 +1,371 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "SSL_GET_VALUE_UINT 3ssl" +.TH SSL_GET_VALUE_UINT 3ssl 2024-04-28 3.3.0 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 +SSL_get_value_uint, SSL_set_value_uint, SSL_get_generic_value_uint, +SSL_set_generic_value_uint, SSL_get_feature_request_uint, +SSL_set_feature_request_uint, SSL_get_feature_peer_request_uint, +SSL_get_feature_negotiated_uint, SSL_get_quic_stream_bidi_local_avail, +SSL_get_quic_stream_bidi_remote_avail, SSL_get_quic_stream_uni_local_avail, +SSL_get_quic_stream_uni_remote_avail, SSL_VALUE_CLASS_GENERIC, +SSL_VALUE_CLASS_FEATURE_REQUEST, SSL_VALUE_CLASS_FEATURE_PEER_REQUEST, +SSL_VALUE_CLASS_FEATURE_NEGOTIATED, SSL_VALUE_QUIC_STREAM_BIDI_LOCAL_AVAIL, +SSL_VALUE_QUIC_STREAM_BIDI_REMOTE_AVAIL, SSL_VALUE_QUIC_STREAM_UNI_LOCAL_AVAIL, +SSL_VALUE_QUIC_STREAM_UNI_REMOTE_AVAIL, SSL_VALUE_QUIC_IDLE_TIMEOUT, +SSL_VALUE_EVENT_HANDLING_MODE, +SSL_VALUE_EVENT_HANDLING_MODE_INHERIT, +SSL_VALUE_EVENT_HANDLING_MODE_EXPLICIT, +SSL_VALUE_EVENT_HANDLING_MODE_IMPLICIT, +SSL_get_event_handling_mode, +SSL_set_event_handling_mode, +SSL_VALUE_STREAM_WRITE_BUF_SIZE, +SSL_get_stream_write_buf_size, +SSL_VALUE_STREAM_WRITE_BUF_USED, +SSL_get_stream_write_buf_used, +SSL_VALUE_STREAM_WRITE_BUF_AVAIL, +SSL_get_stream_write_buf_avail \- +manage negotiable features and configuration values for a SSL object +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& #include <openssl/ssl.h> +\& +\& int SSL_get_value_uint(SSL *ssl, uint32_t class_, uint32_t id, +\& uint64_t *value); +\& int SSL_set_value_uint(SSL *ssl, uint32_t class_, uint32_t id, +\& uint64_t value); +\& +\& #define SSL_VALUE_CLASS_GENERIC +\& #define SSL_VALUE_CLASS_FEATURE_REQUEST +\& #define SSL_VALUE_CLASS_FEATURE_PEER_REQUEST +\& #define SSL_VALUE_CLASS_FEATURE_NEGOTIATED +\& +\& #define SSL_VALUE_QUIC_STREAM_BIDI_LOCAL_AVAIL +\& #define SSL_VALUE_QUIC_STREAM_BIDI_REMOTE_AVAIL +\& #define SSL_VALUE_QUIC_STREAM_UNI_LOCAL_AVAIL +\& #define SSL_VALUE_QUIC_STREAM_UNI_REMOTE_AVAIL +\& #define SSL_VALUE_QUIC_IDLE_TIMEOUT +\& +\& #define SSL_VALUE_EVENT_HANDLING_MODE +\& #define SSL_VALUE_EVENT_HANDLING_MODE_INHERIT +\& #define SSL_VALUE_EVENT_HANDLING_MODE_EXPLICIT +\& #define SSL_VALUE_EVENT_HANDLING_MODE_IMPLICIT +\& +\& #define SSL_VALUE_STREAM_WRITE_BUF_SIZE +\& #define SSL_VALUE_STREAM_WRITE_BUF_USED +\& #define SSL_VALUE_STREAM_WRITE_BUF_AVAIL +.Ve +.PP +The following convenience macros can also be used: +.PP +.Vb 2 +\& int SSL_get_generic_value_uint(SSL *ssl, uint32_t id, uint64_t *value); +\& int SSL_set_generic_value_uint(SSL *ssl, uint32_t id, uint64_t value); +\& +\& int SSL_get_feature_request_uint(SSL *ssl, uint32_t id, uint64_t *value); +\& int SSL_set_feature_request_uint(SSL *ssl, uint32_t id, uint64_t value); +\& +\& int SSL_get_feature_peer_request_uint(SSL *ssl, uint32_t id, uint64_t *value); +\& int SSL_get_feature_negotiated_uint(SSL *ssl, uint32_t id, uint64_t *value); +\& +\& int SSL_get_quic_stream_bidi_local_avail(SSL *ssl, uint64_t *value); +\& int SSL_get_quic_stream_bidi_remote_avail(SSL *ssl, uint64_t *value); +\& int SSL_get_quic_stream_uni_local_avail(SSL *ssl, uint64_t *value); +\& int SSL_get_quic_stream_uni_remote_avail(SSL *ssl, uint64_t *value); +\& +\& int SSL_get_event_handling_mode(SSL *ssl, uint64_t *value); +\& int SSL_set_event_handling_mode(SSL *ssl, uint64_t value); +\& +\& int SSL_get_stream_write_buf_size(SSL *ssl, uint64_t *value); +\& int SSL_get_stream_write_buf_avail(SSL *ssl, uint64_t *value); +\& int SSL_get_stream_write_buf_used(SSL *ssl, uint64_t *value); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +\&\fBSSL_get_value_uint()\fR and \fBSSL_set_value_uint()\fR provide access to configurable +parameters for a given SSL object. Amongst other things, they are used to +provide control over the feature negotiation process during establishment of a +connection, and access to statistics about that connection. +.PP +\&\fBSSL_get_value_uint()\fR and \fBSSL_set_value_uint()\fR get and set configurable values +within a given value class. The value classes are enumerated by +\&\fBSSL_VALUE_CLASS\fR and are as follows: +.IP \fBSSL_VALUE_CLASS_GENERIC\fR 4 +.IX Item "SSL_VALUE_CLASS_GENERIC" +Values in this class do not participate in the feature negotiation process. They +may represent connection parameters which do not participate in explicit +negotiation or provide connection statistics. Values in this class might be +read-write or read-only. +.Sp +You can access values in this class using the convenience macros +\&\fBSSL_get_generic_value_uint()\fR and \fBSSL_set_generic_value_uint()\fR for brevity. +.IP \fBSSL_VALUE_CLASS_FEATURE_REQUEST\fR 4 +.IX Item "SSL_VALUE_CLASS_FEATURE_REQUEST" +Values in this class are read-write, and represent what the local party is +requesting during feature negotiation. Such a request will not necessarily be +honoured; see \fBSSL_VALUE_CLASS_FEATURE_NEGOTIATED\fR. +.Sp +A value in this class may become read-only in certain circumstances; for +example, after a connection has been established, for a value which cannot be +renegotiated after connection establishment. Setting a value in this class after +connection establishment represents a request for online renegotiation of the +specified feature. +.Sp +You can access values in this class using the convenience macros +\&\fBSSL_get_feature_request_uint()\fR and \fBSSL_set_feature_request_uint()\fR for brevity. +.IP \fBSSL_VALUE_CLASS_FEATURE_PEER_REQUEST\fR 4 +.IX Item "SSL_VALUE_CLASS_FEATURE_PEER_REQUEST" +Values in this value class are read-only, and represent what was requested by a +peer during feature negotiation. Such a request has not necessarily been +honoured; see \fBSSL_VALUE_CLASS_FEATURE_NEGOTIATED\fR. +.Sp +You can access values in this class using the convenience macro +\&\fBSSL_get_feature_peer_request_uint()\fR for brevity. +.IP \fBSSL_VALUE_CLASS_FEATURE_NEGOTIATED\fR 4 +.IX Item "SSL_VALUE_CLASS_FEATURE_NEGOTIATED" +Values in this value class are read-only, and represent the value which was +actually negotiated based on both local and peer input during feature +negotiation. This is the effective value in actual use. +.Sp +Attempting to read a value in this class will generally fail if the feature +negotiation process has not yet completed and the value is therefore currently +unknown, unless the nature of the feature in question causes a provisional value +to be used prior to completion of feature negotiation, in which case that value +may be returned. If an online (post-handshake) renegotiation of a feature is +in progress, retrieving the negotiated value will continue to retrieve the +previous negotiated value until that process is completed. See the documentation +of specific values for full details of its behaviour. +.Sp +You can access values in this class using the convenience macro +\&\fBSSL_get_feature_negotiated_uint()\fR for brevity. +.SH "CONFIGURABLE VALUES FOR QUIC OBJECTS" +.IX Header "CONFIGURABLE VALUES FOR QUIC OBJECTS" +The following configurable values are supported for QUIC SSL objects. Whether a +value is supported for a QUIC connection SSL object or a QUIC stream SSL object +is indicated in the heading for each value. Values supported for QUIC stream SSL +objects are also supported on QUIC connection SSL objects if they have a default +stream attached. +.PP +\&\fBSSL_get_value()\fR does not cause internal event processing to occur unless the +documentation for a specific value specifies otherwise. +.IP "\fBSSL_VALUE_QUIC_IDLE_TIMEOUT\fR (connection object)" 4 +.IX Item "SSL_VALUE_QUIC_IDLE_TIMEOUT (connection object)" +Negotiated feature value. This configures the desired QUIC idle timeout in +milliseconds, where 0 represents a lack of an idle timeout. This feature can +only be configured prior to connection establishment and cannot be subsequently +changed. +.Sp +This release of OpenSSL uses a default value of 30 seconds. This default value +may change between releases of OpenSSL. +.IP "\fBSSL_VALUE_QUIC_STREAM_BIDI_LOCAL_AVAIL\fR (connection object)" 4 +.IX Item "SSL_VALUE_QUIC_STREAM_BIDI_LOCAL_AVAIL (connection object)" +Generic read-only statistical value. The number of bidirectional, +locally-initiated streams available to be created (but not yet created). For +example, a value of 100 would mean that \fBSSL_new_stream\fR\|(3) could be called 100 +times to create 100 bidirectional streams before \fBSSL_new_stream\fR\|(3) would +block or fail due to backpressure. +.Sp +Can be queried using the convenience macro +\&\fBSSL_get_quic_stream_bidi_local_avail()\fR. +.IP "\fBSSL_VALUE_QUIC_STREAM_UNI_LOCAL_AVAIL\fR (connection object)" 4 +.IX Item "SSL_VALUE_QUIC_STREAM_UNI_LOCAL_AVAIL (connection object)" +As above, but provides the number of unidirectional, locally-initiated streams +available to be created (but not yet created). +.Sp +Can be queried using the convenience macro +\&\fBSSL_get_quic_stream_uni_local_avail()\fR. +.IP "\fBSSL_VALUE_QUIC_STREAM_BIDI_REMOTE_AVAIL\fR (connection object)" 4 +.IX Item "SSL_VALUE_QUIC_STREAM_BIDI_REMOTE_AVAIL (connection object)" +As above, but provides the number of bidirectional, remotely-initiated streams +available to be created (but not yet created) by the peer. This represents the +number of streams the local endpoint has authorised the peer to create in terms +of QUIC stream creation flow control. +.Sp +Can be queried using the convenience macro +\&\fBSSL_get_quic_stream_bidi_remote_avail()\fR. +.IP "\fBSSL_VALUE_QUIC_STREAM_UNI_REMOTE_AVAIL\fR (connection object)" 4 +.IX Item "SSL_VALUE_QUIC_STREAM_UNI_REMOTE_AVAIL (connection object)" +As above, but provides the number of unidirectional, remotely-initiated streams +available to be created (but not yet created). +.Sp +Can be queried using the convenience macro +\&\fBSSL_get_quic_stream_uni_remote_avail()\fR. +.IP "\fBSSL_VALUE_EVENT_HANDLING_MODE\fR (connection or stream object)" 4 +.IX Item "SSL_VALUE_EVENT_HANDLING_MODE (connection or stream object)" +Generic value. This is an integer value which takes one of the following values, +and determines the event handling mode in use: +.RS 4 +.IP \fBSSL_VALUE_EVENT_HANDLING_MODE_INHERIT\fR 4 +.IX Item "SSL_VALUE_EVENT_HANDLING_MODE_INHERIT" +When set, the event handling mode used is inherited from the value set on the +parent connection (for a stream), or, for a connection, defaults to the implicit +event handling model. +.Sp +When a new connection is created, or a new stream is created or accepted, it +defaults to this setting. +.IP "\fBSSL_VALUE_EVENT_HANDLING_MODE_IMPLICIT\fR (Implicit event handling)" 4 +.IX Item "SSL_VALUE_EVENT_HANDLING_MODE_IMPLICIT (Implicit event handling)" +If set to this value, the implicit event handling model is used. Under this +model, QUIC objects will automatically perform background event processing +(equivalent to a call to \fBSSL_handle_events\fR\|(3)) when calls to I/O functions +such as \fBSSL_read_ex\fR\|(3) or \fBSSL_write_ex\fR\|(3) are made on a QUIC SSL object. +This helps to maintain the health of the QUIC connection and ensures that +incoming datagrams and timeout events are processed. +.IP "\fBSSL_VALUE_EVENT_HANDLING_MODE_EXPLICIT\fR (Explicit event handling)" 4 +.IX Item "SSL_VALUE_EVENT_HANDLING_MODE_EXPLICIT (Explicit event handling)" +If set to this value, the explicit event handling model is used. Under this +model, \fBnonblocking\fR calls to I/O functions such as \fBSSL_read_ex\fR\|(3) or +\&\fBSSL_write_ex\fR\|(3) do not result in the automatic processing of QUIC events. Any +new incoming network traffic is not handled; no new outgoing network traffic is +generated, and pending timeout events are not processed. This allows an +application to obtain greater control over the circumstances in which QUIC event +processing occurs. If this event handling model is used, it is the application's +responsibility to call \fBSSL_handle_events\fR\|(3) as and when called for by the +QUIC implementation; see the \fBSSL_get_rpoll_descriptor\fR\|(3) man page for more +information. +.Sp +Selecting this model does not affect the operation of blocking I/O calls, which +will continue to use the implicit event handling model. Therefore, applications +using this model will generally want to disable blocking operation using +\&\fBSSL_set_blocking_mode\fR\|(3). +.RE +.RS 4 +.Sp +Can be configured using the convenience macros \fBSSL_get_event_handling_mode()\fR and +\&\fBSSL_set_event_handling_mode()\fR. +.Sp +A call to \fBSSL_set_value_uint()\fR which causes this value to switch back to the +implicit event handling model does not in itself cause implicit event handling +to occur; such handling will occur on the next I/O API call. Equally, a call to +\&\fBSSL_set_value_uint()\fR which causes this value to switch to the explicit event +handling model will not cause event handling to occur before making that +transition. +.Sp +This value controls whether implicit event handling occurs when making an I/O +API call on the SSL object it is set on. However, event processing is not +confined to state which relates to only that object. For example, if you +configure explicit event handling on QUIC stream SSL object "A" and configure +implicit event handling on QUIC stream SSL object "B", a call to an I/O function +on "B" may result in state changes to "A". In other words, if event handling +does happen as a result of an API call to an object related to a connection, +processing of background events (for example, received QUIC network traffic) may +also affect the state of any other object related to a connection. +.RE +.IP "\fBSSL_VALUE_STREAM_WRITE_BUF_SIZE\fR (stream object)" 4 +.IX Item "SSL_VALUE_STREAM_WRITE_BUF_SIZE (stream object)" +Generic read-only statistical value. The size of the write buffer allocated to +hold data written to a stream with \fBSSL_write_ex\fR\|(3) until it is transmitted +and subsequently acknowledged by the peer. This value may change at any time, as +buffer sizes are optimised in response to network conditions to optimise +throughput. +.Sp +Can be queried using the convenience macro \fBSSL_get_stream_write_buf_size()\fR. +.IP "\fBSSL_VALUE_STREAM_WRITE_BUF_USED\fR (stream object)" 4 +.IX Item "SSL_VALUE_STREAM_WRITE_BUF_USED (stream object)" +Generic read-only statistical value. The number of bytes currently consumed +in the write buffer which have yet to be acknowledged by the peer. Successful +calls to \fBSSL_write_ex\fR\|(3) which accept data cause this number to increase. +This number will then decrease as data is acknowledged by the peer. +.Sp +Can be queried using the convenience macro \fBSSL_get_stream_write_buf_used()\fR. +.IP "\fBSSL_VALUE_STREAM_WRITE_BUF_AVAIL\fR (stream object)" 4 +.IX Item "SSL_VALUE_STREAM_WRITE_BUF_AVAIL (stream object)" +Generic read-only statistical value. The number of bytes available in the write +buffer which have yet to be consumed by calls to \fBSSL_write_ex\fR\|(3). Successful +calls to \fBSSL_write_ex\fR\|(3) which accept data cause this number to decrease. +This number will increase as data is acknowledged by the peer. It may also +change if the buffer is resized automatically to optimise throughput. +.Sp +Can be queried using the convenience macro \fBSSL_get_stream_write_buf_avail()\fR. +.PP +No configurable values are currently defined for non-QUIC SSL objects. +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +Returns 1 on success or 0 on failure. This function can fail for a number of +reasons: +.IP \(bu 4 +An argument is invalid (e.g. NULL pointer or invalid class). +.IP \(bu 4 +The given value is not supported by the SSL object on which it was called. +.IP \(bu 4 +The given operation (get or set) is not supported by the specified +configurable value. +.IP \(bu 4 +You are trying to modify the given value and the value is not modifiable at this +time. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBSSL_ctrl\fR\|(3), \fBSSL_get_accept_stream_queue_len\fR\|(3), +\&\fBSSL_get_stream_read_state\fR\|(3), \fBSSL_get_stream_write_state\fR\|(3), +\&\fBSSL_get_stream_read_error_code\fR\|(3), \fBSSL_get_stream_write_error_code\fR\|(3), +\&\fBSSL_set_default_stream_mode\fR\|(3), \fBSSL_set_incoming_stream_policy\fR\|(3) +.SH HISTORY +.IX Header "HISTORY" +These functions were added in OpenSSL 3.3. +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2002\-2024 The OpenSSL Project Authors. All Rights Reserved. +.PP +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 +<https://www.openssl.org/source/license.html>. diff --git a/upstream/archlinux/man3/SSL_get_verify_result.3ssl b/upstream/archlinux/man3/SSL_get_verify_result.3ssl index 2b7160b3..cd74249a 100644 --- a/upstream/archlinux/man3/SSL_get_verify_result.3ssl +++ b/upstream/archlinux/man3/SSL_get_verify_result.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_VERIFY_RESULT 3ssl" -.TH SSL_GET_VERIFY_RESULT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_VERIFY_RESULT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_get_version.3ssl b/upstream/archlinux/man3/SSL_get_version.3ssl index df4a6359..4cd5f8ae 100644 --- a/upstream/archlinux/man3/SSL_get_version.3ssl +++ b/upstream/archlinux/man3/SSL_get_version.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GET_VERSION 3ssl" -.TH SSL_GET_VERSION 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GET_VERSION 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_group_to_name.3ssl b/upstream/archlinux/man3/SSL_group_to_name.3ssl index 5d2578d8..4d515f4f 100644 --- a/upstream/archlinux/man3/SSL_group_to_name.3ssl +++ b/upstream/archlinux/man3/SSL_group_to_name.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_GROUP_TO_NAME 3ssl" -.TH SSL_GROUP_TO_NAME 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_GROUP_TO_NAME 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -67,7 +67,7 @@ SSL_group_to_name \- get name of group .Vb 1 \& #include <openssl/ssl.h> \& -\& const char *SSL_group_to_name(const SSL *ssl, int id); +\& const char *SSL_group_to_name(SSL *ssl, int id); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" @@ -89,7 +89,7 @@ SSL object \fIssl\fR. \&\fBssl\fR\|(7) .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2021 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2021\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/SSL_handle_events.3ssl b/upstream/archlinux/man3/SSL_handle_events.3ssl index 73f988f7..d5d1e050 100644 --- a/upstream/archlinux/man3/SSL_handle_events.3ssl +++ b/upstream/archlinux/man3/SSL_handle_events.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_HANDLE_EVENTS 3ssl" -.TH SSL_HANDLE_EVENTS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_HANDLE_EVENTS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_in_init.3ssl b/upstream/archlinux/man3/SSL_in_init.3ssl index 73704a13..99ec5a69 100644 --- a/upstream/archlinux/man3/SSL_in_init.3ssl +++ b/upstream/archlinux/man3/SSL_in_init.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_IN_INIT 3ssl" -.TH SSL_IN_INIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_IN_INIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_inject_net_dgram.3ssl b/upstream/archlinux/man3/SSL_inject_net_dgram.3ssl index 1e6d8640..2b691a1f 100644 --- a/upstream/archlinux/man3/SSL_inject_net_dgram.3ssl +++ b/upstream/archlinux/man3/SSL_inject_net_dgram.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_INJECT_NET_DGRAM 3ssl" -.TH SSL_INJECT_NET_DGRAM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_INJECT_NET_DGRAM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_key_update.3ssl b/upstream/archlinux/man3/SSL_key_update.3ssl index e132fb42..5ca82bad 100644 --- a/upstream/archlinux/man3/SSL_key_update.3ssl +++ b/upstream/archlinux/man3/SSL_key_update.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_KEY_UPDATE 3ssl" -.TH SSL_KEY_UPDATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_KEY_UPDATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_library_init.3ssl b/upstream/archlinux/man3/SSL_library_init.3ssl index 808082ac..61b5380e 100644 --- a/upstream/archlinux/man3/SSL_library_init.3ssl +++ b/upstream/archlinux/man3/SSL_library_init.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_LIBRARY_INIT 3ssl" -.TH SSL_LIBRARY_INIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_LIBRARY_INIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_load_client_CA_file.3ssl b/upstream/archlinux/man3/SSL_load_client_CA_file.3ssl index eef762da..efe29d74 100644 --- a/upstream/archlinux/man3/SSL_load_client_CA_file.3ssl +++ b/upstream/archlinux/man3/SSL_load_client_CA_file.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_LOAD_CLIENT_CA_FILE 3ssl" -.TH SSL_LOAD_CLIENT_CA_FILE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_LOAD_CLIENT_CA_FILE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -111,13 +111,23 @@ the specific usage as support function for it is not limited to CA certificates. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -The following return values can occur: +The following return values can occur for \fBSSL_load_client_CA_file_ex()\fR, and +\&\fBSSL_load_client_CA_file()\fR: .IP NULL 4 .IX Item "NULL" The operation failed, check out the error stack for the reason. .IP "Pointer to STACK_OF(X509_NAME)" 4 .IX Item "Pointer to STACK_OF(X509_NAME)" Pointer to the subject names of the successfully read certificates. +.PP +The following return values can occur for \fBSSL_add_file_cert_subjects_to_stack()\fR, +\&\fBSSL_add_dir_cert_subjects_to_stack()\fR, and \fBSSL_add_store_cert_subjects_to_stack()\fR: +.IP "0 (Failure)" 4 +.IX Item "0 (Failure)" +The operation failed. +.IP "1 (Success)" 4 +.IX Item "1 (Success)" +The operation succeeded. .SH EXAMPLES .IX Header "EXAMPLES" Load names of CAs from file and use it as a client CA list: @@ -145,7 +155,7 @@ Load names of CAs from file and use it as a client CA list: were added in OpenSSL 3.0. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/SSL_new.3ssl b/upstream/archlinux/man3/SSL_new.3ssl index 2f9c5ef5..f4d73e72 100644 --- a/upstream/archlinux/man3/SSL_new.3ssl +++ b/upstream/archlinux/man3/SSL_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_NEW 3ssl" -.TH SSL_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_new_stream.3ssl b/upstream/archlinux/man3/SSL_new_stream.3ssl index e04483c5..760a3545 100644 --- a/upstream/archlinux/man3/SSL_new_stream.3ssl +++ b/upstream/archlinux/man3/SSL_new_stream.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_NEW_STREAM 3ssl" -.TH SSL_NEW_STREAM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_NEW_STREAM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_pending.3ssl b/upstream/archlinux/man3/SSL_pending.3ssl index 35c9aa6c..c318014c 100644 --- a/upstream/archlinux/man3/SSL_pending.3ssl +++ b/upstream/archlinux/man3/SSL_pending.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_PENDING 3ssl" -.TH SSL_PENDING 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_PENDING 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_poll.3ssl b/upstream/archlinux/man3/SSL_poll.3ssl new file mode 100644 index 00000000..d322d70b --- /dev/null +++ b/upstream/archlinux/man3/SSL_poll.3ssl @@ -0,0 +1,393 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "SSL_POLL 3ssl" +.TH SSL_POLL 3ssl 2024-04-28 3.3.0 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 +SSL_poll, +SSL_POLL_EVENT_NONE, +SSL_POLL_EVENT_F, +SSL_POLL_EVENT_EC, +SSL_POLL_EVENT_ECD, +SSL_POLL_EVENT_ER, +SSL_POLL_EVENT_EW, +SSL_POLL_EVENT_R, +SSL_POLL_EVENT_W, +SSL_POLL_EVENT_ISB, +SSL_POLL_EVENT_ISU, +SSL_POLL_EVENT_OSB, +SSL_POLL_EVENT_OSU, +SSL_POLL_EVENT_RW, +SSL_POLL_EVENT_RE, +SSL_POLL_EVENT_WE, +SSL_POLL_EVENT_RWE, +SSL_POLL_EVENT_E, +SSL_POLL_EVENT_IS, +SSL_POLL_EVENT_ISE, +SSL_POLL_EVENT_I, +SSL_POLL_EVENT_OS, +SSL_POLL_EVENT_OSE, +SSL_POLL_FLAG_NO_HANDLE_EVENTS +\&\- determine or await readiness conditions for one or more pollable objects +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& #include <openssl/ssl.h> +\& +\& #define SSL_POLL_EVENT_NONE 0 +\& +\& #define SSL_POLL_EVENT_F /* F (Failure) */ +\& #define SSL_POLL_EVENT_EC /* EC (Exception on Conn) */ +\& #define SSL_POLL_EVENT_ECD /* ECD (Exception on Conn Drained) */ +\& #define SSL_POLL_EVENT_ER /* ER (Exception on Read) */ +\& #define SSL_POLL_EVENT_EW /* EW (Exception on Write) */ +\& #define SSL_POLL_EVENT_R /* R (Readable) */ +\& #define SSL_POLL_EVENT_W /* W (Writable) */ +\& #define SSL_POLL_EVENT_ISB /* ISB (Incoming Stream: Bidi) */ +\& #define SSL_POLL_EVENT_ISU /* ISU (Incoming Stream: Uni) */ +\& #define SSL_POLL_EVENT_OSB /* OSB (Outgoing Stream: Bidi) */ +\& #define SSL_POLL_EVENT_OSU /* OSU (Outgoing Stream: Uni) */ +\& +\& #define SSL_POLL_EVENT_RW /* R | W */ +\& #define SSL_POLL_EVENT_RE /* R | ER */ +\& #define SSL_POLL_EVENT_WE /* W | EW */ +\& #define SSL_POLL_EVENT_RWE /* RE | WE */ +\& #define SSL_POLL_EVENT_E /* EC | ER | EW */ +\& #define SSL_POLL_EVENT_IS /* ISB | ISU */ +\& #define SSL_POLL_EVENT_ISE /* IS | EC */ +\& #define SSL_POLL_EVENT_I /* IS */ +\& #define SSL_POLL_EVENT_OS /* OSB | OSU */ +\& #define SSL_POLL_EVENT_OSE /* OS | EC */ +\& +\& typedef struct ssl_poll_item_st { +\& BIO_POLL_DESCRIPTOR desc; +\& uint64_t events, revents; +\& } SSL_POLL_ITEM; +\& +\& #define SSL_POLL_FLAG_NO_HANDLE_EVENTS +\& +\& int SSL_poll(SSL_POLL_ITEM *items, +\& size_t num_items, +\& size_t stride, +\& const struct timeval *timeout, +\& uint64_t flags, +\& size_t *result_count); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +\&\fBSSL_poll()\fR allows the readiness conditions of the resources represented by one +or more BIO_POLL_DESCRIPTOR structures to be determined. In particular, it can +be used to query for readiness conditions on QUIC connection SSL objects and +QUIC stream SSL objects in a single call. +.PP +A call to \fBSSL_poll()\fR specifies an array of \fBSSL_POLL_ITEM\fR structures, each of +which designates a resource which is being polled for readiness, and a set of +event flags which indicate the specific readiness events which the caller is +interested in in relation to the specified resource. +.PP +The fields of \fBSSL_POLL_ITEM\fR are as follows: +.IP \fIdesc\fR 4 +.IX Item "desc" +The resource being polled for readiness, as represented by a +\&\fBBIO_POLL_DESCRIPTOR\fR. Currently, this must be a poll descriptor of type +\&\fBBIO_POLL_DESCRIPTOR_TYPE_SSL\fR, representing a SSL object pointer, and the SSL +object must be a QUIC connection SSL object or QUIC stream SSL object. +.Sp +If a \fBSSL_POLL_ITEM\fR has a poll descriptor type of +\&\fBBIO_POLL_DESCRIPTOR_TYPE_NONE\fR, or the SSL object pointer is NULL, the +\&\fBSSL_POLL_ITEM\fR array entry is ignored and \fIrevents\fR will be set to 0 on +return. +.IP \fIevents\fR 4 +.IX Item "events" +This is the set of zero or more events which the caller is interested in +learning about in relation to the resource described by \fIdesc\fR. It is a +collection of zero or more \fBSSL_POLL_EVENT\fR flags. See "EVENT TYPES" for a +description of each of the event types. +.IP \fIrevents\fR 4 +.IX Item "revents" +After \fBSSL_poll()\fR returns, this is the set of zero or more events which are +actually applicable to the resource described by \fIdesc\fR. As for \fIevents\fR, +it is a collection of zero or more \fBSSL_POLL_EVENT\fR flags. +.Sp +\&\fIrevents\fR need not be a subset of the events specified in \fIevents\fR, as some +event types are defined as always being enabled (non-maskable). See "EVENT +TYPES" for more information. +.PP +To use \fBSSL_poll()\fR, call it with an array of \fBSSL_POLL_ITEM\fR structures. The +array need remain allocated only for the duration of the call. \fInum_items\fR must +be set to the number of entries in the array, and \fIstride\fR must be set to +\&\f(CWsizeof(SSL_POLL_ITEM)\fR. +.PP +The present implementation of \fBSSL_poll()\fR is a subset of the functionality which +will eventually be available. Only a nonblocking mode of operation is available +at this time, where \fBSSL_poll()\fR always returns immediately. As such, \fItimeout\fR +must point to a valid \fBstruct timeval\fR and that structure must be set to zero. +In future, other inputs to the \fItimeout\fR argument will result in a blocking +mode of operation, which is not currently supported. For more information, see +"LIMITATIONS". +.PP +The following flags are currently defined for the \fIflags\fR argument: +.IP \fBSSL_POLL_FLAG_NO_HANDLE_EVENTS\fR 4 +.IX Item "SSL_POLL_FLAG_NO_HANDLE_EVENTS" +This flag indicates that internal state machine processing should not be +performed in an attempt to generate new readiness events. Only existing +readiness events will be reported. +.PP +The \fIresult_count\fR argument is optional. If it is non-NULL, it is used to +output the number of entries in the array which have nonzero \fIrevents\fR fields +when the call to \fBSSL_poll()\fR returns; see "RETURN VALUES" for details. +.SH "EVENT TYPES" +.IX Header "EVENT TYPES" +The \fBSSL_poll()\fR interface reports zero or more event types on a given resource, +represented by a bit mask. +.PP +All of the event types are level triggered and represent a readiness or +permanent exception condition; as such, after an event has been reported by +\&\fBSSL_poll()\fR for a resource, it will continue to be reported in future \fBSSL_poll()\fR +calls until the condition ceases to be in effect. A caller must mask the given +event type bit in future \fBSSL_poll()\fR calls if it does not wish to receive +repeated notifications and has not caused the underlying readiness condition +(for example, consuming all available data using \fBSSL_read_ex\fR\|(3) after +\&\fBSSL_POLL_EVENT_R\fR is reported) to be deasserted. +.PP +Some event types do not make sense on a given kind of resource. In this case, +specifying that event type in \fIevents\fR is a no-op and will be ignored, and the +given event will never be reported in \fIrevents\fR. +.PP +Failure of the polling mechanism itself is considered distinct from an exception +condition on a resource which was successfully polled. See \fBSSL_POLL_EVENT_F\fR +and "RETURN VALUES" for details. +.PP +In general, an application should always listen for the event types +corresponding to exception conditions if it is listening to the corresponding +non-exception event types (e.g. \fBSSL_POLL_EVENT_EC\fR and \fBSSL_POLL_EVENT_ER\fR +for \fBSSL_POLL_EVENT_R\fR), as not doing so is unlikely to be a sound design. +.PP +Some event types are non-maskable and may be reported in \fIrevents\fR regardless +of whether they were requested in \fIevents\fR. +.PP +The following event types are supported: +.IP \fBSSL_POLL_EVENT_F\fR 4 +.IX Item "SSL_POLL_EVENT_F" +Polling failure. This event is raised when a resource could not be polled. It is +distinct from an exception condition reported on a resource which was +successfully polled and represents a failure of the polling process itself in +relation to a resource. This may mean that \fBSSL_poll()\fR does not support the kind +of resource specified. +.Sp +Where this event is raised on at least one item in \fIitems\fR, \fBSSL_poll()\fR will +return 0 and the ERR stack will contain information pertaining to the first item +in \fIitems\fR with \fBSSL_POLL_EVENT_F\fR set. See "RETURN VALUES" for more +information. +.Sp +This event type may be raised even if it was not requested in \fIevents\fR; +specifying this event type in \fIevents\fR does nothing. +.IP \fBSSL_POLL_EVENT_EC\fR 4 +.IX Item "SSL_POLL_EVENT_EC" +Error at connection level. This event is raised when a connection has failed. +In particular, it is raised when a connection begins terminating. +.Sp +This event is never raised on objects which are not connections. +.IP \fBSSL_POLL_EVENT_DCD\fR 4 +.IX Item "SSL_POLL_EVENT_DCD" +Error at connection level (drained). This event is raised when a connection has +finished terminating, and has reached the terminated state. This event will +generally occur after an interval of time passes after the \fBSSL_POLL_EVENT_EC\fR +event is raised on a connection. +.Sp +This event is never raised on objects which are not connections. +.IP \fBSSL_POLL_EVENT_ER\fR 4 +.IX Item "SSL_POLL_EVENT_ER" +Error in read direction. For QUIC, this is raised only in the event that a +stream has a read part and that read part has been reset by the peer (for +example, using a \fBRESET_STREAM\fR frame). +.IP \fBSSL_POLL_EVENT_EW\fR 4 +.IX Item "SSL_POLL_EVENT_EW" +Error in write direction. For QUIC, this is raised only in the event that a +stream has a write part and that write part has been reset by the peer using a +\&\fBSTOP_SENDING\fR frame. +.IP \fBSSL_POLL_EVENT_R\fR 4 +.IX Item "SSL_POLL_EVENT_R" +Readable. This event is raised when a QUIC stream SSL object (or a QUIC +connection SSL object with a default stream attached) has application data +waiting to be read using \fBSSL_read_ex\fR\|(3), or a FIN event as represented by +\&\fBSSL_ERROR_ZERO_RETURN\fR waiting to be read. +.Sp +It is not raised in the event of the receiving part of the QUIC stream being +reset by the peer; see \fBSSL_POLL_EVENT_ER\fR. +.IP \fBSSL_POLL_EVENT_W\fR 4 +.IX Item "SSL_POLL_EVENT_W" +Writable. This event is raised when a QUIC stream SSL object (or a QUIC +connection SSL object with a default stream attached) could accept more +application data using \fBSSL_write_ex\fR\|(3). +.Sp +This event is never raised by a receive-only stream. +.Sp +This event is never raised by a stream which has had its send part concluded +normally (as with \fBSSL_stream_conclude\fR\|(3)) or locally reset (as with +\&\fBSSL_stream_reset\fR\|(3)). +.Sp +This event does not guarantee that a subsequent call to \fBSSL_write_ex\fR\|(3) will +succeed. +.IP \fBSSL_POLL_EVENT_ISB\fR 4 +.IX Item "SSL_POLL_EVENT_ISB" +This event, which is only raised by a QUIC connection SSL object, is raised when +one or more incoming bidirectional streams are available to be accepted using +\&\fBSSL_accept_stream\fR\|(3). +.IP \fBSSL_POLL_EVENT_ISU\fR 4 +.IX Item "SSL_POLL_EVENT_ISU" +This event, which is only raised by a QUIC connection SSL object, is raised when +one or more incoming unidirectional streams are available to be accepted using +\&\fBSSL_accept_stream\fR\|(3). +.IP \fBSSL_POLL_EVENT_OSB\fR 4 +.IX Item "SSL_POLL_EVENT_OSB" +This event, which is only raised by a QUIC connection SSL object, is raised when +QUIC stream creation flow control currently permits at least one additional +bidirectional stream to be locally created. +.IP \fBSSL_POLL_EVENT_OSU\fR 4 +.IX Item "SSL_POLL_EVENT_OSU" +This event, which is only raised by a QUIC connection SSL object, is raised when +QUIC stream creation flow control currently permits at least one additional +unidirectional stream to be locally created. +.SH LIMITATIONS +.IX Header "LIMITATIONS" +\&\fBSSL_poll()\fR as presently implemented has the following limitations: +.IP \(bu 4 +The implementation of \fBSSL_poll()\fR only supports nonblocking operation and +therefore requires the \fItimeout\fR argument be used to specify a zero timeout. +Calls to \fBSSL_poll()\fR which specify another value, or which pass \fItimeout\fR as +NULL, will fail. This does not allow waiting, but does allow multiple QUIC SSL +objects to be queried for their readiness state in a single call. +.Sp +Future releases will remove this limitation and support blocking \fBSSL_poll()\fR. +.IP \(bu 4 +Only \fBBIO_POLL_DESCRIPTOR\fR structures with type +\&\fBBIO_POLL_DESCRIPTOR_TYPE_SSL\fR, referencing QUIC connection SSL objects or QUIC +stream SSL objects, are supported. +.PP +These limitations will be revised in a future release of OpenSSL. +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +\&\fBSSL_poll()\fR returns 1 on success and 0 on failure. +.PP +Unless the \fIitems\fR pointer itself is invalid, \fBSSL_poll()\fR will always initialise +the \fIrevents\fR fields of all items in the input array upon returning, even if it +returns failure. +.PP +If \fIresult_count\fR is non-NULL, it is always written with the number of items in +the array with nonzero \fIrevents\fR fields, even if the \fBSSL_poll()\fR call returns +failure. +.PP +It is possible for \fIresult_count\fR to be written as 0 even if the \fBSSL_poll()\fR +call returns success, namely if no events were output but the polling process +was successful (e.g. in nonblocking usage) or timed out. +.PP +It is possible for \fIresult_count\fR to be written as a nonzero value if the +\&\fBSSL_poll()\fR call returns failure, for example due to \fBSSL_POLL_EVENT_F\fR events, +or because some events were detected and output before encountering a failure +condition while processing a subsequent entry in the \fIitems\fR array. +.PP +If at least one \fBSSL_POLL_EVENT_F\fR event is output, \fBSSL_poll()\fR is guaranteed +to return 0 and guaranteed to place at least one ERR on the error stack +describing the first \fBSSL_POLL_EVENT_F\fR output. Detailed information on any +additional \fBSSL_POLL_EVENT_F\fR events is not available. \fBSSL_poll()\fR may or may +not return more than one \fBSSL_POLL_EVENT_F\fR event at once. +.PP +"Normal" events representing exceptional I/O conditions which do not +constitute a failure of the \fBSSL_poll()\fR mechanism itself are not considered +errors by \fBSSL_poll()\fR and are instead represented using their own event type; see +"EVENT TYPES" for details. +.PP +The caller can establish the meaning of the \fBSSL_poll()\fR return and output values +as follows: +.IP \(bu 4 +If \fBSSL_poll()\fR returns 1 and \fIresult_count\fR is zero, the operation timed out +before any resource was ready. +.IP \(bu 4 +If \fBSSL_poll()\fR returns 1 and \fIresult_count\fR is nonzero, that many events were +output. +.IP \(bu 4 +If \fBSSL_poll()\fR returns 0 and \fIresult_count\fR is zero, the caller has made a basic +usage error; check the ERR stack for details. +.IP \(bu 4 +If \fBSSL_poll()\fR returns 0 and \fIresult_count\fR is nonzero, inspect the \fIitems\fR +array for \fBSSL_POLL_ITEM\fR structures with the \fBSSL_POLL_EVENT_F\fR event type +raised in \fIrevents\fR. The entries added to the ERR stack (of which there is +guaranteed to be at least one) reflect the cause of the failure of the first +item in \fIitems\fR with \fBSSL_POLL_EVENT_F\fR raised. Note that there may be events +other than \fISSL_POLL_EVENT_F\fR output for items which come before the first +item with \fBSSL_POLL_EVENT_F\fR raised, and additional \fBSSL_POLL_EVENT_F\fR +events may or may not have been output, both of which which will be reflected in +\&\fIresult_count\fR. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBBIO_get_rpoll_descriptor\fR\|(3), \fBBIO_get_wpoll_descriptor\fR\|(3), +\&\fBSSL_get_rpoll_descriptor\fR\|(3), \fBSSL_get_wpoll_descriptor\fR\|(3) +.SH HISTORY +.IX Header "HISTORY" +\&\fBSSL_poll()\fR was added in OpenSSL 3.3. +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2024 The OpenSSL Project Authors. All Rights Reserved. +.PP +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 +<https://www.openssl.org/source/license.html>. diff --git a/upstream/archlinux/man3/SSL_read.3ssl b/upstream/archlinux/man3/SSL_read.3ssl index 0d70add6..48936654 100644 --- a/upstream/archlinux/man3/SSL_read.3ssl +++ b/upstream/archlinux/man3/SSL_read.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_READ 3ssl" -.TH SSL_READ 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_READ 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_read_early_data.3ssl b/upstream/archlinux/man3/SSL_read_early_data.3ssl index 1c9da866..f1b50cf2 100644 --- a/upstream/archlinux/man3/SSL_read_early_data.3ssl +++ b/upstream/archlinux/man3/SSL_read_early_data.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_READ_EARLY_DATA 3ssl" -.TH SSL_READ_EARLY_DATA 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_READ_EARLY_DATA 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_rstate_string.3ssl b/upstream/archlinux/man3/SSL_rstate_string.3ssl index c6c6039a..3f995ae4 100644 --- a/upstream/archlinux/man3/SSL_rstate_string.3ssl +++ b/upstream/archlinux/man3/SSL_rstate_string.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_RSTATE_STRING 3ssl" -.TH SSL_RSTATE_STRING 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_RSTATE_STRING 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_session_reused.3ssl b/upstream/archlinux/man3/SSL_session_reused.3ssl index 22b63632..1fb6ec1b 100644 --- a/upstream/archlinux/man3/SSL_session_reused.3ssl +++ b/upstream/archlinux/man3/SSL_session_reused.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SESSION_REUSED 3ssl" -.TH SSL_SESSION_REUSED 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SESSION_REUSED 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_set1_host.3ssl b/upstream/archlinux/man3/SSL_set1_host.3ssl index d7f83133..2eed61e8 100644 --- a/upstream/archlinux/man3/SSL_set1_host.3ssl +++ b/upstream/archlinux/man3/SSL_set1_host.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SET1_HOST 3ssl" -.TH SSL_SET1_HOST 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SET1_HOST 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_set1_initial_peer_addr.3ssl b/upstream/archlinux/man3/SSL_set1_initial_peer_addr.3ssl index 7336f47b..90b7d3bd 100644 --- a/upstream/archlinux/man3/SSL_set1_initial_peer_addr.3ssl +++ b/upstream/archlinux/man3/SSL_set1_initial_peer_addr.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SET1_INITIAL_PEER_ADDR 3ssl" -.TH SSL_SET1_INITIAL_PEER_ADDR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SET1_INITIAL_PEER_ADDR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_set1_server_cert_type.3ssl b/upstream/archlinux/man3/SSL_set1_server_cert_type.3ssl index d4185d91..11d65880 100644 --- a/upstream/archlinux/man3/SSL_set1_server_cert_type.3ssl +++ b/upstream/archlinux/man3/SSL_set1_server_cert_type.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SET1_SERVER_CERT_TYPE 3ssl" -.TH SSL_SET1_SERVER_CERT_TYPE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SET1_SERVER_CERT_TYPE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -209,7 +209,7 @@ To connect to this server, set the client SSL_CTX and SSL as follows: \& \& /* Do SSL_connect() handshake and handle errors here */ \& -\& /* Optional: verify the peer RPK */ +\& /* Optional: verify the peer RPK */ \& verify_result = SSL_get_verify_result(ssl); \& if (verify_result == X509_V_OK) { \& /* The server\*(Aqs raw public key matched the TLSA record */ diff --git a/upstream/archlinux/man3/SSL_set_async_callback.3ssl b/upstream/archlinux/man3/SSL_set_async_callback.3ssl index 340df9db..d7e204f6 100644 --- a/upstream/archlinux/man3/SSL_set_async_callback.3ssl +++ b/upstream/archlinux/man3/SSL_set_async_callback.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SET_ASYNC_CALLBACK 3ssl" -.TH SSL_SET_ASYNC_CALLBACK 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SET_ASYNC_CALLBACK 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_set_bio.3ssl b/upstream/archlinux/man3/SSL_set_bio.3ssl index f4f76e93..a7890867 100644 --- a/upstream/archlinux/man3/SSL_set_bio.3ssl +++ b/upstream/archlinux/man3/SSL_set_bio.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SET_BIO 3ssl" -.TH SSL_SET_BIO 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SET_BIO 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_set_blocking_mode.3ssl b/upstream/archlinux/man3/SSL_set_blocking_mode.3ssl index 07f5125b..584ecfa7 100644 --- a/upstream/archlinux/man3/SSL_set_blocking_mode.3ssl +++ b/upstream/archlinux/man3/SSL_set_blocking_mode.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SET_BLOCKING_MODE 3ssl" -.TH SSL_SET_BLOCKING_MODE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SET_BLOCKING_MODE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_set_connect_state.3ssl b/upstream/archlinux/man3/SSL_set_connect_state.3ssl index d7a799e6..13ed46bb 100644 --- a/upstream/archlinux/man3/SSL_set_connect_state.3ssl +++ b/upstream/archlinux/man3/SSL_set_connect_state.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SET_CONNECT_STATE 3ssl" -.TH SSL_SET_CONNECT_STATE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SET_CONNECT_STATE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_set_default_stream_mode.3ssl b/upstream/archlinux/man3/SSL_set_default_stream_mode.3ssl index 5fb19c7b..6d94af22 100644 --- a/upstream/archlinux/man3/SSL_set_default_stream_mode.3ssl +++ b/upstream/archlinux/man3/SSL_set_default_stream_mode.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SET_DEFAULT_STREAM_MODE 3ssl" -.TH SSL_SET_DEFAULT_STREAM_MODE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SET_DEFAULT_STREAM_MODE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_set_fd.3ssl b/upstream/archlinux/man3/SSL_set_fd.3ssl index 1037faab..f0d427a0 100644 --- a/upstream/archlinux/man3/SSL_set_fd.3ssl +++ b/upstream/archlinux/man3/SSL_set_fd.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SET_FD 3ssl" -.TH SSL_SET_FD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SET_FD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_set_incoming_stream_policy.3ssl b/upstream/archlinux/man3/SSL_set_incoming_stream_policy.3ssl index d31407c9..278a1882 100644 --- a/upstream/archlinux/man3/SSL_set_incoming_stream_policy.3ssl +++ b/upstream/archlinux/man3/SSL_set_incoming_stream_policy.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SET_INCOMING_STREAM_POLICY 3ssl" -.TH SSL_SET_INCOMING_STREAM_POLICY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SET_INCOMING_STREAM_POLICY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_set_retry_verify.3ssl b/upstream/archlinux/man3/SSL_set_retry_verify.3ssl index 92cf4bbf..29afa438 100644 --- a/upstream/archlinux/man3/SSL_set_retry_verify.3ssl +++ b/upstream/archlinux/man3/SSL_set_retry_verify.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SET_RETRY_VERIFY 3ssl" -.TH SSL_SET_RETRY_VERIFY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SET_RETRY_VERIFY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -96,7 +96,7 @@ with the \fBX509_STORE_CTX\fR to call the \fBSSL_set_retry_verify()\fR function: \& \& /* this should not happen but check anyway */ \& if (idx < 0 -\& || (ssl = X509_STORE_CTX_get_ex_data(ctx, idx)) == NULL) +\& || (ssl = X509_STORE_CTX_get_ex_data(ctx, idx)) == NULL) \& return 0; \& \& if (/* we need to retry verification callback */) diff --git a/upstream/archlinux/man3/SSL_set_session.3ssl b/upstream/archlinux/man3/SSL_set_session.3ssl index 70d700cc..c821954b 100644 --- a/upstream/archlinux/man3/SSL_set_session.3ssl +++ b/upstream/archlinux/man3/SSL_set_session.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SET_SESSION 3ssl" -.TH SSL_SET_SESSION 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SET_SESSION 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_set_shutdown.3ssl b/upstream/archlinux/man3/SSL_set_shutdown.3ssl index 1d36f93e..b642caab 100644 --- a/upstream/archlinux/man3/SSL_set_shutdown.3ssl +++ b/upstream/archlinux/man3/SSL_set_shutdown.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SET_SHUTDOWN 3ssl" -.TH SSL_SET_SHUTDOWN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SET_SHUTDOWN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_set_verify_result.3ssl b/upstream/archlinux/man3/SSL_set_verify_result.3ssl index 286ed6f5..45c49cf5 100644 --- a/upstream/archlinux/man3/SSL_set_verify_result.3ssl +++ b/upstream/archlinux/man3/SSL_set_verify_result.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SET_VERIFY_RESULT 3ssl" -.TH SSL_SET_VERIFY_RESULT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SET_VERIFY_RESULT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_shutdown.3ssl b/upstream/archlinux/man3/SSL_shutdown.3ssl index 4e247457..2fa4a818 100644 --- a/upstream/archlinux/man3/SSL_shutdown.3ssl +++ b/upstream/archlinux/man3/SSL_shutdown.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_SHUTDOWN 3ssl" -.TH SSL_SHUTDOWN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_SHUTDOWN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_state_string.3ssl b/upstream/archlinux/man3/SSL_state_string.3ssl index 416e376c..b75000b4 100644 --- a/upstream/archlinux/man3/SSL_state_string.3ssl +++ b/upstream/archlinux/man3/SSL_state_string.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_STATE_STRING 3ssl" -.TH SSL_STATE_STRING 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_STATE_STRING 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_stream_conclude.3ssl b/upstream/archlinux/man3/SSL_stream_conclude.3ssl index e51646fa..5d5680a0 100644 --- a/upstream/archlinux/man3/SSL_stream_conclude.3ssl +++ b/upstream/archlinux/man3/SSL_stream_conclude.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_STREAM_CONCLUDE 3ssl" -.TH SSL_STREAM_CONCLUDE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_STREAM_CONCLUDE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_stream_reset.3ssl b/upstream/archlinux/man3/SSL_stream_reset.3ssl index f06a325c..f0bf1489 100644 --- a/upstream/archlinux/man3/SSL_stream_reset.3ssl +++ b/upstream/archlinux/man3/SSL_stream_reset.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_STREAM_RESET 3ssl" -.TH SSL_STREAM_RESET 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_STREAM_RESET 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_want.3ssl b/upstream/archlinux/man3/SSL_want.3ssl index 1f08f8b7..35b7b297 100644 --- a/upstream/archlinux/man3/SSL_want.3ssl +++ b/upstream/archlinux/man3/SSL_want.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "SSL_WANT 3ssl" -.TH SSL_WANT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_WANT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/SSL_write.3ssl b/upstream/archlinux/man3/SSL_write.3ssl index 3545df46..02c15c77 100644 --- a/upstream/archlinux/man3/SSL_write.3ssl +++ b/upstream/archlinux/man3/SSL_write.3ssl @@ -55,19 +55,25 @@ .\" ======================================================================== .\" .IX Title "SSL_WRITE 3ssl" -.TH SSL_WRITE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH SSL_WRITE 3ssl 2024-04-28 3.3.0 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 -SSL_write_ex, SSL_write, SSL_sendfile \- write bytes to a TLS/SSL connection +SSL_write_ex2, SSL_write_ex, SSL_write, SSL_sendfile, SSL_WRITE_FLAG_CONCLUDE \- +write bytes to a TLS/SSL connection .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/ssl.h> \& +\& #define SSL_WRITE_FLAG_CONCLUDE +\& \& ossl_ssize_t SSL_sendfile(SSL *s, int fd, off_t offset, size_t size, int flags); +\& int SSL_write_ex2(SSL *s, const void *buf, size_t num, +\& uint64_t flags, +\& size_t *written); \& int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written); \& int SSL_write(SSL *ssl, const void *buf, int num); .Ve @@ -77,6 +83,10 @@ SSL_write_ex, SSL_write, SSL_sendfile \- write bytes to a TLS/SSL connection the specified \fBssl\fR connection. On success \fBSSL_write_ex()\fR will store the number of bytes written in \fB*written\fR. .PP +\&\fBSSL_write_ex2()\fR functions similarly to \fBSSL_write_ex()\fR but can also accept +optional flags which modify its behaviour. Calling \fBSSL_write_ex2()\fR with a +\&\fIflags\fR argument of 0 is exactly equivalent to calling \fBSSL_write_ex()\fR. +.PP \&\fBSSL_sendfile()\fR writes \fBsize\fR bytes from offset \fBoffset\fR in the file descriptor \fBfd\fR to the specified SSL connection \fBs\fR. This function provides efficient zero-copy semantics. \fBSSL_sendfile()\fR is available only when @@ -84,6 +94,34 @@ Kernel TLS is enabled, which can be checked by calling \fBBIO_get_ktls_send()\fR It is provided here to allow users to maintain the same interface. The meaning of \fBflags\fR is platform dependent. Currently, under Linux it is ignored. +.PP +The \fIflags\fR argument to \fBSSL_write_ex2()\fR can accept zero or more of the +following flags. Note that which flags are supported will depend on the kind of +SSL object and underlying protocol being used: +.IP \fBSSL_WRITE_FLAG_CONCLUDE\fR 4 +.IX Item "SSL_WRITE_FLAG_CONCLUDE" +This flag is only supported on QUIC stream SSL objects (or QUIC connection SSL +objects with a default stream attached). +.Sp +If this flag is set, and the call to \fBSSL_write_ex2()\fR succeeds, and all of the +data passed to the call is written (meaning that \f(CW\*(C`*written == num\*(C'\fR), the +relevant QUIC stream's send part is concluded automatically as though +\&\fBSSL_stream_conclude\fR\|(3) was called (causing transmission of a FIN for the +stream). +.Sp +While using this flag is semantically equivalent to calling +\&\fBSSL_stream_conclude\fR\|(3) after a successful call to this function, using this +flag enables greater efficiency than making these two API calls separately, as +it enables the written stream data and the FIN flag indicating the end of the +stream to be scheduled as part of the same QUIC STREAM frame and QUIC packet. +.Sp +Setting this flag does not cause a stream's send part to be concluded if not all +of the data passed to the call was consumed. +.PP +A call to \fBSSL_write_ex2()\fR fails if a flag is passed which is not supported or +understood by the given SSL object. An application should determine if a flag is +supported (for example, for \fBSSL_WRITE_FLAG_CONCLUDE\fR, that a QUIC stream SSL +object is being used) before attempting to use it. .SH NOTES .IX Header "NOTES" In the paragraphs below a "write function" is defined as one of either @@ -145,16 +183,17 @@ You should not call \fBSSL_write()\fR with num=0, it will return an error. the peer. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fBSSL_write_ex()\fR will return 1 for success or 0 for failure. Success means that -all requested application data bytes have been written to the SSL connection or, -if SSL_MODE_ENABLE_PARTIAL_WRITE is in use, at least 1 application data byte has -been written to the SSL connection. Failure means that not all the requested -bytes have been written yet (if SSL_MODE_ENABLE_PARTIAL_WRITE is not in use) or -no bytes could be written to the SSL connection (if -SSL_MODE_ENABLE_PARTIAL_WRITE is in use). Failures can be retryable (e.g. the -network write buffer has temporarily filled up) or non-retryable (e.g. a fatal -network error). In the event of a failure call \fBSSL_get_error\fR\|(3) to find out -the reason which indicates whether the call is retryable or not. +\&\fBSSL_write_ex()\fR and \fBSSL_write_ex2()\fR return 1 for success or 0 for failure. +Success means that all requested application data bytes have been written to the +SSL connection or, if SSL_MODE_ENABLE_PARTIAL_WRITE is in use, at least 1 +application data byte has been written to the SSL connection. Failure means that +not all the requested bytes have been written yet (if +SSL_MODE_ENABLE_PARTIAL_WRITE is not in use) or no bytes could be written to the +SSL connection (if SSL_MODE_ENABLE_PARTIAL_WRITE is in use). Failures can be +retryable (e.g. the network write buffer has temporarily filled up) or +non-retryable (e.g. a fatal network error). In the event of a failure call +\&\fBSSL_get_error\fR\|(3) to find out the reason which indicates whether the call is +retryable or not. .PP For \fBSSL_write()\fR the following return values can occur: .IP "> 0" 4 @@ -195,7 +234,7 @@ The \fBSSL_write_ex()\fR function was added in OpenSSL 1.1.1. The \fBSSL_sendfile()\fR function was added in OpenSSL 3.0. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/TIMEVAL_TO_TIMESPEC.3 b/upstream/archlinux/man3/TIMEVAL_TO_TIMESPEC.3 new file mode 100644 index 00000000..0f23c000 --- /dev/null +++ b/upstream/archlinux/man3/TIMEVAL_TO_TIMESPEC.3 @@ -0,0 +1,32 @@ +.\" Copyright (C) 2024 Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: Linux-man-pages-copyleft +.\" +.TH TIMEVAL_TO_TIMESPEC 3 2024-05-02 "Linux man-pages 6.8" +.SH NAME +TIMEVAL_TO_TIMESPEC, +TIMESPEC_TO_TIMEVAL +\- +convert between time structures +.SH SYNOPSIS +.nf +.B #define _GNU_SOURCE +.B #include <sys/time.h> +.P +.BI "void TIMEVAL_TO_TIMESPEC(const struct timeval *" tv ", struct timespec *" ts ); +.BI "void TIMESPEC_TO_TIMEVAL(struct timeval *" tv ", const struct timespec *" ts ); +.fi +.SH DESCRIPTION +These macros convert from a +.BR timeval (3type) +to a +.BR timespec (3type) +structure, +and vice versa, +respectively. +.P +This is especially useful for writing interfaces that receive a type, +but are implemented with calls to functions that receive the other one. +.SH STANDARDS +GNU, +BSD. diff --git a/upstream/archlinux/man3/TS_RESP_CTX_new.3ssl b/upstream/archlinux/man3/TS_RESP_CTX_new.3ssl index 3e6cebb2..f186e0f6 100644 --- a/upstream/archlinux/man3/TS_RESP_CTX_new.3ssl +++ b/upstream/archlinux/man3/TS_RESP_CTX_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "TS_RESP_CTX_NEW 3ssl" -.TH TS_RESP_CTX_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH TS_RESP_CTX_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/TS_VERIFY_CTX_set_certs.3ssl b/upstream/archlinux/man3/TS_VERIFY_CTX_set_certs.3ssl index f74d4675..b4bdafd4 100644 --- a/upstream/archlinux/man3/TS_VERIFY_CTX_set_certs.3ssl +++ b/upstream/archlinux/man3/TS_VERIFY_CTX_set_certs.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "TS_VERIFY_CTX_SET_CERTS 3ssl" -.TH TS_VERIFY_CTX_SET_CERTS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH TS_VERIFY_CTX_SET_CERTS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/UI_STRING.3ssl b/upstream/archlinux/man3/UI_STRING.3ssl index 786bd911..b7821ef6 100644 --- a/upstream/archlinux/man3/UI_STRING.3ssl +++ b/upstream/archlinux/man3/UI_STRING.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "UI_STRING 3ssl" -.TH UI_STRING 3ssl 2024-01-30 3.2.1 OpenSSL +.TH UI_STRING 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/UI_UTIL_read_pw.3ssl b/upstream/archlinux/man3/UI_UTIL_read_pw.3ssl index 6767317d..4c4fec10 100644 --- a/upstream/archlinux/man3/UI_UTIL_read_pw.3ssl +++ b/upstream/archlinux/man3/UI_UTIL_read_pw.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "UI_UTIL_READ_PW 3ssl" -.TH UI_UTIL_READ_PW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH UI_UTIL_READ_PW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/UI_create_method.3ssl b/upstream/archlinux/man3/UI_create_method.3ssl index c3d9e23b..586acb5d 100644 --- a/upstream/archlinux/man3/UI_create_method.3ssl +++ b/upstream/archlinux/man3/UI_create_method.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "UI_CREATE_METHOD 3ssl" -.TH UI_CREATE_METHOD 3ssl 2024-01-30 3.2.1 OpenSSL +.TH UI_CREATE_METHOD 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/UI_new.3ssl b/upstream/archlinux/man3/UI_new.3ssl index 0163c9ac..d058ad9f 100644 --- a/upstream/archlinux/man3/UI_new.3ssl +++ b/upstream/archlinux/man3/UI_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "UI_NEW 3ssl" -.TH UI_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH UI_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509V3_get_d2i.3ssl b/upstream/archlinux/man3/X509V3_get_d2i.3ssl index 45921caf..ef9c4e8f 100644 --- a/upstream/archlinux/man3/X509V3_get_d2i.3ssl +++ b/upstream/archlinux/man3/X509V3_get_d2i.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509V3_GET_D2I 3ssl" -.TH X509V3_GET_D2I 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509V3_GET_D2I 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509V3_set_ctx.3ssl b/upstream/archlinux/man3/X509V3_set_ctx.3ssl index 5137252f..33ca77c2 100644 --- a/upstream/archlinux/man3/X509V3_set_ctx.3ssl +++ b/upstream/archlinux/man3/X509V3_set_ctx.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509V3_SET_CTX 3ssl" -.TH X509V3_SET_CTX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509V3_SET_CTX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_ALGOR_dup.3ssl b/upstream/archlinux/man3/X509_ALGOR_dup.3ssl index 30a56d34..1d0409cf 100644 --- a/upstream/archlinux/man3/X509_ALGOR_dup.3ssl +++ b/upstream/archlinux/man3/X509_ALGOR_dup.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_ALGOR_DUP 3ssl" -.TH X509_ALGOR_DUP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_ALGOR_DUP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_ATTRIBUTE.3ssl b/upstream/archlinux/man3/X509_ATTRIBUTE.3ssl index 2ca6bf6f..91760e1a 100644 --- a/upstream/archlinux/man3/X509_ATTRIBUTE.3ssl +++ b/upstream/archlinux/man3/X509_ATTRIBUTE.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_ATTRIBUTE 3ssl" -.TH X509_ATTRIBUTE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_ATTRIBUTE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_CRL_get0_by_serial.3ssl b/upstream/archlinux/man3/X509_CRL_get0_by_serial.3ssl index 263fa4a0..9157bf30 100644 --- a/upstream/archlinux/man3/X509_CRL_get0_by_serial.3ssl +++ b/upstream/archlinux/man3/X509_CRL_get0_by_serial.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_CRL_GET0_BY_SERIAL 3ssl" -.TH X509_CRL_GET0_BY_SERIAL 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_CRL_GET0_BY_SERIAL 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_EXTENSION_set_object.3ssl b/upstream/archlinux/man3/X509_EXTENSION_set_object.3ssl index c5d82401..459de124 100644 --- a/upstream/archlinux/man3/X509_EXTENSION_set_object.3ssl +++ b/upstream/archlinux/man3/X509_EXTENSION_set_object.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_EXTENSION_SET_OBJECT 3ssl" -.TH X509_EXTENSION_SET_OBJECT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_EXTENSION_SET_OBJECT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_LOOKUP.3ssl b/upstream/archlinux/man3/X509_LOOKUP.3ssl index b9e5a786..5b1ee8c7 100644 --- a/upstream/archlinux/man3/X509_LOOKUP.3ssl +++ b/upstream/archlinux/man3/X509_LOOKUP.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_LOOKUP 3ssl" -.TH X509_LOOKUP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_LOOKUP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_LOOKUP_hash_dir.3ssl b/upstream/archlinux/man3/X509_LOOKUP_hash_dir.3ssl index 1d9cfed5..dc046662 100644 --- a/upstream/archlinux/man3/X509_LOOKUP_hash_dir.3ssl +++ b/upstream/archlinux/man3/X509_LOOKUP_hash_dir.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_LOOKUP_HASH_DIR 3ssl" -.TH X509_LOOKUP_HASH_DIR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_LOOKUP_HASH_DIR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_LOOKUP_meth_new.3ssl b/upstream/archlinux/man3/X509_LOOKUP_meth_new.3ssl index ae67ee7f..876e8337 100644 --- a/upstream/archlinux/man3/X509_LOOKUP_meth_new.3ssl +++ b/upstream/archlinux/man3/X509_LOOKUP_meth_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_LOOKUP_METH_NEW 3ssl" -.TH X509_LOOKUP_METH_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_LOOKUP_METH_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_NAME_ENTRY_get_object.3ssl b/upstream/archlinux/man3/X509_NAME_ENTRY_get_object.3ssl index a71227a4..1ab5e7b1 100644 --- a/upstream/archlinux/man3/X509_NAME_ENTRY_get_object.3ssl +++ b/upstream/archlinux/man3/X509_NAME_ENTRY_get_object.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_NAME_ENTRY_GET_OBJECT 3ssl" -.TH X509_NAME_ENTRY_GET_OBJECT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_NAME_ENTRY_GET_OBJECT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_NAME_add_entry_by_txt.3ssl b/upstream/archlinux/man3/X509_NAME_add_entry_by_txt.3ssl index 61205dc0..0d948b5b 100644 --- a/upstream/archlinux/man3/X509_NAME_add_entry_by_txt.3ssl +++ b/upstream/archlinux/man3/X509_NAME_add_entry_by_txt.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_NAME_ADD_ENTRY_BY_TXT 3ssl" -.TH X509_NAME_ADD_ENTRY_BY_TXT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_NAME_ADD_ENTRY_BY_TXT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_NAME_get0_der.3ssl b/upstream/archlinux/man3/X509_NAME_get0_der.3ssl index 43a6c2c2..4e782d26 100644 --- a/upstream/archlinux/man3/X509_NAME_get0_der.3ssl +++ b/upstream/archlinux/man3/X509_NAME_get0_der.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_NAME_GET0_DER 3ssl" -.TH X509_NAME_GET0_DER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_NAME_GET0_DER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_NAME_get_index_by_NID.3ssl b/upstream/archlinux/man3/X509_NAME_get_index_by_NID.3ssl index f5ce1f49..7bc735ca 100644 --- a/upstream/archlinux/man3/X509_NAME_get_index_by_NID.3ssl +++ b/upstream/archlinux/man3/X509_NAME_get_index_by_NID.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_NAME_GET_INDEX_BY_NID 3ssl" -.TH X509_NAME_GET_INDEX_BY_NID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_NAME_GET_INDEX_BY_NID 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_NAME_print_ex.3ssl b/upstream/archlinux/man3/X509_NAME_print_ex.3ssl index 7fc00ea6..66d2514f 100644 --- a/upstream/archlinux/man3/X509_NAME_print_ex.3ssl +++ b/upstream/archlinux/man3/X509_NAME_print_ex.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_NAME_PRINT_EX 3ssl" -.TH X509_NAME_PRINT_EX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_NAME_PRINT_EX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_PUBKEY_new.3ssl b/upstream/archlinux/man3/X509_PUBKEY_new.3ssl index 63c05d35..b00551c3 100644 --- a/upstream/archlinux/man3/X509_PUBKEY_new.3ssl +++ b/upstream/archlinux/man3/X509_PUBKEY_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_PUBKEY_NEW 3ssl" -.TH X509_PUBKEY_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_PUBKEY_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_REQ_get_attr.3ssl b/upstream/archlinux/man3/X509_REQ_get_attr.3ssl index 56efcaa4..dd3bf7a5 100644 --- a/upstream/archlinux/man3/X509_REQ_get_attr.3ssl +++ b/upstream/archlinux/man3/X509_REQ_get_attr.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_REQ_GET_ATTR 3ssl" -.TH X509_REQ_GET_ATTR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_REQ_GET_ATTR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_REQ_get_extensions.3ssl b/upstream/archlinux/man3/X509_REQ_get_extensions.3ssl index a320fa0b..aa888834 100644 --- a/upstream/archlinux/man3/X509_REQ_get_extensions.3ssl +++ b/upstream/archlinux/man3/X509_REQ_get_extensions.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_REQ_GET_EXTENSIONS 3ssl" -.TH X509_REQ_GET_EXTENSIONS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_REQ_GET_EXTENSIONS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_SIG_get0.3ssl b/upstream/archlinux/man3/X509_SIG_get0.3ssl index 8bef3f80..dad2dfbb 100644 --- a/upstream/archlinux/man3/X509_SIG_get0.3ssl +++ b/upstream/archlinux/man3/X509_SIG_get0.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_SIG_GET0 3ssl" -.TH X509_SIG_GET0 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_SIG_GET0 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_STORE_CTX_get_by_subject.3ssl b/upstream/archlinux/man3/X509_STORE_CTX_get_by_subject.3ssl index 461079ba..08d3ad29 100644 --- a/upstream/archlinux/man3/X509_STORE_CTX_get_by_subject.3ssl +++ b/upstream/archlinux/man3/X509_STORE_CTX_get_by_subject.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_STORE_CTX_GET_BY_SUBJECT 3ssl" -.TH X509_STORE_CTX_GET_BY_SUBJECT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_STORE_CTX_GET_BY_SUBJECT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_STORE_CTX_get_error.3ssl b/upstream/archlinux/man3/X509_STORE_CTX_get_error.3ssl index 3360823f..b383be9b 100644 --- a/upstream/archlinux/man3/X509_STORE_CTX_get_error.3ssl +++ b/upstream/archlinux/man3/X509_STORE_CTX_get_error.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_STORE_CTX_GET_ERROR 3ssl" -.TH X509_STORE_CTX_GET_ERROR 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_STORE_CTX_GET_ERROR 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_STORE_CTX_new.3ssl b/upstream/archlinux/man3/X509_STORE_CTX_new.3ssl index 197da0d8..9dd6e3d7 100644 --- a/upstream/archlinux/man3/X509_STORE_CTX_new.3ssl +++ b/upstream/archlinux/man3/X509_STORE_CTX_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_STORE_CTX_NEW 3ssl" -.TH X509_STORE_CTX_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_STORE_CTX_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -142,7 +142,9 @@ is no longer valid. If \fIctx\fR is NULL nothing is done. .PP \&\fBX509_STORE_CTX_init()\fR sets up \fIctx\fR for a subsequent verification operation. -It must be called before each call to \fBX509_verify_cert\fR\|(3) or +.PP +\&\fBX509_STORE_CTX_init()\fR initializes the internal state and resources of the +X509_STORE_CTX, and must be called before each call to \fBX509_verify_cert\fR\|(3) or \&\fBX509_STORE_CTX_verify\fR\|(3), i.e., a context is only good for one verification. If you want to verify a further certificate or chain with the same \fIctx\fR then you must call \fBX509_STORE_CTX_init()\fR again. @@ -368,7 +370,7 @@ The \fBX509_STORE_CTX_init_rpk()\fR, \fBX509_STORE_CTX_get0_rpk()\fR, and There is no need to call \fBX509_STORE_CTX_cleanup()\fR explicitly since OpenSSL 3.0. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2009\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2009\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/X509_STORE_CTX_set_verify_cb.3ssl b/upstream/archlinux/man3/X509_STORE_CTX_set_verify_cb.3ssl index fe7f010c..5cd6b524 100644 --- a/upstream/archlinux/man3/X509_STORE_CTX_set_verify_cb.3ssl +++ b/upstream/archlinux/man3/X509_STORE_CTX_set_verify_cb.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_STORE_CTX_SET_VERIFY_CB 3ssl" -.TH X509_STORE_CTX_SET_VERIFY_CB 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_STORE_CTX_SET_VERIFY_CB 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_STORE_add_cert.3ssl b/upstream/archlinux/man3/X509_STORE_add_cert.3ssl index 3a28b6eb..9b1d0b79 100644 --- a/upstream/archlinux/man3/X509_STORE_add_cert.3ssl +++ b/upstream/archlinux/man3/X509_STORE_add_cert.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_STORE_ADD_CERT 3ssl" -.TH X509_STORE_ADD_CERT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_STORE_ADD_CERT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_STORE_get0_param.3ssl b/upstream/archlinux/man3/X509_STORE_get0_param.3ssl index 0375e487..9149bad8 100644 --- a/upstream/archlinux/man3/X509_STORE_get0_param.3ssl +++ b/upstream/archlinux/man3/X509_STORE_get0_param.3ssl @@ -55,14 +55,14 @@ .\" ======================================================================== .\" .IX Title "X509_STORE_GET0_PARAM 3ssl" -.TH X509_STORE_GET0_PARAM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_STORE_GET0_PARAM 3ssl 2024-04-28 3.3.0 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 X509_STORE_get0_param, X509_STORE_set1_param, -X509_STORE_get0_objects, X509_STORE_get1_all_certs +X509_STORE_get1_objects, X509_STORE_get0_objects, X509_STORE_get1_all_certs \&\- X509_STORE setter and getter functions .SH SYNOPSIS .IX Header "SYNOPSIS" @@ -71,6 +71,7 @@ X509_STORE_get0_objects, X509_STORE_get1_all_certs \& \& X509_VERIFY_PARAM *X509_STORE_get0_param(const X509_STORE *xs); \& int X509_STORE_set1_param(X509_STORE *xs, const X509_VERIFY_PARAM *pm); +\& STACK_OF(X509_OBJECT) *X509_STORE_get1_objects(X509_STORE *xs); \& STACK_OF(X509_OBJECT) *X509_STORE_get0_objects(const X509_STORE *xs); \& STACK_OF(X509) *X509_STORE_get1_all_certs(X509_STORE *xs); .Ve @@ -82,9 +83,15 @@ X509_STORE_get0_objects, X509_STORE_get1_all_certs parameters for \fIxs\fR. The returned pointer must not be freed by the calling application .PP +\&\fBX509_STORE_get1_objects()\fR returns a snapshot of all objects in the store's X509 +cache. The cache contains \fBX509\fR and \fBX509_CRL\fR objects. The caller is +responsible for freeing the returned list. +.PP \&\fBX509_STORE_get0_objects()\fR retrieves an internal pointer to the store's X509 object cache. The cache contains \fBX509\fR and \fBX509_CRL\fR objects. The -returned pointer must not be freed by the calling application. +returned pointer must not be freed by the calling application. If the store is +shared across multiple threads, it is not safe to use the result of this +function. Use \fBX509_STORE_get1_objects()\fR instead, which avoids this problem. .PP \&\fBX509_STORE_get1_all_certs()\fR returns a list of all certificates in the store. The caller is responsible for freeing the returned list. @@ -95,6 +102,9 @@ The caller is responsible for freeing the returned list. .PP \&\fBX509_STORE_set1_param()\fR returns 1 for success and 0 for failure. .PP +\&\fBX509_STORE_get1_objects()\fR returns a pointer to a stack of the retrieved +objects on success, else NULL. +.PP \&\fBX509_STORE_get0_objects()\fR returns a pointer to a stack of \fBX509_OBJECT\fR. .PP \&\fBX509_STORE_get1_all_certs()\fR returns a pointer to a stack of the retrieved @@ -107,9 +117,10 @@ certificates on success, else NULL. \&\fBX509_STORE_get0_param\fR and \fBX509_STORE_get0_objects\fR were added in OpenSSL 1.1.0. \&\fBX509_STORE_get1_certs\fR was added in OpenSSL 3.0. +\&\fBX509_STORE_get1_objects\fR was added in OpenSSL 3.3. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2016\-2020 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2016\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/X509_STORE_new.3ssl b/upstream/archlinux/man3/X509_STORE_new.3ssl index ccfea3c9..f47ce3ae 100644 --- a/upstream/archlinux/man3/X509_STORE_new.3ssl +++ b/upstream/archlinux/man3/X509_STORE_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_STORE_NEW 3ssl" -.TH X509_STORE_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_STORE_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_STORE_set_verify_cb_func.3ssl b/upstream/archlinux/man3/X509_STORE_set_verify_cb_func.3ssl index 5608e14d..19d7958c 100644 --- a/upstream/archlinux/man3/X509_STORE_set_verify_cb_func.3ssl +++ b/upstream/archlinux/man3/X509_STORE_set_verify_cb_func.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_STORE_SET_VERIFY_CB_FUNC 3ssl" -.TH X509_STORE_SET_VERIFY_CB_FUNC 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_STORE_SET_VERIFY_CB_FUNC 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_VERIFY_PARAM_set_flags.3ssl b/upstream/archlinux/man3/X509_VERIFY_PARAM_set_flags.3ssl index 5651fa24..c5577b93 100644 --- a/upstream/archlinux/man3/X509_VERIFY_PARAM_set_flags.3ssl +++ b/upstream/archlinux/man3/X509_VERIFY_PARAM_set_flags.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_VERIFY_PARAM_SET_FLAGS 3ssl" -.TH X509_VERIFY_PARAM_SET_FLAGS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_VERIFY_PARAM_SET_FLAGS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_add_cert.3ssl b/upstream/archlinux/man3/X509_add_cert.3ssl index e72871c3..137b0986 100644 --- a/upstream/archlinux/man3/X509_add_cert.3ssl +++ b/upstream/archlinux/man3/X509_add_cert.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_ADD_CERT 3ssl" -.TH X509_ADD_CERT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_ADD_CERT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_check_ca.3ssl b/upstream/archlinux/man3/X509_check_ca.3ssl index 9d2844dc..bf2a0dc9 100644 --- a/upstream/archlinux/man3/X509_check_ca.3ssl +++ b/upstream/archlinux/man3/X509_check_ca.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_CHECK_CA 3ssl" -.TH X509_CHECK_CA 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_CHECK_CA 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_check_host.3ssl b/upstream/archlinux/man3/X509_check_host.3ssl index 18060610..06ebfaf2 100644 --- a/upstream/archlinux/man3/X509_check_host.3ssl +++ b/upstream/archlinux/man3/X509_check_host.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_CHECK_HOST 3ssl" -.TH X509_CHECK_HOST 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_CHECK_HOST 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_check_issued.3ssl b/upstream/archlinux/man3/X509_check_issued.3ssl index 6c2fe43d..d5868853 100644 --- a/upstream/archlinux/man3/X509_check_issued.3ssl +++ b/upstream/archlinux/man3/X509_check_issued.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_CHECK_ISSUED 3ssl" -.TH X509_CHECK_ISSUED 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_CHECK_ISSUED 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_check_private_key.3ssl b/upstream/archlinux/man3/X509_check_private_key.3ssl index 36f7d66c..7ee00c03 100644 --- a/upstream/archlinux/man3/X509_check_private_key.3ssl +++ b/upstream/archlinux/man3/X509_check_private_key.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_CHECK_PRIVATE_KEY 3ssl" -.TH X509_CHECK_PRIVATE_KEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_CHECK_PRIVATE_KEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_check_purpose.3ssl b/upstream/archlinux/man3/X509_check_purpose.3ssl index 0f3908e3..f69afe86 100644 --- a/upstream/archlinux/man3/X509_check_purpose.3ssl +++ b/upstream/archlinux/man3/X509_check_purpose.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_CHECK_PURPOSE 3ssl" -.TH X509_CHECK_PURPOSE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_CHECK_PURPOSE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_cmp.3ssl b/upstream/archlinux/man3/X509_cmp.3ssl index 4dc85472..02ac0e24 100644 --- a/upstream/archlinux/man3/X509_cmp.3ssl +++ b/upstream/archlinux/man3/X509_cmp.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_CMP 3ssl" -.TH X509_CMP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_CMP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_cmp_time.3ssl b/upstream/archlinux/man3/X509_cmp_time.3ssl index c9063061..d5c6bfce 100644 --- a/upstream/archlinux/man3/X509_cmp_time.3ssl +++ b/upstream/archlinux/man3/X509_cmp_time.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_CMP_TIME 3ssl" -.TH X509_CMP_TIME 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_CMP_TIME 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_digest.3ssl b/upstream/archlinux/man3/X509_digest.3ssl index dface631..ff7b9890 100644 --- a/upstream/archlinux/man3/X509_digest.3ssl +++ b/upstream/archlinux/man3/X509_digest.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_DIGEST 3ssl" -.TH X509_DIGEST 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_DIGEST 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_dup.3ssl b/upstream/archlinux/man3/X509_dup.3ssl index f98403f1..29a6ff63 100644 --- a/upstream/archlinux/man3/X509_dup.3ssl +++ b/upstream/archlinux/man3/X509_dup.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_DUP 3ssl" -.TH X509_DUP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_DUP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_get0_distinguishing_id.3ssl b/upstream/archlinux/man3/X509_get0_distinguishing_id.3ssl index c5745e5c..60ef9000 100644 --- a/upstream/archlinux/man3/X509_get0_distinguishing_id.3ssl +++ b/upstream/archlinux/man3/X509_get0_distinguishing_id.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_GET0_DISTINGUISHING_ID 3ssl" -.TH X509_GET0_DISTINGUISHING_ID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_GET0_DISTINGUISHING_ID 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_get0_notBefore.3ssl b/upstream/archlinux/man3/X509_get0_notBefore.3ssl index 4e486b45..871a8b01 100644 --- a/upstream/archlinux/man3/X509_get0_notBefore.3ssl +++ b/upstream/archlinux/man3/X509_get0_notBefore.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_GET0_NOTBEFORE 3ssl" -.TH X509_GET0_NOTBEFORE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_GET0_NOTBEFORE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_get0_signature.3ssl b/upstream/archlinux/man3/X509_get0_signature.3ssl index 582e4cb8..35001ece 100644 --- a/upstream/archlinux/man3/X509_get0_signature.3ssl +++ b/upstream/archlinux/man3/X509_get0_signature.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_GET0_SIGNATURE 3ssl" -.TH X509_GET0_SIGNATURE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_GET0_SIGNATURE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_get0_uids.3ssl b/upstream/archlinux/man3/X509_get0_uids.3ssl index 0c3e2b3b..740c2a4e 100644 --- a/upstream/archlinux/man3/X509_get0_uids.3ssl +++ b/upstream/archlinux/man3/X509_get0_uids.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_GET0_UIDS 3ssl" -.TH X509_GET0_UIDS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_GET0_UIDS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_get_default_cert_file.3ssl b/upstream/archlinux/man3/X509_get_default_cert_file.3ssl index ff406241..554b7917 100644 --- a/upstream/archlinux/man3/X509_get_default_cert_file.3ssl +++ b/upstream/archlinux/man3/X509_get_default_cert_file.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_GET_DEFAULT_CERT_FILE 3ssl" -.TH X509_GET_DEFAULT_CERT_FILE 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_GET_DEFAULT_CERT_FILE 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_get_extension_flags.3ssl b/upstream/archlinux/man3/X509_get_extension_flags.3ssl index e92ef81b..7218c3a5 100644 --- a/upstream/archlinux/man3/X509_get_extension_flags.3ssl +++ b/upstream/archlinux/man3/X509_get_extension_flags.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_GET_EXTENSION_FLAGS 3ssl" -.TH X509_GET_EXTENSION_FLAGS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_GET_EXTENSION_FLAGS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_get_pubkey.3ssl b/upstream/archlinux/man3/X509_get_pubkey.3ssl index d54156f7..1cd2bdd8 100644 --- a/upstream/archlinux/man3/X509_get_pubkey.3ssl +++ b/upstream/archlinux/man3/X509_get_pubkey.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_GET_PUBKEY 3ssl" -.TH X509_GET_PUBKEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_GET_PUBKEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_get_serialNumber.3ssl b/upstream/archlinux/man3/X509_get_serialNumber.3ssl index ba599294..70d77444 100644 --- a/upstream/archlinux/man3/X509_get_serialNumber.3ssl +++ b/upstream/archlinux/man3/X509_get_serialNumber.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_GET_SERIALNUMBER 3ssl" -.TH X509_GET_SERIALNUMBER 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_GET_SERIALNUMBER 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_get_subject_name.3ssl b/upstream/archlinux/man3/X509_get_subject_name.3ssl index 47e55e8d..35d9ae75 100644 --- a/upstream/archlinux/man3/X509_get_subject_name.3ssl +++ b/upstream/archlinux/man3/X509_get_subject_name.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_GET_SUBJECT_NAME 3ssl" -.TH X509_GET_SUBJECT_NAME 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_GET_SUBJECT_NAME 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_get_version.3ssl b/upstream/archlinux/man3/X509_get_version.3ssl index aeb448f6..c2cbba2d 100644 --- a/upstream/archlinux/man3/X509_get_version.3ssl +++ b/upstream/archlinux/man3/X509_get_version.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_GET_VERSION 3ssl" -.TH X509_GET_VERSION 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_GET_VERSION 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_load_http.3ssl b/upstream/archlinux/man3/X509_load_http.3ssl index 553a022c..4320b697 100644 --- a/upstream/archlinux/man3/X509_load_http.3ssl +++ b/upstream/archlinux/man3/X509_load_http.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_LOAD_HTTP 3ssl" -.TH X509_LOAD_HTTP 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_LOAD_HTTP 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_new.3ssl b/upstream/archlinux/man3/X509_new.3ssl index 354e44cd..d4a9108b 100644 --- a/upstream/archlinux/man3/X509_new.3ssl +++ b/upstream/archlinux/man3/X509_new.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_NEW 3ssl" -.TH X509_NEW 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_NEW 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_sign.3ssl b/upstream/archlinux/man3/X509_sign.3ssl index fd44a730..c5800a50 100644 --- a/upstream/archlinux/man3/X509_sign.3ssl +++ b/upstream/archlinux/man3/X509_sign.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_SIGN 3ssl" -.TH X509_SIGN 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_SIGN 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_verify.3ssl b/upstream/archlinux/man3/X509_verify.3ssl index cba0d24b..da63ab62 100644 --- a/upstream/archlinux/man3/X509_verify.3ssl +++ b/upstream/archlinux/man3/X509_verify.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_VERIFY 3ssl" -.TH X509_VERIFY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_VERIFY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509_verify_cert.3ssl b/upstream/archlinux/man3/X509_verify_cert.3ssl index 7c033352..4b3c8a14 100644 --- a/upstream/archlinux/man3/X509_verify_cert.3ssl +++ b/upstream/archlinux/man3/X509_verify_cert.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509_VERIFY_CERT 3ssl" -.TH X509_VERIFY_CERT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509_VERIFY_CERT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/X509v3_get_ext_by_NID.3ssl b/upstream/archlinux/man3/X509v3_get_ext_by_NID.3ssl index 762b2b68..0a74577e 100644 --- a/upstream/archlinux/man3/X509v3_get_ext_by_NID.3ssl +++ b/upstream/archlinux/man3/X509v3_get_ext_by_NID.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "X509V3_GET_EXT_BY_NID 3ssl" -.TH X509V3_GET_EXT_BY_NID 3ssl 2024-01-30 3.2.1 OpenSSL +.TH X509V3_GET_EXT_BY_NID 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/_Generic.3 b/upstream/archlinux/man3/_Generic.3 index 04bd618e..7486a578 100644 --- a/upstream/archlinux/man3/_Generic.3 +++ b/upstream/archlinux/man3/_Generic.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH _Generic 3 2023-10-31 "Linux man-pages 6.06" +.TH _Generic 3 2024-05-02 "Linux man-pages 6.8" .SH NAME _Generic \- type-generic selection .SH SYNOPSIS diff --git a/upstream/archlinux/man3/__ppc_get_timebase.3 b/upstream/archlinux/man3/__ppc_get_timebase.3 index 9604c93d..354ccec2 100644 --- a/upstream/archlinux/man3/__ppc_get_timebase.3 +++ b/upstream/archlinux/man3/__ppc_get_timebase.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH __ppc_get_timebase 3 2023-10-31 "Linux man-pages 6.06" +.TH __ppc_get_timebase 3 2024-05-02 "Linux man-pages 6.8" .SH NAME __ppc_get_timebase, __ppc_get_timebase_freq \- get the current value of the Time Base Register on Power architecture and its frequency. diff --git a/upstream/archlinux/man3/__ppc_set_ppr_med.3 b/upstream/archlinux/man3/__ppc_set_ppr_med.3 index e0e9649e..282d560d 100644 --- a/upstream/archlinux/man3/__ppc_set_ppr_med.3 +++ b/upstream/archlinux/man3/__ppc_set_ppr_med.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH __ppc_set_ppr_med 3 2023-10-31 "Linux man-pages 6.06" +.TH __ppc_set_ppr_med 3 2024-05-02 "Linux man-pages 6.8" Programmer's Manual" .SH NAME __ppc_set_ppr_med, __ppc_set_ppr_very_low, __ppc_set_ppr_low, diff --git a/upstream/archlinux/man3/__ppc_yield.3 b/upstream/archlinux/man3/__ppc_yield.3 index f8b9ad12..5a9a0959 100644 --- a/upstream/archlinux/man3/__ppc_yield.3 +++ b/upstream/archlinux/man3/__ppc_yield.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH __ppc_yield 3 2023-10-31 "Linux man-pages 6.06" +.TH __ppc_yield 3 2024-05-02 "Linux man-pages 6.8" .SH NAME __ppc_yield, __ppc_mdoio, __ppc_mdoom \- Hint the processor to release shared resources diff --git a/upstream/archlinux/man3/__setfpucw.3 b/upstream/archlinux/man3/__setfpucw.3 index d132953c..c0d21abd 100644 --- a/upstream/archlinux/man3/__setfpucw.3 +++ b/upstream/archlinux/man3/__setfpucw.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH __setfpucw 3 2023-10-31 "Linux man-pages 6.06" +.TH __setfpucw 3 2024-05-02 "Linux man-pages 6.8" .SH NAME __setfpucw \- set FPU control word on i386 architecture (obsolete) .SH LIBRARY diff --git a/upstream/archlinux/man3/a64l.3 b/upstream/archlinux/man3/a64l.3 index c0bbcbc5..eb71e6ff 100644 --- a/upstream/archlinux/man3/a64l.3 +++ b/upstream/archlinux/man3/a64l.3 @@ -6,7 +6,7 @@ .\" .\" Corrected, aeb, 2002-05-30 .\" -.TH a64l 3 2023-10-31 "Linux man-pages 6.06" +.TH a64l 3 2024-05-02 "Linux man-pages 6.8" .SH NAME a64l, l64a \- convert between long and base-64 .SH LIBRARY diff --git a/upstream/archlinux/man3/abort.3 b/upstream/archlinux/man3/abort.3 index 048b30c5..c27a096f 100644 --- a/upstream/archlinux/man3/abort.3 +++ b/upstream/archlinux/man3/abort.3 @@ -12,7 +12,7 @@ .\" Modified Fri Aug 4 10:51:53 2000 - patch from Joseph S. Myers .\" 2007-12-15, mtk, Mostly rewritten .\" -.TH abort 3 2023-10-31 "Linux man-pages 6.06" +.TH abort 3 2024-05-02 "Linux man-pages 6.8" .SH NAME abort \- cause abnormal process termination .SH LIBRARY diff --git a/upstream/archlinux/man3/abs.3 b/upstream/archlinux/man3/abs.3 index 04383b48..d8900b47 100644 --- a/upstream/archlinux/man3/abs.3 +++ b/upstream/archlinux/man3/abs.3 @@ -12,7 +12,7 @@ .\" Modified Sat Jul 24 21:45:37 1993, Rik Faith (faith@cs.unc.edu) .\" Modified Sat Dec 16 15:02:59 2000, Joseph S. Myers .\" -.TH abs 3 2023-10-31 "Linux man-pages 6.06" +.TH abs 3 2024-05-02 "Linux man-pages 6.8" .SH NAME abs, labs, llabs, imaxabs \- compute the absolute value of an integer .SH LIBRARY diff --git a/upstream/archlinux/man3/acos.3 b/upstream/archlinux/man3/acos.3 index 8630053e..d7d5b65d 100644 --- a/upstream/archlinux/man3/acos.3 +++ b/upstream/archlinux/man3/acos.3 @@ -13,7 +13,7 @@ .\" Modified 2002-07-25 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH acos 3 2023-10-31 "Linux man-pages 6.06" +.TH acos 3 2024-05-02 "Linux man-pages 6.8" .SH NAME acos, acosf, acosl \- arc cosine function .SH LIBRARY diff --git a/upstream/archlinux/man3/acosh.3 b/upstream/archlinux/man3/acosh.3 index 97be4bfc..11e279cc 100644 --- a/upstream/archlinux/man3/acosh.3 +++ b/upstream/archlinux/man3/acosh.3 @@ -13,7 +13,7 @@ .\" Modified 2002-07-25 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH acosh 3 2023-10-31 "Linux man-pages 6.06" +.TH acosh 3 2024-05-02 "Linux man-pages 6.8" .SH NAME acosh, acoshf, acoshl \- inverse hyperbolic cosine function .SH LIBRARY diff --git a/upstream/archlinux/man3/addseverity.3 b/upstream/archlinux/man3/addseverity.3 index a634bdab..032a42fe 100644 --- a/upstream/archlinux/man3/addseverity.3 +++ b/upstream/archlinux/man3/addseverity.3 @@ -5,7 +5,7 @@ .\" adapted glibc info page .\" .\" polished a little, aeb -.TH addseverity 3 2023-10-31 "Linux man-pages 6.06" +.TH addseverity 3 2024-05-02 "Linux man-pages 6.8" .SH NAME addseverity \- introduce new severity classes .SH LIBRARY diff --git a/upstream/archlinux/man3/adjtime.3 b/upstream/archlinux/man3/adjtime.3 index a73ea605..49e7aac7 100644 --- a/upstream/archlinux/man3/adjtime.3 +++ b/upstream/archlinux/man3/adjtime.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH adjtime 3 2024-01-28 "Linux man-pages 6.06" +.TH adjtime 3 2024-05-02 "Linux man-pages 6.8" .SH NAME adjtime \- correct the time to synchronize the system clock .SH LIBRARY diff --git a/upstream/archlinux/man3/aio_cancel.3 b/upstream/archlinux/man3/aio_cancel.3 index 34ec553e..8f4b9d0b 100644 --- a/upstream/archlinux/man3/aio_cancel.3 +++ b/upstream/archlinux/man3/aio_cancel.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH aio_cancel 3 2023-10-31 "Linux man-pages 6.06" +.TH aio_cancel 3 2024-05-02 "Linux man-pages 6.8" .SH NAME aio_cancel \- cancel an outstanding asynchronous I/O request .SH LIBRARY diff --git a/upstream/archlinux/man3/aio_error.3 b/upstream/archlinux/man3/aio_error.3 index fb3818ae..0a36080a 100644 --- a/upstream/archlinux/man3/aio_error.3 +++ b/upstream/archlinux/man3/aio_error.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH aio_error 3 2023-10-31 "Linux man-pages 6.06" +.TH aio_error 3 2024-05-02 "Linux man-pages 6.8" .SH NAME aio_error \- get error status of asynchronous I/O operation .SH LIBRARY diff --git a/upstream/archlinux/man3/aio_fsync.3 b/upstream/archlinux/man3/aio_fsync.3 index 0ec0e829..42abefa1 100644 --- a/upstream/archlinux/man3/aio_fsync.3 +++ b/upstream/archlinux/man3/aio_fsync.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH aio_fsync 3 2023-10-31 "Linux man-pages 6.06" +.TH aio_fsync 3 2024-05-02 "Linux man-pages 6.8" .SH NAME aio_fsync \- asynchronous file synchronization .SH LIBRARY diff --git a/upstream/archlinux/man3/aio_init.3 b/upstream/archlinux/man3/aio_init.3 index 23fe15f4..f5414fc1 100644 --- a/upstream/archlinux/man3/aio_init.3 +++ b/upstream/archlinux/man3/aio_init.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH aio_init 3 2023-10-31 "Linux man-pages 6.06" +.TH aio_init 3 2024-05-02 "Linux man-pages 6.8" .SH NAME aio_init \- asynchronous I/O initialization .SH LIBRARY diff --git a/upstream/archlinux/man3/aio_read.3 b/upstream/archlinux/man3/aio_read.3 index 5af8717e..9b5321e7 100644 --- a/upstream/archlinux/man3/aio_read.3 +++ b/upstream/archlinux/man3/aio_read.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH aio_read 3 2023-10-31 "Linux man-pages 6.06" +.TH aio_read 3 2024-05-02 "Linux man-pages 6.8" .SH NAME aio_read \- asynchronous read .SH LIBRARY diff --git a/upstream/archlinux/man3/aio_return.3 b/upstream/archlinux/man3/aio_return.3 index f4e0d5aa..d8e20b55 100644 --- a/upstream/archlinux/man3/aio_return.3 +++ b/upstream/archlinux/man3/aio_return.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH aio_return 3 2023-10-31 "Linux man-pages 6.06" +.TH aio_return 3 2024-05-02 "Linux man-pages 6.8" .SH NAME aio_return \- get return status of asynchronous I/O operation .SH LIBRARY diff --git a/upstream/archlinux/man3/aio_suspend.3 b/upstream/archlinux/man3/aio_suspend.3 index d9ecfdcd..348f4aeb 100644 --- a/upstream/archlinux/man3/aio_suspend.3 +++ b/upstream/archlinux/man3/aio_suspend.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH aio_suspend 3 2023-10-31 "Linux man-pages 6.06" +.TH aio_suspend 3 2024-05-02 "Linux man-pages 6.8" .SH NAME aio_suspend \- wait for asynchronous I/O operation or timeout .SH LIBRARY diff --git a/upstream/archlinux/man3/aio_write.3 b/upstream/archlinux/man3/aio_write.3 index e1d70a7b..4bd947de 100644 --- a/upstream/archlinux/man3/aio_write.3 +++ b/upstream/archlinux/man3/aio_write.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH aio_write 3 2023-10-31 "Linux man-pages 6.06" +.TH aio_write 3 2024-05-02 "Linux man-pages 6.8" .SH NAME aio_write \- asynchronous write .SH LIBRARY diff --git a/upstream/archlinux/man3/alloca.3 b/upstream/archlinux/man3/alloca.3 index c49b525f..6e172b6e 100644 --- a/upstream/archlinux/man3/alloca.3 +++ b/upstream/archlinux/man3/alloca.3 @@ -13,7 +13,7 @@ .\" Various rewrites and additions (notes on longjmp() and SIGSEGV). .\" Weaken warning against use of alloca() (as per Debian bug 461100). .\" -.TH alloca 3 2023-10-31 "Linux man-pages 6.06" +.TH alloca 3 2024-05-02 "Linux man-pages 6.8" .SH NAME alloca \- allocate memory that is automatically freed .SH LIBRARY diff --git a/upstream/archlinux/man3/arc4random.3 b/upstream/archlinux/man3/arc4random.3 index 3b467bb9..37a264e6 100644 --- a/upstream/archlinux/man3/arc4random.3 +++ b/upstream/archlinux/man3/arc4random.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH arc4random 3 2023-10-31 "Linux man-pages 6.06" +.TH arc4random 3 2024-05-02 "Linux man-pages 6.8" .SH NAME arc4random, arc4random_uniform, arc4random_buf \- cryptographically-secure pseudorandom number generator diff --git a/upstream/archlinux/man3/argz_add.3 b/upstream/archlinux/man3/argz_add.3 index ca7f2a35..c530ee8b 100644 --- a/upstream/archlinux/man3/argz_add.3 +++ b/upstream/archlinux/man3/argz_add.3 @@ -6,7 +6,7 @@ .\" based on the description in glibc source and infopages .\" .\" Corrections and additions, aeb -.TH argz_add 3 2023-10-31 "Linux man-pages 6.06" +.TH argz_add 3 2024-05-02 "Linux man-pages 6.8" .SH NAME argz_add, argz_add_sep, argz_append, argz_count, argz_create, argz_create_sep, argz_delete, argz_extract, argz_insert, diff --git a/upstream/archlinux/man3/asin.3 b/upstream/archlinux/man3/asin.3 index 4c730eea..22277ec2 100644 --- a/upstream/archlinux/man3/asin.3 +++ b/upstream/archlinux/man3/asin.3 @@ -13,7 +13,7 @@ .\" Modified 2002-07-25 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH asin 3 2023-10-31 "Linux man-pages 6.06" +.TH asin 3 2024-05-02 "Linux man-pages 6.8" .SH NAME asin, asinf, asinl \- arc sine function .SH LIBRARY diff --git a/upstream/archlinux/man3/asinh.3 b/upstream/archlinux/man3/asinh.3 index 9b4d0067..3a14132e 100644 --- a/upstream/archlinux/man3/asinh.3 +++ b/upstream/archlinux/man3/asinh.3 @@ -13,7 +13,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH asinh 3 2023-10-31 "Linux man-pages 6.06" +.TH asinh 3 2024-05-02 "Linux man-pages 6.8" .SH NAME asinh, asinhf, asinhl \- inverse hyperbolic sine function .SH LIBRARY diff --git a/upstream/archlinux/man3/asprintf.3 b/upstream/archlinux/man3/asprintf.3 index 4d57ce45..a188a16c 100644 --- a/upstream/archlinux/man3/asprintf.3 +++ b/upstream/archlinux/man3/asprintf.3 @@ -5,7 +5,7 @@ .\" .\" Text fragments inspired by Martin Schulze <joey@infodrom.org>. .\" -.TH asprintf 3 2023-10-31 "Linux man-pages 6.06" +.TH asprintf 3 2024-05-02 "Linux man-pages 6.8" .SH NAME asprintf, vasprintf \- print to allocated string .SH LIBRARY diff --git a/upstream/archlinux/man3/assert.3 b/upstream/archlinux/man3/assert.3 index 68b23dc9..375cee25 100644 --- a/upstream/archlinux/man3/assert.3 +++ b/upstream/archlinux/man3/assert.3 @@ -6,7 +6,7 @@ .\" Modified Sat Jul 24 21:42:42 1993 by Rik Faith <faith@cs.unc.edu> .\" Modified Tue Oct 22 23:44:11 1996 by Eric S. Raymond <esr@thyrsus.com> .\" Modified Thu Jun 2 23:44:11 2016 by Nikos Mavrogiannopoulos <nmav@redhat.com> -.TH assert 3 2023-10-31 "Linux man-pages 6.06" +.TH assert 3 2024-05-02 "Linux man-pages 6.8" .SH NAME assert \- abort the program if assertion is false .SH LIBRARY diff --git a/upstream/archlinux/man3/assert_perror.3 b/upstream/archlinux/man3/assert_perror.3 index 09fbc927..ea577d8a 100644 --- a/upstream/archlinux/man3/assert_perror.3 +++ b/upstream/archlinux/man3/assert_perror.3 @@ -6,7 +6,7 @@ .\" This replaces an earlier man page written by Walter Harms .\" <walter.harms@informatik.uni-oldenburg.de>. .\" -.TH assert_perror 3 2023-10-31 "Linux man-pages 6.06" +.TH assert_perror 3 2024-05-02 "Linux man-pages 6.8" .SH NAME assert_perror \- test errnum and abort .SH LIBRARY diff --git a/upstream/archlinux/man3/atan.3 b/upstream/archlinux/man3/atan.3 index 5b923469..445887d8 100644 --- a/upstream/archlinux/man3/atan.3 +++ b/upstream/archlinux/man3/atan.3 @@ -13,7 +13,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH atan 3 2023-10-31 "Linux man-pages 6.06" +.TH atan 3 2024-05-02 "Linux man-pages 6.8" .SH NAME atan, atanf, atanl \- arc tangent function .SH LIBRARY diff --git a/upstream/archlinux/man3/atan2.3 b/upstream/archlinux/man3/atan2.3 index cb71d13c..f4befa37 100644 --- a/upstream/archlinux/man3/atan2.3 +++ b/upstream/archlinux/man3/atan2.3 @@ -13,7 +13,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH atan2 3 2023-10-31 "Linux man-pages 6.06" +.TH atan2 3 2024-05-02 "Linux man-pages 6.8" .SH NAME atan2, atan2f, atan2l \- arc tangent function of two variables .SH LIBRARY diff --git a/upstream/archlinux/man3/atanh.3 b/upstream/archlinux/man3/atanh.3 index eeed72d4..a1509f85 100644 --- a/upstream/archlinux/man3/atanh.3 +++ b/upstream/archlinux/man3/atanh.3 @@ -13,7 +13,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH atanh 3 2023-10-31 "Linux man-pages 6.06" +.TH atanh 3 2024-05-02 "Linux man-pages 6.8" .SH NAME atanh, atanhf, atanhl \- inverse hyperbolic tangent function .SH LIBRARY diff --git a/upstream/archlinux/man3/atexit.3 b/upstream/archlinux/man3/atexit.3 index b490dc20..9143b2f9 100644 --- a/upstream/archlinux/man3/atexit.3 +++ b/upstream/archlinux/man3/atexit.3 @@ -11,7 +11,7 @@ .\" Modified 1993-07-24, Rik Faith (faith@cs.unc.edu) .\" Modified 2003-10-25, Walter Harms .\" -.TH atexit 3 2023-10-31 "Linux man-pages 6.06" +.TH atexit 3 2024-05-02 "Linux man-pages 6.8" .SH NAME atexit \- register a function to be called at normal process termination .SH LIBRARY diff --git a/upstream/archlinux/man3/atof.3 b/upstream/archlinux/man3/atof.3 index f07a33c6..35de225a 100644 --- a/upstream/archlinux/man3/atof.3 +++ b/upstream/archlinux/man3/atof.3 @@ -9,7 +9,7 @@ .\" 386BSD man pages .\" Modified Mon Mar 29 22:39:24 1993, David Metcalfe .\" Modified Sat Jul 24 21:39:22 1993, Rik Faith (faith@cs.unc.edu) -.TH atof 3 2023-10-31 "Linux man-pages 6.06" +.TH atof 3 2024-05-02 "Linux man-pages 6.8" .SH NAME atof \- convert a string to a double .SH LIBRARY diff --git a/upstream/archlinux/man3/atoi.3 b/upstream/archlinux/man3/atoi.3 index e1cf820d..46a8017e 100644 --- a/upstream/archlinux/man3/atoi.3 +++ b/upstream/archlinux/man3/atoi.3 @@ -11,7 +11,7 @@ .\" Modified Sat Jul 24 21:38:42 1993, Rik Faith (faith@cs.unc.edu) .\" Modified Sun Dec 17 18:35:06 2000, Joseph S. Myers .\" -.TH atoi 3 2023-10-31 "Linux man-pages 6.06" +.TH atoi 3 2024-05-02 "Linux man-pages 6.8" .SH NAME atoi, atol, atoll \- convert a string to an integer .SH LIBRARY diff --git a/upstream/archlinux/man3/b2i_PVK_bio_ex.3ssl b/upstream/archlinux/man3/b2i_PVK_bio_ex.3ssl index 51d9aa97..683544d1 100644 --- a/upstream/archlinux/man3/b2i_PVK_bio_ex.3ssl +++ b/upstream/archlinux/man3/b2i_PVK_bio_ex.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "B2I_PVK_BIO_EX 3ssl" -.TH B2I_PVK_BIO_EX 3ssl 2024-01-30 3.2.1 OpenSSL +.TH B2I_PVK_BIO_EX 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/backtrace.3 b/upstream/archlinux/man3/backtrace.3 index 3160a05c..bee76d72 100644 --- a/upstream/archlinux/man3/backtrace.3 +++ b/upstream/archlinux/man3/backtrace.3 @@ -25,7 +25,7 @@ .\" .\" References: .\" glibc manual and source -.TH backtrace 3 2023-10-31 "Linux man-pages 6.06" +.TH backtrace 3 2024-05-02 "Linux man-pages 6.8" .SH NAME backtrace, backtrace_symbols, backtrace_symbols_fd \- support for application self-debugging diff --git a/upstream/archlinux/man3/basename.3 b/upstream/archlinux/man3/basename.3 index 3bb4c436..052258f6 100644 --- a/upstream/archlinux/man3/basename.3 +++ b/upstream/archlinux/man3/basename.3 @@ -5,7 +5,7 @@ .\" .\" Created, 14 Dec 2000 by Michael Kerrisk .\" -.TH basename 3 2023-10-31 "Linux man-pages 6.06" +.TH basename 3 2024-05-02 "Linux man-pages 6.8" .SH NAME basename, dirname \- parse pathname components .SH LIBRARY diff --git a/upstream/archlinux/man3/bcmp.3 b/upstream/archlinux/man3/bcmp.3 index 2de47ac0..0589b9c6 100644 --- a/upstream/archlinux/man3/bcmp.3 +++ b/upstream/archlinux/man3/bcmp.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH bcmp 3 2023-11-02 "Linux man-pages 6.06" +.TH bcmp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME bcmp \- compare byte sequences .SH LIBRARY diff --git a/upstream/archlinux/man3/bcopy.3 b/upstream/archlinux/man3/bcopy.3 index 3ed9c31c..c055c7a2 100644 --- a/upstream/archlinux/man3/bcopy.3 +++ b/upstream/archlinux/man3/bcopy.3 @@ -11,7 +11,7 @@ .\" Modified Sun Feb 26 14:52:00 1995 by Rik Faith <faith@cs.unc.edu> .\" Modified Tue Oct 22 23:48:10 1996 by Eric S. Raymond <esr@thyrsus.com> .\" " -.TH bcopy 3 2023-10-31 "Linux man-pages 6.06" +.TH bcopy 3 2024-05-02 "Linux man-pages 6.8" .SH NAME bcopy \- copy byte sequence .SH LIBRARY diff --git a/upstream/archlinux/man3/bind_textdomain_codeset.3 b/upstream/archlinux/man3/bind_textdomain_codeset.3 index 5414339b..80810932 100644 --- a/upstream/archlinux/man3/bind_textdomain_codeset.3 +++ b/upstream/archlinux/man3/bind_textdomain_codeset.3 @@ -10,7 +10,7 @@ .\" GNU gettext source code and manual .\" LI18NUX 2000 Globalization Specification .\" -.TH BIND_TEXTDOMAIN_CODESET 3 "May 2001" "GNU gettext 0.22.2" +.TH BIND_TEXTDOMAIN_CODESET 3 "May 2001" "GNU gettext 0.22.5" .SH NAME bind_textdomain_codeset \- set encoding of message translations .SH SYNOPSIS diff --git a/upstream/archlinux/man3/bindresvport.3 b/upstream/archlinux/man3/bindresvport.3 index 7b33d289..879a52bb 100644 --- a/upstream/archlinux/man3/bindresvport.3 +++ b/upstream/archlinux/man3/bindresvport.3 @@ -8,7 +8,7 @@ .\" 2007-05-31, mtk: Rewrite and substantial additional text. .\" 2008-12-03, mtk: Rewrote some pieces and fixed some errors .\" -.TH bindresvport 3 2023-10-31 "Linux man-pages 6.06" +.TH bindresvport 3 2024-05-02 "Linux man-pages 6.8" .SH NAME bindresvport \- bind a socket to a privileged IP port .SH LIBRARY diff --git a/upstream/archlinux/man3/bindtextdomain.3 b/upstream/archlinux/man3/bindtextdomain.3 index 03589b56..b6fe8701 100644 --- a/upstream/archlinux/man3/bindtextdomain.3 +++ b/upstream/archlinux/man3/bindtextdomain.3 @@ -10,7 +10,7 @@ .\" GNU gettext source code and manual .\" LI18NUX 2000 Globalization Specification .\" -.TH BINDTEXTDOMAIN 3 "May 2001" "GNU gettext 0.22.2" +.TH BINDTEXTDOMAIN 3 "May 2001" "GNU gettext 0.22.5" .SH NAME bindtextdomain \- set directory containing message catalogs .SH SYNOPSIS diff --git a/upstream/archlinux/man3/bsd_signal.3 b/upstream/archlinux/man3/bsd_signal.3 index 89a5d557..af2ca1f3 100644 --- a/upstream/archlinux/man3/bsd_signal.3 +++ b/upstream/archlinux/man3/bsd_signal.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH bsd_signal 3 2023-10-31 "Linux man-pages 6.06" +.TH bsd_signal 3 2024-05-02 "Linux man-pages 6.8" .SH NAME bsd_signal \- signal handling with BSD semantics .SH LIBRARY diff --git a/upstream/archlinux/man3/bsearch.3 b/upstream/archlinux/man3/bsearch.3 index 2f0a16ea..4f8e4054 100644 --- a/upstream/archlinux/man3/bsearch.3 +++ b/upstream/archlinux/man3/bsearch.3 @@ -9,7 +9,7 @@ .\" 386BSD man pages .\" Modified Mon Mar 29 22:41:16 1993, David Metcalfe .\" Modified Sat Jul 24 21:35:16 1993, Rik Faith (faith@cs.unc.edu) -.TH bsearch 3 2023-10-31 "Linux man-pages 6.06" +.TH bsearch 3 2024-05-02 "Linux man-pages 6.8" .SH NAME bsearch \- binary search of a sorted array .SH LIBRARY diff --git a/upstream/archlinux/man3/bstring.3 b/upstream/archlinux/man3/bstring.3 index 40f1b96b..bc2a8c7f 100644 --- a/upstream/archlinux/man3/bstring.3 +++ b/upstream/archlinux/man3/bstring.3 @@ -9,7 +9,7 @@ .\" Modified 1993-04-12, David Metcalfe .\" Modified 1993-07-24, Rik Faith (faith@cs.unc.edu) .\" Modified 2002-01-20, Walter Harms -.TH bstring 3 2023-10-31 "Linux man-pages 6.06" +.TH bstring 3 2024-05-02 "Linux man-pages 6.8" .SH NAME bcmp, bcopy, bzero, memccpy, memchr, memcmp, memcpy, memfrob, memmem, memmove, memset \- byte string operations diff --git a/upstream/archlinux/man3/bswap.3 b/upstream/archlinux/man3/bswap.3 index 8c2b8ea5..7df69ca6 100644 --- a/upstream/archlinux/man3/bswap.3 +++ b/upstream/archlinux/man3/bswap.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH bswap 3 2023-10-31 "Linux man-pages 6.06" +.TH bswap 3 2024-05-02 "Linux man-pages 6.8" .SH NAME bswap_16, bswap_32, bswap_64 \- reverse order of bytes .SH LIBRARY diff --git a/upstream/archlinux/man3/btowc.3 b/upstream/archlinux/man3/btowc.3 index 837f43ca..5f77b416 100644 --- a/upstream/archlinux/man3/btowc.3 +++ b/upstream/archlinux/man3/btowc.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH btowc 3 2023-10-31 "Linux man-pages 6.06" +.TH btowc 3 2024-05-02 "Linux man-pages 6.8" .SH NAME btowc \- convert single byte to wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/btree.3 b/upstream/archlinux/man3/btree.3 index 6c70974b..28ffd24e 100644 --- a/upstream/archlinux/man3/btree.3 +++ b/upstream/archlinux/man3/btree.3 @@ -5,7 +5,7 @@ .\" .\" @(#)btree.3 8.4 (Berkeley) 8/18/94 .\" -.TH btree 3 2023-10-31 "Linux man-pages 6.06" +.TH btree 3 2024-05-02 "Linux man-pages 6.8" .\".UC 7 .SH NAME btree \- btree database access method diff --git a/upstream/archlinux/man3/byteorder.3 b/upstream/archlinux/man3/byteorder.3 index a2062be5..039f2556 100644 --- a/upstream/archlinux/man3/byteorder.3 +++ b/upstream/archlinux/man3/byteorder.3 @@ -10,7 +10,7 @@ .\" Modified Sat Jul 24 21:29:05 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Thu Jul 26 14:06:20 2001 by Andries Brouwer (aeb@cwi.nl) .\" -.TH BYTEORDER 3 2023-10-31 "Linux man-pages 6.06" +.TH BYTEORDER 3 2024-05-02 "Linux man-pages 6.8" .SH NAME htonl, htons, ntohl, ntohs \- convert values between host and network byte order diff --git a/upstream/archlinux/man3/bzero.3 b/upstream/archlinux/man3/bzero.3 index 95cb5b88..08495b02 100644 --- a/upstream/archlinux/man3/bzero.3 +++ b/upstream/archlinux/man3/bzero.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH bzero 3 2023-10-31 "Linux man-pages 6.06" +.TH bzero 3 2024-05-02 "Linux man-pages 6.8" .SH NAME bzero, explicit_bzero \- zero a byte string .SH LIBRARY diff --git a/upstream/archlinux/man3/cabs.3 b/upstream/archlinux/man3/cabs.3 index ca3a637b..4ce66e2f 100644 --- a/upstream/archlinux/man3/cabs.3 +++ b/upstream/archlinux/man3/cabs.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH cabs 3 2023-10-31 "Linux man-pages 6.06" +.TH cabs 3 2024-05-02 "Linux man-pages 6.8" .SH NAME cabs, cabsf, cabsl \- absolute value of a complex number .SH LIBRARY diff --git a/upstream/archlinux/man3/cacos.3 b/upstream/archlinux/man3/cacos.3 index 74be4862..bcd5ec43 100644 --- a/upstream/archlinux/man3/cacos.3 +++ b/upstream/archlinux/man3/cacos.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH cacos 3 2023-10-31 "Linux man-pages 6.06" +.TH cacos 3 2024-05-02 "Linux man-pages 6.8" .SH NAME cacos, cacosf, cacosl \- complex arc cosine .SH LIBRARY diff --git a/upstream/archlinux/man3/cacosh.3 b/upstream/archlinux/man3/cacosh.3 index a16c82ea..416b4236 100644 --- a/upstream/archlinux/man3/cacosh.3 +++ b/upstream/archlinux/man3/cacosh.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH cacosh 3 2023-10-31 "Linux man-pages 6.06" +.TH cacosh 3 2024-05-02 "Linux man-pages 6.8" .SH NAME cacosh, cacoshf, cacoshl \- complex arc hyperbolic cosine .SH LIBRARY diff --git a/upstream/archlinux/man3/canonicalize_file_name.3 b/upstream/archlinux/man3/canonicalize_file_name.3 index 65b0ea8d..88ea269a 100644 --- a/upstream/archlinux/man3/canonicalize_file_name.3 +++ b/upstream/archlinux/man3/canonicalize_file_name.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH canonicalize_file_name 3 2023-10-31 "Linux man-pages 6.06" +.TH canonicalize_file_name 3 2024-05-02 "Linux man-pages 6.8" .SH NAME canonicalize_file_name \- return the canonicalized absolute pathname .SH LIBRARY diff --git a/upstream/archlinux/man3/carg.3 b/upstream/archlinux/man3/carg.3 index e96adc68..d9ffa9f9 100644 --- a/upstream/archlinux/man3/carg.3 +++ b/upstream/archlinux/man3/carg.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH carg 3 2023-10-31 "Linux man-pages 6.06" +.TH carg 3 2024-05-02 "Linux man-pages 6.8" .SH NAME carg, cargf, cargl \- calculate the complex argument .SH LIBRARY diff --git a/upstream/archlinux/man3/casin.3 b/upstream/archlinux/man3/casin.3 index 89c4463a..9f8bc466 100644 --- a/upstream/archlinux/man3/casin.3 +++ b/upstream/archlinux/man3/casin.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH casin 3 2023-10-31 "Linux man-pages 6.06" +.TH casin 3 2024-05-02 "Linux man-pages 6.8" .SH NAME casin, casinf, casinl \- complex arc sine .SH LIBRARY diff --git a/upstream/archlinux/man3/casinh.3 b/upstream/archlinux/man3/casinh.3 index a620132a..dbe409d4 100644 --- a/upstream/archlinux/man3/casinh.3 +++ b/upstream/archlinux/man3/casinh.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH casinh 3 2023-10-31 "Linux man-pages 6.06" +.TH casinh 3 2024-05-02 "Linux man-pages 6.8" .SH NAME casinh, casinhf, casinhl \- complex arc sine hyperbolic .SH LIBRARY diff --git a/upstream/archlinux/man3/catan.3 b/upstream/archlinux/man3/catan.3 index 22fa7f2a..2ad9a881 100644 --- a/upstream/archlinux/man3/catan.3 +++ b/upstream/archlinux/man3/catan.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH catan 3 2023-11-01 "Linux man-pages 6.06" +.TH catan 3 2024-05-02 "Linux man-pages 6.8" .SH NAME catan, catanf, catanl \- complex arc tangents .SH LIBRARY diff --git a/upstream/archlinux/man3/catanh.3 b/upstream/archlinux/man3/catanh.3 index 647737f9..692a44e7 100644 --- a/upstream/archlinux/man3/catanh.3 +++ b/upstream/archlinux/man3/catanh.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH catanh 3 2023-10-31 "Linux man-pages 6.06" +.TH catanh 3 2024-05-02 "Linux man-pages 6.8" .SH NAME catanh, catanhf, catanhl \- complex arc tangents hyperbolic .SH LIBRARY diff --git a/upstream/archlinux/man3/catgets.3 b/upstream/archlinux/man3/catgets.3 index a1c4cdba..e9c1e58f 100644 --- a/upstream/archlinux/man3/catgets.3 +++ b/upstream/archlinux/man3/catgets.3 @@ -4,7 +4,7 @@ .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" Updated, aeb, 980809 -.TH catgets 3 2023-10-31 "Linux man-pages 6.06" +.TH catgets 3 2024-05-02 "Linux man-pages 6.8" .SH NAME catgets \- get message from a message catalog .SH LIBRARY diff --git a/upstream/archlinux/man3/catopen.3 b/upstream/archlinux/man3/catopen.3 index f3e0c33c..69cb4b90 100644 --- a/upstream/archlinux/man3/catopen.3 +++ b/upstream/archlinux/man3/catopen.3 @@ -6,7 +6,7 @@ .\" Modified Thu Dec 13 22:51:19 2001 by Martin Schulze <joey@infodrom.org> .\" Modified 2001-12-14 aeb .\" -.TH catopen 3 2023-10-31 "Linux man-pages 6.06" +.TH catopen 3 2024-05-02 "Linux man-pages 6.8" .SH NAME catopen, catclose \- open/close a message catalog .SH LIBRARY diff --git a/upstream/archlinux/man3/cbrt.3 b/upstream/archlinux/man3/cbrt.3 index c11f9f27..8cfa6e67 100644 --- a/upstream/archlinux/man3/cbrt.3 +++ b/upstream/archlinux/man3/cbrt.3 @@ -8,7 +8,7 @@ .\" Modified 2002-07-27 Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH cbrt 3 2023-10-31 "Linux man-pages 6.06" +.TH cbrt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME cbrt, cbrtf, cbrtl \- cube root function .SH LIBRARY @@ -47,8 +47,11 @@ Feature Test Macro Requirements for glibc (see .SH DESCRIPTION These functions return the (real) cube root of .IR x . -This function cannot fail; every representable real value has a -representable real cube root. +This function cannot fail; +every representable real value +has a real cube root, +and rounding it to a representable value +never causes overflow nor underflow. .SH RETURN VALUE These functions return the cube root of .IR x . diff --git a/upstream/archlinux/man3/ccos.3 b/upstream/archlinux/man3/ccos.3 index 893a4816..e70e4ab9 100644 --- a/upstream/archlinux/man3/ccos.3 +++ b/upstream/archlinux/man3/ccos.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH ccos 3 2023-10-31 "Linux man-pages 6.06" +.TH ccos 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ccos, ccosf, ccosl \- complex cosine function .SH LIBRARY diff --git a/upstream/archlinux/man3/ccosh.3 b/upstream/archlinux/man3/ccosh.3 index 245f517a..b2970fa3 100644 --- a/upstream/archlinux/man3/ccosh.3 +++ b/upstream/archlinux/man3/ccosh.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH ccosh 3 2023-10-31 "Linux man-pages 6.06" +.TH ccosh 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ccosh, ccoshf, ccoshl \- complex hyperbolic cosine .SH LIBRARY diff --git a/upstream/archlinux/man3/ceil.3 b/upstream/archlinux/man3/ceil.3 index f9bddec1..05aa7996 100644 --- a/upstream/archlinux/man3/ceil.3 +++ b/upstream/archlinux/man3/ceil.3 @@ -5,7 +5,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH ceil 3 2023-10-31 "Linux man-pages 6.06" +.TH ceil 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ceil, ceilf, ceill \- ceiling function: smallest integral value not less than argument diff --git a/upstream/archlinux/man3/cexp.3 b/upstream/archlinux/man3/cexp.3 index 2b5655b4..5646bab4 100644 --- a/upstream/archlinux/man3/cexp.3 +++ b/upstream/archlinux/man3/cexp.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH cexp 3 2023-10-31 "Linux man-pages 6.06" +.TH cexp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME cexp, cexpf, cexpl \- complex exponential function .SH LIBRARY diff --git a/upstream/archlinux/man3/cexp2.3 b/upstream/archlinux/man3/cexp2.3 index 9a7c03c2..a844cf53 100644 --- a/upstream/archlinux/man3/cexp2.3 +++ b/upstream/archlinux/man3/cexp2.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH cexp2 3 2023-10-31 "Linux man-pages 6.06" +.TH cexp2 3 2024-05-02 "Linux man-pages 6.8" .SH NAME cexp2, cexp2f, cexp2l \- base-2 exponent of a complex number .SH LIBRARY diff --git a/upstream/archlinux/man3/cfree.3 b/upstream/archlinux/man3/cfree.3 index 657eb148..a1edb29b 100644 --- a/upstream/archlinux/man3/cfree.3 +++ b/upstream/archlinux/man3/cfree.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH cfree 3 2023-10-31 "Linux man-pages 6.06" +.TH cfree 3 2024-05-02 "Linux man-pages 6.8" .SH NAME cfree \- free allocated memory .SH LIBRARY diff --git a/upstream/archlinux/man3/cimag.3 b/upstream/archlinux/man3/cimag.3 index 17f4cd44..bf27226b 100644 --- a/upstream/archlinux/man3/cimag.3 +++ b/upstream/archlinux/man3/cimag.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH cimag 3 2023-10-31 "Linux man-pages 6.06" +.TH cimag 3 2024-05-02 "Linux man-pages 6.8" .SH NAME cimag, cimagf, cimagl \- get imaginary part of a complex number .SH LIBRARY diff --git a/upstream/archlinux/man3/circleq.3 b/upstream/archlinux/man3/circleq.3 index b446416f..5e6b08ea 100644 --- a/upstream/archlinux/man3/circleq.3 +++ b/upstream/archlinux/man3/circleq.3 @@ -5,7 +5,7 @@ .\" SPDX-License-Identifier: BSD-3-Clause .\" .\" -.TH CIRCLEQ 3 2023-10-31 "Linux man-pages 6.06" +.TH CIRCLEQ 3 2024-05-02 "Linux man-pages 6.8" .SH NAME CIRCLEQ_EMPTY, CIRCLEQ_ENTRY, diff --git a/upstream/archlinux/man3/clearenv.3 b/upstream/archlinux/man3/clearenv.3 index 08f23a41..37002d62 100644 --- a/upstream/archlinux/man3/clearenv.3 +++ b/upstream/archlinux/man3/clearenv.3 @@ -4,7 +4,7 @@ .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" Additions, aeb, 2001-10-17. -.TH clearenv 3 2023-10-31 "Linux man-pages 6.06" +.TH clearenv 3 2024-05-02 "Linux man-pages 6.8" .SH NAME clearenv \- clear the environment .SH LIBRARY diff --git a/upstream/archlinux/man3/clock.3 b/upstream/archlinux/man3/clock.3 index 6d8ace49..c2d51f01 100644 --- a/upstream/archlinux/man3/clock.3 +++ b/upstream/archlinux/man3/clock.3 @@ -7,7 +7,7 @@ .\" Modified 14 Jun 2002, Michael Kerrisk <mtk.manpages@gmail.com> .\" Added notes on differences from other UNIX systems with respect to .\" waited-for children. -.TH clock 3 2023-10-31 "Linux man-pages 6.06" +.TH clock 3 2024-05-02 "Linux man-pages 6.8" .SH NAME clock \- determine processor time .SH LIBRARY diff --git a/upstream/archlinux/man3/clock_getcpuclockid.3 b/upstream/archlinux/man3/clock_getcpuclockid.3 index ce9d3bd6..b64c1ba6 100644 --- a/upstream/archlinux/man3/clock_getcpuclockid.3 +++ b/upstream/archlinux/man3/clock_getcpuclockid.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH clock_getcpuclockid 3 2023-10-31 "Linux man-pages 6.06" +.TH clock_getcpuclockid 3 2024-05-02 "Linux man-pages 6.8" .SH NAME clock_getcpuclockid \- obtain ID of a process CPU-time clock .SH LIBRARY diff --git a/upstream/archlinux/man3/clog.3 b/upstream/archlinux/man3/clog.3 index 79c4d30f..45d2ae0d 100644 --- a/upstream/archlinux/man3/clog.3 +++ b/upstream/archlinux/man3/clog.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH clog 3 2023-10-31 "Linux man-pages 6.06" +.TH clog 3 2024-05-02 "Linux man-pages 6.8" .SH NAME clog, clogf, clogl \- natural logarithm of a complex number .SH LIBRARY diff --git a/upstream/archlinux/man3/clog10.3 b/upstream/archlinux/man3/clog10.3 index 1ff78e4f..fd083733 100644 --- a/upstream/archlinux/man3/clog10.3 +++ b/upstream/archlinux/man3/clog10.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH clog10 3 2023-10-31 "Linux man-pages 6.06" +.TH clog10 3 2024-05-02 "Linux man-pages 6.8" .SH NAME clog10, clog10f, clog10l \- base-10 logarithm of a complex number .SH LIBRARY diff --git a/upstream/archlinux/man3/clog2.3 b/upstream/archlinux/man3/clog2.3 index afe69401..afa0e2b3 100644 --- a/upstream/archlinux/man3/clog2.3 +++ b/upstream/archlinux/man3/clog2.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH clog2 3 2023-10-31 "Linux man-pages 6.06" +.TH clog2 3 2024-05-02 "Linux man-pages 6.8" .SH NAME clog2, clog2f, clog2l \- base-2 logarithm of a complex number .SH LIBRARY diff --git a/upstream/archlinux/man3/closedir.3 b/upstream/archlinux/man3/closedir.3 index f374e767..b885265e 100644 --- a/upstream/archlinux/man3/closedir.3 +++ b/upstream/archlinux/man3/closedir.3 @@ -9,7 +9,7 @@ .\" 386BSD man pages .\" Modified Sat Jul 24 21:25:52 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified 11 June 1995 by Andries Brouwer (aeb@cwi.nl) -.TH closedir 3 2023-10-31 "Linux man-pages 6.06" +.TH closedir 3 2024-05-02 "Linux man-pages 6.8" .SH NAME closedir \- close a directory .SH LIBRARY diff --git a/upstream/archlinux/man3/cmsg.3 b/upstream/archlinux/man3/cmsg.3 index 6efbcbb7..ef0c77ef 100644 --- a/upstream/archlinux/man3/cmsg.3 +++ b/upstream/archlinux/man3/cmsg.3 @@ -3,7 +3,7 @@ .\" This man page is Copyright (C) 1999 Andi Kleen <ak@muc.de>. .\" .\" $Id: cmsg.3,v 1.8 2000/12/20 18:10:31 ak Exp $ -.TH CMSG 3 2023-10-31 "Linux man-pages 6.06" +.TH CMSG 3 2024-05-02 "Linux man-pages 6.8" .SH NAME CMSG_ALIGN, CMSG_SPACE, CMSG_NXTHDR, CMSG_FIRSTHDR \- access ancillary data .SH LIBRARY diff --git a/upstream/archlinux/man3/confstr.3 b/upstream/archlinux/man3/confstr.3 index d549e7fe..20da873b 100644 --- a/upstream/archlinux/man3/confstr.3 +++ b/upstream/archlinux/man3/confstr.3 @@ -11,7 +11,7 @@ .\" These should all be added to this page. .\" See also the POSIX.1-2001 specification of confstr() .\" -.TH confstr 3 2023-10-31 "Linux man-pages 6.06" +.TH confstr 3 2024-05-02 "Linux man-pages 6.8" .SH NAME confstr \- get configuration dependent string variables .SH LIBRARY diff --git a/upstream/archlinux/man3/conj.3 b/upstream/archlinux/man3/conj.3 index 475c2703..4a500e5a 100644 --- a/upstream/archlinux/man3/conj.3 +++ b/upstream/archlinux/man3/conj.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH conj 3 2023-10-31 "Linux man-pages 6.06" +.TH conj 3 2024-05-02 "Linux man-pages 6.8" .SH NAME conj, conjf, conjl \- calculate the complex conjugate .SH LIBRARY diff --git a/upstream/archlinux/man3/copysign.3 b/upstream/archlinux/man3/copysign.3 index c76cebe5..6e3f1118 100644 --- a/upstream/archlinux/man3/copysign.3 +++ b/upstream/archlinux/man3/copysign.3 @@ -9,7 +9,7 @@ .\" 386BSD man pages .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu) .\" Modified 2002-08-10 by Walter Harms (walter.harms@informatik.uni-oldenburg.de) -.TH copysign 3 2023-10-31 "Linux man-pages 6.06" +.TH copysign 3 2024-05-02 "Linux man-pages 6.8" .SH NAME copysign, copysignf, copysignl \- copy sign of a number .SH LIBRARY diff --git a/upstream/archlinux/man3/cos.3 b/upstream/archlinux/man3/cos.3 index 843d9c45..eda786a8 100644 --- a/upstream/archlinux/man3/cos.3 +++ b/upstream/archlinux/man3/cos.3 @@ -12,7 +12,7 @@ .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu) .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) -.TH cos 3 2023-10-31 "Linux man-pages 6.06" +.TH cos 3 2024-05-02 "Linux man-pages 6.8" .SH NAME cos, cosf, cosl \- cosine function .SH LIBRARY diff --git a/upstream/archlinux/man3/cosh.3 b/upstream/archlinux/man3/cosh.3 index 2f3d6efc..d21e1edd 100644 --- a/upstream/archlinux/man3/cosh.3 +++ b/upstream/archlinux/man3/cosh.3 @@ -14,7 +14,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH cosh 3 2023-10-31 "Linux man-pages 6.06" +.TH cosh 3 2024-05-02 "Linux man-pages 6.8" .SH NAME cosh, coshf, coshl \- hyperbolic cosine function .SH LIBRARY diff --git a/upstream/archlinux/man3/cpow.3 b/upstream/archlinux/man3/cpow.3 index f7a22df0..f14c725b 100644 --- a/upstream/archlinux/man3/cpow.3 +++ b/upstream/archlinux/man3/cpow.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH cpow 3 2023-10-31 "Linux man-pages 6.06" +.TH cpow 3 2024-05-02 "Linux man-pages 6.8" .SH NAME cpow, cpowf, cpowl \- complex power function .SH LIBRARY diff --git a/upstream/archlinux/man3/cproj.3 b/upstream/archlinux/man3/cproj.3 index 0b015638..b9d7b1ea 100644 --- a/upstream/archlinux/man3/cproj.3 +++ b/upstream/archlinux/man3/cproj.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH cproj 3 2023-10-31 "Linux man-pages 6.06" +.TH cproj 3 2024-05-02 "Linux man-pages 6.8" .SH NAME cproj, cprojf, cprojl \- project into Riemann Sphere .SH LIBRARY diff --git a/upstream/archlinux/man3/creal.3 b/upstream/archlinux/man3/creal.3 index 77e79a93..f1db9f65 100644 --- a/upstream/archlinux/man3/creal.3 +++ b/upstream/archlinux/man3/creal.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH creal 3 2023-10-31 "Linux man-pages 6.06" +.TH creal 3 2024-05-02 "Linux man-pages 6.8" .SH NAME creal, crealf, creall \- get real part of a complex number .SH LIBRARY diff --git a/upstream/archlinux/man3/csin.3 b/upstream/archlinux/man3/csin.3 index 4a09ef20..efff4fb2 100644 --- a/upstream/archlinux/man3/csin.3 +++ b/upstream/archlinux/man3/csin.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH csin 3 2023-10-31 "Linux man-pages 6.06" +.TH csin 3 2024-05-02 "Linux man-pages 6.8" .SH NAME csin, csinf, csinl \- complex sine function .SH LIBRARY diff --git a/upstream/archlinux/man3/csinh.3 b/upstream/archlinux/man3/csinh.3 index 8dd07042..0dc66067 100644 --- a/upstream/archlinux/man3/csinh.3 +++ b/upstream/archlinux/man3/csinh.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH csinh 3 2023-10-31 "Linux man-pages 6.06" +.TH csinh 3 2024-05-02 "Linux man-pages 6.8" .SH NAME csinh, csinhf, csinhl \- complex hyperbolic sine .SH LIBRARY diff --git a/upstream/archlinux/man3/csqrt.3 b/upstream/archlinux/man3/csqrt.3 index d2060fff..34838d63 100644 --- a/upstream/archlinux/man3/csqrt.3 +++ b/upstream/archlinux/man3/csqrt.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH csqrt 3 2023-10-31 "Linux man-pages 6.06" +.TH csqrt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME csqrt, csqrtf, csqrtl \- complex square root .SH LIBRARY diff --git a/upstream/archlinux/man3/ctan.3 b/upstream/archlinux/man3/ctan.3 index fe46a735..0dec6493 100644 --- a/upstream/archlinux/man3/ctan.3 +++ b/upstream/archlinux/man3/ctan.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH ctan 3 2023-10-31 "Linux man-pages 6.06" +.TH ctan 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ctan, ctanf, ctanl \- complex tangent function .SH LIBRARY diff --git a/upstream/archlinux/man3/ctanh.3 b/upstream/archlinux/man3/ctanh.3 index 360c8352..9f6f244f 100644 --- a/upstream/archlinux/man3/ctanh.3 +++ b/upstream/archlinux/man3/ctanh.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH ctanh 3 2023-10-31 "Linux man-pages 6.06" +.TH ctanh 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ctanh, ctanhf, ctanhl \- complex hyperbolic tangent .SH LIBRARY diff --git a/upstream/archlinux/man3/ctermid.3 b/upstream/archlinux/man3/ctermid.3 index abd1719f..ed73d030 100644 --- a/upstream/archlinux/man3/ctermid.3 +++ b/upstream/archlinux/man3/ctermid.3 @@ -4,7 +4,7 @@ .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" Modified Sat Jul 24 19:51:06 1993 by Rik Faith (faith@cs.unc.edu) -.TH ctermid 3 2023-10-31 "Linux man-pages 6.06" +.TH ctermid 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ctermid \- get controlling terminal name .SH LIBRARY diff --git a/upstream/archlinux/man3/ctime.3 b/upstream/archlinux/man3/ctime.3 index e2d1c079..ec4bb124 100644 --- a/upstream/archlinux/man3/ctime.3 +++ b/upstream/archlinux/man3/ctime.3 @@ -13,7 +13,7 @@ .\" Modified 2001-12-13, joey, aeb .\" Modified 2004-11-16, mtk .\" -.TH ctime 3 2023-10-31 "Linux man-pages 6.06" +.TH ctime 3 2024-05-02 "Linux man-pages 6.8" .SH NAME asctime, ctime, gmtime, localtime, mktime, asctime_r, ctime_r, gmtime_r, localtime_r \- transform date and time to broken-down time or ASCII diff --git a/upstream/archlinux/man3/curs_add_wch.3x b/upstream/archlinux/man3/curs_add_wch.3x index 26d82e00..13b798bf 100644 --- a/upstream/archlinux/man3/curs_add_wch.3x +++ b/upstream/archlinux/man3/curs_add_wch.3x @@ -1,5 +1,6 @@ +'\" t .\"*************************************************************************** -.\" Copyright 2019-2021,2023 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 2001-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,42 +28,45 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_add_wch.3x,v 1.32 2023/03/11 20:40:45 tom Exp $ -.TH curs_add_wch 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_add_wch.3x,v 1.62 2024/04/20 21:20:07 tom Exp $ +.TH curs_add_wch 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBadd_wch\fP, -\fBwadd_wch\fP, -\fBmvadd_wch\fP, -\fBmvwadd_wch\fP, -\fBecho_wchar\fP, -\fBwecho_wchar\fP \- add a complex character and rendition to a \fBcurses\fP window, then advance the cursor +\fB\%add_wch\fP, +\fB\%wadd_wch\fP, +\fB\%mvadd_wch\fP, +\fB\%mvwadd_wch\fP, +\fB\%echo_wchar\fP, +\fB\%wecho_wchar\fP \- +add a \fIcurses\fR complex character to a window and advance the cursor .SH SYNOPSIS +.nf +\fB#include <curses.h> .PP -\fB#include <curses.h>\fP -.sp -.B "int add_wch( const cchar_t *\fIwch\fB );" -.br -.B "int wadd_wch( WINDOW *\fIwin\fP, const cchar_t *\fIwch\fB );" -.br -.B "int mvadd_wch( int \fIy\fP, int \fIx\fP, const cchar_t *\fIwch\fB );" -.br -.B "int mvwadd_wch( WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const cchar_t *\fIwch\fB );" -.sp -.B "int echo_wchar( const cchar_t *\fIwch\fB );" -.br -.B "int wecho_wchar( WINDOW *\fIwin\fP, const cchar_t *\fIwch\fB );" -.br +\fBint add_wch(const cchar_t *\fIwch\fP); +\fBint wadd_wch(WINDOW *\fIwin\fP, const cchar_t *\fIwch\fP); +\fBint mvadd_wch(int \fIy\fP, int \fIx\fP, const cchar_t *\fIwch\fP); +\fBint mvwadd_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const cchar_t *\fIwch\fP); +.PP +\fBint echo_wchar(const cchar_t *\fIwch\fP); +\fBint wecho_wchar(WINDOW *\fIwin\fP, const cchar_t *\fIwch\fP); +.fi .SH DESCRIPTION .SS add_wch -.PP The \fBadd_wch\fP, \fBwadd_wch\fP, @@ -78,25 +82,31 @@ If \fIwch\fP refers to a spacing character, then any previous character at that location is removed. A new character specified by \fIwch\fP is placed at that location with rendition specified by \fIwch\fP. -The cursor then advances to -the next spacing character on the screen. +The cursor then advances after this spacing character, +to prepare for writing the next character on the screen. +.IP +The newly added spacing character is the base of the active complex character. +Subsequent non-spacing characters can be combined with this base +until another spacing character is written to the screen, +or the cursor is moved, e.g., using \fBwmove\fP. .bP If \fIwch\fP refers to a non-spacing character, -all previous characters at that location are preserved. -The non-spacing characters of \fIwch\fP -are added to the spacing complex character, -and the rendition specified by \fIwch\fP is ignored. +it is appended to the active complex character, +retaining the previous characters at that location. +The rendition specified by \fIwch\fP is ignored. +.IP +The cursor is not advanced after adding a non-spacing character. +Subsequent calls to add non-spacing characters will update the same position. .bP If the character part of \fIwch\fP is a tab, newline, backspace or other control character, the window is updated and the cursor moves as if \fBaddch\fP were called. .SS echo_wchar -.PP The \fBecho_wchar\fP function is functionally equivalent to a call to \fBadd_wch\fP followed by a call to -\fBrefresh\fP(3X). +\fB\%refresh\fP(3X). Similarly, the \fBwecho_wchar\fP is functionally equivalent to a call to @@ -107,99 +117,171 @@ The knowledge that only a single character is being output is taken into consideration and, for non-control characters, a considerable performance gain might be seen by using the *\fBecho\fP* functions instead of their equivalents. -.SS Line Graphics -Like \fBaddch\fP(3X), +.SS "Line Graphics" +Like \fB\%addch\fP(3X), \fBaddch_wch\fP accepts symbols which make it simple to draw lines and other frequently used special characters. These symbols correspond to the same VT100 line-drawing set as -\fBaddch\fP(3X). +\fB\%addch\fP(3X). .PP .TS -l l l l l -l l l l l -_ _ _ _ _ -lw(1.5i) lw5 lw5 lw5 lw20. -\fBACS\fP \fBUnicode\fP \fBASCII\fP \fBacsc\fP \fBGlyph\fP -\fBName\fP \fBDefault\fP \fBDefault\fP \fBchar\fP \fBName\fP -WACS_BLOCK 0x25ae # 0 solid square block -WACS_BOARD 0x2592 # h board of squares -WACS_BTEE 0x2534 + v bottom tee -WACS_BULLET 0x00b7 o ~ bullet -WACS_CKBOARD 0x2592 : a checker board (stipple) -WACS_DARROW 0x2193 v . arrow pointing down -WACS_DEGREE 0x00b0 ' f degree symbol -WACS_DIAMOND 0x25c6 + ` diamond -WACS_GEQUAL 0x2265 > > greater-than-or-equal-to -WACS_HLINE 0x2500 \- q horizontal line -WACS_LANTERN 0x2603 # i lantern symbol -WACS_LARROW 0x2190 < , arrow pointing left -WACS_LEQUAL 0x2264 < y less-than-or-equal-to -WACS_LLCORNER 0x2514 + m lower left-hand corner -WACS_LRCORNER 0x2518 + j lower right-hand corner -WACS_LTEE 0x2524 + t left tee -WACS_NEQUAL 0x2260 ! | not-equal -WACS_PI 0x03c0 * { greek pi -WACS_PLMINUS 0x00b1 # g plus/minus -WACS_PLUS 0x253c + n plus -WACS_RARROW 0x2192 > + arrow pointing right -WACS_RTEE 0x251c + u right tee -WACS_S1 0x23ba \- o scan line 1 -WACS_S3 0x23bb \- p scan line 3 -WACS_S7 0x23bc \- r scan line 7 -WACS_S9 0x23bd \&_ s scan line 9 -WACS_STERLING 0x00a3 f } pound-sterling symbol -WACS_TTEE 0x252c + w top tee -WACS_UARROW 0x2191 ^ \- arrow pointing up -WACS_ULCORNER 0x250c + l upper left-hand corner -WACS_URCORNER 0x2510 + k upper right-hand corner -WACS_VLINE 0x2502 | x vertical line +Lb Lb Lb Lb Lb +Lb Lb Lb Lb Lb +Lb L L L Lx. +\& Unicode ASCII acsc \& +ACS Name Default Default Char Glyph Name +_ +WACS_BLOCK 0x25ae # 0 T{ +solid square block +T} +WACS_BOARD 0x2592 # h board of squares +WACS_BTEE 0x2534 + v bottom tee +WACS_BULLET 0x00b7 o ~ bullet +WACS_CKBOARD 0x2592 : a T{ +checker board (stipple) +T} +WACS_DARROW 0x2193 v . T{ +arrow pointing down +T} +WACS_DEGREE 0x00b0 ' f degree symbol +WACS_DIAMOND 0x25c6 + \(ga diamond +WACS_GEQUAL 0x2265 > > T{ +greater-than-or-equal-to +T} +WACS_HLINE 0x2500 \- q horizontal line +WACS_LANTERN 0x2603 # i lantern symbol +WACS_LARROW 0x2190 < , T{ +arrow pointing left +T} +WACS_LEQUAL 0x2264 < y T{ +less-than-or-equal-to +T} +WACS_LLCORNER 0x2514 + m T{ +lower left-hand corner +T} +WACS_LRCORNER 0x2518 + j T{ +lower right-hand corner +T} +WACS_LTEE 0x2524 + t left tee +WACS_NEQUAL 0x2260 ! | not-equal +WACS_PI 0x03c0 * { greek pi +WACS_PLMINUS 0x00b1 # g plus/minus +WACS_PLUS 0x253c + n plus +WACS_RARROW 0x2192 > + T{ +arrow pointing right +T} +WACS_RTEE 0x251c + u right tee +WACS_S1 0x23ba \- o scan line 1 +WACS_S3 0x23bb \- p scan line 3 +WACS_S7 0x23bc \- r scan line 7 +WACS_S9 0x23bd \&_ s scan line 9 +WACS_STERLING 0x00a3 f } T{ +pound-sterling symbol +T} +WACS_TTEE 0x252c + w top tee +WACS_UARROW 0x2191 ^ \- T{ +arrow pointing up +T} +WACS_ULCORNER 0x250c + l T{ +upper left-hand corner +T} +WACS_URCORNER 0x2510 + k T{ +upper right-hand corner +T} +WACS_VLINE 0x2502 | x vertical line .TE .PP -The wide-character configuration of ncurses also defines symbols +The wide-character configuration of \fI\%ncurses\fP also defines symbols for thick lines (\fBacsc\fP \*(``J\*('' to \*(``V\*(''): +.PP .TS -l l l l l -l l l l l -_ _ _ _ _ -lw(1.5i) lw5 lw5 lw5 lw20. -\fBACS\fP \fBUnicode\fP \fBASCII\fP \fBacsc\fP \fBGlyph\fP -\fBName\fP \fBDefault\fP \fBDefault\fP \fBchar\fP \fBName\fP -WACS_T_BTEE 0x253b + V thick tee pointing up -WACS_T_HLINE 0x2501 - Q thick horizontal line -WACS_T_LLCORNER 0x2517 + M thick lower left corner -WACS_T_LRCORNER 0x251b + J thick lower right corner -WACS_T_LTEE 0x252b + T thick tee pointing right -WACS_T_PLUS 0x254b + N thick large plus -WACS_T_RTEE 0x2523 + U thick tee pointing left -WACS_T_TTEE 0x2533 + W thick tee pointing down -WACS_T_ULCORNER 0x250f + L thick upper left corner -WACS_T_URCORNER 0x2513 + K thick upper right corner -WACS_T_VLINE 0x2503 | X thick vertical line +Lb Lb Lb Lb Lb +Lb Lb Lb Lb Lb +Lb L L L Lx. +\& Unicode ASCII acsc \& +ACS Name Default Default Char Glyph Name +_ +WACS_T_BTEE 0x253b + V T{ +thick tee pointing up +T} +WACS_T_HLINE 0x2501 - Q T{ +thick horizontal line +T} +WACS_T_LLCORNER 0x2517 + M T{ +thick lower left corner +T} +WACS_T_LRCORNER 0x251b + J T{ +thick lower right corner +T} +WACS_T_LTEE 0x252b + T T{ +thick tee pointing right +T} +WACS_T_PLUS 0x254b + N T{ +thick large plus +T} +WACS_T_RTEE 0x2523 + U T{ +thick tee pointing left +T} +WACS_T_TTEE 0x2533 + W T{ +thick tee pointing down +T} +WACS_T_ULCORNER 0x250f + L T{ +thick upper left corner +T} +WACS_T_URCORNER 0x2513 + K T{ +thick upper right corner +T} +WACS_T_VLINE 0x2503 | X T{ +thick vertical line +T} .TE .PP and for double-lines (\fBacsc\fP \*(``A\*('' to \*(``I\*(''): .PP .TS -l l l l l -l l l l l -_ _ _ _ _ -lw(1.5i) lw5 lw5 lw5 lw20. -\fBACS\fP \fBUnicode\fP \fBASCII\fP \fBacsc\fP \fBGlyph\fP -\fBName\fP \fBDefault\fP \fBDefault\fP \fBchar\fP \fBName\fP -WACS_D_BTEE 0x2569 + H double tee pointing up -WACS_D_HLINE 0x2550 - R double horizontal line -WACS_D_LLCORNER 0x255a + D double lower left corner -WACS_D_LRCORNER 0x255d + A double lower right corner -WACS_D_LTEE 0x2560 + F double tee pointing right -WACS_D_PLUS 0x256c + E double large plus -WACS_D_RTEE 0x2563 + G double tee pointing left -WACS_D_TTEE 0x2566 + I double tee pointing down -WACS_D_ULCORNER 0x2554 + C double upper left corner -WACS_D_URCORNER 0x2557 + B double upper right corner -WACS_D_VLINE 0x2551 | Y double vertical line +Lb Lb Lb Lb Lb +Lb Lb Lb Lb Lb +Lb L L L Lx. +\& Unicode ASCII acsc \& +ACS Name Default Default Char Glyph Name +_ +WACS_D_BTEE 0x2569 + H T{ +double tee pointing up +T} +WACS_D_HLINE 0x2550 - R T{ +double horizontal line +T} +WACS_D_LLCORNER 0x255a + D T{ +double lower left corner +T} +WACS_D_LRCORNER 0x255d + A T{ +double lower right corner +T} +WACS_D_LTEE 0x2560 + F T{ +double tee pointing right +T} +WACS_D_PLUS 0x256c + E T{ +double large plus +T} +WACS_D_RTEE 0x2563 + G T{ +double tee pointing left +T} +WACS_D_TTEE 0x2566 + I T{ +double tee pointing down +T} +WACS_D_ULCORNER 0x2554 + C T{ +double upper left corner +T} +WACS_D_URCORNER 0x2557 + B T{ +double upper right corner +T} +WACS_D_VLINE 0x2551 | Y T{ +double vertical line +T} .TE .PP -Unicode's descriptions for these characters differs slightly from ncurses, +Unicode's descriptions for these characters differs slightly from +\fI\%ncurses\fP, by introducing the term \*(``light\*('' (along with less important details). Here are its descriptions for the normal, thick, and double horizontal lines: .bP @@ -209,10 +291,9 @@ U+2501 BOX DRAWINGS HEAVY HORIZONTAL .bP U+2550 BOX DRAWINGS DOUBLE HORIZONTAL .SH RETURN VALUE -.PP All routines return the integer \fBERR\fP upon failure and \fBOK\fP on success. .PP -X/Open does not define any error conditions. +X/Open Curses does not specify any error conditions. This implementation returns an error .bP if the window pointer is null or @@ -221,21 +302,22 @@ if it is not possible to add a complete character in the window. .PP The latter may be due to different causes: .bP -If \fBscrollok\fP(3X) is not enabled, +If \fB\%scrollok\fP(3X) is not enabled, writing a character at the lower right margin succeeds. -However, an error is returned because -it is not possible to wrap to a new line +However, +an error is returned because it is not possible to wrap to a new line. .bP If an error is detected when converting a multibyte character to a sequence of bytes, or if it is not possible to add all of the resulting bytes in the window, an error is returned. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES -.PP Note that \fBadd_wch\fP, \fBmvadd_wch\fP, @@ -243,23 +325,22 @@ Note that \fBecho_wchar\fP may be macros. .SH PORTABILITY -.PP -All of these functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. The defaults specified for line-drawing characters apply in the POSIX locale. -.PP +.SS "WACS Symbols" X/Open Curses makes it clear that the WACS_ symbols should be defined as a pointer to \fBcchar_t\fP data, e.g., in the discussion of \fBborder_set\fP. A few implementations are problematic: .bP NetBSD curses defines the symbols as a \fBwchar_t\fP within a \fBcchar_t\fP. .bP -HPUX curses equates some of the \fBACS_\fP symbols +HP-UX curses equates some of the \fBACS_\fP symbols to the analogous \fBWACS_\fP symbols as if the \fBACS_\fP symbols were wide characters. The misdefined symbols are the arrows and other symbols which are not used for line-drawing. .PP -X/Open Curses does not define symbols for thick- or double-lines. +X/Open Curses does not specify symbols for thick- or double-lines. SVr4 curses implementations defined their line-drawing symbols in terms of intermediate symbols. This implementation extends those symbols, providing new definitions @@ -270,18 +351,20 @@ alternate character sets (i.e., the \fBacsc\fP capability), with their corresponding line-drawing characters. X/Open Curses did not address the aspect of integrating Unicode with line-drawing characters. -Existing implementations of Unix curses (AIX, HPUX, Solaris) +Existing implementations of Unix curses (AIX, HP-UX, Solaris) use only the \fBacsc\fP character-mapping to provide this feature. As a result, those implementations can only use single-byte line-drawing characters. -Ncurses 5.3 (2002) provided a table of Unicode values to solve these problems. +\fI\%ncurses\fP 5.3 (2002) provided a table of Unicode values to solve +these problems. NetBSD curses incorporated that table in 2010. .PP In this implementation, the Unicode values are used instead of the -terminal description's \fBacsc\fP mapping as discussed in ncurses(3X) -for the environment variable \fBNCURSES_NO_UTF8_ACS\fP. +terminal description's \fBacsc\fP mapping as discussed in +\fB\%ncurses\fP(3X) for the environment variable +\fINCURSES_NO_UTF8_ACS\fP. In contrast, for the same cases, the line-drawing characters -described in \fBcurs_addch\fP(3X) will use only the ASCII default values. +described in \fB\%addch\fP(3X) will use only the ASCII default values. .PP Having Unicode available does not solve all of the problems with line-drawing for curses: @@ -322,13 +405,45 @@ Others have suggested these alternatives: \[u2327] U+2327 (x in a rectangle), \[u256C] U+256C (forms double vertical and horizontal), and \[u2612] U+2612 (ballot box with x). +.SS "Complex Characters" +The complex character type \fBcchar_t\fR +can store more than one wide character (\fBwchar_t\fR). +The X/Open Curses description does not mention this possibility, +describing only the cases where \fIwch\fP is a spacing character +or a non-spacing character. +.PP +This implementation assumes that \fIwch\fP is constructed using +\fB\%setcchar\fP(3X), and in turn that the result +.bP +contains at most one spacing character in the beginning of its list of wide +characters, +and zero or more non-spacing characters +or +.bP +may hold one non-spacing character. +.PP +In the latter case, +\fI\%ncurses\fP adds the non-spacing character to the active +(base) spacing character. +.SS TABSIZE +The +.B TABSIZE +variable is implemented in SVr4 and other versions of +.IR curses , +but is not specified by X/Open Curses +(see \fBcurs_variables\fP(3X)). .SH SEE ALSO -.na +\fB\%curs_addch\fP(3X) describes comparable functions of the +.I \%ncurses +library in its non-wide-character configuration. .PP -\fBcurses\fP(3X), -\fBcurs_addch\fP(3X), -\fBcurs_attr\fP(3X), -\fBcurs_clear\fP(3X), -\fBcurs_outopts\fP(3X), -\fBcurs_refresh\fP(3X), -\fBputwc\fP(3) +\fB\%curses\fP(3X), +\fB\%curs_addwstr\fP(3X), +\fB\%curs_add_wchstr\fP(3X), +\fB\%curs_attr\fP(3X), +\fB\%curs_clear\fP(3X), +\fB\%curs_getcchar\fP(3X), +\fB\%curs_outopts\fP(3X), +\fB\%curs_refresh\fP(3X), +\fB\%curs_variables\fP(3X), +\fB\%putwc\fP(3) diff --git a/upstream/archlinux/man3/curs_add_wchstr.3x b/upstream/archlinux/man3/curs_add_wchstr.3x index 1a162547..610ee023 100644 --- a/upstream/archlinux/man3/curs_add_wchstr.3x +++ b/upstream/archlinux/man3/curs_add_wchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2021,2022 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 2002-2012,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,54 +27,53 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_add_wchstr.3x,v 1.19 2022/02/12 20:07:29 tom Exp $ -.TH curs_add_wchstr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_add_wchstr.3x,v 1.39 2024/04/20 21:20:07 tom Exp $ +.TH curs_add_wchstr 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBadd_wchstr\fP, -\fBadd_wchnstr\fP, -\fBwadd_wchstr\fP, -\fBwadd_wchnstr\fP, -\fBmvadd_wchstr\fP, -\fBmvadd_wchnstr\fP, -\fBmvwadd_wchstr\fP, -\fBmvwadd_wchnstr\fP \- add an array of complex characters (and attributes) to a curses window -.ad -.hy +\fB\%add_wchstr\fP, +\fB\%add_wchnstr\fP, +\fB\%wadd_wchstr\fP, +\fB\%wadd_wchnstr\fP, +\fB\%mvadd_wchstr\fP, +\fB\%mvadd_wchnstr\fP, +\fB\%mvwadd_wchstr\fP, +\fB\%mvwadd_wchnstr\fP \- +add a \fIcurses\fR complex character string to a window .SH SYNOPSIS .nf -\fB#include <curses.h>\fP +\fB#include <curses.h> .PP -\fBint add_wchstr(const cchar_t *\fIwchstr\fB);\fR -.br -\fBint add_wchnstr(const cchar_t *\fIwchstr\fB, int \fIn\fB);\fR -.br -\fBint wadd_wchstr(WINDOW *\fR \fIwin\fB, const cchar_t *\fIwchstr\fB);\fR -.br -\fBint wadd_wchnstr(WINDOW *\fR \fIwin\fB, const cchar_t *\fIwchstr\fB, int \fIn\fB);\fR -.sp -\fBint mvadd_wchstr(int \fIy\fB, int \fIx\fB, const cchar_t *\fIwchstr\fB);\fR -.br -\fBint mvadd_wchnstr(int \fIy\fB, int \fIx\fB, const cchar_t *\fIwchstr\fB, int \fIn\fB);\fR -.br -\fBint mvwadd_wchstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const cchar_t *\fIwchstr\fB);\fR -.br -\fBint mvwadd_wchnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const cchar_t *\fIwchstr\fB, int \fIn\fB);\fR +\fBint add_wchstr(const cchar_t *\fIwchstr\fP); +\fBint wadd_wchstr(WINDOW * \fIwin\fP, const cchar_t *\fIwchstr\fP); +\fBint mvadd_wchstr(int \fIy\fP, int \fIx\fP, const cchar_t *\fIwchstr\fP); +\fBint mvwadd_wchstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const cchar_t *\fIwchstr\fP); +.PP +\fBint add_wchnstr(const cchar_t *\fIwchstr\fP, int \fIn\fP); +\fBint wadd_wchnstr(WINDOW * \fIwin\fP, const cchar_t *\fIwchstr\fP, int \fIn\fP); +\fBint mvadd_wchnstr(int \fIy\fP, int \fIx\fP, const cchar_t *\fIwchstr\fP, int \fIn\fP); +\fBint mvwadd_wchnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const cchar_t *\fIwchstr\fP, int \fIn\fP); .fi .SH DESCRIPTION These functions copy the (null-terminated) array of complex characters \fIwchstr\fP into the window image structure starting at the current cursor position. +.PP The four functions with \fIn\fP as the last argument copy at most \fIn\fP elements, but no more than will fit on the line. @@ -82,7 +81,7 @@ If \fBn\fP=\fB\-1\fP then the whole array is copied, to the maximum number of characters that will fit on the line. .PP The window cursor is \fInot\fP advanced. -These functions work faster than \fBwaddnstr\fP. +These functions are faster than \fBwaddnstr\fP. On the other hand: .bP they do not perform checking @@ -103,21 +102,27 @@ the remaining columns are filled with the background character and rendition. .SH RETURN VALUE All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success. .PP -X/Open does not define any error conditions. +X/Open Curses does not specify any error conditions. This implementation returns an error -if the window pointer is null. +.bP +if the \fIwin\fP parameter is null or +.bP +if the \fIwchstr\fP parameter is null. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES All functions except \fBwadd_wchnstr\fP may be macros. .SH PORTABILITY -These entry points are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_addwstr\fP(3X). +\fB\%curs_addchstr\fP(3X) describes comparable functions of the +.I \%ncurses +library in its non-wide-character configuration. .PP -Comparable functions in the narrow-character (ncurses) library are -described in -\fBcurs_addchstr\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_addwstr\fP(3X), +\fB\%curs_add_wch\fP(3X) diff --git a/upstream/archlinux/man3/curs_addch.3x b/upstream/archlinux/man3/curs_addch.3x index 875f47f3..add60538 100644 --- a/upstream/archlinux/man3/curs_addch.3x +++ b/upstream/archlinux/man3/curs_addch.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,129 +28,176 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addch.3x,v 1.60 2023/03/11 20:39:26 tom Exp $ -.TH curs_addch 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_addch.3x,v 1.85 2024/04/20 19:03:47 tom Exp $ +.TH curs_addch 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.ds ' \(aq +.ds ^ \(ha +.ds ~ \(ti +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.ds ' ' +.ds ^ ^ +.ds ~ ~ +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBaddch\fP, -\fBwaddch\fP, -\fBmvaddch\fP, -\fBmvwaddch\fP, -\fBechochar\fP, -\fBwechochar\fP \- add a character (with attributes) to a \fBcurses\fP window, then advance the cursor +\fB\%addch\fP, +\fB\%waddch\fP, +\fB\%mvaddch\fP, +\fB\%mvwaddch\fP, +\fB\%echochar\fP, +\fB\%wechochar\fP \- +add a \fIcurses\fP character to a window and advance the cursor .SH SYNOPSIS -\fB#include <curses.h>\fP +.nf +\fB#include <curses.h> .PP -\fBint addch(const chtype \fIch\fB);\fR -.br -\fBint waddch(WINDOW *\fIwin\fB, const chtype \fIch\fB);\fR -.br -\fBint mvaddch(int \fIy\fB, int \fIx\fB, const chtype \fIch\fB);\fR -.br -\fBint mvwaddch(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const chtype \fIch\fB);\fR -.sp -\fBint echochar(const chtype \fIch\fB);\fR -.br -\fBint wechochar(WINDOW *\fIwin\fB, const chtype \fIch\fB);\fR -.br +\fBint addch(const chtype \fIch\fP); +\fBint waddch(WINDOW *\fIwin\fP, const chtype \fIch\fP); +\fBint mvaddch(int \fIy\fP, int \fIx\fP, const chtype \fIch\fP); +\fBint mvwaddch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const chtype \fIch\fP); +.PP +\fBint echochar(const chtype \fIch\fP); +\fBint wechochar(WINDOW *\fIwin\fP, const chtype \fIch\fP); +.fi .SH DESCRIPTION -.SS Adding characters -The \fBaddch\fP, \fBwaddch\fP, \fBmvaddch\fP and \fBmvwaddch\fP routines put -the character \fIch\fP into the given window at its current window position, -which is then advanced. -They are analogous to \fBputchar\fP(3) in \fBstdio\fP(3). -If the advance is at the right margin: -.bP -The cursor automatically wraps to the beginning of the next line. +.SS "Adding Characters" +.B \%waddch +puts the character +.I ch +at the cursor position of window +.IR win , +then advances the cursor position, +analogously to the standard C library's \fI\%putchar\fP(3). +\fB\%ncurses\fP(3X) describes the variants of this function. +.PP +If advancement occurs at the right margin, .bP -At the bottom of the current scrolling region, -and if \fBscrollok\fP(3X) is enabled, -the scrolling region is scrolled up one line. +the cursor automatically wraps to the beginning of the next line; +and .bP -If \fBscrollok\fP(3X) is not enabled, -writing a character at the lower right margin succeeds. -However, an error is returned because -it is not possible to wrap to a new line +at the bottom of the current scrolling region, +and if \fB\%scrollok\fP(3X) is enabled for +.IR win , +the scrolling region scrolls up one line. .PP -If \fIch\fP is a tab, newline, carriage return or backspace, -the cursor is moved appropriately within the window: +If +.I ch +is a +backspace, +carriage return, +line feed, +or +tab, +the cursor moves appropriately within the window. .bP -Backspace moves the cursor one character left; at the left -edge of a window it does nothing. +Backspace moves the cursor one character left; +at the left margin of a window, +it does nothing. .bP -Carriage return moves the cursor to the window left margin on the current line. +Carriage return moves the cursor to the left margin on the current line +of the window. .bP -Newline does a \fBclrtoeol\fP, -then moves the cursor to the window left margin on the next line, -scrolling the window if on the last line. +Line feed does a \fB\%clrtoeol\fP(3X), +then moves the cursor to the left margin on the next line of the window, +and if \fB\%scrollok\fP(3X) is enabled for +.IR win , +scrolls the window if the cursor was already on the last line. .bP -Tabs are considered to be at every eighth column. -The tab interval may be altered by setting the \fBTABSIZE\fP variable. +Tab advances the cursor to the next tab stop +(possibly on the next line); +these are placed at every eighth column by default. +Alter the tab interval with the +.B \%TABSIZE +extension; +see \fB\%curs_variables\fP(3X). .PP -If \fIch\fP is any other nonprintable character, +If +.I ch +is any other nonprintable character, it is drawn in printable form, -using the same convention as \fBunctrl\fR(3X): -.bP -Control characters are displayed in the \fB^\fIX\fR notation. -.bP -Values above 128 are either meta characters (if the screen has not -been initialized, or if \fBmeta\fP(3X) has been called with a \fBTRUE\fP E parameter), -shown in the \fBM\-\fIX\fR notation, or are displayed as themselves. -In the latter case, the values may not be printable; -this follows the X/Open specification. -.PP -Calling \fBwinch\fP after adding a -nonprintable character does not return the character itself, -but instead returns the printable representation of the character. +using the same convention as \fB\%unctrl\fP(3X). .PP -Video attributes can be combined with a character argument passed to -\fBaddch\fP or related functions by logical-ORing them into the character. -(Thus, text, including attributes, can be copied from one place to another -using \fBinch\fP(3X) and \fBaddch\fP.) See the \fBcurs_attr\fP(3X) page for -values of predefined video attribute constants that can be usefully OR'ed -into characters. -.SS Echoing characters +Calling \fB\%winch\fP(3X) on the location of a nonprintable character +does not return the character itself, +but its \fB\%unctrl\fP(3X) representation. .PP -The \fBechochar\fP and \fBwechochar\fP routines are equivalent to a call to -\fBaddch\fP followed by a call to \fBrefresh\fP(3X), or a call to \fBwaddch\fP -followed by a call to \fBwrefresh\fP. -The knowledge that only a single -character is being output is used and, for non-control characters, a -considerable performance gain may be seen by using these routines instead of -their equivalents. -.SS Line Graphics -The following variables may be used to add line drawing characters to the -screen with routines of the \fBaddch\fP family. -The default character listed -below is used if the \fBacsc\fP capability does not define a terminal-specific -replacement for it, -or if the terminal and locale configuration requires Unicode but the -library is unable to use Unicode. -.PP -The names are taken from VT100 nomenclature. +.I ch +may contain rendering and/or color attributes, +and others can be combined with the parameter +by logically \*(``or\*(''ing with it. +(A character with its attributes can be copied from place to place +using \fB\%winch\fP(3X) and +.BR \%waddch .) +See \fB\%curs_attr\fP(3X) for values of predefined video attribute +constants that can be usefully \*(``or\*(''ed with characters. +.SS "Echoing Characters" +.B \%echochar +and +.B \%wechochar +are equivalent to calling +.RB \%( w ) addch +followed by +.RB \%( w ) refresh . +.I curses +interprets these functions as a hint that only a single character is +being output; +for non-control characters, +a considerable performance gain may be enjoyed by employing them. +.\" TODO: Combine the following with the "Line Drawing" subsection of +.\" terminfo(5) and replace this with a cross reference there. +.SS "Forms-Drawing Characters" +.I curses +defines macros starting with +.B \%ACS_ +that can be used with +.B \%waddch +to write line-drawing and other special characters to the screen. +.I \%ncurses +terms these +.I "forms-drawing characters." +The ACS default listed below is used if the +.B \%acs_chars +.RB ( \%acsc ) +.I \%term\%info +capability does not define a terminal-specific replacement for it, +or if the terminal and locale configuration requires Unicode to access +these characters but the library is unable to use Unicode. +The \*(``acsc char\*('' column corresponds to how the characters are +specified in the +.B \%acs_chars +string capability, +and the characters in it may appear on the screen if the terminal's +database entry incorrectly advertises ACS support. +The name \*(``ACS\*('' originates in the Alternate Character Set feature +of the DEC VT100 terminal. .PP .TS -l l l l -l l l l -_ _ _ _ -l l l l. -\fBACS\fP \fBACS\fP \fBacsc\fP \fBGlyph\fP -\fBName\fP \fBDefault\fP \fBchar\fP \fBName\fP +Lb Lb Lb Lb +Lb Lb Lb Lb +Lb L L Lx. +\& ACS acsc \& +Symbol Default char Glyph Name +_ ACS_BLOCK # 0 solid square block ACS_BOARD # h board of squares ACS_BTEE + v bottom tee -ACS_BULLET o ~ bullet +ACS_BULLET o \*~ bullet ACS_CKBOARD : a checker board (stipple) ACS_DARROW v . arrow pointing down -ACS_DEGREE ' f degree symbol -ACS_DIAMOND + ` diamond +ACS_DEGREE \*' f degree symbol +ACS_DIAMOND + \(ga diamond ACS_GEQUAL > > greater-than-or-equal-to ACS_HLINE \- q horizontal line ACS_LANTERN # i lantern symbol @@ -171,153 +218,260 @@ ACS_S7 \- r scan line 7 ACS_S9 \&_ s scan line 9 ACS_STERLING f } pound-sterling symbol ACS_TTEE + w top tee -ACS_UARROW ^ \- arrow pointing up +ACS_UARROW \*^ \- arrow pointing up ACS_ULCORNER + l upper left-hand corner ACS_URCORNER + k upper right-hand corner ACS_VLINE | x vertical line .TE .SH RETURN VALUE -All routines return the integer \fBERR\fP upon failure and \fBOK\fP on success -(the SVr4 manuals specify only -\*(``an integer value other than \fBERR\fP\*('') upon successful completion, -unless otherwise noted in the preceding routine descriptions. +These functions return +.B OK +on success and +.B ERR +on failure. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +In +.IR \%ncurses , +.B \%waddch +returns +.B ERR +if it is not possible to add a complete character at the cursor +position, +as when conversion of a multibyte character to a byte sequence fails, +or at least one of the resulting bytes cannot be added to the window. +See section \*(``PORTABILITY\*('' below regarding the use of +.B \%waddch +with multibyte characters. .PP -If it is not possible to add a complete character, -an error is returned: -.bP -If \fBscrollok\fP(3X) is not enabled, -writing a character at the lower right margin succeeds. -However, an error is returned because -it is not possible to wrap to a new line -.bP -If an error is detected when converting a multibyte character to a sequence -of bytes, -or if it is not possible to add all of the resulting bytes in the window, -an error is returned. +.B \%waddch +can successfully write a character at the bottom right location of the +window. +However, +.I \%ncurses +returns +.B ERR +if \fB\%scrollok\fP(3X) is not enabled in that event, +because it is not possible to wrap to a new line. +.PP +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES -Note that \fBaddch\fP, \fBmvaddch\fP, \fBmvwaddch\fP, and -\fBechochar\fP may be macros. +.BR \%addch , +.BR \%mvaddch , +.BR \%mvwaddch , +and +.B \%echochar +may be implemented as macros. .SH PORTABILITY -All these functions are described in the XSI Curses standard, Issue 4. -The defaults specified for forms-drawing characters apply in the POSIX locale. -.SS ACS Symbols -.LP -X/Open Curses states that the \fBACS_\fP definitions are \fBchar\fP constants. -For the wide-character implementation (see \fBcurs_add_wch\fP), -there are analogous \fBWACS_\fP definitions which are \fBcchar_t\fP constants. -Some implementations are problematic: +X/Open Curses, +Issue 4 describes these functions. +It specifies no error conditions for them. +.PP +SVr4 +.I curses +describes a successful return value only as +\*(``an integer value other than +.BR ERR \*(''. +.PP +The defaults specified for forms-drawing characters apply in the POSIX +locale. +.SS "ACS Symbols" +X/Open Curses states that the +.B \%ACS_ +definitions are +.I char +constants. +.PP +Some implementations are problematic. .bP -Some implementations define the ACS symbols to a constant -(such as Solaris), while others define those to entries in an array. +Solaris +.IR curses , +for example, +define the ACS symbols as constants; +others define them as elements of an array. .IP -This implementation uses an array \fBacs_map\fP, as done in SVr4 curses. -NetBSD also uses an array, actually named \fB_acs_char\fP, with a \fB#define\fP +This implementation uses an array, +.BR \%acs_map , +as did SVr4 +.IR curses . +NetBSD also uses an array, +actually named +.BR \%_acs_char , +with a +.B \%#define for compatibility. .bP -HPUX curses equates some of the \fBACS_\fP symbols -to the analogous \fBWACS_\fP symbols as if the \fBACS_\fP symbols were -wide characters. -The misdefined symbols are the arrows -and other symbols which are not used for line-drawing. +HP-UX +.I curses +equates some of the +.B \%ACS_ +symbols to the analogous +.B \%WACS_ +symbols as if the +.B \%ACS_ +symbols were wide characters +(see \fB\%curs_add_wch\fP(3X)). +The misdefined symbols are the arrows and others that are not used for +line drawing. .bP -X/Open Curses (issues 2 through 7) has a typographical error -for the ACS_LANTERN symbol, equating its \*(``VT100+ Character\*('' -to \fBI\fP (capital I), while the header files for SVr4 curses -and the various implementations use \fBi\fP (lowercase). +X/Open Curses +(Issues 2 through 7) +has a typographical error +for the +.B \%ACS_LANTERN +symbol, equating its \*(``VT100+ Character\*('' to \*(``I\*('' +(capital I), +while the header files for SVr4 +.I curses +and other implementations use \*(``i\*('' +(small i). .IP -None of the terminal descriptions on Unix platforms use uppercase-I, -except for Solaris (i.e., \fBscreen\fP's terminal description, +None of the terminal descriptions on Unix platforms use uppercase I, +except for Solaris +(in its +.I \%term\%info +entry for \fI\%screen\fP(1), apparently based on the X/Open documentation around 1995). -On the other hand, the terminal description \fIgs6300\fP -(AT&T PC6300 with EMOTS Terminal Emulator) uses lowercase-i. -.LP +On the other hand, +its +.B \%gs6300 +(AT&T PC6300 with EMOTS Terminal Emulator) +description uses lowercase i. +.PP Some ACS symbols -(ACS_S3, -ACS_S7, -ACS_LEQUAL, -ACS_GEQUAL, -ACS_PI, -ACS_NEQUAL, -ACS_STERLING) -were not documented in -any publicly released System V. -However, many publicly available terminfos -include \fBacsc\fP strings in which their key characters (pryz{|}) are -embedded, and a second-hand list of their character descriptions has come -to light. -The ACS-prefixed names for them were invented for \fBncurses\fP(3X). -.LP -The \fIdisplayed\fP values for the \fBACS_\fP and \fBWACS_\fP constants -depend on +.RB ( \%ACS_S3 , +.BR \%ACS_S7 , +.BR \%ACS_LEQUAL , +.BR \%ACS_GEQUAL , +.BR \%ACS_PI , +.BR \%ACS_NEQUAL , +and +.BR \%ACS_STERLING ) +were not documented in any publicly released System\ V. +However, +many publicly available +.I \%term\%info +entries include +.B \%acsc +strings in which their key characters +.BR ( pryz{|} ) +are embedded, +and a second-hand list of their character descriptions has come to +light. +The +.I \%ncurses +developers invented ACS-prefixed names for them. +.PP +The +.I displayed +values of +.B \%ACS_ +constants depend on .bP -the library configuration, i.e., \fBncurses\fP versus \fBncursesw\fP, -where the latter is capable of displaying Unicode while the former is not, and +the +.I \%ncurses +ABI\(emfor example, +wide-character versus non-wide-character configurations +(the former is capable of displaying Unicode while the latter is not), +and .bP -whether the \fIlocale\fP uses UTF-8 encoding. -.LP -In certain cases, the terminal is unable to display line-drawing characters -except by using UTF-8 (see the discussion of \fBNCURSES_NO_UTF8_ACS\fP in -ncurses(3X)). -.SS Character Set -X/Open Curses assumes that the parameter passed to \fBwaddch\fP contains -a single character. -As discussed in \fBcurs_attr\fP(3X), that character may have been -more than eight bits in an SVr3 or SVr4 implementation, -but in the X/Open Curses model, the details are not given. -The important distinction between SVr4 curses and X/Open Curses is -that the non-character information (attributes and color) was -separated from the character information which is packed in a \fBchtype\fP -to pass to \fBwaddch\fP. +whether the locale uses UTF-8 encoding. +.PP +In certain cases, +the terminal is unable to display forms-drawing characters +.I except +by using UTF-8; +see the discussion of the +.I \%NCURSES_NO_UTF8_ACS +environment variable in \fB\%ncurses\fP(3X)). +.SS "Character Set" +X/Open Curses assumes that the parameter passed to +.B \%waddch +contains a single character. +As discussed in \fB\%curs_attr\fP(3X), +that character may have been more than eight bits wide in an SVr3 or +SVr4 implementation, +but in the X/Open Curses model, +the details are not given. +The important distinction between SVr4 +.I curses +and X/Open Curses is that the latter separates non-character information +(attributes and color) +from the character code, +which SVr4 packs into a +.I \%chtype +for passage to +.BR \%waddch . .PP -In this implementation, \fBchtype\fP holds an eight-bit character. -But ncurses allows multibyte characters to be passed in a succession -of calls to \fBwaddch\fP. -The other implementations do not do this; -a call to \fBwaddch\fP passes exactly one character -which may be rendered as one or more cells on the screen -depending on whether it is printable. +In +.IR \%ncurses , +.I \%chtype +holds an eight-bit character. +But the library allows a multibyte character to be passed in a +succession of calls to +.BR \%waddch . +Other implementations do not; +a +.B \%waddch +call transmits exactly one character, +which may be rendered in one or more screen locations depending on +whether it is printable. .PP Depending on the locale settings, -ncurses will inspect the byte passed in each call to \fBwaddch\fP, -and check if the latest call will continue a multibyte sequence. -When a character is \fIcomplete\fP, -ncurses displays the character and moves to the next position in the screen. +.I \%ncurses +inspects the byte passed in each +.B \%waddch +call, +and checks whether the latest call continues a multibyte sequence. +When a character is +.IR complete , +.I \%ncurses +displays the character and advances the cursor. .PP If the calling application interrupts the succession of bytes in -a multibyte character by moving the current location (e.g., using \fBwmove\fP), -ncurses discards the partially built character, -starting over again. +a multibyte character sequence by changing the current location\(emfor +example, +with \fB\%wmove\fP(3X)\(em\c +.I \%ncurses +discards the incomplete character. .PP For portability to other implementations, -do not rely upon this behavior: +do not rely upon this behavior. +Check whether a character can be represented as a single byte in the +current locale. .bP -check if a character can be represented as a single byte in the current locale -before attempting call \fBwaddch\fP, and +If it can, +call either +.B \%waddch +or \fB\%wadd_wch\fP(3X). .bP -call \fBwadd_wch\fP for characters which cannot be handled by \fBwaddch\fP. +If it cannot, +use only +\fB\%wadd_wch\fP(3X). .SS TABSIZE -.LP -The \fBTABSIZE\fP variable is implemented in SVr4 and other versions of curses, -but is not part of X/Open curses -(see \fBcurs_variables\fP(3X) for more details). -.LP -If \fIch\fP is a carriage return, -the cursor is moved to the beginning of the current row of the window. -This is true of other implementations, but is not documented. +SVr4 and other versions of +.I curses +implement the +.B \%TABSIZE +variable, +but X/Open Curses does not specify it +(see \fB\%curs_variables\fP(3X)). .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_attr\fP(3X), -\fBcurs_clear\fP(3X), -\fBcurs_inch\fP(3X), -\fBcurs_outopts\fP(3X), -\fBcurs_refresh\fP(3X), -\fBcurs_variables\fP(3X), -\fBputc\fP(3). +\fB\%curs_add_wch\fP(3X) describes comparable functions of the +.I \%ncurses +library in its wide-character configuration +.RI ( \%ncursesw ). .PP -Comparable functions in the wide-character (ncursesw) library are -described in -\fBcurs_add_wch\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_addchstr\fP(3X), +\fB\%curs_addstr\fP(3X), +\fB\%curs_attr\fP(3X), +\fB\%curs_clear\fP(3X), +\fB\%curs_inch\fP(3X), +\fB\%curs_outopts\fP(3X), +\fB\%curs_refresh\fP(3X), +\fB\%curs_variables\fP(3X), +\fB\%putchar\fP(3) diff --git a/upstream/archlinux/man3/curs_addchstr.3x b/upstream/archlinux/man3/curs_addchstr.3x index aba4c131..968edd88 100644 --- a/upstream/archlinux/man3/curs_addchstr.3x +++ b/upstream/archlinux/man3/curs_addchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2021,2022 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2012,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,54 +27,53 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addchstr.3x,v 1.25 2022/02/12 20:07:29 tom Exp $ -.TH curs_addchstr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_addchstr.3x,v 1.45 2024/04/20 21:20:07 tom Exp $ +.TH curs_addchstr 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBaddchstr\fP, -\fBaddchnstr\fP, -\fBwaddchstr\fP, -\fBwaddchnstr\fP, -\fBmvaddchstr\fP, -\fBmvaddchnstr\fP, -\fBmvwaddchstr\fP, -\fBmvwaddchnstr\fP \- add a string of characters (and attributes) to a \fBcurses\fP window -.ad -.hy +\fB\%addchstr\fP, +\fB\%addchnstr\fP, +\fB\%waddchstr\fP, +\fB\%waddchnstr\fP, +\fB\%mvaddchstr\fP, +\fB\%mvaddchnstr\fP, +\fB\%mvwaddchstr\fP, +\fB\%mvwaddchnstr\fP \- +add a \fIcurses\fR character string to a window .SH SYNOPSIS .nf -\fB#include <curses.h>\fP +\fB#include <curses.h> .PP -\fBint addchstr(const chtype *\fIchstr\fB);\fR -.br -\fBint addchnstr(const chtype *\fIchstr\fB, int \fIn\fB);\fR -.br -\fBint waddchstr(WINDOW *\fIwin\fB, const chtype *\fIchstr\fB);\fR -.br -\fBint waddchnstr(WINDOW *\fIwin\fB, const chtype *\fIchstr\fB, int \fIn\fB);\fR -.sp -\fBint mvaddchstr(int \fIy\fB, int \fIx\fB, const chtype *\fIchstr\fB);\fR -.br -\fBint mvaddchnstr(int \fIy\fB, int \fIx\fB, const chtype *\fIchstr\fB, int \fIn\fB);\fR -.br -\fBint mvwaddchstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const chtype *\fIchstr\fB);\fR -.br -\fBint mvwaddchnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const chtype *\fIchstr\fB, int \fIn\fB);\fR +\fBint addchstr(const chtype *\fIchstr\fP); +\fBint waddchstr(WINDOW *\fIwin\fP, const chtype *\fIchstr\fP); +\fBint mvaddchstr(int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP); +\fBint mvwaddchstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP); +.PP +\fBint addchnstr(const chtype *\fIchstr\fP, int \fIn\fP); +\fBint waddchnstr(WINDOW *\fIwin\fP, const chtype *\fIchstr\fP, int \fIn\fP); +\fBint mvaddchnstr(int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP, int \fIn\fP); +\fBint mvwaddchnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP, int \fIn\fP); .fi .SH DESCRIPTION These functions copy the (null-terminated) \fIchstr\fP array into the window image structure starting at the current cursor position. +.PP The four functions with \fIn\fP as the last argument copy at most \fIn\fP elements, but no more than will fit on the line. @@ -82,7 +81,7 @@ If \fBn\fP=\fB\-1\fP then the whole array is copied, to the maximum number of characters that will fit on the line. .PP The window cursor is \fInot\fP advanced. -These functions work faster than \fBwaddnstr\fP. +These functions are faster than \fBwaddnstr\fP. On the other hand: .bP they do not perform checking @@ -97,21 +96,28 @@ rather than wrapping it around to the new line. .SH RETURN VALUE All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success. .PP -X/Open does not define any error conditions. +X/Open Curses does not specify any error conditions. This implementation returns an error -if the window pointer is null. +.bP +if the \fIwin\fP parameter is null or +.bP +if the \fIwchstr\fP parameter is null. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES All functions except \fBwaddchnstr\fP may be macros. .SH PORTABILITY -These entry points are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_addstr\fP(3X). +\fB\%curs_add_wchstr\fP(3X) describes comparable functions of the +.I \%ncurses +library in its wide-character configuration +.RI ( \%ncursesw ). .PP -Comparable functions in the wide-character (ncursesw) library are -described in -\fBcurs_add_wchstr\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_addch\fP(3X), +\fB\%curs_addstr\fP(3X) diff --git a/upstream/archlinux/man3/curs_addstr.3x b/upstream/archlinux/man3/curs_addstr.3x index cd8ce48d..82c2844e 100644 --- a/upstream/archlinux/man3/curs_addstr.3x +++ b/upstream/archlinux/man3/curs_addstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2022,2023 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2012,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,93 +27,109 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addstr.3x,v 1.27 2023/03/11 20:40:52 tom Exp $ -.TH curs_addstr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_addstr.3x,v 1.45 2024/04/20 19:18:18 tom Exp $ +.TH curs_addstr 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBaddstr\fP, -\fBaddnstr\fP, -\fBwaddstr\fP, -\fBwaddnstr\fP, -\fBmvaddstr\fP, -\fBmvaddnstr\fP, -\fBmvwaddstr\fP, -\fBmvwaddnstr\fP \- add a string of characters to a \fBcurses\fP window and advance cursor -.ad -.hy +\fB\%addstr\fP, +\fB\%addnstr\fP, +\fB\%waddstr\fP, +\fB\%waddnstr\fP, +\fB\%mvaddstr\fP, +\fB\%mvaddnstr\fP, +\fB\%mvwaddstr\fP, +\fB\%mvwaddnstr\fP \- +add a string to a \fIcurses\fR window and advance the cursor .SH SYNOPSIS .nf -\fB#include <curses.h>\fP +\fB#include <curses.h> .PP -\fBint addstr(const char *\fIstr\fB);\fR -.br -\fBint addnstr(const char *\fIstr\fB, int \fIn\fB);\fR -.br -\fBint waddstr(WINDOW *\fIwin\fB, const char *\fIstr\fB);\fR -.br -\fBint waddnstr(WINDOW *\fIwin\fB, const char *\fIstr\fB, int \fIn\fB);\fR -.sp -\fBint mvaddstr(int \fIy\fB, int \fIx\fB, const char *\fIstr\fB);\fR -.br -\fBint mvaddnstr(int \fIy\fB, int \fIx\fB, const char *\fIstr\fB, int \fIn\fB);\fR -.br -\fBint mvwaddstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char *\fIstr\fB);\fR -.br -\fBint mvwaddnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char *\fIstr, int \fIn\fB);\fR +\fBint addstr(const char *\fIstr\fP); +\fBint mvaddstr(int \fIy\fP, int \fIx\fP, const char *\fIstr\fP); +\fBint mvwaddstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIstr\fP); +\fBint waddstr(WINDOW *\fIwin\fP, const char *\fIstr\fP); +.PP +\fBint addnstr(const char *\fIstr\fP, int \fIn\fP); +\fBint mvaddnstr(int \fIy\fP, int \fIx\fP, const char *\fIstr\fP, int \fIn\fP); +\fBint mvwaddnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIstr\fP, int \fIn\fP); +\fBint waddnstr(WINDOW *\fIwin\fP, const char *\fIstr\fP, int \fIn\fP); .fi .SH DESCRIPTION -These functions write the (null-terminated) character string -\fIstr\fP on the given window. -It is similar to calling \fBwaddch\fP once for each byte in the string. +.B waddstr +writes the characters of the (null-terminated) string +.I str +to the window +.IR win . +Its process is similar to calling \fB\%waddch\fP(3X) for each +.I char +in +.IR str . +Control characters are processed as in \fB\%waddch\fP(3X). .PP -The \fImv\fP functions perform cursor movement once, before writing any -characters. -Thereafter, the cursor is advanced as a side-effect of writing to the window. +.B waddnstr +writes at most +.I n +characters, +or until a terminating null character occurs in +.IR str . +If +.I n +is \-1, +.B +.B waddnstr +writes the entire string. .PP -The four functions with \fIn\fP as the last argument -write at most \fIn\fP bytes, -or until a terminating null is reached. -If \fIn\fP is \-1, then the entire string will be added. +\fB\%ncurses\fP(3X) describes the variants of these functions. .SH RETURN VALUE -All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success. +These functions return +.B OK +on success and +.B ERR +on failure. .PP -X/Open does not define any error conditions. -This implementation returns an error +X/Open Curses does not specify any error conditions. +.I \%ncurses +returns an error .bP -if the window pointer is null or +if the window pointer is +.BR NULL , .bP -if the string pointer is null or +if the string pointer is +.BR NULL , +or .bP -if the corresponding calls to \fBwaddch\fP return an error. -.PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. -If an error is returned by the \fBwmove\fP, -no characters are added to the window. +if an internal \fB\%waddch\fP(3X) call returns an error. .PP -If an error is returned by \fBwaddch\fP -(e.g., -because the window is not large enough, -or an illegal byte sequence was detected) -only part of the string may be added. -Aside from that, -there is a special case in \fBwaddch\fP where an error may be -returned after successfully writing a character to the lower-right corner -of a window when \fBscrollok\fP(3X) is disabled. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES All of these functions except \fBwaddnstr\fP may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +X/Open Curses, +Issue 4 describes these functions. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_addch\fP(3X). +\fB\%curs_addwstr\fP(3X) describes comparable functions of the +.I \%ncurses +library in its wide-character configuration +.RI ( \%ncursesw ). +.PP +\fB\%curses\fP(3X), +\fB\%curs_addch\fP(3X), +\fB\%curs_addchstr\fP(3X) diff --git a/upstream/archlinux/man3/curs_addwstr.3x b/upstream/archlinux/man3/curs_addwstr.3x index 7c3e041c..0de96f92 100644 --- a/upstream/archlinux/man3/curs_addwstr.3x +++ b/upstream/archlinux/man3/curs_addwstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2021,2022 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 2002-2012,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,83 +27,120 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addwstr.3x,v 1.18 2022/02/12 20:07:29 tom Exp $ -.TH curs_addwstr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_addwstr.3x,v 1.37 2024/04/20 19:18:18 tom Exp $ +.TH curs_addwstr 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBaddwstr\fP, -\fBaddnwstr\fP, -\fBwaddwstr\fP, -\fBwaddnwstr\fP, -\fBmvaddwstr\fP, -\fBmvaddnwstr\fP, -\fBmvwaddwstr\fP, -\fBmvwaddnwstr\fP \- add a string of wide characters to a \fBcurses\fP window and advance cursor -.ad -.hy +\fB\%addwstr\fP, +\fB\%addnwstr\fP, +\fB\%waddwstr\fP, +\fB\%waddnwstr\fP, +\fB\%mvaddwstr\fP, +\fB\%mvaddnwstr\fP, +\fB\%mvwaddwstr\fP, +\fB\%mvwaddnwstr\fP \- +add a wide-character string to a \fIcurses\fR window and advance the cursor .SH SYNOPSIS .nf -\fB#include <curses.h>\fP +\fB#include <curses.h> .PP -\fBint addwstr(const wchar_t *\fIwstr\fB);\fR -.br -\fBint addnwstr(const wchar_t *\fIwstr\fB, int \fIn\fB);\fR -.br -\fBint waddwstr(WINDOW *\fIwin\fB, const wchar_t *\fIwstr\fB);\fR -.br -\fBint waddnwstr(WINDOW *\fIwin\fB, const wchar_t *\fIwstr\fB, int \fIn\fB);\fR -.sp -\fBint mvaddwstr(int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB);\fR -.br -\fBint mvaddnwstr(int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB, int \fIn\fB);\fR -.br -\fBint mvwaddwstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB);\fR -.br -\fBint mvwaddnwstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB, int \fIn\fB);\fR +\fBint addwstr(const wchar_t *\fIwstr\fP); +\fBint mvaddwstr(int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP); +\fBint mvwaddwstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP); +\fBint waddwstr(WINDOW *\fIwin\fP, const wchar_t *\fIwstr\fP); +.PP +\fBint addnwstr(const wchar_t *\fIwstr\fP, int \fIn\fP); +\fBint mvaddnwstr(int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP, int \fIn\fP); +\fBint mvwaddnwstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP, int \fIn\fP); +\fBint waddnwstr(WINDOW *\fIwin\fP, const wchar_t *\fIwstr\fP, int \fIn\fP); .fi .SH DESCRIPTION -These functions write the characters of the -(null-terminated) \fBwchar_t\fP character string -\fIwstr\fP on the given window. -It is similar to constructing a \fBcchar_t\fP for each wchar_t in the string, -then calling \fBwadd_wch\fP for the resulting \fBcchar_t\fP. +.B waddwstr +writes the characters of the (wide-null-terminated) wide-character +string +.I wstr +to the window +.IR win . +Its process is similar to constructing a +.I cchar_t +for each +.I wchar_t +in +.IR wstr , +then calling \fB\%wadd_wch\fP(3X) with the resulting +.IR cchar_t . +.bP +Spacing and non-spacing characters in the string +are processed one at a time, +and +.bP +control characters are processed as in \fB\%wadd_wch\fP(3X). .PP -The \fImv\fP functions perform cursor movement once, before writing any -characters. -Thereafter, the cursor is advanced as a side-effect of writing to the window. +.B waddnwstr +writes at most +.I n +wide characters, +or until a terminating wide null character occurs in +.IR wstr . +If +.I n +is \-1, +.B +.B waddnwstr +writes the entire wide string. .PP -The four functions with \fIn\fP as the last argument -write at most \fIn\fP \fBwchar_t\fP characters, -or until a terminating null is reached. -If \fIn\fP is \-1, then the entire string will be added. +\fB\%ncurses\fP(3X) describes the variants of these functions. .SH RETURN VALUE -All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success. +These functions return +.B OK +on success and +.B ERR +on failure. .PP -X/Open does not define any error conditions. -This implementation returns an error +X/Open Curses does not specify any error conditions. +.I \%ncurses +returns an error .bP -if the window pointer is null or +if the window pointer is +.BR NULL , .bP -if the string pointer is null or +if the string pointer is +.BR NULL , +or .bP -if the corresponding calls to \fBwadd_wch\fP return an error. +if an internal \fB\%wadd_wch\fP(3X) call returns an error. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES -All of these functions except \fBwaddnwstr\fP may be macros. +All of these functions except +.B waddnwstr +may be implemented as macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +X/Open Curses, +Issue 4 describes these functions. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_add_wch\fP(3X) +\fB\%curs_addstr\fP(3X) describes comparable functions of the +.I \%ncurses +library in its non-wide-character configuration. +.PP +\fB\%curses\fP(3X), +\fB\%curs_add_wch\fP(3X), +\fB\%curs_add_wchstr\fP(3X) diff --git a/upstream/archlinux/man3/curs_attr.3x b/upstream/archlinux/man3/curs_attr.3x index ac448b4e..5a196e52 100644 --- a/upstream/archlinux/man3/curs_attr.3x +++ b/upstream/archlinux/man3/curs_attr.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,123 +28,90 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_attr.3x,v 1.72 2022/04/16 19:18:32 tom Exp $ -.TH curs_attr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' -.de NS -.ie n .sp -.el .sp .5 -.ie n .in +4 -.el .in +2 -.nf -.ft C \" Courier -.. -.de NE -.fi -.ft R -.ie n .in -4 -.el .in -2 -.. +.\" $Id: curs_attr.3x,v 1.105 2024/04/27 17:54:42 tom Exp $ +.TH curs_attr 3X 2024-04-27 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .\" --------------------------------------------------------------------------- .SH NAME -.\" attr_get -\fBattr_get\fP, -\fBwattr_get\fP, -\fBattr_set\fP, -\fBwattr_set\fP, -.\" .br -\fBattr_off\fP, -\fBwattr_off\fP, -\fBattr_on\fP, -\fBwattr_on\fP, -.\" .br -\fBattroff\fP, -\fBwattroff\fP, -\fBattron\fP, -\fBwattron\fP, -\fBattrset\fP, -\fBwattrset\fP, -.\" .br -\fBchgat\fP, -\fBwchgat\fP, -\fBmvchgat\fP, -\fBmvwchgat\fP, -.\" .br -\fBcolor_set\fP, -\fBwcolor_set\fP, -.\" .br -\fBstandend\fP, -\fBwstandend\fP, -\fBstandout\fP, -\fBwstandout\fP \- \fBcurses\fP character and window attribute control routines -.ad -.hy +\fB\%attr_get\fP, +\fB\%wattr_get\fP, +\fB\%attr_set\fP, +\fB\%wattr_set\fP, +\fB\%attr_off\fP, +\fB\%wattr_off\fP, +\fB\%attr_on\fP, +\fB\%wattr_on\fP, +\fB\%attroff\fP, +\fB\%wattroff\fP, +\fB\%attron\fP, +\fB\%wattron\fP, +\fB\%attrset\fP, +\fB\%wattrset\fP, +\fB\%chgat\fP, +\fB\%wchgat\fP, +\fB\%mvchgat\fP, +\fB\%mvwchgat\fP, +\fB\%color_set\fP, +\fB\%wcolor_set\fP, +\fB\%standend\fP, +\fB\%wstandend\fP, +\fB\%standout\fP, +\fB\%wstandout\fP \- +manipulate attributes of character cells in \fIcurses\fR windows .\" --------------------------------------------------------------------------- .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint attr_get(attr_t *\fIattrs\fB, short *\fIpair\fB, void *\fIopts\fB);\fR -.br -\fBint wattr_get(WINDOW *\fIwin\fB, attr_t *\fIattrs\fB, short *\fIpair\fB,\fR \fBvoid *\fIopts\fB);\fR -.br -\fBint attr_set(attr_t \fIattrs\fB, short \fIpair\fB, void *\fIopts\fB);\fR -.br -\fBint wattr_set(WINDOW *\fIwin\fB, attr_t \fIattrs\fB, short \fIpair\fB, void *\fIopts\fB);\fR -.sp -\fBint attr_off(attr_t \fIattrs\fB, void *\fIopts\fB);\fR -.br -\fBint wattr_off(WINDOW *\fIwin\fB, attr_t \fIattrs\fB, void *\fIopts\fB);\fR -.br -\fBint attr_on(attr_t \fIattrs\fB, void *\fIopts\fB);\fR -.br -\fBint wattr_on(WINDOW *\fIwin\fB, attr_t \fIattrs\fB, void *\fIopts\fB);\fR -.sp -\fBint attroff(int \fIattrs);\fR -.br -\fBint wattroff(WINDOW *\fIwin\fB, int \fIattrs\fB);\fR -.br -\fBint attron(int \fIattrs\fB);\fR -.br -\fBint wattron(WINDOW *\fIwin\fB, int \fIattrs\fB);\fR -.br -\fBint attrset(int \fIattrs\fB);\fR -.br -\fBint wattrset(WINDOW *\fIwin\fB, int \fIattrs\fB);\fR -.sp -\fBint chgat(int \fIn\fB, attr_t \fIattr\fB, short \fIpair\fB,\fR \fBconst void *\fIopts\fB);\fR -.br -\fBint wchgat(WINDOW *\fIwin\fB,\fR +.nf +\fB#include <curses.h> +.PP +\fBint attr_get(attr_t *\fIattrs\fP, short *\fIpair\fP, void *\fIopts\fP); +\fBint wattr_get(WINDOW *\fIwin\fP, attr_t *\fIattrs\fP, short *\fIpair\fP,\fR \fPvoid *\fIopts\fP); +\fBint attr_set(attr_t \fIattrs\fP, short \fIpair\fP, void *\fIopts\fP); +\fBint wattr_set(WINDOW *\fIwin\fP, attr_t \fIattrs\fP, short \fIpair\fP, void *\fIopts\fP); +.PP +\fBint attr_off(attr_t \fIattrs\fP, void *\fIopts\fP); +\fBint wattr_off(WINDOW *\fIwin\fP, attr_t \fIattrs\fP, void *\fIopts\fP); +\fBint attr_on(attr_t \fIattrs\fP, void *\fIopts\fP); +\fBint wattr_on(WINDOW *\fIwin\fP, attr_t \fIattrs\fP, void *\fIopts\fP); +.PP +\fBint attroff(int \fIattrs\fP); +\fBint wattroff(WINDOW *\fIwin\fP, int \fIattrs\fP); +\fBint attron(int \fIattrs\fP); +\fBint wattron(WINDOW *\fIwin\fP, int \fIattrs\fP); +\fBint attrset(int \fIattrs\fP); +\fBint wattrset(WINDOW *\fIwin\fP, int \fIattrs\fP); +.PP +\fBint chgat(int \fIn\fP, attr_t \fIattr\fP, short \fIpair\fP,\fR \fPconst void *\fIopts\fP); +\fBint wchgat(WINDOW *\fIwin\fP, \fBint \fIn\fB, attr_t \fIattr\fB,\fR \fBshort \fIpair\fB, const void *\fIopts\fB);\fR -.br \fBint mvchgat(int \fIy\fB, int \fIx\fB,\fR - \fBint \fIn\fB, attr_t \fIattr\fB,\fR \fBshort \fIpair\fB, const void *\fIopts\fB);\fR -.br -\fBint mvwchgat(WINDOW *\fIwin, int \fIy, int \fIx\fB,\fR - \fBint \fIn,\fR \fBattr_t \fIattr\fB, short \fIpair\fB, const void *\fIopts\fB);\fR -.sp + \fBint \fIn\fB, attr_t \fIattr\fB, short \fIpair\fB, const void *\fIopts\fB);\fR +\fBint mvwchgat(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB,\fR + \fBint \fIn\fB, attr_t \fIattr\fB, short \fIpair\fB, const void *\fIopts\fB);\fR +.PP \fBint color_set(short \fIpair\fB, void* \fIopts\fB);\fR -.br -\fBint wcolor_set(WINDOW *\fIwin\fB, short \fIpair\fB,\fR \fBvoid* \fIopts);\fR -.sp +\fBint wcolor_set(WINDOW *\fIwin\fB, short \fIpair\fB,\fR \fBvoid* \fIopts\fP);\fR +.PP \fBint standend(void);\fP -.br \fBint wstandend(WINDOW *\fIwin\fB);\fR -.br \fBint standout(void);\fP -.br \fBint wstandout(WINDOW *\fIwin\fB);\fR +.fi .\" --------------------------------------------------------------------------- .SH DESCRIPTION -.PP These routines manipulate the current attributes of the named window, which then apply to all characters that are written into the window with \fBwaddch\fP, \fBwaddstr\fP and \fBwprintw\fP. @@ -159,13 +126,8 @@ These routines do not affect the attributes used when erasing portions of the window. See \fBcurs_bkgd\fP(3X) for functions which modify the attributes used for erasing and clearing. -.PP -Routines which do not have a \fBWINDOW*\fP parameter apply to \fBstdscr\fP. -For example, -\fBattr_set\fP is the \fBstdscr\fP variant of \fBwattr_set\fP. .\" --------------------------------------------------------------------------- -.SS Window attributes -.PP +.SS "Window Attributes" There are two sets of functions: .bP functions for manipulating the window attributes and color: @@ -186,7 +148,7 @@ Use \fBattr_off\fP and \fBwattr_off\fP to turn off window attributes, again values OR'd together in \fIattr\fP, without affecting other attributes. .\" --------------------------------------------------------------------------- -.SS Legacy window attributes +.SS "Legacy Window Attributes" The X/Open window attribute routines which \fIset\fP or \fIget\fP, turn \fIon\fP or \fIoff\fP are extensions of older routines @@ -204,14 +166,18 @@ the attribute parameter. For example, as long as that value fits into the \fBA_COLOR\fP mask, then these calls produce similar results: -.NS +.PP +.RS 4 +.EX attrset(A_BOLD | COLOR_PAIR(\fIpair\fP)); attr_set(A_BOLD, \fIpair\fP, NULL); -.NE +.EE +.RE .PP However, if the value does not fit, then the \fBCOLOR_PAIR\fP macro uses only the bits that fit. -For example, because in ncurses \fBA_COLOR\fP has eight (8) bits, +For example, +because in \fI\%ncurses\fP \fBA_COLOR\fP has eight (8) bits, then \fBCOLOR_PAIR(\fI259\fB)\fR is 4 (i.e., 259 is 4 more than the limit 255). .PP @@ -219,10 +185,13 @@ The \fBPAIR_NUMBER\fP macro extracts a pair number from an \fBint\fP (or \fBchtype\fP). For example, the \fIinput\fP and \fIoutput\fP values in these statements would be the same: -.NS +.PP +.RS 4 +.EX int value = A_BOLD | COLOR_PAIR(\fIinput\fP); int \fIoutput\fP = PAIR_NUMBER(value); -.NE +.EE +.RE .PP The \fBattrset\fP routine is a legacy feature predating SVr4 curses but kept in X/Open Curses for the same reason that SVr4 curses kept it: @@ -232,11 +201,12 @@ The remaining \fBattr\fP* functions operate exactly like the corresponding \fBattr_\fP* functions, except that they take arguments of type \fBint\fP rather than \fBattr_t\fP. .PP -There is no corresponding \fBattrget\fP function as such in X/Open Curses, -although ncurses provides \fBgetattrs\fP (see curs_legacy(3X)). +There is no corresponding \fB\%attrget\fP function as such +in X/Open Curses, +although \fI\%ncurses\fP provides \fB\%getattrs\fP +(see \fB\%curs_legacy\fP(3X)). .\" --------------------------------------------------------------------------- -.SS Change character rendition -.PP +.SS "Change Character Rendition" The routine \fBchgat\fP changes the attributes of a given number of characters starting at the current cursor location of \fBstdscr\fP. It does not update @@ -248,69 +218,74 @@ The \fBwchgat\fP function generalizes this to any window; the \fBmvwchgat\fP function does a cursor move before acting. .PP In these functions, -the color \fIpair\fP argument is a color-pair index +the color \fIpair\fP argument is a color pair index (as in the first argument of \fBinit_pair\fP, see \fBcurs_color\fP(3X)). .\" --------------------------------------------------------------------------- -.SS Change window color +.SS "Change Window Color" The routine \fBcolor_set\fP sets the current color of the given window to the foreground/background combination described by the color \fIpair\fP parameter. .\" --------------------------------------------------------------------------- .SS Standout -.PP The routine \fBstandout\fP is the same as \fBattron(A_STANDOUT)\fP. The routine \fBstandend\fP is the same as \fBattrset(A_NORMAL)\fP or \fBattrset(0)\fP, that is, it turns off all attributes. .PP -X/Open does not mark these \*(``restricted\*('', because +X/Open Curses does not mark these \*(``restricted\*('', because .bP they have well established legacy use, and .bP there is no ambiguity about the way the attributes might be combined with a color pair. .\" --------------------------------------------------------------------------- -.SH VIDEO ATTRIBUTES +.SS "Video Attributes" The following video attributes, defined in \fB<curses.h>\fP, can be passed to the routines \fBattron\fP, \fBattroff\fP, and \fBattrset\fP, or OR'd with the characters passed to \fBaddch\fP (see \fBcurs_addch\fP(3X)). .PP +.ne 15 .RS .TS -l l -_ _ _ -l l . -\fBName\fP \fBDescription\fP -\fBA_NORMAL\fP Normal display (no highlight) -\fBA_STANDOUT\fP Best highlighting mode of the terminal. -\fBA_UNDERLINE\fP Underlining -\fBA_REVERSE\fP Reverse video -\fBA_BLINK\fP Blinking -\fBA_DIM\fP Half bright -\fBA_BOLD\fP Extra bright or bold -\fBA_PROTECT\fP Protected mode -\fBA_INVIS\fP Invisible or blank mode -\fBA_ALTCHARSET\fP Alternate character set -\fBA_ITALIC\fP Italics (non-X/Open extension) -\fBA_CHARTEXT\fP Bit-mask to extract a character -\fBA_COLOR\fP Bit-mask to extract a color (legacy routines) +Lb Lb +Lb Lx. +Name Description +_ +A_NORMAL Normal display (no highlight) +A_STANDOUT T{ +Best highlighting mode of the terminal +T} +A_UNDERLINE Underlining +A_REVERSE Reverse video +A_BLINK Blinking +A_DIM Half bright +A_BOLD Extra bright or bold +A_PROTECT Protected mode +A_INVIS Invisible or blank mode +A_ALTCHARSET Alternate character set +A_ITALIC Italics (non-X/Open extension) +A_CHARTEXT Bit-mask to extract a character +A_COLOR T{ +Bit-mask to extract a color (legacy routines) +T} .TE .RE .PP These video attributes are supported by \fBattr_on\fP and related functions (which also support the attributes recognized by \fBattron\fP, etc.): +.PP .RS .TS -l l -_ _ _ -l l . -\fBName\fP \fBDescription\fP -\fBWA_HORIZONTAL\fP Horizontal highlight -\fBWA_LEFT\fP Left highlight -\fBWA_LOW\fP Low highlight -\fBWA_RIGHT\fP Right highlight -\fBWA_TOP\fP Top highlight -\fBWA_VERTICAL\fP Vertical highlight +Lb Lb +Lb Lx. +Name Description +_ +WA_HORIZONTAL Horizontal highlight +WA_LEFT Left highlight +WA_LOW Low highlight +WA_RIGHT Right highlight +WA_TOP Top highlight +WA_VERTICAL Vertical highlight .TE .RE .PP @@ -318,6 +293,27 @@ The return values of many of these routines are not meaningful (they are implemented as macro-expanded assignments and simply return their argument). The SVr4 manual page claims (falsely) that these routines always return \fB1\fP. .\" --------------------------------------------------------------------------- +.SH RETURN VALUE +All routines return the integer \fBOK\fP on success, or \fBERR\fP on failure. +.PP +X/Open Curses does not specify any error conditions. +.PP +This implementation +.bP +returns an error if the window pointer is null. +.bP +returns an error if the color pair parameter +for \fBwcolor_set\fP is outside the range 0..COLOR_PAIRS\-1. +.bP +does not return an error if either of the parameters of \fBwattr_get\fP +used for retrieving attribute or color pair values is \fBNULL\fP. +.PP +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. +.\" --------------------------------------------------------------------------- .SH NOTES These functions may be macros: .sp @@ -330,9 +326,133 @@ Color pair values can only be OR'd with attributes if the pair number is less than 256. The alternate functions such as \fBcolor_set\fP can pass a color pair value directly. -However, ncurses ABI 4 and 5 simply OR this value +However, \fI\%ncurses\fP ABI 4 and 5 simply OR this value within the alternate functions. -You must use ncurses ABI 6 to support more than 256 color pairs. +You must use \fI\%ncurses\fP ABI 6 to support more than 256 color pairs. +.\" --------------------------------------------------------------------------- +.SH EXTENSIONS +This implementation provides the \fBA_ITALIC\fP attribute for terminals +which have the \fBenter_italics_mode\fP (\fBsitm\fP) +and \fBexit_italics_mode\fP (\fBritm\fP) capabilities. +Italics are not mentioned in X/Open Curses. +Unlike the other video attributes, \fBA_ITALIC\fP is unrelated +to the \fBset_attributes\fP capabilities. +This implementation makes the assumption that +\fBexit_attribute_mode\fP may also reset italics. +.PP +Each of the functions added by XSI Curses has a parameter \fIopts\fP, +which X/Open Curses still (after more than twenty years) documents +as reserved for future use, saying that it should be \fBNULL\fP. +This implementation uses that parameter in ABI 6 for the functions which +have a color pair parameter to support \fIextended color pairs\fP: +.bP +For functions which modify the color, e.g., +\fBwattr_set\fP and \fBwattr_on\fP, +if \fIopts\fP is set it is treated as a pointer to \fBint\fP, +and used to set the color pair instead of the \fBshort\fP \fIpair\fP parameter. +.bP +For functions which retrieve the color, e.g., +\fBwattr_get\fP, +if \fIopts\fP is set it is treated as a pointer to \fBint\fP, +and used to retrieve the color pair as an \fBint\fP value, +in addition to +retrieving it via the standard pointer to \fBshort\fP parameter. +.bP +For functions which turn attributes off, e.g., +\fBwattr_off\fP, +the \fIopts\fP parameter is ignored except +except to check that it is \fBNULL\fP. +.\" --------------------------------------------------------------------------- +.SH PORTABILITY +These functions are described in X/Open Curses, Issue 4. +The standard defined the dedicated type for highlights, +\fBattr_t\fP, which was not defined in SVr4 curses. +The functions taking \fBattr_t\fP arguments were not supported under SVr4. +.PP +Very old versions of this library did not force an update of the screen +when changing the attributes. +Use \fBtouchwin\fP to force the screen to match the updated attributes. +.PP +X/Open Curses states that whether the traditional functions +\fBattron\fP/\fBattroff\fP/\fBattrset\fP can manipulate attributes other than +\fBA_BLINK\fP, \fBA_BOLD\fP, \fBA_DIM\fP, \fBA_REVERSE\fP, \fBA_STANDOUT\fP, or +\fBA_UNDERLINE\fP is \*(``unspecified\*(''. +Under this implementation as well as +SVr4 curses, these functions correctly manipulate all other highlights +(specifically, \fBA_ALTCHARSET\fP, \fBA_PROTECT\fP, and \fBA_INVIS\fP). +.PP +X/Open Curses added these entry points: +.sp +.RS +\fBattr_get\fP, \fBattr_on\fP, +\fBattr_off\fP, \fBattr_set\fP, \fBwattr_on\fP, \fBwattr_off\fP, +\fBwattr_get\fP, \fBwattr_set\fP +.RE +.PP +The new functions are intended to work with +a new series of highlight macros prefixed with \fBWA_\fP. +The older macros have direct counterparts in the newer set of names: +.PP +.RS +.ne 9 +.TS +Lb Lb +Lb Lx. +Name Description +_ +WA_NORMAL Normal display (no highlight) +WA_STANDOUT T{ +Best highlighting mode of the terminal +T} +WA_UNDERLINE Underlining +WA_REVERSE Reverse video +WA_BLINK Blinking +WA_DIM Half bright +WA_BOLD Extra bright or bold +WA_ALTCHARSET Alternate character set +.TE +.RE +.PP +X/Open Curses does not assign values to these symbols, +nor does it state whether or not they are related to the +similarly-named A_NORMAL, etc.: +.bP +X/Open Curses specifies that each pair of corresponding \fBA_\fP +and \fBWA_\fP-using functions operates on the same current-highlight +information. +.bP +However, in some implementations, those symbols have unrelated values. +.IP +For example, the Solaris \fIxpg4\fP (X/Open) curses declares +\fBattr_t\fP to be an unsigned short integer (16-bits), +while \fBchtype\fP is a unsigned integer (32-bits). +The \fBWA_\fP symbols in this case are different from the \fBA_\fP symbols +because they are used for a smaller datatype which does not +represent \fBA_CHARTEXT\fP or \fBA_COLOR\fP. +.IP +In this implementation (as in many others), the values happen to be +the same because it simplifies copying information between +\fBchtype\fP and \fBcchar_t\fP variables. +.bP +Because \fI\%ncurses\fP's \fBattr_t\fP can hold a color pair +(in the \fBA_COLOR\fP field), +a call to +\fBwattr_on\fP, +\fBwattr_off\fP, or +\fBwattr_set\fP +may alter the window's color. +If the color pair information in the attribute parameter is zero, +no change is made to the window's color. +.IP +This is consistent with SVr4 curses; +X/Open Curses does not specify this. +.PP +The X/Open Curses extended conformance level adds new highlights +\fBA_HORIZONTAL\fP, \fBA_LEFT\fP, \fBA_LOW\fP, \fBA_RIGHT\fP, \fBA_TOP\fP, +\fBA_VERTICAL\fP (and corresponding \fBWA_\fP macros for each). +As of August 2013, +no known terminal provides these highlights +(i.e., via the \fBsgr1\fP capability). .\" --------------------------------------------------------------------------- .SH HISTORY X/Open Curses is largely based on SVr4 curses, @@ -391,25 +511,26 @@ the format and size of the defined constants as well as clues such as the alternate character set implementation. A 32-bit library can be used on a 64-bit system, but not necessarily the reverse. -.RS +.PP .TS -l l l l l l -_ _ _ _ _ _ -l l l l l l . -\fBYear\fP \fBSystem\fP \fBArch\fP \fBColor\fP \fBChar\fP \fBNotes\fP -1992 Solaris 5.2 32 6 17 SVr4 curses -1992 HPUX 9 32 no 8 SVr2 curses -1992 AIX 3.2 32 no 23 SVr2 curses -1994 OSF/1 r3 32 no 23 SVr2 curses -1995 HP-UX 10.00 32 6 16 SVr3 \*(``curses_colr\*('' -1995 HP-UX 10.00 32 6 8 SVr4, X/Open curses -1995 Solaris 5.4 32/64 7 16 X/Open curses -1996 AIX 4.2 32 7 16 X/Open curses -1996 OSF/1 r4 32 6 16 X/Open curses -1997 HP-UX 11.00 32 6 8 X/Open curses -2000 U/Win 32/64 7/31 16 uses \fBchtype\fP +Lb Lb Lb Cb S Lb +Lb2 Lb Lb2 Lb2 Lb2 Lb +L L L L L Lx. +\& \& \& Bits \& +Year System Arch Color Char Notes +_ +1992 Solaris 5.2 32 6 17 SVr4 \fIcurses\fP +1992 HP-UX 9 32 no 8 SVr2 \fIcurses\fP +1992 AIX 3.2 32 no 23 SVr2 \fIcurses\fP +1994 OSF/1 r3 32 no 23 SVr2 \fIcurses\fP +1995 HP-UX 10.00 32 6 16 SVr3 \fIcurses_colr\fP +1995 HP-UX 10.00 32 6 8 SVr4, X/Open \fIcurses\fP +1995 Solaris 5.4 32/64 7 16 X/Open \fIcurses\fP +1996 AIX 4.2 32 7 16 X/Open \fIcurses\fP +1996 OSF/1 r4 32 6 16 X/Open \fIcurses\fP +1997 HP-UX 11.00 32 6 8 X/Open \fIcurses\fP +2000 U/Win 32/64 7/31 16 uses \fIchtype\fP .TE -.RE .PP Notes: .RS 3 @@ -424,8 +545,9 @@ That version of curses was dropped with HP-UX 11.30 in 2006. Regarding OSF/1 (and Tru64), .bP These used 64-bit hardware. -Like ncurses, the OSF/1 curses interface is not customized for 32-bit -and 64-bit versions. +Like \fI\%ncurses\fP, +the OSF/1 curses interface is not customized for 32-bit and 64-bit +versions. .bP Unlike other systems which evolved from AT&T code, OSF/1 provided a new implementation for X/Open curses. @@ -462,157 +584,15 @@ BSD curses was improved slightly in 1993/1994 using Keith Bostic's modification to make the library 8-bit clean for \fBnvi\fP(1). He moved \fIstandout\fP attribute to a structure member. .IP -The resulting 4.4BSD curses was replaced by ncurses over the next ten years. +The resulting 4.4BSD curses was replaced by \fI\%ncurses\fP over the +next ten years. .bP U/Win is rarely used now. .\" --------------------------------------------------------------------------- -.SH EXTENSIONS -.PP -This implementation provides the \fBA_ITALIC\fP attribute for terminals -which have the \fBenter_italics_mode\fP (\fBsitm\fP) -and \fBexit_italics_mode\fP (\fBritm\fP) capabilities. -Italics are not mentioned in X/Open Curses. -Unlike the other video attributes, \fBA_ITALIC\fP is unrelated -to the \fBset_attributes\fP capabilities. -This implementation makes the assumption that -\fBexit_attribute_mode\fP may also reset italics. -.PP -Each of the functions added by XSI Curses has a parameter \fIopts\fP, -which X/Open Curses still (after more than twenty years) documents -as reserved for future use, saying that it should be \fBNULL\fP. -This implementation uses that parameter in ABI 6 for the functions which -have a color-pair parameter to support \fIextended color pairs\fP: -.bP -For functions which modify the color, e.g., -\fBwattr_set\fP and \fBwattr_on\fP, -if \fIopts\fP is set it is treated as a pointer to \fBint\fP, -and used to set the color pair instead of the \fBshort\fP \fIpair\fP parameter. -.bP -For functions which retrieve the color, e.g., -\fBwattr_get\fP, -if \fIopts\fP is set it is treated as a pointer to \fBint\fP, -and used to retrieve the color pair as an \fBint\fP value, -in addition to -retrieving it via the standard pointer to \fBshort\fP parameter. -.bP -For functions which turn attributes off, e.g., -\fBwattr_off\fP, -the \fIopts\fP parameter is ignored except -except to check that it is \fBNULL\fP. -.\" --------------------------------------------------------------------------- -.SH PORTABILITY -These functions are supported in the XSI Curses standard, Issue 4. -The standard defined the dedicated type for highlights, -\fBattr_t\fP, which was not defined in SVr4 curses. -The functions taking \fBattr_t\fP arguments were not supported under SVr4. -.PP -Very old versions of this library did not force an update of the screen -when changing the attributes. -Use \fBtouchwin\fP to force the screen to match the updated attributes. -.PP -The XSI Curses standard states that whether the traditional functions -\fBattron\fP/\fBattroff\fP/\fBattrset\fP can manipulate attributes other than -\fBA_BLINK\fP, \fBA_BOLD\fP, \fBA_DIM\fP, \fBA_REVERSE\fP, \fBA_STANDOUT\fP, or -\fBA_UNDERLINE\fP is \*(``unspecified\*(''. -Under this implementation as well as -SVr4 curses, these functions correctly manipulate all other highlights -(specifically, \fBA_ALTCHARSET\fP, \fBA_PROTECT\fP, and \fBA_INVIS\fP). -.PP -XSI Curses added these entry points: -.sp -.RS -\fBattr_get\fP, \fBattr_on\fP, -\fBattr_off\fP, \fBattr_set\fP, \fBwattr_on\fP, \fBwattr_off\fP, -\fBwattr_get\fP, \fBwattr_set\fP -.RE -.PP -The new functions are intended to work with -a new series of highlight macros prefixed with \fBWA_\fP. -The older macros have direct counterparts in the newer set of names: -.PP -.RS -.ne 9 -.TS -l l -_ _ _ -l l . -\fBName\fP \fBDescription\fP -\fBWA_NORMAL\fP Normal display (no highlight) -\fBWA_STANDOUT\fP Best highlighting mode of the terminal. -\fBWA_UNDERLINE\fP Underlining -\fBWA_REVERSE\fP Reverse video -\fBWA_BLINK\fP Blinking -\fBWA_DIM\fP Half bright -\fBWA_BOLD\fP Extra bright or bold -\fBWA_ALTCHARSET\fP Alternate character set -.TE -.RE -.PP -XSI curses does not assign values to these symbols, -nor does it state whether or not they are related to the -similarly-named A_NORMAL, etc.: -.bP -The XSI curses standard specifies that each pair of corresponding \fBA_\fP -and \fBWA_\fP-using functions operates on the same current-highlight -information. -.bP -However, in some implementations, those symbols have unrelated values. -.IP -For example, the Solaris \fIxpg4\fP (X/Open) curses declares -\fBattr_t\fP to be an unsigned short integer (16-bits), -while \fBchtype\fP is a unsigned integer (32-bits). -The \fBWA_\fP symbols in this case are different from the \fBA_\fP symbols -because they are used for a smaller datatype which does not -represent \fBA_CHARTEXT\fP or \fBA_COLOR\fP. -.IP -In this implementation (as in many others), the values happen to be -the same because it simplifies copying information between -\fBchtype\fP and \fBcchar_t\fP variables. -.bP -Because ncurses's \fBattr_t\fP can hold a color pair -(in the \fBA_COLOR\fP field), -a call to -\fBwattr_on\fP, -\fBwattr_off\fP, or -\fBwattr_set\fP -may alter the window's color. -If the color pair information in the attribute parameter is zero, -no change is made to the window's color. -.IP -This is consistent with SVr4 curses; -X/Open Curses does not specify this. -.PP -The XSI standard extended conformance level adds new highlights -\fBA_HORIZONTAL\fP, \fBA_LEFT\fP, \fBA_LOW\fP, \fBA_RIGHT\fP, \fBA_TOP\fP, -\fBA_VERTICAL\fP (and corresponding \fBWA_\fP macros for each). -As of August 2013, -no known terminal provides these highlights -(i.e., via the \fBsgr1\fP capability). -.\" --------------------------------------------------------------------------- -.SH RETURN VALUE -All routines return the integer \fBOK\fP on success, or \fBERR\fP on failure. -.PP -X/Open does not define any error conditions. -.PP -This implementation -.bP -returns an error if the window pointer is null. -.bP -returns an error if the color pair parameter -for \fBwcolor_set\fP is outside the range 0..COLOR_PAIRS\-1. -.bP -does not return an error if either of the parameters of \fBwattr_get\fP -used for retrieving attribute or color-pair values is \fBNULL\fP. -.PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. -.\" --------------------------------------------------------------------------- .SH SEE ALSO -.na -\fBcurses\fP(3X), -\fBcurs_addch\fP(3X), -\fBcurs_addstr\fP(3X), -\fBcurs_bkgd\fP(3X), -\fBcurs_printw\fP(3X), -\fBcurs_variables\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_addch\fP(3X), +\fB\%curs_addstr\fP(3X), +\fB\%curs_bkgd\fP(3X), +\fB\%curs_printw\fP(3X), +\fB\%curs_variables\fP(3X) diff --git a/upstream/archlinux/man3/curs_beep.3x b/upstream/archlinux/man3/curs_beep.3x index 4368045c..f73ace85 100644 --- a/upstream/archlinux/man3/curs_beep.3x +++ b/upstream/archlinux/man3/curs_beep.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2020,2021 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2005,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,17 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_beep.3x,v 1.16 2021/12/25 21:41:58 tom Exp $ -.TH curs_beep 3X "" +.\" $Id: curs_beep.3x,v 1.29 2024/04/20 21:20:07 tom Exp $ +.TH curs_beep 3X 2024-04-20 "ncurses 6.5" "Library calls" .SH NAME -\fBbeep\fP, \fBflash\fP \- \fBcurses\fP bell and screen flash routines +\fB\%beep\fP, +\fB\%flash\fP \- +ring the (visual) bell of the terminal with \fIcurses\fR .SH SYNOPSIS -\fB#include <curses.h>\fP +.nf +\fB#include <curses.h> .PP -\fBint beep(void);\fP -.br -\fBint flash(void);\fP -.br +\fBint beep(void); +\fBint flash(void); +.fi .SH DESCRIPTION The \fBbeep\fP and \fBflash\fP routines are used to alert the terminal user. The routine \fBbeep\fP sounds an audible alarm on the terminal, if possible; @@ -55,7 +57,7 @@ These routines return \fBOK\fP if they succeed in beeping or flashing, SVr4's beep and flash routines always returned \fBOK\fP, so it was not possible to tell when the beep or flash failed. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. Like SVr4, it specifies that they always return \fBOK\fP. .SH SEE ALSO -\fBcurses\fP(3X) +\fB\%curses\fP(3X) diff --git a/upstream/archlinux/man3/curs_bkgd.3x b/upstream/archlinux/man3/curs_bkgd.3x index f9199ce0..db74a318 100644 --- a/upstream/archlinux/man3/curs_bkgd.3x +++ b/upstream/archlinux/man3/curs_bkgd.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,143 +27,200 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_bkgd.3x,v 1.35 2022/06/25 21:55:45 tom Exp $ +.\" $Id: curs_bkgd.3x,v 1.61 2024/04/20 18:54:36 tom Exp $ +.TH curs_bkgd 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.TH curs_bkgd 3X "" .SH NAME -\fBbkgdset\fP, \fBwbkgdset\fP, -\fBbkgd\fP, \fBwbkgd\fP, -\fBgetbkgd\fP \- \fBcurses\fP window background manipulation routines +\fB\%bkgdset\fP, +\fB\%wbkgdset\fP, +\fB\%bkgd\fP, +\fB\%wbkgd\fP, +\fB\%getbkgd\fP \- +manipulate background of a \fIcurses\fR window of characters .SH SYNOPSIS -\fB#include <curses.h>\fP -.PP -\fBvoid bkgdset(chtype \fIch\fB);\fR -.br -\fBvoid wbkgdset(WINDOW *\fIwin, chtype \fIch\fB);\fR -.sp -\fBint bkgd(chtype \fIch\fB);\fR -.br -\fBint wbkgd(WINDOW *\fIwin\fB, chtype \fIch\fB);\fR -.sp -\fBchtype getbkgd(WINDOW *\fIwin\fB);\fR -.br -.SH DESCRIPTION -.SS bkgdset -The \fBbkgdset\fP and \fBwbkgdset\fP routines -set the \fIbackground\fP for a window. -A window's background is a \fBchtype\fP consisting of -any combination of attributes (i.e., rendition) and a character: -.bP -The attribute part of the background is combined (OR'ed) with all non-blank -characters that are written into the window with \fBwaddch\fP. -.bP -Both the character and attribute parts of the background are combined with -blank characters that are written into the window. +.nf +\fB#include <curses.h> .PP -The background becomes a property of each -character and moves with the character through any scrolling and -insert/delete line/character operations. +\fBint bkgd(chtype \fIch\fP); +\fBint wbkgd(WINDOW *\fIwin\fP, chtype \fIch\fP); .PP -To the extent possible on a particular terminal, -the attribute part of the background is displayed -as the graphic rendition of the character put on the screen. -.SS bkgd -.PP -The \fBbkgd\fP and \fBwbkgd\fP functions -set the background property of the current or specified window -and then apply this setting to every character position in that window. -According to X/Open Curses, it should do this: +\fBvoid bkgdset(chtype \fIch\fP); +\fBvoid wbkgdset(WINDOW *\fIwin\fP, chtype \fIch\fP); .PP +\fBchtype getbkgd(WINDOW *\fIwin\fP); +.fi +.SH DESCRIPTION +The +.I background +of a +.I curses +window +(in the library's non-\*(``wide\*('' configuration) +is a +.I \%chtype +combining a set of attributes +(see \fB\%curs_attr\fP(3X)) +with a character called the +.I "blank character." +.PP +The blank character is a spacing character that populates a window's +character cells when their contents are erased without replacement. +The background's attributes are combined with all non-blank characters +written to the window, +as with the \fB\%waddch\fP(3X) and \fB\%winsch\fP(3X) families of +functions. +.PP +The blank character and attributes of the background combine with +characters written to the window as described below. +The background becomes a property of the character and moves with it +through any scrolling and insert/delete line/character operations. +.PP +To the extent possible on a given terminal, +the attribute part of the background is displayed as the graphic +rendition of the character put on the screen. +.SS "bkgd, wbkgd" +\fB\%bkgd\fP and \fB\%wbkgd\fP set the background property of +\fB\%stdscr\fP or the specified window and then apply this setting to +every character cell in that window. .bP -The rendition of every character on the screen is changed to -the new background rendition. +The rendition of every character in the window changes to the new +background rendition. .bP -Wherever the former background character -appears, it is changed to the new background character. -.PP -Neither X/Open Curses nor the SVr4 manual pages give details about -the way the rendition of characters on the screen is updated when -\fBbkgd\fP or \fBwbkgd\fP is used to change the background character. -.PP -This implementation, like SVr4 curses, does not store the background -and window attribute contributions to each cell separately. -It updates the rendition by comparing the character, non-color attributes and -colors contained in the background. -For each cell in the window, whether or not it is blank: +Wherever the former background character appears, +it changes to the new background character. +.PP +.I \%ncurses +updates the rendition of each character cell by comparing the character, +non-color attributes, +and colors. +The library applies to following procedure to each cell in the window, +whether or not it is blank. .bP -The library first compares the \fIcharacter\fP, -and if it matches the current character part of the background, -it replaces that with the new background character. -.IP -When \fBbkgdset\fP is used to set the background character, -that does not update each cell in the window. -A subsequent call to \fBbkgd\fP will only modify the \fIcharacter\fP in -cells which match the current background character. +.I \%ncurses +first compares the cell's character to the previously specified blank +character; +if they match, +.I \%ncurses +writes the new blank character to the cell. .bP -The library then checks if the cell uses color, -i.e., its color pair value is nonzero. -If not, it simply replaces the attributes and color pair in the -cell with those from the new background character. +.I \%ncurses +then checks if the cell uses color, +that is, +its color pair value is nonzero. +If not, +it simply replaces the attributes and color pair in the cell with those +from the new background character. .bP If the cell uses color, -and that matches the color in the current background, -the library removes attributes -which may have come from the current background -and adds attributes from the new background. -It finishes by setting the cell -to use the color from the new background. +and its background color matches that of the current window background, +.I \%ncurses +removes attributes that may have come from the current background and +adds those from the new background. +It finishes by setting the cell's background to use the new window +background color. .bP If the cell uses color, -and that does not match the color in the current background, -the library updates only the non-color attributes, -first removing those which may have come from the current background, +and its background color does not match that of the current window +background, +.I \%ncurses +updates only the non-color attributes, +first removing those that may have come from the current background, and then adding attributes from the new background. .PP -If the background's character value is zero (0), a space is assumed. +.I \%ncurses +treats a background character value of zero (0) as a blank character. .PP If the terminal does not support color, -or if color has not been started with \fBstart_color\fP, -the new background character's color attribute will be ignored. +or if color has not been initialized with \fB\%start_color\fP(3X), +.I \%ncurses +ignores the new background character's color attribute. +.SS "bkgdset, wbkgdset" +\fB\%bkgdset\fP and \fB\%wbkgdset\fP manipulate the background of +the applicable window, +without updating the character cells as \fB\%bkgd\fP and +\fB\%wbkgd\fP do; +only future writes reflect the updated background. .SS getbkgd -.PP -The \fBgetbkgd\fP function returns the given window's current background -character/attribute pair. +\fB\%getbkgd\fP obtains the given window's background character and +attribute combination. .SH RETURN VALUE +Functions returning an \fIint\fP return \fBOK\fP on success. +\fB\%bkgd\fP returns \fBERR\fP if the library has not been initialized. +\fB\%wbkgd\fP and \fB\%getbkgd\fP return \fBERR\fP if a \fI\%WINDOW\fP +pointer argument is null. .PP -These functions are described in the XSI Curses standard, Issue 4. -It specifies that \fBbkgd\fP and \fBwbkgd\fP return \fBERR\fP on failure, -but gives no failure conditions. -.PP -The routines \fBbkgd\fP and \fBwbkgd\fP return the integer \fBOK\fP, -unless the library has not been initialized. +\fB\%bkgdset\fP and \fBwbkgdset\fP do not return a value. .PP -In contrast, -the SVr4.0 manual says \fBbkgd\fP and \fBwbkgd\fP may return \fBOK\fP -"or a non-negative integer if \fBimmedok\fP is set", -which refers to the return value from \fBwrefresh\fP -(used to implement the immediate repainting). -The SVr4 curses \fBwrefresh\fP returns the number of characters -written to the screen during the refresh. -This implementation does not do that. +\fB\%getbkgd\fP returns a window's background character and attribute +combination. .SH NOTES +Unusually, +there is no \fB\%wgetbkgd\fP function; +\fB\%getbkgd\fP behaves as one would expect \fB\%wgetbkgd\fP to, +accepting a \fI\%WINDOW\fP pointer argument. .PP -Note that \fBbkgdset\fP and \fBbkgd\fP may be macros. +\fB\%bkgd\fP and +\fB\%bkgdset\fP +may be implemented as macros. .PP X/Open Curses mentions that the character part of the background must be a single-byte value. -This implementation, like SVr4, checks to ensure that, +\fI\%ncurses\fP, +like SVr4 \fIcurses\fP, +checks to ensure that, and will reuse the old background character if the check fails. .SH PORTABILITY -.PP -These functions are described in the XSI Curses standard, Issue 4 -(X/Open Curses). +X/Open Curses, +Issue 4 describes these functions. +It specifies that +\fB\%bkgd\fP, +\fB\%wbkgd\fP, +and +\fB\%getbkgd\fP +return \fBERR\fP on failure +(in the case of the last, +this value is cast to +.IR \%chtype ), +but describes no failure conditions. +.PP +The SVr4.0 manual says that \fB\%bkgd\fP and \fB\%wbkgd\fP may return +\fBOK\fP +\*(``or a non-negative integer if \fB\%immedok\fP is set\*('', +which refers to the return value from \fB\%wrefresh\fP(3X), +used to implement the immediate repainting. +SVr4 \fIcurses\fP's \fB\%wrefresh\fP returns the number of characters +written to the screen during the refresh. +\fI\%ncurses\fP does not do that. +.PP +Neither X/Open Curses nor the SVr4 manual pages detail how the rendition +of characters on the screen updates when \fB\%bkgd\fP or \fB\%wbkgd\fP +changes the background character. +.IR \%ncurses , +like SVr4 +.IR curses , +does not +(in its non-\*(``wide\*('' configuration) +store the background and window attribute contributions to each +character cell separately. .SH SEE ALSO -.na +\fB\%curs_bkgrnd\fP(3X) describes the corresponding functions in the +\*(``wide\*('' configuration of +.IR \%ncurses . .PP -\fBcurses\fP(3X), -\fBcurs_addch\fP(3X), -\fBcurs_attr\fP(3X), -\fBcurs_outopts\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_addch\fP(3X), +\fB\%curs_attr\fP(3X) diff --git a/upstream/archlinux/man3/curs_bkgrnd.3x b/upstream/archlinux/man3/curs_bkgrnd.3x index e64f9941..809a23f1 100644 --- a/upstream/archlinux/man3/curs_bkgrnd.3x +++ b/upstream/archlinux/man3/curs_bkgrnd.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 2002-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,98 +27,190 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_bkgrnd.3x,v 1.16 2022/06/25 21:57:59 tom Exp $ +.\" $Id: curs_bkgrnd.3x,v 1.42 2024/04/20 18:54:36 tom Exp $ +.TH curs_bkgrnd 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.TH curs_bkgrnd 3X "" .SH NAME -\fBbkgrnd\fP, -\fBwbkgrnd\fP, -\fBbkgrndset\fP, -\fBwbkgrndset\fP, -\fBgetbkgrnd\fP, -\fBwgetbkgrnd\fP \- \fBcurses\fP window complex background manipulation routines +\fB\%bkgrnd\fP, +\fB\%wbkgrnd\fP, +\fB\%bkgrndset\fP, +\fB\%wbkgrndset\fP, +\fB\%getbkgrnd\fP, +\fB\%wgetbkgrnd\fP \- +manipulate background of a \fIcurses\fP window of wide characters .SH SYNOPSIS +.nf +\fB#include <curses.h> .PP -.B #include <curses.h> -.sp -\fBint bkgrnd(\fB const cchar_t *\fIwch\fB);\fR -.br -\fBint wbkgrnd(\fB WINDOW *\fIwin\fB, const cchar_t *\fIwch\fB);\fR -.sp -\fBvoid bkgrndset(const cchar_t *\fIwch\fR \fB);\fR -.br -\fBvoid wbkgrndset(WINDOW *\fIwin\fB, const cchar_t *\fIwch\fB);\fR -.sp -\fBint getbkgrnd(cchar_t *\fIwch\fB);\fR -.br -\fBint wgetbkgrnd(WINDOW *\fIwin\fB, cchar_t *\fIwch\fB);\fR -.br +\fBint bkgrnd(const cchar_t *\fIwch\fP); +\fBint wbkgrnd(WINDOW *\fIwin\fP, const cchar_t *\fIwch\fP); +.PP +\fBvoid bkgrndset(const cchar_t *\fIwch\fP); +\fBvoid wbkgrndset(WINDOW *\fIwin\fP, const cchar_t *\fIwch\fP); +.PP +\fBint getbkgrnd(cchar_t *\fIwch\fP); +\fBint wgetbkgrnd(WINDOW *\fIwin\fP, cchar_t *\fIwch\fP); +.fi .SH DESCRIPTION -.SS bkgrndset +The +.I background +of a +.I curses +window +(in the library's \*(``wide\*('' configuration) +is a +.I \%cchar_t +combining a set of attributes +(see \fB\%curs_attr\fP(3X)) +with a complex character called the +.I "blank character." .PP -The \fBbkgrndset\fP and \fBwbkgrndset\fP routines manipulate the -background of the named window. -The window background is a \fBcchar_t\fP consisting of -any combination of attributes (i.e., rendition) and a complex character. -.bP -The attribute part of the background is combined (OR'ed) with all non-blank -characters that are written into the window with \fBwaddch\fP. -.bP -Both -the character and attribute parts of the background are combined with -the blank characters. +The blank character is a spacing character that populates a window's +character cells when their contents are erased without replacement. +The background's attributes are combined with all non-blank characters +written to the window, +as with the \fB\%wadd_wch\fP(3X) and \fB\%wins_wch\fP(3X) families of +functions. .PP -The background becomes a property of the -character and moves with the character through any scrolling and -insert/delete line/character operations. +The blank character and attributes of the background combine with +characters written to the window as described below. +The background becomes a property of the character and moves with it +through any scrolling and insert/delete line/character operations. .PP -To the extent possible on a -particular terminal, the attribute part of the background is displayed -as the graphic rendition of the character put on the screen. -.SS bkgrnd +To the extent possible on a given terminal, +the attribute part of the background is displayed as the graphic +rendition of the character put on the screen. +.SS "bkgrnd, wbkgrnd" +\fB\%bkgrnd\fP and \fB\%wbkgrnd\fP set the background property of +\fB\%stdscr\fP or the specified window and then apply this setting to +every character cell in that window. +.bP +The rendition of every character in the window changes to the new +background rendition. +.bP +Wherever the former background character appears, +it changes to the new background character. .PP -The \fBbkgrnd\fP and \fBwbkgrnd\fP functions -set the background property of the current or specified window -and then apply this setting to every character position in that window: +.I \%ncurses +updates the rendition of each character cell by comparing the character, +non-color attributes, +and colors. +The library applies to following procedure to each cell in the window, +whether or not it is blank. +.bP +.I \%ncurses +first compares the cell's character to the previously specified blank +character; +if they match, +.I \%ncurses +writes the new blank character to the cell. .bP -The rendition of every character on the screen is changed to -the new background rendition. +.I \%ncurses +then checks if the cell uses color, +that is, +its color pair value is nonzero. +If not, +it simply replaces the attributes and color pair in the cell with those +from the new background character. .bP -Wherever the former background character -appears, it is changed to the new background character. -.SS getbkgrnd +If the cell uses color, +and its background color matches that of the current window background, +.I \%ncurses +removes attributes that may have come from the current background and +adds those from the new background. +It finishes by setting the cell's background to use the new window +background color. +.bP +If the cell uses color, +and its background color does not match that of the current window +background, +.I \%ncurses +updates only the non-color attributes, +first removing those that may have come from the current background, +and then adding attributes from the new background. .PP -The \fBgetbkgrnd\fP function returns the given window's current background -character/attribute pair via the \fBwch\fP pointer. -If the given window pointer is null, -the character is not updated (but no error returned). -.SH NOTES -Note that -\fBbkgrnd\fP, -\fBbkgrndset\fP, and -\fBgetbkgrnd\fP -may be macros. +.I \%ncurses +treats a background character value of zero (0) as a blank character. .PP -X/Open Curses does not provide details on how the rendition is changed. -This implementation follows the approach used in SVr4 curses, -which is explained in the manual page for \fBwbkgd\fP. +If the terminal does not support color, +or if color has not been initialized with \fB\%start_color\fP(3X), +.I \%ncurses +ignores the new background character's color attribute. +.SS "bkgrndset, wbkgrndset" +\fB\%bkgrndset\fP and \fB\%wbkgrndset\fP manipulate the background of +the applicable window, +without updating the character cells as \fB\%bkgrnd\fP and +\fB\%wbkgrnd\fP do; +only future writes reflect the updated background. +.SS "getbkgrnd, wgetbkgrnd" +The \fB\%getbkgrnd\fP and \fB\%wgetbkgrnd\fP functions obtain the +background character and attribute pair of \fB\%stdscr\fP or the +specified window and store it via the +.I wch +pointer. .SH RETURN VALUE +\fBbkgrndset\fP and \fBwbkgrndset\fP do not return a value. .PP -The \fBbkgrndset\fP and \fBwbkgrndset\fP routines do not return a value. -.PP -Upon successful completion, the other functions return \fBOK\fP. -Otherwise, they return \fBERR\fP: +The other functions return +.B ERR +upon failure and +.B OK +upon success. +In +.IR \%ncurses , +failure occurs if .bP -A null window pointer is treated as an error. +a +.I \%WINDOW +pointer +.I win +is null, or .bP -A null character pointer is treated as an error. +a +.I \%cchar_t +pointer +.I wch +is null. +.SH NOTES +\fB\%bkgrnd\fP, +\fB\%bkgrndset\fP, and +\fB\%getbkgrnd\fP +may be implemented as macros. +.PP +Unlike their counterparts in the non-\*(``wide\*('' configuration of +.IR \%ncurses , +\fB\%getbkgrnd\fP and \fB\%wgetbkgrnd\fP supply the background character +and attribute in a modifiable +.I \%cchar_t +parameter, +not as the return value. .SH PORTABILITY +X/Open Curses, +Issue 4 describes these functions. +It specifies no error conditions for them. .PP -These functions are described in the XSI Curses standard, Issue 4 -(X/Open Curses). +X/Open Curses does not provide details of how the rendition is updated. +This implementation follows the approach used in SVr4 +.IR curses . .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_bkgd\fP(3X) +\fB\%curs_bkgd\fP(3X) describes the corresponding functions in the +non-\*(``wide\*('' configuration of +.IR \%ncurses . +.PP +\fB\%curses\fP(3X), +\fB\%curs_add_wch\fP(3X), +\fB\%curs_attr\fP(3X) diff --git a/upstream/archlinux/man3/curs_border.3x b/upstream/archlinux/man3/curs_border.3x index 72683b02..0c95bb34 100644 --- a/upstream/archlinux/man3/curs_border.3x +++ b/upstream/archlinux/man3/curs_border.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2007,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,56 +27,53 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_border.3x,v 1.30 2022/02/12 20:06:41 tom Exp $ -.TH curs_border 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' -.na -.hy 0 +.\" $Id: curs_border.3x,v 1.49 2024/04/20 21:20:07 tom Exp $ +.TH curs_border 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME -\fBborder\fP, -\fBwborder\fP, -\fBbox\fP, -\fBhline\fP, -\fBwhline\fP, -\fBvline\fP, -\fBwvline\fP, -\fBmvhline\fP, -\fBmvwhline\fP, -\fBmvvline\fP, -\fBmvwvline\fP \- create \fBcurses\fP borders, horizontal and vertical lines -.ad -.hy +\fB\%border\fP, +\fB\%wborder\fP, +\fB\%box\fP, +\fB\%hline\fP, +\fB\%whline\fP, +\fB\%vline\fP, +\fB\%wvline\fP, +\fB\%mvhline\fP, +\fB\%mvwhline\fP, +\fB\%mvvline\fP, +\fB\%mvwvline\fP \- +draw borders and lines in a \fIcurses\fR window of characters .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint border(chtype \fIls\fB, chtype \fIrs\fB, chtype \fIts\fB, chtype \fIbs\fB,\fR +.nf +\fB#include <curses.h> +.PP +\fBint border(chtype \fIls\fP, chtype \fIrs\fP, chtype \fIts\fP, chtype \fIbs\fP, \fBchtype \fItl\fB, chtype \fItr\fB, chtype \fIbl\fB, chtype \fIbr\fB);\fR -.br \fBint wborder(WINDOW *\fIwin\fB, chtype \fIls\fB, chtype \fIrs\fB,\fR \fBchtype \fIts\fB, chtype \fIbs\fB, chtype \fItl\fB, chtype \fItr\fB,\fR \fBchtype \fIbl\fB, chtype \fIbr\fB);\fR -.sp +.PP \fBint box(WINDOW *\fIwin\fB, chtype \fIverch\fB, chtype \fIhorch\fB);\fR -.sp +.PP \fBint hline(chtype \fIch\fB, int \fIn\fB);\fR -.br \fBint whline(WINDOW *\fIwin\fB, chtype \fIch\fB, int \fIn\fB);\fR -.br \fBint vline(chtype \fIch\fB, int \fIn\fB);\fR -.br \fBint wvline(WINDOW *\fIwin\fB, chtype \fIch\fB, int \fIn\fB);\fR -.sp +.PP \fBint mvhline(int \fIy\fB, int \fIx\fB, chtype \fIch\fB, int \fIn\fB);\fR -.br \fBint mvwhline(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, chtype \fIch\fB, int \fIn\fB);\fR -.br \fBint mvvline(int \fIy\fB, int \fIx\fB, chtype \fIch\fB, int \fIn\fB);\fR -.br \fBint mvwvline(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, chtype \fIch\fB, int \fIn\fB);\fR -.br +.fi .SH DESCRIPTION The \fBborder\fP, \fBwborder\fP and \fBbox\fP routines draw a box around the edges of a window. @@ -140,24 +137,26 @@ The line is at most \fIn\fP characters long, or as many as fit into the window. .SH RETURN VALUE All routines return the integer \fBOK\fP. -The SVr4.0 manual says "or a -non-negative integer if \fBimmedok\fP is set", but this appears to be an error. +The SVr4.0 manual says +\*(``or a non-negative integer if \fB\%immedok\fP is set\*('', +but this appears to be an error. .PP -X/Open does not define any error conditions. +X/Open Curses does not specify any error conditions. This implementation returns an error if the window pointer is null. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES The borders generated by these functions are \fIinside\fP borders (this is also true of SVr4 curses, though the fact is not documented). .PP Note that \fBborder\fP and \fBbox\fP may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. -The standard specifies that they return \fBERR\fP on failure, -but specifies no error conditions. +These functions are described in X/Open Curses, Issue 4. .SH SEE ALSO -\fBcurses\fP(3X), \fBcurs_outopts\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_outopts\fP(3X) diff --git a/upstream/archlinux/man3/curs_border_set.3x b/upstream/archlinux/man3/curs_border_set.3x index 9d79b25c..d01849e3 100644 --- a/upstream/archlinux/man3/curs_border_set.3x +++ b/upstream/archlinux/man3/curs_border_set.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2021,2022 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 2002-2011,2012 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,85 +27,77 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_border_set.3x,v 1.16 2022/02/12 20:06:41 tom Exp $ -.TH curs_border_set 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' -.na -.hy 0 +.\" $Id: curs_border_set.3x,v 1.36 2024/04/20 21:20:07 tom Exp $ +.TH curs_border_set 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME -\fBborder_set\fP, -\fBwborder_set\fP, -\fBbox_set\fP, -\fBhline_set\fP, -\fBwhline_set\fP, -\fBmvhline_set\fP, -\fBmvwhline_set\fP, -\fBvline_set\fP, -\fBwvline_set\fP, -\fBmvvline_set\fP, -\fBmvwvline_set\fP \- create \fBcurses\fP borders or lines using complex characters and renditions -.ad -.hy +\fB\%border_set\fP, +\fB\%wborder_set\fP, +\fB\%box_set\fP, +\fB\%hline_set\fP, +\fB\%whline_set\fP, +\fB\%mvhline_set\fP, +\fB\%mvwhline_set\fP, +\fB\%vline_set\fP, +\fB\%wvline_set\fP, +\fB\%mvvline_set\fP, +\fB\%mvwvline_set\fP \- +draw borders and lines in a \fIcurses\fR window of wide characters .SH SYNOPSIS +.nf +\fB#include <curses.h> .PP -\fB#include <curses.h>\fP -.sp -\fBint border_set(\fP - \fBconst cchar_t *\fIls\fR, \fBconst cchar_t *\fIrs\fR, - \fBconst cchar_t *\fIts\fR, \fBconst cchar_t *\fIbs\fR, - \fBconst cchar_t *\fItl\fR, \fBconst cchar_t *\fItr\fR, - \fBconst cchar_t *\fIbl\fR, \fBconst cchar_t *\fIbr\fR -\fB);\fP +\fBint border_set( + \fBconst cchar_t *\fIls\fB, const cchar_t *\fIrs\fP, + \fBconst cchar_t *\fIts\fB, const cchar_t *\fIbs\fP, + \fBconst cchar_t *\fItl\fB, const cchar_t *\fItr\fP, + \fBconst cchar_t *\fIbl\fB, const cchar_t *\fIbr\fB);\fR .br \fBint wborder_set(\fP - \fBWINDOW *win\fP, - \fBconst cchar_t *\fIls\fR, \fBconst cchar_t *\fIrs\fR, - \fBconst cchar_t *\fIts\fR, \fBconst cchar_t *\fIbs\fR, - \fBconst cchar_t *\fItl\fR, \fBconst cchar_t *\fItr\fR, - \fBconst cchar_t *\fIbl\fR, \fBconst cchar_t *\fIbr\fB);\fR -.br + \fBWINDOW *\fIwin\fP, + \fBconst cchar_t *\fIls\fB, const cchar_t *\fIrs\fP, + \fBconst cchar_t *\fIts\fB, const cchar_t *\fIbs\fP, + \fBconst cchar_t *\fItl\fB, const cchar_t *\fItr\fP, + \fBconst cchar_t *\fIbl\fB, const cchar_t *\fIbr\fB);\fR \fBint box_set(\fP - \fBWINDOW *win\fP, - \fBconst cchar_t *\fIverch\fR, + \fBWINDOW *\fIwin\fP, + \fBconst cchar_t *\fIverch\fP, \fBconst cchar_t *\fIhorch\fB);\fR -.br \fBint hline_set(\fP - \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR -.br + \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR \fBint whline_set(\fP - \fBWINDOW *\fIwin\fR, - \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR -.br + \fBWINDOW *\fIwin\fP, + \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR \fBint mvhline_set(\fP - \fBint \fIy\fR, \fBint \fIx\fR, - \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR -.br + \fBint \fIy\fB, int \fIx\fP, + \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR \fBint mvwhline_set(\fP - \fBWINDOW *\fIwin\fR, - \fBint \fIy\fR, \fBint \fIx\fR, - \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR -.br + \fBWINDOW *\fIwin\fP, + \fBint \fIy\fB, int \fIx\fP, + \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR \fBint vline_set(\fP - \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR -.br + \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR \fBint wvline_set(\fP - \fBWINDOW *\fIwin\fR, - \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR -.br + \fBWINDOW *\fIwin\fP, + \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR \fBint mvvline_set(\fP - \fBint \fIy\fR, \fBint \fIx\fR, - \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR -.br + \fBint \fIy\fB, int \fIx\fP, + \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR \fBint mvwvline_set(\fP - \fBWINDOW *\fIwin\fR, - \fBint \fIy\fR, \fBint \fIx\fR, - \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR -.br + \fBWINDOW *\fIwin\fP, + \fBint \fIy\fB, int \fIx\fP, + \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR +.fi .SH DESCRIPTION -.PP The \fBborder_set\fP and @@ -179,9 +171,20 @@ The \fBmvwvline_set\fP, and \fBwvline_set\fP functions draw a line proceeding toward the last line of the window. -.br -.SH NOTES +.SH RETURN VALUE +Upon successful completion, these functions return +\fBOK\fP. +Otherwise, they return +\fBERR\fP. .PP +Functions using a window parameter return an error if it is null. +.PP +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. +.SH NOTES Note that \fBborder_set\fP, \fBhline_set\fP, @@ -191,21 +194,10 @@ Note that \fBmvwvline_set\fP, and \fBvline_set\fP may be macros. -.br -.SH RETURN VALUE -.PP -Upon successful completion, these functions return -\fBOK\fP. -Otherwise, they return -\fBERR\fP. -.PP -Functions using a window parameter return an error if it is null. -.PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +.SH PORTABILITY +These functions are described in X/Open Curses, Issue 4. .SH SEE ALSO -\fBncurses\fP(3X), -\fBcurs_add_wch\fP(3X), -\fBcurs_border\fP(3X), -\fBcurs_outopts\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_add_wch\fP(3X), +\fB\%curs_border\fP(3X), +\fB\%curs_outopts\fP(3X) diff --git a/upstream/archlinux/man3/curs_clear.3x b/upstream/archlinux/man3/curs_clear.3x index 36ff2781..f0ebf8be 100644 --- a/upstream/archlinux/man3/curs_clear.3x +++ b/upstream/archlinux/man3/curs_clear.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2016 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,65 +27,67 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_clear.3x,v 1.27 2022/11/26 16:23:47 tom Exp $ -.TH curs_clear 3X "" -.na -.hy 0 +.\" $Id: curs_clear.3x,v 1.48 2024/04/20 21:20:07 tom Exp $ +.TH curs_clear 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBerase\fP, -\fBwerase\fP, -\fBclear\fP, -\fBwclear\fP, -\fBclrtobot\fP, -\fBwclrtobot\fP, -\fBclrtoeol\fP, -\fBwclrtoeol\fP \- clear all or part of a \fBcurses\fP window -.ad -.hy +\fB\%erase\fP, +\fB\%werase\fP, +\fB\%clear\fP, +\fB\%wclear\fP, +\fB\%clrtobot\fP, +\fB\%wclrtobot\fP, +\fB\%clrtoeol\fP, +\fB\%wclrtoeol\fP \- +clear all or part of a \fIcurses\fR window .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint erase(void);\fP -.br -\fBint werase(WINDOW *\fIwin\fB);\fR -.sp -\fBint clear(void);\fP -.br -\fBint wclear(WINDOW *\fIwin\fB);\fR -.sp -\fBint clrtobot(void);\fP -.br -\fBint wclrtobot(WINDOW *\fIwin\fB);\fR -.sp -\fBint clrtoeol(void);\fP -.br -\fBint wclrtoeol(WINDOW *\fIwin\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBint erase(void); +\fBint werase(WINDOW *\fIwin\fP); +.PP +\fBint clear(void); +\fBint wclear(WINDOW *\fIwin\fP); +.PP +\fBint clrtobot(void); +\fBint wclrtobot(WINDOW *\fIwin\fP); +.PP +\fBint clrtoeol(void); +\fBint wclrtoeol(WINDOW *\fIwin\fP); +.fi .SH DESCRIPTION -.SS erase/werase +.SS "erase, werase" The \fBerase\fP and \fBwerase\fP routines copy blanks to every position in the window, clearing the screen. .PP Blanks created by erasure have the current background rendition (as set by \fBwbkgdset\fP(3X)) merged into them. -.SS clear/wclear -.PP +.SS "clear, wclear" The \fBclear\fP and \fBwclear\fP routines are like \fBerase\fP and \fBwerase\fP, but they also call \fBclearok\fP(3X), so that the screen is cleared completely on the next call to \fBwrefresh\fP for that window and repainted from scratch. -.SS clrtobot/wclrtobot -.PP +.SS "clrtobot, wclrtobot" The \fBclrtobot\fP and \fBwclrtobot\fP routines erase from the cursor to the end of screen. That is, they erase all lines below the cursor in the window. Also, the current line to the right of the cursor, inclusive, is erased. -.SS clrtoeol/wclrtoeol -.PP +.SS "clrtoeol, wclrtoeol" The \fBclrtoeol\fP and \fBwclrtoeol\fP routines erase the current line to the right of the cursor, inclusive, to the end of the current line. .SH RETURN VALUE @@ -102,13 +104,10 @@ if the cursor position is about to wrap. Note that \fBerase\fP, \fBwerase\fP, \fBclear\fP, \fBwclear\fP, \fBclrtobot\fP, and \fBclrtoeol\fP may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. -The -standard specifies that they return \fBERR\fP on failure, but specifies no -error conditions. +These functions are described in X/Open Curses, Issue 4. .PP -The SVr4.0 manual says that these functions could -return "a non-negative integer if \fBimmedok\fP(3X) is set", +The SVr4.0 manual says that these functions could return +\*(``or a non-negative integer if \fB\%immedok\fP is set\*('', referring to the return-value of \fBwrefresh\fP. In that implementation, \fBwrefresh\fP would return a count of the number of characters written to the terminal. @@ -117,7 +116,7 @@ Some historic curses implementations had, as an undocumented feature, the ability to do the equivalent of \fBclearok(..., 1)\fP by saying \fBtouchwin(stdscr)\fP or \fBclear(stdscr)\fP. This will not work under -ncurses. +\fI\%ncurses\fP. .PP This implementation, and others such as Solaris, sets the current position to 0,0 after erasing @@ -132,7 +131,7 @@ even for a subwindow or derived window. If you do not want to clear the screen during the next \fBwrefresh\fP, use \fBwerase\fP instead. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_outopts\fP(3X), -\fBcurs_refresh\fP(3X), -\fBcurs_variables\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_outopts\fP(3X), +\fB\%curs_refresh\fP(3X), +\fB\%curs_variables\fP(3X) diff --git a/upstream/archlinux/man3/curs_color.3x b/upstream/archlinux/man3/curs_color.3x index 92fc81c1..a68c0d0b 100644 --- a/upstream/archlinux/man3/curs_color.3x +++ b/upstream/archlinux/man3/curs_color.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,145 +27,164 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_color.3x,v 1.69 2023/04/23 20:53:20 tom Exp $ -.TH curs_color 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_color.3x,v 1.100 2024/04/20 21:24:19 tom Exp $ +.TH curs_color 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.ds n 5 -.na -.hy 0 +. .SH NAME -\fBstart_color\fP, -\fBhas_colors\fP, -\fBcan_change_color\fP, -\fBinit_pair\fP, -\fBinit_color\fP, -\fBinit_extended_pair\fP, -\fBinit_extended_color\fP, -\fBcolor_content\fP, -\fBpair_content\fP, -\fBextended_color_content\fP, -\fBextended_pair_content\fP, -\fBreset_color_pairs\fP, -\fBCOLOR_PAIR\fP, -\fBPAIR_NUMBER\fP \- \fBcurses\fP color manipulation routines -.ad -.hy +\fB\%start_color\fP, +\fB\%has_colors\fP, +\fB\%can_change_color\fP, +\fB\%init_pair\fP, +\fB\%init_color\fP, +\fB\%init_extended_pair\fP, +\fB\%init_extended_color\fP, +\fB\%color_content\fP, +\fB\%pair_content\fP, +\fB\%extended_color_content\fP, +\fB\%extended_pair_content\fP, +\fB\%reset_color_pairs\fP, +\fB\%COLOR_PAIR\fP, +\fB\%PAIR_NUMBER\fP, +\fB\%COLORS\fP, +\fB\%COLOR_PAIRS\fP, +\fB\%COLOR_BLACK\fP, +\fB\%COLOR_RED\fP, +\fB\%COLOR_GREEN\fP, +\fB\%COLOR_YELLOW\fP, +\fB\%COLOR_BLUE\fP, +\fB\%COLOR_MAGENTA\fP, +\fB\%COLOR_CYAN\fP, +\fB\%COLOR_WHITE\fP \- +manipulate terminal colors with \fIcurses\fR .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint start_color(void);\fP -.sp -\fBbool has_colors(void);\fP -.br -\fBbool can_change_color(void);\fP -.sp -\fBint init_pair(short \fIpair\fB, short \fIf\fB, short \fIb\fB);\fR -.br -\fBint init_color(short \fIcolor\fB, short \fIr\fB, short \fIg\fB, short \fIb\fB);\fR -.br -/* extensions */ -.br -\fBint init_extended_pair(int \fIpair\fB, int \fIf\fB, int \fIb\fB);\fR -.br -\fBint init_extended_color(int \fIcolor\fB, int \fIr\fB, int \fIg\fB, int \fIb\fB);\fR -.sp -\fBint color_content(short \fIcolor\fB, short *\fIr\fB, short *\fIg\fB, short *\fIb\fB);\fR -.br -\fBint pair_content(short \fIpair\fB, short *\fIf\fB, short *\fIb\fB);\fR -.br -/* extensions */ -.br -\fBint extended_color_content(int \fIcolor\fB, int *\fIr\fB, int *\fIg\fB, int *\fIb\fB);\fR -.br -\fBint extended_pair_content(int \fIpair\fB, int *\fIf\fB, int *\fIb\fB);\fR -.sp -/* extensions */ -.br -\fBvoid reset_color_pairs(void);\fP -.sp -\fBint COLOR_PAIR(int \fIn\fB);\fR -.br -\fBPAIR_NUMBER(\fIattrs\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fI/* variables */ +\fBint COLOR_PAIRS; +\fBint COLORS; +.PP +\fBint start_color(void); +.PP +\fBbool has_colors(void); +\fBbool can_change_color(void); +.PP +\fBint init_pair(short \fIpair\fP, short \fIf\fP, short \fIb\fP); +\fBint init_color(short \fIcolor\fP, short \fIr\fP, short \fIg\fP, short \fIb\fP); +\fI/* extensions */ +\fBint init_extended_pair(int \fIpair\fP, int \fIf\fP, int \fIb\fP); +\fBint init_extended_color(int \fIcolor\fP, int \fIr\fP, int \fIg\fP, int \fIb\fP); +.PP +\fBint color_content(short \fIcolor\fP, short *\fIr\fP, short *\fIg\fP, short *\fIb\fP); +\fBint pair_content(short \fIpair\fP, short *\fIf\fP, short *\fIb\fP); +\fI/* extensions */ +\fBint extended_color_content(int \fIcolor\fP, int *\fIr\fP, int *\fIg\fP, int *\fIb\fP); +\fBint extended_pair_content(int \fIpair\fP, int *\fIf\fP, int *\fIb\fP); +.PP +\fI/* extension */ +\fBvoid reset_color_pairs(void); +.PP +\fBint COLOR_PAIR(int \fIn\fP); +\fBPAIR_NUMBER(int \fIattr\fP); +.fi .SH DESCRIPTION .SS Overview -\fBcurses\fP supports color attributes on terminals with that capability. -To use these routines \fBstart_color\fP must be called, usually right after -\fBinitscr\fP. -Colors are always used in pairs (referred to as color-pairs). -A color-pair consists of a foreground color (for characters) and a background -color (for the blank field on which the characters are displayed). -A programmer initializes a color-pair with the routine \fBinit_pair\fP. -After it has been initialized, \fBCOLOR_PAIR\fP(\fIn\fP) -can be used to convert the pair to a video attribute. -.PP -If a terminal is capable of redefining colors, the programmer can use the -routine \fBinit_color\fP to change the definition of a color. -The routines \fBhas_colors\fP and \fBcan_change_color\fP +\fIcurses\fP supports color attributes on terminals with that +capability. +Call \fB\%start_color\fP +(typically right after \fB\%initscr\fP(3X)) +to enable this feature. +Colors are always used in pairs. +A +.I "color pair" +couples a foreground color for characters with a background color for +the blank field on which characters are rendered. +\fB\%init_pair\fP initializes a color pair. +The macro \fB\%COLOR_PAIR\fP(\fIn\fP) can then convert the pair to a +video attribute. +.PP +If a terminal has the relevant capability, +\fB\%init_color\fP permits (re)definition of a color. +\fB\%has_colors\fP and \fB\%can_change_color\fP return \fBTRUE\fP or \fBFALSE\fP, -depending on whether the terminal has color capabilities and whether the +depending on whether the terminal has color capability and whether the programmer can change the colors. -The routine \fBcolor_content\fP allows a -programmer to extract the amounts of red, green, and blue components in an -initialized color. -The routine \fBpair_content\fP allows a programmer to find -out how a given color-pair is currently defined. -.SS Color Rendering -The \fBcurses\fP library combines these inputs to produce the -actual foreground and background colors shown on the screen: +\fB\%color_content\fP permits extraction of the +red, +green, +and blue components of an initialized color. +\fB\%pair_content\fP permits discovery of a color pair's current +definition. +.SS Rendering +.I curses +combines the following data to render a character cell. +Any of them can include color information. .bP -per-character video attributes (e.g., via \fBwaddch\fP), +.I curses +character attributes, +as from \fB\%waddch\fP(3X) or \fB\%wadd_wch\fP(3X) .bP -the window attribute (e.g., by \fBwattrset\fP), and +window attributes, +as from \fB\%wattrset\fP(3X) or \fB\%wattr_set\fP(3X) .bP -the background character (e.g., \fBwbkgdset\fP). +window background character attributes, +as from \fB\%wbkgdset\fP(3X) or \fB\%wbkgrndset\fP(3X) .PP -Per-character and window attributes are usually set by a parameter containing -video attributes including a color pair value. -Some functions such as \fBwattr_set\fP use a separate parameter which -is the color pair number. +Per-character and window attributes are usually set through a function +parameter containing attributes including a color pair value. +Some functions, +such as \fB\%wattr_set\fP, +use a separate color pair number parameter. .PP -The background character is a special case: it includes a character value, -just as if it were passed to \fBwaddch\fP. +The background character is a special case: +it includes a character code, +just as if it were passed to \fB\%waddch\fP. .PP -The \fBcurses\fP library does the actual work of combining these color -pairs in an internal function called from \fBwaddch\fP: +The \fIcurses\fP library does the actual work of combining these color +pairs in an internal function called from \fB\%waddch\fP: .bP -If the parameter passed to \fBwaddch\fP is \fIblank\fP, +If the parameter passed to \fB\%waddch\fP is \fIblank\fP, and it uses the special color pair 0, .RS .bP -\fBcurses\fP next checks the window attribute. +\fIcurses\fP next checks the window attribute. .bP If the window attribute does not use color pair 0, -\fBcurses\fP uses the color pair from the window attribute. +\fIcurses\fP uses the color pair from the window attribute. .bP -Otherwise, \fBcurses\fP uses the background character. +Otherwise, \fIcurses\fP uses the background character. .RE .bP -If the parameter passed to \fBwaddch\fP is \fInot blank\fP, +If the parameter passed to \fB\%waddch\fP is \fInot blank\fP, or it does not use the special color pair 0, -\fBcurses\fP prefers the color pair from the parameter, +\fIcurses\fP prefers the color pair from the parameter, if it is nonzero. Otherwise, it tries the window attribute next, and finally the background character. .PP -Some \fBcurses\fP functions such as \fBwprintw\fP call \fBwaddch\fP. +Some \fIcurses\fP functions such as \fB\%wprintw\fP call \fB\%waddch\fP. Those do not combine its parameter with a color pair. Consequently those calls use only the window attribute or the background character. .SH CONSTANTS -.PP -In \fB<curses.h>\fP the following macros are defined. +In \fB\%<curses.h>\fP the following macros are defined. These are the standard colors (ISO-6429). -\fBcurses\fP also assumes that \fBCOLOR_BLACK\fP is the default +\fIcurses\fP also assumes that \fB\%COLOR_BLACK\fP is the default background color for all terminals. .PP .nf @@ -183,38 +202,51 @@ Some terminals support more than the eight (8) \*(``ANSI\*('' colors. There are no standard names for those additional colors. .SH VARIABLES .SS COLORS -is initialized by \fBstart_color\fP to the maximum number of colors +is initialized by \fB\%start_color\fP to the maximum number of colors the terminal can support. .SS COLOR_PAIRS -is initialized by \fBstart_color\fP to the maximum number of color pairs -the terminal can support. +is initialized by \fB\%start_color\fP to the maximum number of color +pairs the terminal can support. +Often, +its value is the product \fB\%COLORS\fP \(mu \fB\%COLORS\fP, +but this is not always true. +.bP +A few terminals use the HLS color space +(see \fB\%start_color\fP below), +ignoring this rule; +and +.bP +terminals supporting a large number of colors are limited to the number +of color pairs that a +.I "signed short" +value can represent. .SH FUNCTIONS .SS start_color -The \fBstart_color\fP routine requires no arguments. +The \fB\%start_color\fP routine requires no arguments. It must be called if the programmer wants to use colors, and before any other color manipulation routine is called. -It is good practice to call this routine right after \fBinitscr\fP. -\fBstart_color\fP does this: +It is good practice to call this routine right after \fB\%initscr\fP. +\fB\%start_color\fP does this: .bP -It initializes two global variables, \fBCOLORS\fP and -\fBCOLOR_PAIRS\fP (respectively defining the maximum number of colors -and color-pairs the terminal can support). +It initializes two global variables, \fB\%COLORS\fP and +\fB\%COLOR_PAIRS\fP (respectively defining the maximum number of colors +and color pairs the terminal can support). .bP -It initializes the special color pair \fB0\fP to the default foreground +It initializes the special color pair \fB\%0\fP to the default foreground and background colors. No other color pairs are initialized. .bP It restores the colors on the terminal to the values they had when the terminal was just turned on. .bP -If the terminal supports the \fBinitc\fP (\fBinitialize_color\fP) capability, -\fBstart_color\fP +If the terminal supports the \fBinitc\fP \%(\fBinitialize_color\fP) capability, +\fB\%start_color\fP initializes its internal table representing the red, green, and blue components of the color palette. .IP The components depend on whether the terminal uses CGA (aka \*(``ANSI\*('') or -HLS (i.e., the \fBhls\fP (\fBhue_lightness_saturation\fP) capability is set). +HLS (i.e., the \fBhls\fP \%(\fBhue_lightness_saturation\fP) capability is set). The table is initialized first for eight basic colors (black, red, green, yellow, blue, magenta, cyan, and white), using weights that depend upon the CGA/HLS choice. @@ -229,28 +261,28 @@ but with weights of \fB1000\fP. SVr4 uses a similar scheme, but uses \fB1000\fP for the components of the initial eight colors. .IP -\fBstart_color\fP does not attempt to set the terminal's color palette +\fB\%start_color\fP does not attempt to set the terminal's color palette to match its built-in table. -An application may use \fBinit_color\fP to alter the internal table +An application may use \fB\%init_color\fP to alter the internal table along with the terminal's color. .PP These limits apply to color values and color pairs. -Values outside these limits are not legal, and may result in a runtime error: +Values outside these limits are not valid, and may result in a runtime error: .bP -\fBCOLORS\fP corresponds to the terminal database's \fBmax_colors\fP capability, -(see \fBterminfo\fP(\*n)). +\fBCOLORS\fP corresponds to the terminal database's \fB\%max_colors\fP capability, +(see \fB\%terminfo\fP(5)). .bP -color values are expected to be in the range \fB0\fP to \fBCOLORS\-1\fP, -inclusive (including \fB0\fP and \fBCOLORS\-1\fP). +color values are expected to be in the range \fB0\fP to \fB\%COLORS\-1\fP, +inclusive (including \fB0\fP and \fB\%COLORS\-1\fP). .bP a special color value \fB\-1\fP is used in certain extended functions -to denote the \fIdefault color\fP (see \fBuse_default_colors\fP(3X)). +to denote the \fIdefault color\fP (see \fB\%use_default_colors\fP(3X)). .bP -\fBCOLOR_PAIRS\fP corresponds to -the terminal database's \fBmax_pairs\fP capability, -(see \fBterminfo\fP(\*n)). +\fB\%COLOR_PAIRS\fP corresponds to +the terminal database's \fB\%max_pairs\fP capability, +(see \fB\%terminfo\fP(5)). .bP -legal color pair values are in the range \fB1\fP to \fBCOLOR_PAIRS\-1\fP, +valid color pair values are in the range \fB1\fP to \fB\%COLOR_PAIRS\-1\fP, inclusive. .bP color pair \fB0\fP is special; it denotes \*(``no color\*(''. @@ -259,143 +291,134 @@ Color pair \fB0\fP is assumed to be white on black, but is actually whatever the terminal implements before color is initialized. It cannot be modified by the application. .SS has_colors -.PP -The \fBhas_colors\fP routine requires no arguments. +The \fB\%has_colors\fP routine requires no arguments. It returns \fBTRUE\fP if the terminal can manipulate colors; otherwise, it returns \fBFALSE\fP. This routine facilitates writing terminal-independent programs. For example, a programmer can use it to decide whether to use color or some other video attribute. .SS can_change_color -.PP -The \fBcan_change_color\fP routine requires no arguments. +The \fB\%can_change_color\fP routine requires no arguments. It returns \fBTRUE\fP if the terminal supports colors and can change their definitions; other, it returns \fBFALSE\fP. This routine facilitates writing terminal-independent programs. .SS init_pair -.PP -The \fBinit_pair\fP routine changes the definition of a color-pair. +The \fB\%init_pair\fP routine changes the definition of a color pair. It takes three arguments: -the number of the color-pair to be changed, the foreground +the number of the color pair to be changed, the foreground color number, and the background color number. For portable applications: .bP -The first argument must be a legal color pair value. -If default colors are used (see \fBuse_default_colors\fP(3X)) +The first argument must be a valid color pair value. +If default colors are used (see \fB\%use_default_colors\fP(3X)) the upper limit is adjusted to allow for extra pairs which use a default color in foreground and/or background. .bP -The second and third arguments must be legal color values. +The second and third arguments must be valid color values. .PP -If the color-pair was previously initialized, -the screen is refreshed and all occurrences of that color-pair +If the color pair was previously initialized, +the screen is refreshed and all occurrences of that color pair are changed to the new definition. .PP -As an extension, ncurses allows you to set color pair \fB0\fP via -the \fBassume_default_colors\fP(3X) routine, or to specify the use of +As an extension, +\fI\%ncurses\fP allows you to set color pair \fB0\fP via the +\fB\%assume_default_colors\fP(3X) routine, or to specify the use of default colors (color number \fB\-1\fP) if you first invoke the -\fBuse_default_colors\fP(3X) routine. +\fB\%use_default_colors\fP(3X) routine. .SS init_extended_pair -.PP -Because \fBinit_pair\fP uses signed \fBshort\fPs for its parameters, -that limits color-pairs and color-values +Because \fB\%init_pair\fP uses signed \fBshort\fPs for its parameters, +that limits color pairs and color-values to 32767 on modern hardware. -The extension \fBinit_extended_pair\fP uses \fBint\fPs -for the color-pair and color-value, +The extension \fB\%init_extended_pair\fP uses \fBint\fPs +for the color pair and color-value, allowing a larger number of colors to be supported. .SS init_color -.PP -The \fBinit_color\fP routine changes the definition of a color. +The \fB\%init_color\fP routine changes the definition of a color. It takes four arguments: the number of the color to be changed followed by three RGB values (for the amounts of red, green, and blue components). .bP -The first argument must be a legal color value; +The first argument must be a valid color value; default colors are not allowed here. -(See the section \fBColors\fP for the default color index.) +(See the section \fB\%Colors\fP for the default color index.) .bP Each of the last three arguments must be a value in the range \fB0\fP through \fB1000\fP. .PP -When \fBinit_color\fP is used, all +When \fB\%init_color\fP is used, all occurrences of that color on the screen immediately change to the new definition. .SS init_extended_color -.PP -Because \fBinit_color\fP uses signed \fBshort\fPs for its parameters, +Because \fB\%init_color\fP uses signed \fBshort\fPs for its parameters, that limits color-values and their red, green, and blue components to 32767 on modern hardware. -The extension \fBinit_extended_color\fP uses \fBint\fPs +The extension \fB\%init_extended_color\fP uses \fBint\fPs for the color value and for setting the red, green, and blue components, allowing a larger number of colors to be supported. .SS color_content -.PP -The \fBcolor_content\fP routine gives programmers a way to find the intensity +The \fB\%color_content\fP routine gives programmers a way to find the intensity of the red, green, and blue (RGB) components in a color. It requires four arguments: the color number, and three addresses of \fBshort\fRs for storing the information about the amounts of red, green, and blue components in the given color. .bP -The first argument must be a legal color value, i.e., -\fB0\fP through \fBCOLORS\-1\fP, inclusive. +The first argument must be a valid color value, i.e., +\fB0\fP through \fB\%COLORS\-1\fP, inclusive. .bP The values that are stored at the addresses pointed to by the last three arguments are in the range \fB0\fP (no component) through \fB1000\fP (maximum amount of component), inclusive. .SS extended_color_content -.PP -Because \fBcolor_content\fP uses signed \fBshort\fPs for its parameters, +Because \fB\%color_content\fP uses signed \fBshort\fPs for its parameters, that limits color-values and their red, green, and blue components to 32767 on modern hardware. -The extension \fBextended_color_content\fP uses \fBint\fPs +The extension \fB\%extended_color_content\fP uses \fBint\fPs for the color value and for returning the red, green, and blue components, allowing a larger number of colors to be supported. .SS pair_content -.PP -The \fBpair_content\fP routine allows programmers to find out what colors a -given color-pair consists of. -It requires three arguments: the color-pair +The \fB\%pair_content\fP routine allows programmers to find out what colors a +given color pair consists of. +It requires three arguments: the color pair number, and two addresses of \fBshort\fRs for storing the foreground and the background color numbers. .bP -The first argument must be a legal color value, -i.e., in the range \fB1\fP through \fBCOLOR_PAIRS\-1\fP, inclusive. +The first argument must be a valid color value, +i.e., in the range \fB1\fP through \fB\%COLOR_PAIRS\-1\fP, inclusive. .bP The values that are stored at the addresses pointed to by the second and third arguments are in the -range \fB0\fP through \fBCOLORS\fP, inclusive. +range \fB0\fP through \fB\%COLORS\fP, inclusive. .SS extended_pair_content -.PP -Because \fBpair_content\fP uses signed \fBshort\fPs for its parameters, -that limits color-pair and color-values to 32767 on modern hardware. -The extension \fBextended_pair_content\fP uses \fBint\fPs +Because \fB\%pair_content\fP uses signed \fBshort\fPs for its parameters, +that limits color pair and color-values to 32767 on modern hardware. +The extension \fB\%extended_pair_content\fP uses \fBint\fPs for the color pair and for returning the foreground and background colors, allowing a larger number of colors to be supported. .SS reset_color_pairs -.PP -The extension \fBreset_color_pairs\fP tells ncurses to discard all -of the color-pair information which was set with \fBinit_pair\fP. +The extension \fB\%reset_color_pairs\fP tells \fI\%ncurses\fP to discard +all of the color pair information which was set with \fB\%init_pair\fP. It also touches the current- and standard-screens, allowing an application to switch color palettes rapidly. -.SS PAIR_NUMBER -.PP -\fBPAIR_NUMBER(\fIattrs\fR) extracts the color -value from its \fIattrs\fP parameter and returns it as a color pair number. .SS COLOR_PAIR -Its inverse \fBCOLOR_PAIR(\fIn\fB)\fR converts a color pair number -to an attribute. +\fB\%COLOR_PAIR(\fIn\fB)\fR converts a color pair number to an +attribute. Attributes can hold color pairs in the range 0 to 255. -If you need a color pair larger than that, you must use functions -such as \fBattr_set\fP (which pass the color pair as a separate parameter) -rather than the legacy functions such as \fBattrset\fP. +If you need a color pair larger than that, +you must use functions such as \fB\%attr_set\fP +(which pass the color pair as a separate parameter) +rather than the legacy functions such as \fB\%attrset\fP. +.SS PAIR_NUMBER +\fB\%PAIR_NUMBER(\fIattr\fR) extracts the color information from its +\fIattr\fP parameter and returns it as a color pair number; +it is the inverse operation of \fB\%COLOR_PAIR\fP. .SH RETURN VALUE -The routines \fBcan_change_color\fP and \fBhas_colors\fP return \fBTRUE\fP +The routines \fB\%can_change_color\fP and \fB\%has_colors\fP return \fBTRUE\fP or \fBFALSE\fP. .PP All other routines return the integer \fBERR\fP upon failure and an \fBOK\fP @@ -406,24 +429,24 @@ X/Open defines no error conditions. SVr4 does document some error conditions which apply in general: .bP This implementation will return \fBERR\fP on attempts to -use color values outside the range \fB0\fP to \fBCOLORS\fP\-1 +use color values outside the range \fB0\fP to \fB\%COLORS\fP\-1 (except for the default colors extension), -or use color pairs outside the range \fB0\fP to \fBCOLOR_PAIRS\-1\fP. +or use color pairs outside the range \fB0\fP to \fB\%COLOR_PAIRS\-1\fP. .IP -Color values used in \fBinit_color\fP must be +Color values used in \fB\%init_color\fP must be in the range \fB0\fP to \fB1000\fP. .IP An error is returned from all functions if the terminal has not been initialized. .IP -An error is returned from secondary functions such as \fBinit_pair\fP -if \fBstart_color\fP was not called. +An error is returned from secondary functions such as \fB\%init_pair\fP +if \fB\%start_color\fP was not called. .bP SVr4 does much the same, except that -it returns \fBERR\fP from \fBpair_content\fP if the pair was not initialized -using \fBinit_pairs\fP +it returns \fBERR\fP from \fB\%pair_content\fP if the pair was not initialized +using \fB\%init_pairs\fP and -it returns \fBERR\fP from \fBcolor_content\fP +it returns \fBERR\fP from \fB\%color_content\fP if the terminal does not support changing colors. .IP This implementation does not return \fBERR\fP for either case. @@ -431,19 +454,20 @@ This implementation does not return \fBERR\fP for either case. Specific functions make additional checks: .RS 3 .TP 5 -\fBinit_color\fP +\fB\%init_color\fP returns an error if the terminal does not support -this feature, e.g., if the \fBinitialize_color\fP capability is absent +this feature, e.g., if the \fB\%initialize_color\fP capability is absent from the terminal description. .TP 5 -\fBstart_color\fP +\fB\%start_color\fP returns an error if the color table cannot be allocated. .RE .SH NOTES -In the \fBncurses\fP implementation, there is a separate color activation flag, +In the \fI\%ncurses\fP implementation, +there is a separate color activation flag, color palette, color pairs table, -and associated \fBCOLORS\fP and \fBCOLOR_PAIRS\fP counts -for each screen; the \fBstart_color\fP function only affects the current +and associated \fB\%COLORS\fP and \fB\%COLOR_PAIRS\fP counts +for each screen; the \fB\%start_color\fP function only affects the current screen. The SVr4/XSI interface is not really designed with this in mind, and historical implementations may use a single shared color palette. @@ -452,7 +476,7 @@ Setting an implicit background color via a color pair affects only character cells that a character write operation explicitly touches. To change the background color used when parts of a window are blanked by erasing or -scrolling operations, see \fBcurs_bkgd\fP(3X). +scrolling operations, see \fB\%curs_bkgd\fP(3X). .PP Several caveats apply on older x86 machines (e.g., i386, i486) with VGA-compatible graphics: @@ -467,20 +491,61 @@ Paradise and compatibles) do the wrong thing when you try to set a bright \*(``yellow\*('' background (you get a blinking yellow foreground instead). .bP Color RGB values are not settable. -.SH HISTORY +.SH EXTENSIONS +The functions marked as extensions were designed for +\fB\%ncurses\fP(3X), +and are not found in SVr4 +.IR curses , +4.4BSD +.IR curses , +or any other previous curses implementation. +.SH PORTABILITY +Applications employing +.I \%ncurses +extensions should condition their use on the visibility of the +.B \%NCURSES_VERSION +preprocessor macro. +.PP +This implementation satisfies X/Open Curses's minimum maximums +for \fB\%COLORS\fP and \fB\%COLOR_PAIRS\fP. +.PP +The \fB\%init_pair\fP routine accepts negative values of foreground +and background color to support the \fB\%use_default_colors\fP(3X) extension, +but only if that routine has been first invoked. +.PP +The assumption that \fB\%COLOR_BLACK\fP is the default +background color for all terminals can be modified using the +\fB\%assume_default_colors\fP(3X) extension. .PP +This implementation checks the pointers, +e.g., for the values returned by +\fB\%color_content\fP and \fB\%pair_content\fP, +and will treat those as optional parameters when null. +.PP +X/Open Curses does not specify a limit for the number of colors and +color pairs which a terminal can support. +However, in its use of \fBshort\fP for the parameters, +it carries over SVr4's implementation detail for the compiled +terminfo database, which uses signed 16-bit numbers. +This implementation provides extended versions of those functions +which use \fBshort\fP parameters, +allowing applications to use larger color- and pair-numbers. +.PP +The \fB\%reset_color_pairs\fP function is an extension of +\fI\%ncurses\fP. +.SH HISTORY SVr3.2 introduced color support to curses in 1987. .PP SVr4 made internal changes, e.g., moving the storage for the color state -from \fBSP\fP (the \fBSCREEN\fP structure) -to \fBcur_term\fP (the \fBTERMINAL\fP structure), +from \fBSP\fP (the \fISCREEN\fP structure) +to \fB\%cur_term\fP (the \fI\%TERMINAL\fP structure), but provided the same set of library functions. .PP SVr4 curses limits the number of color pairs to 64, reserving color pair zero (0) as the terminal's initial uncolored state. This limit arises because the color pair information is a bitfield -in the \fBchtype\fP data type (denoted by \fBA_COLOR\fP). +in the \fB\%chtype\fP data type (denoted by \fB\%A_COLOR\fP). .PP Other implementations of curses had different limits: .bP @@ -488,69 +553,37 @@ PCCurses (1987-1990) provided for only eight (8) colors. .bP PDCurses (1992-present) inherited the 8-color limitation from PCCurses, but changed this to 256 in version 2.5 (2001), -along with changing \fBchtype\fP from 16-bits to 32-bits. +along with changing \fB\%chtype\fP from 16-bits to 32-bits. .bP X/Open Curses (1992-present) -added a new structure \fBcchar_t\fP to store the character, -attributes and color-pair values, allowing increased range of color-pairs. -Both color-pairs and color-values used a signed \fBshort\fP, +added a new structure \fB\%cchar_t\fP to store the character, +attributes and color pair values, allowing increased range of color pairs. +Both color pairs and color-values used a signed \fBshort\fP, limiting values to 15 bits. .bP -ncurses (1992-present) uses eight bits for \fBA_COLOR\fP in \fBchtype\fP values. +\fI\%ncurses\fP (1992-present) uses eight bits +for \fB\%A_COLOR\fP in \fB\%chtype\fP values. .IP Version 5.3 provided a wide-character interface (2002), -but left color-pairs as part of the attributes-field. +but left color pairs as part of the attributes-field. .IP Since version 6 (2015), -ncurses uses a separate \fBint\fP for color-pairs in the \fBcchar_t\fP values. -When those color-pair values fit in 8 bits, -ncurses allows color-pairs to be manipulated -via the functions using \fBchtype\fP values. +ncurses uses a separate \fBint\fP for color pairs in the \fB\%cchar_t\fP values. +When those color pair values fit in 8 bits, +ncurses allows color pairs to be manipulated +via the functions using \fB\%chtype\fP values. .bP NetBSD curses used 6 bits from 2000 (when colors were first supported) until 2004. At that point, NetBSD changed to use 10 bits. As of 2021, that size is unchanged. -Like ncurses before version 6, -the NetBSD color-pair information is stored in -the attributes field of \fBcchar_t\fP, limiting the number of color-pairs +Like \fI\%ncurses\fP before version 6, +the NetBSD color pair information is stored in +the attributes field of \fB\%cchar_t\fP, limiting the number of color pairs by the size of the bitfield. -.SH PORTABILITY -.SS Extensions -The functions marked as extensions were designed for \fBncurses\fP(3X), -and are not found in SVr4 curses, 4.4BSD curses, -or any other previous version of curses. -.SS Standards -.PP -This implementation satisfies XSI Curses's minimum maximums -for \fBCOLORS\fP and \fBCOLOR_PAIRS\fP. -.PP -The \fBinit_pair\fP routine accepts negative values of foreground -and background color to support the \fBuse_default_colors\fP(3X) extension, -but only if that routine has been first invoked. -.PP -The assumption that \fBCOLOR_BLACK\fP is the default -background color for all terminals can be modified using the -\fBassume_default_colors\fP(3X) extension. -.PP -This implementation checks the pointers, -e.g., for the values returned by -\fBcolor_content\fP and \fBpair_content\fP, -and will treat those as optional parameters when null. -.PP -X/Open Curses does not specify a limit for the number of colors and -color pairs which a terminal can support. -However, in its use of \fBshort\fP for the parameters, -it carries over SVr4's implementation detail for the compiled -terminfo database, which uses signed 16-bit numbers. -This implementation provides extended versions of those functions -which use \fBshort\fP parameters, -allowing applications to use larger color- and pair-numbers. -.PP -The \fBreset_color_pairs\fP function is an extension of ncurses. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_initscr\fP(3X), -\fBcurs_attr\fP(3X), -\fBcurs_variables\fP(3X), -\fBdefault_colors\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_attr\fP(3X), +\fB\%curs_initscr\fP(3X), +\fB\%curs_variables\fP(3X), +\fB\%default_colors\fP(3X) diff --git a/upstream/archlinux/man3/curs_delch.3x b/upstream/archlinux/man3/curs_delch.3x index 4062f9ed..dc7119ff 100644 --- a/upstream/archlinux/man3/curs_delch.3x +++ b/upstream/archlinux/man3/curs_delch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2006,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,50 +27,87 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_delch.3x,v 1.18 2022/02/12 20:06:41 tom Exp $ -.TH curs_delch 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_delch.3x,v 1.34 2024/04/20 19:24:14 tom Exp $ +.TH curs_delch 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME -\fBdelch\fP, -\fBwdelch\fP, -\fBmvdelch\fP, -\fBmvwdelch\fP \- delete character under the cursor in a \fBcurses\fP window +\fB\%delch\fP, +\fB\%wdelch\fP, +\fB\%mvdelch\fP, +\fB\%mvwdelch\fP \- +delete a character from a \fIcurses\fR window .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint delch(void);\fP -.br -\fBint wdelch(WINDOW *\fIwin\fB);\fR -.br -\fBint mvdelch(int \fIy\fB, int \fIx\fB);\fR -.br -\fBint mvwdelch(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBint delch(void); +\fBint wdelch(WINDOW *\fIwin\fP); +\fBint mvdelch(int \fIy\fP, int \fIx\fP); +\fBint mvwdelch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); +.fi .SH DESCRIPTION -These routines delete the character under the cursor; all characters to the -right of the cursor on the same line are moved to the left one position and the -last character on the line is filled with a blank. -The cursor position does -not change (after moving to \fIy\fP, \fIx\fP, if specified). -(This does not -imply use of the hardware delete character feature.) +.B \%wdelch +deletes the character at the cursor position in +.IR win . +\fB\%ncurses\fP(3X) describes the variants of this function. +.PP +.B \%wdelch +moves all characters to the right of the cursor on the same line to the +left one position and replaces the contents of the rightmost position on +the line with the window's blank character; +see \fB\%bkgd\fP(3X) +(wide-character API users may consult \fB\%bkgrnd\fP(3X) instead). +The cursor position does not change +(after moving to +.RI ( y , +.IR x ), +if specified). .SH RETURN VALUE -All routines return the integer \fBERR\fP upon failure and an \fBOK\fP (SVr4 -specifies only "an integer value other than \fBERR\fP") upon successful -completion. +These functions return +.B OK +on success and +.B ERR +on failure. +.PP +Functions taking a +.I \%WINDOW +pointer argument fail if the pointer is +.BR NULL . .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES -Note that \fBdelch\fP, \fBmvdelch\fP, and \fBmvwdelch\fP may be macros. +.BR \%delch , +.BR \%mvdelch , +and +.B \%mvwdelch +may be implemented as macros. +.PP +A terminal's +.B \%delete_character +.RB ( dch1 ) +capability +is not necessarily employed. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. -The -standard specifies that they return \fBERR\fP on failure, but specifies no -error conditions. +X/Open Curses, +Issue 4 describes these functions. +.PP +SVr4 +.I curses +describes a successful return value only as +\*(``an integer value other than +.BR ERR \*(''. .SH SEE ALSO -\fBcurses\fP(3X) +\fB\%curses\fP(3X) diff --git a/upstream/archlinux/man3/curs_deleteln.3x b/upstream/archlinux/man3/curs_deleteln.3x index c720e05c..f02178f7 100644 --- a/upstream/archlinux/man3/curs_deleteln.3x +++ b/upstream/archlinux/man3/curs_deleteln.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2007,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,30 +27,40 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_deleteln.3x,v 1.20 2022/02/12 20:06:41 tom Exp $ -.TH curs_deleteln 3X "" +.\" $Id: curs_deleteln.3x,v 1.38 2024/04/20 21:20:07 tom Exp $ +.TH curs_deleteln 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .SH NAME -\fBdeleteln\fP, -\fBwdeleteln\fP, -\fBinsdelln\fP, -\fBwinsdelln\fP, -\fBinsertln\fP, -\fBwinsertln\fP \- delete and insert lines in a \fBcurses\fP window +\fB\%deleteln\fP, +\fB\%wdeleteln\fP, +\fB\%insdelln\fP, +\fB\%winsdelln\fP, +\fB\%insertln\fP, +\fB\%winsertln\fP \- +delete or insert lines in a \fIcurses\fR window .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint deleteln(void);\fP -.br -\fBint wdeleteln(WINDOW *\fIwin\fB);\fR -.sp -\fBint insdelln(int \fIn\fB);\fR -.br -\fBint winsdelln(WINDOW *\fIwin\fB, int \fIn\fB);\fR -.sp -\fBint insertln(void);\fP -.br -\fBint winsertln(WINDOW *\fIwin\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBint deleteln(void); +\fBint wdeleteln(WINDOW *\fIwin\fP); +.PP +\fBint insdelln(int \fIn\fP); +\fBint winsdelln(WINDOW *\fIwin\fP, int \fIn\fP); +.PP +\fBint insertln(void); +\fBint winsertln(WINDOW *\fIwin\fP); +.fi .SH DESCRIPTION The \fBdeleteln\fP and \fBwdeleteln\fP routines delete the line under the cursor in the window; all lines below the current line are moved up one line. @@ -70,18 +80,14 @@ The current cursor position remains the same. The \fBinsertln\fP and \fBwinsertln\fP routines insert a blank line above the current line and the bottom line is lost. .SH RETURN VALUE -All routines return the integer \fBERR\fP upon failure and an \fBOK\fP (SVr4 -specifies only "an integer value other than \fBERR\fP") upon successful -completion. +These routines return the integer \fBERR\fP upon failure and an \fBOK\fP +(SVr4 specifies only +\*(``an integer value other than \fBERR\fP\*('') +upon successful completion. .PP X/Open defines no error conditions. In this implementation, if the window parameter is null, an error is returned. -.SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. -The -standard specifies that they return \fBERR\fP on failure, but specifies no -error conditions. .SH NOTES Note that all but \fBwinsdelln\fP may be macros. .PP @@ -89,5 +95,10 @@ These routines do not require a hardware line delete or insert feature in the terminal. In fact, they will not use hardware line delete/insert unless \fBidlok(..., TRUE)\fP has been set on the current window. +.SH PORTABILITY +These functions are described in X/Open Curses, Issue 4. +The +standard specifies that they return \fBERR\fP on failure, but specifies no +error conditions. .SH SEE ALSO -\fBcurses\fP(3X) +\fB\%curses\fP(3X) diff --git a/upstream/archlinux/man3/curs_extend.3x b/upstream/archlinux/man3/curs_extend.3x index 851e4768..bb34777e 100644 --- a/upstream/archlinux/man3/curs_extend.3x +++ b/upstream/archlinux/man3/curs_extend.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1999-2010,2016 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -29,27 +29,33 @@ .\" .\" Author: Thomas E. Dickey 1999-on .\" -.\" $Id: curs_extend.3x,v 1.28 2022/02/12 20:07:29 tom Exp $ -.TH curs_extend 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_extend.3x,v 1.46 2024/03/16 15:35:01 tom Exp $ +.TH curs_extend 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME -\fBcurses_version\fP, -\fBuse_extended_names\fP \- miscellaneous curses extensions -. +\fB\%curses_version\fP, +\fB\%use_extended_names\fP \- +miscellaneous \fIcurses\fR extensions .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBconst char * curses_version(void);\fP -.br -\fBint use_extended_names(bool \fIenable\fB);\fR +.nf +\fB#include <curses.h> +.PP +\fBconst char * curses_version(void); +\fBint use_extended_names(bool \fIenable\fP); +.fi .SH DESCRIPTION These functions are extensions to the curses library which do not fit easily into other categories. .SS curses_version -.PP Use \fBcurses_version\fP to get the version number, including patch level of the library, prefixed by \*(``ncurses\*('', e.g., @@ -58,7 +64,6 @@ prefixed by \*(``ncurses\*('', e.g., .B ncurses 5.0.19991023 .RE .SS use_extended_names -.PP The \fBuse_extended_names\fP function controls whether the calling application is able to use user-defined or nonstandard names @@ -70,28 +75,34 @@ extended terminal definitions. However you can disable this feature to ensure compatibility with other implementations of curses. .SH RETURN VALUE -.PP \fBcurses_version\fP returns a pointer to static memory; you should not free this in your application. .PP \fBuse_extended_names\fP returns the previous state, allowing you to save this and restore it. +.SH EXTENSIONS +These functions are \fB\%ncurses\fP(3X) extensions, +and are not found in SVr4 +.IR curses , +4.4BSD +.IR curses , +or any other previous curses implementation. .SH PORTABILITY -These routines are specific to ncurses. -They were not supported on -Version 7, BSD or System V implementations. -It is recommended that -any code depending on them be conditioned using NCURSES_VERSION. -.SH SEE ALSO -\fBcurs_getch\fP(3X), -\fBcurs_mouse\fP(3X), -\fBcurs_print\fP(3X), -\fBcurs_util\fP(3X), -\fBdefault_colors\fP(3X), -\fBdefine_key\fP(3X), -\fBkeybound\fP(3X), -\fBkeyok\fP(3X), -\fBresizeterm\fP(3X), -\fBwresize\fP(3X). -.SH AUTHOR +Applications employing +.I \%ncurses +extensions should condition their use on the visibility of the +.B \%NCURSES_VERSION +preprocessor macro. +.SH AUTHORS Thomas Dickey. +.SH SEE ALSO +\fB\%curs_getch\fP(3X), +\fB\%curs_mouse\fP(3X), +\fB\%curs_print\fP(3X), +\fB\%curs_util\fP(3X), +\fB\%default_colors\fP(3X), +\fB\%define_key\fP(3X), +\fB\%keybound\fP(3X), +\fB\%keyok\fP(3X), +\fB\%resizeterm\fP(3X), +\fB\%wresize\fP(3X) diff --git a/upstream/archlinux/man3/curs_get_wch.3x b/upstream/archlinux/man3/curs_get_wch.3x index 8a31a90a..d62a3130 100644 --- a/upstream/archlinux/man3/curs_get_wch.3x +++ b/upstream/archlinux/man3/curs_get_wch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 2002-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,168 +27,233 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_get_wch.3x,v 1.17 2022/02/12 20:07:29 tom Exp $ -.TH curs_get_wch 3X "" -.na -.hy 0 -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_get_wch.3x,v 1.40 2024/04/20 19:23:03 tom Exp $ +.TH curs_get_wch 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBget_wch\fP, -\fBwget_wch\fP, -\fBmvget_wch\fP, -\fBmvwget_wch\fP, -\fBunget_wch\fP \- get (or push back) a wide character from curses terminal keyboard -.ad -.hy +\fB\%get_wch\fP, +\fB\%wget_wch\fP, +\fB\%mvget_wch\fP, +\fB\%mvwget_wch\fP, +\fB\%unget_wch\fP \- +get (or push back) a wide character from \fIcurses\fR terminal keyboard .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint get_wch(wint_t *\fIwch\fB);\fR -.br -\fBint wget_wch(WINDOW *\fIwin\fB, wint_t *\fIwch\fB);\fR -.br -\fBint mvget_wch(int \fIy\fB, int \fIx\fB, wint_t *\fIwch\fB);\fR -.br -\fBint mvwget_wch(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wint_t *\fIwch\fB);\fR -.sp -\fBint unget_wch(const wchar_t \fIwch\fB);\fR +.nf +\fB#include <curses.h> +.PP +\fBint get_wch(wint_t *\fIwch\fP); +\fBint wget_wch(WINDOW *\fIwin\fP, wint_t *\fIwch\fP); +\fBint mvget_wch(int \fIy\fP, int \fIx\fP, wint_t *\fIwch\fP); +\fBint mvwget_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, wint_t *\fIwch\fP); +.PP +\fBint unget_wch(const wchar_t \fIwc\fP); +.fi .SH DESCRIPTION -.SS wget_wch -The -\fBget_wch\fP, -\fBwget_wch\fP, -\fBmvget_wch\fP, and -\fBmvwget_wch\fP -functions read a character -from the terminal associated with the current or specified window. -In no-delay mode, -if no input is waiting, the value \fBERR\fP is returned. -In delay mode, -the program waits until the system passes text through to the program. -Depending on the setting of \fBcbreak\fP, -this is after one character (cbreak mode), -or after the first newline (nocbreak mode). -In half-delay mode, -the program waits until the user types a character or the specified -timeout interval has elapsed. +.SS "Reading Characters" +.B \%wget_wch +gathers a key stroke +.I wch +from the terminal keyboard associated with a +.I curses +window +.IR win , +returning +.B OK +if a wide character is read, +.B \%KEY_CODE_YES +if a function key is read, +and +.B ERR +if no key event is available. +\fB\%ncurses\fP(3X) describes the variants of this function. .PP -Unless \fBnoecho\fP has been set, -these routines echo the character into the designated window. +When input is pending, +.B \%wget_wch +stores an integer +identifying the key stroke in +.IR wch ; +for alphanumeric and punctuation keys, +this value corresponds to the character encoding used by the terminal. +Use of the control key as a modifier often results in a distinct code. +The behavior of other keys depends on whether +.I win +is in keypad mode; +see subsections \*(``Keypad Mode\*('' and \*(``Predefined Key Codes\*('' +in \fB\%getch\fP(3X). .PP -If the window is not a pad and has been moved or modified since the -last call to \fBwrefresh\fP, -\fBwrefresh\fP will be called before another character is read. +If no input is pending, +then if the no-delay flag is set in the window +(see \fB\%nodelay\fP(3X)), +the function returns +.BR ERR ; +otherwise, +.I curses +waits until the terminal has input. +If \fB\%cbreak\fP(3X) +has been called, +this happens after one character is read. +If \fB\%nocbreak\fP(3X) +has been called, +it occurs when the next newline is read. +If \fB\%halfdelay\fP(3X) +has been called, +.I curses +waits until a character is typed or the specified delay elapses. .PP -If \fBkeypad\fP is enabled, -these functions respond to -the pressing of a function key by setting the object pointed to by -\fIwch\fP -to the keycode assigned to the function key, -and returning \fBKEY_CODE_YES\fP. -If a character (such as escape) that could be the -beginning of a function key is received, curses sets a timer. -If the remainder -of the sequence does arrive within the designated time, curses passes through -the character; otherwise, curses returns the function key value. -For this -reason, many terminals experience a delay between the time a user presses -the escape key and the time the escape is returned to the program. +If \fB\%echo\fP(3X) has been called, +and the window is not a pad, +.I curses +writes +.I wch +to the window +(at the cursor position) +per the following rules. +.bP +If +.I wch +matches the terminal's erase character, +the cursor moves leftward one position +and the new position is erased +as if \fB\%wmove\fP(3X) and then \fB\%wdelch\fP(3X) were called. +When the window's keypad mode is enabled +(see below), +.B \%KEY_LEFT +and +.B \%KEY_BACKSPACE +are handled the same way. +.bP +.I curses +writes any other +.I wch +to the window, +as with \fB\%wecho_wchar\fP(3X). +.bP +If the window has been moved or modified since the last call to +\fB\%wrefresh\fP(3X), +.I curses +calls +.BR \%wrefresh . .PP -The keycodes returned by these functions are the same as those -returned by \fBwgetch\fP: +If +.I wch +is a carriage return and \fBnl\fP(3X) has been called, +.B \%wgetch +stores the the character code for newline +(line feed) +in +.I wch +instead. +.SS "Ungetting Characters" +.B \%unget_wch +places +.I wch +into the input queue to be returned by the next call to +.BR \%wget_wch . +A single input queue serves all windows. +.SH RETURN VALUE +.B \%wget_wch +returns +.B OK +when it reads a wide character and +.B \%KEY_CODE_YES +when it reads a function key code. +It returns +.B ERR +if .bP -The predefined function -keys are listed in \fB<curses.h>\fP as macros with values outside the range -of 8-bit characters. -Their names begin with \fBKEY_\fP. +the +.I \%WINDOW +pointer is +.BR NULL , +or .bP -Other (user-defined) function keys -which may be defined using \fBdefine_key\fP(3X) have no names, -but also are expected to have values outside the range of 8-bit characters. -.SS unget_wch -The -\fBunget_wch\fP -function pushes the wide character -\fIwch\fP -back onto the head of the input queue, so the wide character -is returned by the next call to -\fBget_wch\fP. -The pushback of -one character is guaranteed. -If the program calls -\fBunget_wch\fP -too many times without an intervening call to -\fBget_wch\fP, -the operation may fail. +its timeout expires without any data arriving, +or +.bP +execution was interrupted by a signal, +in which case +.B \%errno +is set to +.BR \%EINTR . +.PP +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .PP -Unlike \fBungetch\fP and \fBwgetch\fP, -\fBunget_wch\fP cannot distinguish special characters -returned by \fBwget_wch\fP from ordinary characters. -An application can push special keys -which it may read via \fBwget_wch\fP -by checking for the \fBKEY_CODE_YES\fP result, -and using \fBungetch\fP for those special keys. +.B \%unget_wch +returns +.B OK +on success and +.B ERR +if there is no more room in the input queue. .SH NOTES -The header file -\fB<curses.h>\fP -automatically -includes the header file -\fB<stdio.h>\fP. +See the \*(``NOTES\*('' section of \fB\%wgetch\fP(3X). .PP -Applications should not define the escape key by itself as a single-character -function. +All of these functions except +.B \%wget_wch +and +.B \%unget_wch +may be implemented as macros. .PP -When using -\fBget_wch\fP, -\fBwget_wch\fP, -\fBmvget_wch\fP, or -\fBmvwget_wch\fP, applications should -not use -\fBnocbreak\fP -mode and -\fBecho\fP -mode -at the same time. -Depending on the state of the tty driver when each character -is typed, the program may produce undesirable results. +Unlike \fB\%wgetch\fP(3X), +.B \%wget_wch +and its variants store the value of the input character in an additional +.I wch +parameter instead of the return value. .PP -All functions except \fBwget_wch\fP and \fBunget_wch\fP -may be macros. -.SH RETURN VALUE -When -\fBget_wch\fP, -\fBwget_wch\fP, -\fBmvget_wch\fP, and -\fBmvwget_wch\fP -functions successfully -report the pressing of a function key, they return -\fBKEY_CODE_YES\fP. -When they successfully report a wide character, they return -\fBOK\fP. -Otherwise, they return -\fBERR\fP. +Unlike +.BR \%ungetch , +.B \%unget_wch +cannot distinguish function key codes +.B \%wget_wch +from conventional character codes. +An application can overcome this limitation by pushing function key +codes with +.B \%ungetch +and subsequently checking the return value of +.B \%wget_wch +for a match with +.BR \%KEY_CODE_YES . +.SH EXTENSIONS +See the \*(``EXTENSIONS\*('' section of \fB\%wgetch\fP(3X). +.SH PORTABILITY +Applications employing +.I \%ncurses +extensions should condition their use on the visibility of the +.B \%NCURSES_VERSION +preprocessor macro. .PP -Upon successful completion, -\fBunget_wch\fP -returns -\fBOK\fP. -Otherwise, the function returns -\fBERR\fP. +X/Open Curses, +Issue 4 describes these functions. +It specifies no error conditions for them. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +See the \*(``PORTABILITY\*('' section of \fB\%wgetch\fP(3X) regarding +the interaction of +.B \%wget_wch +with signal handlers. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_getch\fP(3X), -\fBcurs_ins_wch\fP(3X), -\fBcurs_inopts\fP(3X), -\fBcurs_move\fP(3X), -\fBcurs_refresh\fP(3X) +\fB\%curs_getch\fP(3X) describes comparable functions of the +.I \%ncurses +library in its non-wide-character configuration. +.PP +\fB\%curses\fP(3X), +\fB\%curs_add_wch\fP(3X), +\fB\%curs_inopts\fP(3X), +\fB\%curs_move\fP(3X), +\fB\%curs_refresh\fP(3X) diff --git a/upstream/archlinux/man3/curs_get_wstr.3x b/upstream/archlinux/man3/curs_get_wstr.3x index 2c49920f..85b1f1d7 100644 --- a/upstream/archlinux/man3/curs_get_wstr.3x +++ b/upstream/archlinux/man3/curs_get_wstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 2002-2012,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,97 +27,90 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_get_wstr.3x,v 1.26 2022/02/12 20:07:29 tom Exp $ -.TH curs_get_wstr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_get_wstr.3x,v 1.48 2024/04/20 19:18:18 tom Exp $ +.TH curs_get_wstr 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBget_wstr\fP, -\fBgetn_wstr\fP, -\fBwget_wstr\fP, -\fBwgetn_wstr\fP, -\fBmvget_wstr\fP, -\fBmvgetn_wstr\fP, -\fBmvwget_wstr\fP, -\fBmvwgetn_wstr\fP \- get an array of wide characters from a curses terminal keyboard -.ad -.hy +\fB\%get_wstr\fP, +\fB\%getn_wstr\fP, +\fB\%wget_wstr\fP, +\fB\%wgetn_wstr\fP, +\fB\%mvget_wstr\fP, +\fB\%mvgetn_wstr\fP, +\fB\%mvwget_wstr\fP, +\fB\%mvwgetn_wstr\fP \- +get a wide-character string from a \fIcurses\fR terminal keyboard .SH SYNOPSIS .nf -\fB#include <curses.h>\fP -.sp -\fBint get_wstr(wint_t *\fIwstr\fB);\fR -.br -\fBint getn_wstr(wint_t *\fIwstr\fB, int \fIn\fB);\fR -.br -\fBint wget_wstr(WINDOW *\fIwin\fB, wint_t *\fIwstr\fB);\fR -.br -\fBint wgetn_wstr(WINDOW *\fIwin\fB, wint_t *\fIwstr\fB, int \fIn\fB);\fR -.sp -\fBint mvget_wstr(int \fIy\fB, int \fIx\fB, wint_t *\fIwstr\fB);\fR -.br -\fBint mvgetn_wstr(int \fIy\fB, int \fIx\fB, wint_t *\fIwstr\fB, int \fIn\fB);\fR -.br -\fBint mvwget_wstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wint_t *\fIwstr\fB);\fR -.br -\fBint mvwgetn_wstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wint_t *\fIwstr\fB, int \fIn\fB);\fR +\fB#include <curses.h> +.PP +\fBint get_wstr(wint_t *\fIwstr\fP); +\fBint getn_wstr(wint_t *\fIwstr\fP, int \fIn\fP); +\fBint wget_wstr(WINDOW *\fIwin\fP, wint_t *\fIwstr\fP); +\fBint wgetn_wstr(WINDOW *\fIwin\fP, wint_t *\fIwstr\fP, int \fIn\fP); +.PP +\fBint mvget_wstr(int \fIy\fP, int \fIx\fP, wint_t *\fIwstr\fP); +\fBint mvgetn_wstr(int \fIy\fP, int \fIx\fP, wint_t *\fIwstr\fP, int \fIn\fP); +\fBint mvwget_wstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, wint_t *\fIwstr\fP); +\fBint mvwgetn_wstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, wint_t *\fIwstr\fP, int \fIn\fP); .fi .SH DESCRIPTION -The effect of -\fBget_wstr\fP -is as though a series of calls -to -\fBget_wch\fP(3X) -were made, until a newline, other end-of-line, -or end-of-file condition is processed. +The function +\fBwgetn_wstr\fP +is equivalent to a series of calls to +\fBwget_wch\fP(3X) +until a newline or carriage return terminates the series: +.bP +The terminating character is not included in the returned string. +.bP An end-of-file condition is represented by \fBWEOF\fP, as defined in \fB<wchar.h>\fP. -The newline and end-of-line conditions are represented -by the \fB\\n\fP \fBwchar_t\fP value. -In all instances, the end of the string is terminated by a null \fBwchar_t\fP. -The routine places resulting values in the area pointed to by \fIwstr\fP. +.bP +In all instances, the end of the string is terminated +by a null \fBwchar_t\fP. +.bP +The function stores the result in the area pointed to +by the \fIwstr\fP parameter. +.bP +The function reads at most \fIn\fP characters, +thus preventing a possible overflow of the input buffer. +.IP +Any attempt to enter more characters +(other than the terminating newline or carriage return) +causes a beep. +.IP +Function keys also cause a beep and are ignored. .PP -The user's erase and kill characters are interpreted. -If keypad -mode is on for the window, \fBKEY_LEFT\fP and \fBKEY_BACKSPACE\fP -are both considered equivalent to the user's kill character. +The user's \fIerase\fP and \fIkill\fP characters are interpreted: +.bP +The \fIerase\fP character (e.g., \fB^H\fP) erases the character +at the end of the buffer, moving the cursor to the left. +.IP +If \fIkeypad\fP mode is on for the window, +\fBKEY_LEFT\fP and \fBKEY_BACKSPACE\fP +are both considered equivalent to the user's \fIerase\fP character. +.bP +The \fIkill\fP character (e.g., \fB^U\fP) erases the entire buffer, +leaving the cursor at the beginning of the buffer. .PP Characters input are echoed only if \fBecho\fP is currently on. In that case, -backspace is echoed as deletion of the previous character (typically a left -motion). -.PP -The effect of -\fBwget_wstr\fP -is as though a series of -calls to -\fBwget_wch\fP -were made. -.PP -The effect of -\fBmvget_wstr\fP -is as though a call to -\fBmove\fP -and then a series of calls to -\fBget_wch\fP -were -made. -.PP -The effect of -\fBmvwget_wstr\fP -is as though a call to -\fBwmove\fP -and then a series of calls to -\fBwget_wch\fP -were made. +backspace is echoed as deletion of the previous character +(typically a left motion). .PP The \fBgetn_wstr\fP, @@ -137,7 +130,33 @@ versions read at most \fIn\fP characters, letting the application prevent overflow of the input buffer. +.SH RETURN VALUE +All of these functions return the integer \fBOK\fP upon successful completion. +If unsuccessful, they return \fBERR\fP. +.PP +X/Open defines no error conditions. +.PP +In this implementation, +these functions return an error +.bP +if the window pointer is null, +.bP +if its timeout expires without having any data, or +.bP +if the associated call to +\fBwget_wch\fP +failed. +.PP +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES +Any of these functions other than +\fBwgetn_wstr\fP +may be macros. +.PP Using \fBget_wstr\fP, \fBmvget_wstr\fP, @@ -152,29 +171,15 @@ The use of \fBgetn_wstr\fP, \fBmvgetn_wstr\fP, \fBmvwgetn_wstr\fP, or -\fBwgetn_wstr\fP, respectively, is recommended. +\fBwgetn_wstr\fP, +respectively, is recommended. .PP These functions cannot return \fBKEY_\fP values because there is no way to distinguish a \fBKEY_\fP value from a valid \fBwchar_t\fP value. -.PP -All of these routines except \fBwgetn_wstr\fP may be macros. -.SH RETURN VALUE -All of these functions return \fBOK\fP upon successful completion. -Otherwise, they return \fBERR\fP. -.PP -Functions using a window parameter return an error if it is null. -.RS -.TP 5 -\fBwgetn_wstr\fP -returns an error if the associated call to \fBwget_wch\fP failed. -.RE -.PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. .SH PORTABILITY These functions are described in The Single Unix Specification, Version 2. No error conditions are defined. +.PP This implementation returns \fBERR\fP if the window pointer is null, or if the lower-level \fBwget_wch\fP call returns an \fBERR\fP. In the latter case, @@ -205,15 +210,17 @@ This implementation counts the terminator in the length. X/Open Curses does not specify what happens if the length \fIn\fP is negative. .bP For analogy with \fBwgetnstr\fP, -ncurses 6.2 uses a limit (based on \fBLINE_MAX\fP). +\fI\%ncurses\fP 6.2 uses a limit (based on \fBLINE_MAX\fP). .bP Some other implementations (such as Solaris xcurses) do the same, while others (PDCurses) do not allow this. .bP -NetBSD 7 curses imitates ncurses 6.1 in this regard, +NetBSD 7 curses imitates \fI\%ncurses\fP 6.1 in this regard, treating a \fB\-1\fP as an indefinite number of characters. .SH SEE ALSO -Functions: -\fBcurses\fP(3X), -\fBcurs_get_wch\fP(3X), -\fBcurs_getstr\fP(3X). +\fB\%curs_getstr\fP(3X) describes comparable functions of the +.I \%ncurses +library in its non-wide-character configuration. +.PP +\fB\%curses\fP(3X), +\fB\%curs_get_wch\fP(3X) diff --git a/upstream/archlinux/man3/curs_getcchar.3x b/upstream/archlinux/man3/curs_getcchar.3x index 46d36110..2a529ae0 100644 --- a/upstream/archlinux/man3/curs_getcchar.3x +++ b/upstream/archlinux/man3/curs_getcchar.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2020,2021 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 2001-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,73 +27,64 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getcchar.3x,v 1.27 2021/12/25 20:35:03 tom Exp $ -.TH curs_getcchar 3X "" +.\" $Id: curs_getcchar.3x,v 1.49 2024/04/20 18:55:09 tom Exp $ +.TH curs_getcchar 3X 2024-04-20 "ncurses 6.5" "Library calls" .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBgetcchar\fP, -\fBsetcchar\fP \- Get a wide character string and rendition from a \fBcchar_t\fP or set a \fBcchar_t\fP from a wide-character string +\fB\%getcchar\fP, +\fB\%setcchar\fP \- +convert between a wide-character string and a \fIcurses\fR complex character .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint getcchar(\fP -.br -.B " const cchar_t *\fIwcval\fP," -.br -.B " wchar_t *\fIwch\fP," -.br +.nf +\fB#include <curses.h> +.PP +\fBint getcchar( +.B " const cchar_t *\fIwch\fP," +.B " wchar_t *\fIwc\fP," .B " attr_t *\fIattrs\fP," -.br .B " short *\fIcolor_pair\fP," -.br .B " void *\fIopts\fP );" -.sp +.PP .B "int setcchar(" -.br -.B " cchar_t *\fIwcval\fP," -.br -.B " const wchar_t *\fIwch\fP," -.br +.B " cchar_t *\fIwch\fP," +.B " const wchar_t *\fIwc\fP," .B " const attr_t \fIattrs\fP," -.br .B " short \fIcolor_pair\fP," -.br .B " const void *\fIopts\fP );" +.fi .SH DESCRIPTION .SS getcchar -.PP The \fBgetcchar\fP function gets a wide-character string and rendition from a \fBcchar_t\fP argument. -When \fIwch\fP is not a null pointer, +When \fIwc\fP is not a null pointer, the \fBgetcchar\fP function does the following: .bP -Extracts information from a \fBcchar_t\fP value \fIwcval\fP +Extracts information from a \fBcchar_t\fP value \fIwch\fP .bP Stores the character attributes in the location pointed to by \fIattrs\fP .bP -Stores the color-pair in the location pointed to by \fIcolor_pair\fP +Stores the color pair in the location pointed to by \fIcolor_pair\fP .bP Stores the wide-character string, -characters referenced by \fIwcval\fP, into the array pointed to by \fIwch\fP. +characters referenced by \fIwch\fP, into the array pointed to by \fIwc\fP. .PP When -\fIwch\fP +\fIwc\fP is a null pointer, the \fBgetcchar\fP function does the following: .bP -Obtains the number of wide characters pointed to by \fIwcval\fP +Obtains the number of wide characters pointed to by \fIwch\fP .bP Does not change the data referenced by \fIattrs\fP or \fIcolor_pair\fP .SS setcchar -.PP -The \fBsetcchar\fP function initializes the location pointed to by \fIwcval\fP +The \fBsetcchar\fP function initializes the location pointed to by \fIwch\fP by using: .bP The character attributes in @@ -102,22 +93,37 @@ The character attributes in The color pair in \fIcolor_pair\fP .bP -The wide-character string pointed to by \fIwch\fP. -The string must be L'\\0' terminated, +The wide-character string pointed to by \fIwc\fP. +The string must be L'\e0' terminated, contain at most one spacing character, which must be the first. .IP -Up to \fBCCHARW_MAX\fP\-1 nonspacing characters may follow. -Additional nonspacing characters are ignored. +Up to \fBCCHARW_MAX\fP\-1 non-spacing characters may follow. +Additional non-spacing characters are ignored. .IP The string may contain a single control character instead. -In that case, no nonspacing characters are allowed. -.SH EXTENSIONS +In that case, no non-spacing characters are allowed. +.SH RETURN VALUE +When \fIwc\fP is a null pointer, +\fBgetcchar\fP returns the number of wide characters referenced by +\fIwch\fP, +including one for a trailing null. .PP +When \fIwc\fP is not a null pointer, +\fBgetcchar\fP returns \fBOK\fP upon successful completion, +and \fBERR\fP otherwise. +.PP +Upon successful completion, \fBsetcchar\fP returns \fBOK\fP. +Otherwise, it returns \fBERR\fP. +.SH NOTES +The \fIwch\fP argument may be a value generated by a call to +\fBsetcchar\fP or by a function that has a \fBcchar_t\fP output argument. +If \fIwch\fP is constructed by any other means, the effect is unspecified. +.SH EXTENSIONS X/Open Curses documents the \fIopts\fP argument as reserved for future use, saying that it must be null. This implementation -uses that parameter in ABI 6 for the functions which have a color-pair +uses that parameter in ABI 6 for the functions which have a color pair parameter to support extended color pairs: .bP For functions which modify the color, e.g., \fBsetcchar\fP, @@ -128,26 +134,8 @@ For functions which retrieve the color, e.g., \fBgetcchar\fP, if \fIopts\fP is set it is treated as a pointer to \fBint\fP, and used to retrieve the color pair as an \fBint\fP value, in addition retrieving it via the standard pointer to \fBshort\fP parameter. -.SH NOTES -.PP -The \fIwcval\fP argument may be a value generated by a call to -\fBsetcchar\fP or by a function that has a \fBcchar_t\fP output argument. -If \fIwcval\fP is constructed by any other means, the effect is unspecified. -.SH RETURN VALUE -.PP -When \fIwch\fP is a null pointer, -\fBgetcchar\fP returns the number of wide characters referenced by -\fIwcval\fP, -including one for a trailing null. -.PP -When \fIwch\fP is not a null pointer, -\fBgetcchar\fP returns \fBOK\fP upon successful completion, -and \fBERR\fP otherwise. -.PP -Upon successful completion, \fBsetcchar\fP returns \fBOK\fP. -Otherwise, it returns \fBERR\fP. .SH PORTABILITY -The \fBCCHARW_MAX\fP symbol is specific to ncurses. +The \fBCCHARW_MAX\fP symbol is specific to \fI\%ncurses\fP. X/Open Curses does not provide details for the layout of the \fBcchar_t\fP structure. It tells what data are stored in it: @@ -194,9 +182,7 @@ including using them for ligatures between characters Unicode does not limit the (analogous) number of combining characters, so some applications may be affected. .SH SEE ALSO -.PP -Functions: -\fBcurs_attr\fP(3X), -\fBcurs_color\fP(3X), -\fBcurses\fP(3X), -\fBwcwidth\fP(3). +\fB\%curses\fP(3X), +\fB\%curs_attr\fP(3X), +\fB\%curs_color\fP(3X), +\fB\%wcwidth\fP(3) diff --git a/upstream/archlinux/man3/curs_getch.3x b/upstream/archlinux/man3/curs_getch.3x index 7894f875..6e8adaa9 100644 --- a/upstream/archlinux/man3/curs_getch.3x +++ b/upstream/archlinux/man3/curs_getch.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,391 +28,670 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getch.3x,v 1.63 2022/02/12 20:07:45 tom Exp $ -.TH curs_getch 3X "" -.na -.hy 0 -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_getch.3x,v 1.87 2024/04/20 19:18:18 tom Exp $ +.TH curs_getch 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.ds ^ \(ha +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.ds ^ ^ +.\} +. +.ie \n(.g .ds : \: +.el .ds : \" empty +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBgetch\fP, -\fBwgetch\fP, -\fBmvgetch\fP, -\fBmvwgetch\fP, -\fBungetch\fP, -\fBhas_key\fP \- get (or push back) characters from \fBcurses\fP terminal keyboard -.ad -.hy +\fB\%getch\fP, +\fB\%wgetch\fP, +\fB\%mvgetch\fP, +\fB\%mvwgetch\fP, +\fB\%ungetch\fP, +\fB\%has_key\fP \- +get (or push back) characters from \fIcurses\fR terminal keyboard .SH SYNOPSIS +.nf .B #include <curses.h> .PP .B int getch(void); -.br -.B int wgetch(WINDOW *\fIwin\fB); -.sp -.B int mvgetch(int \fIy\fB, int \fIx\fB); -.br -.B int mvwgetch(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB); -.sp -.B int ungetch(int \fIch\fB); -.sp -/* extension */ -.br -.B int has_key(int \fIch\fB); -.br +.B int wgetch(WINDOW *\fIwin\fP); +.B int mvgetch(int \fIy\fP, int \fIx\fP); +.B int mvwgetch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); +.PP +.B int ungetch(int \fIc\fP); +.PP +.\" XXX: Move has_key into its own page like define_key and key_defined? +\fI/* extension */\fP +.B int has_key(int \fIc\fP); +.fi .SH DESCRIPTION -.SS Reading characters -The \fBgetch\fP, \fBwgetch\fP, \fBmvgetch\fP and \fBmvwgetch\fP, routines read -a character from the window. -In no-delay mode, if no input is waiting, the value \fBERR\fP is returned. -In delay mode, the program waits until the system -passes text through to the program. -Depending on the setting of \fBcbreak\fP, -this is after one character (cbreak mode), -or after the first newline (nocbreak mode). -In half-delay mode, -the program waits until a character is typed or the -specified timeout has been reached. -.PP -If \fBecho\fP is enabled, and the window is not a pad, -then the character will also be echoed into the -designated window according to the following rules: -.bP -If the character is the current erase character, left arrow, or backspace, -the cursor is moved one space to the left and that screen position is erased -as if \fBdelch\fP had been called. +.SS "Reading Characters" +.B \%wgetch +gathers a key stroke from the terminal keyboard associated with a +.I curses +window +.IR win . +\fB\%ncurses\fP(3X) describes the variants of this function. +.PP +When input is pending, +.B \%wgetch +returns an integer identifying the key stroke; +for alphanumeric and punctuation keys, +this value corresponds to the character encoding used by the terminal. +Use of the control key as a modifier often results in a distinct code. +The behavior of other keys depends on whether +.I win +is in keypad mode; +see subsection \*(``Keypad Mode\*('' below. +.PP +If no input is pending, +then if the no-delay flag is set in the window +(see \fB\%nodelay\fP(3X)), +the function returns +.BR ERR ; +otherwise, +.I curses +waits until the terminal has input. +If \fB\%cbreak\fP(3X) +has been called, +this happens after one character is read. +If \fB\%nocbreak\fP(3X) +has been called, +it occurs when the next newline is read. +If \fB\%halfdelay\fP(3X) +has been called, +.I curses +waits until a character is typed or the specified delay elapses. +.PP +If \fB\%echo\fP(3X) has been called, +and the window is not a pad, +.I curses +writes the returned character +.I c +to the window +(at the cursor position) +per the following rules. .bP -If the character value is any other \fBKEY_\fP define, the user is alerted -with a \fBbeep\fP call. +If +.I c +matches the terminal's erase character, +the cursor moves leftward one position +and the new position is erased +as if \fB\%wmove\fP(3X) and then \fB\%wdelch\fP(3X) were called. +When the window's keypad mode is enabled +(see below), +.B \%KEY_LEFT +and +.B \%KEY_BACKSPACE +are handled the same way. .bP -If the character is a carriage-return, -and if \fBnl\fP is enabled, -it is translated to a line-feed after echoing. +.I curses +writes any other +.I c +to the window, +as with \fB\%wechochar\fP(3X). .bP -Otherwise the character is simply output to the screen. +If the window has been moved or modified since the last call to +\fB\%wrefresh\fP(3X), +.I curses +calls +.BR \%wrefresh . .PP -If the window is not a pad, and it has been moved or modified since the last -call to \fBwrefresh\fP, \fBwrefresh\fP will be called before another character -is read. -.SS Keypad mode -.PP -If \fBkeypad\fP is \fBTRUE\fP, and a function key is pressed, the token for -that function key is returned instead of the raw characters: +If +.I c +is a carriage return and \fBnl\fP(3X) has been called, +.B \%wgetch +returns the character code for line feed instead. +.SS "Keypad Mode" +To +.IR curses , +key strokes not from the alphabetic section of the keyboard +(those corresponding to the ECMA-6 character set\(emsee +\fIascii\fP(7)\(emoptionally modified by either the control or shift +keys) +are treated as +.I function +keys. +(In +.IR curses , +the term \*(``function key\*('' includes but is not limited to keycaps +engraved with \*(``F1\*('', +\*(``PF1\*('', +and so on.) +If the window is in keypad mode, +these produce a numeric code corresponding to the +.B KEY_ +symbols listed in subsection \*(``Predefined Key Codes\*('' below; +otherwise, +they transmit a sequence of codes typically starting with the escape +character, +and which must be collected with multiple +.B \%wgetch +calls. .bP -The predefined function -keys are listed in \fB<curses.h>\fP as macros with values outside the range -of 8-bit characters. -Their names begin with \fBKEY_\fP. +The +.I \%curses.h +header file declares many +.I "predefined function keys" +whose names begin with +.BR KEY_ ; +these object-like macros have values outside the range of eight-bit +character codes. .bP -Other (user-defined) function keys which may be defined -using \fBdefine_key\fP(3X) -have no names, but also are expected to have values outside the range of -8-bit characters. -.PP -Thus, a variable -intended to hold the return value of a function key must be of short size or -larger. -.PP -When a character that could be the beginning of a function key is received -(which, on modern terminals, means an escape character), -\fBcurses\fP sets a timer. -If the remainder of the sequence does not come in within the designated -time, the character is passed through; -otherwise, the function key value is returned. -For this reason, many terminals experience a delay between the time -a user presses the escape key and the escape is returned to the program. -.PP -In \fBncurses\fP, the timer normally expires after -the value in \fBESCDELAY\fP (see \fBcurs_variables\fP(3X)). -If \fBnotimeout\fP is \fBTRUE\fP, the timer does not expire; -it is an infinite (or very large) value. -Because function keys usually begin with an escape character, -the terminal may appear to hang in notimeout mode after pressing the escape key -until another key is pressed. -.SS Ungetting characters -.PP -The \fBungetch\fP routine places \fIch\fP back onto the input queue to be -returned by the next call to \fBwgetch\fP. -There is just one input queue for all windows. -.PP -.SS Predefined key-codes -The following special keys are defined in \fB<curses.h>\fP. +In +.IR \%ncurses , +.I "user-defined function keys" +are configured with \fB\%define_key\fP(3X); +they have no names, +but are also expected to have values outside the range of eight-bit +codes. +.PP +A variable intended to hold a function key code must thus be of type +.I short +or larger. +.PP +Most terminals one encounters follow the ECMA-48 standard insofar as +their function keys produce character sequences prefixed with the +escape character ESC. +This fact implies that +.I curses +cannot know whether the terminal has sent an ESC key stroke or the +beginning of a function key's character sequence without waiting to see +if, +and how soon, +further input arrives. +When +.I curses +reads such an ambiguous character, +it sets a timer. +If the remainder of the sequence does not arrive within the designated +time, +.B \%wgetch +returns the prefix character; +otherwise, +it returns the function key code corresponding to the unique sequence +defined by the terminal. +Consequently, +a user of a +.I curses +application may experience a delay after pressing ESC while +.I curses +disambiguates the input; +see section \*(``EXTENSIONS\*('' below. +If the window is in \*(``no time-out\*('' mode, +the timer does not expire; +it is an infinite +(or very large) +value. +See \fB\%notimeout\fP(3X). +Because function key sequences usually begin with an escape character, +the terminal may appear to hang in no time-out mode after the user has +pressed ESC. +Generally, +further typing \*(``awakens\*('' +.IR curses . +.SS "Ungetting Characters" +.B \%ungetch +places +.I c +into the input queue to be returned by the next call to +.BR \%wgetch . +A single input queue serves all windows. +.SS "Predefined Key Codes" +The header file +.I \%curses.h +defines the following function key codes. .bP -Except for the special case \fBKEY_RESIZE\fP, -it is necessary to enable \fBkeypad\fP for \fBgetch\fP to return these codes. +Except for the special case of +.BR \%KEY_RESIZE , +a window's keypad mode must be enabled for +.B \%wgetch +to read these codes from it. .bP Not all of these are necessarily supported on any particular terminal. .bP -The naming convention may seem obscure, with some apparent -misspellings (such as \*(``RSUME\*('' for \*(``resume\*(''). -The names correspond to the long terminfo capability names for the keys, -and were defined long ago, in the 1980s. +The naming convention may seem obscure, +with some apparent misspellings +(such as \*(``RSUME\*('' for \*(``resume\*(''); +the names correspond to the +.I \%term\%info +capability names for the keys, +and were standardized before the IBM PC/AT keyboard layout achieved a +dominant position in industry. .PP +.RS +.\" XXX: Move this list into ncurses(3X), rather than duplicating it in +.\" get_wch(3X) or having that page cross reference this one? .TS -center tab(/) ; -l l . -\fBName\fP/\fBKey\fP \fBname\fP -_ -KEY_BREAK/Break key -KEY_DOWN/The four arrow keys ... -KEY_UP -KEY_LEFT -KEY_RIGHT -KEY_HOME/Home key (upward+left arrow) -KEY_BACKSPACE/Backspace -KEY_F0/T{ -Function keys; space for 64 keys is reserved. +Lb Lb +Lb Lx. +Symbol Key name += +KEY_BREAK Break key +KEY_DOWN Arrow keys +KEY_UP \^ +KEY_LEFT \^ +KEY_RIGHT \^ +KEY_HOME Home key (upward+left arrow) +KEY_BACKSPACE Backspace +KEY_F0 T{ +Function keys; space for 64 keys is reserved T} -KEY_F(\fIn\fP)/T{ -For 0 \(<= \fIn\fP \(<= 63 +KEY_F(\fIn\fP) T{ +Function key \fIn\fP where 0 \(<= \fIn\fP \(<= 63 T} -KEY_DL/Delete line -KEY_IL/Insert line -KEY_DC/Delete character -KEY_IC/Insert char or enter insert mode -KEY_EIC/Exit insert char mode -KEY_CLEAR/Clear screen -KEY_EOS/Clear to end of screen -KEY_EOL/Clear to end of line -KEY_SF/Scroll 1 line forward -KEY_SR/Scroll 1 line backward (reverse) -KEY_NPAGE/Next page -KEY_PPAGE/Previous page -KEY_STAB/Set tab -KEY_CTAB/Clear tab -KEY_CATAB/Clear all tabs -KEY_ENTER/Enter or send -KEY_SRESET/Soft (partial) reset -KEY_RESET/Reset or hard reset -KEY_PRINT/Print or copy -KEY_LL/Home down or bottom (lower left) -KEY_A1/Upper left of keypad -KEY_A3/Upper right of keypad -KEY_B2/Center of keypad -KEY_C1/Lower left of keypad -KEY_C3/Lower right of keypad -KEY_BTAB/Back tab key -KEY_BEG/Beg(inning) key -KEY_CANCEL/Cancel key -KEY_CLOSE/Close key -KEY_COMMAND/Cmd (command) key -KEY_COPY/Copy key -KEY_CREATE/Create key -KEY_END/End key -KEY_EXIT/Exit key -KEY_FIND/Find key -KEY_HELP/Help key -KEY_MARK/Mark key -KEY_MESSAGE/Message key -KEY_MOUSE/Mouse event occurred -KEY_MOVE/Move key -KEY_NEXT/Next object key -KEY_OPEN/Open key -KEY_OPTIONS/Options key -KEY_PREVIOUS/Previous object key -KEY_REDO/Redo key -KEY_REFERENCE/Ref(erence) key -KEY_REFRESH/Refresh key -KEY_REPLACE/Replace key -KEY_RESIZE/Screen resized -KEY_RESTART/Restart key -KEY_RESUME/Resume key -KEY_SAVE/Save key -KEY_SBEG/Shifted beginning key -KEY_SCANCEL/Shifted cancel key -KEY_SCOMMAND/Shifted command key -KEY_SCOPY/Shifted copy key -KEY_SCREATE/Shifted create key -KEY_SDC/Shifted delete char key -KEY_SDL/Shifted delete line key -KEY_SELECT/Select key -KEY_SEND/Shifted end key -KEY_SEOL/Shifted clear line key -KEY_SEXIT/Shifted exit key -KEY_SFIND/Shifted find key -KEY_SHELP/Shifted help key -KEY_SHOME/Shifted home key -KEY_SIC/Shifted insert key -KEY_SLEFT/Shifted left arrow key -KEY_SMESSAGE/Shifted message key -KEY_SMOVE/Shifted move key -KEY_SNEXT/Shifted next key -KEY_SOPTIONS/Shifted options key -KEY_SPREVIOUS/Shifted prev key -KEY_SPRINT/Shifted print key -KEY_SREDO/Shifted redo key -KEY_SREPLACE/Shifted replace key -KEY_SRIGHT/Shifted right arrow key -KEY_SRSUME/Shifted resume key -KEY_SSAVE/Shifted save key -KEY_SSUSPEND/Shifted suspend key -KEY_SUNDO/Shifted undo key -KEY_SUSPEND/Suspend key -KEY_UNDO/Undo key +KEY_DL Delete line +KEY_IL Insert line +KEY_DC Delete character +KEY_IC Insert character/Enter insert mode +KEY_EIC Exit insert character mode +KEY_CLEAR Clear screen +KEY_EOS Clear to end of screen +KEY_EOL Clear to end of line +KEY_SF Scroll one line forward +KEY_SR Scroll one line backward (reverse) +KEY_NPAGE Next page/Page up +KEY_PPAGE Previous page/Page down +KEY_STAB Set tab +KEY_CTAB Clear tab +KEY_CATAB Clear all tabs +KEY_ENTER Enter/Send +KEY_SRESET Soft (partial) reset +KEY_RESET (Hard) reset +KEY_PRINT Print/Copy +KEY_LL Home down/Bottom (lower left) +KEY_A1 Upper left of keypad +KEY_A3 Upper right of keypad +KEY_B2 Center of keypad +KEY_C1 Lower left of keypad +KEY_C3 Lower right of keypad +KEY_BTAB Back tab key +KEY_BEG Beg(inning) key +KEY_CANCEL Cancel key +KEY_CLOSE Close key +KEY_COMMAND Cmd (command) key +KEY_COPY Copy key +KEY_CREATE Create key +KEY_END End key +KEY_EXIT Exit key +KEY_FIND Find key +KEY_HELP Help key +KEY_MARK Mark key +KEY_MESSAGE Message key +KEY_MOUSE Mouse event occurred +KEY_MOVE Move key +KEY_NEXT Next object key +KEY_OPEN Open key +KEY_OPTIONS Options key +KEY_PREVIOUS Previous object key +KEY_REDO Redo key +KEY_REFERENCE Ref(erence) key +KEY_REFRESH Refresh key +KEY_REPLACE Replace key +KEY_RESIZE Screen resized +KEY_RESTART Restart key +KEY_RESUME Resume key +KEY_SAVE Save key +KEY_SELECT Select key +KEY_SUSPEND Suspend key +KEY_UNDO Undo key +_ +KEY_SBEG Shifted beginning key +KEY_SCANCEL Shifted cancel key +KEY_SCOMMAND Shifted command key +KEY_SCOPY Shifted copy key +KEY_SCREATE Shifted create key +KEY_SDC Shifted delete character key +KEY_SDL Shifted delete line key +KEY_SEND Shifted end key +KEY_SEOL Shifted clear line key +KEY_SEXIT Shifted exit key +KEY_SFIND Shifted find key +KEY_SHELP Shifted help key +KEY_SHOME Shifted home key +KEY_SIC Shifted insert key +KEY_SLEFT Shifted left arrow key +KEY_SMESSAGE Shifted message key +KEY_SMOVE Shifted move key +KEY_SNEXT Shifted next object key +KEY_SOPTIONS Shifted options key +KEY_SPREVIOUS Shifted previous object key +KEY_SPRINT Shifted print key +KEY_SREDO Shifted redo key +KEY_SREPLACE Shifted replace key +KEY_SRIGHT Shifted right arrow key +KEY_SRSUME Shifted resume key +KEY_SSAVE Shifted save key +KEY_SSUSPEND Shifted suspend key +KEY_SUNDO Shifted undo key .TE +.RE +.PP +Many keyboards feature a nine-key directional pad. .PP -Keypad is arranged like this: -.br +.RS .TS -center allbox tab(/) ; -c c c . -\fBA1\fP/\fBup\fP/\fBA3\fP -\fBleft\fP/\fBB2\fP/\fBright\fP -\fBC1\fP/\fBdown\fP/\fBC3\fP +allbox center; +C C C. +A1 up A3 +left B2 right +C1 down C3 .TE +.RE .sp -A few of these predefined values do \fInot\fP correspond to a real key: +Two of the symbols in the list above do +.I not +correspond to a physical key. .bP -.B KEY_RESIZE -is returned when the \fBSIGWINCH\fP signal has been detected -(see \fBinitscr\fP(3X) and \fBresizeterm\fP(3X)). -This code is returned whether or not \fBkeypad\fP has been enabled. +.B \%wgetch +returns +.BR \%KEY_RESIZE , +even if the window's keypad mode is disabled, +when +.I \%ncurses +handles a +.B \%SIGWINCH +signal; +see \fB\%initscr\fP(3X) and \fB\%resizeterm\fP(3X). .bP -.B KEY_MOUSE -is returned for mouse-events (see \fBcurs_mouse\fP(3X)). -This code relies upon whether or not \fBkeypad\fP(3X) has been enabled, -because (e.g., with \fBxterm\fP(1) mouse prototocol) ncurses must -read escape sequences, -just like a function key. -.SS Testing key-codes -.PP -The \fBhas_key\fP routine takes a key-code value from the above list, and -returns \fBTRUE\fP or \fBFALSE\fP according to whether -the current terminal type recognizes a key with that value. -.PP -The library also supports these extensions: -.RS 3 -.TP 5 -.B define_key -defines a key-code for a given string (see \fBdefine_key\fP(3X)). -.TP 5 -.B key_defined -checks if there is a key-code defined for a given -string (see \fBkey_defined\fP(3X)). -.RE -.PP +.B \%wgetch +returns +.B \%KEY_MOUSE +to indicate that a mouse event is pending collection; +see \fB\%curs_mouse\fP(3X). +Receipt of this code requires a window's keypad mode to be enabled, +because to interpret mouse input +(as with with \fI\%xterm\fP(1)'s mouse prototocol), +.I \%ncurses +must read an escape sequence, +as with a function key. +.SS "Testing Key Codes" +In +.IR \%ncurses , +.B \%has_key +returns a Boolean value indicating whether the terminal type recognizes +its parameter as a key code value. +See also +\fB\%define_key\fP(3X) and \fB\%key_defined\fP(3X). .SH RETURN VALUE -All routines return the integer \fBERR\fP upon failure and an integer value -other than \fBERR\fP (\fBOK\fP in the case of \fBungetch\fP) upon successful -completion. -.RS 3 -.TP 5 -\fBungetch\fP -returns \fBERR\fP -if there is no more room in the FIFO. -.TP -\fBwgetch\fP -returns \fBERR\fP -if the window pointer is null, or -if its timeout expires without having any data, or -if the execution was interrupted by a signal (\fBerrno\fP will be set to -\fBEINTR\fP). -.RE +Except for +.BR \%has_key , +these functions return +.B OK +on success and +.B ERR +on failure. +.PP +Functions taking a +.I \%WINDOW +pointer argument fail if the pointer is +.BR NULL . .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. +.PP +.B \%wgetch +also fails if +.bP +its timeout expires without any data arriving, +or +.bP +execution was interrupted by a signal, +in which case +.B \%errno +is set to +.BR \%EINTR . +.PP +.B \%ungetch +fails if there is no more room in the input queue. +.PP +.B \%has_key +returns +.B TRUE +or +.BR FALSE . .SH NOTES -Use of the escape key by a programmer for a single character function is -discouraged, as it will cause a delay of up to one second while the -keypad code looks for a following function-key sequence. -.PP -Some keys may be the same as commonly used control -keys, e.g., -\fBKEY_ENTER\fP versus control/M, -\fBKEY_BACKSPACE\fP versus control/H. -Some curses implementations may differ according to whether they -treat these control keys specially (and ignore the terminfo), or -use the terminfo definitions. -\fBNcurses\fP uses the terminfo definition. -If it says that \fBKEY_ENTER\fP is control/M, -\fBgetch\fP will return \fBKEY_ENTER\fP -when you press control/M. -.PP -Generally, \fBKEY_ENTER\fP denotes the character(s) sent by the \fIEnter\fP -key on the numeric keypad: +.I curses +discourages assignment of the ESC key to a discrete function by the +programmer because the library requires a delay while it awaits the +potential remainder of a terminal escape sequence. +.PP +Some key strokes are indistinguishable from control characters; +for example, +.B \%KEY_ENTER +may be the same as +.BR \*^M , +.\" as with att630 or pccon+keys +and +.B \%KEY_BACKSPACE +may be the same as +.B \*^H +.\" as with att505 or vt52-basic +or +.BR \*^? . +.\" as with pccon+keys or vt320 +Consult the terminal's +.I \%term\%info +entry to determine whether this is the case; +see \fB\%infocmp\fP(1). +Some +.I curses +implementations, +including +.IR \%ncurses , +honor the +.I \%term\%info +key definitions; +others treat such control characters specially. +.PP +.I curses +distinguishes the Enter keys in the alphabetic and numeric keypad +sections of a keyboard because (most) terminals do. +.B \%KEY_ENTER +refers to the key on the numeric keypad and, +like other function keys, +and is reliably recognized only if the window's keypad mode is enabled. .bP -the terminal description lists the most useful keys, +The +.I \%term\%info +.B \%key_enter +.RB ( kent ) +capability describes the character (sequence) sent by the Enter key of +a terminal's numeric +(or similar) +keypad. .bP -the \fIEnter\fP key on the regular keyboard is already handled by -the standard ASCII characters for carriage-return and line-feed, +\*(``Enter or send\*('' is X/Open Curses's description of this key. +.PP +.I curses +treats the Enter or Return key in the +.I alphabetic +section of the keyboard differently. .bP -depending on whether \fBnl\fP or \fBnonl\fP was called, -pressing \*(``Enter\*('' on the regular keyboard -may return either a carriage-return or line-feed, and finally +It usually produces a control code for carriage return +.RB ( \*^M ) +or line feed +.RB ( \*^J ). .bP -\*(``Enter or send\*('' is the standard description for this key. -.PP -When using \fBgetch\fP, \fBwgetch\fP, \fBmvgetch\fP, or -\fBmvwgetch\fP, nocbreak mode (\fBnocbreak\fP) and echo mode -(\fBecho\fP) should not be used at the same time. -Depending on the -state of the tty driver when each character is typed, the program may -produce undesirable results. -.PP -Note that \fBgetch\fP, \fBmvgetch\fP, and \fBmvwgetch\fP may be macros. -.PP -Historically, the set of keypad macros was largely defined by the extremely -function-key-rich keyboard of the AT&T 7300, aka 3B1, aka Safari 4. -Modern -personal computers usually have only a small subset of these. -IBM PC-style -consoles typically support little more than \fBKEY_UP\fP, \fBKEY_DOWN\fP, -\fBKEY_LEFT\fP, \fBKEY_RIGHT\fP, \fBKEY_HOME\fP, \fBKEY_END\fP, -\fBKEY_NPAGE\fP, \fBKEY_PPAGE\fP, and function keys 1 through 12. -The Ins key -is usually mapped to \fBKEY_IC\fP. +Depending on the terminal mode +(raw, +cbreak, +or +\*(``cooked\*(''), +and whether \fB\%nl\fP(3X) or \fB\%nonl\fP(3X) has been called, +.B \%wgetch +may return either a carriage return or line feed upon an Enter or Return +key stroke. +.PP +Use of +.B \%wgetch +with \fB\%echo\fP(3X) and neither \fB\%cbreak\fP(3X) nor \fB\%raw\fP(3X) +is not well-defined. +.PP +Historically, +the list of key code macros above was influenced by the +function-key-rich keyboard of the AT&T 7300 +(also known variously as the \*(``3B1\*('', \*(``Safari 4\*('', and +\*(``UNIX PC\*(''), +a 1985 machine. +Today's computer keyboards are based that of the IBM PC/AT and tend to +have fewer. +A +.I curses +application can expect such a keyboard to transmit key codes +.BR \%KEY_UP , +.BR \%KEY_DOWN , +.BR \%KEY_LEFT , +.BR \%KEY_RIGHT , +.BR \%KEY_HOME , +.BR \%KEY_END , +.B \%KEY_PPAGE +(Page Up), +.B \%KEY_NPAGE +(Page Down), +.B \%KEY_IC +(Insert), +.B \%KEY_DC +(Delete), +and +.BI \%KEY_F( n ) +for 1 \(<= +.I n +\(<= 12. +.PP +.BR \%getch , +.BR \%mvgetch , +and +.B \%mvwgetch +may be implemented as macros. +.SH EXTENSIONS +In +.IR \%ncurses , +when a window's \*(``no time-out\*('' mode is +.I not +set, +the +.B \%ESCDELAY +variable configures the duration of the timer used to disambiguate a +function key character sequence from a series of key strokes beginning +with ESC typed by the user; +see +\fB\%curs_variables\fP(3X). +.PP +\fB\%has_key\fP was designed for \fB\%ncurses\fP(3X), +and is not found in SVr4 +.IR curses , +4.4BSD +.IR curses , +or any other previous curses implementation. .SH PORTABILITY -The *get* functions are described in the XSI Curses standard, Issue 4. -They -read single-byte characters only. -The standard specifies that they return -\fBERR\fP on failure, but specifies no error conditions. -.PP -The echo behavior of these functions on input of \fBKEY_\fP or backspace -characters was not specified in the SVr4 documentation. -This description is -adopted from the XSI Curses standard. -.PP -The behavior of \fBgetch\fP and friends in the presence of handled signals is -unspecified in the SVr4 and XSI Curses documentation. -Under historical curses -implementations, it varied depending on whether the operating system's -implementation of handled signal receipt interrupts a \fBread\fP(2) call in -progress or not, and also (in some implementations) depending on whether an -input timeout or non-blocking mode has been set. -.PP -\fBKEY_MOUSE\fP is mentioned in XSI Curses, along with a few related -terminfo capabilities, but no higher-level functions use the feature. -The implementation in ncurses is an extension. -.PP -\fBKEY_RESIZE\fP is an extension first implemented for ncurses. -NetBSD curses later added this extension. -.PP -Programmers concerned about portability should be prepared for either of two -cases: (a) signal receipt does not interrupt \fBgetch\fP; (b) signal receipt -interrupts \fBgetch\fP and causes it to return \fBERR\fP with \fBerrno\fP set to -\fBEINTR\fP. -.PP -The \fBhas_key\fP function is unique to \fBncurses\fP. -We recommend that -any code using it be conditionalized on the \fBNCURSES_VERSION\fP feature macro. +Applications employing +.I \%ncurses +extensions should condition their use on the visibility of the +.B \%NCURSES_VERSION +preprocessor macro. +.PP +X/Open Curses, +Issue 4 describes +\fB\%getch\fP, +\fB\%wgetch\fP, +\fB\%mvgetch\fP, +\fB\%mvwgetch\fP, +and +\fB\%ungetch\fP. +It specifies no error conditions for them. +.PP +.B \%wgetch +reads only single-byte characters. +.PP +The echo behavior of these functions on input of +.B KEY_ +or backspace characters was not specified in the SVr4 documentation. +This description is adapted from X/Open Curses. +.PP +The behavior of +.B \%wgetch +in the presence of signal handlers is unspecified in the SVr4 +documentation and X/Open Curses. +In historical +.I curses +implementations, +it varied depending on whether the operating system's dispatch of a +signal to a handler interrupting a \fIread\fP(2) call in progress, +and also +(in some implementations) +whether an input timeout or non-blocking mode has been set. +Programmers concerned about portability should be prepared for either of +two cases: +(a) signal receipt does not interrupt +.BR \%wgetch ; +or +(b) signal receipt interrupts +.B \%wgetch +and causes it to return +.B ERR +with +.B \%errno +set to +.BR \%EINTR . +.PP +.B \%KEY_MOUSE +is mentioned in X/Open Curses, +along with a few related +.I \%term\%info +capabilities, +but no higher-level functions use the feature. +The implementation in +.I \%ncurses +is an extension. +.PP +.B \%KEY_RESIZE +and +.B \%has_key +are extensions first implemented for +.IR \%ncurses . +By 2022, +.I \%PDCurses +.\" https://web.archive.org/web/20220117232009/https://pdcurses.org/docs/MANUAL.html +and +NetBSD +.I curses +.\" https://web.archive.org/web/20200923185647/https://man.netbsd.org/curses_input.3 +had added them along with +.BR \%KEY_MOUSE . .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_inopts\fP(3X), -\fBcurs_mouse\fP(3X), -\fBcurs_move\fP(3X), -\fBcurs_outopts\fP(3X), -\fBcurs_refresh\fP(3X), -\fBcurs_variables\fP(3X), -\fBresizeterm\fP(3X). -.PP -Comparable functions in the wide-character (ncursesw) library are -described in -\fBcurs_get_wch\fP(3X). +\fB\%curs_get_wch\fP(3X) describes comparable functions of the +.I \%ncurses +library in its wide-character configuration +.RI ( \%ncursesw ). +.PP +\fB\%curses\fP(3X), +\fB\%curs_addch\fP(3X), +\fB\%curs_inopts\fP(3X), +\fB\%curs_mouse\fP(3X), +\fB\%curs_move\fP(3X), +\fB\%curs_outopts\fP(3X), +\fB\%curs_refresh\fP(3X), +\fB\%curs_variables\fP(3X), +\fB\%resizeterm\fP(3X), +\fB\%ascii\fP(7) +.PP +ECMA-6 \*(``7-bit coded Character Set\*('' +\%<https://\*:ecma\-international\*:.org/\ +\*:publications\-and\-standards/\*:standards/\*:ecma\-6/> +.PP +ECMA-48 \*(``Control Functions for Coded Character Sets\*('' +\%<https://\*:ecma\-international\*:.org/\ +\*:publications\-and\-standards/\*:standards/\*:ecma\-48/> diff --git a/upstream/archlinux/man3/curs_getstr.3x b/upstream/archlinux/man3/curs_getstr.3x index 80a1c1ab..6b4299ae 100644 --- a/upstream/archlinux/man3/curs_getstr.3x +++ b/upstream/archlinux/man3/curs_getstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,70 +27,70 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getstr.3x,v 1.36 2022/02/12 20:07:29 tom Exp $ -.TH curs_getstr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_getstr.3x,v 1.58 2024/04/20 19:18:18 tom Exp $ +.TH curs_getstr 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBgetstr\fP, -\fBgetnstr\fP, -\fBwgetstr\fP, -\fBwgetnstr\fP, -\fBmvgetstr\fP, -\fBmvgetnstr\fP, -\fBmvwgetstr\fP, -\fBmvwgetnstr\fP \- accept character strings from \fBcurses\fP terminal keyboard -.ad -.hy +\fB\%getstr\fP, +\fB\%getnstr\fP, +\fB\%wgetstr\fP, +\fB\%wgetnstr\fP, +\fB\%mvgetstr\fP, +\fB\%mvgetnstr\fP, +\fB\%mvwgetstr\fP, +\fB\%mvwgetnstr\fP \- +accept character strings from \fIcurses\fR terminal keyboard .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint getstr(char *\fIstr\fB);\fR -.br -\fBint getnstr(char *\fIstr\fB, int \fIn\fB);\fR -.br -\fBint wgetstr(WINDOW *\fIwin\fB, char *\fIstr\fB);\fR -.br -\fBint wgetnstr(WINDOW *\fIwin\fB, char *\fIstr\fB, int \fIn\fB);\fR -.sp -\fBint mvgetstr(int \fIy\fB, int \fIx\fB, char *\fIstr\fB);\fR -.br -\fBint mvwgetstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, char *\fIstr\fB);\fR -.br -\fBint mvgetnstr(int \fIy\fB, int \fIx\fB, char *\fIstr\fB, int \fIn\fB);\fR -.br -\fBint mvwgetnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, char *\fIstr\fB, int \fIn\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBint getstr(char *\fIstr\fP); +\fBint getnstr(char *\fIstr\fP, int \fIn\fP); +\fBint wgetstr(WINDOW *\fIwin\fP, char *\fIstr\fP); +\fBint wgetnstr(WINDOW *\fIwin\fP, char *\fIstr\fP, int \fIn\fP); +.PP +\fBint mvgetstr(int \fIy\fP, int \fIx\fP, char *\fIstr\fP); +\fBint mvwgetstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, char *\fIstr\fP); +\fBint mvgetnstr(int \fIy\fP, int \fIx\fP, char *\fIstr\fP, int \fIn\fP); +\fBint mvwgetnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, char *\fIstr\fP, int \fIn\fP); +.fi .SH DESCRIPTION -The function \fBgetstr\fP is equivalent to a series of calls to \fBgetch\fP, -until a newline or carriage return is received (the terminating character is -not included in the returned string). -.\" X/Open says also until EOf -.\" X/Open says then an EOS is added to the result -.\" X/Open doesn't mention n<0 -The resulting value is placed in the -area pointed to by the character pointer \fIstr\fP, -followed by a NUL. -.PP -The \fBgetnstr\fP function reads -from the \fIstdscr\fP default window. -The other functions, such as \fBwgetnstr\fP, -read from the window given as a parameter. -.PP -\fBgetnstr\fP reads at most \fIn\fP characters, thus preventing a possible -overflow of the input buffer. -Any attempt to enter more characters (other -than the terminating newline or carriage return) causes a beep. -Function -keys also cause a beep and are ignored. +The function +\fBwgetnstr\fP +is equivalent to a series of calls to +\fBwgetch\fP(3X), +until a newline or carriage return terminates the series: +.bP +The terminating character is not included in the returned string. +.bP +In all instances, the end of the string is terminated +by a NUL. +.bP +The function stores the result in the area pointed to +by the \fIstr\fP parameter. +.bP +The function reads at most \fIn\fP characters, +thus preventing a possible overflow of the input buffer. +.IP +Any attempt to enter more characters +(other than the terminating newline or carriage return) +causes a beep. +.IP +Function keys also cause a beep and are ignored. .PP The user's \fIerase\fP and \fIkill\fP characters are interpreted: .bP @@ -99,40 +99,86 @@ at the end of the buffer, moving the cursor to the left. .IP If \fIkeypad\fP mode is on for the window, \fBKEY_LEFT\fP and \fBKEY_BACKSPACE\fP -are both considered equivalent to the user's erase character. +are both considered equivalent to the user's \fIerase\fP character. .bP The \fIkill\fP character (e.g., \fB^U\fP) erases the entire buffer, leaving the cursor at the beginning of the buffer. .PP Characters input are echoed only if \fBecho\fP is currently on. In that case, -backspace is echoed as deletion of the previous character (typically a left -motion). +backspace is echoed as deletion of the previous character +(typically a left motion). +.PP +The +\fBgetnstr\fP, +\fBmvgetnstr\fP, +\fBmvwgetnstr\fP, and +\fBwgetnstr\fP +functions are identical +to the +\fBgetstr\fP, +\fBmvgetstr\fP, +\fBmvwgetstr\fP, and +\fBwgetstr\fP +functions, respectively, +except that the +\fB*n*\fP +versions read at most +\fIn\fP +characters, letting the application prevent overflow of the +input buffer. .SH RETURN VALUE -All routines return the integer \fBERR\fP upon failure and an \fBOK\fP (SVr4 -specifies only \*(``an integer value other than \fBERR\fP\*('') upon successful -completion. +All of these functions return the integer \fBOK\fP upon successful completion. +(SVr4 specifies only \*(``an integer value other than \fBERR\fP\*('') +If unsuccessful, they return \fBERR\fP. .PP X/Open defines no error conditions. .PP In this implementation, these functions return an error -if the window pointer is null, or -if its timeout expires without having any data. +.bP +if the window pointer is null, +.bP +if its timeout expires without having any data, or +.bP +if the associated call to +\fBwgetch\fP +failed. .PP This implementation provides an extension as well. If a \fBSIGWINCH\fP interrupts the function, it will return \fBKEY_RESIZE\fP rather than \fBOK\fP or \fBERR\fP. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES -Note that \fBgetstr\fP, \fBmvgetstr\fP, and \fBmvwgetstr\fP may be macros. +Any of these functions other than +\fBwgetnstr\fP +may be macros. +.PP +Using +\fBgetstr\fP, +\fBmvgetstr\fP, +\fBmvwgetstr\fP, or +\fBwgetstr\fP +to read a line that +overflows the array pointed to by +\fBstr\fP +causes undefined +results. +The use of +\fBgetnstr\fP, +\fBmvgetnstr\fP, +\fBmvwgetnstr\fP, or +\fBwgetnstr\fP, +respectively, is recommended. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. -They read single-byte characters only. -The standard does not define any error conditions. +These functions are described in The Single Unix Specification, Version 2. +No error conditions are defined. +.PP This implementation returns \fBERR\fP if the window pointer is null, or if the lower-level \fBwgetch\fP(3X) call returns an \fBERR\fP. .PP @@ -157,9 +203,9 @@ but did not state whether the terminating NUL is counted in that limit. X/Open Curses, Issue 7 (2009) changed that to say they \*(``read at most \fIn\fP\-1 bytes\*('' to allow for the terminating NUL. -As of 2018, some implementations do, some do not count it: +As of 2018, some implementations count it, some do not: .bP -ncurses 6.1 and PDCurses do not count the NUL in the given limit, while +\fI\%ncurses\fP 6.1 and PDCurses do not count the NUL in the given limit, while .bP Solaris SVr4 and NetBSD curses count the NUL as part of the limit. .bP @@ -187,15 +233,15 @@ that it is greater than zero. .IP A comment in NetBSD's source code states that this is specified in SUSv2. .bP -ncurses (before 6.2) assumes no particular limit for the result +\fI\%ncurses\fP (before 6.2) assumes no particular limit for the result from \fBwgetstr\fP, and treats the \fIn\fP parameter of \fBwgetnstr\fP like SVr4 curses. .bP -ncurses 6.2 uses \fBLINE_MAX\fP, +\fI\%ncurses\fP 6.2 uses \fBLINE_MAX\fP, or a larger (system-dependent) value which the \fBsysconf\fP function may provide. If neither \fBLINE_MAX\fP or \fBsysconf\fP is available, -ncurses uses the POSIX value for \fBLINE_MAX\fP (a 2048 byte limit). +\fI\%ncurses\fP uses the POSIX value for \fBLINE_MAX\fP (a 2048 byte limit). In either case, it reserves a byte for the terminating NUL. .PP Although \fBgetnstr\fP is equivalent to a series of calls to \fBgetch\fP, @@ -225,22 +271,31 @@ They may take the \fIcbreak\fP mode set by the caller into account when deciding whether to handle echoing within \fBgetnstr\fP or as a side-effect of the \fBgetch\fP calls. .bP -The original ncurses (as \fIpcurses\fP in 1986) set \fBnoraw\fP and \fBcbreak\fP -when accepting input for \fBgetnstr\fP. +The original \fI\%ncurses\fP +(as \fIpcurses\fP in 1986) +set \fBnoraw\fP and \fBcbreak\fP when accepting input for \fBgetnstr\fP. That may have been done to make function- and cursor-keys work; -it is not necessary with ncurses. +it is not necessary with \fI\%ncurses\fP. .IP -Since 1995, ncurses has provided signal handlers for INTR and QUIT -(e.g., \fB^C\fP or \fB^\\\fP). +Since 1995, +\fI\%ncurses\fP has provided signal handlers for INTR and QUIT +(e.g., \fB^C\fP or \fB^\e\fP). With the \fBnoraw\fP and \fBcbreak\fP settings, those may catch a signal and stop the program, where other implementations allow one to enter those characters in the buffer. .bP -Starting in 2021 (ncurses 6.3), \fBgetnstr\fP sets \fBraw\fP, +Starting in 2021 +(\fI\%ncurses\fP 6.3), +\fBgetnstr\fP sets \fBraw\fP, rather than \fBnoraw\fP and \fBcbreak\fP for better compatibility with SVr4-curses, e.g., allowing one to enter a \fB^C\fP into the buffer. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_getch\fP(3X), -\fBcurs_termattrs\fP(3X), -\fBcurs_variables\fP(3X). +\fB\%curs_get_wstr\fP(3X) describes comparable functions of the +.I \%ncurses +library in its wide-character configuration +.RI ( \%ncursesw ). +.PP +\fB\%curses\fP(3X), +\fB\%curs_getch\fP(3X), +\fB\%curs_termattrs\fP(3X), +\fB\%curs_variables\fP(3X) diff --git a/upstream/archlinux/man3/curs_getyx.3x b/upstream/archlinux/man3/curs_getyx.3x index 94ceeb3a..0183ab68 100644 --- a/upstream/archlinux/man3/curs_getyx.3x +++ b/upstream/archlinux/man3/curs_getyx.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2020-2021,2022 Thomas E. Dickey * +.\" Copyright 2020-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2007,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,75 +27,87 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getyx.3x,v 1.23 2022/02/12 20:07:29 tom Exp $ -.TH curs_getyx 3X "" +.\" $Id: curs_getyx.3x,v 1.44 2024/04/20 21:20:07 tom Exp $ +.TH curs_getyx 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .SH NAME -\fBgetyx\fP, -\fBgetparyx\fP, -\fBgetbegyx\fP, -\fBgetmaxyx\fP \- get \fBcurses\fP cursor and window coordinates +\fB\%getyx\fP, +\fB\%getparyx\fP, +\fB\%getbegyx\fP, +\fB\%getmaxyx\fP \- +get \fIcurses\fR cursor and window coordinates .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBvoid getyx(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB);\fR -.br -\fBvoid getparyx(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB);\fR -.br -\fBvoid getbegyx(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB);\fR -.br -\fBvoid getmaxyx(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBvoid getyx(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); +\fBvoid getparyx(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); +\fBvoid getbegyx(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); +\fBvoid getmaxyx(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); +.fi .SH DESCRIPTION -The \fBgetyx\fP macro places the current cursor position of the given window in -the two integer variables \fIy\fP and \fIx\fP. +The \fB\%getyx\fP macro places the current cursor position +of the given window in the two integer variables \fIy\fP and \fIx\fP. .PP -If \fIwin\fP is a subwindow, the \fBgetparyx\fP macro places the beginning +If \fIwin\fP is a subwindow, the \fB\%getparyx\fP macro places the beginning coordinates of the subwindow relative to the parent window into two integer variables \fIy\fP and \fIx\fP. Otherwise, \fB\-1\fP is placed into \fIy\fP and \fIx\fP. .PP -Like \fBgetyx\fP, the \fBgetbegyx\fP and \fBgetmaxyx\fP macros store +Like \fB\%getyx\fP, the \fB\%getbegyx\fP and \fB\%getmaxyx\fP macros store the current beginning coordinates and size of the specified window. .SH RETURN VALUE The return values of these macros are undefined (i.e., they should not be used as the right-hand side of assignment statements). .SH NOTES All of these interfaces are macros. -A "\fB&\fP" is not necessary before the variables \fIy\fP and \fIx\fP. +A \*(``&\*('' is not necessary before the variables \fIy\fP and \fIx\fP. .SH PORTABILITY The -\fBgetyx\fP, -\fBgetparyx\fP, -\fBgetbegyx\fP and -\fBgetmaxyx\fP -macros are described in the XSI Curses standard, Issue 4. +\fB\%getyx\fP, +\fB\%getparyx\fP, +\fB\%getbegyx\fP and +\fB\%getmaxyx\fP +macros are described in X/Open Curses, Issue 4. .PP This implementation also provides functions -\fBgetbegx\fP, -\fBgetbegy\fP, -\fBgetcurx\fP, -\fBgetcury\fP, -\fBgetmaxx\fP, -\fBgetmaxy\fP, -\fBgetparx\fP and -\fBgetpary\fP -for compatibility with older versions of curses. +\fB\%getbegx\fP, +\fB\%getbegy\fP, +\fB\%getcurx\fP, +\fB\%getcury\fP, +\fB\%getmaxx\fP, +\fB\%getmaxy\fP, +\fB\%getparx\fP and +\fB\%getpary\fP +for compatibility with older versions of \fIcurses\fP; +see \fB\%curs_legacy\fP(3X). .PP Although X/Open Curses does not address this, -many implementations provide members of the WINDOW structure +many implementations provide members of the \fB\%WINDOW\fP structure containing values corresponding to these macros. -For best portability, do not rely on using the data in WINDOW, -since some implementations make WINDOW opaque (do not allow +For best portability, do not rely on using the data in \fB\%WINDOW\fP, +since some implementations make \fB\%WINDOW\fP opaque (do not allow direct use of its members). .PP Besides the problem of opaque structures, the data stored in like-named members may not have like-values in different implementations. -For example, the WINDOW._maxx and WINDOW._maxy values in ncurses -have (at least since release 1.8.1) differed by one from some -other implementations. -The difference is hidden by means of the macro \fBgetmaxyx\fP. +For example, the \fB\%WINDOW._maxx\fP and \fB\%WINDOW._maxy\fP values +in \fI\%ncurses\fP have +(at least since release 1.8.1) +differed by one from some other implementations. +The difference is hidden by means of the macro \fB\%getmaxyx\fP. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_legacy\fP(3X), -\fBcurs_opaque\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_legacy\fP(3X), +\fB\%curs_opaque\fP(3X) diff --git a/upstream/archlinux/man3/curs_in_wch.3x b/upstream/archlinux/man3/curs_in_wch.3x index ba249855..9be5d08a 100644 --- a/upstream/archlinux/man3/curs_in_wch.3x +++ b/upstream/archlinux/man3/curs_in_wch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 2002-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,45 +27,58 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_in_wch.3x,v 1.13 2022/02/12 20:07:29 tom Exp $ -.TH curs_in_wch 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_in_wch.3x,v 1.31 2024/04/20 21:20:07 tom Exp $ +.TH curs_in_wch 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME -\fBin_wch\fP, -\fBmvin_wch\fP, -\fBmvwin_wch\fP, -\fBwin_wch\fP \- extract a complex character and rendition from a window +\fB\%in_wch\fP, +\fB\%mvin_wch\fP, +\fB\%mvwin_wch\fP, +\fB\%win_wch\fP \- +get a \fIcurses\fR complex character from a window .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint in_wch(cchar_t *\fIwcval\fB);\fR -.br -\fBint win_wch(WINDOW *\fIwin\fB, cchar_t *\fIwcval\fB);\fR -.sp -\fBint mvin_wch(int \fIy\fB, int \fIx\fB, cchar_t *\fIwcval\fB);\fR -.br -\fBint mvwin_wch(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, cchar_t *\fIwcval\fB);\fR +.nf +\fB#include <curses.h> +.PP +\fBint in_wch(cchar_t *\fIwch\fP); +\fBint win_wch(WINDOW *\fIwin\fP, cchar_t *\fIwch\fP); +.PP +\fBint mvin_wch(int \fIy\fP, int \fIx\fP, cchar_t *\fIwch\fP); +\fBint mvwin_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwch\fP); +.fi .SH DESCRIPTION These functions extract the complex character and rendition from the current position in the named window into the \fBcchar_t\fP object -referenced by wcval. +referenced by wch. .SH RETURN VALUE -No errors are defined in the XSI Curses standard. +No errors are defined in X/Open Curses. This implementation checks for null pointers, returns \fBERR\fP in that case. Also, the \fImv\fP routines check for error moving the cursor, returning \fBERR\fP in that case. Otherwise they return \fBOK\fP. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES Note that all of these routines may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_inch\fP(3X). +\fB\%curs_inch\fP(3X) describes comparable functions of the +.I \%ncurses +library in its non-wide-character configuration. +.PP +\fB\%curses\fP(3X), +\fB\%curs_inwstr\fP(3X) diff --git a/upstream/archlinux/man3/curs_in_wchstr.3x b/upstream/archlinux/man3/curs_in_wchstr.3x index 4bcec948..65fe719a 100644 --- a/upstream/archlinux/man3/curs_in_wchstr.3x +++ b/upstream/archlinux/man3/curs_in_wchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 2002-2012,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,67 +27,81 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_in_wchstr.3x,v 1.17 2022/02/12 20:07:29 tom Exp $ -.TH curs_in_wchstr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' -.na -.hy 0 +.\" $Id: curs_in_wchstr.3x,v 1.39 2024/04/20 21:24:19 tom Exp $ +.TH curs_in_wchstr 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. .SH NAME -\fBin_wchstr\fP, -\fBin_wchnstr\fP, -\fBwin_wchstr\fP, -\fBwin_wchnstr\fP, -\fBmvin_wchstr\fP, -\fBmvin_wchnstr\fP, -\fBmvwin_wchstr\fP, -\fBmvwin_wchnstr\fP \- get an array of complex characters and renditions from a curses window -.ad -.hy +\fB\%in_wchstr\fP, +\fB\%in_wchnstr\fP, +\fB\%win_wchstr\fP, +\fB\%win_wchnstr\fP, +\fB\%mvin_wchstr\fP, +\fB\%mvin_wchnstr\fP, +\fB\%mvwin_wchstr\fP, +\fB\%mvwin_wchnstr\fP \- +get a \fIcurses\fR complex character string from a window .SH SYNOPSIS .nf -\fB#include <curses.h>\fP -.sp -\fBint in_wchstr(cchar_t *\fIwchstr\fB);\fR -.br -\fBint in_wchnstr(cchar_t *\fIwchstr\fB, int \fIn\fB);\fR -.br -\fBint win_wchstr(WINDOW *\fIwin\fB, cchar_t *\fIwchstr\fB);\fR -.br -\fBint win_wchnstr(WINDOW *\fIwin\fB, cchar_t *\fIwchstr\fB, int \fIn\fB);\fR -.sp -\fBint mvin_wchstr(int \fIy\fB, int \fIx\fB, cchar_t *\fIwchstr\fB);\fR -.br -\fBint mvin_wchnstr(int \fIy\fB, int \fIx\fB, cchar_t *\fIwchstr\fB, int \fIn\fB);\fR -.br -\fBint mvwin_wchstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, cchar_t *\fIwchstr\fB);\fR -.br -\fBint mvwin_wchnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, cchar_t *\fIwchstr\fR, int \fIn\fB);\fR +\fB#include <curses.h> +.PP +\fBint in_wchstr(cchar_t *\fIwchstr\fP); +\fBint win_wchstr(WINDOW *\fIwin\fP, cchar_t *\fIwchstr\fP); +\fBint mvin_wchstr(int \fIy\fP, int \fIx\fP, cchar_t *\fIwchstr\fP); +\fBint mvwin_wchstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwchstr\fP); +.PP +\fBint in_wchnstr(cchar_t *\fIwchstr\fP, int \fIn\fP); +\fBint win_wchnstr(WINDOW *\fIwin\fP, cchar_t *\fIwchstr\fP, int \fIn\fP); +\fBint mvin_wchnstr(int \fIy\fP, int \fIx\fP, cchar_t *\fIwchstr\fP, int \fIn\fP); +\fBint mvwin_wchnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwchstr\fP, int \fIn\fP); .fi .SH DESCRIPTION These functions return an array of complex characters in \fIwchstr\fP, starting at the current cursor position in the named window. Attributes (rendition) are stored with the characters. .PP -The -\fBin_wchnstr\fP, -\fBmvin_wchnstr\fP, -\fBmvwin_wchnstr\fP -and -\fBwin_wchnstr\fP -fill the array -with at most -\fIn\fP -\fBcchar_t\fP -elements. -.br +The four functions with \fIn\fP as the last argument return +a leading substring at most \fIn\fP characters long +(exclusive of the trailing zeroed \fBcchar_t\fR. +Transfer stops at the end of the current line, or when \fIn\fP characters have +been stored at the location referenced by \fIwchstr\fP. +.PP +Constants defined in \fB<curses.h>\fP can be used with the \fB&\fP (logical +AND) operator to extract the character or the attribute alone from any position +in the \fIwchstr\fP [see \fBgetcchar\fP(3X)]. +.SH RETURN VALUE +Upon successful completion, these functions return +\fBOK\fP. +Otherwise, they return +\fBERR\fP. +.PP +X/Open Curses defines no error conditions. +This implementation returns an error +.bP +if the \fIwin\fP parameter is null or +.bP +if the \fIwchstr\fP parameter is null. +.PP +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES -Note that all routines except -\fBwin_wchnstr\fP -may be -macros. +All routines except \fBwin_wchnstr\fP may be macros. .PP Reading a line that overflows the array pointed to by \fIwchstr\fP @@ -104,23 +118,15 @@ Therefore, the use of \fBmvwin_wchnstr\fP, or \fBwin_wchnstr\fP is recommended. -.SH RETURN VALUE -Upon successful completion, these functions return -\fBOK\fP. -Otherwise, they return -\fBERR\fP. -.PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. .SH PORTABILITY -The XSI Curses defines no error conditions. +X/Open Curses defines no error conditions. This implementation checks for null pointers, returning \fBERR\fP in that case. .SH SEE ALSO -Functions: -\fBcurses\fP(3X), -\fBcurs_in_wch\fP(3X), -\fBcurs_instr\fP(3X), -\fBcurs_inwstr\fP(3X) -\fBcurs_inchstr\fP(3X) +\fB\%curs_inchstr\fP(3X) describes comparable functions of the +.I \%ncurses +library in its non-wide-character configuration. +.PP +\fB\%curses\fP(3X), +\fB\%curs_inwstr\fP(3X), +\fB\%curs_in_wch\fP(3X) diff --git a/upstream/archlinux/man3/curs_inch.3x b/upstream/archlinux/man3/curs_inch.3x index 90992fe3..68742886 100644 --- a/upstream/archlinux/man3/curs_inch.3x +++ b/upstream/archlinux/man3/curs_inch.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,32 +28,39 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inch.3x,v 1.28 2022/02/12 20:07:29 tom Exp $ -.TH curs_inch 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_inch.3x,v 1.51 2024/04/20 21:20:07 tom Exp $ +.TH curs_inch 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBinch\fP, -\fBwinch\fP, -\fBmvinch\fP, -\fBmvwinch\fP \- get a character and attributes from a \fBcurses\fP window +\fB\%inch\fP, +\fB\%winch\fP, +\fB\%mvinch\fP, +\fB\%mvwinch\fP \- +get a \fIcurses\fR character from a window .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBchtype inch(void);\fP -.br -\fBchtype winch(WINDOW *\fIwin\fB);\fR -.sp -\fBchtype mvinch(int \fIy\fB, int \fIx\fB);\fR -.br -\fBchtype mvwinch(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBchtype inch(void); +\fBchtype winch(WINDOW *\fIwin\fP); +.PP +\fBchtype mvinch(int \fIy\fP, int \fIx\fP); +\fBchtype mvwinch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); +.fi .SH DESCRIPTION These routines return the character, of type \fBchtype\fP, at the current position in the named window. @@ -64,18 +71,23 @@ Constants defined in extract the character or attributes alone. . .SS Attributes -The following bit-masks may be AND-ed with characters returned by \fBwinch\fP. -. +The following bit masks may be AND-ed with characters returned by \fBwinch\fP. +.PP .TS -l l . -\fBA_CHARTEXT\fP Bit-mask to extract character -\fBA_ATTRIBUTES\fP Bit-mask to extract attributes -\fBA_COLOR\fP Bit-mask to extract color-pair field information +Lb Lb +Lb Lx. +Name Description +_ +A_CHARTEXT Extract character +A_ATTRIBUTES Extract attributes +A_COLOR Extract color pair information .TE .SH RETURN VALUE -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .PP The \fBwinch\fP function does not return an error if the window contains characters larger than 8-bits (255). @@ -83,7 +95,7 @@ Only the low-order 8 bits of the character are used by \fBwinch\fP. .SH NOTES Note that all of these routines may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. .PP Very old systems (before standardization) provide a different function with the same name: @@ -107,13 +119,10 @@ This implementation uses 8 bits for character values. An application using more bits, e.g., a Unicode value, should use the wide-character equivalents to these functions. .SH SEE ALSO -.TP 5 -\fBcurses\fP(3X) -gives an overview of the WINDOW and \fBchtype\fP data types. -.TP 5 -\fBcurs_attr\fP(3X) -goes into more detail, pointing out portability problems and -constraints on the use of \fBchtype\fP for returning window information. -.TP 5 -\fBcurs_in_wch\fP(3X) -describes comparable functions for the wide-character (ncursesw) library. +\fB\%curs_in_wch\fP(3X) describes comparable functions of the +.I \%ncurses +library in its wide-character configuration +.RI ( \%ncursesw ). +.PP +\fB\%curses\fP(3X), +\fB\%curs_instr\fP(3X) diff --git a/upstream/archlinux/man3/curs_inchstr.3x b/upstream/archlinux/man3/curs_inchstr.3x index 2ffa4e32..f34cbb7b 100644 --- a/upstream/archlinux/man3/curs_inchstr.3x +++ b/upstream/archlinux/man3/curs_inchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,55 +27,58 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inchstr.3x,v 1.24 2022/02/12 20:07:29 tom Exp $ -.TH curs_inchstr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_inchstr.3x,v 1.45 2024/04/20 21:20:07 tom Exp $ +.TH curs_inchstr 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBinchstr\fP, -\fBinchnstr\fP, -\fBwinchstr\fP, -\fBwinchnstr\fP, -\fBmvinchstr\fP, -\fBmvinchnstr\fP, -\fBmvwinchstr\fP, -\fBmvwinchnstr\fP \- get a string of characters (and attributes) from a \fBcurses\fP window -.ad -.hy +\fB\%inchstr\fP, +\fB\%inchnstr\fP, +\fB\%winchstr\fP, +\fB\%winchnstr\fP, +\fB\%mvinchstr\fP, +\fB\%mvinchnstr\fP, +\fB\%mvwinchstr\fP, +\fB\%mvwinchnstr\fP \- +get a \fIcurses\fR character string from a window .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint inchstr(chtype *\fIchstr\fB);\fR -.br -\fBint inchnstr(chtype *\fIchstr\fB, int \fIn\fB);\fR -.br -\fBint winchstr(WINDOW *\fIwin\fB, chtype *\fIchstr\fB);\fR -.br -\fBint winchnstr(WINDOW *\fIwin\fB, chtype *\fIchstr\fB, int \fIn\fB);\fR -.sp -\fBint mvinchstr(int \fIy\fB, int \fIx\fB, chtype *\fIchstr\fB);\fR -.br -\fBint mvinchnstr(int \fIy\fB, int \fIx\fB, chtype *\fIchstr\fB, int \fIn\fB);\fR -.br -\fBint mvwinchstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, chtype *\fIchstr\fB);\fR -.br -\fBint mvwinchnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, chtype *\fIchstr\fB, int \fIn\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBint inchstr(chtype *\fIchstr\fP); +\fBint inchnstr(chtype *\fIchstr\fP, int \fIn\fP); +\fBint winchstr(WINDOW *\fIwin\fP, chtype *\fIchstr\fP); +\fBint winchnstr(WINDOW *\fIwin\fP, chtype *\fIchstr\fP, int \fIn\fP); +.PP +\fBint mvinchstr(int \fIy\fP, int \fIx\fP, chtype *\fIchstr\fP); +\fBint mvinchnstr(int \fIy\fP, int \fIx\fP, chtype *\fIchstr\fP, int \fIn\fP); +\fBint mvwinchstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, chtype *\fIchstr\fP); +\fBint mvwinchnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, chtype *\fIchstr\fP, int \fIn\fP); +.fi .SH DESCRIPTION These routines return a NULL-terminated array of \fBchtype\fP quantities, starting at the current cursor position in the named window and ending at the right margin of the window. -The four functions with \fIn\fP as -the last argument, return a leading substring at most \fIn\fP characters long +.PP +The four functions with \fIn\fP as the last argument, return +a leading substring at most \fIn\fP characters long (exclusive of the trailing (chtype)0). +Transfer stops at the end of the current line, or when \fIn\fP characters have +been stored at the location referenced by \fIchstr\fP. +.PP Constants defined in \fB<curses.h>\fP can be used with the \fB&\fP (logical AND) operator to extract the character or the attribute alone from any position in the \fIchstr\fP [see \fBcurs_inch\fP(3X)]. @@ -85,30 +88,48 @@ other than \fBERR\fP upon successful completion (the number of characters retrieved, exclusive of the trailing 0). .PP X/Open Curses defines no error conditions. -In this implementation: +This implementation returns an error .bP -If the \fIwin\fP parameter is null, an error is returned, +if the \fIwin\fP parameter is null or .bP -If the \fIchstr\fP parameter is null, an error is returned, +if the \fIchstr\fP parameter is null. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES -Note that all routines except \fBwinchnstr\fP may be macros. +All routines except \fBwinchnstr\fP may be macros. +.PP SVr4 does not document whether the result string is zero-terminated; it does not document whether a length limit argument includes any trailing 0; and it does not document the meaning of the return value. +.PP +Reading a line that overflows the array pointed to by +\fIchstr\fP +with +\fBinchstr\fP, +\fBmvinchstr\fP, +\fBmvwinchstr\fP +or +\fBwinchstr\fP +causes undefined results. +Therefore, the use of +\fBinchnstr\fP, +\fBmvinchnstr\fP, +\fBmvwinchnstr\fP, or +\fBwinchnstr\fP +is recommended. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. It is no more specific than the SVr4 documentation on the trailing 0. It does specify that the successful return of the functions is \fBOK\fP. .SH SEE ALSO -\fBcurses\fP(3X), \fBcurs_inch\fP(3X). -.PP -Comparable functions in the wide-character (ncursesw) library are -described in -\fBcurs_in_wchstr\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_inch\fP(3X), +\fB\%curs_inwstr\fP(3X), +\fB\%curs_in_wchstr\fP(3X) diff --git a/upstream/archlinux/man3/curs_initscr.3x b/upstream/archlinux/man3/curs_initscr.3x index 5e17ead0..a90bfd5d 100644 --- a/upstream/archlinux/man3/curs_initscr.3x +++ b/upstream/archlinux/man3/curs_initscr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,42 +27,44 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_initscr.3x,v 1.39 2022/07/24 15:46:49 tom Exp $ -.TH curs_initscr 3X "" +.\" $Id: curs_initscr.3x,v 1.69 2024/04/20 21:24:19 tom Exp $ +.TH curs_initscr 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' -.na -.hy 0 .SH NAME -\fBinitscr\fP, -\fBnewterm\fP, -\fBendwin\fP, -\fBisendwin\fP, -\fBset_term\fP, -\fBdelscreen\fP \- \fBcurses\fP screen initialization and manipulation routines -.ad -.hy +\fB\%initscr\fP, +\fB\%newterm\fP, +\fB\%endwin\fP, +\fB\%isendwin\fP, +\fB\%set_term\fP, +\fB\%delscreen\fP \- +initialize, manipulate, or tear down \fIcurses\fR terminal interface .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBWINDOW *initscr(void);\fP -.br -\fBint endwin(void);\fP -.sp -\fBbool isendwin(void);\fP -.sp -\fBSCREEN *newterm(const char *\fItype\fB, FILE *\fIoutfd\fB, FILE *\fIinfd\fB);\fR -.br -\fBSCREEN *set_term(SCREEN *\fInew\fB);\fR -.br -\fBvoid delscreen(SCREEN* \fIsp\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBWINDOW *initscr(void); +\fBint endwin(void); +.PP +\fBbool isendwin(void); +.PP +\fBSCREEN *newterm(const char *\fItype\fP, FILE *\fIoutf\fP, FILE *\fIinf\fP); +\fBSCREEN *set_term(SCREEN *\fInew\fP); +\fBvoid delscreen(SCREEN* \fIsp\fP); +.fi .SH DESCRIPTION .SS initscr \fBinitscr\fP is normally the first \fBcurses\fP routine to call when @@ -81,27 +83,30 @@ If errors occur, \fBinitscr\fP writes an appropriate error message to standard error and exits; otherwise, a pointer is returned to \fBstdscr\fP. .SS newterm -.PP A program that outputs to more than one terminal should use the \fBnewterm\fP routine for each terminal instead of \fBinitscr\fP. A program that needs to inspect capabilities, so it can continue to run in a line-oriented mode if the terminal cannot support a screen-oriented program, would also use \fBnewterm\fP. +.PP The routine \fBnewterm\fP should be called once for each terminal. -It returns a variable of type \fBSCREEN *\fP which should be saved +It returns a variable of type \fISCREEN *\fP which should be saved as a reference to that terminal. \fBnewterm\fP's arguments are .bP the \fItype\fP of the terminal to be used in place of \fB$TERM\fP, .bP -a file pointer for output to the terminal, and +an output stream connected to the terminal, and .bP -another file pointer for input from the terminal +an input stream connected to the terminal .PP If the \fItype\fP parameter is \fBNULL\fP, \fB$TERM\fP will be used. -.SS endwin .PP +The file descriptor of the output stream is passed to \fBsetupterm\fP(3X), +which returns a pointer to a \fI\%TERMINAL\fP structure. +\fBnewterm\fP's return value holds a pointer to the \fI\%TERMINAL\fP structure. +.SS endwin The program must also call \fBendwin\fP for each terminal being used before exiting from \fBcurses\fP. If \fBnewterm\fP is called more than once for the same terminal, the first @@ -126,24 +131,21 @@ restores tty modes (see \fBreset_shell_mode\fP(3X)). Calling \fBrefresh\fP(3X) or \fBdoupdate\fP(3X) after a temporary escape causes the program to resume visual mode. .SS isendwin -.PP The \fBisendwin\fP routine returns \fBTRUE\fP if \fBendwin\fP has been called without any subsequent calls to \fBwrefresh\fP, and \fBFALSE\fP otherwise. .SS set_term -.PP The \fBset_term\fP routine is used to switch between different terminals. The screen reference \fInew\fP becomes the new current terminal. The previous terminal is returned by the routine. -This is the only routine which manipulates \fBSCREEN\fP pointers; +This is the only routine which manipulates \fISCREEN\fP pointers; all other routines affect only the current terminal. .SS delscreen -.PP The \fBdelscreen\fP routine frees storage associated with the -\fBSCREEN\fP data structure. +\fISCREEN\fP data structure. The \fBendwin\fP routine does not do this, so \fBdelscreen\fP should be called after \fBendwin\fP if a -particular \fBSCREEN\fP is no longer needed. +particular \fISCREEN\fP is no longer needed. .SH RETURN VALUE \fBendwin\fP returns the integer \fBERR\fP upon failure and \fBOK\fP upon successful completion. @@ -153,7 +155,15 @@ Routines that return pointers always return \fBNULL\fP on error. X/Open defines no error conditions. In this implementation .bP -\fBendwin\fP returns an error if the terminal was not initialized. +\fBendwin\fP returns an error if +.RS +.bP +the terminal was not initialized, or +.bP +\fBendwin\fP is called more than once without updating the screen, or +.bP +\fBreset_shell_mode\fP(3X) returns an error. +.RE .bP \fBnewterm\fP returns an error if it cannot allocate the data structures for the screen, @@ -164,14 +174,14 @@ i.e., \fBset_term\fP returns no error. .SH PORTABILITY -These functions were described in the XSI Curses standard, Issue 4. +These functions were described in X/Open Curses, Issue 4. As of 2015, the current document is X/Open Curses, Issue 7. .SS Differences -X/Open specifies that portable applications must not +X/Open Curses specifies that portable applications must not call \fBinitscr\fP more than once: .bP The portable way to use \fBinitscr\fP is once only, -using \fBrefresh\fP (see curs_refresh(3X)) +using \fB\%refresh\fP(3X) to restore the screen after \fBendwin\fP. .bP This implementation allows using \fBinitscr\fP after \fBendwin\fP. @@ -179,62 +189,81 @@ This implementation allows using \fBinitscr\fP after \fBendwin\fP. Old versions of curses, e.g., BSD 4.4, would return a null pointer from \fBinitscr\fP when an error is detected, rather than exiting. It is safe but redundant to check the return value of \fBinitscr\fP -in XSI Curses. +in X/Open Curses. .PP Calling \fBendwin\fP does not dispose of the memory allocated in \fBinitscr\fP or \fBnewterm\fP. -Deleting a \fBSCREEN\fP provides a way to do this: +Deleting a \fISCREEN\fP provides a way to do this: .bP -X/Open Curses does not say what happens to \fBWINDOW\fPs when \fBdelscreen\fP -\*(``frees storage associated with the \fBSCREEN\fP\*('' +X/Open Curses does not say what happens to \fI\%WINDOW\fPs when \fBdelscreen\fP +\*(``frees storage associated with the \fISCREEN\fP\*('' nor does the SVr4 documentation help, -adding that it should be called after \fBendwin\fP if a \fBSCREEN\fP +adding that it should be called after \fBendwin\fP if a \fISCREEN\fP is no longer needed. .bP -However, \fBWINDOW\fPs are implicitly associated with a \fBSCREEN\fP. +However, \fI\%WINDOW\fPs are implicitly associated with a \fISCREEN\fP. so that it is reasonable to expect \fBdelscreen\fP to deal with these. .bP -SVr4 curses deletes the standard \fBWINDOW\fP structures +SVr4 curses deletes the standard \fI\%WINDOW\fP structures \fBstdscr\fP and \fBcurscr\fP as well as a work area \fBnewscr\fP. SVr4 curses ignores other windows. .bP -Since version 4.0 (1996), ncurses has maintained a list of all windows -for each screen, +Since version 4.0 (1996), +\fI\%ncurses\fP has maintained a list of all windows for each screen, using that information to delete those windows when \fBdelscreen\fP is called. .bP -NetBSD copied this feature of ncurses in 2001. +NetBSD copied this feature of \fI\%ncurses\fP in 2001. PDCurses follows the SVr4 model, -deleting only the standard \fBWINDOW\fP structures. -.SS Unset TERM Variable +deleting only the standard \fI\%WINDOW\fP structures. +.SS "High-level versus Low-level" +Different implementations may disagree regarding the level of some functions. +For example, \fISCREEN\fP (returned by \fBnewterm\fP) and +\fI\%TERMINAL\fP (returned by \fBsetupterm\fP(3X)) hold file descriptors for +the output stream. +If an application switches screens using \fBset_term\fR, +or switches terminals using \fBset_curterm\fP(3X), +applications which use the output file descriptor can have different +behavior depending on which structure holds the corresponding descriptor. .PP -If the TERM variable is missing or empty, \fBinitscr\fP uses the +For example +.bP +NetBSD's \fBbaudrate\fP(3X) function uses the descriptor in \fI\%TERMINAL\fP. +\fI\%ncurses\fP and SVr4 use the descriptor in \fISCREEN\fP. +.bP +NetBSD and \fI\%ncurses\fP use the descriptor +in \fI\%TERMINAL\fP +for terminal I/O modes, +e.g., +\fBdef_shell_mode\fP(3X), +\fBdef_prog_mode\fP(3X). +SVr4 curses uses the descriptor in \fISCREEN\fP. +.SS "Unset \fITERM\fP Variable" +If the \fITERM\fP variable is missing or empty, \fBinitscr\fP uses the value \*(``unknown\*('', which normally corresponds to a terminal entry with the \fIgeneric\fP (\fIgn\fP) capability. -Generic entries are detected by \fBsetupterm\fP -(see curs_terminfo(3X)) and cannot be used for full-screen operation. -Other implementations may handle a missing/empty TERM variable differently. -.SS Signal Handlers -.PP -Quoting from X/Open Curses, section 3.1.1: +Generic entries are detected by \fBsetupterm\fP(3X) +and cannot be used for full-screen operation. +Other implementations may handle +a missing/empty \fITERM\fP variable differently. +.SS "Signal Handlers" +Quoting from X/Open Curses Issue 7, section 3.1.1: .RS 5 -.hy 0 .PP -.I Curses implementations may provide for special handling of the -.I \fBSIGINT\fP, -.I \fBSIGQUIT\fP and -.I \fBSIGTSTP\fP signals -.I if their disposition is \fBSIG_DFL\fP at the time -\fBinitscr\fI is called \fR... +Curses implementations may provide for special handling of the +\%SIGINT, +\%SIGQUIT, +and \%SIGTSTP signals if their disposition is \%SIG_DFL at the time +.I \%initscr +is called.\|.\|. .PP -.I Any special handling for these signals may remain in effect for the -.I life of the process or until the process changes the disposition of -.I the signal. +Any special handling for these signals may remain in effect for the +life of the process or until the process changes the disposition of +the signal. .PP -.I None of the Curses functions are required to be safe -.I with respect to signals \fP... +None of the Curses functions are required to be safe +with respect to signals.\|.\|. .RE -.hy .PP This implementation establishes signal handlers during initialization, e.g., \fBinitscr\fP or \fBnewterm\fP. @@ -242,18 +271,19 @@ Applications which must handle these signals should set up the corresponding handlers \fIafter\fP initializing the library: .TP 5 .B SIGINT -The handler \fIattempts\fP to cleanup the screen on exit. +The handler \fIattempts\fP to clean up the screen on exit. Although it \fIusually\fP works as expected, there are limitations: .RS 5 .bP -Walking the \fBSCREEN\fP list is unsafe, since all list management +Walking the \fISCREEN\fP list is unsafe, since all list management is done without any signal blocking. .bP On systems which have \fBREENTRANT\fP turned on, \fBset_term\fP uses functions which could deadlock or misbehave in other ways. .bP -\fBendwin\fP calls other functions, many of which use stdio or -other library functions which are clearly unsafe. +\fBendwin\fP calls other functions, +many of which use \fI\%stdio\fP(3) or other library functions which are +clearly unsafe. .RE .TP 5 .B SIGTERM @@ -264,26 +294,26 @@ purpose than \fBSIGQUIT\fP (which is used in debugging). .B SIGTSTP This handles the \fIstop\fP signal, used in job control. When resuming the process, this implementation discards pending -input with \fBflushinput\fP (see curs_util(3X)), and repaints the screen +input with \fB\%flushinp\fP(3X), and repaints the screen assuming that it has been completely altered. -It also updates the saved terminal modes with \fBdef_shell_mode\fP -(see \fBcurs_kernel\fP(3X)). +It also updates the saved terminal modes with +\fB\%def_shell_mode\fP(3X). .TP 5 .B SIGWINCH This handles the window-size changes which were ignored in the standardization efforts. The handler sets a (signal-safe) variable -which is later tested in \fBwgetch\fP (see curs_getch(3X)). +which is later tested in \fB\%wgetch\fP(3X). If \fBkeypad\fP has been enabled for the corresponding window, \fBwgetch\fP returns the key symbol \fBKEY_RESIZE\fP. At the same time, \fBwgetch\fP calls \fBresizeterm\fP to adjust the standard screen \fBstdscr\fP, and update other data such as \fBLINES\fP and \fBCOLS\fP. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_kernel\fP(3X), -\fBcurs_refresh\fP(3X), -\fBcurs_slk\fP(3X), -\fBcurs_terminfo\fP(3X), -\fBcurs_util\fP(3X), -\fBcurs_variables\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_kernel\fP(3X), +\fB\%curs_refresh\fP(3X), +\fB\%curs_slk\fP(3X), +\fB\%curs_terminfo\fP(3X), +\fB\%curs_util\fP(3X), +\fB\%curs_variables\fP(3X) diff --git a/upstream/archlinux/man3/curs_inopts.3x b/upstream/archlinux/man3/curs_inopts.3x index 39790680..d71f819e 100644 --- a/upstream/archlinux/man3/curs_inopts.3x +++ b/upstream/archlinux/man3/curs_inopts.3x @@ -1,5 +1,6 @@ +'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,354 +28,527 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inopts.3x,v 1.36 2022/02/12 20:07:29 tom Exp $ -.TH curs_inopts 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' -.na -.hy 0 +.\" $Id: curs_inopts.3x,v 1.66 2024/04/13 22:20:29 tom Exp $ +.TH curs_inopts 3X 2024-04-13 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME -\fBcbreak\fP, -\fBnocbreak\fP, -\fBecho\fP, -\fBnoecho\fP, -\fBhalfdelay\fP, -\fBintrflush\fP, -\fBkeypad\fP, -\fBmeta\fP, -\fBnl\fP, -\fBnonl\fP, -\fBnodelay\fP, -\fBnotimeout\fP, -\fBraw\fP, -\fBnoraw\fP, -\fBqiflush\fP, -\fBnoqiflush\fP, -\fBtimeout\fP, -\fBwtimeout\fP, -\fBtypeahead\fP \- \fBcurses\fP input options -.ad -.hy +\fB\%cbreak\fP, +\fB\%echo\fP, +\fB\%halfdelay\fP, +\fB\%intrflush\fP, +\fB\%is_cbreak\fP, +\fB\%is_echo\fP, +\fB\%is_nl\fP, +\fB\%is_raw\fP, +\fB\%keypad\fP, +\fB\%meta\fP, +\fB\%nl\fP, +\fB\%nocbreak\fP, +\fB\%nodelay\fP, +\fB\%noecho\fP, +\fB\%nonl\fP, +\fB\%noqiflush\fP, +\fB\%noraw\fP, +\fB\%notimeout\fP, +\fB\%qiflush\fP, +\fB\%raw\fP, +\fB\%timeout\fP, +\fB\%wtimeout\fP, +\fB\%typeahead\fP \- +get and set \fIcurses\fR terminal input options .SH SYNOPSIS -\fB#include <curses.h>\fP +.nf +\fB#include <curses.h> +.PP +\fBint cbreak(void); +\fBint nocbreak(void); +.PP +\fBint echo(void); +\fBint noecho(void); +.PP +\fBint intrflush(WINDOW *\fIwin\fP, bool \fIbf\fP); +\fBint keypad(WINDOW *\fIwin\fP, bool \fIbf\fP); +\fBint meta(WINDOW *\fIwin\fP, bool \fIbf\fP); +\fBint nodelay(WINDOW *\fIwin\fP, bool \fIbf\fP); +\fBint notimeout(WINDOW *\fIwin\fP, bool \fIbf\fP); .PP -\fBint cbreak(void);\fP -.br -\fBint nocbreak(void);\fP -.sp -\fBint echo(void);\fP -.br -\fBint noecho(void);\fP -.sp -\fBint intrflush(WINDOW *\fIwin\fB, bool \fIbf\fB);\fR -.br -\fBint keypad(WINDOW *\fIwin\fB, bool \fIbf\fB);\fR -.br -\fBint meta(WINDOW *\fIwin\fB, bool \fIbf\fB);\fR -.br -\fBint nodelay(WINDOW *\fIwin\fB, bool \fIbf\fB);\fR -.br -\fBint notimeout(WINDOW *\fIwin\fB, bool \fIbf\fB);\fR -.sp -\fBint nl(void);\fP -.br -\fBint nonl(void);\fP -.sp -\fBint raw(void);\fP -.br -\fBint noraw(void);\fP -.sp -\fBvoid qiflush(void);\fP -.br -\fBvoid noqiflush(void);\fP -.sp -\fBint halfdelay(int \fItenths\fB);\fR -.br -\fBvoid timeout(int \fIdelay\fB);\fR -.br -\fBvoid wtimeout(WINDOW *\fIwin\fB, int \fIdelay\fB);\fR -.sp -\fBint typeahead(int \fIfd\fB);\fR -.br +\fBint nl(void); +\fBint nonl(void); +.PP +\fBint raw(void); +\fBint noraw(void); +.PP +\fBvoid qiflush(void); +\fBvoid noqiflush(void); +.PP +\fBint halfdelay(int \fItenths\fP); +\fBvoid timeout(int \fIdelay\fP); +\fBvoid wtimeout(WINDOW *\fIwin\fP, int \fIdelay\fP); +.PP +\fBint typeahead(int \fIfd\fP); +.PP +\fI/* extensions */ +\fBint is_cbreak(void); +\fBint is_echo(void); +\fBint is_nl(void); +\fBint is_raw(void); +.fi .SH DESCRIPTION -The \fBncurses\fP library provides several functions which let an application -change the way input from the terminal is handled. -Some are global, applying to all windows. +.I \%ncurses +provides several functions that let an application change the way input +from the terminal is handled. +Some are global, +applying to all windows. Others apply only to a specific window. Window-specific settings are not automatically applied to new or derived windows. -An application must apply these to each window, if the same behavior -is needed. +An application must apply these to each window if the same behavior is +desired. .\" -.SS cbreak/nocbreak -Normally, the tty driver buffers typed characters until a newline or carriage +.SS "cbreak, nocbreak" +Normally, +the terminal driver buffers typed characters until a newline or carriage return is typed. -The \fBcbreak\fP routine disables line buffering and -erase/kill character-processing (interrupt and flow control characters are -unaffected), making characters typed by the user immediately available to the +The \fB\%cbreak\fP routine disables line buffering and +erase/kill character-processing +(interrupt and flow control characters are unaffected), +making characters typed by the user immediately available to the program. -The \fBnocbreak\fP routine returns the terminal to normal (cooked) +The \fB\%nocbreak\fP routine returns the terminal to normal (cooked) mode. .PP -Initially the terminal may or may not be in \fBcbreak\fP mode, as the mode is -inherited; therefore, a program should call \fBcbreak\fP or \fBnocbreak\fP -explicitly. -Most interactive programs using \fBcurses\fP set the \fBcbreak\fP -mode. -Note that \fBcbreak\fP overrides \fBraw\fP. -[See \fBcurs_getch\fP(3X) for a -discussion of how these routines interact with \fBecho\fP and \fBnoecho\fP.] +Initially the terminal may or may not be in \fB\%cbreak\fP mode, +as the mode is inherited; +therefore, +a program should call \fB\%cbreak\fP or \fB\%nocbreak\fP explicitly. +Most interactive programs using +.I curses +set the \fB\%cbreak\fP mode. +Note that \fB\%cbreak\fP overrides \fBraw\fP. +[See \fB\%curs_getch\fP(3X) for a discussion of how these routines +interact with \fBecho\fP and \fB\%noecho\fP.] .\" -.SS echo/noecho -.PP -The \fBecho\fP and \fBnoecho\fP routines control whether characters typed by -the user are echoed by \fBgetch\fP(3X) as they are typed. -Echoing by the tty -driver is always disabled, but initially \fBgetch\fP is in echo mode, so -characters typed are echoed. +.SS "echo, noecho" +The \fBecho\fP and \fB\%noecho\fP routines control whether characters +typed by the user are echoed by \fB\%getch\fP(3X) as they are typed. +Echoing by the terminal driver is always disabled, +but initially \fB\%getch\fP is in echo mode, +so characters typed are echoed. Authors of most interactive programs prefer to do -their own echoing in a controlled area of the screen, or not to echo at all, so -they disable echoing by calling \fBnoecho\fP. -[See \fBcurs_getch\fP(3X) for a -discussion of how these routines interact with \fBcbreak\fP and -\fBnocbreak\fP.] +their own echoing in a controlled area of the screen, +or not to echo at all, +so they disable echoing by calling \fB\%noecho\fP. +[See \fB\%curs_getch\fP(3X) for a +discussion of how these routines interact with \fB\%cbreak\fP and +\fB\%nocbreak\fP.] .\" .SS halfdelay -.PP -The \fBhalfdelay\fP routine is used for half-delay mode, which is similar to -\fBcbreak\fP mode in that characters typed by the user are immediately -available to the program. -However, after blocking for \fItenths\fP tenths of -seconds, \fBERR\fP is returned if nothing has been typed. -The value of \fItenths\fP -must be a number between 1 and 255. -Use \fBnocbreak\fP to leave half-delay -mode. +The \fB\%halfdelay\fP routine is used for half-delay mode, +which is similar to \fB\%cbreak\fP mode in that characters typed by the +user are immediately available to the program. +However, +after blocking for \fItenths\fP tenths of seconds, +\fBERR\fP is returned if nothing has been typed. +The value of \fItenths\fP must be a number between 1 and 255. +Use \fB\%nocbreak\fP to leave half-delay mode. .\" .SS intrflush -.PP -If the \fBintrflush\fP option is enabled (\fIbf\fP is \fBTRUE\fP), and an -interrupt key is pressed on the keyboard (interrupt, break, quit), all output in -the tty driver queue will be flushed, giving the effect of faster response to -the interrupt, but causing \fBcurses\fP to have the wrong idea of what is on -the screen. -Disabling the option (\fIbf\fP is \fBFALSE\fP) prevents the -flush. -The default for the option is inherited from the tty driver settings. -The window argument is ignored. +If the \fB\%intrflush\fP option is enabled +.RI ( bf +is +.BR TRUE ), +and an interrupt key is pressed on the keyboard +(interrupt, +break, +quit), +all output in the terminal driver queue is flushed, +giving the effect of faster response to the interrupt, +but causing +.I curses +to have the wrong idea of what is on the screen. +Disabling the option +.RI ( bf +is +.BR FALSE ), +prevents the flush. +The default for the option is inherited from the terminal driver +settings. +The +.I win +argument is ignored. .\" .SS keypad -.PP -The \fBkeypad\fP option enables the keypad of the user's terminal. +The \fB\%keypad\fP option enables the keypad of the user's terminal. If -enabled (\fIbf\fP is \fBTRUE\fP), the user can press a function key -(such as an arrow key) and \fBwgetch\fP(3X) returns a single value -representing the function key, as in \fBKEY_LEFT\fP. +enabled +.RI ( bf +is +.BR TRUE ), +the user can press a function key +(such as an arrow key) +and \fB\%wgetch\fP(3X) returns a single value representing the function +key, +as in \fB\%KEY_LEFT\fP. If disabled -(\fIbf\fP is \fBFALSE\fP), \fBcurses\fP does not treat function keys -specially and the program has to interpret the escape sequences -itself. -If the keypad in the terminal can be turned on (made to -transmit) and off (made to work locally), turning on this option -causes the terminal keypad to be turned on when \fBwgetch\fP(3X) is -called. +(\fIbf\fP is \fBFALSE\fP), +.I curses +does not treat function keys specially and the program has to interpret +the escape sequences itself. +If the keypad in the terminal can be turned on +(made to transmit) +and off +(made to work locally), +turning on this option causes the terminal keypad to be turned on when +\fB\%wgetch\fP(3X) is called. The default value for keypad is \fBFALSE\fP. .\" .SS meta -.PP -Initially, whether the terminal returns 7 or 8 significant bits on -input depends on the control mode of the tty driver [see \fBtermios\fP(3)]. -To force 8 bits to be returned, invoke \fBmeta\fP(\fIwin\fP, -\fBTRUE\fP); this is equivalent, under POSIX, to setting the CS8 flag -on the terminal. -To force 7 bits to be returned, invoke -\fBmeta\fP(\fIwin\fP, \fBFALSE\fP); this is equivalent, under POSIX, +Initially, +whether the terminal returns 7 or 8 significant bits on input depends on +the control mode of the terminal driver [see \fI\%termios\fP(3)]. +To force 8 bits to be returned, +invoke +\fBmeta\fP(\fIwin\fP, \fBTRUE\fP); +this is equivalent, +under POSIX, +to setting the CS8 flag on the terminal. +To force 7 bits to be returned, +invoke +\fBmeta\fP(\fIwin\fP, \fBFALSE\fP); +this is equivalent, +under POSIX, to setting the CS7 flag on the terminal. The window argument, -\fIwin\fP, is always ignored. -If the terminfo capabilities \fBsmm\fP -(meta_on) and \fBrmm\fP (meta_off) are defined for the terminal, -\fBsmm\fP is sent to the terminal when \fBmeta\fP(\fIwin\fP, -\fBTRUE\fP) is called and \fBrmm\fP is sent when \fBmeta\fP(\fIwin\fP, -\fBFALSE\fP) is called. +.IR win , +is always ignored. +If the terminfo capabilities +\fBsmm\fP (meta_on) and +\fBrmm\fP (meta_off) are defined for the terminal, +\fBsmm\fP is sent to the terminal when +\fBmeta\fP(\fIwin\fP, \fBTRUE\fP) +is called and \fBrmm\fP is sent when +\fBmeta\fP(\fIwin\fP, \fBFALSE\fP) is called. .\" -.SS nl/nonl -.PP -The \fBnl\fP and \fBnonl\fP routines control whether the underlying display -device translates the return key into newline on input. +.SS "nl, nonl" +The \fBnl\fP and \fBnonl\fP routines control whether the underlying +display device translates the return key into newline on input. .\" .SS nodelay -.PP -The \fBnodelay\fP option causes \fBgetch\fP to be a non-blocking call. -If no input is ready, \fBgetch\fP returns \fBERR\fP. +The \fB\%nodelay\fP option causes \fB\%getch\fP to be a non-blocking +call. +If no input is ready, +\fB\%getch\fP returns \fBERR\fP. If disabled -(\fIbf\fP is \fBFALSE\fP), \fBgetch\fP waits until a key is pressed. +.RI ( bf +is +.BR FALSE ), +\fB\%getch\fP waits until a key is pressed. .SS notimeout -.PP -When interpreting an escape sequence, \fBwgetch\fP(3X) sets a timer +When interpreting an escape sequence, +\fB\%wgetch\fP(3X) sets a timer while waiting for the next character. -If \fBnotimeout(\fIwin\fR, -\fBTRUE\fP) is called, then \fBwgetch\fP does not set a timer. -The -purpose of the timeout is to differentiate between sequences received -from a function key and those typed by a user. +If +\fB\%notimeout(\fIwin\fR, \fBTRUE\fP) +is called, +then \fB\%wgetch\fP does not set a timer. +The purpose of the timeout is to distinguish sequences produced by a +function key from those typed by a user. .\" -.SS raw/noraw -.PP -The \fBraw\fP and \fBnoraw\fP routines place the terminal into or out of raw -mode. -Raw mode is similar to \fBcbreak\fP mode, in that characters typed are -immediately passed through to the user program. -The differences are that in -raw mode, the interrupt, quit, suspend, and flow control characters are all -passed through uninterpreted, instead of generating a signal. -The behavior of -the BREAK key depends on other bits in the tty driver that are not set by -\fBcurses\fP. +.SS "raw, noraw" +The \fBraw\fP and \fB\%noraw\fP routines place the terminal into or out +of raw mode. +Raw mode is similar to \fB\%cbreak\fP mode, +in that characters typed are immediately passed through to the user +program. +The differences are that in raw mode, +the interrupt, +quit, +suspend, +and flow control characters are all +passed through uninterpreted, +instead of generating a signal. +The behavior of the BREAK key depends on other bits in the terminal +driver that are not set by +.IR curses . .\" -.SS qiflush/noqiflush -.PP -When the \fBnoqiflush\fP routine is used, normal flush of input and -output queues associated with the \fBINTR\fP, \fBQUIT\fP and -\fBSUSP\fP characters will not be done [see \fBtermios\fP(3)]. +.SS "qiflush, nqiflush" +When the \fB\%noqiflush\fP routine is used, +normal flush of input and output queues associated with the \fBINTR\fP, +\fBQUIT\fP and \fBSUSP\fP characters will not be done +[see \fB\%termios\fP(3)]. When -\fBqiflush\fP is called, the queues will be flushed when these control -characters are read. -You may want to call \fBnoqiflush\fP in a signal -handler if you want output to continue as though the interrupt -had not occurred, after the handler exits. +\fB\%qiflush\fP is called, +the queues will be flushed when these control characters are read. +You may want to call \fB\%noqiflush\fP in a signal handler if you want +output to continue as though the interrupt had not occurred, +after the handler exits. .\" -.SS timeout/wtimeout -.PP -The \fBtimeout\fP and \fBwtimeout\fP routines set blocking or +.SS "timeout, wtimeout" +The \fB\%timeout\fP and \fB\%wtimeout\fP routines set blocking or non-blocking read for a given window. If \fIdelay\fP is negative, -blocking read is used (i.e., waits indefinitely for -input). -If \fIdelay\fP is zero, then non-blocking read is used -(i.e., read returns \fBERR\fP if no input is waiting). +a blocking read is used +(i.e., +waits indefinitely for input). +If \fIdelay\fP is zero, +then a non-blocking read is used +(i.e., +.I read +returns \fBERR\fP if no input is waiting). If -\fIdelay\fP is positive, then read blocks for \fIdelay\fP -milliseconds, and returns \fBERR\fP if there is still no input. -Hence, these routines provide the same functionality as \fBnodelay\fP, +\fIdelay\fP is positive, +then +.I read +blocks for \fIdelay\fP milliseconds, +and returns \fBERR\fP if there is still no input. +Hence, +these routines provide the same functionality as \fB\%nodelay\fP, plus the additional capability of being able to block for only -\fIdelay\fP milliseconds (where \fIdelay\fP is positive). +\fIdelay\fP milliseconds +(where \fIdelay\fP is positive). .\" .SS typeahead -.PP -The \fBcurses\fP library does \*(``line-breakout optimization\*('' -by looking for typeahead periodically while updating the screen. -If input is found, and it is coming from a tty, +.I curses +does \*(``line-breakout optimization\*('' by looking for typeahead +periodically while updating the screen. +If input is found, +and it is coming from a terminal, the current update is postponed until -\fBrefresh\fP(3X) or \fBdoupdate\fP is called again. +\fB\%refresh\fP(3X) or \fB\%doupdate\fP is called again. This allows faster response to commands typed in advance. -Normally, the input FILE -pointer passed to \fBnewterm\fP, or \fBstdin\fP in the case that -\fBinitscr\fP was used, will be used to do this typeahead checking. -The \fBtypeahead\fP routine specifies that the file descriptor +Normally, +the input +.I FILE +pointer passed to \fB\%newterm\fP, +or \fBstdin\fP in the case that \fB\%initscr\fP was used, +will be used to do this typeahead checking. +The \fB\%typeahead\fP routine specifies that the file descriptor \fIfd\fP is to be used to check for typeahead instead. If \fIfd\fP is -\-1, then no typeahead checking is done. +\-1, +then no typeahead checking is done. .\" .SH RETURN VALUE -All routines that return an integer return \fBERR\fP upon failure and \fBOK\fP +All routines that return an integer return \fBERR\fP upon failure and +\fBOK\fP (SVr4 specifies only \*(``an integer value other than \fBERR\fP\*('') upon successful completion, unless otherwise noted in the preceding routine descriptions. .PP -X/Open does not define any error conditions. +X/Open Curses does not specify any error conditions. In this implementation, functions with a window parameter will return an error if it is null. -Any function will also return an error if the terminal was not initialized. +Any function will also return an error if the terminal was not +initialized. Also, -.RS +.RS 3 .TP 5 -\fBhalfdelay\fP +\fB\%halfdelay\fP returns an error if its parameter is outside the range 1..255. .RE +.SH NOTES +\fBecho\fP, +\fB\%noecho\fP, +\fB\%halfdelay\fP, +\fB\%intrflush\fP, +\fBmeta\fP, +\fBnl\fP, +\fBnonl\fP, +\fB\%nodelay\fP, +\fB\%notimeout\fP, +\fB\%noqiflush\fP, +\fB\%qiflush\fP, +\fB\%timeout\fP, +and +\fB\%wtimeout\fP +may be implemented as macros. +.PP +\fB\%noraw\fP and \fB\%nocbreak\fP follow historical practice in that +they attempt to restore normal (\*(``cooked\*('') mode +from raw and cbreak modes respectively. +Mixing \fBraw\fP/\fB\%noraw\fP and \fB\%cbreak\fP/\fB\%nocbreak\fP calls +leads to terminal driver control states that are hard to predict or +understand; +doing so is not recommended. +.SH EXTENSIONS +.I \%ncurses +provides four \*(``is_\*('' functions that may be used to detect if the +corresponding flags were set or reset. +.PP +.TS +center; +Lb Lb Lb +L L L . +Query Set Reset +_ +is_cbreak cbreak nocbreak +is_echo echo noecho +is_nl nl nonl +is_raw raw noraw +.TE +.PP +In each case, +the function returns +.TP 4 \" "-1" + 2n +1 +if the flag is set, +.TP +0 +if the flag is reset, +or +.TP +\-1 +if the library is not initialized. +.PP +They were designed for +\fB\%ncurses\fP(3X), +and are not found in SVr4 +.IR curses , +4.4BSD +.IR curses , +or any other previous +.I curses +implementation. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +Applications employing +.I \%ncurses +extensions should condition their use on the visibility of the +.B \%NCURSES_VERSION +preprocessor macro. +.PP +Except as noted in section \*(``EXTENSIONS\*('' above, +X/Open Curses, Issue 4, Version 2 describes these functions. .PP -The ncurses library obeys the XPG4 standard and the historical practice of the -AT&T curses implementations, in that the echo bit is cleared when curses +.I \%ncurses +follows X/Open Curses +and the historical practice of AT&T +.I curses +implementations, +in that the echo bit is cleared when +.I curses initializes the terminal state. -BSD curses differed from this slightly; it -left the echo bit on at initialization, but the BSD \fBraw\fP call turned it -off as a side-effect. -For best portability, set \fBecho \fPor \fBnoecho\fP explicitly -just after initialization, even if your program remains in cooked mode. +BSD +.I curses +differed from this slightly; +it left the echo bit on at initialization, +but the BSD \fBraw\fP call turned it off as a side effect. +For best portability, +set \fBecho\fP or \fB\%noecho\fP explicitly just after initialization, +even if your program remains in cooked mode. .PP -The XSI Curses standard is ambiguous on the question of whether \fBraw\fP -should disable the CRLF translations controlled by \fBnl\fP and \fBnonl\fP. -BSD curses did turn off these translations; AT&T curses (at least as late as -SVr1) did not. -We chose to do so, on the theory that a programmer requesting -raw input wants a clean (ideally 8-bit clean) connection that the operating -system will not alter. +X/Open Curses is ambiguous regarding whether \fBraw\fP should disable +the CR/LF translations controlled by \fBnl\fP and \fBnonl\fP. +BSD +.I curses +did turn off these translations; +AT&T +.I curses +(at least as late as SVr1) +did not. +.I \%ncurses +does so, +on the assumption that a programmer requesting raw input wants a clean +(ideally, +8-bit clean) +connection that the operating system will not alter. .PP -When \fBkeypad\fP is first enabled, -ncurses loads the key-definitions for the current terminal description. +When \fB\%keypad\fP is first enabled, +.I \%ncurses +loads the key definitions for the current terminal description. If the terminal description includes extended string capabilities, -e.g., from using the \fB\-x\fP option of \fBtic\fP, -then ncurses also defines keys for the capabilities whose names -begin with \*(``k\*(''. -The corresponding keycodes are generated and (depending on previous -loads of terminal descriptions) may differ from one execution of a -program to the next. -The generated keycodes are recognized by the \fBkeyname\fP function +e.g., +from using the +.B \-x +option of \fB\%tic\fP, +then +.I \%ncurses +also defines keys for the capabilities whose names begin with +\*(``k\*(''. +The corresponding keycodes are generated and +(depending on previous loads of terminal descriptions) +may differ from one execution of a program to the next. +The generated keycodes are recognized by the \fB\%keyname\fP(3X) +function (which will then return a name beginning with \*(``k\*('' denoting the -terminfo capability name rather than \*(``K\*('', used for curses key-names). -On the other hand, an application can use \fBdefine_key\fP to establish +terminfo capability name rather than \*(``K\*('', +used for +.I curses +key names). +On the other hand, +an application can use \fB\%define_key\fP(3X) to establish a specific keycode for a given string. This makes it possible for an application to check for an extended -capability's presence with \fBtigetstr\fP, +capability's presence with \fB\%tigetstr\fP, and reassign the keycode to match its own needs. .PP -Low-level applications can use \fBtigetstr\fP to obtain the definition +Low-level applications can use \fB\%tigetstr\fP to obtain the definition of any particular string capability. -Higher-level applications which use the curses \fBwgetch\fP -and similar functions to return keycodes rely upon the order in which -the strings are loaded. +Higher-level applications which use the +.I curses +\fB\%wgetch\fP and similar functions to return keycodes rely upon the +order in which the strings are loaded. If more than one key definition has the same string value, -then \fBwgetch\fP can return only one keycode. -Most curses implementations (including ncurses) +then \fB\%wgetch\fP can return only one keycode. +Most +.I curses +implementations +(including +.IR \%ncurses ) load key definitions in the order defined by the array of string capability names. The last key to be loaded determines the keycode which will be returned. -In ncurses, you may also have extended capabilities interpreted as -key definitions. +In +.IR \%ncurses , +you may also have extended capabilities interpreted as key definitions. These are loaded after the predefined keys, and if a capability's value is the same as a previously-loaded key definition, the later definition is the one used. -.SH NOTES -Note that -\fBecho\fP, -\fBnoecho\fP, -\fBhalfdelay\fP, -\fBintrflush\fP, -\fBmeta\fP, -\fBnl\fP, -\fBnonl\fP, -\fBnodelay\fP, -\fBnotimeout\fP, -\fBnoqiflush\fP, -\fBqiflush\fP, -\fBtimeout\fP, and -\fBwtimeout\fP may be macros. -.PP -The \fBnoraw\fP and \fBnocbreak\fP calls follow historical practice in that -they attempt to restore to normal (\*(``cooked\*('') mode -from raw and cbreak modes respectively. -Mixing raw/noraw and cbreak/nocbreak calls leads to tty driver -control states that are hard to predict or understand; it is not recommended. +.SH HISTORY +Formerly, +.I \%ncurses +used +.B \%nl +and +.B \%nonl +to control the conversion of newlines to carriage return/line feed +on output as well as input. +X/Open Curses documents the use of these functions only for input. +This difference arose from converting the +.I \%pcurses +source (1986), +which used +\fI\%ioctl\fP(2) calls and the +.I \%sgttyb +structure, +to +.I \%termios +(the POSIX terminal API). +In the former, +both input and output were controlled via a single option +.BR \%CRMOD , +while the latter separates these features. +Because that conversion interferes with output optimization, +.I \%ncurses +6.2 (2020) amended +.B \%nl +and +.B \%nonl +to eliminate their effect on output. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_getch\fP(3X), -\fBcurs_initscr\fP(3X), -\fBcurs_util\fP(3X), -\fBdefine_key\fP(3X), -\fBtermios\fP(3) +\fB\%curses\fP(3X), +\fB\%curs_getch\fP(3X), +\fB\%curs_initscr\fP(3X), +\fB\%curs_util\fP(3X), +\fB\%define_key\fP(3X), +\fB\%termios\fP(3) diff --git a/upstream/archlinux/man3/curs_ins_wch.3x b/upstream/archlinux/man3/curs_ins_wch.3x index 1acd4933..d2985226 100644 --- a/upstream/archlinux/man3/curs_ins_wch.3x +++ b/upstream/archlinux/man3/curs_ins_wch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2021,2022 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 2002-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,42 +27,89 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_ins_wch.3x,v 1.13 2022/02/12 20:05:11 tom Exp $ -.TH curs_ins_wch 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_ins_wch.3x,v 1.30 2024/04/20 19:18:18 tom Exp $ +.TH curs_ins_wch 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME -\fBins_wch\fP, -\fBmvins_wch\fP, -\fBmvwins_wch\fP, -\fBwins_wch\fP \- insert a complex character and rendition into a window +\fB\%ins_wch\fP, +\fB\%mvins_wch\fP, +\fB\%mvwins_wch\fP, +\fB\%wins_wch\fP \- +insert a \fIcurses\fR complex character in a window .SH SYNOPSIS -#include <curses.h> -.sp -\fBint ins_wch(const cchar_t *\fIwch\fB);\fR -.br -\fBint wins_wch(WINDOW *\fIwin\fB, const cchar_t *\fIwch\fB);\fR -.sp -\fBint mvins_wch(int \fIy\fB, int \fIx\fB, const cchar_t *\fIwch\fB);\fR -.br -\fBint mvwins_wch(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const cchar_t *\fIwch\fB);\fR +.nf +\fB#include <curses.h>\fP +.PP +\fBint ins_wch(const cchar_t *\fIwch\fP); +\fBint wins_wch(WINDOW *\fIwin\fP, const cchar_t *\fIwch\fP); +\fBint mvins_wch(int \fIy\fP, int \fIx\fP, const cchar_t *\fIwch\fP); +\fBint mvwins_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const cchar_t *\fIwch\fP); +.fi .SH DESCRIPTION -These routines, insert the complex character \fIwch\fP with rendition -before the character under the cursor. -All characters to the right of the cursor are moved one space to the right, -with the possibility of the rightmost character on the line being lost. -The insertion operation does not change the cursor position. -.SH RETURN VALUE -If successful, these functions return \fBOK\fP. -If not, they return \fBERR\fP. +These functions insert the +.I curses +complex character +.I wch +at the cursor in the specified window +.I win +(or +.BR \%stdscr ). +The character previously at the cursor and any to its right move one +cell to the right; +the rightmost character on the line is discarded. +The cursor does not advance. +.SH "RETURN VALUE" +These functions return \fBOK\fP on success and \fBERR\fP on failure. +.PP +Functions taking a +.I \%WINDOW +pointer argument fail if the pointer is +.BR NULL . +.PP +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. +.SH NOTES +A terminal's +.B \%insert_character +.RB ( ich1 ) +capability +is not necessarily employed. +.PP +\fB\%ins_wch\fP, +\fB\%mvins_wch\fP, +and +\fB\%mvwins_wch\fP +may be implemented as macros. +.SH PORTABILITY +X/Open Curses, +Issue 4 describes these functions. +.PP +SVr4 describes successful return values only as +\*(``an integer value other than \fBERR\fP\*(''. +.SH HISTORY +SVr4 (1989) implemented these functions under the names +.BR inswch , +.BR winswch , +.BR mvinswch , +and +.BR mvwinswch . +.SH "SEE ALSO" +\fB\%curs_insch\fP(3X) describes comparable functions in the +non-wide-character +.I curses +configuration. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. -.SH ERRORS -No errors are defined. -.SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_insch\fP(3X). +\fB\%curses\fP(3X), +\fB\%terminfo\fP(5) diff --git a/upstream/archlinux/man3/curs_ins_wstr.3x b/upstream/archlinux/man3/curs_ins_wstr.3x index 57199710..3fef8ce7 100644 --- a/upstream/archlinux/man3/curs_ins_wstr.3x +++ b/upstream/archlinux/man3/curs_ins_wstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2021,2022 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 2002-2012,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,85 +27,102 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_ins_wstr.3x,v 1.14 2022/02/12 20:05:11 tom Exp $ -.TH curs_ins_wstr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' -.na -.hy 0 +.\" $Id: curs_ins_wstr.3x,v 1.38 2024/04/20 21:23:08 tom Exp $ +.TH curs_ins_wstr 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. .SH NAME -\fBins_wstr\fP, -\fBins_nwstr\fP, -\fBwins_wstr\fP, -\fBwins_nwstr\fP, -\fBmvins_wstr\fP, -\fBmvins_nwstr\fP, -\fBmvwins_wstr\fP, -\fBmvwins_nwstr\fP \- insert a wide-character string into a curses window -.ad -.hy +\fB\%ins_wstr\fP, +\fB\%ins_nwstr\fP, +\fB\%wins_wstr\fP, +\fB\%wins_nwstr\fP, +\fB\%mvins_wstr\fP, +\fB\%mvins_nwstr\fP, +\fB\%mvwins_wstr\fP, +\fB\%mvwins_nwstr\fP \- +insert a wide-character string in a \fIcurses\fR window .SH SYNOPSIS .nf -\fB#include <curses.h>\fP -.sp -\fBint ins_wstr(const wchar_t *\fIwstr);\fR -.br -\fBint ins_nwstr(const wchar_t *\fIwstr\fB, int \fIn\fB);\fR -.br -\fBint wins_wstr(WINDOW *\fIwin\fB, const wchar_t *\fIwstr\fB);\fR -.br -\fBint wins_nwstr(WINDOW *\fIwin\fB, const wchar_t *\fIwstr\fB, int \fIn\fB);\fR -.sp -\fBint mvins_wstr(int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB);\fR -.br -\fBint mvins_nwstr(int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB, int \fIn\fB);\fR -.br -\fBint mvwins_wstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB);\fR -.br -\fBint mvwins_nwstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB, int \fIn\fB);\fR +\fB#include <curses.h> +.PP +\fBint ins_wstr(const wchar_t *\fIwstr\fP); +\fBint ins_nwstr(const wchar_t *\fIwstr\fP, int \fIn\fP); +\fBint wins_wstr(WINDOW *\fIwin\fP, const wchar_t *\fIwstr\fP); +\fBint wins_nwstr(WINDOW *\fIwin\fP, const wchar_t *\fIwstr\fP, int \fIn\fP); +.PP +\fBint mvins_wstr(int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP); +\fBint mvins_nwstr(int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP, int \fIn\fP); +\fBint mvwins_wstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP); +\fBint mvwins_nwstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP, int \fIn\fP); .fi .SH DESCRIPTION These routines insert a \fBwchar_t\fP character string (as many characters as will fit on the line) -before the character under the cursor. +before the character under the cursor, +as if calling \fBwins_wch\fP(3X). All characters to the right of the cursor are shifted right, with the possibility of the rightmost characters on the line being lost. No wrapping is performed. +.PP The cursor position does not change (after moving to \fIy\fP, \fIx\fP, if specified). -The four routines with \fIn\fP as the last argument +.PP +The functions with \fIn\fP as the last argument insert a leading substring of at most \fIn\fP \fBwchar_t\fP characters. -If \fIn\fP is less than 1, the entire string is inserted. +If \fIn\fP is less than zero, the entire string is inserted +(stopping on a L'\e0' character). .PP -If a character in \fIwstr\fP is a tab, newline, carriage return or -backspace, the cursor is moved appropriately within the window. -A newline also does a \fBclrtoeol\fP before moving. -Tabs are considered to be at every eighth column. -If a character in \fIwstr\fP is another control character, -it is drawn in the \fB^\fIX\fR notation. -Calling \fBwin_wch\fP after adding a control character -(and moving to it, if necessary) -does not return the control character, -but instead returns a character in the ^-representation -of the control character. +Special characters are handled as in \fBwadd_wch\fP(3X). +.SH RETURN VALUE +All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success. +.PP +X/Open Curses does not specify any error conditions. +This implementation returns an error +.bP +if the \fIwin\fP parameter is null or +.bP +if the \fIwstr\fP parameter is null or +.bP +if the \fBwins_wch\fP function returns an error. +.PP +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES -Note that all but wins_nwstr may be macros. +All but \fBwins_nwstr\fP may be macros. .PP -If the first character in the string is a nonspacing character, these +If the first character in the string is a non-spacing character, these functions will fail. -XSI does not define what will happen if a nonspacing character follows -a control character. -.SH RETURN VALUE -Upon successful completion, these functions return \fBOK\fP. -Otherwise, they return \fBERR\fP. +X/Open Curses does not define what will happen +if a non-spacing character follows a control character. +.SH PORTABILITY +These functions are described in X/Open Curses, Issue 4, +which adds \fI\%const\fP qualifiers to the arguments. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +X/Open states that the entire string is inserted if \fIn\fP is less than 1. +This is probably an error, +because it is inconsistent with other functions, +and differs from the X/Open implementation on Solaris. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_insstr\fP(3X), -\fBcurs_in_wch\fP(3X), -\fBcurs_ins_wch\fP(3X). +\fB\%curs_insstr\fP(3X) describes comparable functions of the +.I \%ncurses +library in its non-wide-character configuration. +.PP +\fB\%curses\fP(3X), +\fB\%curs_ins_wch\fP(3X), +\fB\%curs_in_wch\fP(3X) diff --git a/upstream/archlinux/man3/curs_insch.3x b/upstream/archlinux/man3/curs_insch.3x index 7534c93e..5b1e8ad6 100644 --- a/upstream/archlinux/man3/curs_insch.3x +++ b/upstream/archlinux/man3/curs_insch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,53 +27,89 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_insch.3x,v 1.22 2022/02/12 20:05:11 tom Exp $ -.TH curs_insch 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_insch.3x,v 1.40 2024/04/20 19:03:47 tom Exp $ +.TH curs_insch 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME -\fBinsch\fP, -\fBwinsch\fP, -\fBmvinsch\fP, -\fBmvwinsch\fP \- insert a character before cursor in a \fBcurses\fP window +\fB\%insch\fP, +\fB\%winsch\fP, +\fB\%mvinsch\fP, +\fB\%mvwinsch\fP \- +insert a \fIcurses\fP character in a window .SH SYNOPSIS +.nf \fB#include <curses.h>\fP -.sp -\fBint insch(chtype \fIch\fB);\fR -.br -\fBint winsch(WINDOW *\fIwin\fB, chtype \fIch\fB);\fR -.sp -\fBint mvinsch(int \fIy\fB, int \fIx\fB, chtype \fIch\fB);\fR -.br -\fBint mvwinsch(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, chtype \fIch\fB);\fR -.br +.PP +\fBint insch(chtype \fIch\fP); +\fBint winsch(WINDOW *\fIwin\fP, chtype \fIch\fP); +\fBint mvinsch(int \fIy\fP, int \fIx\fP, chtype \fIch\fP); +\fBint mvwinsch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, chtype \fIch\fP); +.fi .SH DESCRIPTION -These routines insert the character \fIch\fP before the character under the -cursor. -All characters to the right of the cursor are moved one space to the -right, with the possibility of the rightmost character on the line being lost. -The insertion operation does not change the cursor position. -.SH RETURN VALUE -All routines that return an integer return \fBERR\fP upon failure and \fBOK\fP -(SVr4 specifies only "an integer value other than \fBERR\fP") -upon successful completion, -unless otherwise noted in the preceding routine descriptions. +These functions insert the +.I curses +character +.I ch +at the cursor in the specified window +.I win +(or +.BR \%stdscr ). +The character previously at the cursor and any to its right move one +cell to the right; +the rightmost character on the line is discarded. +The cursor does not advance. +.SH "RETURN VALUE" +These functions return +.B OK +on success and +.B ERR +on failure. +.PP +Functions taking a +.I \%WINDOW +pointer argument fail if the pointer is +.BR NULL . .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES -These routines do not necessarily imply use of a hardware insert character -feature. +.BR \%insch , +.BR \%mvinsch , +and +.B \%mvwinsch +may be implemented as macros. .PP -Note that \fBinsch\fP, \fBmvinsch\fP, and \fBmvwinsch\fP may be macros. +A terminal's +.B \%insert_character +.RB ( ich1 ) +capability +is not necessarily employed. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. -.SH SEE ALSO -\fBcurses\fP(3X). +X/Open Curses, +Issue 4 describes these functions. +.PP +SVr4 +.I curses +describes a successful return value only as +\*(``an integer value other than +.BR ERR \*(''. +.SH "SEE ALSO" +\fB\%curs_ins_wch\fP(3X) describes comparable functions in the +wide-character +.I curses +configuration. .PP -Comparable functions in the wide-character (ncursesw) library are -described in -\fBcurs_ins_wch\fP(3X). +\fB\%curses\fP(3X), +\fB\%terminfo\fP(5) diff --git a/upstream/archlinux/man3/curs_insstr.3x b/upstream/archlinux/man3/curs_insstr.3x index 44bc6fd2..1927f55a 100644 --- a/upstream/archlinux/man3/curs_insstr.3x +++ b/upstream/archlinux/man3/curs_insstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2021,2022 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,79 +27,98 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_insstr.3x,v 1.29 2022/02/12 20:05:11 tom Exp $ -.TH curs_insstr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_insstr.3x,v 1.51 2024/04/20 21:20:07 tom Exp $ +.TH curs_insstr 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. .SH NAME -\fBinsstr\fP, -\fBinsnstr\fP, -\fBwinsstr\fP, -\fBwinsnstr\fP, -\fBmvinsstr\fP, -\fBmvinsnstr\fP, -\fBmvwinsstr\fP, -\fBmvwinsnstr\fP \- insert string before cursor in a \fBcurses\fP window +\fB\%insstr\fP, +\fB\%insnstr\fP, +\fB\%winsstr\fP, +\fB\%winsnstr\fP, +\fB\%mvinsstr\fP, +\fB\%mvinsnstr\fP, +\fB\%mvwinsstr\fP, +\fB\%mvwinsnstr\fP \- +insert a string in a \fIcurses\fR window .SH SYNOPSIS -\fB#include <curses.h>\fP -.br -\fBint insstr(const char *\fIstr\fB);\fR -.br -\fBint insnstr(const char *\fIstr\fB, int \fIn\fB);\fR -.br -\fBint winsstr(WINDOW *\fIwin\fB, const char *\fIstr\fB);\fR -.br -\fBint winsnstr(WINDOW *\fIwin\fB, const char *\fIstr\fB, int \fIn\fB);\fR -.sp -\fBint mvinsstr(int \fIy\fB, int \fIx\fB, const char *\fIstr\fB);\fR -.br -\fBint mvinsnstr(int \fIy\fB, int \fIx\fB, const char *\fIstr\fB, int \fIn\fB);\fR -.br -\fBint mvwinsstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char *\fIstr\fB);\fR -.br -\fBint mvwinsnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char *\fIstr\fB, int \fIn\fB);\fR -.br +.nf +\fB#include <curses.h> +\fBint insstr(const char *\fIstr\fP); +\fBint insnstr(const char *\fIstr\fP, int \fIn\fP); +\fBint winsstr(WINDOW *\fIwin\fP, const char *\fIstr\fP); +\fBint winsnstr(WINDOW *\fIwin\fP, const char *\fIstr\fP, int \fIn\fP); +.PP +\fBint mvinsstr(int \fIy\fP, int \fIx\fP, const char *\fIstr\fP); +\fBint mvinsnstr(int \fIy\fP, int \fIx\fP, const char *\fIstr\fP, int \fIn\fP); +\fBint mvwinsstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIstr\fP); +\fBint mvwinsnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIstr\fP, int \fIn\fP); +.fi .SH DESCRIPTION These routines insert a character string (as many characters as will fit on the line) -before the character under the cursor. -All characters to the right of the cursor are shifted right +before the character under the cursor, +as if calling \fBwinsch\fP(3X). +All characters to the right of the cursor are shifted right, with the possibility of the rightmost characters on the line being lost. +No wrapping is performed. +.PP The cursor position does not change (after moving to \fIy\fP, \fIx\fP, if specified). +.PP The functions with \fIn\fP as the last argument insert a leading substring of at most \fIn\fP characters. -If \fIn\fP<=0, then the entire string is inserted. +If \fIn\fP is less than zero, the entire string is inserted +(stopping on a NUL character). .PP -Special characters are handled as in \fBaddch\fP. +Special characters are handled as in \fBwaddch\fP(3X). .SH RETURN VALUE -All routines that return an integer return \fBERR\fP upon failure and \fBOK\fP -(SVr4 specifies only "an integer value other than \fBERR\fP") -upon successful completion, -unless otherwise noted in the preceding routine descriptions. +All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success. .PP -X/Open defines no error conditions. -In this implementation, -if the window parameter is null or the str parameter is null, -an error is returned. +X/Open Curses does not specify any error conditions. +This implementation returns an error +.bP +if the \fIwin\fP parameter is null or +.bP +if the \fIstr\fP parameter is null or +.bP +the \fBwinsch\fP(3X) function returns an error. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES -Note that all but \fBwinsnstr\fP may be macros. +All but \fBwinsnstr\fP may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4, which adds -const qualifiers to the arguments. -.LP +These functions are described in X/Open Curses, Issue 4, +which adds \fI\%const\fP qualifiers to the arguments. +.PP The Single Unix Specification, Version 2 states that \fBinsnstr\fP and \fBwinsnstr\fP perform wrapping. This is probably an error, since it makes this group of functions inconsistent. Also, no implementation of curses documents this inconsistency. +.PP +X/Open states that the entire string is inserted if \fIn\fP is less than 1. +This is probably an error, +because it is inconsistent with other functions, +and differs from the SVr4 and X/Open implementations on Solaris. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_util\fP(3X), -\fBcurs_clear\fP(3X), -\fBcurs_inch\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_inch\fP(3X), +\fB\%curs_ins_wstr\fP(3X), +\fB\%curs_util\fP(3X) diff --git a/upstream/archlinux/man3/curs_instr.3x b/upstream/archlinux/man3/curs_instr.3x index 4ab3e540..896f4251 100644 --- a/upstream/archlinux/man3/curs_instr.3x +++ b/upstream/archlinux/man3/curs_instr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,73 +27,104 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_instr.3x,v 1.25 2022/02/12 20:05:11 tom Exp $ -.TH curs_instr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_instr.3x,v 1.51 2024/04/20 21:24:19 tom Exp $ +.TH curs_instr 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBinstr\fP, -\fBinnstr\fP, -\fBwinstr\fP, -\fBwinnstr\fP, -\fBmvinstr\fP, -\fBmvinnstr\fP, -\fBmvwinstr\fP, -\fBmvwinnstr\fP \- get a string of characters from a \fBcurses\fP window +\fB\%instr\fP, +\fB\%innstr\fP, +\fB\%winstr\fP, +\fB\%winnstr\fP, +\fB\%mvinstr\fP, +\fB\%mvinnstr\fP, +\fB\%mvwinstr\fP, +\fB\%mvwinnstr\fP \- +get a string from a \fIcurses\fR window .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint instr(char *\fIstr\fB);\fR -.br -\fBint innstr(char *\fIstr\fB, int \fIn\fB);\fR -.br -\fBint winstr(WINDOW *\fIwin\fB, char *\fIstr\fB);\fR -.br -\fBint winnstr(WINDOW *\fIwin\fB, char *\fIstr\fB, int \fIn\fB);\fR -.sp -\fBint mvinstr(int \fIy\fB, int \fIx\fB, char *\fIstr\fB);\fR -.br -\fBint mvinnstr(int \fIy\fB, int \fIx\fB, char *\fIstr\fB, int \fIn\fB);\fR -.br -\fBint mvwinstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, char *\fIstr\fB);\fR -.br -\fBint mvwinnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, char *\fIstr\fB, int \fIn\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBint instr(char *\fIstr\fP); +\fBint innstr(char *\fIstr\fP, int \fIn\fP); +\fBint winstr(WINDOW *\fIwin\fP, char *\fIstr\fP); +\fBint winnstr(WINDOW *\fIwin\fP, char *\fIstr\fP, int \fIn\fP); +.PP +\fBint mvinstr(int \fIy\fP, int \fIx\fP, char *\fIstr\fP); +\fBint mvinnstr(int \fIy\fP, int \fIx\fP, char *\fIstr\fP, int \fIn\fP); +\fBint mvwinstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, char *\fIstr\fP); +\fBint mvwinnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, char *\fIstr\fP, int \fIn\fP); +.fi .SH DESCRIPTION -These routines return a string of characters in \fIstr\fP, extracted starting -at the current cursor position in the named window. +These routines return a string of characters in \fIstr\fP, +starting at the current cursor position in the named window. Attributes are stripped from the characters. -The four -functions with \fIn\fP as the last argument return a leading substring at most -\fIn\fP characters long (exclusive of the trailing NUL). +.PP +The four functions with \fIn\fP as the last argument return +a leading substring at most \fIn\fP characters long +(exclusive of the trailing NUL). +Transfer stops at the end of the current line, or when \fIn\fP characters have +been stored at the location referenced by \fIstr\fP. .SH RETURN VALUE All of the functions return \fBERR\fP upon failure, or the number of characters actually read into the string. .PP X/Open Curses defines no error conditions. -In this implementation: +This implementation returns an error .bP -If the \fIwin\fP parameter is null, an error is returned, +if the \fIwin\fP parameter is null or .bP -If the \fIchstr\fP parameter is null, an error is returned, +if the \fIchstr\fP parameter is null. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES -Note that all routines except \fBwinnstr\fP may be macros. +All routines except \fBwinnstr\fP may be macros. +.PP +Reading a line that overflows the array pointed to by +\fIstr\fP +with +\fBinstr\fP, +\fBmvinstr\fP, +\fBmvwinstr\fP +or +\fBwinstr\fP +causes undefined results. +Therefore, the use of +\fBinnstr\fP, +\fBmvinnstr\fP, +\fBmvwinnstr\fP, or +\fBwinnstr\fP +is recommended. .SH PORTABILITY SVr4 does not document whether a length limit includes or excludes the trailing NUL. .PP -The ncurses library extends the XSI description by allowing a negative -value for \fIn\fP. +The \fI\%ncurses\fP library extends the X/Open Curses description by allowing a +negative value for \fIn\fP. In this case, the functions return the string ending at the right margin. .SH SEE ALSO -\fBcurses\fP(3X). +\fB\%curs_ins_wstr\fP(3X) describes comparable functions of the +.I \%ncurses +library in its wide-character configuration +.RI ( \%ncursesw ). +.PP +\fB\%curses\fP(3X), +\fB\%curs_inch\fP(3X), +\fB\%curs_inchstr\fP(3X) diff --git a/upstream/archlinux/man3/curs_inwstr.3x b/upstream/archlinux/man3/curs_inwstr.3x index 3b02feea..f98da461 100644 --- a/upstream/archlinux/man3/curs_inwstr.3x +++ b/upstream/archlinux/man3/curs_inwstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 2002-2012,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,45 +27,49 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inwstr.3x,v 1.17 2022/02/12 20:05:11 tom Exp $ -.TH curs_inwstr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_inwstr.3x,v 1.41 2024/04/20 21:20:07 tom Exp $ +.TH curs_inwstr 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. .SH NAME -\fBinwstr\fP, -\fBinnwstr\fP, -\fBwinwstr\fP, -\fBwinnwstr\fP, -\fBmvinwstr\fP, -\fBmvinnwstr\fP, -\fBmvwinwstr\fP, -\fBmvwinnwstr\fP \- get a string of \fBwchar_t\fP characters from a curses window +\fB\%inwstr\fP, +\fB\%innwstr\fP, +\fB\%winwstr\fP, +\fB\%winnwstr\fP, +\fB\%mvinwstr\fP, +\fB\%mvinnwstr\fP, +\fB\%mvwinwstr\fP, +\fB\%mvwinnwstr\fP \- +get a wide-character string from a \fIcurses\fR window .SH SYNOPSIS .nf -\fB#include <curses.h> \fP -.sp -\fBint inwstr(\fBwchar_t *\fIwstr\fB);\fR -.br -\fBint innwstr(\fBwchar_t *\fIwstr\fB, int \fIn\fB);\fR -.br -\fBint winwstr(\fBWINDOW *\fIwin\fB, wchar_t *\fIwstr\fB);\fR -.br -\fBint winnwstr(\fBWINDOW *\fIwin\fB, wchar_t *\fIwstr\fB, int \fIn\fB);\fR -.sp -\fBint mvinwstr(\fBint \fIy\fB, int \fIx\fB, wchar_t *\fIwstr\fB);\fR -.br -\fBint mvinnwstr(\fBint \fIy\fB, int \fIx\fB, wchar_t *\fIwstr\fB, int \fIn\fB);\fR -.br -\fBint mvwinwstr(\fBWINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wchar_t *\fIwstr\fB);\fR -.br -\fBint mvwinnwstr(\fBWINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wchar_t *\fIwstr\fB, int \fIn\fB);\fR +\fB#include <curses.h> +.PP +\fBint inwstr(wchar_t *\fIwstr\fP); +\fBint innwstr(wchar_t *\fIwstr\fP, int \fIn\fP); +\fBint winwstr(WINDOW *\fIwin\fP, wchar_t *\fIwstr\fP); +\fBint winnwstr(WINDOW *\fIwin\fP, wchar_t *\fIwstr\fP, int \fIn\fP); +.PP +\fBint mvinwstr(int \fIy\fP, int \fIx\fP, wchar_t *\fIwstr\fP); +\fBint mvinnwstr(int \fIy\fP, int \fIx\fP, wchar_t *\fIwstr\fP, int \fIn\fP); +\fBint mvwinwstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, wchar_t *\fIwstr\fP); +\fBint mvwinnwstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, wchar_t *\fIwstr\fP, int \fIn\fP); .fi .SH DESCRIPTION -.PP These routines return a string of \fBwchar_t\fP wide characters in \fIwstr\fP, -extracted starting at the current cursor position in the named window. +starting at the current cursor position in the named window. .PP The four functions with \fIn\fP as the last argument return a leading substring at most \fIn\fP characters long @@ -75,17 +79,6 @@ been stored at the location referenced by \fIwstr\fP. .PP If the size \fIn\fP is not large enough to store a complete complex character, an error is generated. -.SH NOTES -.PP -All routines except -\fBwinnwstr\fP -may be macros. -.PP -Each cell in the window holds a complex character (i.e., base- -and combining-characters) together with attributes and color. -These functions store only the wide characters, -ignoring attributes and color. -Use \fBin_wchstr\fP to return the complex characters from a window. .SH RETURN VALUE All routines return \fBERR\fP @@ -97,10 +90,52 @@ routines return routines return the number of characters read into the string. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +X/Open defines no error conditions. +This implementation returns an error +.bP +if the \fIwin\fP parameter is null or +.bP +if the \fIwstr\fP parameter is null, or +.bP +if no characters could be read. +.PP +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. +.SH NOTES +All routines except +\fBwinnwstr\fP +may be macros. +.PP +Each cell in the window holds a complex character +(a spacing character and zero or more non-spacing characters) +together with attributes and color. +These functions store only the wide characters, +ignoring attributes and color. +Use \fBin_wchstr\fP to return the complex characters from a window. +.PP +Reading a line that overflows the array pointed to by +\fIwstr\fP +with +\fBinwstr\fP, +\fBmvinwstr\fP, +\fBmvwinwstr\fP +or +\fBwinwstr\fP +causes undefined results. +Therefore, the use of +\fBinnwstr\fP, +\fBmvinnwstr\fP, +\fBmvwinnwstr\fP, or +\fBwinnwstr\fP +is recommended. +.SH PORTABILITY +These functions are described in X/Open Curses, Issue 4. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_instr\fP(3X), -\fBcurs_in_wchstr\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_inch\fP(3X), +\fB\%curs_inchstr\fP(3X), +\fB\%curs_instr\fP(3X), +\fB\%curs_in_wchstr\fP(3X) diff --git a/upstream/archlinux/man3/curs_kernel.3x b/upstream/archlinux/man3/curs_kernel.3x index 73dec7b1..29c35f7a 100644 --- a/upstream/archlinux/man3/curs_kernel.3x +++ b/upstream/archlinux/man3/curs_kernel.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,87 +27,83 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_kernel.3x,v 1.32 2022/02/12 20:05:11 tom Exp $ -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_kernel.3x,v 1.61 2024/04/20 21:24:19 tom Exp $ +.TH curs_kernel 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.TH curs_kernel 3X "" -.na -.hy 0 .SH NAME -\fBdef_prog_mode\fP, -\fBdef_shell_mode\fP, -\fBreset_prog_mode\fP, -\fBreset_shell_mode\fP, -\fBresetty\fP, -\fBsavetty\fP, -\fBgetsyx\fP, -\fBsetsyx\fP, -\fBripoffline\fP, -\fBcurs_set\fP, -\fBnapms\fP \- low-level \fBcurses\fP routines -.ad -.hy +\fB\%def_prog_mode\fP, +\fB\%def_shell_mode\fP, +\fB\%reset_prog_mode\fP, +\fB\%reset_shell_mode\fP, +\fB\%resetty\fP, +\fB\%savetty\fP, +\fB\%getsyx\fP, +\fB\%setsyx\fP, +\fB\%ripoffline\fP, +\fB\%curs_set\fP, +\fB\%napms\fP \- +low-level \fIcurses\fR routines .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint def_prog_mode(void);\fP -.br -\fBint def_shell_mode(void);\fP -.sp -\fBint reset_prog_mode(void);\fP -.br -\fBint reset_shell_mode(void);\fP -.sp -\fBint resetty(void);\fP -.br -\fBint savetty(void);\fP -.sp -\fBvoid getsyx(int \fIy\fB, int \fIx\fB);\fR -.br -\fBvoid setsyx(int \fIy\fB, int \fIx\fB);\fR -.sp -\fBint ripoffline(int \fIline\fB, int (*\fIinit\fB)(WINDOW *, int));\fR -.br -\fBint curs_set(int \fIvisibility\fB);\fR -.br -\fBint napms(int \fIms\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBint def_prog_mode(void); +\fBint def_shell_mode(void); +.PP +\fBint reset_prog_mode(void); +\fBint reset_shell_mode(void); +.PP +\fBint resetty(void); +\fBint savetty(void); +.PP +\fBvoid getsyx(int \fIy\fP, int \fIx\fP); +\fBvoid setsyx(int \fIy\fP, int \fIx\fP); +.PP +\fBint ripoffline(int \fIline\fP, int (*\fIinit\fP)(WINDOW *, int)); +\fBint curs_set(int \fIvisibility\fP); +\fBint napms(int \fIms\fP); +.fi .SH DESCRIPTION The following routines give low-level access to various \fBcurses\fP capabilities. These routines typically are used inside library routines. -.SS def_prog_mode, def_shell_mode -.PP +.SS "def_prog_mode, def_shell_mode" The \fBdef_prog_mode\fP and \fBdef_shell_mode\fP routines save the -current terminal modes as the \*(``program\*('' (in \fBcurses\fP) or \*(``shell\*('' +current terminal modes as the \*(``program\*('' +(in \fBcurses\fP) or \*(``shell\*('' (not in \fBcurses\fP) state for use by the \fBreset_prog_mode\fP and \fBreset_shell_mode\fP routines. This is done automatically by \fBinitscr\fP. There is one such save area for each screen context allocated by \fBnewterm\fP. -.SS reset_prog_mode, reset_shell_mode -.PP +.SS "reset_prog_mode, reset_shell_mode" The \fBreset_prog_mode\fP and \fBreset_shell_mode\fP routines restore the terminal to \*(``program\*('' (in \fBcurses\fP) or \*(``shell\*('' (out of \fBcurses\fP) state. These are done automatically by \fBendwin\fP(3X) and, after an \fBendwin\fP, by \fBdoupdate\fP, so they normally are not called. -.SS resetty, savetty -.PP +.SS "resetty, savetty" The \fBresetty\fP and \fBsavetty\fP routines save and restore the state of the terminal modes. \fBsavetty\fP saves the current state in a buffer and \fBresetty\fP restores the state to what it was at the last call to \fBsavetty\fP. .SS getsyx -.PP The \fBgetsyx\fP routine returns the current coordinates of the \fIvirtual screen\fP cursor in \fIy\fP and \fIx\fP. If \fBleaveok\fP is currently \fBTRUE\fP, then @@ -120,7 +116,6 @@ therefore, \fIy\fP and \fIx\fP should be used only as arguments for Few applications will use this feature, most use \fBgetyx\fP instead. .SS setsyx -.PP The \fBsetsyx\fP routine sets the \fIvirtual screen\fP cursor to \fIy\fP, \fIx\fP. If \fIy\fP and \fIx\fP are both \fB\-1\fP, then @@ -137,11 +132,10 @@ at the beginning, do its manipulation of its own windows, do a Few applications will use this feature, most use \fBwmove\fP instead. .SS ripoffline -.PP -The \fBripoffline\fP routine provides access to the same facility that -\fBslk_init\fP [see \fBcurs_slk\fP(3X)] uses to reduce the size of the -screen. -\fBripoffline\fP must be called before \fBinitscr\fP or +.B \%ripoffline +provides access to the same facility that \fB\%slk_init\fP(3X) uses to +reduce the size of the screen. +\fB\%ripoffline\fP must be called before \fBinitscr\fP or \fBnewterm\fP is called, to prepare these initial actions: .bP If \fIline\fP is positive, a line is removed from the top of \fBstdscr\fP. @@ -165,7 +159,6 @@ It is allowable to call \fBwnoutrefresh\fP during the initialization routine. \fBripoffline\fP can be called up to five times before calling \fBinitscr\fP or \fBnewterm\fP. .SS curs_set -.PP The \fBcurs_set\fP routine sets the cursor state to invisible, normal, or very visible for \fBvisibility\fP equal to \fB0\fP, \fB1\fP, or \fB2\fP respectively. @@ -173,8 +166,15 @@ If the terminal supports the \fIvisibility\fP requested, the previous \fIcursor\fP state is returned; otherwise, \fBERR\fP is returned. .SS napms -.PP -The \fBnapms\fP routine is used to sleep for \fIms\fP milliseconds. +.B \%napms +sleeps for +.I ms +milliseconds. +If +.I ms +exceeds 30,000 +(thirty seconds), +it is capped at that value. .SH RETURN VALUE Except for \fBcurs_set\fP, these routines always return \fBOK\fP. .PP @@ -185,18 +185,14 @@ requested \fIvisibility\fP is not supported. X/Open defines no error conditions. In this implementation .TP 5 -.na -.hy 0 \fBdef_prog_mode\fP, \fBdef_shell_mode\fP, \fBreset_prog_mode\fP, \fBreset_shell_mode\fP -.hy -.ad return an error if the terminal was not initialized, or if the I/O call to obtain the terminal settings fails. .TP 5 \fBripoffline\fP returns an error if the maximum number of ripped-off lines -exceeds the maximum (NRIPS = 5). +exceeds the maximum (5). .SH NOTES Note that \fBgetsyx\fP is a macro, so \fB&\fP is not necessary before the variables \fIy\fP and \fIx\fP. @@ -206,26 +202,30 @@ of \fBcurs_set\fP \*(``is currently incorrect\*(''. This implementation gets it right, but it may be unwise to count on the correctness of the return value anywhere else. .PP -Both ncurses and SVr4 will call \fBcurs_set\fP in \fBendwin\fP +Both \fI\%ncurses\fP and SVr4 will call \fBcurs_set\fP in \fBendwin\fP if \fBcurs_set\fP has been called to make the cursor other than normal, i.e., either invisible or very visible. -There is no way for ncurses to determine the initial cursor state to -restore that. +There is no way for \fI\%ncurses\fP to determine the initial cursor +state to restore that. .SH PORTABILITY The \fIvirtual screen\fP functions \fBsetsyx\fP and \fBgetsyx\fP -are not described in the XSI Curses standard, Issue 4. -All other functions are as described in XSI Curses. +are not described in X/Open Curses, Issue 4. +All other functions are as described in X/Open Curses. .PP The SVr4 documentation describes \fBsetsyx\fP and \fBgetsyx\fP as having return type int. This is misleading, as they are macros with no documented semantics for the return value. +.PP +If interrupted, \fI\%ncurses\fP restarts \fBnapms\fP. +That, and the limitation to 30 seconds, +are different from other implementations. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_initscr\fP(3X), -\fBcurs_outopts\fP(3X), -\fBcurs_refresh\fP(3X), -\fBcurs_scr_dump\fP(3X), -\fBcurs_slk\fP(3X), -\fBcurs_variables\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_initscr\fP(3X), +\fB\%curs_outopts\fP(3X), +\fB\%curs_refresh\fP(3X), +\fB\%curs_scr_dump\fP(3X), +\fB\%curs_slk\fP(3X), +\fB\%curs_variables\fP(3X) diff --git a/upstream/archlinux/man3/curs_legacy.3x b/upstream/archlinux/man3/curs_legacy.3x index 02e2c828..75428f79 100644 --- a/upstream/archlinux/man3/curs_legacy.3x +++ b/upstream/archlinux/man3/curs_legacy.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2020,2022 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 2007-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,82 +27,112 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_legacy.3x,v 1.13 2022/02/12 20:05:11 tom Exp $ +.\" $Id: curs_legacy.3x,v 1.32 2024/03/16 15:35:01 tom Exp $ +.TH curs_legacy 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.TH curs_legacy 3X "" .SH NAME -curs_legacy \- get \fBcurses\fP cursor and window coordinates, attributes +\fB\%getattrs\fP, +\fB\%getbegx\fP, +\fB\%getbegy\fP, +\fB\%getcurx\fP, +\fB\%getcury\fP, +\fB\%getmaxx\fP, +\fB\%getmaxy\fP, +\fB\%getparx\fP, +\fB\%getpary\fP \- +get \fIcurses\fR cursor and window coordinates or attributes (legacy) .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint getattrs(const WINDOW *\fIwin\fB);\fR -.sp -\fBint getbegx(const WINDOW *\fIwin\fB);\fR -.br -\fBint getbegy(const WINDOW *\fIwin\fB);\fR -.sp -\fBint getcurx(const WINDOW *\fIwin\fB);\fR -.br -\fBint getcury(const WINDOW *\fIwin\fB);\fR -.sp -\fBint getmaxx(const WINDOW *\fIwin\fB);\fR -.br -\fBint getmaxy(const WINDOW *\fIwin\fB);\fR -.sp -\fBint getparx(const WINDOW *\fIwin\fB);\fR -.br -\fBint getpary(const WINDOW *\fIwin\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBint getattrs(const WINDOW *\fIwin\fP); +.PP +\fBint getbegx(const WINDOW *\fIwin\fP); +\fBint getbegy(const WINDOW *\fIwin\fP); +.PP +\fBint getcurx(const WINDOW *\fIwin\fP); +\fBint getcury(const WINDOW *\fIwin\fP); +.PP +\fBint getmaxx(const WINDOW *\fIwin\fP); +\fBint getmaxy(const WINDOW *\fIwin\fP); +.PP +\fBint getparx(const WINDOW *\fIwin\fP); +\fBint getpary(const WINDOW *\fIwin\fP); +.fi .SH DESCRIPTION -These legacy functions are simpler to use than the X/Open Curses functions: +These legacy functions are simpler to use +than the X/Open \fIcurses\fP functions: .bP -The \fBgetattrs\fP function returns the same attribute data as \fBwattr_get\fP. +The \fB\%getattrs\fP function returns the same attribute data +as \fB\%wattr_get\fP. .IP -However, \fBgetattrs\fP returns an integer (actually a \fBchtype\fP), -while \fBwattr_get\fP returns the current color pair in a separate parameter. +However, \fB\%getattrs\fP returns an integer (actually a \fB\%chtype\fP), +while \fB\%wattr_get\fP returns the current color pair in a separate parameter. In the wide-character library configuration, -color pairs may not fit into a \fBchtype\fP, -so \fBwattr_get\fP is the only way to obtain the color information. +color pairs may not fit into a \fB\%chtype\fP, +so \fB\%wattr_get\fP is the only way to obtain the color information. .IP -Because \fBgetattrs\fP returns the attributes in a single parameter, +Because \fB\%getattrs\fP returns the attributes in a single parameter, it would not be possible for an application to distinguish that from \fBERR\fP (a \fI-1\fP). -If the window parameter is null, \fBgetattrs\fP returns \fBA_NORMAL\fP (zero). +If the window parameter is null, \fB\%getattrs\fP +returns \fB\%A_NORMAL\fP (zero). .bP -The \fBgetbegy\fP and \fBgetbegx\fP functions return the same -data as \fBgetbegyx\fP. +The \fB\%getbegy\fP and \fB\%getbegx\fP functions return the same +data as \fB\%getbegyx\fP. .bP -The \fBgetcury\fP and \fBgetcurx\fP functions return the same -data as \fBgetyx\fP. +The \fB\%getcury\fP and \fB\%getcurx\fP functions return the same +data as \fB\%getyx\fP. .bP -The \fBgetmaxy\fP and \fBgetmaxx\fP functions return the same -data as \fBgetmaxyx\fP. +The \fB\%getmaxy\fP and \fB\%getmaxx\fP functions return the same +data as \fB\%getmaxyx\fP. .bP -The \fBgetpary\fP and \fBgetparx\fP functions return the same -data as \fBgetparyx\fP. +The \fB\%getpary\fP and \fB\%getparx\fP functions return the same +data as \fB\%getparyx\fP. .SH RETURN VALUE Except as noted, these functions return an integer, or \fBERR\fP if the window parameter is null. .SH NOTES -All of these interfaces are provided as macros and functions. -The macros are suppressed (and only the functions provided) -when \fBNCURSES_OPAQUE\fP is defined. -The standard forms such as \fBgetyx\fP must be implemented as macros, -and (in this implementation) are defined in terms of the functions -described here, -to avoid reliance on internal details of the WINDOW structure. +All of these interfaces are implemented as macros and functions. +The macros are suppressed +(and only the functions provided) +in an \*(``opaque\*('' +.I \%ncurses +build, +which defines the preprocessor symbol +.BR \%NCURSES_OPAQUE . +See section \*(``ALTERNATE CONFIGURATIONS\*('' in \fB\%ncurses\fP(3X). +.PP +The standard forms such as \fB\%getyx\fP +.I must +be implemented as macros, +and +(in this implementation) +are defined in terms of the functions described here, +to avoid reliance on internal details of the \fI\%WINDOW\fP structure. .SH PORTABILITY These functions were supported on Version 7, BSD or System V implementations. None of those implementations checked the window parameter. .PP -The \fBgetattrs\fP function and macro are defined to return a (signed) integer +The \fB\%getattrs\fP function and macro are defined to return a (signed) integer for compatibility with those implementations although an unsigned type would have been more appropriate. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_getyx\fP(3X), -\fBcurs_opaque\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_getyx\fP(3X), +\fB\%curs_opaque\fP(3X) diff --git a/upstream/archlinux/man3/curs_memleaks.3x b/upstream/archlinux/man3/curs_memleaks.3x index cea4165f..b779db88 100644 --- a/upstream/archlinux/man3/curs_memleaks.3x +++ b/upstream/archlinux/man3/curs_memleaks.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2021,2022 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 2008-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,77 +27,80 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_memleaks.3x,v 1.15 2022/06/04 23:33:48 tom Exp $ -.TH curs_memleaks 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_memleaks.3x,v 1.35 2024/03/16 15:35:01 tom Exp $ +.TH curs_memleaks 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBexit_curses\fP, -\fBexit_terminfo\fP \- \fBcurses\fP memory-leak checking -.ad -.hy +\fB\%exit_curses\fP, +\fB\%exit_terminfo\fP \- +check for memory leaks in \fIcurses\fR .SH SYNOPSIS -\fB#include <curses.h>\fP -.br -\fBvoid exit_curses(int \fIcode\fB);\fR -.sp -\fB#include <term.h>\fP -.br -\fBvoid exit_terminfo(int \fIcode\fB);\fR -.sp -/* deprecated (intentionally not declared in curses.h or term.h) */ -.br -\fBvoid _nc_freeall(void);\fP -.br -\fBvoid _nc_free_and_exit(int \fIcode\fB);\fR -.br -\fBvoid _nc_free_tinfo(int \fIcode\fB);\fR +.nf +\fB#include <curses.h> +\fBvoid exit_curses(int \fIcode\fP); +.PP +\fB#include <term.h> +\fBvoid exit_terminfo(int \fIcode\fP); +.PP +\fI/* deprecated (intentionally not declared in curses.h or term.h) */ +\fBvoid _nc_freeall(void); +\fBvoid _nc_free_and_exit(int \fIcode\fP); +\fBvoid _nc_free_tinfo(int \fIcode\fP); +.fi .SH DESCRIPTION -These functions are used to simplify analysis of memory leaks in the ncurses -library. +These functions are used to simplify analysis of memory leaks in the +\fI\%ncurses\fP library. .PP Any implementation of curses must not free the memory associated with -a screen, since (even after calling \fBendwin\fP(3X)), it must be available -for use in the next call to \fBrefresh\fP(3X). +a screen, since (even after calling \fB\%endwin\fP(3X)), it must be available +for use in the next call to \fB\%refresh\fP(3X). There are also chunks of memory held for performance reasons. That makes it hard to analyze curses applications for memory leaks. -When using the specially configured debugging version of the ncurses library, +When using the specially configured debugging version of the +\fI\%ncurses\fP library, applications can call functions which free those chunks of memory, simplifying the process of memory-leak checking. .PP Some of the functions are named with a \*(``_nc_\*('' prefix because they are not intended for use in the non-debugging library: .TP 5 -\fB_nc_freeall\fP -This frees (almost) all of the memory allocated by ncurses. +\fB\%_nc_freeall\fP +This frees (almost) all of the memory allocated by \fI\%ncurses\fP. .TP 5 -\fB_nc_free_and_exit\fP -This frees the memory allocated by ncurses (like \fB_nc_freeall\fP), +\fB\%_nc_free_and_exit\fP +This frees the memory allocated by \fI\%ncurses\fP +(like \fB\%_nc_freeall\fP), and exits the program. -It is preferred over \fB_nc_freeall\fP since some of that memory +It is preferred over \fB\%_nc_freeall\fP since some of that memory may be required to keep the application running. Simply exiting (with the given exit-code) is safer. .TP 5 -\fB_nc_free_tinfo\fP +\fB\%_nc_free_tinfo\fP Use this function if only the low-level terminfo functions (and corresponding library) are used. -Like \fB_nc_free_and_exit\fP, it exits the program after freeing memory. +Like \fB\%_nc_free_and_exit\fP, it exits the program after freeing memory. .PP The functions prefixed \*(``_nc\*('' are normally not available; they must be configured into the library -at build time using the \fB\-\-disable-leaks\fP option. +at build time using the \fB\%\-\-disable-leaks\fP option. That compiles-in code that frees memory that normally would not be freed. .PP -The \fBexit_curses\fP and \fBexit_terminfo\fP functions -call \fB_nc_free_and_exit\fP and \fB_nc_free_tinfo\fP if +The \fB\%exit_curses\fP and \fB\%exit_terminfo\fP functions +call \fB\%_nc_free_and_exit\fP and \fB\%_nc_free_tinfo\fP if the library is configured to support memory-leak checking. If the library is not configured to support memory-leak checking, they simply call \fBexit\fP. @@ -110,18 +113,19 @@ nor do other implementations of curses provide a similar feature. In any implementation of X/Open Curses, an application can free part of the memory allocated by curses: .bP -The portable part of \fBexit_curses\fP can be freed using \fBdelscreen\fP, -passing the \fBSCREEN*\fP pointer returned by \fBnewterm\fP. +The portable part of \fB\%exit_curses\fP can be freed using \fB\%delscreen\fP, +passing the \fISCREEN\fP pointer returned by \fB\%newterm\fP. .IP In some implementations, there is a global variable \fBsp\fP which could be used, e.g., if the screen were only initialized -using \fBinitscr\fP. +using \fB\%initscr\fP. .bP -The portable part of \fBexit_terminfo\fP can be freed using \fBdel_curterm\fP. +The portable part of \fB\%exit_terminfo\fP can be freed +using \fB\%del_curterm\fP. .IP -In this case, there is a global variable \fBcur_term\fP which can be +In this case, there is a global variable \fB\%cur_term\fP which can be used as parameter. .SH SEE ALSO -\fBcurs_initscr\fP(3X), -\fBcurs_terminfo\fP(3X). -\fBcurses\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_initscr\fP(3X), +\fB\%curs_terminfo\fP(3X) diff --git a/upstream/archlinux/man3/curs_mouse.3x b/upstream/archlinux/man3/curs_mouse.3x index 25d69201..ba9bd75e 100644 --- a/upstream/archlinux/man3/curs_mouse.3x +++ b/upstream/archlinux/man3/curs_mouse.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2022,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,78 +28,77 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_mouse.3x,v 1.59 2022/02/12 20:05:11 tom Exp $ -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' -.de NS -.ie n .sp -.el .sp .5 -.ie n .in +4 -.el .in +2 -.nf -.ft C \" Courier -.. -.de NE -.fi -.ft R -.ie n .in -4 -.el .in -2 -.. +.\" $Id: curs_mouse.3x,v 1.98 2024/04/20 19:02:07 tom Exp $ +.TH curs_mouse 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.TH curs_mouse 3X "" -.na -.hy 0 .SH NAME -\fBhas_mouse\fP, -\fBgetmouse\fP, \fBungetmouse\fP, -\fBmousemask\fP, \fBwenclose\fP, -\fBmouse_trafo\fP, \fBwmouse_trafo\fP, -\fBmouseinterval\fP \- mouse interface through curses -.ad -.hy +\fB\%has_mouse\fP, +\fB\%getmouse\fP, +\fB\%ungetmouse\fP, +\fB\%mousemask\fP, +\fB\%wenclose\fP, +\fB\%mouse_trafo\fP, +\fB\%wmouse_trafo\fP, +\fB\%mouseinterval\fP \- +get mouse events in \fIcurses\fR .SH SYNOPSIS -\fB#include <curses.h>\fP +.nf +\fB#include <curses.h> .PP -\fBtypedef unsigned long mmask_t;\fP +\fBtypedef unsigned long mmask_t; .PP -.nf -\fBtypedef struct {\fP -\fB short id; \fI/* ID to distinguish multiple devices */\fR -\fB int x, y, z; \fI/* event coordinates */\fR -\fB mmask_t bstate; \fI/* button state bits */\fR -\fB} MEVENT;\fP -.fi +\fBtypedef struct { +\fB short id; \fI/* ID to distinguish multiple devices */ +\fB int x, y, z; \fI/* event coordinates */ +\fB mmask_t bstate; \fI/* button state bits */ +\fB} MEVENT; +.PP +\fBbool has_mouse(void); +.PP +\fBmmask_t mousemask(mmask_t \fInewmask\fP, mmask_t *\fIoldmask\fP); +.PP +\fBint getmouse(MEVENT *\fIevent\fP); +\fBint ungetmouse(MEVENT *\fIevent\fP); +.PP +\fBbool wenclose(const WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); +.PP +\fBbool mouse_trafo(int* \fIpY\fP, int* \fIpX\fP, bool \fIto_screen\fP); +\fBbool wmouse_trafo(const WINDOW* \fIwin\fP, +.ti +18n \" "bool wmouse_trafo(" +\fBint* \fIpY\fB, int* \fIpX\fB, bool \fIto_screen\fB); .PP -\fBbool has_mouse(void);\fP -.sp -\fBint getmouse(MEVENT *\fIevent\fB);\fR -.br -\fBint ungetmouse(MEVENT *\fIevent\fB);\fR -.sp -\fBmmask_t mousemask(mmask_t \fInewmask\fB, mmask_t *\fIoldmask\fB);\fR -.sp -\fBbool wenclose(const WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB);\fR -.sp -\fBbool mouse_trafo(int* \fIpY\fB, int* \fIpX\fB, bool \fIto_screen\fB);\fR -.br -\fBbool wmouse_trafo(const WINDOW* \fIwin\fB,\fR - \fBint* \fIpY\fB, int* \fIpX\fB, bool \fIto_screen\fB);\fR -.sp \fBint mouseinterval(int \fIerval\fB);\fR -.br +.fi .SH DESCRIPTION These functions provide an interface to mouse events from -\fBncurses\fP(3X). -Mouse events are represented by \fBKEY_MOUSE\fP -pseudo-key values in the \fBwgetch\fP(3X) input stream. -.SS mousemask +\fB\%ncurses\fP(3X). +Mouse events are represented by \fB\%KEY_MOUSE\fP +pseudo-key values in the \fB\%wgetch\fP(3X) input stream. +.SS has_mouse +The \fB\%has_mouse\fP function returns \fBTRUE\fP if the mouse driver +has been successfully initialized, +and \fBFALSE\fP otherwise. .PP -To make mouse events visible, use the \fBmousemask\fP function. +Mouse events are ignored when input is in cooked mode, and +cause an error beep when cooked mode is being simulated in a window by a +function such as \fB\%getstr\fP that expects a linefeed for input-loop +termination. +.SS mousemask +To make mouse events visible, use the \fB\%mousemask\fP function. This sets the mouse events to be reported. By default, no mouse events are reported. .bP @@ -110,22 +109,21 @@ If the screen has not been initialized, or if the terminal does not support mouse-events, this function returns 0. .bP -If \fIoldmask\fP is non-NULL, +If \fIoldmask\fP is non-\fBNULL\fP, this function fills the indicated location with the previous value of the current screen's mouse event mask. .PP -As a side effect, setting a zero mousemask may turn off the mouse pointer; +As a side effect, setting a zero mouse mask may turn off the mouse pointer; setting a nonzero mask may turn it on. Whether this happens is device-dependent. -.SS Mouse events -.PP +.SS "Mouse Events" Here are the mouse event type masks which may be defined: .PP .TS -l l -_ _ -l l. -\fBName\fP \fBDescription\fP +Lb Lb +Lb Lx. +Name Description += BUTTON1_PRESSED mouse button 1 down BUTTON1_RELEASED mouse button 1 up BUTTON1_CLICKED mouse button 1 clicked @@ -156,203 +154,156 @@ BUTTON5_CLICKED mouse button 5 clicked BUTTON5_DOUBLE_CLICKED mouse button 5 double clicked BUTTON5_TRIPLE_CLICKED mouse button 5 triple clicked _ -BUTTON_SHIFT shift was down during button state change -BUTTON_CTRL control was down during button state change -BUTTON_ALT alt was down during button state change +BUTTON_SHIFT T{ +shift was down during button state change +T} +BUTTON_CTRL T{ +control was down during button state change +T} +BUTTON_ALT T{ +alt was down during button state change +T} ALL_MOUSE_EVENTS report all button state changes REPORT_MOUSE_POSITION report mouse movement _ .TE .SS getmouse -.PP Once a class of mouse events has been made visible in a window, -calling the \fBwgetch\fP function on that window may return -\fBKEY_MOUSE\fP as an indicator that a mouse event has been queued. +calling the \fB\%wgetch\fP function on that window may return +\fB\%KEY_MOUSE\fP as an indicator that a mouse event has been queued. To read the event data and pop the event off the queue, call -\fBgetmouse\fP. +\fB\%getmouse\fP. This function will return \fBOK\fP if a mouse event is actually visible in the given window, \fBERR\fP otherwise. -When \fBgetmouse\fP returns \fBOK\fP, the data deposited as y and +When \fB\%getmouse\fP returns \fBOK\fP, the data deposited as y and x in the event structure coordinates will be screen-relative character-cell coordinates. The returned state mask will have exactly one bit set to indicate the event type. The corresponding data in the queue is marked invalid. -A subsequent call to \fBgetmouse\fP will retrieve the next older +A subsequent call to \fB\%getmouse\fP will retrieve the next older item from the queue. .SS ungetmouse -.PP -The \fBungetmouse\fP function behaves analogously to \fBungetch\fP. +The \fB\%ungetmouse\fP function behaves analogously to \fB\%ungetch\fP. It pushes -a \fBKEY_MOUSE\fP event onto the input queue, and associates with that event +a \fB\%KEY_MOUSE\fP event onto the input queue, and associates with that event the given state data and screen-relative character-cell coordinates. .SS wenclose -.PP -The \fBwenclose\fP function tests whether a given pair of screen-relative +The \fB\%wenclose\fP function tests whether a given pair of screen-relative character-cell coordinates is enclosed by a given window, returning \fBTRUE\fP if it is and \fBFALSE\fP otherwise. It is useful for determining what subset of the screen windows enclose the location of a mouse event. -.SS wmouse_trafo .PP -The \fBwmouse_trafo\fP function transforms a given pair of coordinates -from stdscr-relative coordinates +If the parameter is a pad, +\fB\%wenclose\fP uses the most recent screen coordinates used for +this pad in +\fB\%prefresh\fP(3X) or +\fB\%pnoutrefresh\fP(3X). +.SS wmouse_trafo +The \fB\%wmouse_trafo\fP function transforms a given pair of coordinates +from \fB\%stdscr\fP-relative coordinates to coordinates relative to the given window or vice versa. -The resulting stdscr-relative coordinates are not always identical -to window-relative coordinates due to the mechanism to reserve lines on top -or bottom of the screen for other purposes -(see the \fBripoffline\fP and \fBslk_init\fP(3X) calls, for example). +The resulting \fB\%stdscr\fP-relative coordinates are not always +identical to screen coordinates due to the mechanism to reserve +lines on top or bottom of the screen for other purposes +(see the \fB\%ripoffline\fP(3X) and \fB\%slk_init\fP(3X) calls, for example). .bP If the parameter \fIto_screen\fP is \fBTRUE\fP, the pointers \fIpY, pX\fP must reference the coordinates of a location inside the window \fIwin\fP. -They are converted to window-relative coordinates and returned +They are converted to \fB\%stdscr\fP-relative coordinates and returned through the pointers. If the conversion was successful, the function returns \fBTRUE\fP. -.bP -If one of the parameters was NULL or the location is +.IP +If one of the parameters was \fBNULL\fP or the location is not inside the window, \fBFALSE\fP is returned. .bP If \fIto_screen\fP is -\fBFALSE\fP, the pointers \fIpY, pX\fP must reference window-relative -coordinates. -They are converted to stdscr-relative coordinates if the +\fBFALSE\fP, the pointers \fIpY, pX\fP must reference +\fB\%stdscr\fP-relative coordinates. +They are converted to window-relative coordinates if the window \fIwin\fP encloses this point. In this case the function returns \fBTRUE\fP. -.bP -If one of the parameters is NULL or the point is not inside the +.IP +If one of the parameters is \fBNULL\fP or the point is not inside the window, \fBFALSE\fP is returned. +.PP The referenced coordinates are only replaced by the converted coordinates if the transformation was successful. .SS mouse_trafo -.PP -The \fBmouse_trafo\fP function performs the same translation -as \fBwmouse_trafo\fP, -using stdscr for \fIwin\fP. +The \fB\%mouse_trafo\fP function performs the same translation +as \fB\%wmouse_trafo\fP, +using \fB\%stdscr\fP for \fIwin\fP. .SS mouseinterval +The \fB\%mouseinterval\fP function sets the maximum time +(in thousands of a second) +that can elapse between press and release events for them to +be resolved as a +.IR click . +An application might interpret button press and release events separated +by more than the mouse interval as a \*(``long press\*('', +or, +with motion, +as a \*(``drag\*(''. +.PP +Calling \fB\%mouseinterval(0)\fP disables click resolution. +When +.I \%ncurses +detects a mouse event, +it awaits further input activity up to this interval, +and then checks for a subsequent mouse event which can be combined +with the first event. +If the timeout expires without input activity +(which would happen with a zero interval), +then no click resolution will occur. .PP -The \fBmouseinterval\fP function sets the maximum time (in thousands of a -second) that can elapse between press and release events for them to -be recognized as a click. -Use \fBmouseinterval(0)\fP to disable click resolution. This function returns the previous interval value. -Use \fBmouseinterval(\-1)\fP to obtain the interval without altering it. -The default is one sixth of a second. -.SS has_mouse +Use \fB\%mouseinterval(\-1)\fP to obtain the interval without altering it. .PP -The \fBhas_mouse\fP function returns \fBTRUE\fP if the mouse driver has been -successfully initialized. -.PP -Note that mouse events will be ignored when input is in cooked mode, and will -cause an error beep when cooked mode is being simulated in a window by a -function such as \fBgetstr\fP that expects a linefeed for input-loop -termination. +The mouse interval is set to one sixth of a second +when the corresponding screen is initialized, +e.g., in \fBinitscr\fP(3X) or \fBsetupterm\fP(3X). .SH RETURN VALUE -\fBgetmouse\fP and \fBungetmouse\fP -return the integer \fBERR\fP upon failure or \fBOK\fP -upon successful completion: -.RS 3 -.TP 5 -\fBgetmouse\fP -returns an error. +\fB\%has_mouse\fP, +\fB\%wenclose\fP, +\fB\%mouse_trafo\fP, +and +\fB\%wmouse_trafo\fP +return \fBTRUE\fP or \fBFALSE\fP as noted above. +.PP +\fB\%getmouse\fP and \fB\%ungetmouse\fP +return \fBERR\fP upon failure and \fBOK\fP upon success. +.PP +\fB\%getmouse\fP fails if: .bP -If no mouse driver was initialized, or -if the mask parameter is zero, +no mouse driver was initialized, .bP -It returns an error if a mouse event was detected which did not match the -current \fImousemask\fP. +the mask of reportable events is zero, .bP -It also returns an error if no more events remain in the queue. -.TP 5 -\fBungetmouse\fP -returns an error if the FIFO is full. -.RE +a mouse event was detected that does not match the mask, +.bP +or if no more events remain in the queue. +.PP +\fB\%ungetmouse\fP returns an error if the event queue is full. .PP -\fBmousemask\fP +\fB\%mousemask\fP returns the mask of reportable events. .PP -\fBmouseinterval\fP +\fB\%mouseinterval\fP returns the previous interval value, unless the terminal was not initialized. In that case, it returns the maximum interval value (166). -.PP -\fBwenclose\fP and \fBwmouse_trafo\fP -are boolean functions returning \fBTRUE\fP or \fBFALSE\fP depending -on their test result. -.SH PORTABILITY -These calls were designed for \fBncurses\fP(3X), and are not found in SVr4 -curses, 4.4BSD curses, or any other previous version of curses. -.PP -SVr4 curses had support for the mouse in a variant of \fBxterm\fP(1). -It is mentioned in a few places, but with no supporting documentation: -.bP -the \*(``libcurses\*('' manual page lists functions for this feature -which are prototyped in \fBcurses.h\fP: -.NS -extern int mouse_set(long int); -extern int mouse_on(long int); -extern int mouse_off(long int); -extern int request_mouse_pos(void); -extern int map_button(unsigned long); -extern void wmouse_position(WINDOW *, int *, int *); -extern unsigned long getmouse(void), getbmap(void); -.NE -.bP -the \*(``terminfo\*('' manual page lists capabilities for the feature -.NS -buttons btns BT Number of buttons on the mouse -get_mouse getm Gm Curses should get button events -key_mouse kmous Km 0631, Mouse event has occurred -mouse_info minfo Mi Mouse status information -req_mouse_pos reqmp RQ Request mouse position report -.NE -.bP -the interface made assumptions (as does ncurses) about the escape sequences -sent to and received from the terminal. -.IP -For instance -the SVr4 curses library used the \fBget_mouse\fP capability to tell the -terminal which mouse button events it should send, -passing the mouse-button bit-mask to the terminal. -Also, it could ask the terminal -where the mouse was using the \fBreq_mouse_pos\fP capability. -.IP -Those features required a terminal which had been modified to work with curses. -They were not part of the X Consortium's xterm. -.PP -When developing the xterm mouse support for ncurses in September 1995, -Eric Raymond was uninterested in using the same interface due to its -lack of documentation. -Later, in 1998, Mark Hesseling provided support in -PDCurses 2.3 using the SVr4 interface. -PDCurses, however, does not use video terminals, -making it unnecessary to be concerned about compatibility with the -escape sequences. -.PP -The feature macro \fBNCURSES_MOUSE_VERSION\fP is provided so the preprocessor -can be used to test whether these features are present. -If the interface is changed, the value of \fBNCURSES_MOUSE_VERSION\fP will be -incremented. -These values for \fBNCURSES_MOUSE_VERSION\fP may be -specified when configuring ncurses: -.RS 3 -.TP 3 -1 -has definitions for reserved events. -The mask uses 28 bits. -.TP 3 -2 -adds definitions for button 5, -removes the definitions for reserved events. -The mask uses 29 bits. -.RE -.PP -The order of the \fBMEVENT\fP structure members is not guaranteed. +.SH NOTES +The order of the \fB\%MEVENT\fP structure members is not guaranteed. Additional fields may be added to the structure in the future. .PP -Under \fBncurses\fP(3X), these calls are implemented using either -xterm's built-in mouse-tracking API or +Under +.IR \%ncurses , +these calls are implemented using either +.IR \%xterm 's +built-in mouse-tracking API or platform-specific drivers including .RS 3 .bP @@ -365,23 +316,31 @@ OS/2 EMX .PP If you are using an unsupported configuration, mouse events will not be visible to -\fBncurses\fP(3X) (and the \fBmousemask\fP function will always +\fI\%ncurses\fP (and the \fB\%mousemask\fP function will always return \fB0\fP). .PP -If the terminfo entry contains a \fBXM\fP string, -this is used in the xterm mouse driver to control the +If the +.I \%term\%info +entry contains a \fBXM\fP string, +this is used in the +.I \%xterm +mouse driver to control the way the terminal is initialized for mouse operation. The default, if \fBXM\fP is not found, -corresponds to private mode 1000 of xterm: +corresponds to private mode 1000 of +.I \%xterm: .PP .RS 3 -\\E[?1000%?%p1%{1}%=%th%el%; +\eE[?1000%?%p1%{1}%=%th%el%; .RE .PP -The mouse driver also recognizes a newer xterm private mode 1006, e.g., +The mouse driver also recognizes a newer +.I \%xterm +private mode 1006, +e.g., .PP .RS 3 -\\E[?1006;1000%?%p1%{1}%=%th%el%; +\eE[?1006;1000%?%p1%{1}%=%th%el%; .RE .PP The \fIz\fP member in the event structure is not presently used. @@ -389,37 +348,178 @@ It is intended for use with touch screens (which may be pressure-sensitive) or with 3D-mice/trackballs/power gloves. .PP -The \fBALL_MOUSE_EVENTS\fP class does not include \fBREPORT_MOUSE_POSITION\fP. +The \fB\%ALL_MOUSE_EVENTS\fP class does not +include \fB\%REPORT_MOUSE_POSITION\fP. They are distinct. -For example, in xterm, +For example, +in +.IR \%xterm , wheel/scrolling mice send position reports as a sequence of presses of buttons 4 or 5 without matching button-releases. +.SH EXTENSIONS +These functions were designed for +\fB\%ncurses\fP(3X), +and are not found in SVr4 +.IR curses , +4.4BSD +.IR curses , +or any other previous curses implementation. +(SVr4 +.I curses +did have a +.I \%getmouse +function, +which took no argument and returned a different type.) +.SH PORTABILITY +Applications employing the +.I \%ncurses +mouse extension should condition its use on the visibility of the +.B \%NCURSES_MOUSE_VERSION +preprocessor macro. +When the interface changes, +the macro's value increments. +Multiple versions are available when +.I \%ncurses +is configured; +see section \*(``ALTERNATE CONFIGURATIONS\*('' of \fB\%ncurses\fP(3X). +The following values may be specified. +.RS 3 +.TP 3 +1 +has definitions for reserved events. +The mask uses 28 bits. +.TP 3 +2 +adds definitions for button 5, +removes the definitions for reserved events. +The mask uses 29 bits. +.RE +.PP +SVr4 +.I curses +had support for the mouse in a variant of \fI\%xterm\fP(1). +It is mentioned in a few places, +with little supporting documentation. +.bP +Its \*(``libcurses\*('' manual page lists functions for this feature +prototyped in \fI\%curses.h\fP. +.PP +.RS 8 +.EX +extern int mouse_set(long int); +extern int mouse_on(long int); +extern int mouse_off(long int); +extern int request_mouse_pos(void); +extern int map_button(unsigned long); +extern void wmouse_position(WINDOW *, int *, int *); +extern unsigned long getmouse(void), getbmap(void); +.EE +.RE +.bP +Its \*(``terminfo\*('' manual page lists capabilities for the feature. +.\" These don't appear in in the SVID 4th edition, Volume 3, +.\" terminfo(TI_ENV) man page. They can be found in, e.g., the "z/OS +.\" V1R1.0 C Curses" book, Chapter 17, pp. 179-186 (PDF 213-220). +.RS 8 +.TS +Lb Lb Lb Lx. +buttons btns BT T{ +Number of buttons on the mouse +T} +get_mouse getm Gm T{ +Curses should get button events +T} +key_mouse kmous Km T{ +0631, Mouse event has occurred +T} +mouse_info minfo Mi T{ +Mouse status information +T} +req_mouse_pos reqmp RQ T{ +Request mouse position report +T} +.TE +.RE +.bP +The interface made assumptions +(as does +.IR \%ncurses ) +about the escape sequences sent to and received from the terminal. +.IP +For instance, +the SVr4 +.I curses +library used the \fB\%get_mouse\fP capability to tell the terminal which +mouse button events it should send, +passing the mouse-button bit mask to the terminal. +Also, it could ask the terminal +where the mouse was using the \fB\%req_mouse_pos\fP capability. +.IP +Those features required a terminal program that had been modified +to work with SVr4 +.IR curses . +They were not part of the X Consortium's +.IR \%xterm . +.PP +When developing the +.I \%xterm +mouse support for +.I \%ncurses +in September 1995, +Eric Raymond was uninterested in using the same interface due to its +lack of documentation. +Later, in 1998, Mark Hesseling provided support in +.I \%PDCurses +2.3 using the SVr4 interface. +.IR \%PDCurses , +however, +does not use video terminals, +making it unnecessary to be concerned about compatibility with the +escape sequences. .SH BUGS -Mouse events under xterm will not in fact be ignored during cooked mode, -if they have been enabled by \fBmousemask\fP. -Instead, the xterm mouse -report sequence will appear in the string read. -.PP -Mouse events under xterm will not be detected correctly in a window with -its keypad bit off, since they are interpreted as a variety of function key. -Your terminfo description should have \fBkmous\fP set to \*(``\\E[M\*('' -(the beginning of the response from xterm for mouse clicks). -Other values for \fBkmous\fP are permitted, -but under the same assumption, -i.e., it is the beginning of the response. -.PP -Because there are no standard terminal responses that would serve to identify -terminals which support the xterm mouse protocol, \fBncurses\fP assumes that -if \fBkmous\fP is defined in the terminal description, -or if the terminal description's primary name or aliases -contain the string \*(``xterm\*('', +Mouse events from +.I \%xterm +are +.I not +ignored in cooked mode if they have been enabled by \fB\%mousemask\fP. +Instead, +the +.I \%xterm +mouse report sequence appears in the string read. +.PP +Mouse event reports from +.I \%xterm +are not detected correctly in a window with keypad application mode +disabled, +since they are interpreted as a variety of function key. +Set the terminal's +.I \%term\%info +capability \fB\%kmous\fP to \*(``\eE[M\*('' +(the beginning of the response from +.I \%xterm +for mouse clicks). +Other values of \fB\%kmous\fP are permitted under the same assumption, +that is, +the report begins with that sequence. +.PP +Because there are no standard response sequences that serve to identify +terminals supporting the +.I \%xterm +mouse protocol, +.I \%ncurses +assumes that if \fB\%kmous\fP is defined in the terminal description, +or if the terminal type's primary name or aliases contain the string +\%\*(``xterm\*('', then the terminal may send mouse events. -The \fBkmous\fP capability is checked first, -allowing the use of newer xterm mouse protocols -such as xterm's private mode 1006. +The \fB\%kmous\fP capability is checked first, +allowing use of newer +.I \%xterm +mouse protocols, +such as its private mode 1006. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_inopts\fP(3X), -\fBcurs_kernel\fP(3X), -\fBcurs_slk\fP(3X), -\fBcurs_variables\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_inopts\fP(3X), +\fB\%curs_kernel\fP(3X), +\fB\%curs_pad\fP(3X), +\fB\%curs_slk\fP(3X), +\fB\%curs_variables\fP(3X) diff --git a/upstream/archlinux/man3/curs_move.3x b/upstream/archlinux/man3/curs_move.3x index 05917626..33d8b564 100644 --- a/upstream/archlinux/man3/curs_move.3x +++ b/upstream/archlinux/man3/curs_move.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,40 +27,62 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_move.3x,v 1.22 2022/02/12 20:05:11 tom Exp $ -.TH curs_move 3X "" -.na -.hy 0 +.\" $Id: curs_move.3x,v 1.40 2024/04/27 17:56:05 tom Exp $ +.TH curs_move 3X 2024-04-27 "ncurses 6.5" "Library calls" .SH NAME -\fBmove\fP, -\fBwmove\fP \- move \fBcurses\fP window cursor -.ad -.hy +\fB\%move\fP, +\fB\%wmove\fP \- +move cursor in a \fIcurses\fR window .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint move(int \fIy\fB, int \fIx\fB);\fR -.br -\fBint wmove(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBint move(int \fIy\fP, int \fIx\fP); +\fBint wmove(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); +.fi .SH DESCRIPTION -These routines move the cursor associated with the window to line \fIy\fP and -column \fIx\fP. -This routine does not move the physical cursor of the terminal -until \fBrefresh\fP(3X) is called. -The position specified is relative to the upper -left-hand corner of the window, which is (0,0). +.B \%wmove +relocates the cursor associated with the +.I curses +window +.I win +to line +.I y +and column +.IR x . +The terminal's cursor does not move until \fB\%refresh\fP(3X) is called. +The position +.RI ( y , +.IR x ) +is relative to the upper left-hand corner of the window, +which has coordinates +(0,\ 0). +\fB\%ncurses\fP(3X) describes the +.B \%move +variant of this function. .SH RETURN VALUE -These routines return \fBERR\fP upon failure and \fBOK\fP (SVr4 -specifies only "an integer value other than \fBERR\fP") upon successful -completion. +These functions return +.B OK +on success and +.B ERR +on failure. +.PP +They fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .PP -Specifically, they return an error -if the window pointer is null, or -if the position is outside the window. +.B \%wmove +fails if its +.I \%WINDOW +pointer argument is +.BR NULL . .SH NOTES -Note that \fBmove\fP may be a macro. +.B \%move +may be implemented as a macro. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +X/Open Curses, +Issue 4 describes these functions. .SH SEE ALSO -\fBcurses\fP(3X), \fBcurs_refresh\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_refresh\fP(3X) diff --git a/upstream/archlinux/man3/curs_opaque.3x b/upstream/archlinux/man3/curs_opaque.3x index 2e57c0e2..a9b8d380 100644 --- a/upstream/archlinux/man3/curs_opaque.3x +++ b/upstream/archlinux/man3/curs_opaque.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2020-2022,2023 Thomas E. Dickey * +.\" Copyright 2020-2023,2024 Thomas E. Dickey * .\" Copyright 2007-2014,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,129 +27,135 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_opaque.3x,v 1.19 2023/03/11 20:40:58 tom Exp $ -.TH curs_opaque 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' -.na -.hy 0 +.\" $Id: curs_opaque.3x,v 1.43 2024/03/16 15:35:01 tom Exp $ +.TH curs_opaque 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME -\fBis_cleared\fP, -\fBis_idlok\fP, -\fBis_idcok\fP, -\fBis_immedok\fP, -\fBis_keypad\fP, -\fBis_leaveok\fP, -\fBis_nodelay\fP, -\fBis_notimeout\fP, -\fBis_pad\fP, -\fBis_scrollok\fP, -\fBis_subwin\fP, -\fBis_syncok\fP, -\fBwgetdelay\fP, -\fBwgetparent\fP, -\fBwgetscrreg\fP \- \fBcurses\fP window properties -.ad -.hy +\fB\%is_cleared\fP, +\fB\%is_idlok\fP, +\fB\%is_idcok\fP, +\fB\%is_immedok\fP, +\fB\%is_keypad\fP, +\fB\%is_leaveok\fP, +\fB\%is_nodelay\fP, +\fB\%is_notimeout\fP, +\fB\%is_pad\fP, +\fB\%is_scrollok\fP, +\fB\%is_subwin\fP, +\fB\%is_syncok\fP, +\fB\%wgetdelay\fP, +\fB\%wgetparent\fP, +\fB\%wgetscrreg\fP \- +obtain \fIcurses\fR window properties .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBbool is_cleared(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_idcok(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_idlok(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_immedok(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_keypad(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_leaveok(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_nodelay(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_notimeout(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_pad(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_scrollok(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_subwin(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_syncok(const WINDOW *\fIwin\fB);\fR -.br -\fBWINDOW * wgetparent(const WINDOW *\fIwin\fB);\fR -.br -\fBint wgetdelay(const WINDOW *\fIwin\fB);\fR -.br -\fBint wgetscrreg(const WINDOW *\fIwin\fB, int *\fItop\fB, int *\fIbottom\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBbool is_cleared(const WINDOW *\fIwin\fP); +\fBbool is_idcok(const WINDOW *\fIwin\fP); +\fBbool is_idlok(const WINDOW *\fIwin\fP); +\fBbool is_immedok(const WINDOW *\fIwin\fP); +\fBbool is_keypad(const WINDOW *\fIwin\fP); +\fBbool is_leaveok(const WINDOW *\fIwin\fP); +\fBbool is_nodelay(const WINDOW *\fIwin\fP); +\fBbool is_notimeout(const WINDOW *\fIwin\fP); +\fBbool is_pad(const WINDOW *\fIwin\fP); +\fBbool is_scrollok(const WINDOW *\fIwin\fP); +\fBbool is_subwin(const WINDOW *\fIwin\fP); +\fBbool is_syncok(const WINDOW *\fIwin\fP); +.PP +\fBWINDOW * wgetparent(const WINDOW *\fIwin\fP); +\fBint wgetdelay(const WINDOW *\fIwin\fP); +\fBint wgetscrreg(const WINDOW *\fIwin\fP, int *\fItop\fP, int *\fIbottom\fP); +.fi .SH DESCRIPTION -This implementation provides functions which return properties -set in the WINDOW structure, allowing it to be \*(``opaque\*('' if -the symbol \fBNCURSES_OPAQUE\fP is defined: -.TP 5 +\fI\%ncurses\fP provides functions returning properties of a +\fI\%WINDOW\fP structure, +allowing it to be \*(``opaque\*('' if +the application defines the \fB\%NCURSES_OPAQUE\fP preprocessor symbol. +\fIOpacity\fP in this sense means that the members of \fIstruct\fP data +types are not directly accessible +(for instance, +through \*(``.\*('' or \*(``\->\*('' operators), +but instead must be queried and/or set via library functions. +Advantages of opacity include greater abstraction and improved +management of concurrent accesses to data structures, +keeping object states coherent. +.TP \fBis_cleared\fP -returns the value set in \fBclearok\fP(3X) -.TP 5 +returns the value set by \fB\%clearok\fP(3X). +.TP \fBis_idcok\fP -returns the value set in \fBidcok\fP(3X) -.TP 5 +returns the value set by \fB\%idcok\fP(3X). +.TP \fBis_idlok\fP -returns the value set in \fBidlok\fP(3X) -.TP 5 +returns the value set by \fB\%idlok\fP(3X). +.TP \fBis_immedok\fP -returns the value set in \fBimmedok\fP(3X) -.TP 5 +returns the value set by \fB\%immedok\fP(3X). +.TP \fBis_keypad\fP -returns the value set in \fBkeypad\fP(3X) -.TP 5 +returns the value set by \fB\%keypad\fP(3X). +.TP \fBis_leaveok\fP -returns the value set in \fBleaveok\fP(3X) -.TP 5 +returns the value set by \fB\%leaveok\fP(3X). +.TP \fBis_nodelay\fP -returns the value set in \fBnodelay\fP(3X) -.TP 5 +returns the value set by \fB\%nodelay\fP(3X). +.TP \fBis_notimeout\fP -returns the value set in \fBnotimeout\fP(3X) -.TP 5 +returns the value set by \fB\%notimeout\fP(3X). +.TP \fBis_pad\fP -returns \fBTRUE\fP if the window is a pad -i.e., created by \fBnewpad\fP(3X) -.TP 5 +returns \fBTRUE\fP if the window is a pad; +that is, +it was created by \fB\%newpad\fP(3X). +.TP \fBis_scrollok\fP -returns the value set in \fBscrollok\fP(3X) -.TP 5 +returns the value set by \fB\%scrollok\fP(3X). +.TP \fBis_subwin\fP returns \fBTRUE\fP if the window is a subwindow, -i.e., created by \fBsubwin\fP(3X) or \fBderwin\fP(3X) -.TP 5 +that is, +it was created by \fB\%subwin\fP(3X) or \fB\%derwin\fP(3X). +.TP \fBis_syncok\fP -returns the value set in \fBsyncok\fP(3X) -.TP 5 +returns the value set by \fB\%syncok\fP(3X). +.TP \fBwgetdelay\fP -returns the delay timeout as set in \fBwtimeout\fP(3X). -.TP 5 +returns the delay timeout set by \fB\%wtimeout\fP(3X). +.TP \fBwgetparent\fP -returns the parent WINDOW pointer for subwindows, -or NULL for windows having no parent. -.TP 5 +returns the parent \fI\%WINDOW\fP pointer for subwindows, +or \fBNULL\fP for windows having no parent. +.TP \fBwgetscrreg\fP -returns the top and bottom rows for the scrolling margin -as set in \fBwsetscrreg\fP. +stores the the top and bottom rows for the scrolling margin set by +\fB\%wsetscrreg\fP(3X) in the corresponding arguments, +returning \fBERR\fP upon failure and \fBOK\fP upon successful +completion. .SH RETURN VALUE -These functions all return \fBTRUE\fP or \fBFALSE\fP, except as noted. +These functions return \fBTRUE\fP or \fBFALSE\fP except as noted. .SH NOTES -Both a macro and a function are provided for each name. +\fI\%ncurses\fP provides both a C function and a preprocessor macro for +each function documented in this page. .SH PORTABILITY -These routines are specific to ncurses. +These routines are specific to \fI\%ncurses\fP. They were not supported on Version 7, BSD or System V implementations. -It is recommended that any code depending on ncurses extensions -be conditioned using NCURSES_VERSION. +It is recommended that any code depending on \fI\%ncurses\fP extensions +be conditioned using \fB\%NCURSES_VERSION\fP. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_inopts\fP(3X), -\fBcurs_outopts\fP(3X), -\fBcurs_window\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_inopts\fP(3X), +\fB\%curs_outopts\fP(3X), +\fB\%curs_threads\fP(3X), +\fB\%curs_window\fP(3X) diff --git a/upstream/archlinux/man3/curs_outopts.3x b/upstream/archlinux/man3/curs_outopts.3x index 4f90611b..74955009 100644 --- a/upstream/archlinux/man3/curs_outopts.3x +++ b/upstream/archlinux/man3/curs_outopts.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,52 +27,42 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_outopts.3x,v 1.36 2022/02/12 20:05:11 tom Exp $ -.TH curs_outopts 3X "" -.na -.hy 0 +.\" $Id: curs_outopts.3x,v 1.64 2024/04/20 21:24:19 tom Exp $ +.TH curs_outopts 3X 2024-04-20 "ncurses 6.5" "Library calls" .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBclearok\fP, -\fBidlok\fP, -\fBidcok\fP, -\fBimmedok\fP, -\fBleaveok\fP, -\fBsetscrreg\fP, -\fBwsetscrreg\fP, -\fBscrollok\fP \- \fBcurses\fP output options -.ad -.hy +\fB\%clearok\fP, +\fB\%idlok\fP, +\fB\%idcok\fP, +\fB\%immedok\fP, +\fB\%leaveok\fP, +\fB\%setscrreg\fP, +\fB\%wsetscrreg\fP, +\fB\%scrollok\fP \- +set \fIcurses\fR output options .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint clearok(WINDOW *\fIwin\fB, bool \fIbf\fB);\fR -.br -\fBint idlok(WINDOW *\fIwin\fB, bool \fIbf\fB);\fR -.br -\fBvoid idcok(WINDOW *\fIwin\fB, bool \fIbf\fB);\fR -.br -\fBvoid immedok(WINDOW *\fIwin\fB, bool \fIbf\fB);\fR -.br -\fBint leaveok(WINDOW *\fIwin\fB, bool \fIbf\fB);\fR -.br -\fBint scrollok(WINDOW *\fIwin\fB, bool \fIbf\fB);\fR -.sp -\fBint setscrreg(int \fItop\fB, int \fIbot\fB);\fR -.br -\fBint wsetscrreg(WINDOW *\fIwin\fB, int \fItop\fB, int \fIbot\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBint clearok(WINDOW *\fIwin\fP, bool \fIbf\fP); +\fBint idlok(WINDOW *\fIwin\fP, bool \fIbf\fP); +\fBvoid idcok(WINDOW *\fIwin\fP, bool \fIbf\fP); +\fBvoid immedok(WINDOW *\fIwin\fP, bool \fIbf\fP); +\fBint leaveok(WINDOW *\fIwin\fP, bool \fIbf\fP); +\fBint scrollok(WINDOW *\fIwin\fP, bool \fIbf\fP); +.PP +\fBint setscrreg(int \fItop\fP, int \fIbot\fP); +\fBint wsetscrreg(WINDOW *\fIwin\fP, int \fItop\fP, int \fIbot\fP); +.fi .SH DESCRIPTION -.PP These routines set options that change the style of output within \fBcurses\fP. All options are initially \fBFALSE\fP, unless otherwise stated. It is not necessary to turn these options off before calling \fBendwin\fP(3X). .SS clearok -.PP If \fBclearok\fP is called with \fBTRUE\fP as argument, the next call to \fBwrefresh\fP with this window will clear the screen completely and redraw the entire screen from scratch. @@ -83,7 +73,6 @@ the \fIwin\fP argument to \fBclearok\fP is the global variable \fBcurscr\fP, the next call to \fBwrefresh\fP with any window causes the screen to be cleared and repainted from scratch. .SS idlok -.PP If \fBidlok\fP is called with \fBTRUE\fP as second argument, \fBcurses\fP considers using the hardware insert/delete line feature of terminals so equipped. @@ -97,7 +86,6 @@ when used in applications where it is not really needed. If insert/delete line cannot be used, \fBcurses\fP redraws the changed portions of all lines. .SS idcok -.PP If \fBidcok\fP is called with \fBFALSE\fP as second argument, \fBcurses\fP no longer considers using the hardware insert/delete character feature of terminals so equipped. @@ -105,15 +93,16 @@ Use of character insert/delete is enabled by default. Calling \fBidcok\fP with \fBTRUE\fP as second argument re-enables use of character insertion and deletion. .SS immedok -.PP -If \fBimmedok\fP is called with \fBTRUE as argument\fP, any change -in the window image, such as the ones caused by \fBwaddch, wclrtobot, wscrl\fP, -etc., automatically cause a call to \fBwrefresh\fP. -However, it may -degrade performance considerably, due to repeated calls to \fBwrefresh\fP. -It is disabled by default. +If \fBimmedok\fP is called with \fBTRUE\fP as second argument, +any change in the window image, +such as the ones caused by \fBwaddch, wclrtobot, wscrl\fP, +etc., automatically causes a call to \fBwrefresh\fP. +However, it may degrade performance considerably, +due to repeated calls to \fBwrefresh\fP. +Calling \fBimmedok\fP with \fBFALSE\fP as second argument +restores the default behavior, +i.e., deferring screen updates until a refresh is needed. .SS leaveok -.PP Normally, the hardware cursor is left at the location of the window cursor being refreshed. The \fBleaveok\fP option allows the cursor to be left @@ -121,7 +110,6 @@ wherever the update happens to leave it. It is useful for applications where the cursor is not used, since it reduces the need for cursor motions. .SS scrollok -.PP The \fBscrollok\fP option controls what happens when the cursor of a window is moved off the edge of the window or scrolling region, either as a result of a newline action on the bottom line, or typing the last character of the last @@ -131,8 +119,7 @@ line. If enabled, (\fIbf\fP is \fBTRUE\fP), the window is scrolled up one line (Note that to get the physical scrolling effect on the terminal, it is also necessary to call \fBidlok\fP). -.SS setscrreg/wsetscrreg -.PP +.SS "setscrreg, wsetscrreg" The \fBsetscrreg\fP and \fBwsetscrreg\fP routines allow the application programmer to set a software scrolling region in a window. The \fItop\fP and @@ -156,7 +143,7 @@ and \fBERR\fP upon failure. All other routines that return an integer always return \fBOK\fP. .PP -X/Open Curses does not define any error conditions. +X/Open Curses does not specify any error conditions. .PP In this implementation, .bP @@ -164,60 +151,49 @@ those functions that have a window pointer will return an error if the window pointer is null .bP \fBwsetscrreg\fP -returns an error if the scrolling region limits extend outside the window. -.RE +returns an error if the scrolling region limits extend outside the +window boundaries. +.SH NOTES +Note that +\fBclearok\fP, +\fBleaveok\fP, +\fBscrollok\fP, +\fBidcok\fP, and +\fBsetscrreg\fP may be macros. .PP -X/Open does not define any error conditions. -This implementation returns an error -if the window pointer is null. +The \fBimmedok\fP routine is useful for windows that are used as terminal +emulators. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. -.PP -From the outset, ncurses used \fBnl\fP/\fBnonl\fP to control the conversion -of newlines to carriage return/line-feed on output as well as input. -XSI Curses documents only the use of these functions for input. -This difference arose from converting the \fIpcurses\fP source -(which used \fBioctl\fP calls with the \fBsgttyb\fP structure) -to termios (i.e., the POSIX terminal interface). -In the former, both input and output were controlled via a single -option \fBCRMOD\fP, -while the latter separates these features. -Because that conversion interferes with output optimization, -\fBnl\fP/\fBnonl\fP were amended after ncurses 6.2 -to eliminate their effect on output. +These functions are described in X/Open Curses, Issue 4. .PP Some historic curses implementations had, as an undocumented feature, the ability to do the equivalent of \fBclearok(..., 1)\fP by saying \fBtouchwin(stdscr)\fP or \fBclear(stdscr)\fP. -This will not work under ncurses. +This will not work under \fI\%ncurses\fP. .PP Earlier System V curses implementations specified that with \fBscrollok\fP enabled, any window modification triggering a scroll also forced a physical refresh. -XSI Curses does not require this, and \fBncurses\fP avoids doing +X/Open Curses does not require this, and \fI\%ncurses\fP avoids doing it to perform better vertical-motion optimization at \fBwrefresh\fP time. .PP -The XSI Curses standard does not mention that the cursor should be +X/Open Curses does not mention that the cursor should be made invisible as a side-effect of \fBleaveok\fP. SVr4 curses documentation does this, but the code does not. Use \fBcurs_set\fP to make the cursor invisible. -.SH NOTES -Note that -\fBclearok\fP, -\fBleaveok\fP, -\fBscrollok\fP, -\fBidcok\fP, and -\fBsetscrreg\fP may be macros. -.PP -The \fBimmedok\fP routine is useful for windows that are used as terminal -emulators. +.SH HISTORY +.I \%ncurses +formerly treated \fBnl\fP(3X) and \fBnonl\fP(3X) as both input +.I and +output options, +but no longer; +see \fB\%curs_inopts\fP(3X). .SH SEE ALSO -.na -\fBcurses\fP(3X), -\fBcurs_addch\fP(3X), -\fBcurs_clear\fP(3X), -\fBcurs_initscr\fP(3X), -\fBcurs_scroll\fP(3X), -\fBcurs_refresh\fP(3X), -\fBcurs_variables\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_addch\fP(3X), +\fB\%curs_clear\fP(3X), +\fB\%curs_initscr\fP(3X), +\fB\%curs_refresh\fP(3X), +\fB\%curs_scroll\fP(3X), +\fB\%curs_variables\fP(3X) diff --git a/upstream/archlinux/man3/curs_overlay.3x b/upstream/archlinux/man3/curs_overlay.3x index 9c6561e7..9f7d5562 100644 --- a/upstream/archlinux/man3/curs_overlay.3x +++ b/upstream/archlinux/man3/curs_overlay.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2020-2021,2022 Thomas E. Dickey * +.\" Copyright 2020-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2013,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,28 +27,36 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_overlay.3x,v 1.22 2022/02/12 20:05:11 tom Exp $ -.TH curs_overlay 3X "" -.na -.hy 0 +.\" $Id: curs_overlay.3x,v 1.43 2024/04/20 21:20:07 tom Exp $ +.TH curs_overlay 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .SH NAME -\fBoverlay\fP, -\fBoverwrite\fP, -\fBcopywin\fP \- overlay and manipulate overlapped \fBcurses\fP windows -.ad -.hy +\fB\%overlay\fP, +\fB\%overwrite\fP, +\fB\%copywin\fP \- +overlay \fIcurses\fR windows and manipulate them .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint overlay(const WINDOW *\fIsrcwin\fB, WINDOW *\fIdstwin\fB);\fR -.br -\fBint overwrite(const WINDOW *\fIsrcwin\fB, WINDOW *\fIdstwin\fB);\fR -.br -\fBint copywin(const WINDOW *\fIsrcwin\fB, WINDOW *\fIdstwin\fB, int \fIsminrow\fB,\fR +.nf +\fB#include <curses.h> +.PP +\fBint overlay(const WINDOW *\fIsrcwin\fP, WINDOW *\fIdstwin\fP); +\fBint overwrite(const WINDOW *\fIsrcwin\fP, WINDOW *\fIdstwin\fP); +\fBint copywin(const WINDOW *\fIsrcwin\fP, WINDOW *\fIdstwin\fP, int \fIsminrow\fP, \fBint \fIsmincol\fB, int \fIdminrow\fB, int \fIdmincol\fB, int \fIdmaxrow\fB,\fR \fBint \fIdmaxcol\fB, int \fIoverlay\fB);\fR +.fi .SH DESCRIPTION -.SS overlay, overwrite +.SS "overlay, overwrite" The \fBoverlay\fP and \fBoverwrite\fP routines overlay \fIsrcwin\fP on top of \fIdstwin\fP. \fIscrwin\fP and \fIdstwin\fP are not required @@ -56,7 +64,6 @@ to be the same size; only text where the two windows overlap is copied. The difference is that \fBoverlay\fP is non-destructive (blanks are not copied) whereas \fBoverwrite\fP is destructive. .SS copywin -.PP The \fBcopywin\fP routine provides a finer granularity of control over the \fBoverlay\fP and \fBoverwrite\fP routines. As in the \fBprefresh\fP routine, @@ -67,9 +74,10 @@ If the argument \fIoverlay\fP is \fBtrue\fP, then copying is non-destructive, as in \fBoverlay\fP. .SH RETURN VALUE -Routines that return an integer return \fBERR\fP upon failure, and \fBOK\fP -(SVr4 only specifies "an integer value other than \fBERR\fP") upon successful -completion. +These routines return the integer \fBERR\fP upon failure and an \fBOK\fP +(SVr4 specifies only +\*(``an integer value other than \fBERR\fP\*('') +upon successful completion. .PP X/Open defines no error conditions. In this implementation, @@ -80,9 +88,11 @@ if some part of the window would be placed off-screen. .SH NOTES Note that \fBoverlay\fP and \fBoverwrite\fP may be macros. .SH PORTABILITY -The XSI Curses standard, Issue 4 describes these functions (adding the const -qualifiers). +These functions are described in X/Open Curses, Issue 4, +which adds \fI\%const\fP qualifiers to the arguments. It further specifies their behavior in the presence of characters with multibyte renditions (not yet supported in this implementation). .SH SEE ALSO -\fBcurses\fP(3X), \fBcurs_pad\fP(3X), \fBcurs_refresh\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_pad\fP(3X), +\fB\%curs_refresh\fP(3X) diff --git a/upstream/archlinux/man3/curs_pad.3x b/upstream/archlinux/man3/curs_pad.3x index da25f3b7..f23b2df4 100644 --- a/upstream/archlinux/man3/curs_pad.3x +++ b/upstream/archlinux/man3/curs_pad.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,127 +27,161 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_pad.3x,v 1.29 2022/02/12 20:05:11 tom Exp $ +.\" $Id: curs_pad.3x,v 1.61 2024/04/27 17:55:43 tom Exp $ +.TH curs_pad 3X 2024-04-27 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.TH curs_pad 3X "" -.na -.hy 0 .SH NAME -\fBnewpad\fP, -\fBsubpad\fP, -\fBprefresh\fP, -\fBpnoutrefresh\fP, -\fBpechochar\fP, -\fBpecho_wchar\fP \- create and display \fBcurses\fP pads -.ad -.hy +\fB\%newpad\fP, +\fB\%subpad\fP, +\fB\%prefresh\fP, +\fB\%pnoutrefresh\fP, +\fB\%pechochar\fP, +\fB\%pecho_wchar\fP \- +create and display \fIcurses\fR pads .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBWINDOW *newpad(int \fInlines\fB, int \fIncols\fB);\fR -.br -\fBWINDOW *subpad(WINDOW *\fIorig\fB, int \fInlines\fB, int \fIncols\fB,\fR +.nf +\fB#include <curses.h> +.PP +\fBWINDOW *newpad(int \fInlines\fP, int \fIncols\fP); +\fBWINDOW *subpad(WINDOW *\fIparent\fP, int \fInlines\fP, int \fIncols\fP, \fBint \fIbegin_y\fB, int \fIbegin_x\fB);\fR -.br +.PP \fBint prefresh(WINDOW *\fIpad\fB, int \fIpminrow\fB, int \fIpmincol\fB,\fR \fBint \fIsminrow\fB, int \fIsmincol\fB, int \fIsmaxrow\fB, int \fIsmaxcol\fB);\fR -.br \fBint pnoutrefresh(WINDOW *\fIpad\fB, int \fIpminrow\fB, int \fIpmincol\fB,\fR \fBint \fIsminrow\fB, int \fIsmincol\fB, int \fIsmaxrow\fB, int \fIsmaxcol\fB);\fR -.br +.PP \fBint pechochar(WINDOW *\fIpad\fB, chtype \fIch\fB);\fR -.br \fBint pecho_wchar(WINDOW *\fIpad\fB, const cchar_t *\fIwch\fB);\fR +.fi .SH DESCRIPTION -.SS newpad -The \fBnewpad\fP routine creates and returns a pointer to a new pad data -structure with the given number of lines, \fInlines\fP, and columns, -\fIncols\fP. -A pad is like a window, except that it is not restricted by the -screen size, and is not necessarily associated with a particular part of the -screen. -Pads can be used when a large window is needed, and only a part of the -window will be on the screen at one time. -Automatic refreshes of pads -(e.g., from scrolling or echoing of input) do not occur. +A +.I curses +.I pad +is like a window, +except that it is not restricted by the screen size, +and is not necessarily associated with a particular part of the screen. +Pads can be used when a large window is needed, +only part of which is to be visible on the screen. +Pads are not automatically refreshed by scrolling or input-echoing +operations. .PP -It is not -legal to call \fBwrefresh\fP with a \fIpad\fP as an argument; the routines -\fBprefresh\fP or \fBpnoutrefresh\fP should be called instead. -Note that these -routines require additional parameters to specify the part of the pad to be -displayed and the location on the screen to be used for the display. +Pads cannot be refreshed with \fB\%wrefresh\fP(3X); +use +.B \%prefresh +or +.B \%pnoutrefresh +instead. +.SS newpad +\fB\%newpad\fP creates and returns a pointer to a new pad data structure +with the given number of lines, +.IR nlines , +and columns, +.IR ncols . .SS subpad -.PP -The \fBsubpad\fP routine creates and returns a pointer to a subwindow within a -pad with the given number of lines, \fInlines\fP, and columns, \fIncols\fP. -Unlike \fBsubwin\fP, which uses screen coordinates, the window is at position -(\fIbegin\fR_\fIx\fB,\fR \fIbegin\fR_\fIy\fR) on the pad. -The window is -made in the middle of the window \fIorig\fP, so that changes made to one window -affect both windows. -During the use of this routine, it will often be -necessary to call \fBtouchwin\fP or \fBtouchline\fP on \fIorig\fP before -calling \fBprefresh\fP. -.SS prefresh, pnoutrefresh -.PP -The \fBprefresh\fP and \fBpnoutrefresh\fP routines are analogous to -\fBwrefresh\fP and \fBwnoutrefresh\fP except that they relate to pads instead -of windows. -The additional parameters are needed to indicate what part of the -pad and screen are involved. +.B \%subpad +creates and returns a pointer to a subwindow within a pad +with the given number of lines, +.IR nlines , +and columns, +.IR ncols . +Unlike \fB\%subwin\fP(3X), +which uses screen coordinates, +the new pad is placed at position +.RI ( begin_y , +.IR begin_x ) +relative to its parent. +Thus, +changes made to one pad can affect both. +When operating on a subpad, +it is often necessary to call \fB\%touchwin\fP(3X) or +\fB\%touchline\fP(3X) on +.I parent +before calling +.BR \%prefresh . +.SS "prefresh, pnoutrefresh" +.B \%prefresh\fP +and +.B \%pnoutrefresh +are analogous to \fB\%wrefresh\fP(3X) and \fB\%wnoutrefresh\fP(3X) +except that they operate on pads rather than windows. +They require additional parameters are needed to indicate what portions +of the pad and screen are involved. .bP -The \fIpminrow\fP and \fIpmincol\fP parameters specify the upper -left-hand corner of the rectangle to be displayed in the pad. +.I pminrow +and +.I pmincol +specify the upper left-hand corner of a rectangular view of the pad. .bP -The \fIsminrow\fP, -\fIsmincol\fP, \fIsmaxrow\fP, and \fIsmaxcol\fP -parameters specify the edges of the -rectangle to be displayed on the screen. +.IR sminrow , +.IR smincol , +.IR smaxrow , +and +.I smaxcol +specify the vertices of the rectangle to be displayed on the screen. .PP -The lower right-hand corner of the -rectangle to be displayed in the pad is calculated from the screen coordinates, +The lower right-hand corner +of the rectangle to be displayed in the pad +is calculated from the screen coordinates, since the rectangles must be the same size. -Both rectangles must be entirely -contained within their respective structures. -Negative values of -\fIpminrow\fP, \fIpmincol\fP, \fIsminrow\fP, or \fIsmincol\fP are treated as if -they were zero. +Both rectangles must be entirely contained +within their respective structures. +.I curses +treats +negative values of any of these parameters as zero. .SS pechochar -.PP -The \fBpechochar\fP routine is functionally equivalent to a call to \fBaddch\fP -followed by a call to \fBrefresh\fP(3X), -a call to \fBwaddch\fP followed by a call -to \fBwrefresh\fP, or a call to \fBwaddch\fP followed by a call to -\fBprefresh\fP. -The knowledge that only a single character is being output is -taken into consideration and, for non-control characters, a considerable -performance gain might be seen by using these routines instead of their -equivalents. -In the case of \fBpechochar\fP, the last location of the pad on -the screen is reused for the arguments to \fBprefresh\fP. +.B \%pechochar +is functionally equivalent to calling \fB\%waddch\fP(3X) followed by +.BR \%prefresh . +It suggests to the +.I curses +optimizer that only a single character is being output; +a considerable performance benefit may be thus enjoyed. +The location of the character +.I ch +written to the pad is used to populate the arguments to +.BR \%prefresh . .SS pecho_wchar -.PP -The \fBpecho_wchar\fP function is the analogous wide-character -form of \fBpechochar\fP. -It outputs one character to a pad and immediately refreshes the pad. -It does this by a call to \fBwadd_wch\fP followed by a call to \fBprefresh\fP. +.B \%pecho_wchar\fP +is functionally equivalent to calling \fB\%wadd_wch\fP(3X) followed by +.BR \%prefresh . +It suggests to the +.I curses +optimizer that only a single wide character is being output; +a considerable performance benefit may be thus enjoyed. +The location of the character +.I wch +written to the pad is used to populate the arguments to +.BR \%prefresh . .SH RETURN VALUE -Routines that return an integer return \fBERR\fP upon failure and \fBOK\fP -(SVr4 only specifies "an integer value other than \fBERR\fP") upon successful -completion. +Functions that return an integer return \fBERR\fP upon failure and +\fBOK\fP +(SVr4 specifies only +\*(``an integer value other than \fBERR\fP\*('') +upon successful completion. .PP -Routines that return pointers return \fBNULL\fP on error, and set \fBerrno\fP -to \fBENOMEM\fP. +Functions that return pointers return \fBNULL\fP on error, +and set \fB\%errno\fP to \fB\%ENOMEM\fP. .PP -X/Open does not define any error conditions. +X/Open Curses does not specify any error conditions. In this implementation .RS 3 .TP 5 -\fBprefresh\fP and \fBpnoutrefresh\fP +\fB\%prefresh\fP and \fB\%pnoutrefresh\fP return an error if the window pointer is null, or if the window is not really a pad or @@ -157,19 +191,19 @@ if the minimum coordinates are greater than the maximum. \fBpechochar\fP returns an error if the window is not really a pad, and the associated call -to \fBwechochar\fP returns an error. +to \fB\%wechochar\fP returns an error. .TP 5 \fBpecho_wchar\fP returns an error if the window is not really a pad, and the associated call -to \fBwecho_wchar\fP returns an error. +to \fB\%wecho_wchar\fP returns an error. .RE .SH NOTES -Note that \fBpechochar\fP may be a macro. +\fB\%pechochar\fP may be a macro. .SH PORTABILITY -BSD curses has no \fIpad\fP feature. +BSD \fIcurses\fP has no \fIpad\fP feature. .PP -SVr2 curses (1986) provided the \fBnewpad\fP and related functions, +SVr2 \fIcurses\fP (1986) provided the \fB\%newpad\fP and related functions, documenting them in a single line each. SVr3 (1987) provided more extensive documentation. .PP @@ -184,59 +218,63 @@ and select text from the pad. .PP The two uses may be related. .PP -The XSI Curses standard, Issue 4 describes these functions, +X/Open Curses, Issue 4 describes these functions, without significant change from the SVr3 documentation. It describes no error conditions. -The behavior of \fBsubpad\fP if the parent window is not +The behavior of \fB\%subpad\fP if the parent window is not a pad is undocumented, and is not checked by the vendor Unix implementations: .bP -SVr4 curses sets a flag in the \fBWINDOW\fP structure in \fBnewpad\fP -which tells if the window is a \fIpad\fP. +SVr4 \fIcurses\fP sets a flag in the \fI\%WINDOW\fP structure in +\fB\%newpad\fP which tells if the window is a \fIpad\fP. .IP However, it uses this information only in -\fBwaddch\fP (to decide if it should call \fBwrefresh\fP) and -\fBwscrl\fP (to avoid scrolling a pad), -and does not check in \fBwrefresh\fP to ensure that the pad +\fB\%waddch\fP (to decide if it should call \fB\%wrefresh\fP) and +\fB\%wscrl\fP (to avoid scrolling a pad), +and does not check in \fB\%wrefresh\fP to ensure that the pad is refreshed properly. .bP -Solaris X/Open Curses checks if a window is a pad in \fBwnoutrefresh\fP, +Solaris \fI\%xcurses\fP checks whether a window is a pad in +\fB\%wnoutrefresh\fP, returning \fBERR\fP in that case. .IP -However, it only sets the flag for subwindows if the parent window is a pad. -Its \fBnewpad\fP function does not set this information. +However, +it only sets the flag for subwindows if the parent window is a pad. +Its \fB\%newpad\fP function does not set this information. Consequently, the check will never fail. .IP -It makes no comparable check in \fBpnoutrefresh\fP, +It makes no comparable check in \fB\%pnoutrefresh\fP, though interestingly enough, a comment in the source code states that the lack of a check was an MKS extension. .bP -NetBSD 7 curses -sets a flag in the \fBWINDOW\fP structure for \fBnewpad\fP and \fBsubpad\fP, -using this to help with the distinction between \fBwnoutrefresh\fP -and \fBpnoutrefresh\fP. +NetBSD 7 \fIcurses\fP +sets a flag in the \fI\%WINDOW\fP structure +for \fB\%newpad\fP and \fB\%subpad\fP, +using this to help with the distinction between \fB\%wnoutrefresh\fP +and \fB\%pnoutrefresh\fP. .IP It does not check for the case where a subwindow is created in -a pad using \fBsubwin\fP or \fBderwin\fP. +a pad using \fB\%subwin\fP or \fB\%derwin\fP. .IP -The \fBdupwin\fP function returns a regular window when duplicating a pad. -Likewise, \fBgetwin\fP always returns a window, even if the saved +The \fB\%dupwin\fP function returns a regular window when duplicating a pad. +Likewise, \fB\%getwin\fP always returns a window, even if the saved data was from a pad. .PP This implementation .bP -sets a flag in the \fBWINDOW\fP structure for \fBnewpad\fP and \fBsubpad\fP, +sets a flag in the \fI\%WINDOW\fP structure +for \fB\%newpad\fP and \fB\%subpad\fP, .bP -allows a \fBsubwin\fP or \fBderwin\fP call to succeed having a pad parent by +allows a \fB\%subwin\fP or \fB\%derwin\fP call to succeed having a pad parent by forcing the subwindow to be a pad, .bP -checks in both \fBwnoutrefresh\fP and \fBpnoutrefresh\fP to ensure +checks in both \fB\%wnoutrefresh\fP and \fB\%pnoutrefresh\fP to ensure that pads and windows are handled distinctly, and .bP -ensures that \fBdupwin\fP and \fBgetwin\fP treat +ensures that \fB\%dupwin\fP and \fB\%getwin\fP treat pads versus windows consistently. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_refresh\fP(3X), -\fBcurs_touch\fP(3X), -\fBcurs_addch\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_addch\fP(3X), +\fB\%curs_refresh\fP(3X), +\fB\%curs_touch\fP(3X) diff --git a/upstream/archlinux/man3/curs_print.3x b/upstream/archlinux/man3/curs_print.3x index 31c7dc46..57345fe7 100644 --- a/upstream/archlinux/man3/curs_print.3x +++ b/upstream/archlinux/man3/curs_print.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,19 +27,23 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_print.3x,v 1.19 2022/02/12 20:05:11 tom Exp $ -.TH curs_print 3X "" +.\" $Id: curs_print.3x,v 1.38 2024/03/16 15:35:01 tom Exp $ +.TH curs_print 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBmcprint\fP \- ship binary data to printer +\fB\%mcprint\fP \- +write binary data to printer using \fIterminfo\fR capabilities .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint mcprint(char *\fIdata\fB, int \fIlen\fB);\fR +.nf +\fB#include <curses.h> +.PP +\fBint mcprint(char *\fIdata\fP, int \fIlen\fP); +.fi .SH DESCRIPTION This function uses the \fBmc5p\fP or \fBmc4\fP and \fBmc5\fP capabilities, if they are present, to ship given data to a printer attached to the terminal. .PP -Note that the \fBmcprint\fP code has no way to do flow control with the printer +Note that the \fB\%mcprint\fP code has no way +to do flow control with the printer or to know how much buffering it has. Your application is responsible for keeping the rate of writes to the printer below its continuous throughput rate @@ -49,24 +53,37 @@ Dot-matrix printers and rule of thumb is to sleep for a second after shipping each 80-character line. . .SH RETURN VALUE -The \fBmcprint\fP function returns \fBERR\fP if the write operation aborted +The \fB\%mcprint\fP function returns \fBERR\fP if the write operation aborted for some reason. -In this case, \fBerrno\fP will contain either an error associated +In this case, \fB\%errno\fP will contain either an error associated with \fBwrite\fP(2) or one of the following: .TP 5 -ENODEV +\fBENODEV\fP Capabilities for printer redirection do not exist. .TP 5 -ENOMEM +\fBENOMEM\fP Couldn't allocate sufficient memory to buffer the printer write. .PP -When \fBmcprint\fP succeeds, it returns the number of characters actually +When \fB\%mcprint\fP succeeds, it returns the number of characters actually sent to the printer. +.SH EXTENSIONS +\fB\%mcprint\fP was designed for +\fB\%ncurses\fP(3X), +and was not found in SVr4 +.IR curses , +4.4BSD +.IR curses , +or any other previous curses implementation. .SH PORTABILITY -The \fBmcprint\fP call was designed for \fBncurses\fP(3X), and is not found -in SVr4 curses, 4.4BSD curses, or any other previous version of curses. +Applications employing this +.I \%ncurses +extension should condition its use on the visibility of the +.B \%NCURSES_VERSION +preprocessor macro. .SH BUGS -Padding in the \fBmc5p\fP, \fBmc4\fP and \fBmc5\fP capabilities will not be -interpreted. +Padding in the +\fBmc5p\fP, +\fBmc4\fP, and +\fBmc5\fP capabilities is not interpreted. .SH SEE ALSO -\fBcurses\fP(3X) +\fB\%curses\fP(3X) diff --git a/upstream/archlinux/man3/curs_printw.3x b/upstream/archlinux/man3/curs_printw.3x index ee9ea8a3..8f6cec79 100644 --- a/upstream/archlinux/man3/curs_printw.3x +++ b/upstream/archlinux/man3/curs_printw.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,128 +27,179 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_printw.3x,v 1.32 2022/02/12 20:05:11 tom Exp $ -.TH curs_printw 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_printw.3x,v 1.53 2024/04/20 19:18:18 tom Exp $ +.TH curs_printw 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBprintw\fP, -\fBwprintw\fP, -\fBmvprintw\fP, -\fBmvwprintw\fP, -\fBvwprintw\fP, \fBvw_printw\fP \- print formatted output in \fBcurses\fP windows -.ad -.hy +\fB\%printw\fP, +\fB\%wprintw\fP, +\fB\%mvprintw\fP, +\fB\%mvwprintw\fP, +\fB\%vwprintw\fP, +\fB\%vw_printw\fP \- +write formatted output to a \fIcurses\fR window .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint printw(const char *\fIfmt\fB, ...);\fR -.br -\fBint wprintw(WINDOW *\fIwin\fB, const char *\fIfmt\fB, ...);\fR -.br -\fBint mvprintw(int \fIy\fB, int \fIx\fB, const char *\fIfmt\fB, ...);\fR -.br -\fBint mvwprintw(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char *\fIfmt\fB, ...);\fR -.br -\fBint vw_printw(WINDOW *\fIwin\fB, const char *\fIfmt\fB, va_list \fIvarglist\fB);\fR -.sp -/* obsolete */ -.br -\fBint vwprintw(WINDOW *\fIwin\fB, const char *\fIfmt\fB, va_list \fIvarglist\fB);\fR +.nf +\fB#include <curses.h> +.PP +\fBint printw(const char *\fIfmt\fP, ...); +\fBint wprintw(WINDOW *\fIwin\fP, const char *\fIfmt\fP, ...); +\fBint mvprintw(int \fIy\fP, int \fIx\fP, const char *\fIfmt\fP, ...); +\fBint mvwprintw(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIfmt\fP, ...); +.PP +\fBint vw_printw(WINDOW *\fIwin\fP, const char *\fIfmt\fP, va_list \fIvarglist\fP); +.PP +\fI/* obsolete */\fP +\fBint vwprintw(WINDOW *\fIwin\fP, const char *\fIfmt\fP, va_list \fIvarglist\fP); +.fi .SH DESCRIPTION -The \fBprintw\fP, \fBwprintw\fP, \fBmvprintw\fP and \fBmvwprintw\fP -routines are analogous to \fBprintf\fP [see \fBprintf\fP(3)]. -In -effect, the string that would be output by \fBprintf\fP is output -instead as though \fBwaddstr\fP were used on the given window. +\fB\%printw\fP, +\fB\%wprintw\fP, +\fB\%mvprintw\fP, +and +\fB\%mvwprintw\fP +are analogous to \fI\%printf\fP(3). +In effect, +the string that would be output by \fI\%printf\fP(3) is instead output +as though \fB\%waddstr\fP(3X) were used with +.I win +(or +.BR \%stdscr ) +as its first argument. .PP -The \fBvwprintw\fP and \fBvw_printw\fP routines are analogous -to \fBvprintf\fP [see \fBprintf\fP(3)] -and perform a \fBwprintw\fP using a variable argument list. -The third argument is a \fBva_list\fP, a pointer to a -list of arguments, as defined in \fB<stdarg.h>\fP. +\fB\%vwprintw\fP +and +\fB\%vw_printw\fP are analogous to \fI\%vprintf\fP(3), +and perform a \fB\%wprintw\fP using a variable argument list. +The third argument is a \fI\%va_list\fP, +a pointer to a list of arguments, +as defined in \fI\%stdarg.h\fP. .SH RETURN VALUE -Routines that return an integer return \fBERR\fP upon failure and \fBOK\fP -(SVr4 only specifies "an integer value other than \fBERR\fP") upon successful -completion. +These functions return +.B ERR +upon failure and +.B OK +upon success. .PP -X/Open defines no error conditions. -In this implementation, -an error may be returned if it cannot allocate enough memory for the -buffer used to format the results. -It will return an error if the window pointer is null. +In +.IR \%ncurses , +failure occurs if the library cannot allocate enough memory for the +buffer into which the output is formatted, +or if the window pointer +.I win +is null. +.PP +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. +.SH NOTES +No wide character counterpart functions are defined by the +\*(``wide\*('' +.I \%ncurses +configuration nor by any standard. +To format and write a wide-character string to a +.I curses +window, +consider using \fI\%swprintf\fP(3) and \fB\%waddwstr\fP(3X) or similar. +.SH PORTABILITY +X/Open Curses, +Issue 4 describes these functions. +It specifies no error conditions for them. .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. +.I \%ncurses +defines \fB\%vw_printw\fP and \fB\%vwprintw\fP identically to support +legacy applications. +However, +the latter is obsolete. +.bP +X/Open Curses, +Issue 4 Version 2 (1996), +marked \fB\%vwprintw\fP as requiring \fI\%varargs.h\fP and +\*(``TO BE WITHDRAWN\*('', +and specified \fB\%vw_printw\fP using the \fI\%stdarg.h\fP interface. +.bP +X/Open Curses, Issue 5, Draft 2 +(December 2007) marked \fBvwprintw\fP (along with +\fBvwscanw\fP and the \fItermcap\fP interface) as withdrawn. +After incorporating review comments, +this became +X/Open Curses, Issue 7 (2009). +.bP +.I \%ncurses +provides \fB\%vwprintw\fP, +but marks it as deprecated. .SH HISTORY -While \fBprintw\fP was implemented in 4BSD, -it was unused until 4.2BSD (which used it in games). -That early version of curses was before the ANSI C standard. -It did not use <varargs.h>, though that was available. -In 1991 (a couple of years after SVr4 was generally available, +While \fB\%printw\fP was implemented in 4BSD +(November 1980), +.\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=4BSD/usr/src/lib/\ +.\" libcurses/printw.c +it was unused until 4.2BSD +(August 1983), +which employed it for games. +That early version of +.I curses +preceded the ANSI C standard of 1989. +It did not use \fI\%varargs.h\fP, +though that had been available since Seventh Edition Unix (1979). +.\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=V7/usr/include/\ +.\" varargs.h +In 1991 +(a couple of years after SVr4 was generally available, and after the C standard was published), other developers updated the library, -using <stdarg.h> internally in 4.4BSD curses. +using \fI\%stdarg.h\fP internally in 4.4BSD +.IR curses . Even with this improvement, -BSD curses did not use function prototypes (or even declare -functions) in the <curses.h> header until 1992. +BSD +.I curses +did not use function prototypes +(nor even declare functions) +in \fI\%curses.h\fP until 1992. .PP -SVr2 documented -\fBprintw\fP, -\fBwprintw\fP -tersely as \*(``printf on \fIstdscr\fP\*('' and -tersely as \*(``printf on \fIwin\fP\*('', respectively. +SVr2 (1984) documented \fB\%printw\fP and \fB\%wprintw\fP tersely as +\*(``printf on \fB\%stdscr\fP\*('' and +\*(``printf on \fIwin\fP\*('', +respectively. .PP -SVr3 added -\fBmvprintw\fP, and -\fBmvwprintw\fP, with a three-line summary saying that they were analogous -to \fBprintf\fP(3), -explaining that the string which would be output from \fBprintf\fP(3) would -instead be output using \fBwaddstr\fP on the given window. -SVr3 also added \fBvwprintw\fP, saying that the third parameter -is a \fBva_list\fP, defined in <varargs.h>, -and referring the reader to the manual pages for \fIvarargs\fP and -\fBvprintf\fP for detailed descriptions. +SVr3 (1987) added \fB\%mvprintw\fP and \fB\%mvwprintw\fP, +with a three-line summary asserting that they were analogous to +\fI\%printf\fP(3), +explaining that the string that \fI\%printf\fP(3) would write to the +standard output stream would instead be output using \fB\%waddstr\fP to +the given window. +SVr3 also implemented \fB\%vwprintw\fP, +describing its third parameter as a \fI\%va_list\fP, +defined in \fI\%varargs.h\fP, +and referred the reader to the manual pages for \fI\%varargs\fP and +\fI\%vprintf\fP for detailed descriptions. .PP -SVr4 added no new variations of \fBprintw\fP, -but provided for using <varargs.h> or <stdarg.h> to define the \fBva_list\fP -type. +SVr4 (1989) introduced no new variations of \fI\%printw\fP, +but provided for using either \fI\%varargs.h\fP or \fI\%stdarg.h\fP to +define the \fI\%va_list\fP type. +.\" either header declares "va_list", but only one can be used .PP -X/Open Curses added \fBvw_printw\fP to replace \fBvwprintw\fP, -stating that its \fBva_list\fP definition requires <stdarg.h>. -.SH PORTABILITY -In this implementation, \fBvw_printw\fP and \fBvwprintw\fP are equivalent, -to support legacy applications. -However, the latter (\fBvwprintw\fP) is obsolete: -.bP -The XSI Curses standard, Issue 4 described these functions. -The function -\fBvwprintw\fP is marked TO BE WITHDRAWN, and is to be replaced by a function -\fBvw_printw\fP using the \fB<stdarg.h>\fP interface. -.bP -The Single Unix Specification, Version 2 states that -\fBvw_printw\fP is preferred to \fBvwprintw\fP since the latter requires -including \fB<varargs.h>\fP, which -cannot be used in the same file as \fB<stdarg.h>\fP. -This implementation uses \fB<stdarg.h>\fP for both, -because that header is included in \fB<curses.h\fP>. -.bP -X/Open Curses, Issue 5 (December 2007) marked \fBvwprintw\fP (along with -\fBvwscanw\fP and the termcap interface) as withdrawn. +X/Open Curses, Issue 4 (1995), +defined \fB\%vw_printw\fP to replace \fB\%vwprintw\fP, +stating that its \fI\%va_list\fP type is defined in \fI\%stdarg.h\fP. .SH SEE ALSO -.na -\fBcurses\fP(3X), -\fBcurs_addstr\fP(3X), -\fBcurs_scanw\fP(3X), -\fBcurs_termcap\fP(3X), -\fBprintf\fP(3), -\fBvprintf\fP(3). +\fB\%curses\fP(3X), +\fB\%curs_addstr\fP(3X), +\fB\%curs_scanw\fP(3X), +\fB\%printf\fP(3), +\fB\%vprintf\fP(3) diff --git a/upstream/archlinux/man3/curs_refresh.3x b/upstream/archlinux/man3/curs_refresh.3x index c2cd8468..f864125f 100644 --- a/upstream/archlinux/man3/curs_refresh.3x +++ b/upstream/archlinux/man3/curs_refresh.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2016 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,44 +27,45 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_refresh.3x,v 1.26 2023/03/11 20:41:02 tom Exp $ -.TH curs_refresh 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_refresh.3x,v 1.46 2024/04/20 21:20:07 tom Exp $ +.TH curs_refresh 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBdoupdate\fP, -\fBredrawwin\fP, -\fBrefresh\fP, -\fBwnoutrefresh\fP, -\fBwredrawln\fP, -\fBwrefresh\fP \- refresh \fBcurses\fP windows and lines -.ad -.hy +\fB\%doupdate\fP, +\fB\%redrawwin\fP, +\fB\%refresh\fP, +\fB\%wnoutrefresh\fP, +\fB\%wredrawln\fP, +\fB\%wrefresh\fP \- +refresh \fIcurses\fR windows or lines thereupon .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint refresh(void);\fP -.br -\fBint wrefresh(WINDOW *\fIwin\fB);\fR -.br -\fBint wnoutrefresh(WINDOW *\fIwin\fB);\fR -.br -\fBint doupdate(void);\fP -.sp -\fBint redrawwin(WINDOW *\fIwin\fB);\fR -.br -\fBint wredrawln(WINDOW *\fIwin\fB, int \fIbeg_line\fB, int \fInum_lines\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBint refresh(void); +\fBint wrefresh(WINDOW *\fIwin\fP); +\fBint wnoutrefresh(WINDOW *\fIwin\fP); +\fBint doupdate(void); +.PP +\fBint redrawwin(WINDOW *\fIwin\fP); +\fBint wredrawln(WINDOW *\fIwin\fP, int \fIbeg_line\fP, int \fInum_lines\fP); +.fi .SH DESCRIPTION -.SS refresh/wrefresh +.SS "refresh, wrefresh" The \fBrefresh\fP and \fBwrefresh\fP routines (or \fBwnoutrefresh\fP and \fBdoupdate\fP) must be called to get actual output to the terminal, as other routines merely manipulate data structures. @@ -76,17 +77,18 @@ same, using \fBstdscr\fP as the default window. Unless \fBleaveok\fP(3X) has been enabled, the physical cursor of the terminal is left at the location of the cursor for that window. -.SS wnoutrefresh/doupdate -.PP +.SS "wnoutrefresh, doupdate" The \fBwnoutrefresh\fP and \fBdoupdate\fP routines allow multiple updates with more efficiency than \fBwrefresh\fP alone. In addition to all the window structures, \fBcurses\fP keeps two data structures representing the terminal screen: .bP -a \fIphysical screen\fP, describing what is actually on the screen, and +a \fIphysical screen\fP, +describing what is actually on the screen, and .bP -a \fIvirtual screen\fP, describing what the programmer wants to have on the screen. +a \fIvirtual screen\fP, +describing what the programmer wants to have on the screen. .PP The routine \fBwrefresh\fP works by .bP @@ -120,18 +122,18 @@ order and the overlap region will be modified only when it is explicitly changed. (But see the section on \fBPORTABILITY\fP below for a warning about exploiting this behavior.) -.SS wredrawln/redrawwin -.PP +.SS "wredrawln, redrawwin" The \fBwredrawln\fP routine indicates to \fBcurses\fP that some screen lines are corrupted and should be thrown away before anything is written over them. It touches the indicated lines (marking them changed). The routine \fBredrawwin\fP touches the entire window. .SH RETURN VALUE -Routines that return an integer return \fBERR\fP upon failure, and \fBOK\fP -(SVr4 only specifies "an integer value other than \fBERR\fP") upon successful -completion. +These routines return the integer \fBERR\fP upon failure and \fBOK\fP +(SVr4 specifies only +\*(``an integer value other than \fBERR\fP\*('') +upon successful completion. .PP -X/Open does not define any error conditions. +X/Open Curses does not specify any error conditions. In this implementation .RS 3 .TP 5 @@ -147,7 +149,7 @@ if the associated call to \fBtouchln\fP returns an error. .SH NOTES Note that \fBrefresh\fP and \fBredrawwin\fP may be macros. .SH PORTABILITY -The XSI Curses standard, Issue 4 describes these functions. +X/Open Curses, Issue 4 describes these functions. .PP Whether \fBwnoutrefresh\fP copies to the virtual screen the entire contents of a window or just its changed portions has never been well-documented in @@ -158,6 +160,6 @@ implementations. Instead, you can do an explicit \fBtouchwin\fP before the \fBwnoutrefresh\fP call to guarantee an entire-contents copy anywhere. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_outopts\fP(3X) -\fBcurs_variables\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_outopts\fP(3X) +\fB\%curs_variables\fP(3X) diff --git a/upstream/archlinux/man3/curs_scanw.3x b/upstream/archlinux/man3/curs_scanw.3x index ca78012e..cbad301a 100644 --- a/upstream/archlinux/man3/curs_scanw.3x +++ b/upstream/archlinux/man3/curs_scanw.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,143 +27,229 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_scanw.3x,v 1.32 2022/02/12 20:05:11 tom Exp $ -.TH curs_scanw 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_scanw.3x,v 1.53 2024/04/20 19:18:18 tom Exp $ +.TH curs_scanw 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBscanw\fP, -\fBwscanw\fP, -\fBmvscanw\fP, -\fBmvwscanw\fP, -\fBvwscanw\fP, \fBvw_scanw\fP \- convert formatted input from a \fBcurses\fP window +\fB\%scanw\fP, +\fB\%wscanw\fP, +\fB\%mvscanw\fP, +\fB\%mvwscanw\fP, +\fB\%vwscanw\fP, +\fB\%vw_scanw\fP \- +read formatted input from a \fIcurses\fR window .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint scanw(const char *\fIfmt\fB, ...);\fR -.br -\fBint wscanw(WINDOW *\fIwin\fB, const char *\fIfmt\fB, ...);\fR -.br -\fBint mvscanw(int \fIy\fB, int \fIx\fB, const char *\fIfmt\fB, ...);\fR -.br -\fBint mvwscanw(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char *\fIfmt\fB, ...);\fR -.sp -\fBint vw_scanw(WINDOW *\fIwin\fB, const char *\fIfmt\fB, va_list \fIvarglist\fB);\fR -.sp -/* obsolete */ -.br -\fBint vwscanw(WINDOW *\fIwin\fB, const char *\fIfmt\fB, va_list \fIvarglist\fB);\fR -.SH DESCRIPTION -The \fBscanw\fP, \fBwscanw\fP and \fBmvscanw\fP routines are analogous to -\fBscanf\fP [see \fBscanf\fP(3)]. -The effect of these routines is as though -\fBwgetstr\fP were called on the window, and the resulting line used as input -for \fBsscanf\fP(3). -Fields which do not map to a variable in the \fIfmt\fP -field are lost. +.nf +\fB#include <curses.h> .PP -The \fBvwscanw\fP and \fBvw_scanw\fP routines are analogous to \fBvscanf\fP(3). -They perform a \fBwscanw\fP using a variable argument list. -The third argument is a \fBva_list\fP, -a pointer to a list of arguments, as defined in \fB<stdarg.h>\fP. -.SH RETURN VALUE -\fBvwscanw\fP returns \fBERR\fP on failure and an integer equal to the -number of fields scanned on success. +\fBint scanw(const char *\fIfmt\fP, ...); +\fBint wscanw(WINDOW *\fIwin\fP, const char *\fIfmt\fP, ...); +\fBint mvscanw(int \fIy\fP, int \fIx\fP, const char *\fIfmt\fP, ...); +\fBint mvwscanw(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIfmt\fP, ...); .PP -Applications may use the return value from the \fBscanw\fP, \fBwscanw\fP, -\fBmvscanw\fP and \fBmvwscanw\fP routines to determine the number of fields -which were mapped in the call. +\fBint vw_scanw(WINDOW *\fIwin\fP, const char *\fIfmt\fP, va_list \fIvarglist\fP); .PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. -.SH HISTORY -While \fBscanw\fP was implemented in 4BSD, -none of the BSD releases used it until 4.4BSD (in a game). -That early version of curses was before the ANSI C standard. -It did not use <varargs.h>, though that was available. -In 1991 (a couple of years after SVr4 was generally available, -and after the C standard was published), -other developers updated the library, -using <stdarg.h> internally in 4.4BSD curses. -Even with this improvement, -BSD curses did not use function prototypes (or even declare -functions) in the <curses.h> header until 1992. +\fI/* obsolete */\fP +\fBint vwscanw(WINDOW *\fIwin\fP, const char *\fIfmt\fP, va_list \fIvarglist\fP); +.fi +.SH DESCRIPTION +\fB\%scanw\fP, +\fB\%wscanw\fP, +\fB\%mvscanw\fP, +and +\fB\%mvwscanw\fP +are analogous to \fI\%scanf\fP(3). +In effect, +they call \fB\%wgetstr\fP(3X) with +.I win +(or +.BR \%stdscr ) +as its first argument, +then attempt conversion of the resulting string with \fI\%vsscanf\fP(3). +Fields in the string that do not map to a variable in the \fIfmt\fP +parameter are discarded. .PP -SVr2 documented -\fBscanw\fP, -\fBwscanw\fP -tersely as \*(``scanf through \fIstdscr\fP\*('' and -tersely as \*(``scanf through \fIwin\fP\*('', respectively. +\fB\%vwscanw\fP +and +\fB\%vw_scanw\fP are analogous to \fI\%vscanf\fP(3), +and perform a \fB\%wscanw\fP using a variable argument list. +The third argument is a \fI\%va_list\fP, +a pointer to a list of arguments, +as defined in \fI\%stdarg.h\fP. +.SH RETURN VALUE +These functions return +.B ERR +upon failure and otherwise a count of successful conversions; +this quantity may be zero. .PP -SVr3 added -\fBmvscanw\fP, and -\fBmvwscanw\fP, with a three-line summary saying that they were analogous -to \fBscanf\fP(3), -explaining that the string which would be output from \fBscanf\fP(3) would -instead be output using \fBwaddstr\fP on the given window. -SVr3 also added \fBvwscanw\fP, saying that the third parameter -is a \fBva_list\fP, defined in <varargs.h>, -and referring the reader to the manual pages for \fIvarargs\fP and -\fBvprintf\fP for detailed descriptions. -(Because the SVr3 documentation does not mention \fBvscanf\fP, -that reference to \fBvprintf\fP may not be an error). +In +.IR \%ncurses , +failure occurs if \fI\%vsscanf\fP(3) returns +\fBEOF\fP, +or if the window pointer +.I win +is null. .PP -SVr4 added no new variations of \fBscanw\fP, -but provided for using <varargs.h> or <stdarg.h> to define the \fBva_list\fP -type. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. +.SH NOTES +No wide character counterpart functions are defined by the +\*(``wide\*('' +.I \%ncurses +configuration nor by any standard. +They are unnecessary: +to retrieve and convert a wide-character string from a +.I curses +terminal keyboard, +use these functions with the \fI\%scanf\fP(3) conversions \*(``%lc\*('' +and \*(``%ls\*('' for wide characters and strings, +respectively. .PP -X/Open Curses added \fBvw_scanw\fP to replace \fBvwscanw\fP, -stating that its \fBva_list\fP definition requires <stdarg.h>. +.I \%ncurses +implements \fI\%vsscanf\fP(3) internally if it is unavailable when the +library is configured. .SH PORTABILITY -In this implementation, \fBvw_scanw\fP and \fBvwscanw\fP are equivalent, -to support legacy applications. -However, the latter (\fBvwscanw\fP) is obsolete: +X/Open Curses, +Issue 4 describes these functions. +It specifies no error conditions for them. +.PP +.I \%ncurses +defines \fB\%vw_scanw\fP and \fB\%vwscanw\fP identically to support +legacy applications. +However, +the latter is obsolete. .bP -The XSI Curses standard, Issue 4 described these functions, -noting that the function -\fBvwscanw\fP is marked TO BE WITHDRAWN, and is to be replaced by a function -\fBvw_scanw\fP using the \fB<stdarg.h>\fP interface. +X/Open Curses, +Issue 4 Version 2 (1996), +marked \fB\%vwscanw\fP as requiring \fI\%varargs.h\fP and +\*(``TO BE WITHDRAWN\*('', +and specified \fB\%vw_scanw\fP using the \fI\%stdarg.h\fP interface. .bP -The Single Unix Specification, Version 2 states that -\fBvw_scanw\fP is preferred to \fBvwscanw\fP since the latter requires -including \fB<varargs.h>\fP, which -cannot be used in the same file as \fB<stdarg.h>\fP. -This implementation uses \fB<stdarg.h>\fP for both, because that header -is included in \fB<curses.h\fP>. +X/Open Curses, +Issue 5, +Draft 2 (December 2007) marked \fB\%vwscanw\fP (along with +\fB\%vwscanw\fP and the \fItermcap\fP interface) as withdrawn. +After incorporating review comments, +this became +X/Open Curses, Issue 7 (2009). .bP -X/Open Curses, Issue 5 (December 2007) marked \fBvwscanw\fP (along with -\fBvwprintw\fP and the termcap interface) as withdrawn. -.LP -Both XSI and The Single Unix Specification, Version 2 state that these -functions return \fBERR\fP or \fBOK\fP. +.I \%ncurses +provides \fB\%vwscanw\fP, +but marks it as deprecated. +.PP +X/Open Curses Issues 4 and 7 both state that these functions return +\fBERR\fP or \fBOK\fP. +This is likely an erratum. .bP -Since the underlying \fBscanf\fP(3) can return the number of items scanned, -and the SVr4 code was documented to use this feature, -this is probably an editing error which was introduced in XSI, -rather than being done intentionally. +Since the underlying \fI\%scanf\fP(3) returns the number of successful +conversions, +and SVr4 +.I curses +was documented to use this feature, +this may have been an editorial solecism introduced by X/Open, +rather than an intentional change. .bP -This implementation returns the number of items scanned, -for compatibility with SVr4 curses. -As of 2018, NetBSD curses also returns the number of items scanned. -Both ncurses and NetBSD curses call \fBvsscanf\fP to scan the string, +This implementation retains compatibility with SVr4 +.IR curses . +As of 2018, +NetBSD +.I curses +also returns the number of successful conversions. +Both +.I \%ncurses\fP +and NetBSD +.I curses +call \fI\%vsscanf\fP(3) to scan the string, which returns \fBEOF\fP on error. .bP -Portable applications should only test if the return value is \fBERR\fP, -since the \fBOK\fP value (zero) is likely to be misleading. +Portable applications should test only if the return value is \fBERR\fP, +and not compare it to \fBOK\fP, +since that value (zero) might be misleading. .IP -One possible way to get useful results would be to use a "%n" conversion -at the end of the format string to ensure that something was processed. +One portable way to get useful results would be to use a \*(``%n\*('' +conversion at the end of the format string, +and check the value of the corresponding variable to determine how many +conversions succeeded. +.SH HISTORY +\fB\%scanw\fP was implemented in 4BSD +(November 1980); +.\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=4BSD/usr/src/lib/\ +.\" libcurses/scanw.c +that early version of +.I curses +preceded the ANSI C standard of 1989. +The function was unused in Berkeley distributions for over ten years, +until 4.4BSD, +which employed it in a game. +The 4BSD \fB\%scanw\fP did not use \fI\%varargs.h\fP, +though that had been available since Seventh Edition Unix (1979). +.\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=V7/usr/include/\ +.\" varargs.h +In 1991 +(a couple of years after SVr4 was generally available, +and after the C standard was published), +other developers updated the library, +using \fI\%stdarg.h\fP internally in 4.4BSD +.IR curses . +Even with this improvement, +BSD +.I curses +did not use function prototypes +(nor even declare functions) +in \fI\%curses.h\fP until 1992. +.PP +SVr2 (1984) documented \fB\%scanw\fP and \fB\%wscanw\fP tersely as +\*(``scanf through \fB\%stdscr\fP\*('' and +\*(``scanf through \fIwin\fP\*('', +respectively. +.PP +SVr3 (1987) added +\fB\%mvscanw\fP, and +\fB\%mvwscanw\fP, stating +.RS +.PP +\*(``[t]hese routines correspond to \fIscanf\fP(3S), +as do their arguments and return values. +\fB\%wgetstr\fP() is called on the window, +and the resulting line is used as input for the scan.\*('' +.RE +.PP +SVr3 also implemented \fB\%vwscanw\fP, +describing its third parameter as a \fI\%va_list\fP, +defined in \fI\%varargs.h\fP, +and referred the reader to the manual pages for \fI\%varargs\fP and +\fI\%vprintf\fP for detailed descriptions. +(Because the SVr3 documentation does not mention \fI\%vscanf\fP, +the reference to \fI\%vprintf\fP might not be an error). +.PP +SVr4 (1989) introduced no new variations of \fI\%scanw\fP, +but provided for using either \fI\%varargs.h\fP or \fI\%stdarg.h\fP to +define the \fI\%va_list\fP type. +.\" either header declares "va_list", but only one can be used +.PP +X/Open Curses, Issue 4 (1995), +defined \fI\%vw_scanw\fP to replace \fI\%vwscanw\fP, +stating that its \fI\%va_list\fP type is defined in \fI\%stdarg.h\fP. .SH SEE ALSO -.na -\fBcurses\fP(3X), -\fBcurs_getstr\fP(3X), -\fBcurs_printw\fP(3X), -\fBcurs_termcap\fP(3X), -\fBscanf\fP(3). +\fB\%curses\fP(3X), +\fB\%curs_getstr\fP(3X), +\fB\%curs_printw\fP(3X), +\fB\%scanf\fP(3), +\fB\%vscanf\fP(3) diff --git a/upstream/archlinux/man3/curs_scr_dump.3x b/upstream/archlinux/man3/curs_scr_dump.3x index 7829fade..c1bf7c8c 100644 --- a/upstream/archlinux/man3/curs_scr_dump.3x +++ b/upstream/archlinux/man3/curs_scr_dump.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,94 +27,126 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_scr_dump.3x,v 1.20 2022/02/12 20:05:11 tom Exp $ -.TH curs_scr_dump 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_scr_dump.3x,v 1.43 2024/04/20 18:54:36 tom Exp $ +.TH curs_scr_dump 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBscr_dump\fP, -\fBscr_restore\fP, -\fBscr_init\fP, -\fBscr_set\fP \- read (write) a \fBcurses\fP screen from (to) a file -.ad -.hy +\fB\%scr_dump\fP, +\fB\%scr_restore\fP, +\fB\%scr_init\fP, +\fB\%scr_set\fP \- +read/write a \fIcurses\fR screen from/to a file .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint scr_dump(const char *\fIfilename\fB);\fR -.br -\fBint scr_restore(const char *\fIfilename\fB);\fR -.br -\fBint scr_init(const char *\fIfilename\fB);\fR -.br -\fBint scr_set(const char *\fIfilename\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBint scr_dump(const char *\fIfilename\fP); +\fBint scr_restore(const char *\fIfilename\fP); +\fBint scr_init(const char *\fIfilename\fP); +\fBint scr_set(const char *\fIfilename\fP); +.fi .SH DESCRIPTION +.I curses +provides applications the ability to write the contents of the screen +to a file and read them back. +To read/write a window +(rather than the whole screen) +from/to a file, +use \fB\%getwin\fP(3X) and +\fB\%putwin\fP(3X), +respectively. .SS scr_dump -.PP -The \fBscr_dump\fP routine dumps the current contents -of the \fIvirtual screen\fP -to the file \fIfilename\fP. +\fB\%scr_dump\fP writes to +.I filename +the contents of the virtual screen; +see \fB\%curscr\fP(3X). .SS scr_restore -.PP -The \fBscr_restore\fP routine sets the \fIvirtual screen\fP to the contents -of \fIfilename\fP, which must have been written using \fBscr_dump\fP. -The next call to \fBdoupdate\fP restores -the \fIphysical screen\fP to the way it looked in the dump file. +\fB\%scr_restore\fP updates the virtual screen to contain the contents +of +.I filename +(if it was validly written with \fB\%scr_dump\fP). +No refresh is performed; +after performing any further desired updates, +call \fB\%doupdate\fP(3X) or similar. .SS scr_init +\fB\%scr_init\fP reads +.IR filename , +using it to initialize +.I curses +data structures describing the state of the terminal screen. +If these data are valid, +.I curses +bases its next update of the screen on this information rather than +clearing it and starting from scratch. .PP -The \fBscr_init\fP routine reads in the contents of \fIfilename\fP and uses -them to initialize the \fBcurses\fP data structures about what the terminal -currently has on its screen. -If the data is determined to be valid, -\fBcurses\fP bases its next update of the screen on this information rather -than clearing the screen and starting from scratch. -\fBscr_init\fP is used -after \fBinitscr\fP(3X) or a \fBsystem\fP(3) call to share -the screen with another process which has done a \fBscr_dump\fP after its -\fBendwin\fP(3X) call. -The data is declared invalid +The data fail the validity check .bP -if the terminfo capabilities \fBrmcup\fP and \fBnrrmc\fP exist, also +if the terminal employs +.I \%term\%info +capabilities +.B \%exit_ca_mode +.RB ( \%rmcup ) +or +.B \%non_rev_rmcup +.RB ( \%nrrmc ) +are defined, +or .bP -if the terminal has been written to since the preceding \fBscr_dump\fP call. -.SS scr_set +if +.I curses +knows that the terminal has been written to since the preceding +\fB\%scr_dump\fP call. .PP +\fB\%scr_init\fP could be used after \fB\%initscr\fP(3X) or +\fB\%system\fP(3) to share the screen with another process that has +done a \fBscr_dump\fP after \fB\%endwin\fP(3X). +.SS scr_set The \fBscr_set\fP routine is a combination of \fBscr_restore\fP and \fBscr_init\fP. It tells the program that the information in \fIfilename\fP is what is currently on the screen, and also what the program wants on the screen. This can be thought of as a screen inheritance function. -.PP -To read (write) a window from (to) a file, use the \fBgetwin\fP and -\fBputwin\fP routines [see \fBcurs_util\fP(3X)]. .SH RETURN VALUE -All routines return the integer \fBERR\fP upon failure and \fBOK\fP -upon success. +These functions return \fBOK\fP on success and \fBERR\fP on failure. .PP -X/Open defines no error conditions. +X/Open defines no failure conditions. In this implementation, -each will return an error if the file cannot be opened. +each function fails if it cannot open +.IR filename . .SH NOTES -Note that \fBscr_init\fP, \fBscr_set\fP, and \fBscr_restore\fP may be macros. +\fB\%scr_init\fP, +\fB\%scr_set\fP, +and +\fB\%scr_restore\fP may be macros. .SH PORTABILITY -The XSI Curses standard, Issue 4, describes these functions (adding the const -qualifiers). +X/Open Curses, +Issue 4 describes these functions. +.PP +.\" SVID 4, p. 529 +SVr4 omitted the +.I \%const +qualifiers. .PP -The SVr4 docs merely say under \fBscr_init\fP that the dump data is also -considered invalid "if the time-stamp of the tty is old" but do not define -\*(``old\*(''. +SVr4 documentation describes \fB\%scr_init\fP such that the dump data is +also considered invalid \*(``if the time-stamp of the tty is old\*('' +but does not define \*(``old\*(''. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_initscr\fP(3X), -\fBcurs_refresh\fP(3X), -\fBcurs_util\fP(3X), -\fBscr_dump\fP(5), -\fBsystem\fP(3) +\fB\%curses\fP(3X), +\fB\%curs_initscr\fP(3X), +\fB\%curs_refresh\fP(3X), +\fB\%curs_util\fP(3X), +\fB\%system\fP(3), +\fB\%scr_dump\fP(5) diff --git a/upstream/archlinux/man3/curs_scroll.3x b/upstream/archlinux/man3/curs_scroll.3x index ee8288c9..109db199 100644 --- a/upstream/archlinux/man3/curs_scroll.3x +++ b/upstream/archlinux/man3/curs_scroll.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2006,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,69 +27,111 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_scroll.3x,v 1.23 2023/03/11 20:41:05 tom Exp $ -.TH curs_scroll 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' -.na -.hy 0 +.\" $Id: curs_scroll.3x,v 1.43 2024/04/20 18:54:36 tom Exp $ +.TH curs_scroll 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. .SH NAME -\fBscroll\fP, -\fBscrl\fP, -\fBwscrl\fP \- scroll a \fBcurses\fP window -.ad -.hy +\fB\%scroll\fP, +\fB\%scrl\fP, +\fB\%wscrl\fP \- +scroll a \fIcurses\fR window .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint scroll(WINDOW *\fIwin\fB);\fR -.sp -\fBint scrl(int \fIn\fB);\fR -.br -\fBint wscrl(WINDOW *\fIwin\fB, int \fIn\fB);\fR -.br -.SH DESCRIPTION -The \fBscroll\fP routine scrolls the window up one line. -This involves moving -the lines in the window data structure. -As an optimization, if the scrolling -region of the window is the entire screen, -the \fIphysical screen\fP may be scrolled at the same time. +.nf +\fB#include <curses.h> +.PP +\fBint scroll(WINDOW *\fIwin\fP); .PP -For positive \fIn\fP, the \fBscrl\fP and \fBwscrl\fP routines scroll the -window up \fIn\fP lines (line \fIi\fP+\fIn\fP becomes \fIi\fP); otherwise -scroll the window down \fIn\fP lines. -This involves moving the lines in the -window character image structure. -The current cursor position is not changed. +\fBint scrl(int \fIn\fP); +\fBint wscrl(WINDOW *\fIwin\fP, int \fIn\fP); +.fi +.SH DESCRIPTION +\fBscroll\fP scrolls the given window up one line. +That is, +every visible line we might number +.I i +becomes line +.IR i "\-1." +The text of the top line in the window disappears and the bottom line +is populated with blank characters; +see \fB\%bkgd\fP(3X) or \fB\%bkgrnd\fP(3X). +As an optimization, +if the scrolling region of the window is the entire screen, +the physical screen may be scrolled at the same time; +see \fB\%curscr\fP(3X). .PP -For these functions to work, scrolling must be enabled via \fBscrollok\fP(3X). -.SH RETURN VALUE -These routines return \fBERR\fP upon failure, and \fBOK\fP (SVr4 only specifies -"an integer value other than \fBERR\fP") upon successful completion. +\fB\%scrl\fP and \fB\%wscrl\fP scroll +.B \%stdscr +or the specified window up or down depending on the sign of +.IR n . +.bP +For positive +.IR n , +line \fIi\fP+\fIn\fP becomes \fIi\fP (scrolling up); +.bP +for negative +.IR n , +line \fIi\fP-\fIn\fP becomes \fIi\fP (scrolling down). .PP -X/Open defines no error conditions. +The cursor does not move. +These functions perform no operation unless scrolling is enabled for the +window via \fB\%scrollok\fP(3X). +.SH "RETURN VALUE" +These functions return +.B ERR +upon failure and +.B OK +upon success. .PP -This implementation returns an error -if the window pointer is null, or -if scrolling is not enabled in the window, e.g., with \fBscrollok\fP(3X). +.I \%ncurses +returns \fBERR\fP if scrolling is not enabled in the window, +for example with \fB\%scrollok\fP(3X), +or if the +.I \%WINDOW +pointer is null. .SH NOTES -Note that \fBscrl\fP and \fBscroll\fP may be macros. -.PP -The SVr4 documentation says that the optimization of physically scrolling -immediately if the scroll region is the entire screen \*(``is\*('' performed, not -\*(``may be\*('' performed. -This implementation deliberately does not guarantee -that this will occur, to leave open the possibility of smarter -optimization of multiple scroll actions on the next update. +Unusually, +there is no \fB\%wscroll\fP function; +\fBscroll\fP behaves as one would expect \fB\%wscroll\fP to, +accepting a \fI\%WINDOW\fP pointer argument. .PP -Neither the SVr4 nor the XSI documentation specify whether the current -attribute or -current color-pair of blanks generated by the scroll function is zeroed. -Under this implementation it is. +\fB\%scrl\fP and \fB\%scroll\fP may be implemented as macros. .SH PORTABILITY -The XSI Curses standard, Issue 4 describes these functions. +X/Open Curses, +Issue 4 describes these functions. +It defines no error conditions. +.PP +SVr4 specifies only +\*(``an integer value other than \fBERR\fP\*('' as a successful return +value. +.PP +SVr4 indicates that the optimization of physically scrolling immediately +if the scroll region is the entire screen \*(``is\*('' performed, +not \*(``may be\*('' performed. +.I \%ncurses +deliberately does not guarantee that this will occur, +to leave open the possibility of smarter optimization of multiple scroll +actions on the next update. +.PP +Neither SVr4 +.I curses +nor X/Open Curses specify whether the current attribute or current color +pair of blanks generated by the scroll function are zeroed. +.I \%ncurses +does so. .SH SEE ALSO -\fBcurses\fP(3X), \fBcurs_outopts\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_outopts\fP(3X) diff --git a/upstream/archlinux/man3/curs_slk.3x b/upstream/archlinux/man3/curs_slk.3x index 0816785e..8f0664c4 100644 --- a/upstream/archlinux/man3/curs_slk.3x +++ b/upstream/archlinux/man3/curs_slk.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,105 +27,96 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_slk.3x,v 1.44 2022/10/29 22:44:14 tom Exp $ -.TH curs_slk 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_slk.3x,v 1.71 2024/04/20 18:54:36 tom Exp $ +.TH curs_slk 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBslk_init\fP, -\fBslk_set\fP, -\fBslk_wset\fP, -\fBslk_refresh\fP, -\fBslk_noutrefresh\fP, -\fBslk_label\fP, -\fBslk_clear\fP, -\fBslk_restore\fP, -\fBslk_touch\fP, -\fBslk_attron\fP, -\fBslk_attrset\fP, -\fBslk_attroff\fP, -\fBslk_attr_on\fP, -\fBslk_attr_set\fP, -\fBslk_attr_off\fP, -\fBslk_attr\fP, -\fBslk_color\fP, -\fBextended_slk_color\fP \- \fBcurses\fP soft label routines -.ad -.hy +\fB\%slk_init\fP, +\fB\%slk_set\fP, +\fB\%slk_wset\fP, +\fB\%slk_refresh\fP, +\fB\%slk_noutrefresh\fP, +\fB\%slk_label\fP, +\fB\%slk_clear\fP, +\fB\%slk_restore\fP, +\fB\%slk_touch\fP, +\fB\%slk_attron\fP, +\fB\%slk_attrset\fP, +\fB\%slk_attroff\fP, +\fB\%slk_attr_on\fP, +\fB\%slk_attr_set\fP, +\fB\%slk_attr_off\fP, +\fB\%slk_attr\fP, +\fB\%slk_color\fP, +\fB\%extended_slk_color\fP \- +\fIcurses\fR soft label key routines .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint slk_init(int \fIfmt\fB);\fR -.sp -\fBint slk_set(int \fIlabnum\fB, const char *\fIlabel\fB, int \fIfmt\fB);\fR -.br -\fBint slk_wset(int \fIlabnum\fB, const wchar_t *\fIlabel\fB, int \fIfmt\fB);\fR -.sp -\fBchar *slk_label(int \fIlabnum\fB);\fR -.sp -\fBint slk_refresh(void);\fP -.br -\fBint slk_noutrefresh(void);\fP -.br -\fBint slk_clear(void);\fP -.br -\fBint slk_restore(void);\fP -.br -\fBint slk_touch(void);\fP -.sp -\fBint slk_attron(const chtype \fIattrs\fB);\fR -.br -\fBint slk_attroff(const chtype \fIattrs\fB);\fR -.br -\fBint slk_attrset(const chtype \fIattrs\fB);\fR -.br -\fBint slk_attr_on(attr_t \fIattrs\fB, void* \fIopts\fB);\fR -.br -\fBint slk_attr_off(const attr_t \fIattrs\fB, void * \fIopts\fB);\fR -.br -\fBint slk_attr_set(const attr_t \fIattrs\fB, short \fIpair\fB, void* \fIopts\fB);\fR -.br -/* extension */ -.br -\fBattr_t slk_attr(void);\fP -.sp -\fBint slk_color(short \fIpair\fB);\fR -.br -/* extension */ -.br -\fBint extended_slk_color(int \fIpair\fB);\fR +.nf +\fB#include <curses.h> +.PP +\fBint slk_init(int \fIfmt\fP); +.PP +\fBint slk_set(int \fIlabnum\fP, const char *\fIlabel\fP, int \fIalign\fP); +\fBint slk_wset(int \fIlabnum\fP, const wchar_t *\fIlabel\fP, int \fIalign\fP); +.PP +\fBchar *slk_label(int \fIlabnum\fP); +.PP +\fBint slk_refresh(void); +\fBint slk_noutrefresh(void); +\fBint slk_clear(void); +\fBint slk_restore(void); +\fBint slk_touch(void); +.PP +\fBint slk_attron(const chtype \fIattrs\fP); +\fBint slk_attroff(const chtype \fIattrs\fP); +\fBint slk_attrset(const chtype \fIattrs\fP); +\fBint slk_attr_on(attr_t \fIattrs\fP, void *\fIopts\fP); +\fBint slk_attr_off(const attr_t \fIattrs\fP, void *\fIopts\fP); +\fBint slk_attr_set(const attr_t \fIattrs\fP, short \fIpair\fP, void*\fIopts\fP); +\fI/* extension */ +\fBattr_t slk_attr(void); +.PP +\fBint slk_color(short \fIpair\fP); +\fI/* extension */ +\fBint extended_slk_color(int \fIpair\fP); +.fi .SH DESCRIPTION -The slk* functions manipulate the set of soft function-key labels that exist on -many terminals. +These functions manipulate the soft function key labels that some +hardware terminals support. For those terminals that do not have soft labels, -\fBcurses\fP takes over the bottom line of \fBstdscr\fP, reducing the size of -\fBstdscr\fP and the variable \fBLINES\fP. -\fBcurses\fP standardizes on eight -labels of up to eight characters each. -In addition to this, the ncurses -implementation supports a mode where it simulates 12 labels of up to five -characters each. -This is useful for PC-like enduser devices. -ncurses simulates this mode by taking over up to two lines at +\fIcurses\fP takes over the bottom line of \fB\%stdscr\fP, +reducing its vertical size and the value of \fBLINES\fP by one. +By default, +\fIcurses\fP uses eight labels of up to eight characters each. +.PP +\fI\%ncurses\fP +furthermore supports a mode comprising twelve labels of up to five +characters each, +following a convention associated with the IBM PC/AT keyboard. +\fI\%ncurses\fP simulates this mode by taking over up to two lines at the bottom of the screen; it does not try to use any hardware support for this mode. .SS Initialization -.PP -The \fBslk_init\fP routine must be called before \fBinitscr\fP or \fBnewterm\fP -is called. -If \fBinitscr\fP eventually uses a line from \fBstdscr\fP to +\fB\%slk_init\fP must be called before \fB\%initscr\fP or +\fB\%newterm\fP. +If \fB\%initscr\fP eventually uses a line from \fB\%stdscr\fP to emulate the soft labels, -then \fIfmt\fP determines how the labels are arranged on the screen: -.RS 3 +then \fIfmt\fP determines how the labels are arranged on the screen. .TP 3 .B 0 indicates a 3\-2\-3 arrangement of @@ -139,85 +130,104 @@ indicates the PC-like 4\-4\-4 mode. .TP 3 .B 3 is again the PC-like 4\-4\-4 mode, -but in addition an index line is generated, helping the user to -identify the key numbers easily. -.RE +but in addition an index line is generated, +helping the user to associate each label with its numbered function key. +\fBLINES\fP and the vertical size of \fB\%stdscr\fP are further reduced. .SS Labels -.PP -The \fBslk_set\fP routine -(and the \fBslk_wset\fP routine for the wide-character library) -has three parameters: -.RS 3 -.TP 5 +Populate the labels with normal strings +(\fB\%slk_set\fP) +or wide-character strings +(\fB\%slk_wset\fP). +Each function takes three parameters. +.TP 8 \" "labnum" + 2n .I labnum is the label number, from \fB1\fP to \fB8\fP -(12 if \fIfmt\fP in \fBslk_init\fP is \fB2\fP or \fB3\fP); +(12 if \fIfmt\fP in \fB\%slk_init\fP is \fB2\fP or \fB3\fP); .TP .I label is be the string to put on the label, up to eight -(five if \fIfmt\fP in \fBslk_init\fP is \fB2\fP or \fB3\fP) +(five if \fIfmt\fP in \fB\%slk_init\fP is \fB2\fP or \fB3\fP) characters in length. -A null string or a null pointer sets up a blank label. +A empty string or a null pointer sets up a blank label. .TP -.I fmt -is either -\fB0\fP, \fB1\fP, or \fB2\fP, indicating whether the label is to be -left-justified, centered, or right-justified, respectively, within the -label. -.RE -.PP -The \fBslk_label\fP routine returns the current label for label number -\fIlabnum\fP, with leading and trailing blanks stripped. -.SS Screen updates -.PP -The \fBslk_refresh\fP and \fBslk_noutrefresh\fP routines correspond to -the \fBwrefresh\fP and \fBwnoutrefresh\fP routines. +.I align +is +.BR 0 , +.BR 1 , +or +.BR 2 , +aligning +.I label +to the left, +center, +or right, +respectively, +within the 8 (5) character cells housing it. .PP -The \fBslk_clear\fP routine clears the soft labels from the screen. +\fB\%slk_label\fP obtains the string assigned to label number +\fIlabnum\fP, +with any leading and trailing blanks stripped. +.SS "Screen Updates" +\fB\%slk_refresh\fP and \fB\%slk_noutrefresh\fP affect the soft key +label lines as \fB\%wrefresh\fP and \fB\%wnoutrefresh\fP do the +.I curses +window. .PP -The \fBslk_restore\fP routine restores the soft labels to the screen -after a \fBslk_clear\fP has been performed. +The \fB\%slk_clear\fP routine clears the soft labels from the screen. .PP -The \fBslk_touch\fP routine forces all the soft labels to be output -the next time a \fBslk_noutrefresh\fP is performed. -.SS Video attributes +The \fB\%slk_restore\fP routine restores the soft labels to the screen +after a \fB\%slk_clear\fP has been performed. .PP +The \fB\%slk_touch\fP routine forces all the soft labels to be output +the next time a \fB\%slk_noutrefresh\fP is performed. +.SS "Video Attributes" The -\fBslk_attron\fP, \fBslk_attrset\fP, \fBslk_attroff\fP and \fBslk_attr\fP +\fB\%slk_attron\fP, +\fB\%slk_attrset\fP, +\fB\%slk_attroff\fP, +and +\fB\%slk_attr\fP routines correspond to -\fBattron\fP, \fBattrset\fP, \fBattroff\fP and \fBattr_get\fP, respectively. -They have an effect only if soft labels are simulated on the bottom line of -the screen. -The default highlight for soft keys is A_STANDOUT (as in -System V curses, which does not document this fact). +\fB\%attron\fP, +\fB\%attrset\fP, +\fB\%attroff\fP, +and +\fB\%attr_get\fP, +respectively. +They have an effect only if soft labels are simulated on the bottom line +of the screen. +The default highlight for soft key labels is \fB\%A_STANDOUT\fP +(as in System\ V \fIcurses\fP, +which does not document this fact). .SS Colors -.PP -The \fBslk_color\fP routine corresponds to \fBcolor_set\fP. +The \fB\%slk_color\fP routine corresponds to \fB\%color_set\fP. It has an effect only if soft labels are simulated on the bottom line of the screen. .PP -Because \fBslk_color\fP accepts only \fBshort\fP (signed 16-bit integer) values, +Because \fB\%slk_color\fP accepts +only \fIshort\fP +(signed 16-bit integer) +values, this implementation provides -\fBextended_slk_color\fP which accepts an integer value, e.g., 32-bits. -. +\fB\%extended_slk_color\fP, +which accepts an \fIint\fP value of at least 32 bits. .SH RETURN VALUE -These routines return \fBERR\fP upon failure -and \fBOK\fP (SVr4 specifies only "an integer value other than \fBERR\fP") +Routines that return an integer return \fBERR\fP upon failure and +\fBOK\fP +(SVr4 specifies only +\*(``an integer value other than \fBERR\fP\*('') upon successful completion. .PP -X/Open defines no error conditions. +X/Open Curses defines no error conditions. +.PP In this implementation .RS 3 .TP 5 \fBslk_attr\fP returns the attribute used for the soft keys. .TP 5 -.na -.hy 0 \fBslk_attroff\fP, \fBslk_attron\fP, \fBslk_clear\fP, \fBslk_noutrefresh\fP, \fBslk_refresh\fP, \fBslk_touch\fP -.ad -.hy return an error if the terminal or the softkeys were not initialized. .TP 5 @@ -228,12 +238,12 @@ if the terminal or the softkeys were not initialized. \fBslk_attr_set\fP returns an error if the terminal or the softkeys were not initialized, or -the color pair is outside the range 0..COLOR_PAIRS\-1. +the color pair is outside the range 0..\fBCOLOR_PAIRS\fP\-1. .TP 5 \fBslk_color\fP returns an error if the terminal or the softkeys were not initialized, or -the color pair is outside the range 0..COLOR_PAIRS\-1. +the color pair is outside the range 0..\fBCOLOR_PAIRS\fP\-1. .TP 5 \fBslk_init\fP returns an error @@ -249,68 +259,55 @@ the \fIlabnum\fP parameter is outside the range of label counts, or if the format parameter is outside the range 0..2, or if memory for the labels cannot be allocated. .RE -.SH HISTORY -SVr3 introduced these functions: - slk_clear - slk_init - slk_label - slk_noutrefresh - slk_refresh - slk_restore - slk_set - slk_touch -.PP -SVr4 added these functions: - slk_attroff - slk_attron - slk_attrset - slk_start -.PP -X/Open Curses added these: - slk_attr_off - slk_attr_on - slk_attr_set - slk_color - slk_wset +.SH NOTES +Most applications would use \fB\%slk_noutrefresh\fP because a +\fB\%wrefresh\fP is likely to follow soon. .SH EXTENSIONS -.PP -X/Open Curses documents the \fIopts\fP argument as reserved for future use, +X/Open Curses documents the \fIopts\fP argument +as reserved for future use, saying that it must be null. This implementation -uses that parameter in ABI 6 for the functions which have a color-pair +uses that parameter in ABI 6 for the functions which have a color pair parameter to support extended color pairs. .PP -For functions which modify the color, e.g., \fBslk_attr_set\fP, -if \fIopts\fP is set it is treated as a pointer to \fBint\fP, -and used to set the color pair instead of the \fBshort\fP pair parameter. -.SH NOTES -Most applications would use \fBslk_noutrefresh\fP because a -\fBwrefresh\fP is likely to follow soon. +For functions which modify the color, +e.g., +\fB\%slk_attr_set\fP, +if \fIopts\fP is set it is treated as a pointer to \fIint\fP, +and used to set the color pair instead of the \fIshort\fP pair +parameter. .SH PORTABILITY -The XSI Curses standard, Issue 4, described the soft-key functions, -with some differences from SVr4 curses: +X/Open Curses, +Issue 4 describes these functions, +with some differences from SVr4 \fIcurses\fP: .bP -It added functions like the SVr4 -attribute-manipulation functions \fBslk_attron\fP, -\fBslk_attroff\fP, \fBslk_attrset\fP, -but which use \fBattr_t\fP parameters (rather than \fBchtype\fP), +X/Open added functions like the SVr4 attribute-manipulation functions +\fB\%slk_attron\fP, +\fB\%slk_attroff\fP, +and +\fB\%slk_attrset\fP, +but which use \fI\%attr_t\fP parameters +(rather than \fI\%chtype\fP), along with a reserved \fIopts\fP parameter. .IP -Two of these new functions (unlike the SVr4 functions) have no provision -for color: \fBslk_attr_on\fP and \fBslk_attr_off\fP. +Two of these new functions +(unlike the SVr4 functions) +have no provision for color: +\fB\%slk_attr_on\fP and \fB\%slk_attr_off\fP. .IP -The third function (\fBslk_attr_set\fP) has a color-pair parameter. +The third function \%(\fBslk_attr_set\fP) has a color pair parameter. .bP -It added \fBconst\fP qualifiers to parameters (unnecessarily), and +It added \fIconst\fP qualifiers to parameters (unnecessarily), +and .bP -It added \fBslk_color\fP. +It added \fB\%slk_color\fP. .PP -Although \fBslk_start\fP is declared in the curses header file, +Although \fB\%slk_start\fP is declared in the \fIcurses\fP header file, it was not documented by SVr4 other than its presence in a list of libtermlib.so.1 symbols. Reading the source code (i.e., Illumos): .bP -\fBslk_start\fP has two parameters: +\fB\%slk_start\fP has two parameters: .RS .bP \fIng\fP (number of groups) and @@ -320,39 +317,63 @@ Reading the source code (i.e., Illumos): .bP Soft-key groups are an array of \fIng\fP integers. .bP -In SVr4, \fBslk_init\fP calls \fBslk_start\fP passing a null for \fIgp\fP. -For this case, \fBslk_start\fP uses the number of groups \fIng\fP -(3 for the 3-2-3 layout, 2 for the 4-4 layout) which \fBslk_init\fP provided. +In SVr4, \fB\%slk_init\fP calls \fB\%slk_start\fP passing a null for \fIgp\fP. +For this case, \fB\%slk_start\fP uses the number of groups \fIng\fP +(3 for the 3-2-3 layout, 2 for the 4-4 layout) which \fB\%slk_init\fP provided. .IP If \fIng\fP is neither 2 or 3, -\fBslk_start\fP checks the terminfo \fIfln\fP (label_format) capability, +\fB\%slk_start\fP checks the terminfo \fBfln\fP (label_format) capability, interpreting that as a comma-separated list of numbers, e.g., \*(``3,2,3\*('' for the 3-2-3 layout. .IP -Finally, if there is no \fIfln\fP capability, \fBslk_start\fP returns ERR. +Finally, if there is no \fBfln\fP capability, +\fB\%slk_start\fP returns \fBERR\fP. .bP -If \fBslk_start\fP is given a non-null \fIgp\fP, +If \fB\%slk_start\fP is given a non-null \fIgp\fP, it copies the \fIng\fP elements of the group of soft-keys, up to 16. .IP -If there are more than 16 elements, \fBslk_start\fP returns an error. +If there are more than 16 elements, \fB\%slk_start\fP returns an error. .bP -The format codes \fB2\fP and \fB3\fP for \fBslk_init\fP -were added by ncurses in 1996. +The format codes \fB2\fP and \fB3\fP for \fB\%slk_init\fP +were added by \fI\%ncurses\fP in 1996. PDCurses 2.4 added this feature in 2001. .PP -The function \fBslk_attr\fP was added by ncurses in 1996. +The function \fB\%slk_attr\fP was added by \fI\%ncurses\fP in 1996. .PP X/Open Curses does not specify a limit for the number of colors and color pairs which a terminal can support. -However, in its use of \fBshort\fP for the parameters, +However, in its use of \fIshort\fP for the parameters, it carries over SVr4's implementation detail for the compiled terminfo database, which uses signed 16-bit numbers. This implementation provides extended versions of those functions -which use \fBint\fP parameters, +which use \fIint\fP parameters, allowing applications to use larger color- and pair-numbers. +.SH HISTORY +SVr3 introduced these functions: + \fBslk_clear\fP + \fBslk_init\fP + \fBslk_label\fP + \fBslk_noutrefresh\fP + \fBslk_refresh\fP + \fBslk_restore\fP + \fBslk_set\fP + \fBslk_touch\fP +.PP +SVr4 added these functions: + \fBslk_attroff\fP + \fBslk_attron\fP + \fBslk_attrset\fP + \fBslk_start\fP +.PP +X/Open Curses added these: + \fBslk_attr_off\fP + \fBslk_attr_on\fP + \fBslk_attr_set\fP + \fBslk_color\fP + \fBslk_wset\fP .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_attr\fP(3X), -\fBcurs_initscr\fP(3X), -\fBcurs_refresh\fP(3X), -\fBcurs_variables\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_attr\fP(3X), +\fB\%curs_initscr\fP(3X), +\fB\%curs_refresh\fP(3X), +\fB\%curs_variables\fP(3X) diff --git a/upstream/archlinux/man3/curs_sp_funcs.3x b/upstream/archlinux/man3/curs_sp_funcs.3x index 9bfc4578..7c23dbc2 100644 --- a/upstream/archlinux/man3/curs_sp_funcs.3x +++ b/upstream/archlinux/man3/curs_sp_funcs.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 2010-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,309 +27,201 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_sp_funcs.3x,v 1.27 2022/02/12 20:05:11 tom Exp $ -.TH curs_sp_funcs 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' -.na -.hy 0 +.\" $Id: curs_sp_funcs.3x,v 1.50 2024/04/20 18:56:31 tom Exp $ +.TH curs_sp_funcs 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME -curs_sp_funcs \- \fBcurses\fP screen-pointer extension -.ad -.hy +\fB\%curs_sp_funcs\fP \- +\fIcurses\fR screen-pointer extension .SH SYNOPSIS -\fB#include <curses.h>\fP .nf -.sp -\fBint alloc_pair_sp(SCREEN* \fIsp\fB, int \fIfg\fB, int \fIbg\fB);\fR -.br -\fBint assume_default_colors_sp(SCREEN* \fIsp\fB, int \fIfg\fB, int \fIbg\fB);\fR -.br -\fBint baudrate_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint beep_sp(SCREEN* \fIsp\fB);\fR -.br -\fBbool can_change_color_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint cbreak_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint color_content_sp(SCREEN* \fIsp\fB, short \fIcolor\fB, short* \fIr\fB, short* \fIg\fB, short* \fIb\fB);\fR -.br -\fBint curs_set_sp(SCREEN* \fIsp\fB, int \fIvisibility\fR);\fR -.br -\fBint def_prog_mode_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint def_shell_mode_sp(SCREEN* \fIsp\fB);\fR -.sp -\fBint define_key_sp(SCREEN* \fIsp\fB, const char * \fIdefinition\fB, int \fIkeycode\fB);\fR -.br -\fBint delay_output_sp(SCREEN* \fIsp\fB, int \fIms\fB);\fR -.br -\fBint doupdate_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint echo_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint endwin_sp(SCREEN* \fIsp\fB);\fR -.br -\fBchar erasechar_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint erasewchar_sp(SCREEN* \fIsp\fB, wchar_t *\fIch\fB);\fR -.br -\fBint extended_color_content_sp(SCREEN * \fIsp\fB, int \fIcolor\fB, int * \fIr\fB, int * \fIg\fB, int * \fIb\fB);\fR -.br -\fBint extended_pair_content_sp(SCREEN* \fIsp\fB, int \fIpair\fB, int * \fIfg\fB, int * \fIbg\fB);\fR -.br -\fBint extended_slk_color_sp(SCREEN* \fIsp\fB, int \fIpair\fB);\fR -.sp -\fBvoid filter_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint find_pair_sp(SCREEN* \fIsp\fB, int \fIfg\fB, int \fIbg\fB);\fR -.br -\fBint flash_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint flushinp_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint free_pair_sp(SCREEN* \fIsp\fB, int \fIpair\fB);\fR -.br -\fBint get_escdelay_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint getmouse_sp(SCREEN* \fIsp\fB, MEVENT* \fBevent\fB);\fR -.br -\fBWINDOW* getwin_sp(SCREEN* \fIsp\fB, FILE* \fIfilep\fB);\fR -.br -\fBint halfdelay_sp(SCREEN* \fIsp\fB, int \fItenths\fB);\fR -.br -\fBbool has_colors_sp(SCREEN* \fIsp\fB);\fR -.sp -\fBbool has_ic_sp(SCREEN* \fIsp\fB);\fR -.br -\fBbool has_il_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint has_key_sp(SCREEN* \fIsp\fB, int \fIch\fB);\fR -.br -\fBbool has_mouse_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint init_color_sp(SCREEN* \fIsp\fB, short \fIcolor\fB, short \fIr\fB, short \fIg\fB, short \fIb\fB);\fR -.br -\fBint init_extended_color_sp(SCREEN* \fIsp\fB, int \fIcolor\fB, int \fIr\fB, int \fIg\fB, int \fIb\fB);\fR -.br -\fBint init_extended_pair_sp(SCREEN* \fIsp\fB, int \fIpair\fB, int \fIfg\fB, int \fIbg\fB);\fR -.br -\fBint init_pair_sp(SCREEN* \fIsp\fB, short \fIpair\fB, short \fIfg\fB, short \fIbg\fB);\fR -.br -\fBint intrflush_sp(SCREEN* \fIsp\fB, WINDOW* \fIwin\fB, bool \fIbf\fB);\fR -.br -\fBbool is_term_resized_sp(SCREEN* \fIsp\fB, int \fIlines\fB, int \fIcolumns\fB);\fR -.sp -\fBbool isendwin_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint key_defined_sp(SCREEN* \fIsp\fB, const char *\fIdefinition\fB);\fR -.br -\fBchar* keybound_sp(SCREEN* \fIsp\fB, int \fIkeycode\fB, int \fIcount\fB);\fR -.br -\fBNCURSES_CONST char * keyname_sp(SCREEN* \fIsp\fB, int \fIc\fB);\fR -.br -\fBint keyok_sp(SCREEN* \fIsp\fB, int \fIkeycode\fB, bool \fIenable\fB);\fR -.br -\fBchar killchar_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint killwchar_sp(SCREEN* \fIsp\fB, wchar_t *\fIch\fB);\fR -.br -\fBchar* longname_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint mcprint_sp(SCREEN* \fIsp\fB, char *\fIdata\fB, int \fIlen\fB);\fR -.br -\fBint mouseinterval_sp(SCREEN* \fIsp\fB, int \fIerval\fB);\fR -.sp -\fBmmask_t mousemask_sp(SCREEN* \fIsp\fB, mmask_t \fInewmask\fB, mmask_t *\fIoldmask\fB);\fR -.br -\fBint mvcur_sp(SCREEN* \fIsp\fB, int \fIoldrow\fB, int \fIoldcol\fB, int \fInewrow\fB, int \fInewcol\fB);\fR -.br -\fBint napms_sp(SCREEN* \fIsp\fB, int \fIms\fB);\fR -.br -\fBWINDOW* newpad_sp(SCREEN* \fIsp\fB, int \fInrows\fB, int \fIncols\fB);\fR -.br -\fBSCREEN* new_prescr(void);\fP -.br -\fBSCREEN* newterm_sp(SCREEN* \fIsp\fB, const char *\fItype\fB, FILE *\fIoutfd\fB, FILE *\fIinfd\fB);\fR -.br -\fBWINDOW* newwin_sp(SCREEN* \fIsp\fB, int \fInlines\fB, int \fIncols\fB, int \fIbegin_y\fB, int \fIbegin_x\fB);\fR -.br -\fBint nl_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint nocbreak_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint noecho_sp(SCREEN* \fIsp\fB);\fR -.sp -\fBvoid nofilter_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint nonl_sp(SCREEN* \fIsp\fB);\fR -.br -\fBvoid noqiflush_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint noraw_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint pair_content_sp(SCREEN* \fIsp\fB, short \fIpair\fB, short* \fIfg\fB, short* \fIbg\fB);\fR -.br -\fBvoid qiflush_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint raw_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint reset_prog_mode_sp(SCREEN* \fIsp\fB);\fR -.br -\fBvoid reset_color_pairs_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint reset_shell_mode_sp(SCREEN* \fIsp\fB);\fR -.sp -\fBint resetty_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint resize_term_sp(SCREEN* \fIsp\fB, int \fIlines\fB, int \fIcolumns\fB);\fR -.br -\fBint resizeterm_sp(SCREEN* \fIsp\fB, int \fIlines\fB, int \fIcolumns\fB);\fR -.br -\fBint ripoffline_sp(SCREEN* \fIsp\fB, int \fIline\fB, int (*\fIinit\fB)(WINDOW* \fIwin\fB, int \fIfmt\fB));\fR -.br -\fBint savetty_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint scr_init_sp(SCREEN* \fIsp\fB, const char *\fIfilename\fB);\fR -.br -\fBint scr_restore_sp(SCREEN* \fIsp\fB, const char *\fIfilename\fB);\fR -.br -\fBint scr_set_sp(SCREEN* \fIsp\fB, const char *\fIfilename\fB);\fR -.br -\fBint set_escdelay_sp(SCREEN* \fIsp\fB, int \fIms\fB);\fR -.br -\fBint set_tabsize_sp(SCREEN* \fIsp\fB, int \fIcols\fB);\fR -.sp -\fBint slk_attr_set_sp(SCREEN* \fIsp\fB, const attr_t \fIattrs\fB, short \fIpair\fB, void*\fIopts\fB);\fR -.br -\fBint slk_attrset_sp(SCREEN* \fIsp\fB, const chtype \fIa\fB);\fR -.br -\fBint slk_attroff_sp(SCREEN* \fIsp\fB, const chtype \fIa\fB);\fR -.br -\fBint slk_attron_sp(SCREEN* \fIsp\fB, const chtype \fIa\fB);\fR -.br -\fBattr_t slk_attr_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint slk_clear_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint slk_color_sp(SCREEN* \fIsp\fB, short \fIpair\fB);\fR -.br -\fBint slk_init_sp(SCREEN* \fIsp\fB, int \fIfmt\fB);\fR -.br -\fBchar* slk_label_sp(SCREEN* \fIsp\fB, int \fIlabnum\fB);\fR -.br -\fBint slk_noutrefresh_sp(SCREEN* \fIsp\fB);\fR -.sp -\fBint slk_refresh_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint slk_restore_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint slk_set_sp(SCREEN* \fIsp\fB, int \fIlabnum\fB, const char * \fIlabel\fB, int \fIfmt\fB);\fR -.br -\fBint slk_touch_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint start_color_sp(SCREEN* \fIsp\fB);\fR -.br -\fBattr_t term_attrs_sp(SCREEN* \fIsp\fB);\fR -.br -\fBchtype termattrs_sp(SCREEN* \fIsp\fB);\fR -.br -\fBchar* termname_sp(SCREEN* \fIsp\fB);\fR -.br -\fBint typeahead_sp(SCREEN* \fIsp\fB, int \fIfd\fB);\fR -.br -\fBint unget_wch_sp(SCREEN* \fIsp\fB, const wchar_t \fIwch\fB);\fR -.sp -\fBint ungetch_sp(SCREEN* \fIsp\fB, int \fIch\fB);\fR -.br -\fBint ungetmouse_sp(SCREEN* \fIsp\fB,MEVENT * \fBevent\fB);\fR -.br -\fBint use_default_colors_sp(SCREEN* \fIsp\fB);\fR -.br -\fBvoid use_env_sp(SCREEN* \fIsp\fB, bool \fIbf\fB);\fR -.br -\fBint use_legacy_coding_sp(SCREEN* \fIsp\fB, int \fIlevel\fB);\fR -.br -\fBvoid use_tioctl_sp(SCREEN *\fIsp\fB, bool \fIbf\fB);\fR -.br -\fBint vid_attr_sp(SCREEN* \fIsp\fB, attr_t \fIattrs\fB, short \fIpair\fB, void * \fIopts\fB);\fR -.br -\fBint vid_puts_sp(SCREEN* \fIsp\fB, attr_t \fIattrs\fB, short \fIpair\fB, void * \fIopts\fB, NCURSES_SP_OUTC \fIputc\fB);\fR -.br -\fBint vidattr_sp(SCREEN* \fIsp\fB, chtype \fIattrs\fB);\fR -.br -\fBint vidputs_sp(SCREEN* \fIsp\fB, chtype \fIattrs\fB, NCURSES_SP_OUTC \fIputc\fB);\fR -.br -\fBwchar_t* wunctrl_sp(SCREEN* \fIsp\fB, cchar_t *\fIch\fB);\fR -.sp -\fB#include <form.h>\fP -.sp -\fBFORM* new_form_sp(SCREEN* \fIsp\fB, FIELD **\fIfields\fB);\fR -.sp -\fB#include <menu.h>\fP -.sp -\fBMENU* new_menu_sp(SCREEN* \fIsp\fB, ITEM **\fIitems\fB);\fR -.sp -\fB#include <panel.h>\fP -.sp -\fBPANEL* ceiling_panel(SCREEN* \fIsp\fB);\fR -.br -\fBPANEL* ground_panel(SCREEN* \fIsp\fB);\fR -.br -\fBvoid update_panels_sp(SCREEN* \fIsp\fB);\fR -.sp -\fB#include <term.h>\fP -.sp -\fBint del_curterm_sp(SCREEN* \fIsp\fB, TERMINAL *\fIoterm\fB);\fR -.br -\fBint putp_sp(SCREEN* \fIsp\fB, const char *\fIstr\fB);\fR -.br -\fBint restartterm_sp(SCREEN* \fIsp\fB, NCURSES_CONST char*\fIterm\fB, int \fIfiledes\fB, int *\fIerrret\fB);\fR -.br -\fBTERMINAL* set_curterm_sp(SCREEN* \fIsp\fB, TERMINAL*\fInterm\fB);\fR -.br -\fBint tgetent_sp(SCREEN* \fIsp\fB, char *\fIbp\fB, const char *\fIname\fB);\fR -.br -\fBint tgetflag_sp(SCREEN* \fIsp\fB, const char *\fIcapname\fB);\fR -.br -\fBint tgetnum_sp(SCREEN* \fIsp\fB, const char *\fIcapname\fB);\fR -.br -\fBchar* tgetstr_sp(SCREEN* \fIsp\fB, const char *\fIcapname\fB, char **\fIarea\fB);\fR -.br -\fBchar* tgoto_sp(SCREEN* \fIsp\fB, const char *\fIcapname\fB, int \fIcol\fB, int \fIrow\fB);\fR -.br -\fBint tigetflag_sp(SCREEN* \fIsp\fB, const char *\fIcapname\fB);\fR -.br -\fBint tigetnum_sp(SCREEN* \fIsp\fB, const char *\fIcapname\fB);\fR -.br -\fBchar* tigetstr_sp(SCREEN* \fIsp\fB, const char *\fIcapname\fB);\fR -.br -\fR/* may instead use 9 long parameters */\fP -.br -\fBchar* tparm_sp(SCREEN* \fIsp\fB, const char *\fIstr\fB, ...);\fR -.br -\fBint tputs_sp(SCREEN* \fIsp\fB, const char *\fIstr\fB, int \fIaffcnt\fB, NCURSES_SP_OUTC \fIputc\fB);\fR -.sp -\fB#include <unctrl.h>\fP -.sp -\fBNCURSES_CONST char* unctrl_sp(SCREEN* \fIsp\fB, chtype \fIc\fB);\fR -.ad -.br +\fB#include <curses.h> +.PP +\fBint alloc_pair_sp(SCREEN* \fIsp\fP, int \fIfg\fP, int \fIbg\fP); +\fBint assume_default_colors_sp(SCREEN* \fIsp\fP, int \fIfg\fP, int \fIbg\fP); +\fBint baudrate_sp(SCREEN* \fIsp\fP); +\fBint beep_sp(SCREEN* \fIsp\fP); +\fBbool can_change_color_sp(SCREEN* \fIsp\fP); +\fBint cbreak_sp(SCREEN* \fIsp\fP); +\fBint color_content_sp(SCREEN* \fIsp\fP, short \fIcolor\fP, short* \fIr\fP, short* \fIg\fP, short* \fIb\fP); +\fBint curs_set_sp(SCREEN* \fIsp\fP, int \fIvisibility\fP); +\fBint def_prog_mode_sp(SCREEN* \fIsp\fP); +\fBint def_shell_mode_sp(SCREEN* \fIsp\fP); +.PP +\fBint define_key_sp(SCREEN* \fIsp\fP, const char * \fIdefinition\fP, int \fIkeycode\fP); +\fBint delay_output_sp(SCREEN* \fIsp\fP, int \fIms\fP); +\fBint doupdate_sp(SCREEN* \fIsp\fP); +\fBint echo_sp(SCREEN* \fIsp\fP); +\fBint endwin_sp(SCREEN* \fIsp\fP); +\fBchar erasechar_sp(SCREEN* \fIsp\fP); +\fBint erasewchar_sp(SCREEN* \fIsp\fP, wchar_t *\fIwc\fP); +\fBint extended_color_content_sp(SCREEN * \fIsp\fP, int \fIcolor\fP, int * \fIr\fP, int * \fIg\fP, int * \fIb\fP); +\fBint extended_pair_content_sp(SCREEN* \fIsp\fP, int \fIpair\fP, int * \fIfg\fP, int * \fIbg\fP); +\fBint extended_slk_color_sp(SCREEN* \fIsp\fP, int \fIpair\fP); +.PP +\fBvoid filter_sp(SCREEN* \fIsp\fP); +\fBint find_pair_sp(SCREEN* \fIsp\fP, int \fIfg\fP, int \fIbg\fP); +\fBint flash_sp(SCREEN* \fIsp\fP); +\fBint flushinp_sp(SCREEN* \fIsp\fP); +\fBint free_pair_sp(SCREEN* \fIsp\fP, int \fIpair\fP); +\fBint get_escdelay_sp(SCREEN* \fIsp\fP); +\fBint getmouse_sp(SCREEN* \fIsp\fP, MEVENT* \fIevent\fP); +\fBWINDOW* getwin_sp(SCREEN* \fIsp\fP, FILE* \fIfilep\fP); +\fBint halfdelay_sp(SCREEN* \fIsp\fP, int \fItenths\fP); +\fBbool has_colors_sp(SCREEN* \fIsp\fP); +.PP +\fBbool has_ic_sp(SCREEN* \fIsp\fP); +\fBbool has_il_sp(SCREEN* \fIsp\fP); +\fBint has_key_sp(SCREEN* \fIsp\fP, int \fIc\fP); +\fBbool has_mouse_sp(SCREEN* \fIsp\fP); +\fBint init_color_sp(SCREEN* \fIsp\fP, short \fIcolor\fP, short \fIr\fP, short \fIg\fP, short \fIb\fP); +\fBint init_extended_color_sp(SCREEN* \fIsp\fP, int \fIcolor\fP, int \fIr\fP, int \fIg\fP, int \fIb\fP); +\fBint init_extended_pair_sp(SCREEN* \fIsp\fP, int \fIpair\fP, int \fIfg\fP, int \fIbg\fP); +\fBint init_pair_sp(SCREEN* \fIsp\fP, short \fIpair\fP, short \fIfg\fP, short \fIbg\fP); +\fBint intrflush_sp(SCREEN* \fIsp\fP, WINDOW* \fIwin\fP, bool \fIbf\fP); +\fBint is_cbreak_sp(SCREEN* \fIsp\fP); +.PP +\fBint is_echo_sp(SCREEN* \fIsp\fP); +\fBint is_nl_sp(SCREEN* \fIsp\fP); +\fBint is_raw_sp(SCREEN* \fIsp\fP); +\fBbool is_term_resized_sp(SCREEN* \fIsp\fP, int \fIlines\fP, int \fIcolumns\fP); +\fBbool isendwin_sp(SCREEN* \fIsp\fP); +\fBint key_defined_sp(SCREEN* \fIsp\fP, const char *\fIdefinition\fP); +\fBchar* keybound_sp(SCREEN* \fIsp\fP, int \fIkeycode\fP, int \fIcount\fP); +\fBNCURSES_CONST char* keyname_sp(SCREEN* \fIsp\fP, int \fIc\fP); +\fBint keyok_sp(SCREEN* \fIsp\fP, int \fIkeycode\fP, bool \fIenable\fP); +\fBchar killchar_sp(SCREEN* \fIsp\fP); +.PP +\fBint killwchar_sp(SCREEN* \fIsp\fP, wchar_t *\fIwc\fP); +\fBchar* longname_sp(SCREEN* \fIsp\fP); +\fBint mcprint_sp(SCREEN* \fIsp\fP, char *\fIdata\fP, int \fIlen\fP); +\fBint mouseinterval_sp(SCREEN* \fIsp\fP, int \fIerval\fP); +\fBmmask_t mousemask_sp(SCREEN* \fIsp\fP, mmask_t \fInewmask\fP, mmask_t *\fIoldmask\fP); +\fBint mvcur_sp(SCREEN* \fIsp\fP, int \fIoldrow\fP, int \fIoldcol\fP, int \fInewrow\fP, int \fInewcol\fP); +\fBint napms_sp(SCREEN* \fIsp\fP, int \fIms\fP); +\fBWINDOW* newpad_sp(SCREEN* \fIsp\fP, int \fInrows\fP, int \fIncols\fP); +\fBSCREEN* new_prescr(void); +\fBSCREEN* newterm_sp(SCREEN* \fIsp\fP, const char *\fItype\fP, FILE *\fIoutfd\fP, FILE *\fIinfd\fP); +.PP +\fBWINDOW* newwin_sp(SCREEN* \fIsp\fP, int \fInlines\fP, int \fIncols\fP, int \fIbegin_y\fP, int \fIbegin_x\fP); +\fBint nl_sp(SCREEN* \fIsp\fP); +\fBint nocbreak_sp(SCREEN* \fIsp\fP); +\fBint noecho_sp(SCREEN* \fIsp\fP); +\fBvoid nofilter_sp(SCREEN* \fIsp\fP); +\fBint nonl_sp(SCREEN* \fIsp\fP); +\fBvoid noqiflush_sp(SCREEN* \fIsp\fP); +\fBint noraw_sp(SCREEN* \fIsp\fP); +\fBint pair_content_sp(SCREEN* \fIsp\fP, short \fIpair\fP, short* \fIfg\fP, short* \fIbg\fP); +\fBvoid qiflush_sp(SCREEN* \fIsp\fP); +.PP +\fBint raw_sp(SCREEN* \fIsp\fP); +\fBvoid reset_color_pairs_sp(SCREEN* \fIsp\fP); +\fBint reset_prog_mode_sp(SCREEN* \fIsp\fP); +\fBint reset_shell_mode_sp(SCREEN* \fIsp\fP); +\fBint resetty_sp(SCREEN* \fIsp\fP); +\fBint resize_term_sp(SCREEN* \fIsp\fP, int \fIlines\fP, int \fIcolumns\fP); +\fBint resizeterm_sp(SCREEN* \fIsp\fP, int \fIlines\fP, int \fIcolumns\fP); +\fBint ripoffline_sp(SCREEN* \fIsp\fP, int \fIline\fP, int (*\fIinit\fP)(WINDOW* \fIwin\fP, int \fIfmt\fP)); +\fBint savetty_sp(SCREEN* \fIsp\fP); +\fBint scr_init_sp(SCREEN* \fIsp\fP, const char *\fIfilename\fP); +.PP +\fBint scr_restore_sp(SCREEN* \fIsp\fP, const char *\fIfilename\fP); +\fBint scr_set_sp(SCREEN* \fIsp\fP, const char *\fIfilename\fP); +\fBint set_escdelay_sp(SCREEN* \fIsp\fP, int \fIms\fP); +\fBint set_tabsize_sp(SCREEN* \fIsp\fP, int \fIcols\fP); +\fBint slk_attrset_sp(SCREEN* \fIsp\fP, const chtype \fIa\fP); +\fBint slk_attr_set_sp(SCREEN* \fIsp\fP, const attr_t \fIattrs\fP, short \fIpair\fP, void*\fIopts\fP); +\fBint slk_attroff_sp(SCREEN* \fIsp\fP, const chtype \fIa\fP); +\fBint slk_attron_sp(SCREEN* \fIsp\fP, const chtype \fIa\fP); +\fBattr_t slk_attr_sp(SCREEN* \fIsp\fP); +\fBint slk_clear_sp(SCREEN* \fIsp\fP); +.PP +\fBint slk_color_sp(SCREEN* \fIsp\fP, short \fIpair\fP); +\fBint slk_init_sp(SCREEN* \fIsp\fP, int \fIfmt\fP); +\fBchar* slk_label_sp(SCREEN* \fIsp\fP, int \fIlabnum\fP); +\fBint slk_noutrefresh_sp(SCREEN* \fIsp\fP); +\fBint slk_refresh_sp(SCREEN* \fIsp\fP); +\fBint slk_restore_sp(SCREEN* \fIsp\fP); +\fBint slk_set_sp(SCREEN* \fIsp\fP, int \fIlabnum\fP, const char * \fIlabel\fP, int \fIfmt\fP); +\fBint slk_touch_sp(SCREEN* \fIsp\fP); +\fBint start_color_sp(SCREEN* \fIsp\fP); +\fBattr_t term_attrs_sp(SCREEN* \fIsp\fP); +.PP +\fBchtype termattrs_sp(SCREEN* \fIsp\fP); +\fBchar* termname_sp(SCREEN* \fIsp\fP); +\fBint typeahead_sp(SCREEN* \fIsp\fP, int \fIfd\fP); +\fBint unget_wch_sp(SCREEN* \fIsp\fP, const wchar_t \fIwc\fP); +\fBint ungetch_sp(SCREEN* \fIsp\fP, int \fIc\fP); +\fBint ungetmouse_sp(SCREEN* \fIsp\fP, MEVENT* \fIevent\fP); +\fBint use_default_colors_sp(SCREEN* \fIsp\fP); +\fBvoid use_env_sp(SCREEN* \fIsp\fP, bool \fIbf\fP); +\fBint use_legacy_coding_sp(SCREEN* \fIsp\fP, int \fIlevel\fP); +\fBvoid use_tioctl_sp(SCREEN *\fIsp\fP, bool \fIbf\fP); +.PP +\fBint vid_attr_sp(SCREEN* \fIsp\fP, attr_t \fIattrs\fP, short \fIpair\fP, void * \fIopts\fP); +\fBint vid_puts_sp(SCREEN* \fIsp\fP, attr_t \fIattrs\fP, short \fIpair\fP, void * \fIopts\fP, NCURSES_SP_OUTC \fIputc\fP); +\fBint vidattr_sp(SCREEN* \fIsp\fP, chtype \fIattrs\fP); +\fBint vidputs_sp(SCREEN* \fIsp\fP, chtype \fIattrs\fP, NCURSES_SP_OUTC \fIputc\fP); +\fBwchar_t* wunctrl_sp(SCREEN* \fIsp\fP, cchar_t *\fIwch\fP); +.PP +\fB#include <form.h> +.PP +\fBFORM* new_form_sp(SCREEN* \fIsp\fP, FIELD **\fIfields\fP); +.PP +\fB#include <menu.h> +.PP +\fBMENU* new_menu_sp(SCREEN* \fIsp\fP, ITEM **\fIitems\fP); +.PP +\fB#include <panel.h> +.PP +\fBPANEL* ceiling_panel(SCREEN* \fIsp\fP); +\fBPANEL* ground_panel(SCREEN* \fIsp\fP); +\fBvoid update_panels_sp(SCREEN* \fIsp\fP); +.PP +\fB#include <term.h> +.PP +\fBint del_curterm_sp(SCREEN* \fIsp\fP, TERMINAL *\fIoterm\fP); +\fBint putp_sp(SCREEN* \fIsp\fP, const char *\fIstr\fP); +\fBint restartterm_sp(SCREEN* \fIsp\fP, NCURSES_CONST char*\fIterm\fP, int \fIfiledes\fP, int *\fIerrret\fP); +\fBTERMINAL* set_curterm_sp(SCREEN* \fIsp\fP, TERMINAL*\fInterm\fP); +\fBint tgetent_sp(SCREEN* \fIsp\fP, char *\fIbp\fP, const char *\fIname\fP); +\fBint tgetflag_sp(SCREEN* \fIsp\fP, const char *\fIcapname\fP); +\fBint tgetnum_sp(SCREEN* \fIsp\fP, const char *\fIcapname\fP); +\fBchar* tgetstr_sp(SCREEN* \fIsp\fP, const char *\fIcapname\fP, char **\fIarea\fP); +\fBchar* tgoto_sp(SCREEN* \fIsp\fP, const char *\fIcapname\fP, int \fIcol\fP, int \fIrow\fP); +\fBint tigetflag_sp(SCREEN* \fIsp\fP, const char *\fIcapname\fP); +.PP +\fBint tigetnum_sp(SCREEN* \fIsp\fP, const char *\fIcapname\fP); +\fBchar* tigetstr_sp(SCREEN* \fIsp\fP, const char *\fIcapname\fP); +\fI/* tparm_sp may use 9 long parameters rather than being variadic */ +\fBchar* tparm_sp(SCREEN* \fIsp\fP, const char *\fIstr\fP, ...); +\fBint tputs_sp(SCREEN* \fIsp\fP, const char *\fIstr\fP, int \fIaffcnt\fP, NCURSES_SP_OUTC \fIputc\fP); +.PP +\fB#include <unctrl.h> +.PP +\fBNCURSES_CONST char* unctrl_sp(SCREEN* \fIsp\fP, chtype \fIch\fP); +.fi .SH DESCRIPTION This implementation can be configured to provide a set of functions which improve the ability to manage multiple screens. -This feature can be added to any of the configurations supported by ncurses; -it adds new entrypoints +This feature can be added to any of the configurations supported by +\fI\%ncurses\fP; +it adds new symbols without changing the meaning of any of the existing ones. -.PP .\" *************************************************************************** -.SS IMPROVED FUNCTIONS +.SS "Improved Functions" Most of the functions are new versions of existing functions. A parameter is added at the front of the parameter list. -It is a SCREEN pointer. +It is a \fISCREEN\fP pointer. .PP The existing functions all use the current screen, which is a static variable. @@ -337,7 +229,7 @@ The extended functions use the specified screen, thereby reducing the number of variables which must be modified to update multiple screens. .\" *************************************************************************** -.SS NEW FUNCTIONS +.SS "New Functions" Here are the new functions: .TP 5 ceiling_panel @@ -353,8 +245,8 @@ With the screen-pointer extension, there are situations where it must create a current screen before the unextended library does. The \fBnew_prescr\fP function is used internally to handle these cases. -It is also provided as an entrypoint to allow applications to customize -the library initialization. +It is also provided to allow applications to customize library +initialization. .\" *************************************************************************** .SH NOTES This extension introduces some new names: @@ -367,7 +259,8 @@ to make it useful for checking if the extension is provided. NCURSES_SP_NAME The new functions are named using the macro \fINCURSES_SP_NAME\fP, which hides the actual implementation. -Currently this adds a \*(``_sp\*('' suffix to the name of the unextended function. +Currently this adds a \*(``_sp\*('' suffix +to the name of the unextended function. This manual page indexes the extensions showing the full name. However the proper usage of these functions uses the macro, to provide for the possibility of changing the naming convention @@ -380,13 +273,12 @@ where an \fINCURSES_OUTC\fP is used in the unextended library. NCURSES_OUTC This is a function-pointer type used for the cases where a function passes characters to the output stream, e.g., \fBvidputs\fP(3X). -.PP .SH PORTABILITY -These routines are specific to ncurses. +These routines are specific to \fI\%ncurses\fP. They were not supported on Version 7, BSD or System V implementations. -It is recommended that any code depending on ncurses extensions +It is recommended that any code depending on \fI\%ncurses\fP extensions be conditioned using \fINCURSES_SP_FUNCS\fP. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_opaque\fP(3X), -\fBcurs_threads\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_opaque\fP(3X), +\fB\%curs_threads\fP(3X) diff --git a/upstream/archlinux/man3/curs_termattrs.3x b/upstream/archlinux/man3/curs_termattrs.3x index 8f20cde5..1dc98eca 100644 --- a/upstream/archlinux/man3/curs_termattrs.3x +++ b/upstream/archlinux/man3/curs_termattrs.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,61 +27,51 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_termattrs.3x,v 1.20 2023/03/11 20:41:12 tom Exp $ -.TH curs_termattrs 3X "" +.\" $Id: curs_termattrs.3x,v 1.41 2024/04/20 21:20:07 tom Exp $ +.TH curs_termattrs 3X 2024-04-20 "ncurses 6.5" "Library calls" .SH NAME -\fBbaudrate\fP, -\fBerasechar\fP, -\fBerasewchar\fP, -\fBhas_ic\fP, -\fBhas_il\fP, -\fBkillchar\fP, -\fBkillwchar\fP, -\fBlongname\fP, -\fBterm_attrs\fP, -\fBtermattrs\fP, -\fBtermname\fP \- \fBcurses\fP environment query routines +\fB\%baudrate\fP, +\fB\%erasechar\fP, +\fB\%erasewchar\fP, +\fB\%has_ic\fP, +\fB\%has_il\fP, +\fB\%killchar\fP, +\fB\%killwchar\fP, +\fB\%longname\fP, +\fB\%term_attrs\fP, +\fB\%termattrs\fP, +\fB\%termname\fP \- +\fIcurses\fR environment query routines .SH SYNOPSIS -\fB#include <curses.h>\fP +.nf +\fB#include <curses.h> .PP -\fBint baudrate(void);\fP -.br -\fBchar erasechar(void);\fP -.br -\fBint erasewchar(wchar_t *\fIch\fB);\fR -.br -\fBbool has_ic(void);\fP -.br -\fBbool has_il(void);\fP -.br -\fBchar killchar(void);\fP -.br -\fBint killwchar(wchar_t *\fIch\fB);\fR -.br -\fBchar *longname(void);\fP -.br -\fBattr_t term_attrs(void);\fP -.br -\fBchtype termattrs(void);\fP -.br -\fBchar *termname(void);\fP -.br +\fBint baudrate(void); +\fBchar erasechar(void); +\fBint erasewchar(wchar_t *\fIwc\fP); +\fBbool has_ic(void); +\fBbool has_il(void); +\fBchar killchar(void); +\fBint killwchar(wchar_t *\fIwc\fP); +\fBchar *longname(void); +\fBattr_t term_attrs(void); +\fBchtype termattrs(void); +\fBchar *termname(void); +.fi .SH DESCRIPTION .SS baudrate The \fBbaudrate\fP routine returns the output speed of the terminal. The number returned is in bits per second, for example \fB9600\fP, and is an integer. -.SS erasechar, erasewchar -.PP +.SS "erasechar, erasewchar" The \fBerasechar\fP routine returns the user's current erase character. .PP The \fBerasewchar\fP routine stores the current erase character -in the location referenced by \fIch\fP. +in the location referenced by \fIwc\fP. If no erase character has been defined, the routine fails -and the location referenced by \fIch\fP is not changed. -.SS has_is, has_il -.PP +and the location referenced by \fIwc\fP is not changed. +.SS "has_ic, has_il" The \fBhas_ic\fP routine is true if the terminal has insert- and delete- character capabilities. .PP @@ -90,16 +80,14 @@ capabilities, or can simulate them using scrolling regions. This might be used to determine if it would be appropriate to turn on physical scrolling using \fBscrollok\fP(3X). -.SS killchar, killwchar -.PP +.SS "killchar, killwchar" The \fBkillchar\fP routine returns the user's current line kill character. .PP The \fBkillwchar\fP routine stores the current line-kill character -in the location referenced by \fIch\fP. +in the location referenced by \fIwc\fP. If no line-kill character has been defined, -the routine fails and the location referenced by \fIch\fP is not changed. +the routine fails and the location referenced by \fIwc\fP is not changed. .SS longname -.PP The \fBlongname\fP routine returns a pointer to a static area containing a verbose description of the current terminal. The maximum @@ -110,8 +98,7 @@ overwritten by each call to \fBnewterm\fP and is not restored by \fBset_term\fP, so the value should be saved between calls to \fBnewterm\fP if \fBlongname\fP is going to be used with multiple terminals. -.SS termattrs, term_attrs -.PP +.SS "termattrs, term_attrs" If a given terminal does not support a video attribute that an application program is trying to use, \fBcurses\fP may substitute a different video attribute for it. @@ -121,7 +108,6 @@ terminal using \fBA_\fP and \fBWA_\fP constants respectively. This information is useful when a \fBcurses\fP program needs complete control over the appearance of the screen. .SS termname -.PP The \fBtermname\fP routine returns the terminal name used by \fBsetupterm\fP. .SH RETURN VALUE \fBlongname\fP and \fBtermname\fP return \fBNULL\fP on error. @@ -132,10 +118,12 @@ completion. .SH NOTES Note that \fBtermattrs\fP may be a macro. .SH PORTABILITY -The XSI Curses standard, Issue 4 describes these functions. +X/Open Curses, Issue 4 describes these functions. It changes the return type of \fBtermattrs\fP to the new type \fBattr_t\fP. Most versions of curses truncate the result returned by \fBtermname\fP to 14 characters. .SH SEE ALSO -\fBcurses\fP(3X), \fBcurs_initscr\fP(3X), \fBcurs_outopts\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_initscr\fP(3X), +\fB\%curs_outopts\fP(3X) diff --git a/upstream/archlinux/man3/curs_termcap.3x b/upstream/archlinux/man3/curs_termcap.3x index 5e47f725..665196b5 100644 --- a/upstream/archlinux/man3/curs_termcap.3x +++ b/upstream/archlinux/man3/curs_termcap.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2017,2018 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,367 +27,521 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_termcap.3x,v 1.58 2023/04/16 18:16:40 tom Exp $ -.TH curs_termcap 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_termcap.3x,v 1.85 2024/04/20 19:13:12 tom Exp $ +.TH curs_termcap 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 -.ds n 5 +. .SH NAME -\fBPC\fP, -\fBUP\fP, -\fBBC\fP, -\fBospeed\fP, -\fBtgetent\fP, -\fBtgetflag\fP, -\fBtgetnum\fP, -\fBtgetstr\fP, -\fBtgoto\fP, -\fBtputs\fP \- \fBcurses\fP emulation of termcap -.ad -.hy +\fB\%PC\fP, +\fB\%UP\fP, +\fB\%BC\fP, +\fB\%ospeed\fP, +\fB\%tgetent\fP, +\fB\%tgetflag\fP, +\fB\%tgetnum\fP, +\fB\%tgetstr\fP, +\fB\%tgoto\fP, +\fB\%tputs\fP \- +\fIcurses\fR emulation of \fItermcap\fR .SH SYNOPSIS -\fB#include <curses.h>\fP -.br -\fB#include <term.h>\fP -.sp -\fBextern char PC;\fP -.br -\fBextern char * UP;\fP -.br -\fBextern char * BC;\fP -.br -\fBextern short ospeed;\fP -.sp -\fBint tgetent(char *\fIbp\fB, const char *\fIname\fB);\fR -.br -\fBint tgetflag(const char *\fIid\fB);\fR -.br -\fBint tgetnum(const char *\fIid\fB);\fR -.br -\fBchar *tgetstr(const char *\fIid\fB, char **\fIarea\fB);\fR -.br -\fBchar *tgoto(const char *\fIcap\fB, int \fIcol\fB, int \fIrow\fB);\fR -.br -\fBint tputs(const char *\fIstr\fB, int \fIaffcnt\fB, int (*\fIputc\fB)(int));\fR -.br +.nf +\fB#include <curses.h> +\fB#include <term.h> +.PP +\fBchar PC; +\fBchar * UP; +\fBchar * BC; +\fBshort ospeed; +.PP +\fBint tgetent(char *\fIbp\fP, const char *\fIname\fP); +\fBint tgetflag(const char *\fIid\fP); +\fBint tgetnum(const char *\fIid\fP); +\fBchar *tgetstr(const char *\fIid\fP, char **\fIarea\fP); +\fBchar *tgoto(const char *\fIcap\fP, int \fIcol\fP, int \fIrow\fP); +\fBint tputs(const char *\fIstr\fP, int \fIaffcnt\fP, int (*\fIputc\fP)(int)); +.fi .SH DESCRIPTION -These routines are included as a conversion aid for programs that use -the \fItermcap\fP library. -Their parameters are the same, but the -routines are emulated using the \fIterminfo\fP database. -Thus, they -can only be used to query the capabilities of entries for which a -terminfo entry has been compiled. +.I \%ncurses +provides the foregoing variables and functions as a compatibility layer +for programs that use the \fItermcap\fP library. +The API is the same, +but behavior is emulated using the \fI\%term\%info\fP database. +Thus, +it can be used only to query the capabilities of terminal database +entries for which a \fI\%term\%info\fP entry has been compiled. .SS Initialization -.PP -The \fBtgetent\fP routine loads the entry for \fIname\fP. -It returns: +\fB\%tgetent\fP loads the terminal database entry for \fIname\fP; +see \fBterm\fP(7). +This must be done before calling any of the other functions. +It returns .RS 3 -.TP 3 +.TP 5 \" "-1" + 2n + adjust for PDF 1 on success, -.TP 3 +.TP 0 if there is no such entry -(or that it is a generic type, having too little information for curses -applications to run), and -.TP 3 +(or if the matching entry describes a generic terminal, +having too little information for +.I curses +applications to run), +and +.TP \-1 -if the terminfo database could not be found. +if the \fI\%term\%info\fP database could not be found. .RE .PP -This differs from the \fItermcap\fP library in two ways: +This implementation differs from those of historical \fItermcap\fP +libraries. .RS 3 .bP -The emulation ignores the buffer pointer \fIbp\fP. -The \fItermcap\fP library would store a copy of the terminal +.I \%ncurses +ignores the buffer pointer \fIbp\fP, +as do other \fItermcap\fP implementations conforming to portions of +X/Open Curses now withdrawn. +The BSD \fItermcap\fP library would store a copy of the terminal type description in the area referenced by this pointer. -However, ncurses stores its terminal descriptions in compiled -binary form, which is not the same thing. +\fI\%term\%info\fP stores terminal type descriptions in compiled form, +which is not the same thing. .bP -There is a difference in return codes. -The \fItermcap\fP library does not check if the terminal -description is marked with the \fIgeneric\fP capability, -or if the terminal description has cursor-addressing. +The meanings of the return values differ. +The BSD \fItermcap\fP library does not check whether the terminal type +description includes the +.B \%generic +.RB ( gn ) +capability, +nor whether the terminal type description supports an addressable +cursor, +a property essential for any \fIcurses\fP implementation to operate. .RE -.SS Capability Values -.PP -The \fBtgetflag\fP routine gets the boolean entry for \fIid\fP, +.SS "Retrieving Capability Values" +\fB\%tgetflag\fP reports the Boolean entry for \fIid\fP, or zero if it is not available. .PP -The \fBtgetnum\fP routine gets the numeric entry for \fIid\fP, +\fB\%tgetnum\fP obtains the numeric entry for \fIid\fP, or \-1 if it is not available. .PP -The \fBtgetstr\fP routine returns the string entry for \fIid\fP, -or zero if it is not available. -Use \fBtputs\fP to output the returned string. -The \fIarea\fP parameter is used as follows: +\fB\%tgetstr\fP returns the string entry for \fIid\fP, +or +.B NULL +if it is not available. +Use \fB\%tputs\fP to output the string returned. +The +.I area +parameter is used as follows. .RS 3 .bP It is assumed to be the address of a pointer to a buffer managed by the calling application. .bP -However, ncurses checks to ensure that \fBarea\fP is not NULL, -and also that the resulting buffer pointer is not NULL. -If either check fails, the \fIarea\fP parameter is ignored. +However, +\fI\%ncurses\fP checks to ensure that +.I area +is not +.BR NULL , +and also that the resulting buffer pointer is not +.BR NULL . +If either check fails, +.I area +is ignored. .bP -If the checks succeed, ncurses also copies the return value to -the buffer pointed to by \fIarea\fP, -and the \fIarea\fP value will be updated to point past the null ending -this value. +If the checks succeed, +\fI\%ncurses\fP also copies the return value to the buffer pointed to by +\fIarea\fP, +and the library updates +.I area +to point past the null character terminating this value. .bP -The return value itself is an address in the terminal description which -is loaded into memory. +The return value itself is an address in the terminal type description +loaded into memory. .RE -.PP -Only the first two characters of the \fBid\fP parameter of -\fBtgetflag\fP, -\fBtgetnum\fP and -\fBtgetstr\fP are compared in lookups. -.SS Formatting Capabilities -.PP -The \fBtgoto\fP routine expands the given capability using the parameters. +.SS "Applying String Capabilities" +String capabilities can be parameterized; +see subsection \*(``Parameterized Strings\*('' in \fB\%terminfo\fP(5). +\fB\%tgoto\fP applies its second and third arguments to the parametric +placeholders in the capability stored in the first argument. .bP -Because the capability may have padding characters, -the output of \fBtgoto\fP should be passed to \fBtputs\fP -rather than some other output function such as \fBprintf\fP(3). +The capability may contain padding specifications; +see subsection \*(``Delays and Padding\*('' of \fB\%terminfo\fP(5). +The output of \fB\%tgoto\fP should thus be passed to \fB\%tputs\fP +rather than some other output function such as \fI\%printf\fP(3). .bP -While \fBtgoto\fP is assumed to be used for the two-parameter +While \fB\%tgoto\fP is assumed to be used for the two-parameter cursor positioning capability, -termcap applications also use it for single-parameter capabilities. +\fItermcap\fP applications also use it for single-parameter +capabilities. .IP -Doing this shows a quirk in \fBtgoto\fP: most hardware -terminals use cursor addressing with \fIrow\fP first, -but the original developers of the termcap interface chose to -put the \fIcolumn\fP parameter first. -The \fBtgoto\fP function swaps the order of parameters. -It does this also for calls requiring only a single parameter. -In that case, the first parameter is merely a placeholder. +Doing so reveals a quirk in \fB\%tgoto\fP: +most hardware terminals use cursor addressing with \fIrow\fP first, +but the original developers of the \fItermcap\fP interface chose to +put the \fIcol\fP (column) parameter first. +The \fB\%tgoto\fP function swaps the order of its parameters. +It does this even for calls requiring only a single parameter. +In that case, +the first parameter is merely a placeholder. .bP -Normally the ncurses library is compiled with terminfo support. -In that case, \fBtgoto\fP uses an internal version of -\fBtparm\fP(3X) (a more capable formatter). +Normally the \fI\%ncurses\fP library is compiled without +full \fI\%termcap\fP support. +In that case, +\fB\%tgoto\fP uses an internal version of \fB\%tparm\fP(3X) +(a more capable function). .IP -With terminfo support, \fBtgoto\fP is able to use some of the terminfo -features, but not all. -In particular, it allows only numeric parameters; -\fBtparm\fP supports string parameters. +Because it uses \fB\%tparm\fP internally, +\fB\%tgoto\fP is able to use some \fI\%term\%info\fP features, +but not all. +In particular, +it allows only numeric parameters; +\fB\%tparm\fP supports string parameters. .IP -However, \fBtparm\fP is not a \fItermcap\fP feature, -and portable \fItermcap\fP applications should not rely upon its availability. -.PP -The \fBtputs\fP routine is described on the \fBcurs_terminfo\fP(3X) manual -page. -It can retrieve capabilities by either termcap or terminfo name. -.SS Global Variables +However, +\fB\%tparm\fP is not a \fItermcap\fP feature, +and portable \fItermcap\fP applications should not rely upon its +availability. .PP +\fB\%tputs\fP is described in \fB\%curs_terminfo\fP(3X). +It can retrieve capabilities by either \fItermcap\fP or +\fI\%term\%info\fP code. +.SS "Global Variables" The variables \fBPC\fP, \fBUP\fP and \fBBC\fP -are set by \fBtgetent\fP to the terminfo entry's data for -\fBpad_char\fP, -\fBcursor_up\fP and -\fBbackspace_if_not_bs\fP, +are set by \fB\%tgetent\fP to the \fI\%term\%info\fP entry's data for +\fB\%pad_char\fP, +\fB\%cursor_up\fP and +\fB\%backspace_if_not_bs\fP, respectively. -\fBUP\fP is not used by ncurses. -\fBPC\fP is used in the \fBtdelay_output\fP function. -\fBBC\fP is used in the \fBtgoto\fP emulation. -The variable \fBospeed\fP is set by ncurses in a system-specific coding -to reflect the terminal speed. -.SS Releasing Memory -The termcap functions provide no means for freeing memory, -because legacy termcap implementations used only the buffer -areas provided by the caller via \fBtgetent\fP and \fBtgetstr\fP. -Those buffers are unused in terminfo. +\fBUP\fP is not used by \fI\%ncurses\fP. +\fBPC\fP is used by \fB\%delay_output\fP(3X). +\fBBC\fP is used by \fB\%tgoto\fP emulation. +The variable \fB\%ospeed\fP is set by \fI\%ncurses\fP using a +system-specific encoding to indicate the terminal's data rate. +.SS "Releasing Memory" +The \fItermcap\fP functions provide no means of freeing memory, +because legacy \fItermcap\fP implementations used only the buffer +areas provided by the caller via \fB\%tgetent\fP and \fB\%tgetstr\fP. +Those buffers are unused in \fI\%term\%info\fP. .PP -On the other hand, terminfo allocates memory. -It uses \fBsetupterm\fP to retrieve the data used by \fBtgetent\fP -and the functions which return capability values such as \fBtgetstr\fP. +By contrast, +\fI\%term\%info\fP allocates memory. +It uses \fB\%setupterm\fP(3X) to obtain the data used by \fB\%tgetent\fP +and the functions that retrieve capability values. One could use -.sp - \fBdel_curterm(cur_term);\fP -.sp -.PP -to free this memory, but there is an additional complication with ncurses. -It uses a fixed-size \fIpool\fP of storage locations, -one per setting of the \fBTERM\fP variable when \fBtgetent\fP is called. -The \fBscreen\fP(1) program relies upon this arrangement, -to improve its performance. -.PP -An application which uses only the low-level termcap functions could -free the memory using \fBdel_curterm\fP, -because the pool is freed using other functions -(see \fBcurs_memleaks\fP(3X)). -. -.SH RETURN VALUE -Except where explicitly noted, -routines that return an integer return \fBERR\fP upon failure and \fBOK\fP -(SVr4 only specifies "an integer value other than \fBERR\fP") upon successful -completion. +.RS +.EX +del_curterm(cur_term); +.EE +.RE +to free this memory, +but there is an additional complication with \fI\%ncurses\fP. +It uses a fixed-size pool of storage locations, +one per value of the terminal name parameter given to \fB\%tgetent\fP. +The \fIscreen\fP(1) program relies upon this arrangement to improve its +performance. .PP -Routines that return pointers return \fBNULL\fP on error. +An application that uses only the \fItermcap\fP functions, +not the higher level +.I \%curses +API, +could release the memory using \fB\%del_curterm\fP(3X), +because the pool is freed using other functions; +see \fB\%curs_memleaks\fP(3X). +.SH "RETURN VALUE" +The return values of +\fB\%tgetent\fP, +\fB\%tgetflag\fP, +\fB\%tgetname\fP, +and +\fB\%tgetstr\fP +are documented above. .PP -A few special cases apply: -.bP -If the terminal database has not been initialized, -these return an error. +\fB\%tgoto\fP returns +.B NULL +on error. +Error conditions include: .bP -The calls with a string parameter (\fBtgoto\fP, \fBtputs\fP) -check if the string is null, or cancelled. -Those return an error. +uninitialized state +(\fB\%tgetent\fP was not called successfully), .bP -A call to \fBtgoto\fP using a capability with string parameters is an error. +.I cap +being a null pointer, .bP -A call to \fBtgoto\fP using a capability with more than two parameters -is an error. -.SH BUGS -If you call \fBtgetstr\fP to fetch \fBca\fP or any other parameterized string, -be aware that it will be returned in terminfo notation, not the older and -not-quite-compatible termcap notation. -This will not cause problems if all -you do with it is call \fBtgoto\fP or \fBtparm\fP, which both expand -terminfo-style strings as terminfo. -(The \fBtgoto\fP function, if configured to support termcap, will check -if the string is indeed terminfo-style by looking for "%p" parameters or -"$<..>" delays, and invoke a termcap-style parser if the string does not -appear to be terminfo). -.PP -Because terminfo conventions for representing padding in string capabilities -differ from termcap's, -users can be surprised: +.I cap +referring to a canceled capability, .bP -\fBtputs("50")\fP in a terminfo system will put out a literal \*(``50\*('' -rather than busy-waiting for 50 milliseconds. +.I cap +being a capability with string-valued parameters +(a \fI\%term\%info\fP-only feature), +and .bP -However, if ncurses is configured to support termcap, -it may also have been configured to support the BSD-style padding. -.IP -In that case, \fBtputs\fP inspects strings passed to it, -looking for digits at the beginning of the string. -.IP -\fBtputs("50")\fP in a termcap system may wait for 50 milliseconds -rather than put out a literal \*(``50\*('' +.I cap +being a capability with more than two parameters. .PP -Note that termcap has nothing analogous to terminfo's \fBsgr\fP string. -One consequence of this is that termcap applications assume \fBme\fP -(terminfo \fBsgr0\fP) does not reset the alternate character set. -This implementation checks for, and modifies the data shown to the -termcap interface to accommodate termcap's limitation in this respect. +See \fB\%curs_terminfo\fP(3X) regarding \fB\%tputs\fP. +.SH NOTES +\fI\%ncurses\fP compares only the first two characters of the \fIid\fP +parameter of +\fB\%tgetflag\fP, +\fB\%tgetnum\fP, +and +\fB\%tgetstr\fP to the capability names in the database. .SH PORTABILITY +These functions are no longer standardized +(and the variables never were); +\fI\%ncurses\fP provides them to support legacy applications. +They should not be used in new programs. .SS Standards -These functions are provided for supporting legacy applications, -and should not be used in new programs: .bP -The XSI Curses standard, Issue 4 describes these functions. -However, they -are marked TO BE WITHDRAWN and may be removed in future versions. +X/Open Curses, Issue 4, Version 2 (1996), +describes these functions, +marking them as +\*(``TO BE WITHDRAWN\*(''. .bP -X/Open Curses, Issue 5 (December 2007) marked the termcap interface -(along with \fBvwprintw\fP and \fBvwscanw\fP) as withdrawn. +X/Open Curses, Issue 7 (2009) marks the \fItermcap\fP interface +(along with \fB\%vwprintw\fP and \fB\%vwscanw\fP) as withdrawn. .PP -Neither the XSI Curses standard nor the SVr4 man pages documented the return -values of \fBtgetent\fP correctly, though all three were in fact returned ever -since SVr1. -In particular, an omission in the XSI Curses documentation has been -misinterpreted to mean that \fBtgetent\fP returns \fBOK\fP or \fBERR\fP. +Neither X/Open Curses nor the SVr4 man pages documented the return +values of \fB\%tgetent\fP correctly, +though all three shown here were in fact returned ever since SVr1. +In particular, +an omission in the X/Open Curses specification has been misinterpreted +to mean that \fB\%tgetent\fP returns \fBOK\fP or \fBERR\fP. Because the purpose of these functions is to provide compatibility with -the \fItermcap\fP library, that is a defect in XCurses, Issue 4, Version 2 -rather than in ncurses. -.SS Compatibility with BSD Termcap +the \fItermcap\fP library, +that is a defect in X/Open Curses, Issue 4, Version 2 +rather than in \fI\%ncurses\fP. +.SS "Compatibility with BSD \fItermcap\fP" +Externally visible variables are provided for support of certain +\fItermcap\fP applications. +However, +their correct usage is poorly documented; +for example, +it is unclear when reading and writing them is meaningful. +In particular, +some applications are reported to declare and/or modify \fB\%ospeed\fP. .PP -External variables are provided for support of certain termcap applications. -However, termcap applications' use of those variables is poorly documented, -e.g., not distinguishing between input and output. -In particular, some applications are reported to declare and/or -modify \fBospeed\fP. -.PP -The comment that only the first two characters of the \fBid\fP parameter -are used escapes many application developers. -The original BSD 4.2 termcap library (and historical relics thereof) -did not require a trailing null NUL on the parameter name passed -to \fBtgetstr\fP, \fBtgetnum\fP and \fBtgetflag\fP. -Some applications assume that the termcap interface does not require -the trailing NUL for the parameter name. -Taking into account these issues: -.bP -As a special case, -\fBtgetflag\fP matched against a single-character identifier -provided that was at the end of the terminal description. -You should not rely upon this behavior in portable programs. -This implementation disallows matches against single-character capability names. +The constraint that only the first two characters of the \fIid\fP +parameter are used escapes many application developers. +The BSD \fItermcap\fP library did not require a trailing null character +on the capability identifier passed to \fB\%tgetstr\fP, +\fB\%tgetnum\fP, +and +\fB\%tgetflag\fP. +.\" See <https://minnie.tuhs.org/cgi-bin/utree.pl?file=2BSD/src/\ +.\" termlib/termcap.c>. +Some applications thus assume that the \fItermcap\fP interface does not +require the trailing null character for the capability identifier. .bP -This implementation disallows matches by the termcap interface against -extended capability names which are longer than two characters. +.I \%ncurses +disallows matches by the \fItermcap\fP interface against extended +capability names that are longer than two characters; +see \fB\%user_caps\fP(5). .PP -The BSD termcap function \fBtgetent\fP returns the text of a termcap -entry in the buffer passed as an argument. -This library (like other terminfo implementations) does not store -terminal descriptions as text. +The BSD \fItermcap\fP function \fB\%tgetent\fP returns the text of a +\fItermcap\fP entry in the buffer passed as an argument. +This library, +like other \fI\%term\%info\fP implementations, +does not store terminal type descriptions as text. It sets the buffer contents to a null-terminated string. -.SS Other Compatibility -This library includes a termcap.h header, -for compatibility with other implementations. -But the header is rarely used because the other implementations -are not strictly compatible. +.SS "Header File" +This library includes a \fI\%termcap.h\fP header for compatibility with +other implementations, +but the header is rarely used because the other implementations are not +strictly compatible. +.SH HISTORY +.\" See https://www.oreilly.com/openbook/opensources/book/kirkmck.html +.\" for much BSD release history. +Bill Joy originated a forerunner of \fItermcap\fP called +\*(``ttycap\*('', +dated September 1977, +and released in 1BSD +(March 1978). +.\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=1BSD/s7/ttycap.c +.\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=1BSD/man7/ttycap.7 +It used many of the same function names as the later \fItermcap\fP, +such as +\fB\%tgetent\fP, +\fB\%tgetflag\fP, +\fB\%tgetnum\fP, +and +\fB\%tgetstr\fP. .PP -The original BSD termcap (through 4.3BSD) had no header file which -gave function prototypes, because that was a feature of ANSI C. -BSD termcap was written several years before C was standardized. -However, there were two different termcap.h header files in the BSD -sources: +A clear descendant, +the \fItermlib\fP library, +.\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=2BSD/src/termlib/ +followed in 2BSD +(May 1979), +adding \fB\%tgoto\fP and \fB\%tputs\fP. +The former applied at that time only to cursor positioning capabilities, +.\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=2BSD/bin/etc/termcap +thus the overly specific name. +Little changed in 3BSD +(late 1979) +except the addition of test programs and a \fI\%termlib\fP man page, +which documented the API shown in section \*(``SYNOPSIS\*('' above. +.\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=3BSD/usr/src/lib/\ +.\" libtermlib/ +.\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=3BSD/usr/man/man3/\ +.\" termlib.3 +.PP +4BSD +(November 1980) +renamed \fItermlib\fP to \fItermcap\fP +.\" ...except in the source tree... +.\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=4BSD/usr/src/lib/\ +.\" libtermlib/makefile +and added another test program. +The library remained much the same though 4.3BSD +(June 1986). +4.4BSD-Lite +(June 1994) +refactored it, +.\" Observe the `tncktc()`, `tnamatch()`, `tskip()`, and `tdecode()` +.\" entry points disappearing from termcap.c. +leaving the API unchanged. +.PP +Function prototypes were a feature of ANSI C (1989). +The library long antedated the standard and thus provided no header file +declaring them. +Nevertheless, +the BSD sources included two different \fI\%termcap.h\fP header files +over time. .bP -One was used internally by the \fBjove\fP editor in 2BSD through 4.4BSD. -It defined global symbols for the termcap variables which it used. +One was used internally by \fBjove\fP(1) from 4.3BSD onward. +.\" 2BSD became a branch retaining support for non-virtual memory +.\" systems (such as the PDP-11) whereas most BSD development focused on +.\" the VAX and other VM-enabled systems starting with 3BSD. +.\" +.\" This man page previously located a termcap.h in 2BSD, but that may +.\" be confusion arising from its backport to 2.9BSD (and still present +.\" in surviving sources for 2.11BSD, the "end of the line" for that +.\" branch's development). +.\" +.\" Observe the copyright notice in +.\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=4.3BSD/usr/contrib/\ +.\" jove/Makefile +.\" --much too late for 2BSD (1979). +It declared global symbols for the \fItermcap\fP variables that it used. .bP -The other appeared in 4.4BSD Lite Release 2 (mid-1993) -as part of \fIlibedit\fP (also known as the \fIeditline\fP library). -The CSRG source history shows that this was added in mid-1992. -The \fIlibedit\fP header file was used internally, -as a convenience for compiling the \fIeditline\fP library. -It declared function prototypes, but no global variables. +The other appeared in 4.4BSD-Lite Release 2 +(June 1995) +as part of \fIlibedit\fP +(also known as the \fI\%edit\%line\fP library). +CSRG source history shows that this was added in mid-1992. +The \fIlibedit\fP header file was used internally as a convenience for +compiling the \fI\%edit\%line\fP library. +It declared function prototypes, +but no global variables. +This header file was added to NetBSD's \fItermcap\fP library in +mid-1994. .PP -The header file from \fIlibedit\fP was added to NetBSD's termcap -library in mid-1994. +Meanwhile, +GNU \fItermcap\fP began development in 1990. +Its first release (1.0) in 1991 included a \fI\%termcap.h\fP header. +Its second (1.1) in September 1992 modified the header to use +\fIconst\fP for the function prototypes in the header where one would +expect the parameters to be read-only. +BSD \fItermcap\fP did not. +The prototype for \fB\%tputs\fP also differed, +but in that instance, +it was \fIlibedit\fP that differed from BSD \fItermcap\fP. .PP -Meanwhile, GNU termcap was under development, starting in 1990. -The first release (termcap 1.0) in 1991 included a termcap.h header. -The second release (termcap 1.1) in September 1992 modified the -header to use \fBconst\fP for the function prototypes in the header -where one would expect the parameters to be read-only. -This was a difference versus the original BSD termcap. -The prototype for \fBtputs\fP also differed, -but in that instance, it was \fIlibedit\fP which differed from BSD termcap. +GNU \fItermcap\fP 1.3 was bundled with \fIbash\fP(1) in mid-1993 to +support the \fI\%readline\fP(3) library. .PP -A copy of GNU termcap 1.3 was bundled with \fIbash\fP in mid-1993, -to support the \fBreadline\fP(3) library. -.PP -A termcap.h file was provided in ncurses 1.8.1 (November 1993). -That reflected influence by \fBemacs\fP(1) (rather than \fBjove\fP(1)) -and GNU termcap: +\fI\%ncurses\fP 1.8.1 +(November 1993) +provided a \fI\%termcap.h\fP file. +It reflected influence from GNU \fItermcap\fP and \fBemacs\fP(1) +(rather than \fBjove\fP(1)), +providing the following interface: .bP -it provided declarations for a few global symbols used by \fBemacs\fP +global symbols used by \fIemacs\fP, .bP -it provided function prototypes (using \fBconst\fP). +\fIconst\fP-qualified function prototypes, +and .bP -a prototype for \fBtparam\fP (a GNU termcap feature) was provided. +a prototype for \fBtparam\fP, +a GNU \fItermcap\fP feature. +.PP +Later +(in mid-1996) +the \fB\%tparam\fP function was removed from \fI\%ncurses\fP. +Any two of the four implementations thus differ, +and programs that intend to work with all \fItermcap\fP library +interfaces must account for that fact. +.SH BUGS +If you call \fB\%tgetstr\fP to fetch +.B \%column_address +.RB ( ch ) +or any other parameterized string capability, +be aware that it is returned in \fI\%term\%info\fP notation, +not the older and not-quite-compatible \fItermcap\fP notation. +This does not cause problems if all you do with it is call \fB\%tgoto\fP +or \fB\%tparm\fP, +which both parametrically expand \fI\%term\%info\fP-style string +capabilities as \fI\%term\%info\fP does. +(If +.I \%ncurses +is configured to support \fItermcap,\fP +\fB\%tgoto\fP checks whether the string is \fI\%term\%info\fP-style by +looking for \*(``\fB%p\fP\*('' parameters or +\*(``\fB<\fP.\|.\|.\fB>\fP\*('' delays, +and invokes a \fItermcap\fP-style parser if the string appears not to +use \fI\%term\%info\fP syntax.) +.PP +Because \fI\%term\%info\fP's syntax for padding in string capabilities +differs from \fItermcap\fP's, +users can be surprised. +.IP \(bu 4 +\fB\%tputs("50")\fP in a \fI\%term\%info\fP system transmits +\*(``50\*('' rather than busy-waiting for 50 milliseconds. +.IP \(bu 4 +However, +if \fI\%ncurses\fP is configured to support \fItermcap\fP, +it may also have been configured to support BSD-style padding. +.IP +In that case, +\fB\%tputs\fP inspects strings passed to it, +looking for digits at the beginning of the string. +.IP +\fB\%tputs("50")\fP in a \fItermcap\fP system may busy-wait for 50 +milliseconds rather than transmitting \*(``50\*(''. +.PP +\fItermcap\fP has nothing analogous to \fI\%term\%info\fP's +.B \%set_attributes +.RB ( sgr ) +capability. +One consequence is that \fItermcap\fP applications assume that +.RB \*(`` me \*('' +(equivalent to \fI\%term\%info\fP's +.B \%exit_attribute_mode +.RB ( sgr0 ) +capability) +does not reset the alternate character set. +\fI\%ncurses\fP checks for, +and modifies the data shared with, +the \fItermcap\fP interface to accommodate the latter's limitation in +this respect. +.SH "SEE ALSO" +\fB\%curses\fP(3X), +\fB\%curs_terminfo\fP(3X), +\fB\%putc\fP(3), +\fB\%term_variables\fP(3X), +\fB\%terminfo\fP(5) .PP -Later (in mid-1996) the \fBtparam\fP function was removed from ncurses. -As a result, there are differences between any of the four implementations, -which must be taken into account by programs which can work with all -termcap library interfaces. -.SH SEE ALSO -\fBcurses\fP(3X), -\fBputc\fP(3), -\fBterm_variables\fP(3X), -\fBterminfo\fP(\*n). -.sp -https://invisible-island.net/ncurses/tctest.html +https://invisible\-island.net/ncurses/tctest.html diff --git a/upstream/archlinux/man3/curs_terminfo.3x b/upstream/archlinux/man3/curs_terminfo.3x index 737104db..a9078d2f 100644 --- a/upstream/archlinux/man3/curs_terminfo.3x +++ b/upstream/archlinux/man3/curs_terminfo.3x @@ -1,5 +1,6 @@ +'\" t .\"*************************************************************************** -.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,750 +28,1115 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_terminfo.3x,v 1.85 2023/04/23 20:52:38 tom Exp $ -.TH curs_terminfo 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_terminfo.3x,v 1.136 2024/04/14 00:14:40 tom Exp $ +.TH curs_terminfo 3X 2024-04-13 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.ds n 5 -.na -.hy 0 +. .SH NAME -\fBdel_curterm\fP, -\fBmvcur\fP, -\fBputp\fP, -\fBrestartterm\fP, -\fBset_curterm\fP, -\fBsetupterm\fP, -\fBtigetflag\fP, -\fBtigetnum\fP, -\fBtigetstr\fP, -\fBtiparm\fP, -\fBtiparm_s\fP, -\fBtiscan_s\fP, -\fBtparm\fP, -\fBtputs\fP, -\fBvid_attr\fP, -\fBvid_puts\fP, -\fBvidattr\fP, -\fBvidputs\fP \- \fBcurses\fP interfaces to terminfo database -.ad -.hy +\fB\%del_curterm\fP, +\fB\%mvcur\fP, +\fB\%putp\fP, +\fB\%restartterm\fP, +\fB\%set_curterm\fP, +\fB\%setupterm\fP, +\fB\%tigetflag\fP, +\fB\%tigetnum\fP, +\fB\%tigetstr\fP, +\fB\%tiparm\fP, +\fB\%tiparm_s\fP, +\fB\%tiscan_s\fP, +\fB\%tparm\fP, +\fB\%tputs\fP, +\fB\%vid_attr\fP, +\fB\%vid_puts\fP, +\fB\%vidattr\fP, +\fB\%vidputs\fP \- +\fIcurses\fR interfaces to \fI\%term\%info\fR database .SH SYNOPSIS .nf -\fB#include <curses.h>\fP -\fB#include <term.h>\fP -.sp -\fBTERMINAL *cur_term;\fP -.sp -\fBconst char * const boolnames[];\fP -\fBconst char * const boolcodes[];\fP -\fBconst char * const boolfnames[];\fP -\fBconst char * const numnames[];\fP -\fBconst char * const numcodes[];\fP -\fBconst char * const numfnames[];\fP -\fBconst char * const strnames[];\fP -\fBconst char * const strcodes[];\fP -\fBconst char * const strfnames[];\fP -.sp -\fBint setupterm(const char *\fIterm\fB, int \fIfiledes\fB, int *\fIerrret\fB);\fR -.br -\fBTERMINAL *set_curterm(TERMINAL *\fInterm\fB);\fR -.br -\fBint del_curterm(TERMINAL *\fIoterm\fB);\fR -.br -\fBint restartterm(const char *\fIterm\fB, int \fIfiledes\fB, int *\fIerrret\fB);\fR -.sp -\fBchar *tparm(const char *\fIstr\fB, ...);\fR -.br - \fIor\fP -.br -\fBchar *tparm(const char *\fIstr\fB, long \fIp1 ... \fBlong \fIp9\fB);\fR -.sp -\fBint tputs(const char *\fIstr\fB, int \fIaffcnt\fB, int (*\fIputc\fB)(int));\fR -.br -\fBint putp(const char *\fIstr\fB);\fR -.sp -\fBint vidputs(chtype \fIattrs\fB, int (*\fIputc\fB)(int));\fR -.br -\fBint vidattr(chtype \fIattrs\fB);\fR -.br -\fBint vid_puts(attr_t \fIattrs\fB, short \fIpair\fB, void *\fIopts\fB, int (*\fIputc\fB)(int));\fR -.br -\fBint vid_attr(attr_t \fIattrs\fB, short \fIpair\fB, void *\fIopts\fB);\fR -.sp -\fBint mvcur(int \fIoldrow\fB, int \fIoldcol\fB, int \fInewrow\fR, int \fInewcol\fB);\fR -.sp -\fBint tigetflag(const char *\fIcapname\fB);\fR -.br -\fBint tigetnum(const char *\fIcapname\fB);\fR -.br -\fBchar *tigetstr(const char *\fIcapname\fB);\fR -.sp -\fBchar *tiparm(const char *\fIstr\fB, ...);\fR -.sp -/* extensions */ -.br -\fBchar *tiparm_s(int \fIexpected\fB, int \fImask\fB, const char *\fIstr\fB, ...);\fR -.br -\fBint tiscan_s(int *\fIexpected\fB, int *\fImask\fB, const char *\fIstr\fB);\fR -.br +\fB#include <curses.h> +\fB#include <term.h> +.PP +\fBTERMINAL *cur_term; +.PP +\fBconst char * const boolnames[]; +\fBconst char * const boolcodes[]; +\fBconst char * const boolfnames[]; +\fBconst char * const numnames[]; +\fBconst char * const numcodes[]; +\fBconst char * const numfnames[]; +\fBconst char * const strnames[]; +\fBconst char * const strcodes[]; +\fBconst char * const strfnames[]; +.PP +\fBint setupterm(const char *\fIterm\fP, int \fIfiledes\fP, int *\fIerrret\fP); +\fBTERMINAL *set_curterm(TERMINAL *\fInterm\fP); +\fBint del_curterm(TERMINAL *\fIoterm\fP); +\fBint restartterm(const char *\fIterm\fP, int \fIfiledes\fP, int *\fIerrret\fP); +.PP +\fBchar *tparm(const char *\fIstr\fP, \fR.\|.\|.\fP); + \fI/* or */ +\fBchar *tparm(const char *\fIstr\fP, long \fIp1\fP \fR.\|.\|.\fP \fBlong\fP \fIp9\fP); +.PP +\fBint tputs(const char *\fIstr\fP, int \fIaffcnt\fP, int (*\fIputc\fP)(int)); +\fBint putp(const char *\fIstr\fP); +.PP +\fBint vidputs(chtype \fIattrs\fP, int (*\fIputc\fP)(int)); +\fBint vidattr(chtype \fIattrs\fP); +\fBint vid_puts(attr_t \fIattrs\fP, short \fIpair\fP, void *\fIopts\fP, int (*\fIputc\fP)(int)); +\fBint vid_attr(attr_t \fIattrs\fP, short \fIpair\fP, void *\fIopts\fP); +.PP +\fBint mvcur(int \fIoldrow\fP, int \fIoldcol\fP, int \fInewrow\fP, int \fInewcol\fP); +.PP +\fBint tigetflag(const char *\fIcap-code\fP); +\fBint tigetnum(const char *\fIcap-code\fP); +\fBchar *tigetstr(const char *\fIcap-code\fP); +.PP +\fBchar *tiparm(const char *\fIstr\fP, \fR.\|.\|.\fP); +.PP +\fI/* extensions */ +\fBchar *tiparm_s(int \fIexpected\fP, int \fImask\fP, const char *\fIstr\fP, ...); +\fBint tiscan_s(int *\fIexpected\fP, int *\fImask\fP, const char *\fIstr\fP); +.PP +\fI/* deprecated */ +\fBint setterm(const char *\fIterm\fP); .fi .SH DESCRIPTION -These low-level routines must be called by programs that have to deal -directly with the \fBterminfo\fP database to handle certain terminal -capabilities, such as programming function keys. -For all other -functionality, \fBcurses\fP routines are more suitable and their use is -recommended. +These low-level functions must be called by programs that deal directly +with the +.I \%term\%info +database to handle certain terminal capabilities, +such as programming function keys. +For all other functionality, +.I curses +functions are more suitable and their use is recommended. .PP -None of these functions use (or are aware of) multibyte character strings -such as UTF-8: +None of these functions use +(or are aware of) +multibyte character strings such as UTF-8. .bP -capability names use the POSIX portable character set +Capability names and codes use the POSIX portable character set. .bP -capability string values have no associated encoding; +Capability string values have no associated encoding; they are strings of 8-bit characters. .SS Initialization +Initially, +\fB\%setupterm\fP should be called. +The high-level +.I curses +functions \fB\%initscr\fP and \fB\%newterm\fP call \fB\%setupterm\fP to +initialize the low-level set of terminal-dependent variables listed in +\fB\%term_variables\fP(3X). .PP -Initially, \fBsetupterm\fP should be called. -The high-level curses functions \fBinitscr\fP and -\fBnewterm\fP call \fBsetupterm\fP to initialize the -low-level set of terminal-dependent variables -[listed in \fBterminfo\fP(\*n)]. -.PP -Applications can use the -terminal capabilities either directly (via header definitions), +Applications can use the terminal capabilities either directly +(via header definitions), or by special functions. -The header files \fBcurses.h\fP and \fBterm.h\fP should be included (in this -order) to get the definitions for these strings, numbers, and flags. +The header files +.I \%curses.h +and +.I \%term.h +should be included +(in that order) +to get the definitions for these strings, +numbers, +and flags. .PP -The \fBterminfo\fP variables -\fBlines\fP and \fBcolumns\fP are initialized by \fBsetupterm\fP as -follows: +The +.I \%term\%info +variables +.B \%lines +and +.B \%columns +are initialized by \fB\%setupterm\fP as follows. .bP -If \fBuse_env(FALSE)\fP has been called, values for -\fBlines\fP and \fBcolumns\fP specified in \fBterminfo\fP are used. +If \fB\%use_env(FALSE)\fP has been called, +values for +.B \%lines +and +.B \%columns +specified in +.I \%term\%info +are used. .bP -Otherwise, if the environment variables \fBLINES\fP and \fBCOLUMNS\fP -exist, their values are used. -If these environment variables do not -exist and the program is running in a window, the current window size +Otherwise, +if the environment variables +.I LINES +and +.I \%COLUMNS +exist, +their values are used. +If these environment variables do not exist and the program is running +in a window, +the current window size is used. -Otherwise, if the environment variables do not exist, the -values for \fBlines\fP and \fBcolumns\fP specified in the -\fBterminfo\fP database are used. -.PP -Parameterized strings should be passed through \fBtparm\fP to instantiate them. -All \fBterminfo\fP strings -(including the output of \fBtparm\fP) -should be printed -with \fBtputs\fP or \fBputp\fP. -Call \fBreset_shell_mode\fP to restore the -tty modes before exiting [see \fBcurs_kernel\fP(3X)]. -.PP -Programs which use +Otherwise, +if the environment variables do not exist, +the values for +.B \%lines +and +.B \%columns +specified in the +.I \%term\%info +database are used. +.PP +Parameterized strings should be passed through \fB\%tparm\fP to +instantiate them. +All +.I \%term\%info +strings +(including the output of \fB\%tparm\fP) +should be sent to the terminal device with \fB\%tputs\fP or +\fB\%putp\fP. +Call \fB\%reset_shell_mode\fP to restore the terminal modes before +exiting; +see \fB\%curs_kernel\fP(3X). +.PP +Programs that use cursor addressing should .bP -output \fBenter_ca_mode\fP upon startup and +output \fB\%enter_ca_mode\fP upon startup and .bP -output \fBexit_ca_mode\fP before exiting. +output \fB\%exit_ca_mode\fP before exiting. .PP -Programs which execute shell subprocesses should +Programs that execute shell subprocesses should .bP -call \fBreset_shell_mode\fP and -output \fBexit_ca_mode\fP before the shell +call \fB\%reset_shell_mode\fP and +output \fB\%exit_ca_mode\fP before the shell is called and .bP -output \fBenter_ca_mode\fP and -call \fBreset_prog_mode\fP after returning from the shell. +output \fB\%enter_ca_mode\fP and +call \fB\%reset_prog_mode\fP after returning from the shell. .PP -The \fBsetupterm\fP routine reads in the \fBterminfo\fP database, -initializing the \fBterminfo\fP structures, but does not set up the -output virtualization structures used by \fBcurses\fP. -These are its parameters: +\fB\%setupterm\fP reads in the +.I \%term\%info +database, +initializing the +.I \%term\%info +structures, +but does not set up the output virtualization structures used by +.IR curses . +Its parameters follow. .RS 3 .TP 5 -\fIterm\fP -is the terminal type, a character string. -If \fIterm\fP is null, the environment variable \fBTERM\fP is used. +.I term +is the terminal type, +a character string. +If +.I term +is null, +the environment variable +.I TERM +is read. .TP 5 -\fIfiledes\fP -is the file descriptor used for all output. +.I filedes +is the file descriptor used for getting and setting terminal I/O modes. +.IP +Higher-level applications use \fB\%newterm\fP(3X) to initialize the +terminal, +passing an output +.I stream +rather than a +.IR descriptor . +In +.IR curses , +the two are the same because \fB\%newterm\fP calls \fB\%setupterm\fP, +passing the file descriptor derived from its output stream parameter. .TP 5 -\fIerrret\fP +.I errret points to an optional location where an error status can be returned to the caller. -If \fIerrret\fP is not null, -then \fBsetupterm\fP returns \fBOK\fP or -\fBERR\fP and stores a status value in the integer pointed to by -\fIerrret\fP. -A return value of \fBOK\fP combined with status of \fB1\fP in \fIerrret\fP +If +.I errret +is not null, +then \fB\%setupterm\fP returns +.B OK +or +.B ERR +and stores a status value in the integer pointed to by +.IR errret . +A return value of +.B OK +combined with status of +.B 1 +in +.I errret is normal. .IP -If \fBERR\fP is returned, examine \fIerrret\fP: +If +.B ERR +is returned, +examine +.I errret: .RS .TP 5 .B 1 -means that the terminal is hardcopy, cannot be used for curses applications. +means that the terminal is hardcopy, +and cannot be used for +.I curses +applications. .IP -\fBsetupterm\fP determines if the entry is a hardcopy type by -checking the \fBhc\fP (\fBhardcopy\fP) capability. +\fB\%setupterm\fP determines if the entry is a hardcopy type by +checking the +.B \%hardcopy +.RB ( hc ) +capability. .TP 5 .B 0 means that the terminal could not be found, or that it is a generic type, -having too little information for curses applications to run. +having too little information for +.I curses +applications to run. .IP -\fBsetupterm\fP determines if the entry is a generic type by -checking the \fBgn\fP (\fBgeneric\fP) capability. +\fB\%setupterm\fP determines if the entry is a generic type by +checking the +.B \%generic_type +.RB ( gn ) +capability. .TP 5 .B \-1 -means that the \fBterminfo\fP database could not be found. +means that the +.I \%term\%info +database could not be found. .RE .IP -If \fIerrret\fP is -null, \fBsetupterm\fP prints an error message upon finding an error -and exits. -Thus, the simplest call is: -.sp - \fBsetupterm((char *)0, 1, (int *)0);\fP, -.sp -which uses all the defaults and sends the output to \fBstdout\fP. +If +.I errret +is null, +\fB\%setupterm\fP reports an error message upon finding an error and +exits. +Thus, +the simplest call is: +.RS +.IP +.EX +setupterm((char *)0, 1, (int *)0); +.EE .RE -.\" *************************************************************************** -.SS The Terminal State -.PP -The \fBsetupterm\fP routine stores its information about the terminal -in a \fBTERMINAL\fP structure pointed to by the global variable \fBcur_term\fP. +.IP +which uses all the defaults and sends the output to +.BR stdout . +.RE +.\" ******************************************************************** +.SS "The Terminal State" +\fB\%setupterm\fP stores its information about the terminal in a +.I \%TERMINAL +structure pointed to by the global variable \fB\%cur_term\fP. If it detects an error, -or decides that the terminal is unsuitable (hardcopy or generic), +or decides that the terminal is unsuitable +(hardcopy or generic), it discards this information, making it not available to applications. .PP -If \fBsetupterm\fP is called repeatedly for the same terminal type, +If \fB\%setupterm\fP is called repeatedly for the same terminal type, it will reuse the information. It maintains only one copy of a given terminal's capabilities in memory. If it is called for different terminal types, -\fBsetupterm\fP allocates new storage for each set of terminal capabilities. -.PP -The \fBset_curterm\fP routine sets \fBcur_term\fP to -\fInterm\fP, and makes all of the \fBterminfo\fP boolean, numeric, and -string variables use the values from \fInterm\fP. -It returns the old value of \fBcur_term\fP. -.PP -The \fBdel_curterm\fP routine frees the space pointed to by -\fIoterm\fP and makes it available for further use. -If \fIoterm\fP is -the same as \fBcur_term\fP, references to any of the \fBterminfo\fP -boolean, numeric, and string variables thereafter may refer to invalid -memory locations until another \fBsetupterm\fP has been called. -.PP -The \fBrestartterm\fP routine is similar to \fBsetupterm\fP and \fBinitscr\fP, -except that it is called after restoring memory to a previous state (for -example, when reloading a game saved as a core image dump). -\fBrestartterm\fP assumes that the windows and the input and output options -are the same as when memory was saved, -but the terminal type and baud rate may be different. -Accordingly, \fBrestartterm\fP saves various tty state bits, -calls \fBsetupterm\fP, and then restores the bits. -.\" *************************************************************************** -.SS Formatting Output +\fB\%setupterm\fP allocates new storage for each set of terminal +capabilities. +.PP +\fB\%set_curterm\fP sets \fB\%cur_term\fP to +.IR \%nterm , +and makes all of the +.I \%term\%info +Boolean, +numeric, +and string variables use the values from +.IR \%nterm . +It returns the old value of \fB\%cur_term\fP. +.PP +\fB\%del_curterm\fP frees the space pointed to by +.I \%oterm +and makes it available for further use. +If +.I \%oterm +is +the same as \fB\%cur_term\fP, +references to any of the +.I \%term\%info +Boolean, +numeric, +and string variables thereafter may refer to invalid memory locations +until another \fB\%setupterm\fP has been called. .PP -The \fBtparm\fP routine instantiates the string \fIstr\fP with -parameters \fIpi\fP. A pointer is returned to the result of \fIstr\fP +\fB\%restartterm\fP is similar to \fB\%setupterm\fP and \fB\%initscr\fP, +except that it is called after restoring memory to a previous state +(for example, +when reloading a game saved as a core image dump). +\fB\%restartterm\fP assumes that the windows and the input and output +options are the same as when memory was saved, +but the terminal type and baud rate may be different. +Accordingly, +\fB\%restartterm\fP saves various terminal state bits, +calls \fB\%setupterm\fP, +and then restores the bits. +.\" ******************************************************************** +.SS "Formatting Output" +\fB\%tparm\fP instantiates the string +.I str +with parameters +.IR pi . +A pointer is returned to the result of +.I str with the parameters applied. -Application developers should keep in mind these quirks of the interface: +Application developers should keep in mind these quirks of the +interface: .bP -Although \fBtparm\fP's actual parameters may be integers or strings, -the prototype expects \fBlong\fP (integer) values. +Although \fB\%tparm\fP's actual parameters may be integers or strings, +the prototype expects +.I long +(integer) values. .bP -Aside from the \fBset_attributes\fP (\fBsgr\fP) capability, +Aside from the +.B \%set_attributes\fP +.RB ( sgr ) +capability, most terminal capabilities require no more than one or two parameters. .bP -Padding information is ignored by \fBtparm\fP; -it is interpreted by \fBtputs\fP. +Padding information is ignored by \fB\%tparm\fP; +it is interpreted by \fB\%tputs\fP. .bP The capability string is null-terminated. -Use \*(``\\200\*('' where an ASCII NUL is needed in the output. +Use \*(``\e200\*('' where an ASCII NUL is needed in the output. .PP -\fBtiparm\fP is a newer form of \fBtparm\fP which uses \fI<stdarg.h>\fP +\fB\%tiparm\fP is a newer form of \fB\%tparm\fP which uses +.I \%stdarg.h rather than a fixed-parameter list. -Its numeric parameters are integers (int) rather than longs. +Its numeric parameters are +.IR int s +rather than +.IR long "s." .PP -Both \fBtparm\fP and \fBtiparm\fP assume that the application passes +Both \fB\%tparm\fP and \fB\%tiparm\fP assume that the application passes parameters consistent with the terminal description. -Two extensions are provided as alternatives to deal with untrusted data: +Two extensions are provided as alternatives to deal with untrusted data. .bP -\fBtiparm_s\fP is an extension which is a safer formatting function -than \fBtparm\fR or \fBtiparm\fR, -because it allows the developer to tell the curses +\fB\%tiparm_s\fP is an extension which is a safer formatting function +than \fB\%tparm\fR or \fB\%tiparm\fR, +because it allows the developer to tell the +.I curses library how many parameters to expect in the parameter list, and which may be string parameters. .IP The \fImask\fP parameter has one bit set for each of the parameters -(up to 9) which will be passed as char* rather than numbers. -.bP -The extension \fBtiscan_s\fP allows the application -to inspect a formatting capability to see what the curses library would assume. -.\" *************************************************************************** -.SS Output Functions -.PP -The \fBtputs\fP routine applies padding information -(i.e., by interpreting marker embedded in the terminfo capability -such as \*(``$<5>\*('' as 5 milliseconds) -to the string -\fIstr\fP and outputs it: -.bP -The \fIstr\fP parameter must be a terminfo string -variable or the return value from -\fBtparm\fP, \fBtiparm\fP, \fBtgetstr\fP, or \fBtgoto\fP. +(up to 9) +passed as +.I char +pointers rather than numbers. +.bP +The extension \fB\%tiscan_s\fP allows the application to inspect a +formatting capability to see what the +.I curses +library would assume. +.\" ******************************************************************** +.SS "Output Functions" +String capabilities can contain padding information, +a time delay +(accommodating performance limitations of hardware terminals) +expressed as \fB$<\fIn\fB>\fR, +where \fIn\fP is a nonnegative integral count of milliseconds. +If \fIn\fP exceeds 30,000 +(thirty seconds), +it is capped at that value. +.PP +\fB\%tputs\fP interprets time-delay information in the string +.I str +and outputs it, +executing the delays: +.bP +The +.I str +parameter must be a +.I \%term\%info +string variable or the return value of +\fB\%tparm\fP, +\fB\%tiparm\fP, +\fB\%tgetstr\fP, +or \fB\%tgoto\fP. .IP -The \fBtgetstr\fP and \fBtgoto\fP functions are part of the \fItermcap\fP +The \fB\%tgetstr\fP and \fB\%tgoto\fP functions are part of the +.I termcap interface, -which happens to share this function name with the \fIterminfo\fP interface. +which happens to share these function names with the +.I \%term\%info +API. .bP -\fIaffcnt\fP is the number of lines affected, or 1 if -not applicable. +.I affcnt +is the number of lines affected, +or +.B 1 +if not applicable. .bP -\fIputc\fP is a \fBputchar\fP-like routine to which -the characters are passed, one at a time. +.I putc +is a +.IR \%putchar -like +function to which the characters are passed, +one at a time. +.IP +If \fB\%tputs\fP processes a time-delay, +it uses the \fB\%delay_output\fP(3X) function, +routing any resulting padding characters through this function. .PP -The \fBputp\fR routine calls \fBtputs(\fIstr\fB, 1, putchar)\fR. -The output of \fBputp\fP always goes to \fBstdout\fP, rather than -the \fIfiledes\fP specified in \fBsetupterm\fP. +\fB\%putp\fR calls +.RB \%\*(`` tputs(\c +.IB str ", 1, putchar)\c" +\*(''. +The output of \fB\%putp\fP always goes to +.BR stdout , +rather than the +.I \%file\%des +specified in \fB\%setupterm\fP. .PP -The \fBvidputs\fP routine displays the string on the terminal in the -video attribute mode \fIattrs\fP, which is any combination of the -attributes listed in \fBcurses\fP(3X). -The characters are passed to -the \fBputchar\fP-like routine \fIputc\fP. +\fB\%vidputs\fP displays the string on the terminal in the video +attribute mode +.IR attrs , +which is any combination of the attributes listed in \fB\%curses\fP(3X). +The characters are passed to the +.IR \%putchar -like +function +.IR putc . .PP -The \fBvidattr\fP routine is like the \fBvidputs\fP routine, except -that it outputs through \fBputchar\fP. +\fB\%vidattr\fP is like \fB\%vidputs\fP, +except that it outputs through \fI\%putchar\fP(3). .PP -The \fBvid_attr\fP and \fBvid_puts\fP routines correspond -to vidattr and vidputs, respectively. -They use a set of arguments for representing the video attributes plus color, -i.e., +.B \%vid_attr +and +.B \%vid_puts +correspond to +.B \%vidattr +and +.BR \%vidputs , +respectively. +They use multiple parameters to represent the character attributes and +color; +namely, .bP -\fIattrs\fP of type \fBattr_t\fP for the attributes and +.IR \%attrs , +of type +.IR \%attr_t , +for the attributes and .bP -\fIpair\fP of type \fBshort\fP for the color-pair number. +.IR pair , +of type +.IR short , +for the color pair number. .PP -The \fBvid_attr\fP and \fBvid_puts\fP routines -are designed to use the attribute constants with the \fBWA_\fP prefix. +Use the attribute constants prefixed with +.RB \*(`` WA_ \*('' +with +.B \%vid_attr +and +.BR \%vid_puts . .PP -X/Open Curses reserves the \fIopts\fP argument for future use, -saying that applications must provide a null pointer for that argument. -As an extension, -this implementation allows \fIopts\fP to be used as a pointer to \fBint\fP, -which overrides the \fIpair\fP (\fBshort\fP) argument. +X/Open Curses reserves the +.I opts +argument for future use, +saying that applications must provide a null pointer for that argument; +but see section \*(``EXTENSIONS\*('' below. .PP -The \fBmvcur\fP routine provides low-level cursor motion. -It takes effect immediately (rather than at the next refresh). +\fB\%mvcur\fP provides low-level cursor motion. +It takes effect immediately +(rather than at the next refresh). +Unlike the other low-level output functions, +which either write to the standard output or pass an output function +parameter, +\fB\%mvcur\fP uses an output file descriptor derived from +the output stream parameter of \fB\%newterm\fP(3X). .PP -While \fBputp\fP and \fBmvcur\fP are low-level functions which -do not use the high-level curses state, -they are declared in \fB<curses.h>\fP because SystemV did this -(see \fIHISTORY\fP). -.\" *************************************************************************** -.SS Terminal Capability Functions +While \fB\%putp\fP and \fB\%mvcur\fP are low-level functions that do not +use high-level +.I curses +state, +.I \%ncurses +declares them in +.I \%curses.h +because System\ V did this +(see section \*(``HISTORY\*('' below). +.\" ******************************************************************** +.SS "Terminal Capability Functions" +\fB\%tigetflag\fP, +\fB\%tigetnum\fP, +and \fB\%tigetstr\fP return the value of the capability corresponding to +the +.I \%term\%info +.IR cap-code , +such as +.BR xenl , +passed to them. +The +.I cap-code +for each capability is given in the table column entitled +.I cap-code +code in the capabilities section of \fB\%terminfo\fP(5). .PP -The \fBtigetflag\fP, \fBtigetnum\fP and \fBtigetstr\fP routines return -the value of the capability corresponding to the \fBterminfo\fP -\fIcapname\fP passed to them, such as \fBxenl\fP. -The \fIcapname\fP for each capability is given in the table column entitled -\fIcapname\fP code in the capabilities section of \fBterminfo\fP(\*n). +These functions return special values to denote errors. .PP -These routines return special values to denote errors. -.PP -The \fBtigetflag\fP routine returns +\fB\%tigetflag\fP returns .TP -\fB\-1\fP -if \fIcapname\fP is not a boolean capability, +.B \-1 +if +.I cap-code +is not a Boolean capability, or .TP -\fB0\fP +.B 0 if it is canceled or absent from the terminal description. .PP -The \fBtigetnum\fP routine returns +\fB\%tigetnum\fP returns .TP -\fB\-2\fP -if \fIcapname\fP is not a numeric capability, or +.B \-2 +if +.I cap-code +is not a numeric capability, +or .TP -\fB\-1\fP +.B \-1 if it is canceled or absent from the terminal description. .PP -The \fBtigetstr\fP routine returns +\fB\%tigetstr\fP returns .TP -\fB(char *)\-1\fP -if \fIcapname\fP is not a string capability, +.B "(char *)\-1" +if +.I cap-code +is not a string capability, or .TP -\fB0\fP +.B 0 if it is canceled or absent from the terminal description. -.\" *************************************************************************** -.SS Terminal Capability Names -.PP +.\" ******************************************************************** +.SS "Terminal Capability Names" These null-terminated arrays contain .bP -the short terminfo names (\*(``codes\*(''), +the short \fI\%term\%info\fP names (\*(``codes\*(''), .bP -the \fBtermcap\fP names (\*(``names\*(''), and +the \fItermcap\fP names (\*(``names\*(''), +and .bP -the long terminfo names (\*(``fnames\*('') +the long \fI\%term\%info\fP names (\*(``fnames\*('') +.PP +for each of the predefined +.I \%term\%info +variables: .PP -for each of the predefined \fBterminfo\fP variables: -.sp .RS +.nf \fBconst char *boolnames[]\fP, \fB*boolcodes[]\fP, \fB*boolfnames[]\fP -.br \fBconst char *numnames[]\fP, \fB*numcodes[]\fP, \fB*numfnames[]\fP -.br \fBconst char *strnames[]\fP, \fB*strcodes[]\fP, \fB*strfnames[]\fP +.fi .RE -.\" *************************************************************************** -.SS Releasing Memory -Each successful call to \fBsetupterm\fP allocates memory to hold the terminal -description. -As a side-effect, it sets \fBcur_term\fP to point to this memory. +.\" ******************************************************************** +.SS "Releasing Memory" +Each successful call to \fB\%setupterm\fP allocates memory to hold the +terminal description. +As a side effect, +it sets \fB\%cur_term\fP to point to this memory. If an application calls -.sp - \fBdel_curterm(cur_term);\fP -.sp +.IP +.EX +del_curterm(cur_term); +.EE +.PP the memory will be freed. .PP -The formatting functions \fBtparm\fP and \fBtiparm\fP extend the storage -allocated by \fBsetupterm\fP: +The formatting functions \fB\%tparm\fP and \fB\%tiparm\fP extend the +storage allocated by \fB\%setupterm\fP as follows. .bP -the \*(``static\*('' terminfo variables [a-z]. -Before ncurses 6.3, those were shared by all screens. -With ncurses 6.3, those are allocated per screen. -See \fBterminfo\fP(\*n) for details. +They add the \*(``static\*('' +.I \%term\%info +variables [a-z]. +Before +.I \%ncurses +6.3, +those were shared by all screens. +With +.I \%ncurses +6.3, +those are allocated per screen. +See \fB\%terminfo\fP(5). .bP -to improve performance, ncurses 6.3 caches the result of analyzing terminfo +To improve performance, +.I \%ncurses +6.3 caches the result of analyzing +.I \%term\%info strings for their parameter types. -That is stored as a binary tree referenced from the \fBTERMINAL\fP structure. +That is stored as a binary tree referenced from the +.I \%TERMINAL +structure. .PP -The higher-level \fBinitscr\fP and \fBnewterm\fP functions use \fBsetupterm\fP. -Normally they do not free this memory, but it is possible to do that using -the \fBdelscreen\fP(3X) function. -.\" *************************************************************************** +The higher-level \fB\%initscr\fP and \fB\%newterm\fP functions use +\fB\%setupterm\fP. +Normally they do not free this memory, +but it is possible to do that using the \fB\%delscreen\fP(3X) function. +.\" ******************************************************************** .SH RETURN VALUE -Routines that return an integer return \fBERR\fP upon failure and \fBOK\fP -(SVr4 only specifies \*(``an integer value other than \fBERR\fP\*('') -upon successful completion, -unless otherwise noted in the preceding routine descriptions. -.PP -Routines that return pointers always return \fBNULL\fP on error. -.PP -X/Open defines no error conditions. -In this implementation -.RS 3 +X/Open Curses defines no failure conditions. +In +.IR \%ncurses , .TP 5 -\fBdel_curterm\fP -returns an error -if its terminal parameter is null. +.B del_curtem +fails if its terminal parameter is null. .TP 5 -\fBputp\fP -calls \fBtputs\fP, returning the same error-codes. +.B putp +calls \fB\%tputs\fP, +returning the same error codes. .TP 5 -\fBrestartterm\fP -returns an error -if the associated call to \fBsetupterm\fP returns an error. +.B restartterm +fails if the associated call to \fB\%setupterm\fP returns an error. .TP 5 -\fBsetupterm\fP -returns an error -if it cannot allocate enough memory, or -create the initial windows (stdscr, curscr, newscr). +.B setupterm +fails if it cannot allocate enough memory, +or create the initial windows +.RB ( \%stdscr , +.BR \%curscr , +and +.BR \%newscr ) Other error conditions are documented above. .TP 5 -\fBtparm\fP -returns a null if the capability would require unexpected parameters, -e.g., too many, too few, or incorrect types -(strings where integers are expected, or vice versa). +.B tparm +returns a null pointer if the capability would require unexpected +parameters; +that is, +too many, +too few, +or incorrect types +(strings where integers are expected, +or vice versa). .TP 5 -\fBtputs\fP -returns an error if the string parameter is null. +.B tputs +fails if the string parameter is null. It does not detect I/O errors: -X/Open states that \fBtputs\fP ignores the return value -of the output function \fIputc\fP. -.RE -.\" *************************************************************************** -.SS Compatibility macros +X/Open Curses states that \fB\%tputs\fP ignores the return value +of the output function \fI\%putc\fP. +.\" ******************************************************************** +.SH NOTES +The +.B \%vid_attr +function in +.I \%ncurses +is a special case. +It was originally implemented based on a draft of X/Open Curses, +as a macro, +before other parts of the +.I \%ncurses +wide-character API were developed, +and unlike the other wide-character functions, +is also provided in the non-wide-character configuration. +.\" ******************************************************************** +.SH EXTENSIONS +The functions marked as extensions were designed for +.IR \%ncurses , +and are not found in SVr4 +.IR curses , +4.4BSD +.IR curses , +or any other previous +.I curses +implementation. +.PP +.I \%ncurses +allows +.I opts +to be a pointer to +.IR int , +which overrides the +.I pair +.RI ( short ) +argument. +.\" ******************************************************************** +.SH PORTABILITY +\fB\%setterm\fP is not described by X/Open and must be considered +non-portable. +All other functions are as described by X/Open. +.SS "Compatibility Macros" This implementation provides a few macros for compatibility with systems -before SVr4 (see \fIHISTORY\fP). -Those include -\fBcrmode\fP, -\fBfixterm\fP, -\fBgettmode\fP, -\fBnocrmode\fP, -\fBresetterm\fP, -\fBsaveterm\fP, and -\fBsetterm\fP. -.PP -In SVr4, those are found in \fB<curses.h>\fP, -but except for \fBsetterm\fP, are likewise macros. -The one function, \fBsetterm\fP, is mentioned in the manual page. -The manual page notes that the \fBsetterm\fP routine -was replaced by \fBsetupterm\fP, stating that the call: -.sp - \fBsetupterm(\fIterm\fB, 1, (int *)0)\fR -.sp -provides the same functionality as \fBsetterm(\fIterm\fB)\fR, -and is not recommended for new programs. -This implementation provides each of those symbols -as macros for BSD compatibility, -.\" *************************************************************************** +before SVr4 +(see section \*(``HISTORY\*('' below). +They include +\fB\%Bcrmode\fP, +\fB\%Bfixterm\fP, +\fB\%Bgettmode\fP, +\fB\%Bnocrmode\fP, +\fB\%Bresetterm\fP, +\fB\%Bsaveterm\fP, +and +\fB\%Bsetterm\fP. +.PP +In SVr4, +these are found in +.IR \%curses.h , +but except for \fB\%setterm\fP, +are likewise macros. +The one function, +\fB\%setterm\fP, +is mentioned in the manual page. +It further notes that \fB\%setterm\fP was replaced by \fB\%setupterm\fP, +stating that the call +.RS +.EX +setupterm(\fIterm\fP, 1, (int *)0) +.EE +.RE +provides the same functionality as \fB\%setterm(\fIterm\fB)\fR, +discouraging the latter for new programs. +.I \%ncurses +implements each of these symbols as macros for BSD +.I curses +compatibility. +.SS "Legacy Data" +\fB\%setupterm\fP copies the terminal name to the array \fB\%ttytype\fP. +This is not part of X/Open Curses, +but is assumed by some applications. +.PP +Other implementions may not declare the capability name arrays. +Some provide them without declaring them. +X/Open Curses does not specify them. +.PP +Extended terminal capability names, +as defined by +.RB \%\*(`` "tic \-x" \*('', +are not stored in the arrays described here. +.SS "Output Buffering" +Older versions of \fI\%ncurses\fP assumed that the file descriptor +passed to \fB\%setupterm\fP from \fB\%initscr\fP or \fB\%newterm\fP uses +buffered I/O, +and would write to the corresponding stream. +In addition to the limitation that the terminal was left in +block-buffered mode on exit +(like System\ V +.IR curses ), +it was problematic because +.I \%ncurses +did not allow a reliable way to clean up on receiving +.BR SIGTSTP . +.PP +The current version (ncurses6) +uses output buffers managed directly by +.IR \%ncurses . +Some of the low-level functions described in this manual page write +to the standard output. +They are not signal-safe. +The high-level functions in +.I \%ncurses +employ alternate versions of these functions using the more reliable +buffering scheme. +.SS "Function Prototypes" +The X/Open Curses prototypes are based on the SVr4 +.I curses +header declarations, +which were defined at the same time the C language was first +standardized in the late 1980s. +.bP +X/Open Curses uses +.I \%const +less effectively than a later design might, +sometimes applying it needlessly to values that are already constant, +and in most cases overlooking parameters that normally would use +.IR \%const . +Passing +.IR \%const -qualified +parameters to functions that do not declare them +.I \%const +may prevent the program from compiling. +On the other hand, +\*(``writable strings\*('' are an obsolescent feature. +.IP +As an extension, +this implementation can be configured to change the function prototypes +to use the +.I \%const +keyword. +The +.I \%ncurses +ABI 6 enables this feature by default. +.bP +X/Open Curses prototypes \fB\%tparm\fP with a fixed number of +parameters, +rather than a variable argument list. +.IP +This implementation uses a variable argument list, +but can be configured to use the fixed-parameter list. +Portable applications should provide nine parameters after the format; +zeroes are fine for this purpose. +.IP +In response to review comments by Thomas E. Dickey, +X/Open Curses Issue 7 proposed the \fB\%tiparm\fP function in mid-2009. +.IP +While \fB\%tiparm\fP is always provided in \fI\%ncurses\fP, +the older form is only available as a build-time configuration option. +If not specially configured, +\fB\%tparm\fP is the same as \fB\%tiparm\fP. +.PP +Both forms of \fB\%tparm\fP have drawbacks: +.bP +Most of the calls to \fB\%tparm\fP use only one or two parameters. +Passing nine on each call is awkward. +.IP +Using +.I long +for the numeric parameter type is a workaround to make the parameter use +the same amount of stack as a pointer. +That approach dates back to the mid-1980s, +before C was standardized. +Since then, +there is a standard +(and pointers are not required to fit in a +.IR long ). +.bP +Providing the right number of parameters for a variadic function +such as \fB\%tiparm\fP can be a problem, +in particular for string parameters. +However, +only a few +.I \%term\%info +capabilities use string parameters +(for instance, +the ones used for programmable function keys). +.IP +The \fI\%ncurses\fP library checks usage of these capabilities, +and returns an error if the capability mishandles string parameters. +But it cannot check if a calling program provides strings in the right +places for the \fB\%tparm\fP calls. +.IP +The \fB\%tput\fR(1) program checks its use of these capabilities with +a table, +so that it calls \fB\%tparm\fP correctly. +.SS "Special \fITERM\fP treatment" +If configured to use the terminal driver, +.\" XXX: as opposed to the Unix terminal driver, termio(s)? +as with the MinGW port, +.bP +\fB\%setupterm\fP interprets a missing/empty \fITERM\fP variable as the +special value \*(``unknown\*(''. +.IP +SVr4 +.I curses +uses the special value \*(``dumb\*(''. +.IP +The difference between the two is that the former uses the +.B \%generic_type +.RB ( gn ) +.I \%term\%info +capability, +while the latter does not. +A generic terminal is unsuitable for full-screen applications. +.bP +\fB\%setupterm\fP allows explicit use of the +the windows console driver by checking if \fB$TERM\fP is set to +\*(``#win32con\*('' or an abbreviation of that string. +.SS "Other Portability Issues" +In SVr4, +\fB\%set_curterm\fP returns an +.IR int , +.B OK +or +.BR ERR . +We have chosen to implement the X/Open Curses semantics. +.PP +In SVr4, +the third argument of \fB\%tputs\fP has the type +.RB \*(`` "int (*putc)(char)" \*(''. +.PP +At least one implementation of X/Open Curses (Solaris) returns a value +other than +.B OK +or +.B ERR +from \fB\%tputs\fP. +It instead returns the length of the string, +and does no error checking. +.PP +X/Open Curses notes that after calling \fB\%mvcur\fP, +the +.I curses +state may not match the actual terminal state, +and that an application should touch and refresh the window before +resuming normal +.I curses +calls. +Both +.I \%ncurses +and SVr4 +.I curses +implement \fB\%mvcur\fP using the +.I SCREEN +data allocated in either \fB\%initscr\fP or \fB\%newterm\fP. +So though it is documented as a +.I \%term\%info +function, +\fB\%mvcur\fP is really a +.I curses +function that is not well specified. +.PP +X/Open Curses states that the old location must be given for +\fB\%mvcur\fP to accommodate terminals that lack absolute cursor +positioning. +.\" X/Open Curses Issue 7, p. 161 +.I \%ncurses +allows the caller to use \-1 for either or both old coordinates. +The \-1 tells +.I \%ncurses +that the old location is unknown, +and that it must use only absolute motion, +as with the +.B \%cursor_address +.RB ( cup ) +capability, +rather than the least costly combination of absolute and relative +motion. +.\" ******************************************************************** .SH HISTORY +SVr2 (1984) introduced the +.I \%term\%info +feature. +Its programming manual mentioned the following low-level functions. .PP -SVr2 introduced the terminfo feature. -Its programming manual mentioned these low-level functions: .TS -l l -_ _ -l l. -\fBFunction\fP \fBDescription\fP -fixterm restore tty to \*(``in curses\*('' state -gettmode establish current tty modes +lB lB +lB lx. +Function Description +_ +fixterm restore terminal to \*(``in \fIcurses\fP\*('' state +gettmode establish current terminal modes mvcur low level cursor motion -putp T{ -utility function that uses \fBtputs\fP to send characters via \fBputchar\fP. -T} -resetterm set tty modes to \*(``out of curses\*('' state -resetty reset tty flags to stored value -saveterm save current modes as \*(``in curses\*('' state -savetty store current tty flags +putp use \fBtputs\fP to send characters via \fIputchar\fP +resetterm set terminal modes to \*(``out of \fIcurses\fP\*(''\ + state +resetty reset terminal flags to stored value +saveterm save current modes as \*(``in \fIcurses\fP\*('' state +savetty store current terminal flags setterm establish terminal with given type setupterm establish terminal with given type -tparm instantiate a string expression with parameters +tparm interpolate parameters into string capability tputs apply padding information to a string -vidattr like \fBvidputs\fP, but outputs through \fBputchar\fP +vidattr like \fBvidputs\fP, but output through \fIputchar\fP vidputs T{ -output a string to put terminal in a specified video attribute mode +write string to terminal, applying specified attributes T} .TE .PP The programming manual also mentioned -functions provided for termcap compatibility -(commenting that they \*(``may go away at a later date\*(''): +functions provided for +.I termcap +compatibility +(commenting that they \*(``may go away at a later date\*(''). +.PP .TS -l l -_ _ -l l. -\fBFunction\fP \fBDescription\fP -tgetent look up termcap entry for given \fIname\fP -tgetflag get boolean entry for given \fIid\fP +lB lB +lB lx. +Function Description +_ +tgetent look up \fItermcap\fP entry for given \fIname\fP +tgetflag get Boolean entry for given \fIid\fP tgetnum get numeric entry for given \fIid\fP tgetstr get string entry for given \fIid\fP tgoto apply parameters to given capability tputs T{ -apply padding to capability, calling a function to put characters +write characters via a function parameter, applying padding T} .TE .PP -Early terminfo programs obtained capability values from the -\fBTERMINAL\fP structure initialized by \fBsetupterm\fP. +Early +.I \%term\%info +programs obtained capability values from the +.I \%TERMINAL +structure initialized by \fB\%setupterm\fP. +.PP +SVr3 (1987) extended +.I \%term\%info +by adding functions to retrieve capability values +(like the +.I termcap +interface), +and reusing \fB\%tgoto\fP and \fB\%tputs\fP. .PP -SVr3 extended terminfo by adding functions to retrieve capability values -(like the termcap interface), -and reusing tgoto and tputs: .TS -l l -_ _ -l l. -\fBFunction\fP \fBDescription\fP -tigetflag get boolean entry for given \fIid\fP +lB lB +lB lx. +Function Description +_ +tigetflag get Boolean entry for given \fIid\fP tigetnum get numeric entry for given \fIid\fP tigetstr get string entry for given \fIid\fP .TE .PP -SVr3 also replaced several of the SVr2 terminfo functions -which had no counterpart in the termcap interface, -documenting them as obsolete: +SVr3 also replaced several of the SVr2 +.I \%term\%info +functions that had no counterpart in the +.I termcap +interface, +documenting them as obsolete. +.PP .TS -l l -_ _ -l l. -\fBFunction\fP \fBReplaced by\fP +lB lB +l lx. +Function Replaced by +_ crmode cbreak fixterm reset_prog_mode -gettmode N/A +gettmode \fIn/a\fP nocrmode nocbreak resetterm reset_shell_mode saveterm def_prog_mode setterm setupterm .TE .PP -SVr3 kept the \fBmvcur\fP, \fBvidattr\fP and \fBvidputs\fP functions, -along with \fBputp\fP, \fBtparm\fP and \fBtputs\fP. +SVr3 kept the \fB\%mvcur\fP, +\fB\%vidattr\fP, +and \fB\%vidputs\fP functions, +along with \fB\%putp\fP, +\fB\%tparm\fP, +and \fB\%tputs\fP. The latter were needed to support padding, -and handling functions such as \fBvidattr\fP -(which used more than the two parameters supported by \fBtgoto\fP). +and to handle capabilities accessed by functions such as \fB\%vidattr\fP +(which used more than the two parameters supported by \fB\%tgoto\fP). .PP SVr3 introduced the functions for switching between terminal -descriptions, e.g., \fBset_curterm\fP. -Some of that was incremental improvements to the SVr2 library: +descriptions; +for example, +\fB\%set_curterm\fP. +Some changes reflected incremental improvements to the SVr2 library. .bP -The \fBTERMINAL\fP type definition was introduced in SVr3.01, -for the \fBterm\fP structure provided in SVr2. +The +.I \%TERMINAL +type definition was introduced in SVr3.01, +for the +.I term +structure provided in SVr2. .bP -The various global variables such as \fBboolnames\fP were mentioned +Various global variables such as \fB\%boolnames\fP were mentioned in the programming manual at this point, -though the variables were provided in SVr2. -.PP -SVr4 added the \fBvid_attr\fP and \fBvid_puts\fP functions. -.PP -There are other low-level functions declared in the curses header files -on Unix systems, -but none were documented. -The functions marked \*(``obsolete\*('' remained in use -by the Unix \fBvi\fP(1) editor. -.SH PORTABILITY -.SS Extensions -The functions marked as extensions were designed for \fBncurses\fP(3X), -and are not found in SVr4 curses, 4.4BSD curses, -or any other previous version of curses. -.PP -.SS Legacy functions -.PP -X/Open notes that \fBvidattr\fP and \fBvidputs\fP may be macros. -.PP -The function \fBsetterm\fP is not described by X/Open and must -be considered non-portable. -All other functions are as described by X/Open. -.SS Legacy data -.PP -\fBsetupterm\fP copies the terminal name to the array \fBttytype\fP. -This is not part of X/Open Curses, but is assumed by some applications. -.PP -Other implementions may not declare the capability name arrays. -Some provide them without declaring them. -X/Open does not specify them. -.PP -Extended terminal capability names, e.g., as defined by \fBtic\ \-x\fP, -are not stored in the arrays described here. -.SS Output buffering -.PP -Older versions of \fBncurses\fP assumed that the file descriptor passed to -\fBsetupterm\fP from \fBinitscr\fP or \fBnewterm\fP uses buffered I/O, -and would write to the corresponding stream. -In addition to the limitation that the terminal was left in block-buffered -mode on exit (like System V curses), -it was problematic because \fBncurses\fP -did not allow a reliable way to cleanup on receiving SIGTSTP. -.PP -The current version (ncurses6) -uses output buffers managed directly by \fBncurses\fP. -Some of the low-level functions described in this manual page write -to the standard output. -They are not signal-safe. -The high-level functions in \fBncurses\fP use -alternate versions of these functions -using the more reliable buffering scheme. -.SS Function prototypes -.PP -The X/Open Curses prototypes are based on the SVr4 curses header declarations, -which were defined at the same time the C language was first standardized in -the late 1980s. -.bP -X/Open Curses uses \fBconst\fP less effectively than a later design might, -in some cases applying it needlessly to values are already constant, -and in most cases overlooking parameters which normally would use \fBconst\fP. -Using constant parameters for functions which do not use \fBconst\fP -may prevent the program from compiling. -On the other hand, \fIwritable strings\fP are an obsolescent feature. -.IP -As an extension, this implementation can be configured to change the -function prototypes to use the \fBconst\fP keyword. -The ncurses ABI 6 enables this feature by default. -.bP -X/Open Curses prototypes \fBtparm\fP with a fixed number of parameters, -rather than a variable argument list. -.IP -This implementation uses a variable argument list, but can be -configured to use the fixed-parameter list. -Portable applications should provide 9 parameters after the format; -zeroes are fine for this purpose. -.IP -In response to review comments by Thomas E. Dickey, -X/Open Curses Issue 7 proposed the \fBtiparm\fP function in mid-2009. -.IP -While \fBtiparm\fP is always provided in ncurses, -the older form is only available as a build-time configuration option. -If not specially configured, \fBtparm\fP is the same as \fBtiparm\fP. +though the variables had been provided in SVr2. .PP -Both forms of \fBtparm\fP have drawbacks: -.bP -Most of the calls to \fBtparm\fP use only one or two parameters. -Passing nine on each call is awkward. -.IP -Using \fBlong\fP for the numeric parameter type is a workaround -to make the parameter use the same amount of stack as a pointer. -That approach dates back to the mid-1980s, before C was standarized. -Since then, there is a standard -(and pointers are not required to fit in a long). -.bP -Providing the right number of parameters for a variadic function -such as \fBtiparm\fP can be a problem, in particular for string parameters. -However, only a few terminfo capabilities use string parameters -(e.g., the ones used for programmable function keys). -.IP -The ncurses library checks usage of these capabilities, -and returns an error if the capability mishandles string parameters. -But it cannot check if a calling program provides strings in the right -places for the \fBtparm\fP calls. -.IP -The \fBtput\fR(1) program checks its use of these capabilities with a table, -so that it calls \fBtparm\fP correctly. -.SS Special TERM treatment +SVr4 (1989) added the \fB\%vid_attr\fP and \fB\%vid_puts\fP functions. .PP -If configured to use the terminal-driver, -e.g., for the MinGW port, -.bP -\fBsetupterm\fP interprets a missing/empty TERM variable as the -special value \*(``unknown\*(''. -.bP -\fBsetupterm\fP allows explicit use of the -the windows console driver by checking if $TERM is set to -\*(``#win32con\*('' or an abbreviation of that string. -.SS Other portability issues -.PP -In System V Release 4, \fBset_curterm\fP has an \fBint\fP return type and -returns \fBOK\fP or \fBERR\fP. We have chosen to implement the X/Open Curses -semantics. -.PP -In System V Release 4, the third argument of \fBtputs\fP has the type -\fBint (*putc)(char)\fP. -.PP -At least one implementation of X/Open Curses (Solaris) returns a value -other than \fBOK\fP/\fBERR\fP from \fBtputs\fP. -That returns the length of the string, and does no error-checking. -.PP -X/Open notes that after calling \fBmvcur\fP, the curses state may not match the -actual terminal state, and that an application should touch and refresh -the window before resuming normal curses calls. -Both \fBncurses\fP and System V Release 4 curses implement \fBmvcur\fP using -the SCREEN data allocated in either \fBinitscr\fP or \fBnewterm\fP. -So though it is documented as a terminfo function, -\fBmvcur\fP is really a curses function which is not well specified. -.PP -X/Open states that the old location must be given for \fBmvcur\fP. -This implementation allows the caller to use \-1's for the old ordinates. -In that case, the old location is unknown. +Other low-level functions are declared in the +.I curses +header files of Unix systems, +but none are documented. +Those noted as \*(``obsolete\*('' by SVr3 remained in use by System\ V's +\fIvi\fP(1) editor. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_initscr\fP(3X), -\fBcurs_kernel\fP(3X), -\fBcurs_memleaks\fP(3X), -\fBcurs_termcap\fP(3X), -\fBcurs_variables\fP(3X), -\fBterm_variables\fP(3X), -\fBputc\fP(3), -\fBterminfo\fP(\*n) +\fB\%curses\fP(3X), +\fB\%curs_initscr\fP(3X), +\fB\%curs_kernel\fP(3X), +\fB\%curs_memleaks\fP(3X), +\fB\%curs_termcap\fP(3X), +\fB\%curs_variables\fP(3X), +\fB\%putc\fP(3), +\fB\%term_variables\fP(3X), +\fB\%terminfo\fP(5) diff --git a/upstream/archlinux/man3/curs_threads.3x b/upstream/archlinux/man3/curs_threads.3x index 58ace20e..01b0dbb0 100644 --- a/upstream/archlinux/man3/curs_threads.3x +++ b/upstream/archlinux/man3/curs_threads.3x @@ -1,5 +1,6 @@ +'\" t .\"*************************************************************************** -.\" Copyright 2021,2022 Thomas E. Dickey * +.\" Copyright 2021-2023,2024 Thomas E. Dickey * .\" Copyright 2008-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,577 +28,611 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_threads.3x,v 1.31 2022/02/12 20:05:11 tom Exp $ -.TH curs_threads 3X "" +.\" $Id: curs_threads.3x,v 1.56 2024/03/16 15:35:01 tom Exp $ +.TH curs_threads 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBcurs_threads\fP \- \fBcurses\fP thread support -.ad -.hy +\fI\%NCURSES_WINDOW_CB\fP, +\fI\%NCURSES_SCREEN_CB\fP, +\fB\%get_escdelay\fP, +\fB\%set_escdelay\fP, +\fB\%set_tabsize\fP, +\fB\%use_screen\fP, +\fB\%use_window\fP \- +\fIcurses\fR support for multi-threaded applications .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBtypedef int (*NCURSES_WINDOW_CB)(WINDOW *, void *);\fP -.br -\fBtypedef int (*NCURSES_SCREEN_CB)(SCREEN *, void *);\fP -.sp -\fBint get_escdelay(void);\fP -.br -\fBint set_escdelay(int \fIms\fB);\fR -.br -\fBint set_tabsize(int \fIcols\fB);\fR -.sp -\fBint use_screen(SCREEN *\fIscr\fB, NCURSES_SCREEN_CB \fIfunc\fB, void *\fIdata\fB);\fR -.br -\fBint use_window(WINDOW *\fIwin\fB, NCURSES_WINDOW_CB \fIfunc\fB, void *\fIdata\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fI/* data types */ +\fBtypedef int (*NCURSES_WINDOW_CB)(WINDOW *, void *); +\fBtypedef int (*NCURSES_SCREEN_CB)(SCREEN *, void *); +.PP +\fBint get_escdelay(void); +\fBint set_escdelay(int \fIms\fP); +\fBint set_tabsize(int \fIcols\fP); +.PP +\fBint use_screen(SCREEN *\fIscr\fP, NCURSES_SCREEN_CB \fIfunc\fP, void *\fIdata\fP); +\fBint use_window(WINDOW *\fIwin\fP, NCURSES_WINDOW_CB \fIfunc\fP, void *\fIdata\fP); +.fi .SH DESCRIPTION -This implementation can be configured to provide rudimentary support -for multi-threaded applications. -This makes a different set of libraries, e.g., \fBlibncursest\fP since -the binary interfaces are different. +The \fI\%ncurses\fP library can be configured to support multi-threaded +applications in a rudimentary way. +Such configuration produces a different set of libraries, +named \fIlibncursest\fP, +for example, +since doing so alters \fI\%ncurses\fP's application binary interface +(ABI). .PP -Rather than modify the interfaces to pass a thread specifier to -each function, it adds a few functions which can be used in any -configuration which hide the mutex's needed to prevent concurrent -use of the global variables when configured for threading. +Instead of modifying the programming interface (API) to make +\fI\%ncurses\fP functions expect an additional argument specifying a +thread, +the library adds functions, +usable in any configuration, +that hide the \fImutexes\fP +(mutual exclusion locks) +needed to prevent concurrent access to variables shared by multiple +threads of execution. .PP -In addition to forcing access to members of the \fBWINDOW\fP structure -to be via functions (see \fBcurs_opaque\fP(3X)), -it makes functions of the common global variables, -e.g., -COLORS, -COLOR_PAIRS, -COLS, -ESCDELAY, -LINES, -TABSIZE -curscr, -newscr and -ttytype. -Those variables are maintained as read-only values, stored in the \fBSCREEN\fP -structure. +\fI\%ncurses\fP threading support requires the use of functions to +access members of the \fI\%WINDOW\fP structure (see +\fBcurs_opaque\fP(3X)). +It further makes functions of the common global variables +\fB\%COLORS\fP, +\fB\%COLOR_PAIRS\fP, +\fB\%COLS\fP, +\fB\%ESCDELAY\fP, +\fB\%LINES\fP, +\fB\%TABSIZE\fP, +\fB\%curscr\fP, +\fB\%newscr\fP, +and +\fB\%ttytype\fP, +maintaining them as as read-only values in the \fISCREEN\fP structure. .PP -Even this is not enough to make a thread-safe application using curses. -A multi-threaded application would be expected to have threads updating -separate windows (within the same device), -or updating on separate screens (on different devices). -Also, a few of the global variables are considered writable by some -applications. +Even this is not enough to make an application using \fIcurses\fP +thread-safe. +We would expect a multi-threaded application to have threads updating +separate windows (on the same device), +and separate screens (on different devices). +Further, +applications expect a few of the global variables to be writable. The functions described here address these special situations. .PP -The ESCDELAY and TABSIZE global variables are modified by some applications. +The \fB\%ESCDELAY\fP and \fB\%TABSIZE\fP global variables are modified +by some applications. To modify them in any configuration, -use the \fBset_escdelay\fP or \fBset_tabsize\fP functions. +use the \fB\%set_escdelay\fP or \fB\%set_tabsize\fP functions. Other global variables are not modifiable. +\fBget_escdelay\fP retrieves \fB\%ESCDELAY\fP's value. .PP -The \fBget_escdelay\fP function returns the value for ESCDELAY. -.PP -The \fBuse_window\fP and \fBuse_screen\fP functions provide coarse -granularity mutexes for their respective \fBWINDOW\fP and \fBSCREEN\fP -parameters, and call a user-supplied function, -passing it a \fIdata\fP parameter, -and returning the value from the user-supplied function to the application. +The \fBuse_window\fP and \fBuse_screen\fP functions provide +coarse-grained mutexes for their respective \fI\%WINDOW\fP and +\fISCREEN\fP parameters; +they call a user-supplied function, +pass it a \fIdata\fP parameter, +and return the value from the user-supplied function to the application. .\" *************************************************************************** -.SS USAGE -All of the ncurses library functions assume that the locale is not +.SS Usage +All \fI\%ncurses\fP library functions assume that the locale is not altered during operation. In addition, -they use data which is maintained within a hierarchy of scopes. -.RS 3 +they use data that is maintained within a hierarchy of scopes. .bP -global data, e.g., used in the low-level terminfo or termcap interfaces. +global data used in the low-level \fIterminfo\fP or \fItermcap\fP +interfaces .bP -terminal data, e.g., associated with a call to \fBset_curterm\fP. -The terminal data are initialized when screens are created. +terminal data associated with a call to \fBset_curterm\fP(3X) +.IP +Terminal data are initialized when screens are created. .bP -screen data, e.g., associated with a call to \fBnewterm\fP or \fBinitscr\fP. +screen data associated with a call to \fBnewterm\fP(3X) or +\fBinitscr\fP(3X) .bP -window data, e.g., associated with a call to \fBnewwin\fP or \fBsubwin\fP. +window data associated with a call to \fBnewwin\fP(3X) or +\fBsubwin\fP(3X) +.IP Windows are associated with screens. -Pads are not necessarily associated with a particular screen. +Pads are not necessarily associated with any particular screen. .IP -Most curses applications operate on one or more windows within a single screen. +Most \fIcurses\fP applications operate on one or more windows within a +single screen. .bP -reentrant, i.e., it uses only the data passed as parameters. -.RE +reentrant data associated with \*(``pure\*('' functions that alter no +shared variables +.PP +The following table lists the scope of each symbol in the +\fI\%ncurses\fP library when configured to support multi-threaded +applications. .PP -This table lists the scope of data used for each symbol in the -ncurses library when it is configured to support threading: .TS -center tab(/); -l l -l l . -Symbol/Scope -= -BC/global -COLORS/screen (readonly) -COLOR_PAIR/reentrant -COLOR_PAIRS/screen (readonly) -COLS/screen (readonly) -ESCDELAY/screen (readonly, see \fBset_escdelay\fP) -LINES/screen (readonly) -PAIR_NUMBER/reentrant -PC/global -SP/global -TABSIZE/screen (readonly) -UP/global -acs_map/screen (readonly) -add_wch/window (stdscr) -add_wchnstr/window (stdscr) -add_wchstr/window (stdscr) -addch/window (stdscr) -addchnstr/window (stdscr) -addchstr/window (stdscr) -addnstr/window (stdscr) -addnwstr/window (stdscr) -addstr/window (stdscr) -addwstr/window (stdscr) -assume_default_colors/screen -attr_get/window (stdscr) -attr_off/window (stdscr) -attr_on/window (stdscr) -attr_set/window (stdscr) -attroff/window (stdscr) -attron/window (stdscr) -attrset/window (stdscr) -baudrate/screen -beep/screen -bkgd/window (stdscr) -bkgdset/window (stdscr) -bkgrnd/window (stdscr) -bkgrndset/window (stdscr) -boolcodes/global (readonly) -boolfnames/global (readonly) -boolnames/global (readonly) -border/window (stdscr) -border_set/window (stdscr) -box/window (stdscr) -box_set/window (stdscr) -can_change_color/terminal -cbreak/screen -chgat/window (stdscr) -clear/window (stdscr) -clearok/window -clrtobot/window (stdscr) -clrtoeol/window (stdscr) -color_content/screen -color_set/window (stdscr) -copywin/window locks(source, target) -cur_term/terminal -curs_set/screen -curscr/screen (readonly) -curses_version/global (readonly) -def_prog_mode/terminal -def_shell_mode/terminal -define_key/screen -del_curterm/screen -delay_output/screen -delch/window (stdscr) -deleteln/window (stdscr) -delscreen/global locks(screenlist, screen) -delwin/global locks(windowlist) -derwin/screen -doupdate/screen -dupwin/screen locks(window) -echo/screen -echo_wchar/window (stdscr) -echochar/window (stdscr) -endwin/screen -erase/window (stdscr) -erasechar/window (stdscr) -erasewchar/window (stdscr) -filter/global -flash/terminal -flushinp/screen -get_wch/screen (input-operation) -get_wstr/screen (input-operation) -getattrs/window -getbegx/window -getbegy/window -getbkgd/window -getbkgrnd/window -getcchar/reentrant -getch/screen (input-operation) -getcurx/window -getcury/window -getmaxx/window -getmaxy/window -getmouse/screen (input-operation) -getn_wstr/screen (input-operation) -getnstr/screen (input-operation) -getparx/window -getpary/window -getstr/screen (input-operation) -getwin/screen (input-operation) -halfdelay/screen -has_colors/terminal -has_ic/terminal -has_il/terminal -has_key/screen -hline/window (stdscr) -hline_set/window (stdscr) -idcok/window -idlok/window -immedok/window -in_wch/window (stdscr) -in_wchnstr/window (stdscr) -in_wchstr/window (stdscr) -inch/window (stdscr) -inchnstr/window (stdscr) -inchstr/window (stdscr) -init_color/screen -init_pair/screen -initscr/global locks(screenlist) -innstr/window (stdscr) -innwstr/window (stdscr) -ins_nwstr/window (stdscr) -ins_wch/window (stdscr) -ins_wstr/window (stdscr) -insch/window (stdscr) -insdelln/window (stdscr) -insertln/window (stdscr) -insnstr/window (stdscr) -insstr/window (stdscr) -instr/window (stdscr) -intrflush/terminal -inwstr/window (stdscr) -is_cleared/window -is_idcok/window -is_idlok/window -is_immedok/window -is_keypad/window -is_leaveok/window -is_linetouched/window -is_nodelay/window -is_notimeout/window -is_scrollok/window -is_syncok/window -is_term_resized/terminal -is_wintouched/window -isendwin/screen -key_defined/screen -key_name/global (static data) -keybound/screen -keyname/global (static data) -keyok/screen -keypad/window -killchar/terminal -killwchar/terminal -leaveok/window -longname/screen -mcprint/terminal -meta/screen -mouse_trafo/window (stdscr) -mouseinterval/screen -mousemask/screen -move/window (stdscr) -mvadd_wch/window (stdscr) -mvadd_wchnstr/window (stdscr) -mvadd_wchstr/window (stdscr) -mvaddch/window (stdscr) -mvaddchnstr/window (stdscr) -mvaddchstr/window (stdscr) -mvaddnstr/window (stdscr) -mvaddnwstr/window (stdscr) -mvaddstr/window (stdscr) -mvaddwstr/window (stdscr) -mvchgat/window (stdscr) -mvcur/screen -mvdelch/window (stdscr) -mvderwin/window (stdscr) -mvget_wch/screen (input-operation) -mvget_wstr/screen (input-operation) -mvgetch/screen (input-operation) -mvgetn_wstr/screen (input-operation) -mvgetnstr/screen (input-operation) -mvgetstr/screen (input-operation) -mvhline/window (stdscr) -mvhline_set/window (stdscr) -mvin_wch/window (stdscr) -mvin_wchnstr/window (stdscr) -mvin_wchstr/window (stdscr) -mvinch/window (stdscr) -mvinchnstr/window (stdscr) -mvinchstr/window (stdscr) -mvinnstr/window (stdscr) -mvinnwstr/window (stdscr) -mvins_nwstr/window (stdscr) -mvins_wch/window (stdscr) -mvins_wstr/window (stdscr) -mvinsch/window (stdscr) -mvinsnstr/window (stdscr) -mvinsstr/window (stdscr) -mvinstr/window (stdscr) -mvinwstr/window (stdscr) -mvprintw/window (stdscr) -mvscanw/screen -mvvline/window (stdscr) -mvvline_set/window (stdscr) -mvwadd_wch/window -mvwadd_wchnstr/window -mvwadd_wchstr/window -mvwaddch/window -mvwaddchnstr/window -mvwaddchstr/window -mvwaddnstr/window -mvwaddnwstr/window -mvwaddstr/window -mvwaddwstr/window -mvwchgat/window -mvwdelch/window -mvwget_wch/screen (input-operation) -mvwget_wstr/screen (input-operation) -mvwgetch/screen (input-operation) -mvwgetn_wstr/screen (input-operation) -mvwgetnstr/screen (input-operation) -mvwgetstr/screen (input-operation) -mvwhline/window -mvwhline_set/window -mvwin/window -mvwin_wch/window -mvwin_wchnstr/window -mvwin_wchstr/window -mvwinch/window -mvwinchnstr/window -mvwinchstr/window -mvwinnstr/window -mvwinnwstr/window -mvwins_nwstr/window -mvwins_wch/window -mvwins_wstr/window -mvwinsch/window -mvwinsnstr/window -mvwinsstr/window -mvwinstr/window -mvwinwstr/window -mvwprintw/window -mvwscanw/screen -mvwvline/window -mvwvline_set/window -napms/reentrant -newpad/global locks(windowlist) -newscr/screen (readonly) -newterm/global locks(screenlist) -newwin/global locks(windowlist) -nl/screen -nocbreak/screen -nodelay/window -noecho/screen -nofilter/global -nonl/screen -noqiflush/terminal -noraw/screen -notimeout/window -numcodes/global (readonly) -numfnames/global (readonly) -numnames/global (readonly) -ospeed/global -overlay/window locks(source, target) -overwrite/window locks(source, target) -pair_content/screen -pecho_wchar/screen -pechochar/screen -pnoutrefresh/screen -prefresh/screen -printw/window -putp/global -putwin/window -qiflush/terminal -raw/screen -redrawwin/window -refresh/screen -reset_prog_mode/screen -reset_shell_mode/screen -resetty/terminal -resize_term/screen locks(windowlist) -resizeterm/screen -restartterm/screen -ripoffline/global (static data) -savetty/terminal -scanw/screen -scr_dump/screen -scr_init/screen -scr_restore/screen -scr_set/screen -scrl/window (stdscr) -scroll/window -scrollok/window -set_curterm/screen -set_escdelay/screen -set_tabsize/screen -set_term/global locks(screenlist, screen) -setcchar/reentrant -setscrreg/window (stdscr) -setupterm/global -slk_attr/screen -slk_attr_off/screen -slk_attr_on/screen -slk_attr_set/screen -slk_attroff/screen -slk_attron/screen -slk_attrset/screen -slk_clear/screen -slk_color/screen -slk_init/screen -slk_label/screen -slk_noutrefresh/screen -slk_refresh/screen -slk_restore/screen -slk_set/screen -slk_touch/screen -slk_wset/screen -standend/window -standout/window -start_color/screen -stdscr/screen (readonly) -strcodes/global (readonly) -strfnames/global (readonly) -strnames/global (readonly) -subpad/window -subwin/window -syncok/window -term_attrs/screen -termattrs/screen -termname/terminal -tgetent/global -tgetflag/global -tgetnum/global -tgetstr/global -tgoto/global -tigetflag/terminal -tigetnum/terminal -tigetstr/terminal -timeout/window (stdscr) -touchline/window -touchwin/window -tparm/global (static data) -tputs/screen -trace/global (static data) -ttytype/screen (readonly) -typeahead/screen -unctrl/screen -unget_wch/screen (input-operation) -ungetch/screen (input-operation) -ungetmouse/screen (input-operation) -untouchwin/window -use_default_colors/screen -use_env/global (static data) -use_extended_names/global (static data) -use_legacy_coding/screen -use_screen/global locks(screenlist, screen) -use_window/global locks(windowlist, window) -vid_attr/screen -vid_puts/screen -vidattr/screen -vidputs/screen -vline/window (stdscr) -vline_set/window (stdscr) -vw_printw/window -vw_scanw/screen -vwprintw/window -vwscanw/screen -wadd_wch/window -wadd_wchnstr/window -wadd_wchstr/window -waddch/window -waddchnstr/window -waddchstr/window -waddnstr/window -waddnwstr/window -waddstr/window -waddwstr/window -wattr_get/window -wattr_off/window -wattr_on/window -wattr_set/window -wattroff/window -wattron/window -wattrset/window -wbkgd/window -wbkgdset/window -wbkgrnd/window -wbkgrndset/window -wborder/window -wborder_set/window -wchgat/window -wclear/window -wclrtobot/window -wclrtoeol/window -wcolor_set/window -wcursyncup/screen (affects window plus parents) -wdelch/window -wdeleteln/window -wecho_wchar/window -wechochar/window -wenclose/window -werase/window -wget_wch/screen (input-operation) -wget_wstr/screen (input-operation) -wgetbkgrnd/window -wgetch/screen (input-operation) -wgetdelay/window -wgetn_wstr/screen (input-operation) -wgetnstr/screen (input-operation) -wgetparent/window -wgetscrreg/window -wgetstr/screen (input-operation) -whline/window -whline_set/window -win_wch/window -win_wchnstr/window -win_wchstr/window -winch/window -winchnstr/window -winchstr/window -winnstr/window -winnwstr/window -wins_nwstr/window -wins_wch/window -wins_wstr/window -winsch/window -winsdelln/window -winsertln/window -winsnstr/window -winsstr/window -winstr/window -winwstr/window -wmouse_trafo/window -wmove/window -wnoutrefresh/screen -wprintw/window -wredrawln/window -wrefresh/screen -wresize/window locks(windowlist) -wscanw/screen -wscrl/window -wsetscrreg/window -wstandend/window -wstandout/window -wsyncdown/screen (affects window plus parents) -wsyncup/screen (affects window plus parents) -wtimeout/window -wtouchln/window -wunctrl/global (static data) -wvline/window -wvline_set/window +center; +Lb2 Lb +Lb2 Lx. +Symbol Scope +_ +BC global +COLORS screen (read-only) +COLOR_PAIR reentrant +COLOR_PAIRS screen (read-only) +COLS screen (read-only) +ESCDELAY screen (read-only; see \fBset_escdelay\fP) +LINES screen (read-only) +PAIR_NUMBER reentrant +PC global +SP global +TABSIZE screen (read-only; see \fBset_tabsize\fP) +UP global +acs_map screen (read-only) +add_wch window (\fBstdscr\fP) +add_wchnstr window (\fBstdscr\fP) +add_wchstr window (\fBstdscr\fP) +addch window (\fBstdscr\fP) +addchnstr window (\fBstdscr\fP) +addchstr window (\fBstdscr\fP) +addnstr window (\fBstdscr\fP) +addnwstr window (\fBstdscr\fP) +addstr window (\fBstdscr\fP) +addwstr window (\fBstdscr\fP) +assume_default_colors screen +attr_get window (\fBstdscr\fP) +attr_off window (\fBstdscr\fP) +attr_on window (\fBstdscr\fP) +attr_set window (\fBstdscr\fP) +attroff window (\fBstdscr\fP) +attron window (\fBstdscr\fP) +attrset window (\fBstdscr\fP) +baudrate screen +beep screen +bkgd window (\fBstdscr\fP) +bkgdset window (\fBstdscr\fP) +bkgrnd window (\fBstdscr\fP) +bkgrndset window (\fBstdscr\fP) +boolcodes global (read-only) +boolfnames global (read-only) +boolnames global (read-only) +border window (\fBstdscr\fP) +border_set window (\fBstdscr\fP) +box window (\fBstdscr\fP) +box_set window (\fBstdscr\fP) +can_change_color terminal +cbreak screen +chgat window (\fBstdscr\fP) +clear window (\fBstdscr\fP) +clearok window +clrtobot window (\fBstdscr\fP) +clrtoeol window (\fBstdscr\fP) +color_content screen +color_set window (\fBstdscr\fP) +copywin window (locks source, target) +cur_term terminal +curs_set screen +curscr screen (read-only) +curses_version global (read-only) +def_prog_mode terminal +def_shell_mode terminal +define_key screen +del_curterm screen +delay_output screen +delch window (\fBstdscr\fP) +deleteln window (\fBstdscr\fP) +delscreen global (locks screen list, screen) +delwin global (locks window list) +derwin screen +doupdate screen +dupwin screen (locks window) +echo screen +echo_wchar window (\fBstdscr\fP) +echochar window (\fBstdscr\fP) +endwin screen +erase window (\fBstdscr\fP) +erasechar window (\fBstdscr\fP) +erasewchar window (\fBstdscr\fP) +filter global +flash terminal +flushinp screen +get_wch screen (input operation) +get_wstr screen (input operation) +getattrs window +getbegx window +getbegy window +getbkgd window +getbkgrnd window +getcchar reentrant +getch screen (input operation) +getcurx window +getcury window +getmaxx window +getmaxy window +getmouse screen (input operation) +getn_wstr screen (input operation) +getnstr screen (input operation) +getparx window +getpary window +getstr screen (input operation) +getwin screen (input operation) +halfdelay screen +has_colors terminal +has_ic terminal +has_il terminal +has_key screen +hline window (\fBstdscr\fP) +hline_set window (\fBstdscr\fP) +idcok window +idlok window +immedok window +in_wch window (\fBstdscr\fP) +in_wchnstr window (\fBstdscr\fP) +in_wchstr window (\fBstdscr\fP) +inch window (\fBstdscr\fP) +inchnstr window (\fBstdscr\fP) +inchstr window (\fBstdscr\fP) +init_color screen +init_pair screen +initscr global (locks screen list) +innstr window (\fBstdscr\fP) +innwstr window (\fBstdscr\fP) +ins_nwstr window (\fBstdscr\fP) +ins_wch window (\fBstdscr\fP) +ins_wstr window (\fBstdscr\fP) +insch window (\fBstdscr\fP) +insdelln window (\fBstdscr\fP) +insertln window (\fBstdscr\fP) +insnstr window (\fBstdscr\fP) +insstr window (\fBstdscr\fP) +instr window (\fBstdscr\fP) +intrflush terminal +inwstr window (\fBstdscr\fP) +is_cleared window +is_idcok window +is_idlok window +is_immedok window +is_keypad window +is_leaveok window +is_linetouched window +is_nodelay window +is_notimeout window +is_scrollok window +is_syncok window +is_term_resized terminal +is_wintouched window +isendwin screen +key_defined screen +key_name global (static data) +keybound screen +keyname global (static data) +keyok screen +keypad window +killchar terminal +killwchar terminal +leaveok window +longname screen +mcprint terminal +meta screen +mouse_trafo window (\fBstdscr\fP) +mouseinterval screen +mousemask screen +move window (\fBstdscr\fP) +mvadd_wch window (\fBstdscr\fP) +mvadd_wchnstr window (\fBstdscr\fP) +mvadd_wchstr window (\fBstdscr\fP) +mvaddch window (\fBstdscr\fP) +mvaddchnstr window (\fBstdscr\fP) +mvaddchstr window (\fBstdscr\fP) +mvaddnstr window (\fBstdscr\fP) +mvaddnwstr window (\fBstdscr\fP) +mvaddstr window (\fBstdscr\fP) +mvaddwstr window (\fBstdscr\fP) +mvchgat window (\fBstdscr\fP) +mvcur screen +mvdelch window (\fBstdscr\fP) +mvderwin window (\fBstdscr\fP) +mvget_wch screen (input operation) +mvget_wstr screen (input operation) +mvgetch screen (input operation) +mvgetn_wstr screen (input operation) +mvgetnstr screen (input operation) +mvgetstr screen (input operation) +mvhline window (\fBstdscr\fP) +mvhline_set window (\fBstdscr\fP) +mvin_wch window (\fBstdscr\fP) +mvin_wchnstr window (\fBstdscr\fP) +mvin_wchstr window (\fBstdscr\fP) +mvinch window (\fBstdscr\fP) +mvinchnstr window (\fBstdscr\fP) +mvinchstr window (\fBstdscr\fP) +mvinnstr window (\fBstdscr\fP) +mvinnwstr window (\fBstdscr\fP) +mvins_nwstr window (\fBstdscr\fP) +mvins_wch window (\fBstdscr\fP) +mvins_wstr window (\fBstdscr\fP) +mvinsch window (\fBstdscr\fP) +mvinsnstr window (\fBstdscr\fP) +mvinsstr window (\fBstdscr\fP) +mvinstr window (\fBstdscr\fP) +mvinwstr window (\fBstdscr\fP) +mvprintw window (\fBstdscr\fP) +mvscanw screen +mvvline window (\fBstdscr\fP) +mvvline_set window (\fBstdscr\fP) +mvwadd_wch window +mvwadd_wchnstr window +mvwadd_wchstr window +mvwaddch window +mvwaddchnstr window +mvwaddchstr window +mvwaddnstr window +mvwaddnwstr window +mvwaddstr window +mvwaddwstr window +mvwchgat window +mvwdelch window +mvwget_wch screen (input operation) +mvwget_wstr screen (input operation) +mvwgetch screen (input operation) +mvwgetn_wstr screen (input operation) +mvwgetnstr screen (input operation) +mvwgetstr screen (input operation) +mvwhline window +mvwhline_set window +mvwin window +mvwin_wch window +mvwin_wchnstr window +mvwin_wchstr window +mvwinch window +mvwinchnstr window +mvwinchstr window +mvwinnstr window +mvwinnwstr window +mvwins_nwstr window +mvwins_wch window +mvwins_wstr window +mvwinsch window +mvwinsnstr window +mvwinsstr window +mvwinstr window +mvwinwstr window +mvwprintw window +mvwscanw screen +mvwvline window +mvwvline_set window +napms reentrant +newpad global (locks window list) +newscr screen (read-only) +newterm global (locks screen list) +newwin global (locks window list) +nl screen +nocbreak screen +nodelay window +noecho screen +nofilter global +nonl screen +noqiflush terminal +noraw screen +notimeout window +numcodes global (read-only) +numfnames global (read-only) +numnames global (read-only) +ospeed global +overlay window (locks source, target) +overwrite window (locks source, target) +pair_content screen +pecho_wchar screen +pechochar screen +pnoutrefresh screen +prefresh screen +printw window +putp global +putwin window +qiflush terminal +raw screen +redrawwin window +refresh screen +reset_prog_mode screen +reset_shell_mode screen +resetty terminal +resize_term screen (locks window list) +resizeterm screen +restartterm screen +ripoffline global (static data) +savetty terminal +scanw screen +scr_dump screen +scr_init screen +scr_restore screen +scr_set screen +scrl window (\fBstdscr\fP) +scroll window +scrollok window +set_curterm screen +set_escdelay screen +set_tabsize screen +set_term global (locks screen list, screen) +setcchar reentrant +setscrreg window (\fBstdscr\fP) +setupterm global +slk_attr screen +slk_attr_off screen +slk_attr_on screen +slk_attr_set screen +slk_attroff screen +slk_attron screen +slk_attrset screen +slk_clear screen +slk_color screen +slk_init screen +slk_label screen +slk_noutrefresh screen +slk_refresh screen +slk_restore screen +slk_set screen +slk_touch screen +slk_wset screen +standend window +standout window +start_color screen +\fBstdscr\fP screen (read-only) +strcodes global (read-only) +strfnames global (read-only) +strnames global (read-only) +subpad window +subwin window +syncok window +term_attrs screen +termattrs screen +termname terminal +tgetent global +tgetflag global +tgetnum global +tgetstr global +tgoto global +tigetflag terminal +tigetnum terminal +tigetstr terminal +timeout window (\fBstdscr\fP) +touchline window +touchwin window +tparm global (static data) +tputs screen +trace global (static data) +ttytype screen (read-only) +typeahead screen +unctrl screen +unget_wch screen (input operation) +ungetch screen (input operation) +ungetmouse screen (input operation) +untouchwin window +use_default_colors screen +use_env global (static data) +use_extended_names global (static data) +use_legacy_coding screen +use_screen global (locks screen list, screen) +use_window global (locks window list, window) +vid_attr screen +vid_puts screen +vidattr screen +vidputs screen +vline window (\fBstdscr\fP) +vline_set window (\fBstdscr\fP) +vw_printw window +vw_scanw screen +vwprintw window +vwscanw screen +wadd_wch window +wadd_wchnstr window +wadd_wchstr window +waddch window +waddchnstr window +waddchstr window +waddnstr window +waddnwstr window +waddstr window +waddwstr window +wattr_get window +wattr_off window +wattr_on window +wattr_set window +wattroff window +wattron window +wattrset window +wbkgd window +wbkgdset window +wbkgrnd window +wbkgrndset window +wborder window +wborder_set window +wchgat window +wclear window +wclrtobot window +wclrtoeol window +wcolor_set window +wcursyncup screen (affects window plus parents) +wdelch window +wdeleteln window +wecho_wchar window +wechochar window +wenclose window +werase window +wget_wch screen (input operation) +wget_wstr screen (input operation) +wgetbkgrnd window +wgetch screen (input operation) +wgetdelay window +wgetn_wstr screen (input operation) +wgetnstr screen (input operation) +wgetparent window +wgetscrreg window +wgetstr screen (input operation) +whline window +whline_set window +win_wch window +win_wchnstr window +win_wchstr window +winch window +winchnstr window +winchstr window +winnstr window +winnwstr window +wins_nwstr window +wins_wch window +wins_wstr window +winsch window +winsdelln window +winsertln window +winsnstr window +winsstr window +winstr window +winwstr window +wmouse_trafo window +wmove window +wnoutrefresh screen +wprintw window +wredrawln window +wrefresh screen +wresize window (locks window list) +wscanw screen +wscrl window +wsetscrreg window +wstandend window +wstandout window +wsyncdown screen (affects window plus parents) +wsyncup screen (affects window plus parents) +wtimeout window +wtouchln window +wunctrl global (static data) +wvline window +wvline_set window .TE .\" *************************************************************************** .SH RETURN VALUE -These functions all return \fBTRUE\fP or \fBFALSE\fP, except as noted. +\fB\%get_escdelay\fP returns the value of \fB\%ESCDELAY\fP. +\fB\%set_escdelay\fP and \fB\%set_tabsize\fP return \fBERR\fP upon +failure and \fBOK\fP upon successful completion. +\fB\%use_screen\fP and \fB\%use_window\fP return the \fIint\fP returned +by the user-supplied function they are called with. .SH NOTES -Both a macro and a function are provided for each name. +\fI\%ncurses\fP provides both a C function and a preprocessor macro for +each function documented in this page. .SH PORTABILITY -These routines are specific to ncurses. +These routines are specific to \fI\%ncurses\fP. They were not supported on Version 7, BSD or System V implementations. -It is recommended that any code depending on ncurses extensions -be conditioned using NCURSES_VERSION. +It is recommended that any code depending on \fI\%ncurses\fP extensions +be conditioned using \fB\%NCURSES_VERSION\fP. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_opaque\fP(3X), -\fBcurs_variables\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_opaque\fP(3X), +\fB\%curs_variables\fP(3X) diff --git a/upstream/archlinux/man3/curs_touch.3x b/upstream/archlinux/man3/curs_touch.3x index 7b979b2b..e2ab768d 100644 --- a/upstream/archlinux/man3/curs_touch.3x +++ b/upstream/archlinux/man3/curs_touch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,36 +27,32 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_touch.3x,v 1.26 2022/02/12 20:05:11 tom Exp $ -.TH curs_touch 3X "" -.na -.hy 0 +.\" $Id: curs_touch.3x,v 1.47 2024/04/20 21:20:07 tom Exp $ +.TH curs_touch 3X 2024-04-20 "ncurses 6.5" "Library calls" .SH NAME -\fBtouchwin\fP, -\fBtouchline\fP, -\fBuntouchwin\fP, -\fBwtouchln\fP, -\fBis_linetouched\fP, -\fBis_wintouched\fP \- \fBcurses\fP refresh control routines -.ad -.hy +\fB\%touchwin\fP, +\fB\%touchline\fP, +\fB\%untouchwin\fP, +\fB\%wtouchln\fP, +\fB\%is_linetouched\fP, +\fB\%is_wintouched\fP \- +control terminal output refresh in a \fIcurses\fR window .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint touchline(WINDOW *\fIwin\fB, int \fIstart\fB, int \fIcount\fB);\fR -.sp -\fBint touchwin(WINDOW *\fIwin\fB);\fR -.br -\fBint wtouchln(WINDOW *\fIwin\fB, int \fIy\fB, int \fIn\fB, int \fIchanged\fB);\fR -.sp -\fBint untouchwin(WINDOW *\fIwin\fB);\fR -.sp -\fBbool is_linetouched(WINDOW *\fIwin\fB, int \fIline\fB);\fR -.br -\fBbool is_wintouched(WINDOW *\fIwin\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\fBint touchline(WINDOW *\fIwin\fP, int \fIstart\fP, int \fIcount\fP); +.PP +\fBint touchwin(WINDOW *\fIwin\fP); +\fBint wtouchln(WINDOW *\fIwin\fP, int \fIy\fP, int \fIn\fP, int \fIchanged\fP); +.PP +\fBint untouchwin(WINDOW *\fIwin\fP); +.PP +\fBbool is_linetouched(WINDOW *\fIwin\fP, int \fIline\fP); +\fBbool is_wintouched(WINDOW *\fIwin\fP); +.fi .SH DESCRIPTION -The \fBtouchwin\fP and \fBtouchline\fP routines throw away all +The \fB\%touchwin\fP and \fB\%touchline\fP routines throw away all optimization information about which parts of the window have been touched, by pretending that the entire window has been drawn on. This @@ -64,35 +60,35 @@ is sometimes necessary when using overlapping windows, since a change to one window affects the other window, but the records of which lines have been changed in the other window do not reflect the change. The -routine \fBtouchline\fP only pretends that \fIcount\fP lines have been +routine \fB\%touchline\fP only pretends that \fIcount\fP lines have been changed, beginning with line \fIstart\fP. .PP -The \fBuntouchwin\fP routine marks all lines in the window as unchanged since -the last call to \fBwrefresh\fP. +The \fB\%untouchwin\fP routine marks all lines in the window as unchanged since +the last call to \fB\%wrefresh\fP. .PP -The \fBwtouchln\fP routine makes \fIn\fP lines in the window, starting +The \fB\%wtouchln\fP routine makes \fIn\fP lines in the window, starting at line \fIy\fR, look as if they have (\fIchanged\fB=1\fR) or have not (\fIchanged\fB=0\fR) been changed since the last call to -\fBwrefresh\fP. +\fB\%wrefresh\fP. .PP -The \fBis_linetouched\fP and \fBis_wintouched\fP routines return +The \fB\%is_linetouched\fP and \fB\%is_wintouched\fP routines return \fBTRUE\fP if the specified line/window was modified since the last -call to \fBwrefresh\fP; otherwise they return \fBFALSE\fP. In -addition, \fBis_linetouched\fP returns \fBERR\fP if \fIline\fP is not +call to \fB\%wrefresh\fP; otherwise they return \fBFALSE\fP. In +addition, \fB\%is_linetouched\fP returns \fBERR\fP if \fIline\fP is not valid for the given window. .SH RETURN VALUE All routines return the integer \fBERR\fP upon failure and an integer value other than \fBERR\fP upon successful completion, unless otherwise noted in the preceding routine descriptions. .PP -X/Open does not define any error conditions. +X/Open Curses does not specify any error conditions. In this implementation .RS 3 .TP 5 \fBis_linetouched\fP returns an error if the window pointer is null, or -if the line number is outside the window. +if the line number is outside the window boundaries. .IP The constant \fBERR\fP is distinct from \fBTRUE\fP and \fBFALSE\fP, which are the normal return values of this function. @@ -101,29 +97,28 @@ returning \fBERR\fP (which is neither \fBTRUE\fP nor \fBFALSE\fP) may not be supported by the compiler. .IP To provide error-checking and also match the X/Open function prototype, -the \fBERR\fP is provided by a macro named \fBis_linetouched\fP. +the \fBERR\fP is provided by a macro named \fB\%is_linetouched\fP. The actual function returns \fBFALSE\fP when it detects an error. .TP 5 \fBwtouchln\fP returns an error if the window pointer is null, or -if the line number is outside the window. +if the line number is outside the window boundaries. .RE +.SH NOTES +All of these routines except \fB\%wtouchln\fP may be macros. .SH PORTABILITY -.PP These functions were introduced by SVr4. -The Solaris curses header file, +The Solaris \fIcurses\fP header file, for instance, defines both an actual function and macro for each. The macros give the same result as the actual functions. -SVr4 curses does not check the window parameter \fIwin\fP to ensure +SVr4 \fIcurses\fP does not check the window parameter \fIwin\fP to ensure that it is not \fBNULL\fP; otherwise this implementation behaves the same as SVr4. .PP -The XSI Curses standard, Issue 4 describes these functions, +X/Open Curses, Issue 4 describes these functions, but defines no error conditions. -.SH NOTES -All of these routines except \fBwtouchln\fP may be macros. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_refresh\fP(3X), -\fBcurs_variables\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_refresh\fP(3X), +\fB\%curs_variables\fP(3X) diff --git a/upstream/archlinux/man3/curs_trace.3x b/upstream/archlinux/man3/curs_trace.3x index 02e67394..08bde42f 100644 --- a/upstream/archlinux/man3/curs_trace.3x +++ b/upstream/archlinux/man3/curs_trace.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2021,2022 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 2000-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,67 +27,76 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_trace.3x,v 1.25 2022/02/12 20:06:41 tom Exp $ -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_trace.3x,v 1.50 2024/04/20 21:24:19 tom Exp $ +.TH curs_trace 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.TH curs_trace 3X "" +. +.de dS \" Start unfilled display. +.nr aD \n(.j .na -.hy 0 +.. +. +.de dE \" End unfilled display. +.ad \n(.j +.rr aD +.. +. .SH NAME -\fBcurses_trace\fP, -\fBtrace\fP, -\fB_tracef\fP, -\fB_traceattr\fP, -\fB_traceattr2\fP, -\fB_tracecchar_t\fP, -\fB_tracecchar_t2\fP, -\fB_tracechar\fP, -\fB_tracechtype\fP, -\fB_tracechtype2\fP, -\fB_nc_tracebits\fP, -\fB_tracedump\fP, -\fB_tracemouse\fP \- \fBcurses\fP debugging routines -.ad -.hy +\fB\%curses_trace\fP, +\fB\%trace\fP, +\fB\%_tracef\fP, +\fB\%_traceattr\fP, +\fB\%_traceattr2\fP, +\fB\%_tracecchar_t\fP, +\fB\%_tracecchar_t2\fP, +\fB\%_tracechar\fP, +\fB\%_tracechtype\fP, +\fB\%_tracechtype2\fP, +\fB\%_nc_tracebits\fP, +\fB\%_tracedump\fP, +\fB\%_tracemouse\fP \- +\fIcurses\fR debugging routines .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBunsigned curses_trace(const unsigned \fIparam\fB);\fR -.sp -\fBvoid _tracef(const char *\fIformat\fB, ...);\fR -.sp -\fBchar *_traceattr(attr_t \fIattr\fB);\fR -.br -\fBchar *_traceattr2(int \fIbuffer\fB, chtype \fIch\fB);\fR -.br -\fBchar *_tracecchar_t(const cchar_t *\fIstring\fB);\fR -.br -\fBchar *_tracecchar_t2(int \fIbuffer\fB, const cchar_t *\fIstring\fB);\fR -.br -\fBchar *_tracechar(int \fIch\fB);\fR -.br -\fBchar *_tracechtype(chtype \fIch\fB);\fR -.br -\fBchar *_tracechtype2(int \fIbuffer\fB, chtype \fIch\fB);\fR -.sp -\fBvoid _tracedump(const char *\fIlabel\fB, WINDOW *\fIwin\fB);\fR -.br -\fBchar *_nc_tracebits(void);\fP -.br -\fBchar *_tracemouse(const MEVENT *\fIevent\fB);\fR -.sp -/* deprecated */ -.br -\fBvoid trace(const unsigned int \fIparam\fB);\fR +.nf +\fB#include <curses.h> +.PP +\fBunsigned curses_trace(const unsigned \fItrace-mask\fP); +.PP +\fBvoid _tracef(const char *\fIformat\fP, ...); +.PP +\fBchar *_traceattr(attr_t \fIattr\fP); +\fBchar *_traceattr2(int \fIbuffer\fP, chtype \fIch\fP); +\fBchar *_tracecchar_t(const cchar_t *\fIstring\fP); +\fBchar *_tracecchar_t2(int \fIbuffer\fP, const cchar_t *\fIstring\fP); +\fBchar *_tracechar(int \fIc\fP); +\fBchar *_tracechtype(chtype \fIch\fP); +\fBchar *_tracechtype2(int \fIbuffer\fP, chtype \fIch\fP); +.PP +\fBvoid _tracedump(const char *\fIlabel\fP, WINDOW *\fIwin\fP); +\fBchar *_nc_tracebits(void); +\fBchar *_tracemouse(const MEVENT *\fIevent\fP); +.PP +\fI/* deprecated */\fP +\fBvoid trace(const unsigned int \fItrace-mask\fP); +.fi .SH DESCRIPTION -The \fIcurses trace\fP routines are used for debugging the ncurses libraries, -as well as applications which use the ncurses libraries. +The \fIcurses trace\fP routines are used for debugging the +\fI\%ncurses\fP libraries, +as well as applications which use the \fI\%ncurses\fP libraries. Some limitations apply: .bP Aside from \fBcurses_trace\fP, @@ -125,11 +134,11 @@ updates the trace mask, and returns the previous trace mask. .IP When the trace mask is nonzero, -ncurses creates the file \*(``trace\*('' in the current directory for output. +\fI\%ncurses\fP creates the file \*(``trace\*('' in the current directory for output. If the file already exists, no tracing is done. .bP If tracing is not available, \fBcurses_trace\fP returns zero (0). -.SS Trace Parameter +.SS "Trace Parameter" The trace parameter is formed by OR'ing values from the list of \fBTRACE_\fIxxx\fR definitions in \fB<curses.h>\fR. These include: @@ -194,31 +203,7 @@ Some tracing features are enabled whenever the \fBcurses_trace\fP parameter is nonzero. Some features overlap. The specific names are used as a guideline. -.SS Initialization -These functions check the \fBNCURSES_TRACE\fP environment variable, -to set the tracing feature as if \fBcurses_trace\fP was called: -.RS 4 -.PP -.na -.hy 0 -filter, -initscr, -new_prescr, -newterm, -nofilter, -restartterm, -ripoffline, -setupterm, -slk_init, -tgetent, -use_env, -use_extended_names, -use_tioctl -.hy -.ad -.RE -.SS Command-line Utilities -.PP +.SS "Command-line Utilities" The command-line utilities such as \fBtic\fP(1) provide a verbose option which extends the set of messages written using the \fBcurses_trace\fP function. Both of these (\fB\-v\fP and \fBcurses_trace\fP) @@ -228,22 +213,47 @@ which determines the messages which are written. Because the command-line utilities may call initialization functions such as \fBsetupterm\fP, \fBtgetent\fP or \fBuse_extended_names\fP, some of their debugging output may be directed to the \fItrace\fP file -if the \fBNCURSES_TRACE\fP environment variable is set: +if the \fI\%NCURSES_TRACE\fP environment variable is set: .bP messages produced in the utility are written to the standard error. .bP messages produced by the underlying library are written to \fItrace\fP. .PP -If ncurses is built without tracing, none of the latter are produced, +If \fI\%ncurses\fP is built without tracing, +none of the latter are produced, and fewer diagnostics are provided by the command-line utilities. .SH RETURN VALUE Routines which return a value are designed to be used as parameters to the \fB_tracef\fP routine. +.SH ENVIRONMENT +.SS NCURSES_TRACE +A positive integral value stored in this variable causes the following +functions to enable the tracing feature as if +.B \%curses_trace +were called. +.PP +.dS +.RS 4 +\fB\%filter\fP, +\fB\%initscr\fP, +\fB\%new_prescr\fP, +\fB\%newterm\fP, +\fB\%nofilter\fP, +\fB\%restartterm\fP, +\fB\%ripoffline\fP, +\fB\%setupterm\fP, +\fB\%slk_init\fP, +\fB\%tgetent\fP, +\fB\%use_env\fP, +\fB\%use_extended_names\fP, +\fB\%use_tioctl\fP +.RE +.dE .SH PORTABILITY -These functions are not part of the XSI interface. +These functions are not part of the X/Open Curses interface. Some other curses implementations are known to have similar features, -but they are not compatible with ncurses: +but they are not compatible with \fI\%ncurses\fP: .bP SVr4 provided \fBtraceon\fP and \fBtraceoff\fP, to control whether debugging information was written @@ -262,21 +272,22 @@ only when a debug-library is built. .IP PDCurses has a short description of these functions, with a note that they are not present in X/Open Curses, -ncurses or NetBSD. +\fI\%ncurses\fP or NetBSD. It does not mention SVr4, but the functions' inclusion in a header file section labeled \*(``Quasi-standard\*('' hints at the origin. .bP NetBSD does not provide functions for enabling/disabling traces. It uses environment variables -\fBCURSES_TRACE_MASK\fP and -\fBCURSES_TRACE_FILE\fP to determine what is traced, +\fI\%CURSES_TRACE_MASK\fP and +\fI\%CURSES_TRACE_FILE\fP to determine what is traced, and where the results are written. This is available only when a debug-library is built. .IP The NetBSD tracing feature is undocumented. .PP -A few ncurses functions are not provided when symbol versioning is used: +A few \fI\%ncurses\fP functions are not provided when symbol versioning +is used: .RS 4 .PP _nc_tracebits, @@ -287,4 +298,4 @@ _tracemouse The original \fBtrace\fP routine was deprecated because it often conflicted with application names. .SH SEE ALSO -\fBcurses\fP(3X). +\fB\%curses\fP(3X) diff --git a/upstream/archlinux/man3/curs_util.3x b/upstream/archlinux/man3/curs_util.3x index ac23f963..36085fd9 100644 --- a/upstream/archlinux/man3/curs_util.3x +++ b/upstream/archlinux/man3/curs_util.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,80 +28,73 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_util.3x,v 1.66 2023/03/11 20:28:02 tom Exp $ -.TH curs_util 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_util.3x,v 1.101 2024/04/20 21:20:07 tom Exp $ +.TH curs_util 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBdelay_output\fP, -\fBfilter\fP, -\fBflushinp\fP, -\fBgetwin\fP, -\fBkey_name\fP, -\fBkeyname\fP, -\fBnofilter\fP, -\fBputwin\fP, -\fBunctrl\fP, -\fBuse_env\fP, -\fBuse_tioctl\fP, -\fBwunctrl\fP \- miscellaneous \fBcurses\fP utility routines -.ad -.hy +\fB\%delay_output\fP, +\fB\%filter\fP, +\fB\%flushinp\fP, +\fB\%getwin\fP, +\fB\%key_name\fP, +\fB\%keyname\fP, +\fB\%nofilter\fP, +\fB\%putwin\fP, +\fB\%unctrl\fP, +\fB\%use_env\fP, +\fB\%use_tioctl\fP, +\fB\%wunctrl\fP \- +miscellaneous \fIcurses\fR utility routines .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBconst char *unctrl(chtype \fIc\fB);\fR -.br -\fBwchar_t *wunctrl(cchar_t *\fIc\fB);\fR -.sp -\fBconst char *keyname(int \fIc\fB);\fR -.br -\fBconst char *key_name(wchar_t \fIw\fB);\fR -.sp -\fBvoid filter(void);\fP -.br -\fBvoid nofilter(void);\fP -.sp -\fBvoid use_env(bool \fIf\fB);\fR -.br -\fBvoid use_tioctl(bool \fIf\fB);\fR -.sp -\fBint putwin(WINDOW *\fIwin\fB, FILE *\fIfilep\fB);\fR -.br -\fBWINDOW *getwin(FILE *\fIfilep\fB);\fR -.sp -\fBint delay_output(int \fIms\fB);\fR -.br -\fBint flushinp(void);\fP -.br -.SH DESCRIPTION -.SS unctrl +.nf +\fB#include <curses.h> .PP -The \fBunctrl\fP routine returns a character string which is a printable -representation of the character \fIc\fP, ignoring attributes. -Control characters are displayed in the \fB^\fIX\fR notation. -Printing characters are displayed as is. +\fBconst char *unctrl(chtype \fIch\fP); +\fBwchar_t *wunctrl(cchar_t *\fIwch\fP); .PP -The corresponding \fBwunctrl\fP returns a printable representation of -a wide character. -.SS keyname/key_name +\fBconst char *keyname(int \fIc\fP); +\fBconst char *key_name(wchar_t \fIwc\fP); .PP -The \fBkeyname\fP routine returns a character string -corresponding to the key \fIc\fP: +\fBvoid filter(void); +.PP +\fBvoid use_env(bool \fIf\fP); +.PP +\fBint putwin(WINDOW *\fIwin\fP, FILE *\fIfilep\fP); +\fBWINDOW *getwin(FILE *\fIfilep\fP); +.PP +\fBint delay_output(int \fIms\fP); +\fBint flushinp(void); +.PP +\fI/* extensions */ +\fBvoid nofilter(void); +\fBvoid use_tioctl(bool \fIf\fP); +.fi +.SH DESCRIPTION +.SS unctrl +The \fBunctrl\fP routine returns a character string which is a printable +representation of the character \fIch\fP: .bP Printable characters are displayed as themselves, e.g., a one-character string containing the key. .bP Control characters are displayed in the \fB^\fIX\fR notation. .bP +Printing characters are displayed as is. +.bP DEL (character 127) is displayed as \fB^?\fP. .bP Values above 128 are either meta characters @@ -111,20 +104,38 @@ shown in the \fBM\-\fIX\fR notation, or are displayed as themselves. In the latter case, the values may not be printable; this follows the X/Open specification. +.PP +The corresponding \fBwunctrl\fP returns a printable representation of +a complex character \fIwch\fP. +.PP +In both \fBunctrl\fP and \fBwunctrl\fP the attributes and color associated +with the character parameter are ignored. +.SS "keyname, key_name" +The \fBkeyname\fP routine returns a character string +corresponding to the key \fIc\fP. +Key codes are different from character codes. .bP -Values above 256 may be the names of the names of function keys. +Key codes below 256 are characters. +They are displayed using \fBunctrl\fP. .bP -Otherwise (if there is no corresponding name) the function returns null, -to denote an error. +Values above 256 may be the codes for function keys. +The function key name is displayed. +.bP +Otherwise (if there is no corresponding name and the key is not a character) +the function returns null, to denote an error. X/Open also lists an \*(``UNKNOWN KEY\*('' return value, which some implementations return rather than null. .LP -The corresponding \fBkey_name\fP returns a character string corresponding +The corresponding \fBkey_name\fP returns +a multibyte character string corresponding to the wide-character value \fIw\fP. -The two functions do not return the same set of strings; -the latter returns null where the former would display a meta character. -.SS filter/nofilter -.PP +The two functions (\fBkeyname\fP and \fBkey_name\fP) +do not return the same set of strings: +.bP +\fBkeyname\fP returns null where \fBkey_name\fP would display a meta character. +.bP +\fBkey_name\fP does not return the name of a function key. +.SS "filter, nofilter" The \fBfilter\fP routine, if used, must be called before \fBinitscr\fP or \fBnewterm\fP are called. Calling \fBfilter\fP causes these changes in initialization: @@ -152,15 +163,15 @@ using a different value of \fB$TERM\fP. The limitation arises because the \fBfilter\fP routine modifies the in-memory copy of the terminal information. .SS use_env -.PP The \fBuse_env\fP routine, if used, should be called before \fBinitscr\fP or \fBnewterm\fP are called (because those compute the screen size). -It modifies the way \fBncurses\fP treats environment variables +It modifies the way \fI\%ncurses\fP treats environment variables when determining the screen size. .bP -Normally \fBncurses\fP looks first at the terminal database for the screen size. +Normally \fI\%ncurses\fP looks first at the terminal database for the +screen size. .IP If \fBuse_env\fP was called with \fBFALSE\fP for parameter, it stops here unless @@ -171,57 +182,57 @@ If successful, it overrides the values from the terminal database. .bP Finally (unless \fBuse_env\fP was called with \fBFALSE\fP parameter), -\fBncurses\fP examines the \fBLINES\fP or \fBCOLUMNS\fP environment variables, +\fI\%ncurses\fP examines the \fILINES\fP or \fI\%COLUMNS\fP environment +variables, using a value in those to override the results from the operating system or terminal database. .IP -\fBNcurses\fP also updates the screen size in response to \fBSIGWINCH\fP, -unless overridden by the \fBLINES\fP or \fBCOLUMNS\fP environment variables, +\fI\%curses\fP also updates the screen size in response to +\fBSIGWINCH\fP, +unless overridden by the \fILINES\fP or \fI\%COLUMNS\fP environment +variables, .SS use_tioctl -.PP The \fBuse_tioctl\fP routine, if used, should be called before \fBinitscr\fP or \fBnewterm\fP are called (because those compute the screen size). After \fBuse_tioctl\fP is called with \fBTRUE\fP as an argument, -\fBncurses\fP modifies the last step in its computation +\fI\%ncurses\fP modifies the last step in its computation of screen size as follows: .bP -checks if the \fBLINES\fP and \fBCOLUMNS\fP environment variables +checks if the \fILINES\fP and \fI\%COLUMNS\fP environment variables are set to a number greater than zero. .bP -for each, \fBncurses\fP updates the corresponding environment variable +for each, \fI\%ncurses\fP updates the corresponding environment variable with the value that it has obtained via operating system call or from the terminal database. .bP -\fBncurses\fP re-fetches the value of the environment variables so that -it is still the environment variables which set the screen size. +\fI\%ncurses\fP re-fetches the value of the environment variables so +that it is still the environment variables which set the screen size. .PP -The \fBuse_env\fP and \fBuse_tioctl\fP routines combine as -summarized here: +The \fB\%use_env\fP and \fB\%use_tioctl\fP routines combine as follows. +.IP .TS -center tab(/); -l l l -_ _ _ -lw7 lw7 lw40. -\fBuse_env\fP/\fBuse_tioctl\fP/\fBSummary\fP -TRUE/FALSE/T{ +lB lB lB +lB lB lx. +use_env use_tioctl Summary +_ +TRUE FALSE T{ This is the default behavior. -\fBncurses\fP uses operating system calls -unless overridden by $LINES or $COLUMNS environment variables. -T} -TRUE/TRUE/T{ -\fBncurses\fP updates $LINES and $COLUMNS based on operating system calls. +\fI\%ncurses\fP uses operating system calls +unless overridden by \fILINES\fP or \fI\%COLUMNS\fP environment +variables; +default. T} -FALSE/TRUE/T{ -\fBncurses\fP ignores $LINES and $COLUMNS, -uses operating system calls to obtain size. +TRUE TRUE T{ +\fI\%ncurses\fP updates \fILINES\fP and \fI\%COLUMNS\fP based on +operating system calls. T} -FALSE/FALSE/T{ -\fBncurses\fP relies on the terminal database to determine size. +FALSE TRUE T{ +\fI\%ncurses\fP ignores \fILINES\fP and \fI\%COLUMNS\fP, +using operating system calls to obtain size. T} .TE -.SS putwin/getwin -.PP +.SS "putwin, getwin" The \fBputwin\fP routine writes all data associated with window (or pad) \fIwin\fP into the file to which \fIfilep\fP points. @@ -235,10 +246,10 @@ data. It returns a pointer to the new window. There are a few caveats: .bP -the data written is a copy of the \fBWINDOW\fP structure, +the data written is a copy of the \fI\%WINDOW\fP structure, and its associated character cells. -The format differs between the wide-character (\fBncursesw\fP) and -non-wide (\fBncurses\fP) libraries. +The format differs between the wide-character (\fI\%ncursesw\fP) and +non-wide (\fI\%ncurses\fP) libraries. You can transfer data between the two, however. .bP the retrieved window is always created as a top-level window (or pad), @@ -250,15 +261,24 @@ If cells in the retrieved window use color pairs which have not been created in the application using \fBinit_pair\fP, they will not be colored when the window is refreshed. .SS delay_output -.PP The \fBdelay_output\fP routine inserts an \fIms\fP millisecond pause in output. -This routine should not be used extensively because -padding characters are used rather than a CPU pause. -If no padding character is specified, -this uses \fBnapms\fP to perform the delay. -.SS flushinp +Employ this function judiciously when terminal output uses padding, +because \fI\%ncurses\fP transmits null characters +(consuming CPU and I/O resources) +instead of sleeping and requesting resumption from the operating system. +Padding is used unless: +.bP +the terminal description has \fBnpc\fP (\fBno_pad_char\fP) capability, or +.bP +the environment variable \fB\%NCURSES_NO_PADDING\fP is set. .PP +If padding is not in use, +\fI\%ncurses\fP uses \fBnapms\fP to perform the delay. +If the value of \fIms\fP exceeds 30,000 +(thirty seconds), +it is capped at that value. +.SS flushinp The \fBflushinp\fP routine throws away any typeahead that has been typed by the user and has not yet been read by the program. .SH RETURN VALUE @@ -268,7 +288,7 @@ upon failure and \fBOK\fP (SVr4 specifies only "an integer value other than .PP Routines that return pointers return \fBNULL\fP on error. .PP -X/Open does not define any error conditions. +X/Open Curses does not specify any error conditions. In this implementation .RS 3 .TP 5 @@ -280,13 +300,22 @@ returns an error if the associated \fBfwrite\fP calls return an error. .RE .SH PORTABILITY .SS filter -.PP The SVr4 documentation describes the action of \fBfilter\fP only in the vaguest terms. -The description here is adapted from the XSI Curses standard (which +The description here is adapted from X/Open Curses (which erroneously fails to describe the disabling of \fBcuu\fP). -.SS keyname +.SS "delay_output padding" +The limitation to 30 seconds +and the use of \fBnapms\fP +differ from other implementations. +.bP +SVr4 curses does not delay if no padding character is available. +.bP +NetBSD curses uses \fBnapms\fP when no padding character is available, +but does not take timing into account when using the padding character. .PP +Neither limits the delay. +.SS keyname The \fBkeyname\fP function may return the names of user-defined string capabilities which are defined in the terminfo entry via the \fB\-x\fP option of \fBtic\fP. @@ -297,14 +326,13 @@ the same value for different runs because user-defined codes are merged from all terminal descriptions which have been loaded. The \fBuse_extended_names\fP(3X) function controls whether this data is loaded when the terminal description is read by the library. -.SS nofilter/use_tioctl -.PP -The \fBnofilter\fP and \fBuse_tioctl\fP routines are specific to \fBncurses\fP. +.SS "nofilter, use_tioctl" +The \fBnofilter\fP and \fBuse_tioctl\fP routines are specific to +\fI\%ncurses\fP. They were not supported on Version 7, BSD or System V implementations. -It is recommended that any code depending on \fBncurses\fP extensions -be conditioned using NCURSES_VERSION. -.SS putwin/getwin file-format -.PP +It is recommended that any code depending on \fI\%ncurses\fP extensions +be conditioned using \fBNCURSES_VERSION\fP. +.SS "putwin/getwin file-format" The \fBputwin\fP and \fBgetwin\fP functions have several issues with portability: .bP @@ -319,9 +347,10 @@ the University of California, Berkeley (in 1982) and were later (in 1988) incorporated into SVr4. Oddly, there are no such functions in the 4.3BSD curses sources. .bP -Most implementations simply dump the binary \fBWINDOW\fP structure to the file. +Most implementations simply dump the binary \fI\%WINDOW\fP structure +to the file. These include SVr4 curses, NetBSD and PDCurses, -as well as older \fBncurses\fP versions. +as well as older \fI\%ncurses\fP versions. This implementation (as well as the X/Open variant of Solaris curses, dated 1995) uses textual dumps. @@ -334,9 +363,8 @@ these functions. Doing that can run into problems mixing block- and buffered-I/O. This implementation reduces the problem on writes by flushing the output. However, reading from a file written using mixed schemes may not be successful. -.SS unctrl/wunctrl -.PP -The XSI Curses standard, Issue 4 describes these functions. +.SS "unctrl, wunctrl" +X/Open Curses, Issue 4 describes these functions. It states that \fBunctrl\fP and \fBwunctrl\fP will return a null pointer if unsuccessful, but does not define any error conditions. This implementation checks for three cases: @@ -385,24 +413,23 @@ When treating them as \*(``meta\*('' keys this implementation returns strings \*(``M\-^@\*('', \*(``M\-^A\*('', etc. .PP X/Open Curses documents \fBunctrl\fP as declared in \fB<unctrl.h>\fP, -which \fBncurses\fP does. -However, \fBncurses\fP' \fB<curses.h>\fP includes \fB<unctrl.h>\fP, +which \fI\%ncurses\fP does. +However, \fI\%ncurses\fP' \fB<curses.h>\fP includes \fB<unctrl.h>\fP, matching the behavior of SVr4 curses. Other implementations may not do that. -.SS use_env/use_tioctl -.PP -If \fBncurses\fP is configured to provide the sp-functions extension, +.SS "use_env, use_tioctl" +If \fI\%ncurses\fP is configured to provide the sp-functions extension, the state of \fBuse_env\fP and \fBuse_tioctl\fP may be updated before creating each \fIscreen\fP rather than once only (\fBcurs_sp_funcs\fP(3X)). This feature of \fBuse_env\fP -is not provided by other implementation of curses. +is not provided by other implementations of curses. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_initscr\fP(3X), -\fBcurs_inopts\fP(3X), -\fBcurs_kernel\fP(3X), -\fBcurs_scr_dump\fP(3X), -\fBcurs_sp_funcs\fP(3X), -\fBcurs_variables\fP(3X), -\fBlegacy_coding\fP(3X). +\fB\%curses\fP(3X), +\fB\%curs_initscr\fP(3X), +\fB\%curs_inopts\fP(3X), +\fB\%curs_kernel\fP(3X), +\fB\%curs_scr_dump\fP(3X), +\fB\%curs_sp_funcs\fP(3X), +\fB\%curs_variables\fP(3X), +\fB\%legacy_coding\fP(3X) diff --git a/upstream/archlinux/man3/curs_variables.3x b/upstream/archlinux/man3/curs_variables.3x index ad6a5b80..a4236ac6 100644 --- a/upstream/archlinux/man3/curs_variables.3x +++ b/upstream/archlinux/man3/curs_variables.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2020,2021 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 2010-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,162 +27,303 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_variables.3x,v 1.17 2021/12/25 21:49:32 tom Exp $ -.TH curs_variables 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_variables.3x,v 1.47 2024/04/13 22:37:35 tom Exp $ +.TH curs_variables 3X 2024-04-13 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. +.ie \n(.g .ds : \: +.el .ds : \" empty +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.ds n 5 -.na -.hy 0 +. .SH NAME -\fBCOLORS\fP, -\fBCOLOR_PAIRS\fP, -\fBCOLS\fP, -\fBESCDELAY\fP, -\fBLINES\fP, -\fBTABSIZE\fP, -\fBcurscr\fP, -\fBnewscr\fP, -\fBstdscr\fP -\- \fBcurses\fP global variables -.ad -.hy +\fI\%bool\fP, +\fI\%chtype\fP, +\fI\%cchar_t\fP, +\fI\%attr_t\fP, +\fI\%SCREEN\fP, +\fI\%WINDOW\fP, +\fB\%TRUE\fP, +\fB\%FALSE\fP, +\fB\%ERR\fP, +\fB\%OK\fP, +\fB\%curscr\fP, +\fB\%newscr\fP, +\fB\%stdscr\fP, +\fB\%COLORS\fP, +\fB\%COLOR_PAIRS\fP, +\fB\%COLS\fP, +\fB\%LINES\fP, +\fB\%ESCDELAY\fP, +\fB\%TABSIZE\fP \- +\fIcurses\fR data types, constants, and global variables .SH SYNOPSIS .nf -\fB#include <curses.h>\fP -.PP -\fBint COLOR_PAIRS;\fP -.br -\fBint COLORS;\fP -.br -\fBint COLS;\fP -.br -\fBint ESCDELAY;\fP -.br -\fBint LINES;\fP -.br -\fBint TABSIZE;\fP -.br -\fBWINDOW * curscr;\fP -.br -\fBWINDOW * newscr;\fP -.br -\fBWINDOW * stdscr;\fP +\fB#include <curses.h> +.PP +\fI/* data types */ +\fBtypedef \fI/*\fP .\|.\|. \fI*/\fP bool; +\fBtypedef \fI/*\fP .\|.\|. \fI*/\fP chtype; +\fBtypedef \fI/*\fP .\|.\|. \fI*/\fP cchar_t; +\fBtypedef \fI/*\fP .\|.\|. \fI*/\fP attr_t; +\fBtypedef \fI/*\fP .\|.\|. \fI*/\fP SCREEN; +\fBtypedef \fI/*\fP .\|.\|. \fI*/\fP WINDOW; +.PP +\fI/* constants */ +\fBconst bool TRUE; +\fBconst bool FALSE; +.PP +\fBconst \fI/*\fP .\|.\|. \fI*/\fP ERR; +\fBconst \fI/*\fP .\|.\|. \fI*/\fP OK; +.PP +\fI/* variables */ +\fBint COLORS; +\fBint COLOR_PAIRS; +\fBint COLS; +\fBint LINES; +\fBWINDOW * curscr; +\fBWINDOW * stdscr; +.PP +\fI/* extensions */ +\fBint ESCDELAY; +\fBint TABSIZE; +\fBWINDOW * newscr; .fi .SH DESCRIPTION -This page summarizes variables provided by the \fBcurses\fP library. -A more complete description is given in the \fBcurses\fP(3X) manual page. +This page summarizes data types, +constants, +and variables provided by the \fIcurses\fP library. +Locate further discussion in \fB\%curses\fP(3X). .PP -Depending on the configuration, these may be actual variables, -or macros (see \fBcurs_threads\fP(3X) and \fBcurs_opaque\fP(3X)) -which provide read-only access to \fIcurses\fP's state. -In either case, applications should treat them as read-only to avoid +Depending on \fI\%ncurses\fP's build-time configuration, +the variables may instead be +macros (see \fB\%curs_threads\fP(3X) and \fB\%curs_opaque\fP(3X)) +that provide read-only access to the library's state. +In either case, +applications should treat them as read-only to avoid confusing the library. -.SS COLOR_PAIRS -After initializing curses, this variable contains the number of color pairs -which the terminal can support. -Usually the number of color pairs will be the product \fBCOLORS\fP*\fBCOLORS\fP, -however this is not always true: -.bP -a few terminals use HLS colors, which do not follow this rule -.bP -terminals supporting a large number of colors are limited by the number -of color pairs that can be represented in a \fIsigned short\fP value. +.SH "CONSTANTS" +.SS "TRUE, FALSE" +The \fIcurses\fP library defines \fBTRUE\fP and \fBFALSE\fP +to represent the values of the Boolean data type. +.SS "ERR, OK" +\fIcurses\fP and \fIterminfo\fP routines frequently return these +constant integral values indicating failure and success, +respectively. +.SH "PREDEFINED TYPES" +.SS "\fIbool\fP" +X/Open Issue 4 \fIcurses\fP (1996) preceded the ISO C99 and ISO C++98 +standards, +each of which also defined a Boolean data type. +The \fIcurses\fP library requires an integral type \fIbool\fP. +.PP +\fB\%ncurses\fP' configure script attempts to discover the +data type used by the system's C and C++ compilers, +to reuse for the \fIcurses\fP \fIbool\fP. +.SS "\fIchtype\fP" +The \fI\%chtype\fP integral type combines a +(\*(``narrow\*('', +8-bit) +character with attributes encoding the character's \fIrendition\fP, +such as the styling of its typeface and/or foreground and background +colors. +See, +for example, +\fB\%addch\fP(3X), +\fB\%attron\fP(3X), +and +\fB\%inch\fP(3X). +.SS "\fIcchar_t\fP, \fIattr_t\fP" +\fI\%chtype\fP is too small for the standard C library's wide-character +type, +\fIwchar_t\fP. +\fI\%cchar_t\fP is a type that can accommodate an \fI\%attr_t\fP and +enough wide characters to store what Unicode terms a \fIgrapheme cluster\fP +(a \*(``user-perceived character\*('' [UAX #29], +which may nevertheless require several character encoding units to +represent). +\fI\%attr_t\fP is an integral type storing \*(``wide\*('' attributes that +apply to \fI\%cchar_t\fPs. +See, +for example, +\fB\%add_wch\fP(3X), +\fB\%attr_on\fP(3X), +and +\fB\%in_wch\fP(3X). +.SS "\fISCREEN\fP" +.I curses +manages a terminal device with this structure type; +see \fB\%initscr\fP(3X). +.SS "\fIWINDOW\fP" +.I curses +represents rectangular portions of the terminal screen with the +.I \%WINDOW +structure type; +see subsection \*(``Overview\*('' of \fB\%ncurses\fP(3X). +.SH "VARIABLES" +.SS "curscr, stdscr, newscr" +The library records updates to the terminal screen in a window named +\fB\%curscr\fP. +This object is referred to as the \*(``physical screen\*('' in +\fB\%curs_refresh\fP(3X) and +\fB\%curs_outopts\fP(3X). +.PP +\fI\%ncurses\fP collects pending updates to the terminal screen in a +window named \fB\%newscr\fP. +This object is referred to as the \*(``virtual screen\*('' in the +\fB\%curs_kernel\fP(3X), +\fB\%curs_refresh\fP(3X), +and +\fB\%curs_outopts\fP(3X). +When the screen is refreshed, +\fIcurses\fP determines a minimal set of updates using the terminal's +capabilities to make \fB\%curscr\fP look like \fB\%newscr\fP. +.PP +Once \fIcurses\fP is initialized, +it creates a window named \fB\%stdscr\fP. +It is the same size as the terminal screen and is the default window +used by routines that do not take a parameter identifying one. +Many \fIcurses\fP functions use this window. .SS COLORS -After initializing curses, this variable contains the number of colors -which the terminal can support. -.SS COLS -After initializing curses, this variable contains the width of the screen, -i.e., the number of columns. +Once \fIcurses\fP is initialized, +\fB\%COLORS\fP +contains the number of colors supported by the terminal; +see \fB\%curs_color\fP(3X). +.SS COLOR_PAIRS +Once \fIcurses\fP is initialized, +\fB\%COLOR_PAIRS\fP +contains the number of color pairs supported by the terminal; +see \fB\%curs_color\fP(3X). +.SS "COLS, LINES" +Once \fIcurses\fP is initialized, +.B \%COLS +and +.B LINES +contain the screen's width and height in character cells, +respectively; +that is, +the number of columns and lines. .SS ESCDELAY -This variable holds the number of milliseconds to wait after reading an -escape character, -to distinguish between an individual escape character entered on the -keyboard from escape sequences sent by cursor- and function-keys -(see curses(3X)). -.SS LINES -After initializing curses, this variable contains the height of the screen, -i.e., the number of lines. +For +.I curses +to distinguish the ESC character resulting from a user's press of the +\*(``Escape\*('' key on the input device from one beginning an +.I "escape sequence" +(as commonly produced by function keys), +it waits after the escape character to see if further characters are +available on the input stream within a short interval. +.B \%ESCDELAY +stores this interval in milliseconds. +.PP +If \fB\%keypad\fP(3X) is disabled for the +.I curses +window receiving input, +a program must disambiguate escape sequences itself. .SS TABSIZE -This variable holds the number of columns used by the \fIcurses\fP library -when converting a tab character to spaces as it adds the tab to a window -(see \fBcurs_addch\fP(3X). -.SS The Current Screen -This implementation of curses uses a special window \fBcurscr\fP to -record its updates to the terminal screen. -.PP -This is referred to as the \*(``physical screen\*('' in the -\fBcurs_refresh\fP(3X) and -\fBcurs_outopts\fP(3X) manual pages. -.SS The New Screen -This implementation of curses uses a special window \fBnewscr\fP to -hold updates to the terminal screen before applying them to \fBcurscr\fP. -.PP -This is referred to as the \*(``virtual screen\*('' in the -\fBcurs_kernel\fP(3X), -\fBcurs_refresh\fP(3X) and -\fBcurs_outopts\fP(3X) manual pages. -.SS The Standard Screen -Upon initializing curses, -a default window called \fBstdscr\fP, -which is the size of the terminal screen, is created. -Many curses functions use this window. +The \fIcurses\fP library converts a tab character to this number of +spaces as it adds a tab to a window; +see \fB\%curs_addch\fP(3X). .SH NOTES -The curses library is initialized using either \fBinitscr\fP(3X), -or \fBnewterm\fP(3X). +Either \fB\%initscr\fP(3X) or \fB\%newterm\fP(3X) initializes +\fIcurses\fP. .PP -If \fBcurses\fP is configured to use separate curses/terminfo libraries, -most of these variables reside in the curses library. +If +.I \%ncurses +is configured to provide separate +.I curses +and +.I \%tinfo +libraries, +most of these variables reside in the former. .SH PORTABILITY -\fBTABSIZE\fP is a feature of SVr4 curses -which is not documented by X/Open curses. +The X/Open Curses standard documents all of the foregoing types and +symbols except for \fB\%newscr\fP, +\fB\%TABSIZE\fP, +and \fB\%ESCDELAY\fP. +.PP +X/Open Curses describes \fB\%curscr\fP only as \*(``an internal data +structure\*(''; +SVr4 gave more details, +noting its use \*(``for certain low-level operations like clearing and +redrawing a screen containing garbage\*(''. +.\" SVID 4, Volume 3, p. 408 +Neither specified its interaction with the rest of the interface beyond +use as an argument to \fB\%clearok\fP(3X) and \fB\%wrefresh\fP(3X). +.PP +\fB\%newscr\fP is a feature of SVr4 \fIcurses\fP. +When refreshing the screen, +it is used as a working area for combining the standard window +\fB\%stdscr\fP with any others the application may have created with +\fB\%newwin\fP(3X). +When the update of \fB\%newscr\fP is complete, +\fIcurses\fP modifies \fB\%curscr\fP to match \fB\%newscr\fP. +.PP +\fB\%TABSIZE\fP is a feature of SVr4 \fIcurses\fP. .bP -In SVr4 curses, \fBTABSIZE\fP is initially set from the terminal description's -\fBinit_tabs\fP capability. -After that, it can be altered by the applications using SVr4 curses. -.IP -SVr4 curses uses the current value of \fBTABSIZE\fP to -compute the position of tabstops for updating both -the virtual screen with \fBaddch\fP(3X) as well as -the physical screen with \fBmvcur\fP(3X). +SVr4 initially sets \fB\%TABSIZE\fP from the terminal description's +\fB\%init_tabs\fP capability. +After that, +it can be altered by applications using SVr4 \fIcurses\fP. .bP -This implementation uses the current value of \fBTABSIZE\fP only for -updating the virtual screen. -It uses the terminal description's \fBit\fP (\fBinit_tabs\fP) capability for -computing hardware tabs (i.e., tab stops on the physical screen). +SVr4 \fIcurses\fP uses the value of \fB\%TABSIZE\fP to compute the +position of tab stops when updating both +the virtual screen with \fB\%addch\fP(3X) and +the physical screen with \fB\%mvcur\fP(3X). +.bP +\fI\%ncurses\fP uses the value of \fB\%TABSIZE\fP only to update the +virtual screen. +It uses the terminal description's \*(``\fBit\fP\*('' +(\fB\%init_tabs\fP) capability for computing hardware tabs +(that is, +tab stops on the physical screen). .bP Other implementations differ. -For instance, NetBSD curses allows \fBTABSIZE\fP to be set through -an environment variable. -This implementation does not. +For instance, +NetBSD \fIcurses\fP allows \fB\%TABSIZE\fP to be set through an +environment variable. +\fI\%ncurses\fP does not. .IP -NetBSD curses does not support hardware tabs; -it uses the \fBinit_tabs\fP capability and the \fBTABSIZE\fP variable -only for updating the virtual screen. +NetBSD \fIcurses\fP does not support hardware tabs; +it uses the \fB\%init_tabs\fP capability and the \fB\%TABSIZE\fP +variable only for updating the virtual screen. .PP -\fBESCDELAY\fP is an extension in AIX curses: +\fB\%ESCDELAY\fP is a feature of AIX \fIcurses\fP. .bP -In AIX, the units for \fBESCDELAY\fP are \fIfifths\fP of a millisecond. +In AIX, +the units for \fB\%ESCDELAY\fP are \fIfifths\fP of milliseconds. .bP -The default value for AIX's \fBESCDELAY\fP is 0.1 seconds. +The default value for AIX's \fB\%ESCDELAY\fP equals 0.1 seconds. .bP -AIX also enforces a limit of 10,000 seconds for \fBESCDELAY\fP; -this implementation currently has no upper limit. +AIX also enforces a limit of 10,000 seconds for \fB\%ESCDELAY\fP; +\fI\%ncurses\fP does not enforce any upper limit. .PP -This implementation has long used \fBESCDELAY\fP with units of milliseconds, +\fI\%ncurses\fP has long used \fB\%ESCDELAY\fP with units of +milliseconds, making it impossible to be completely compatible with AIX. -Likewise, most users have either decided to override the value, -or rely upon its default value. +Consequently, +most users have decided either to override the value, +or to rely upon its default. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_opaque\fP(3X), -\fBcurs_terminfo\fP(3X), -\fBcurs_threads\fP(3X), -\fBterm_variables\fP(3X), -\fBterminfo\fP(\*n). +\fB\%curses\fP(3X), +\fB\%curs_color\fP(3X), +\fB\%curs_opaque\fP(3X), +\fB\%curs_terminfo\fP(3X), +\fB\%curs_threads\fP(3X), +\fB\%term_variables\fP(3X), +\fB\%terminfo\fP(5) +.PP +[UAX #29] \*(``Unicode Standard Annex #29: Unicode Text +Segmentation\*(''; +\%<https://\*:unicode\*:.org/\*:reports/\*:tr29/> diff --git a/upstream/archlinux/man3/curs_window.3x b/upstream/archlinux/man3/curs_window.3x index f37eb5f6..a342ddb9 100644 --- a/upstream/archlinux/man3/curs_window.3x +++ b/upstream/archlinux/man3/curs_window.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2020-2021,2022 Thomas E. Dickey * +.\" Copyright 2020-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2015,2016 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,59 +27,47 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_window.3x,v 1.28 2022/08/13 23:24:22 tom Exp $ -.TH curs_window 3X "" +.\" $Id: curs_window.3x,v 1.48 2024/04/20 21:20:07 tom Exp $ +.TH curs_window 3X 2024-04-20 "ncurses 6.5" "Library calls" .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.na -.hy 0 .SH NAME -\fBnewwin\fP, -\fBdelwin\fP, -\fBmvwin\fP, -\fBsubwin\fP, -\fBderwin\fP, -\fBmvderwin\fP, -\fBdupwin\fP, -\fBwsyncup\fP, -\fBsyncok\fP, -\fBwcursyncup\fP, -\fBwsyncdown\fP \- create \fBcurses\fP windows -.ad -.hy +\fB\%newwin\fP, +\fB\%delwin\fP, +\fB\%mvwin\fP, +\fB\%subwin\fP, +\fB\%derwin\fP, +\fB\%mvderwin\fP, +\fB\%dupwin\fP, +\fB\%wsyncup\fP, +\fB\%syncok\fP, +\fB\%wcursyncup\fP, +\fB\%wsyncdown\fP \- +create and manipulate \fIcurses\fR windows .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBWINDOW *newwin(\fP +.nf +\fB#include <curses.h> +.PP +\fBWINDOW *newwin( \fBint \fInlines\fB, int \fIncols\fB,\fR \fBint \fIbegin_y\fB, int \fIbegin_x\fB);\fR -.br \fBint delwin(WINDOW *\fIwin\fB);\fR -.br \fBint mvwin(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB);\fR -.br \fBWINDOW *subwin(WINDOW *\fIorig\fB,\fR \fBint \fInlines\fB, int \fIncols\fB,\fR \fBint \fIbegin_y\fB, int \fIbegin_x\fB);\fR -.br \fBWINDOW *derwin(WINDOW *\fIorig\fB,\fR \fBint \fInlines\fB, int \fIncols\fB,\fR \fBint \fIbegin_y\fB, int \fIbegin_x\fB);\fR -.br \fBint mvderwin(WINDOW *\fIwin\fB, int \fIpar_y\fB, int \fIpar_x\fB);\fR -.br \fBWINDOW *dupwin(WINDOW *\fIwin\fB);\fR -.br \fBvoid wsyncup(WINDOW *\fIwin\fB);\fR -.br \fBint syncok(WINDOW *\fIwin\fB, bool \fIbf\fB);\fR -.br \fBvoid wcursyncup(WINDOW *\fIwin\fB);\fR -.br \fBvoid wsyncdown(WINDOW *\fIwin\fB);\fR -.br +.fi .SH DESCRIPTION .SS newwin Calling \fBnewwin\fP creates and returns a pointer to a new window with the @@ -108,54 +96,49 @@ rather than a duplicate (with \fBdupwin\fP), all of the window modes are initialized to the default values. These functions set window modes after a window is created: .RS -.na .PP -idcok, -idlok, -immedok, -keypad, -leaveok, -nodelay, -scrollok, -setscrreg, -syncok, -wbkgdset, -wbkgrndset, and -wtimeout +\fB\%idcok\fP +\fB\%idlok\fP +\fB\%immedok\fP +\fB\%keypad\fP +\fB\%leaveok\fP +\fB\%nodelay\fP +\fB\%scrollok\fP +\fB\%setscrreg\fP +\fB\%syncok\fP +\fB\%wbkgdset\fP +\fB\%wbkgrndset\fP and +\fB\%wtimeout\fP. .RE -.ad .SS delwin -.PP Calling \fBdelwin\fP deletes the named window, freeing all memory associated with it (it does not actually erase the window's screen image). Subwindows must be deleted before the main window can be deleted. .SS mvwin -.PP Calling \fBmvwin\fP moves the window so that the upper left-hand corner is at position (\fIx\fP, \fIy\fP). If the move would cause the window to be off the screen, it is an error and the window is not moved. Moving subwindows is allowed, but should be avoided. .SS subwin -.PP Calling \fBsubwin\fP creates and returns a pointer to a new window with the given number of lines, \fInlines\fP, and columns, \fIncols\fP. The window is at position (\fIbegin\fR_\fIy\fP, \fIbegin\fR_\fIx\fP) on the screen. The subwindow shares memory with the window \fIorig\fP, +its \fIancestor\fP, so that changes made to one window will affect both windows. When using this routine, it is necessary to call \fBtouchwin\fP or \fBtouchline\fP on \fIorig\fP before calling \fBwrefresh\fP on the subwindow. .SS derwin -.PP Calling \fBderwin\fP is the same as calling \fBsubwin,\fP except that \fIbegin\fR_\fIy\fP and \fIbegin\fR_\fIx\fP are relative to the origin of the window \fIorig\fP rather than the screen. There is no difference between the subwindows and the derived windows. -.PP +.SS mvderwin Calling \fBmvderwin\fP moves a derived window (or subwindow) inside its parent window. The screen-relative parameters of the window are not changed. @@ -163,23 +146,19 @@ This routine is used to display different parts of the parent window at the same physical position on the screen. .SS dupwin -.PP Calling \fBdupwin\fP creates an exact duplicate of the window \fIwin\fP. .SS wsyncup -.PP Calling \fBwsyncup\fP touches all locations in ancestors of \fIwin\fP that are changed in \fIwin\fP. If \fBsyncok\fP is called with second argument \fBTRUE\fP then \fBwsyncup\fP is called automatically whenever there is a change in the window. .SS wsyncdown -.PP The \fBwsyncdown\fP routine touches each location in \fIwin\fP that has been touched in any of its ancestor windows. This routine is called by \fBwrefresh\fP, so it should almost never be necessary to call it manually. .SS wcursyncup -.PP The routine \fBwcursyncup\fP updates the current cursor position of all the ancestors of the window to reflect the current cursor position of the window. @@ -242,20 +221,8 @@ If many small changes are made to the window, the \fBwsyncup\fP option could degrade performance. .PP Note that \fBsyncok\fP may be a macro. -.SH BUGS -The subwindow functions (\fBsubwin\fP, \fBderwin\fP, \fBmvderwin\fP, -\fBwsyncup\fP, \fBwsyncdown\fP, \fBwcursyncup\fP, \fBsyncok\fP) are flaky, -incompletely implemented, and not well tested. -.PP -The System V curses documentation is very unclear about what \fBwsyncup\fP -and \fBwsyncdown\fP actually do. -It seems to imply that they are only -supposed to touch exactly those lines that are affected by ancestor changes. -The language here, and the behavior of the \fBcurses\fP implementation, -is patterned on the XPG4 curses standard. -The weaker XPG4 spec may result in slower updates. .SH PORTABILITY -The XSI Curses standard, Issue 4 describes these functions. +X/Open Curses, Issue 4 describes these functions. .PP X/Open Curses states regarding \fBdelwin\fP: .bP @@ -268,15 +235,38 @@ It simply returned \fBERR\fP when asked to delete a subwindow. Solaris X/Open curses does not even make that check, and will delete a parent window which still has subwindows. .bP -Since release 4.0 (1996), ncurses maintains a list of windows for each screen, +Since release 4.0 (1996), +\fI\%ncurses\fP maintains a list of windows for each screen, to ensure that a window has no subwindows before allowing deletion. .bP -NetBSD copied this feature of ncurses in 2003. +NetBSD copied this feature of \fI\%ncurses\fP in 2003. .br PDCurses follows the scheme used in Solaris X/Open curses. +.SH BUGS +The subwindow functions +\fB\%subwin\fP, +\fB\%derwin\fP, +\fB\%mvderwin\fP, +\fB\%wsyncup\fP, +\fB\%wsyncdown\fP, +\fB\%wcursyncup\fP, +and +\fB\%syncok\fP +are flaky, +incompletely implemented, +and not well tested. +.PP +System\ V's \fIcurses\fP documentation is unclear about what +\fB\%wsyncup\fP and \fB\%wsyncdown\fP actually do. +It seems to imply that they are supposed to touch only those lines that +are affected by changes to a window's ancestors. +The language here, +and behavior of \fI\%ncurses\fP, +is patterned on the X/Open Curses standard; +this approach may result in slower updates. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_initscr\fP(3X), -\fBcurs_refresh\fP(3X), -\fBcurs_touch\fP(3X), -\fBcurs_variables\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_initscr\fP(3X), +\fB\%curs_refresh\fP(3X), +\fB\%curs_touch\fP(3X), +\fB\%curs_variables\fP(3X) diff --git a/upstream/archlinux/man3/d2i_PKCS8PrivateKey_bio.3ssl b/upstream/archlinux/man3/d2i_PKCS8PrivateKey_bio.3ssl index 711c412c..dd53f5e8 100644 --- a/upstream/archlinux/man3/d2i_PKCS8PrivateKey_bio.3ssl +++ b/upstream/archlinux/man3/d2i_PKCS8PrivateKey_bio.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "D2I_PKCS8PRIVATEKEY_BIO 3ssl" -.TH D2I_PKCS8PRIVATEKEY_BIO 3ssl 2024-01-30 3.2.1 OpenSSL +.TH D2I_PKCS8PRIVATEKEY_BIO 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -119,7 +119,7 @@ and \fBi2d_PKCS8PrivateKey_nid_fp()\fR return 1 on success or 0 on error. \&\fBpassphrase\-encoding\fR\|(7) .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2002\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2002\-2018 The OpenSSL Project Authors. All Rights Reserved. .PP 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 diff --git a/upstream/archlinux/man3/d2i_PrivateKey.3ssl b/upstream/archlinux/man3/d2i_PrivateKey.3ssl index 81fe84fb..b864b263 100644 --- a/upstream/archlinux/man3/d2i_PrivateKey.3ssl +++ b/upstream/archlinux/man3/d2i_PrivateKey.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "D2I_PRIVATEKEY 3ssl" -.TH D2I_PRIVATEKEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH D2I_PRIVATEKEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/d2i_RSAPrivateKey.3ssl b/upstream/archlinux/man3/d2i_RSAPrivateKey.3ssl index 1399f96a..9b97c94d 100644 --- a/upstream/archlinux/man3/d2i_RSAPrivateKey.3ssl +++ b/upstream/archlinux/man3/d2i_RSAPrivateKey.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "D2I_RSAPRIVATEKEY 3ssl" -.TH D2I_RSAPRIVATEKEY 3ssl 2024-01-30 3.2.1 OpenSSL +.TH D2I_RSAPRIVATEKEY 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/d2i_SSL_SESSION.3ssl b/upstream/archlinux/man3/d2i_SSL_SESSION.3ssl index 0b2e06ba..b17b68e9 100644 --- a/upstream/archlinux/man3/d2i_SSL_SESSION.3ssl +++ b/upstream/archlinux/man3/d2i_SSL_SESSION.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "D2I_SSL_SESSION 3ssl" -.TH D2I_SSL_SESSION 3ssl 2024-01-30 3.2.1 OpenSSL +.TH D2I_SSL_SESSION 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/d2i_X509.3ssl b/upstream/archlinux/man3/d2i_X509.3ssl index 029eb017..b818ac6c 100644 --- a/upstream/archlinux/man3/d2i_X509.3ssl +++ b/upstream/archlinux/man3/d2i_X509.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "D2I_X509 3ssl" -.TH D2I_X509 3ssl 2024-01-30 3.2.1 OpenSSL +.TH D2I_X509 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/daemon.3 b/upstream/archlinux/man3/daemon.3 index 3c4ebc0e..95d29e7c 100644 --- a/upstream/archlinux/man3/daemon.3 +++ b/upstream/archlinux/man3/daemon.3 @@ -6,7 +6,7 @@ .\" .\" @(#)daemon.3 8.1 (Berkeley) 6/9/93 .\" Added mentioning of glibc weirdness wrt unistd.h. 5/11/98, Al Viro -.TH daemon 3 2023-10-31 "Linux man-pages 6.06" +.TH daemon 3 2024-05-02 "Linux man-pages 6.8" .SH NAME daemon \- run in the background .SH LIBRARY diff --git a/upstream/archlinux/man3/dbopen.3 b/upstream/archlinux/man3/dbopen.3 index 32470ce1..dc88d1a4 100644 --- a/upstream/archlinux/man3/dbopen.3 +++ b/upstream/archlinux/man3/dbopen.3 @@ -5,7 +5,7 @@ .\" .\" @(#)dbopen.3 8.5 (Berkeley) 1/2/94 .\" -.TH dbopen 3 2023-10-31 "Linux man-pages 6.06" +.TH dbopen 3 2024-05-02 "Linux man-pages 6.8" .UC 7 .SH NAME dbopen \- database access methods diff --git a/upstream/archlinux/man3/default_colors.3x b/upstream/archlinux/man3/default_colors.3x index 0710a510..d9544111 100644 --- a/upstream/archlinux/man3/default_colors.3x +++ b/upstream/archlinux/man3/default_colors.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 2000-2011,2016 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -29,21 +29,29 @@ .\" .\" Author: Thomas E. Dickey 1997,1999,2000,2005 .\" -.\" $Id: default_colors.3x,v 1.35 2022/02/12 20:03:40 tom Exp $ -.TH default_colors 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: default_colors.3x,v 1.52 2024/04/13 22:17:22 tom Exp $ +.TH default_colors 3X 2024-04-13 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME -\fBuse_default_colors\fP, -\fBassume_default_colors\fP \- use terminal's default colors +\fB\%use_default_colors\fP, +\fB\%assume_default_colors\fP \- +use terminal's default colors in \fIcurses\fP .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint use_default_colors(void);\fP -.br -\fBint assume_default_colors(int \fIfg\fB, int \fIbg\fB);\fR +.nf +\fB#include <curses.h> +.PP +\fBint use_default_colors(void); +\fBint assume_default_colors(int \fIfg\fP, int \fIbg\fP); +.fi .SH DESCRIPTION The \fBuse_default_colors\fP and \fBassume_default_colors\fP functions are extensions to the curses library. @@ -57,7 +65,8 @@ Some applications are designed to work with the default background, using colors only for text. For example, there are several implementations of the \fBls\fP program which use colors to denote different file types or permissions. -These \*(``color ls\*('' programs do not necessarily modify the background color, +These \*(``color ls\*('' programs do not necessarily +modify the background color, typically using only the \fBsetaf\fP terminfo capability to set the foreground color. Full-screen applications that use default colors can achieve similar @@ -84,9 +93,9 @@ The following are equivalent: .I assume_default_colors(\-1,\-1); .RE .PP -These are ncurses extensions. +These are \fI\%ncurses\fP extensions. For other curses implementations, color -number \-1 does not mean anything, just as for ncurses before a +number \-1 does not mean anything, just as for \fI\%ncurses\fP before a successful call of \fBuse_default_colors\fP or \fBassume_default_colors\fP. .PP Other curses implementations do not allow an application to modify color pair 0. @@ -97,7 +106,7 @@ If your application does not use either .B use_default_colors or .B assume_default_colors -ncurses will paint a white foreground (text) with black background +\fI\%ncurses\fP will paint a white foreground (text) with black background for color pair 0. .SH RETURN VALUE These functions return the integer \fBERR\fP upon failure @@ -131,14 +140,14 @@ a different problem: support for applications which would use environment variables and other configuration to bypass curses' notion of the terminal's default colors, setting specific values. .SH PORTABILITY -These routines are specific to ncurses. +These routines are specific to \fI\%ncurses\fP. They were not supported on Version 7, BSD or System V implementations. It is recommended that any code depending on them be conditioned using NCURSES_VERSION. -.SH SEE ALSO -\fBded\fP(1), -\fBcurs_color\fP(3X). -.SH AUTHOR +.SH AUTHORS Thomas Dickey (from an analysis of the requirements for color xterm for XFree86 3.1.2C, February 1996). +.SH SEE ALSO +\fB\%ded\fP(1), +\fB\%curs_color\fP(3X) diff --git a/upstream/archlinux/man3/define_key.3x b/upstream/archlinux/man3/define_key.3x index 1476bb76..a8466c0d 100644 --- a/upstream/archlinux/man3/define_key.3x +++ b/upstream/archlinux/man3/define_key.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -29,38 +29,43 @@ .\" .\" Author: Thomas E. Dickey 1997 .\" -.\" $Id: define_key.3x,v 1.21 2022/02/12 20:03:40 tom Exp $ -.TH define_key 3X "" +.\" $Id: define_key.3x,v 1.42 2024/03/16 15:35:01 tom Exp $ +.TH define_key 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBdefine_key\fP \- define a keycode +\fB\%define_key\fP \- +define a \fIcurses\fR keycode .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint define_key(const char *\fIdefinition\fB, int \fIkeycode\fB);\fR +.nf +\fB#include <curses.h> +.PP +\fBint define_key(const char *\fIdefinition\fP, int \fIkeycode\fP); +.fi .SH DESCRIPTION -This is an extension to the curses library. +This is an extension to the \fIcurses\fP library. It permits an application to define keycodes with their corresponding control -strings, so that the ncurses library will interpret them just as it would +strings, +so that the \fI\%ncurses\fP library will interpret them just as it would the predefined codes in the terminfo database. .PP -If the given string is null, any existing definition for the keycode is -removed. +If \fIdefinition\fP is \fBNULL\fP, +any existing one for the keycode is removed. Similarly, if the given keycode is negative or zero, any existing string for the given definition is removed. .SH RETURN VALUE -The keycode must be greater than zero, and the string non-null, +Either \fIkeycode\fP must be greater than zero, +or \fIdefinition\fP must be non-\fBNULL\fP, otherwise \fBERR\fP is returned. \fBERR\fP may also be returned if there is insufficient memory to allocate the data to store the definition. If no error is detected, \fBOK\fP is returned. .SH PORTABILITY -These routines are specific to ncurses. +These routines are specific to \fI\%ncurses\fP. They were not supported on Version 7, BSD or System V implementations. It is recommended that -any code depending on them be conditioned using NCURSES_VERSION. +any code depending on them be conditioned using \fB\%NCURSES_VERSION\fP. +.SH AUTHORS +Thomas Dickey .SH SEE ALSO -\fBkeyok\fP(3X), -\fBkey_defined\fP(3X). -.SH AUTHOR -Thomas Dickey. +\fB\%keyok\fP(3X), +\fB\%key_defined\fP(3X) diff --git a/upstream/archlinux/man3/des_crypt.3 b/upstream/archlinux/man3/des_crypt.3 index b2c9aabc..066ea035 100644 --- a/upstream/archlinux/man3/des_crypt.3 +++ b/upstream/archlinux/man3/des_crypt.3 @@ -10,7 +10,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH des_crypt 3 2023-10-31 "Linux man-pages 6.06" +.TH des_crypt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME des_crypt, ecb_crypt, cbc_crypt, des_setparity, DES_FAILED \- fast DES encryption diff --git a/upstream/archlinux/man3/dialog.3 b/upstream/archlinux/man3/dialog.3 index c450e791..ef7e87f5 100644 --- a/upstream/archlinux/man3/dialog.3 +++ b/upstream/archlinux/man3/dialog.3 @@ -1,5 +1,5 @@ '\" t -.\" $Id: dialog.3,v 1.147 2024/01/01 11:32:49 tom Exp $ +.\" $Id: dialog.3,v 1.148 2024/03/06 09:13:53 tom Exp $ .\" Copyright 2005-2023,2024 Thomas E. Dickey .\" .\" This program is free software; you can redistribute it and/or modify @@ -140,7 +140,7 @@ are used for convenience in building the library or main program. These include definitions based on the generated \fI<dlg_config.h>\fP header. . .\" ************************************************************************ -.SH DATA STRUCTURES +.SH "DATA STRUCTURES" All of the global data for the \fB\*l\fP library is stored in a few structures: \fIDIALOG_STATE\fP, \fIDIALOG_VARS\fP and \fIDIALOG_COLORS\fP. @@ -1534,7 +1534,7 @@ is the desired width of the box. If zero, the height is based on the screen size. . .\" ************************************************************************ -.SH UTILITY FUNCTIONS +.SH "UTILITY FUNCTIONS" Most functions that implement lower-level functionality for the command-line \fB\*p\fP program or widgets, have names beginning "\fIdlg_\fP". diff --git a/upstream/archlinux/man3/difftime.3 b/upstream/archlinux/man3/difftime.3 index 77aec052..f5ec1952 100644 --- a/upstream/archlinux/man3/difftime.3 +++ b/upstream/archlinux/man3/difftime.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 19:48:17 1993 by Rik Faith (faith@cs.unc.edu) -.TH difftime 3 2023-11-11 "Linux man-pages 6.06" +.TH difftime 3 2024-05-02 "Linux man-pages 6.8" .SH NAME difftime \- calculate time difference .SH LIBRARY diff --git a/upstream/archlinux/man3/dirfd.3 b/upstream/archlinux/man3/dirfd.3 index 83450bfe..89a1d279 100644 --- a/upstream/archlinux/man3/dirfd.3 +++ b/upstream/archlinux/man3/dirfd.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH dirfd 3 2023-10-31 "Linux man-pages 6.06" +.TH dirfd 3 2024-05-02 "Linux man-pages 6.8" .SH NAME dirfd \- get directory stream file descriptor .SH LIBRARY diff --git a/upstream/archlinux/man3/div.3 b/upstream/archlinux/man3/div.3 index 2428cb3f..75bdd1fd 100644 --- a/upstream/archlinux/man3/div.3 +++ b/upstream/archlinux/man3/div.3 @@ -12,7 +12,7 @@ .\" Modified 1993-07-24, Rik Faith (faith@cs.unc.edu) .\" Modified 2002-08-10, 2003-11-01 Walter Harms, aeb .\" -.TH div 3 2023-10-31 "Linux man-pages 6.06" +.TH div 3 2024-05-02 "Linux man-pages 6.8" .SH NAME div, ldiv, lldiv, imaxdiv \- compute quotient and remainder of an integer division diff --git a/upstream/archlinux/man3/dl_iterate_phdr.3 b/upstream/archlinux/man3/dl_iterate_phdr.3 index f45c3682..be359a52 100644 --- a/upstream/archlinux/man3/dl_iterate_phdr.3 +++ b/upstream/archlinux/man3/dl_iterate_phdr.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH dl_iterate_phdr 3 2023-10-31 "Linux man-pages 6.06" +.TH dl_iterate_phdr 3 2024-05-02 "Linux man-pages 6.8" .SH NAME dl_iterate_phdr \- walk through list of shared objects .SH LIBRARY diff --git a/upstream/archlinux/man3/dladdr.3 b/upstream/archlinux/man3/dladdr.3 index 2b0a49dc..03999cd0 100644 --- a/upstream/archlinux/man3/dladdr.3 +++ b/upstream/archlinux/man3/dladdr.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH dladdr 3 2023-10-31 "Linux man-pages 6.06" +.TH dladdr 3 2024-05-02 "Linux man-pages 6.8" .SH NAME dladdr, dladdr1 \- translate address to symbolic information .SH LIBRARY diff --git a/upstream/archlinux/man3/dlerror.3 b/upstream/archlinux/man3/dlerror.3 index 1c44425e..b457a096 100644 --- a/upstream/archlinux/man3/dlerror.3 +++ b/upstream/archlinux/man3/dlerror.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH dlerror 3 2023-10-31 "Linux man-pages 6.06" +.TH dlerror 3 2024-05-02 "Linux man-pages 6.8" .SH NAME dlerror \- obtain error diagnostic for functions in the dlopen API .SH LIBRARY diff --git a/upstream/archlinux/man3/dlinfo.3 b/upstream/archlinux/man3/dlinfo.3 index d5f62d38..49ca4ebb 100644 --- a/upstream/archlinux/man3/dlinfo.3 +++ b/upstream/archlinux/man3/dlinfo.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH dlinfo 3 2023-10-31 "Linux man-pages 6.06" +.TH dlinfo 3 2024-05-02 "Linux man-pages 6.8" .SH NAME dlinfo \- obtain information about a dynamically loaded object .SH LIBRARY diff --git a/upstream/archlinux/man3/dlopen.3 b/upstream/archlinux/man3/dlopen.3 index 25496c95..acfdec41 100644 --- a/upstream/archlinux/man3/dlopen.3 +++ b/upstream/archlinux/man3/dlopen.3 @@ -14,7 +14,7 @@ .\" Modified by Walter Harms: dladdr, dlvsym .\" Modified by Petr Baudis <pasky@suse.cz>, 2008-12-04: dladdr caveat .\" -.TH dlopen 3 2023-10-31 "Linux man-pages 6.06" +.TH dlopen 3 2024-05-02 "Linux man-pages 6.8" .SH NAME dlclose, dlopen, dlmopen \- open and close a shared object diff --git a/upstream/archlinux/man3/dlsym.3 b/upstream/archlinux/man3/dlsym.3 index 0cf45c69..6fbc0704 100644 --- a/upstream/archlinux/man3/dlsym.3 +++ b/upstream/archlinux/man3/dlsym.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH dlsym 3 2023-10-31 "Linux man-pages 6.06" +.TH dlsym 3 2024-05-02 "Linux man-pages 6.8" .SH NAME dlsym, dlvsym \- obtain address of a symbol in a shared object or executable .SH LIBRARY diff --git a/upstream/archlinux/man3/drand48.3 b/upstream/archlinux/man3/drand48.3 index a27305e8..226b4e32 100644 --- a/upstream/archlinux/man3/drand48.3 +++ b/upstream/archlinux/man3/drand48.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 19:46:03 1993 by Rik Faith (faith@cs.unc.edu) -.TH drand48 3 2023-10-31 "Linux man-pages 6.06" +.TH drand48 3 2024-05-02 "Linux man-pages 6.8" .SH NAME drand48, erand48, lrand48, nrand48, mrand48, jrand48, srand48, seed48, lcong48 \- generate uniformly distributed pseudo-random numbers diff --git a/upstream/archlinux/man3/drand48_r.3 b/upstream/archlinux/man3/drand48_r.3 index 361592be..7b49707b 100644 --- a/upstream/archlinux/man3/drand48_r.3 +++ b/upstream/archlinux/man3/drand48_r.3 @@ -5,7 +5,7 @@ .\" .\" Created 2004-10-31. Text taken from a page by Walter Harms, 2003-09-08 .\" -.TH drand48_r 3 2023-10-31 "Linux man-pages 6.06" +.TH drand48_r 3 2024-05-02 "Linux man-pages 6.8" .SH NAME drand48_r, erand48_r, lrand48_r, nrand48_r, mrand48_r, jrand48_r, srand48_r, seed48_r, lcong48_r diff --git a/upstream/archlinux/man3/duplocale.3 b/upstream/archlinux/man3/duplocale.3 index 8d8a5745..ec0aae9a 100644 --- a/upstream/archlinux/man3/duplocale.3 +++ b/upstream/archlinux/man3/duplocale.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH duplocale 3 2023-10-31 "Linux man-pages 6.06" +.TH duplocale 3 2024-05-02 "Linux man-pages 6.8" .SH NAME duplocale \- duplicate a locale object .SH LIBRARY diff --git a/upstream/archlinux/man3/dysize.3 b/upstream/archlinux/man3/dysize.3 index 24eb9340..7fb93de7 100644 --- a/upstream/archlinux/man3/dysize.3 +++ b/upstream/archlinux/man3/dysize.3 @@ -4,7 +4,7 @@ .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" aeb: some corrections -.TH dysize 3 2023-10-31 "Linux man-pages 6.06" +.TH dysize 3 2024-05-02 "Linux man-pages 6.8" .SH NAME dysize \- get number of days for a given year .SH LIBRARY diff --git a/upstream/archlinux/man3/ecvt.3 b/upstream/archlinux/man3/ecvt.3 index 7900ed28..bf6c4370 100644 --- a/upstream/archlinux/man3/ecvt.3 +++ b/upstream/archlinux/man3/ecvt.3 @@ -10,7 +10,7 @@ .\" Modified Sat Jul 24 19:40:39 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Fri Jun 25 12:10:47 1999 by Andries Brouwer (aeb@cwi.nl) .\" -.TH ecvt 3 2023-10-31 "Linux man-pages 6.06" +.TH ecvt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ecvt, fcvt \- convert a floating-point number to a string .SH LIBRARY diff --git a/upstream/archlinux/man3/ecvt_r.3 b/upstream/archlinux/man3/ecvt_r.3 index 888c9612..360aafa6 100644 --- a/upstream/archlinux/man3/ecvt_r.3 +++ b/upstream/archlinux/man3/ecvt_r.3 @@ -8,7 +8,7 @@ .\" .\" Corrected return types; from Fabian; 2004-10-05 .\" -.TH ecvt_r 3 2023-10-31 "Linux man-pages 6.06" +.TH ecvt_r 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ecvt_r, fcvt_r, qecvt_r, qfcvt_r \- convert a floating-point number to a string .SH LIBRARY diff --git a/upstream/archlinux/man3/encrypt.3 b/upstream/archlinux/man3/encrypt.3 index 33342c7a..b60f6a15 100644 --- a/upstream/archlinux/man3/encrypt.3 +++ b/upstream/archlinux/man3/encrypt.3 @@ -9,7 +9,7 @@ .\" .\" Modified 2003-04-04, aeb .\" -.TH encrypt 3 2023-10-31 "Linux man-pages 6.06" +.TH encrypt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME encrypt, setkey, encrypt_r, setkey_r \- encrypt 64-bit messages .SH LIBRARY @@ -155,7 +155,7 @@ See .SS Features in glibc In glibc 2.2, these functions use the DES algorithm. .SH EXAMPLES -.\" [[deprecated]] SRC BEGIN (encrypt.c) +.\" SRC BEGIN (encrypt.c) .EX #define _XOPEN_SOURCE #include <crypt.h> diff --git a/upstream/archlinux/man3/end.3 b/upstream/archlinux/man3/end.3 index 26488457..878b0a54 100644 --- a/upstream/archlinux/man3/end.3 +++ b/upstream/archlinux/man3/end.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH end 3 2023-10-31 "Linux man-pages 6.06" +.TH end 3 2024-05-02 "Linux man-pages 6.8" .SH NAME etext, edata, end \- end of program segments .SH SYNOPSIS diff --git a/upstream/archlinux/man3/endian.3 b/upstream/archlinux/man3/endian.3 index 82ccd73b..e84ed353 100644 --- a/upstream/archlinux/man3/endian.3 +++ b/upstream/archlinux/man3/endian.3 @@ -5,7 +5,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH endian 3 2023-10-31 "Linux man-pages 6.06" +.TH endian 3 2024-05-02 "Linux man-pages 6.8" .SH NAME htobe16, htole16, be16toh, le16toh, htobe32, htole32, be32toh, le32toh, htobe64, htole64, be64toh, le64toh \- diff --git a/upstream/archlinux/man3/envz_add.3 b/upstream/archlinux/man3/envz_add.3 index 4d892578..e37802dc 100644 --- a/upstream/archlinux/man3/envz_add.3 +++ b/upstream/archlinux/man3/envz_add.3 @@ -6,7 +6,7 @@ .\" based on the description in glibc source and infopages .\" .\" Corrections and additions, aeb -.TH envz_add 3 2023-10-31 "Linux man-pages 6.06" +.TH envz_add 3 2024-05-02 "Linux man-pages 6.8" .SH NAME envz_add, envz_entry, envz_get, envz_merge, envz_remove, envz_strip \- environment string support diff --git a/upstream/archlinux/man3/erf.3 b/upstream/archlinux/man3/erf.3 index 7672524a..46578fa1 100644 --- a/upstream/archlinux/man3/erf.3 +++ b/upstream/archlinux/man3/erf.3 @@ -13,7 +13,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH erf 3 2023-10-31 "Linux man-pages 6.06" +.TH erf 3 2024-05-02 "Linux man-pages 6.8" .SH NAME erf, erff, erfl \- error function .SH LIBRARY diff --git a/upstream/archlinux/man3/erfc.3 b/upstream/archlinux/man3/erfc.3 index 72e5d28b..52f03b46 100644 --- a/upstream/archlinux/man3/erfc.3 +++ b/upstream/archlinux/man3/erfc.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH erfc 3 2023-10-31 "Linux man-pages 6.06" +.TH erfc 3 2024-05-02 "Linux man-pages 6.8" .SH NAME erfc, erfcf, erfcl \- complementary error function .SH LIBRARY diff --git a/upstream/archlinux/man3/err.3 b/upstream/archlinux/man3/err.3 index f52c69ad..ef1ae408 100644 --- a/upstream/archlinux/man3/err.3 +++ b/upstream/archlinux/man3/err.3 @@ -9,7 +9,7 @@ .\" .\" 2011-09-10, mtk, Converted from mdoc to man macros .\" -.TH err 3 2023-10-31 "Linux man-pages 6.06" +.TH err 3 2024-05-02 "Linux man-pages 6.8" .SH NAME err, verr, errx, verrx, warn, vwarn, warnx, vwarnx \- formatted error messages .SH LIBRARY diff --git a/upstream/archlinux/man3/errno.3 b/upstream/archlinux/man3/errno.3 index b8171a71..df0e039d 100644 --- a/upstream/archlinux/man3/errno.3 +++ b/upstream/archlinux/man3/errno.3 @@ -9,7 +9,7 @@ .\" 2006-02-09 Kurt Wall, mtk .\" Added non-POSIX errors .\" -.TH errno 3 2023-10-31 "Linux man-pages 6.06" +.TH errno 3 2024-05-02 "Linux man-pages 6.8" .SH NAME errno \- number of last error .SH LIBRARY diff --git a/upstream/archlinux/man3/error.3 b/upstream/archlinux/man3/error.3 index 34d8c016..9c28b67a 100644 --- a/upstream/archlinux/man3/error.3 +++ b/upstream/archlinux/man3/error.3 @@ -25,7 +25,7 @@ .\" .\" References: .\" glibc manual and source -.TH error 3 2023-10-31 "Linux man-pages 6.06" +.TH error 3 2024-05-02 "Linux man-pages 6.8" .SH NAME error, error_at_line, error_message_count, error_one_per_line, error_print_progname \- glibc error reporting functions diff --git a/upstream/archlinux/man3/ether_aton.3 b/upstream/archlinux/man3/ether_aton.3 index ead04f39..ca576395 100644 --- a/upstream/archlinux/man3/ether_aton.3 +++ b/upstream/archlinux/man3/ether_aton.3 @@ -9,7 +9,7 @@ .\" .\" Minor additions, aeb, 2013-06-21 .\" -.TH ether_aton 3 2023-10-31 "Linux man-pages 6.06" +.TH ether_aton 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ether_aton, ether_ntoa, ether_ntohost, ether_hostton, ether_line, ether_ntoa_r, ether_aton_r \- Ethernet address manipulation routines diff --git a/upstream/archlinux/man3/euidaccess.3 b/upstream/archlinux/man3/euidaccess.3 index f9aa13ce..43914f4e 100644 --- a/upstream/archlinux/man3/euidaccess.3 +++ b/upstream/archlinux/man3/euidaccess.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH euidaccess 3 2023-10-31 "Linux man-pages 6.06" +.TH euidaccess 3 2024-05-02 "Linux man-pages 6.8" .SH NAME euidaccess, eaccess \- check effective user's permissions for a file .SH LIBRARY diff --git a/upstream/archlinux/man3/exec.3 b/upstream/archlinux/man3/exec.3 index 41256723..c672b591 100644 --- a/upstream/archlinux/man3/exec.3 +++ b/upstream/archlinux/man3/exec.3 @@ -11,7 +11,7 @@ .\" Modified, 24 Jun 2004, Michael Kerrisk <mtk.manpages@gmail.com> .\" Added note on casting NULL .\" -.TH exec 3 2023-10-31 "Linux man-pages 6.06" +.TH exec 3 2024-05-02 "Linux man-pages 6.8" .SH NAME execl, execlp, execle, execv, execvp, execvpe \- execute a file .SH LIBRARY diff --git a/upstream/archlinux/man3/exit.3 b/upstream/archlinux/man3/exit.3 index abde10d1..91a36909 100644 --- a/upstream/archlinux/man3/exit.3 +++ b/upstream/archlinux/man3/exit.3 @@ -7,7 +7,7 @@ .\" could be listed on this page. See, for example, the list in the .\" POSIX exit(3p) page. .\" -.TH exit 3 2023-10-31 "Linux man-pages 6.06" +.TH exit 3 2024-05-02 "Linux man-pages 6.8" .SH NAME exit \- cause normal process termination .SH LIBRARY diff --git a/upstream/archlinux/man3/exp.3 b/upstream/archlinux/man3/exp.3 index 80f842c3..0b133765 100644 --- a/upstream/archlinux/man3/exp.3 +++ b/upstream/archlinux/man3/exp.3 @@ -14,7 +14,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH exp 3 2023-10-31 "Linux man-pages 6.06" +.TH exp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME exp, expf, expl \- base-e exponential function .SH LIBRARY diff --git a/upstream/archlinux/man3/exp10.3 b/upstream/archlinux/man3/exp10.3 index d20aa3be..40801490 100644 --- a/upstream/archlinux/man3/exp10.3 +++ b/upstream/archlinux/man3/exp10.3 @@ -13,7 +13,7 @@ .\" Modified 1995-08-14 by Arnt Gulbrandsen <agulbra@troll.no> .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) -.TH exp10 3 2023-10-31 "Linux man-pages 6.06" +.TH exp10 3 2024-05-02 "Linux man-pages 6.8" .SH NAME exp10, exp10f, exp10l \- base-10 exponential function .SH LIBRARY diff --git a/upstream/archlinux/man3/exp2.3 b/upstream/archlinux/man3/exp2.3 index f42f2c75..52c8925e 100644 --- a/upstream/archlinux/man3/exp2.3 +++ b/upstream/archlinux/man3/exp2.3 @@ -14,7 +14,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH exp2 3 2023-10-31 "Linux man-pages 6.06" +.TH exp2 3 2024-05-02 "Linux man-pages 6.8" .SH NAME exp2, exp2f, exp2l \- base-2 exponential function .SH LIBRARY diff --git a/upstream/archlinux/man3/expm1.3 b/upstream/archlinux/man3/expm1.3 index 1d50e645..97f285da 100644 --- a/upstream/archlinux/man3/expm1.3 +++ b/upstream/archlinux/man3/expm1.3 @@ -8,7 +8,7 @@ .\" Modified 2002-07-27 Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH expm1 3 2023-10-31 "Linux man-pages 6.06" +.TH expm1 3 2024-05-02 "Linux man-pages 6.8" .SH NAME expm1, expm1f, expm1l \- exponential minus 1 .SH LIBRARY diff --git a/upstream/archlinux/man3/fabs.3 b/upstream/archlinux/man3/fabs.3 index 04132a74..a46bea14 100644 --- a/upstream/archlinux/man3/fabs.3 +++ b/upstream/archlinux/man3/fabs.3 @@ -10,7 +10,7 @@ .\" Modified Sat Jul 24 19:42:04 1993 by Rik Faith (faith@cs.unc.edu) .\" Added fabsl, fabsf, aeb, 2001-06-07 .\" -.TH fabs 3 2023-10-31 "Linux man-pages 6.06" +.TH fabs 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fabs, fabsf, fabsl \- absolute value of floating-point number .SH LIBRARY diff --git a/upstream/archlinux/man3/fclose.3 b/upstream/archlinux/man3/fclose.3 index befd9040..7c9636ea 100644 --- a/upstream/archlinux/man3/fclose.3 +++ b/upstream/archlinux/man3/fclose.3 @@ -14,7 +14,7 @@ .\" .\" Modified 2000-07-22 by Nicolás Lichtmaier <nick@debian.org> .\" -.TH fclose 3 2023-10-31 "Linux man-pages 6.06" +.TH fclose 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fclose \- close a stream .SH LIBRARY diff --git a/upstream/archlinux/man3/fcloseall.3 b/upstream/archlinux/man3/fcloseall.3 index 71ae9807..a17698f5 100644 --- a/upstream/archlinux/man3/fcloseall.3 +++ b/upstream/archlinux/man3/fcloseall.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH fcloseall 3 2023-10-31 "Linux man-pages 6.06" +.TH fcloseall 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fcloseall \- close all open streams .SH LIBRARY diff --git a/upstream/archlinux/man3/fdim.3 b/upstream/archlinux/man3/fdim.3 index e550acbe..d7ae9dbf 100644 --- a/upstream/archlinux/man3/fdim.3 +++ b/upstream/archlinux/man3/fdim.3 @@ -5,7 +5,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH fdim 3 2023-10-31 "Linux man-pages 6.06" +.TH fdim 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fdim, fdimf, fdiml \- positive difference .SH LIBRARY diff --git a/upstream/archlinux/man3/fenv.3 b/upstream/archlinux/man3/fenv.3 index b867cbf2..ad7759ff 100644 --- a/upstream/archlinux/man3/fenv.3 +++ b/upstream/archlinux/man3/fenv.3 @@ -6,7 +6,7 @@ .\" 2000-08-14 added GNU additions from Andreas Jaeger .\" 2000-12-05 some changes inspired by acahalan's remarks .\" -.TH fenv 3 2023-10-31 "Linux man-pages 6.06" +.TH fenv 3 2024-05-02 "Linux man-pages 6.8" .SH NAME feclearexcept, fegetexceptflag, feraiseexcept, fesetexceptflag, fetestexcept, fegetenv, fegetround, feholdexcept, fesetround, diff --git a/upstream/archlinux/man3/ferror.3 b/upstream/archlinux/man3/ferror.3 index ec339507..329b9d33 100644 --- a/upstream/archlinux/man3/ferror.3 +++ b/upstream/archlinux/man3/ferror.3 @@ -14,7 +14,7 @@ .\" .\" Converted for Linux, Mon Nov 29 14:24:40 1993, faith@cs.unc.edu .\" -.TH ferror 3 2023-10-31 "Linux man-pages 6.06" +.TH ferror 3 2024-05-02 "Linux man-pages 6.8" .SH NAME clearerr, feof, ferror \- check and reset stream status .SH LIBRARY diff --git a/upstream/archlinux/man3/fexecve.3 b/upstream/archlinux/man3/fexecve.3 index e3dcb4ef..9a3c12ca 100644 --- a/upstream/archlinux/man3/fexecve.3 +++ b/upstream/archlinux/man3/fexecve.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH fexecve 3 2023-10-31 "Linux man-pages 6.06" +.TH fexecve 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fexecve \- execute program specified via file descriptor .SH LIBRARY diff --git a/upstream/archlinux/man3/fflush.3 b/upstream/archlinux/man3/fflush.3 index b634dbb8..2205b176 100644 --- a/upstream/archlinux/man3/fflush.3 +++ b/upstream/archlinux/man3/fflush.3 @@ -15,7 +15,7 @@ .\" Modified 2000-07-22 by Nicolás Lichtmaier <nick@debian.org> .\" Modified 2001-10-16 by John Levon <moz@compsoc.man.ac.uk> .\" -.TH fflush 3 2023-10-31 "Linux man-pages 6.06" +.TH fflush 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fflush \- flush a stream .SH LIBRARY diff --git a/upstream/archlinux/man3/ffs.3 b/upstream/archlinux/man3/ffs.3 index 86dd7385..43b1d641 100644 --- a/upstream/archlinux/man3/ffs.3 +++ b/upstream/archlinux/man3/ffs.3 @@ -11,7 +11,7 @@ .\" .\" Modified 2003 Walter Harms (walter.harms@informatik.uni-oldenburg.de) .\" -.TH ffs 3 2023-11-19 "Linux man-pages 6.06" +.TH ffs 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ffs, ffsl, ffsll \- find first bit set in a word .SH LIBRARY diff --git a/upstream/archlinux/man3/fgetc.3 b/upstream/archlinux/man3/fgetc.3 index 003befc8..c111664c 100644 --- a/upstream/archlinux/man3/fgetc.3 +++ b/upstream/archlinux/man3/fgetc.3 @@ -5,7 +5,7 @@ .\" .\" Modified Wed Jul 28 11:12:07 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Fri Sep 8 15:48:13 1995 by Andries Brouwer (aeb@cwi.nl) -.TH fgetc 3 2023-10-31 "Linux man-pages 6.06" +.TH fgetc 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fgetc, fgets, getc, getchar, ungetc \- input of characters and strings .SH LIBRARY diff --git a/upstream/archlinux/man3/fgetgrent.3 b/upstream/archlinux/man3/fgetgrent.3 index 239ad7df..9370762d 100644 --- a/upstream/archlinux/man3/fgetgrent.3 +++ b/upstream/archlinux/man3/fgetgrent.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 19:38:44 1993 by Rik Faith (faith@cs.unc.edu) -.TH fgetgrent 3 2023-10-31 "Linux man-pages 6.06" +.TH fgetgrent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fgetgrent \- get group file entry .SH LIBRARY diff --git a/upstream/archlinux/man3/fgetpwent.3 b/upstream/archlinux/man3/fgetpwent.3 index 546e60b8..d193e436 100644 --- a/upstream/archlinux/man3/fgetpwent.3 +++ b/upstream/archlinux/man3/fgetpwent.3 @@ -11,7 +11,7 @@ .\" Modified Sat Jul 24 19:37:37 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Mon May 27 22:40:48 1996 by Martin Schulze (joey@linux.de) .\" -.TH fgetpwent 3 2023-10-31 "Linux man-pages 6.06" +.TH fgetpwent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fgetpwent \- get password file entry .SH LIBRARY diff --git a/upstream/archlinux/man3/fgetwc.3 b/upstream/archlinux/man3/fgetwc.3 index 575948e4..7a6d7c2d 100644 --- a/upstream/archlinux/man3/fgetwc.3 +++ b/upstream/archlinux/man3/fgetwc.3 @@ -11,7 +11,7 @@ .\" ISO/IEC 9899:1999 .\" .\" Modified Tue Oct 16 23:18:40 BST 2001 by John Levon <moz@compsoc.man.ac.uk> -.TH fgetwc 3 2023-10-31 "Linux man-pages 6.06" +.TH fgetwc 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fgetwc, getwc \- read a wide character from a FILE stream .SH LIBRARY diff --git a/upstream/archlinux/man3/fgetws.3 b/upstream/archlinux/man3/fgetws.3 index 537a834c..256e75f8 100644 --- a/upstream/archlinux/man3/fgetws.3 +++ b/upstream/archlinux/man3/fgetws.3 @@ -11,7 +11,7 @@ .\" ISO/IEC 9899:1999 .\" .\" Modified Tue Oct 16 23:18:40 BST 2001 by John Levon <moz@compsoc.man.ac.uk> -.TH fgetws 3 2023-10-31 "Linux man-pages 6.06" +.TH fgetws 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fgetws \- read a wide-character string from a FILE stream .SH LIBRARY diff --git a/upstream/archlinux/man3/fileno.3 b/upstream/archlinux/man3/fileno.3 index f749e326..0926f4b6 100644 --- a/upstream/archlinux/man3/fileno.3 +++ b/upstream/archlinux/man3/fileno.3 @@ -12,7 +12,7 @@ .\" Converted for Linux, Mon Nov 29 14:24:40 1993, faith@cs.unc.edu .\" Added remark on EBADF for fileno, aeb, 2001-03-22 .\" -.TH fileno 3 2023-10-31 "Linux man-pages 6.06" +.TH fileno 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fileno \- obtain file descriptor of a stdio stream .SH LIBRARY diff --git a/upstream/archlinux/man3/finite.3 b/upstream/archlinux/man3/finite.3 index f448a8d6..5ec0a2c3 100644 --- a/upstream/archlinux/man3/finite.3 +++ b/upstream/archlinux/man3/finite.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH finite 3 2023-10-31 "Linux man-pages 6.06" +.TH finite 3 2024-05-02 "Linux man-pages 6.8" .SH NAME finite, finitef, finitel, isinf, isinff, isinfl, isnan, isnanf, isnanl \- BSD floating-point classification functions diff --git a/upstream/archlinux/man3/flockfile.3 b/upstream/archlinux/man3/flockfile.3 index d1b5670b..6f734ead 100644 --- a/upstream/archlinux/man3/flockfile.3 +++ b/upstream/archlinux/man3/flockfile.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH flockfile 3 2023-10-31 "Linux man-pages 6.06" +.TH flockfile 3 2024-05-02 "Linux man-pages 6.8" .SH NAME flockfile, ftrylockfile, funlockfile \- lock FILE for stdio .SH LIBRARY diff --git a/upstream/archlinux/man3/floor.3 b/upstream/archlinux/man3/floor.3 index 7246d9d6..fd4b364f 100644 --- a/upstream/archlinux/man3/floor.3 +++ b/upstream/archlinux/man3/floor.3 @@ -5,7 +5,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH floor 3 2023-10-31 "Linux man-pages 6.06" +.TH floor 3 2024-05-02 "Linux man-pages 6.8" .SH NAME floor, floorf, floorl \- largest integral value not greater than argument .SH LIBRARY diff --git a/upstream/archlinux/man3/fma.3 b/upstream/archlinux/man3/fma.3 index a8497ee0..8b9fd105 100644 --- a/upstream/archlinux/man3/fma.3 +++ b/upstream/archlinux/man3/fma.3 @@ -8,7 +8,7 @@ .\" Modified 2004-11-15, Added further text on FLT_ROUNDS .\" as suggested by AEB and Fabian Kreutz .\" -.TH fma 3 2023-10-31 "Linux man-pages 6.06" +.TH fma 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fma, fmaf, fmal \- floating-point multiply and add .SH LIBRARY diff --git a/upstream/archlinux/man3/fmax.3 b/upstream/archlinux/man3/fmax.3 index 1b5ac673..6d2acc90 100644 --- a/upstream/archlinux/man3/fmax.3 +++ b/upstream/archlinux/man3/fmax.3 @@ -5,7 +5,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH fmax 3 2023-10-31 "Linux man-pages 6.06" +.TH fmax 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fmax, fmaxf, fmaxl \- determine maximum of two floating-point numbers .SH LIBRARY diff --git a/upstream/archlinux/man3/fmemopen.3 b/upstream/archlinux/man3/fmemopen.3 index 2bf1a0c1..e0c7f8b1 100644 --- a/upstream/archlinux/man3/fmemopen.3 +++ b/upstream/archlinux/man3/fmemopen.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH fmemopen 3 2023-10-31 "Linux man-pages 6.06" +.TH fmemopen 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fmemopen \- open memory as stream .SH LIBRARY diff --git a/upstream/archlinux/man3/fmin.3 b/upstream/archlinux/man3/fmin.3 index 3722a398..b298d1cf 100644 --- a/upstream/archlinux/man3/fmin.3 +++ b/upstream/archlinux/man3/fmin.3 @@ -5,7 +5,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH fmin 3 2023-10-31 "Linux man-pages 6.06" +.TH fmin 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fmin, fminf, fminl \- determine minimum of two floating-point numbers .SH LIBRARY diff --git a/upstream/archlinux/man3/fmod.3 b/upstream/archlinux/man3/fmod.3 index cdcdee11..d6e3edad 100644 --- a/upstream/archlinux/man3/fmod.3 +++ b/upstream/archlinux/man3/fmod.3 @@ -13,7 +13,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH fmod 3 2023-10-31 "Linux man-pages 6.06" +.TH fmod 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fmod, fmodf, fmodl \- floating-point remainder function .SH LIBRARY diff --git a/upstream/archlinux/man3/fmtmsg.3 b/upstream/archlinux/man3/fmtmsg.3 index cc8e994f..b0f50f58 100644 --- a/upstream/archlinux/man3/fmtmsg.3 +++ b/upstream/archlinux/man3/fmtmsg.3 @@ -9,7 +9,7 @@ .\" The function is quite complex and deserves an example .\" .\" Polished, aeb, 2003-11-01 -.TH fmtmsg 3 2023-10-31 "Linux man-pages 6.06" +.TH fmtmsg 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fmtmsg \- print formatted error messages .SH LIBRARY diff --git a/upstream/archlinux/man3/fnmatch.3 b/upstream/archlinux/man3/fnmatch.3 index b6b9ca68..7e09383b 100644 --- a/upstream/archlinux/man3/fnmatch.3 +++ b/upstream/archlinux/man3/fnmatch.3 @@ -6,7 +6,7 @@ .\" Modified Sat Jul 24 19:35:54 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Mon Oct 16 00:16:29 2000 following Joseph S. Myers .\" -.TH fnmatch 3 2023-10-31 "Linux man-pages 6.06" +.TH fnmatch 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fnmatch \- match filename or pathname .SH LIBRARY diff --git a/upstream/archlinux/man3/fopen.3 b/upstream/archlinux/man3/fopen.3 index 1b06259c..0340b6a2 100644 --- a/upstream/archlinux/man3/fopen.3 +++ b/upstream/archlinux/man3/fopen.3 @@ -14,7 +14,7 @@ .\" Modified, aeb, 960421, 970806 .\" Modified, joey, aeb, 2002-01-03 .\" -.TH fopen 3 2023-10-31 "Linux man-pages 6.06" +.TH fopen 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fopen, fdopen, freopen \- stream open functions .SH LIBRARY diff --git a/upstream/archlinux/man3/fopencookie.3 b/upstream/archlinux/man3/fopencookie.3 index 366b822e..c3862a3f 100644 --- a/upstream/archlinux/man3/fopencookie.3 +++ b/upstream/archlinux/man3/fopencookie.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH fopencookie 3 2023-12-29 "Linux man-pages 6.06" +.TH fopencookie 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fopencookie \- open a custom stream .SH LIBRARY diff --git a/upstream/archlinux/man3/form.3x b/upstream/archlinux/man3/form.3x index 85da7443..e847689f 100644 --- a/upstream/archlinux/man3/form.3x +++ b/upstream/archlinux/man3/form.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2020,2021 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,21 +28,30 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form.3x,v 1.38 2021/12/25 21:49:32 tom Exp $ -.TH form 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: form.3x,v 1.54 2024/03/16 15:35:01 tom Exp $ +.TH form 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBform\fP \- curses extension for programming forms +\fBform\fP \- +curses extension for programming forms .SH SYNOPSIS -\fB#include <form.h>\fP -.br +.nf +\fB#include <form.h> +.fi .SH DESCRIPTION The \fBform\fP library provides terminal-independent facilities for composing form screens on character-cell terminals. @@ -64,7 +73,7 @@ so that input/output processing will work. A curses initialization routine such as \fBinitscr\fP must be called before using any of these functions. . -.SS Current Default Values for Field Attributes +.SS "Current Default Values for Field Attributes" . The \fBform\fP library maintains a default value for field attributes. You @@ -75,13 +84,13 @@ Changing this default with a \fBset_\fP function affects future field creations, but does not change the rendering of fields already created. . -.SS Routine Name Index +.SS "Routine Name Index" . The following table lists each \fBform\fP routine and the name of the manual page on which it is described. Routines flagged with \*(``*\*('' -are ncurses-specific, not present in SVr4. -. +are \fI\%ncurses\fP-specific, not present in SVr4. +.PP .TS l l l l . @@ -206,39 +215,32 @@ System error occurred (see \fBerrno\fP(3)). .B E_UNKNOWN_COMMAND The form driver code saw an unknown request code. .SH NOTES -The header file \fB<form.h>\fP automatically includes the header files -\fB<curses.h>\fP and \fB<eti.h>\fP. -.PP -In your library list, libform.a should be before libncurses.a; that is, -you want to say \*(``\-lform \-lncurses\*('', not the other way around -(which would give you a link error when using static libraries). +The header file \fI\%form.h\fP itself includes \fI\%curses.h\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions. .PP -The menu facility was documented in SVr4.2 in -\fICharacter User Interface Programming (UNIX SVR4.2)\fP. +A form facility was documented in SVr4.2's +\fICharacter User Interface Programming\fP document. .PP It is not part of X/Open Curses. .PP -Aside from ncurses, there are few implementations: +Aside from \fI\%ncurses\fP, there are few implementations: .bP systems based on SVr4 source code, e.g., Solaris. .bP NetBSD curses. .PP -A few functions in this implementation are extensions added for ncurses, +A few functions in this implementation are extensions added for +\fI\%ncurses\fP, but not provided by other implementations, e.g., \fBform_driver_w\fP, \fBunfocus_current_field\fP. .SH AUTHORS Juergen Pfeifer. -Manual pages and adaptation for ncurses by Eric +Manual pages and adaptation for \fI\%ncurses\fP by Eric S. Raymond. .SH SEE ALSO -\fBcurses\fP(3X) and related pages whose names begin \*(``form_\*('' for detailed -descriptions of the entry points. -.PP -This describes \fBncurses\fP -version 6.4 (patch 20230520). +\fBcurses\fP(3X) and related pages whose names begin \*(``form_\*('' for +detailed descriptions of the entry points. diff --git a/upstream/archlinux/man3/form_cursor.3x b/upstream/archlinux/man3/form_cursor.3x index a2af849d..7a317a1d 100644 --- a/upstream/archlinux/man3/form_cursor.3x +++ b/upstream/archlinux/man3/form_cursor.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,15 +28,17 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_cursor.3x,v 1.17 2022/02/12 20:03:40 tom Exp $ -.TH form_cursor 3X "" +.\" $Id: form_cursor.3x,v 1.31 2024/03/16 15:35:01 tom Exp $ +.TH form_cursor 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBpos_form_cursor\fP \- position a form window cursor +\fBpos_form_cursor\fP \- +position a form window cursor .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint pos_form_cursor(FORM *\fIform\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBint pos_form_cursor(FORM *\fIform\fP); +.fi .SH DESCRIPTION The function \fBpos_form_cursor\fP restores the cursor to the position required for the forms driver to continue processing requests. @@ -57,12 +59,6 @@ The form has not been posted. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -. -.SH SEE ALSO -\fBcurses\fP(3X), \fBform\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -70,3 +66,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X) diff --git a/upstream/archlinux/man3/form_data.3x b/upstream/archlinux/man3/form_data.3x index ac7db7cd..bcf940d4 100644 --- a/upstream/archlinux/man3/form_data.3x +++ b/upstream/archlinux/man3/form_data.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,18 +28,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_data.3x,v 1.18 2022/02/12 20:03:40 tom Exp $ -.TH form_data 3X "" +.\" $Id: form_data.3x,v 1.32 2024/03/16 15:35:01 tom Exp $ +.TH form_data 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBdata_ahead\fP, -\fBdata_behind\fP \- test for off-screen data in given forms +\fBdata_behind\fP \- +test for off-screen data in given forms .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBbool data_ahead(const FORM *\fIform\fB);\fR -.br -\fBbool data_behind(const FORM *\fIform\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBbool data_ahead(const FORM *\fIform\fP); +\fBbool data_behind(const FORM *\fIform\fP); +.fi .SH DESCRIPTION The function \fBdata_ahead\fP tests whether there is off-screen data ahead in the given form. @@ -48,11 +49,6 @@ It returns TRUE (1) or FALSE (0). The function \fBdata_behind\fP tests whether there is off-screen data behind in the given form. It returns TRUE (1) or FALSE (0). -.SH SEE ALSO -\fBcurses\fP(3X), \fBform\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -60,3 +56,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X) diff --git a/upstream/archlinux/man3/form_driver.3x b/upstream/archlinux/man3/form_driver.3x index ff3a0137..c8803697 100644 --- a/upstream/archlinux/man3/form_driver.3x +++ b/upstream/archlinux/man3/form_driver.3x @@ -1,5 +1,6 @@ +'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,22 +28,23 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_driver.3x,v 1.39 2022/02/12 20:03:40 tom Exp $ -.TH form_driver 3X "" +.\" $Id: form_driver.3x,v 1.61 2024/04/20 18:55:09 tom Exp $ +.TH form_driver 3X 2024-04-20 "ncurses 6.5" "Library calls" .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME \fBform_driver\fP, -\fBform_driver_w\fP \- command-processing loop of the form system +\fBform_driver_w\fP \- +command-processing loop of the form system .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint form_driver(FORM *\fIform\fB, int \fIc\fB);\fR -.br -\fBint form_driver_w(FORM *\fIform\fB, int \fIc\fB, wchar_t \fIwch\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBint form_driver(FORM *\fIform\fP, int \fIc\fP); +\fBint form_driver_w(FORM *\fIform\fP, int \fIc\fP, wchar_t \fIwc\fP); +.fi .SH DESCRIPTION .SS form_driver Once a form has been posted (displayed), you should funnel input events to it @@ -59,33 +61,32 @@ checked according to the program's locale settings. .bP The input is the KEY_MOUSE special key associated with an mouse event. .SS form_driver_w -.PP This extension simplifies the use of the forms library using wide characters. The input is either a key code (a request) or a wide character returned by \fBget_wch\fP(3X). The type must be passed as well, to enable the library to determine whether the parameter is a wide character or a request. -.SS Form-driver requests -.PP +.SS "Form Driver Requests" The form driver requests are as follows: +.PP .TS -l l -_ _ -l l. -\fBName\fP \fBDescription\fP -REQ_BEG_FIELD Move to the beginning of the field. -REQ_BEG_LINE Move to the beginning of the line. +Lb Lb +Lb Lx. +Name Description +_ +REQ_BEG_FIELD Move to beginning of field. +REQ_BEG_LINE Move to beginning of the line. REQ_CLR_EOF Clear to end of field from cursor. REQ_CLR_EOL Clear to end of line from cursor. REQ_CLR_FIELD Clear the entire field. REQ_DEL_CHAR Delete character at the cursor. REQ_DEL_LINE Delete line at the cursor. REQ_DEL_PREV Delete character before the cursor. -REQ_DEL_WORD Delete blank-delimited word at the cursor. -REQ_DOWN_CHAR Move down in the field. +REQ_DEL_WORD Delete blank-delimited word at cursor. +REQ_DOWN_CHAR Move down in field. REQ_DOWN_FIELD Move down to a field. -REQ_END_FIELD Move to the end of the field. +REQ_END_FIELD Move to the end of field. REQ_END_LINE Move to the end of the line. REQ_FIRST_FIELD Move to the first field. REQ_FIRST_PAGE Move to the first page. @@ -94,7 +95,7 @@ REQ_INS_LINE Insert a blank line at the cursor. REQ_INS_MODE Enter insert mode. REQ_LAST_FIELD Move to the last field. REQ_LAST_PAGE Move to the last field. -REQ_LEFT_CHAR Move left in the field. +REQ_LEFT_CHAR Move left in field. REQ_LEFT_FIELD Move left to a field. REQ_NEW_LINE Insert or overlay a new line. REQ_NEXT_CHAR Move to the next char. @@ -111,25 +112,25 @@ REQ_PREV_FIELD Move to the previous field. REQ_PREV_LINE Move to the previous line. REQ_PREV_PAGE Move to the previous page. REQ_PREV_WORD Move to the previous word. -REQ_RIGHT_CHAR Move right in the field. +REQ_RIGHT_CHAR Move right in field. REQ_RIGHT_FIELD Move right to a field. -REQ_SCR_BCHAR Scroll the field backward a character. -REQ_SCR_BHPAGE Scroll the field backward half a page. -REQ_SCR_BLINE Scroll the field backward a line. -REQ_SCR_BPAGE Scroll the field backward a page. -REQ_SCR_FCHAR Scroll the field forward a character. -REQ_SCR_FHPAGE Scroll the field forward half a page. -REQ_SCR_FLINE Scroll the field forward a line. -REQ_SCR_FPAGE Scroll the field forward a page. -REQ_SCR_HBHALF Horizontal scroll the field backward half a line. -REQ_SCR_HBLINE Horizontal scroll the field backward a line. -REQ_SCR_HFHALF Horizontal scroll the field forward half a line. -REQ_SCR_HFLINE Horizontal scroll the field forward a line. +REQ_SCR_BCHAR Scroll field backward 1 character. +REQ_SCR_BHPAGE Scroll field backward \(12 page. +REQ_SCR_BLINE Scroll field backward 1 line. +REQ_SCR_BPAGE Scroll field backward 1 page. +REQ_SCR_FCHAR Scroll field forward 1 character. +REQ_SCR_FHPAGE Scroll field forward \(12 page. +REQ_SCR_FLINE Scroll field forward 1 line. +REQ_SCR_FPAGE Scroll field forward 1 page. +REQ_SCR_HBHALF Horizontal scroll field backward \(12 line. +REQ_SCR_HBLINE Horizontal scroll field backward 1 line. +REQ_SCR_HFHALF Horizontal scroll field forward \(12 line. +REQ_SCR_HFLINE Horizontal scroll field forward 1 line. REQ_SFIRST_FIELD Move to the sorted first field. REQ_SLAST_FIELD Move to the sorted last field. REQ_SNEXT_FIELD Move to the sorted next field. REQ_SPREV_FIELD Move to the sorted previous field. -REQ_UP_CHAR Move up in the field. +REQ_UP_CHAR Move up in field. REQ_UP_FIELD Move up to a field. REQ_VALIDATION Validate field. .TE @@ -138,7 +139,7 @@ If the second argument is a printable character, the driver places it in the current position in the current field. If it is one of the forms requests listed above, that request is executed. -.SS Field validation +.SS "Field Validation" The form library makes updates to the window associated with form fields rather than directly to the field buffers. .PP @@ -147,7 +148,6 @@ The form driver also provides for validating modified fields to ensure that the contents meet whatever constraints an application may attach using \fBset_field_type\fP. .PP -.PP You can validate a field without making any changes to it using \fBREQ_VALIDATION\fP. The form driver also validates a field in these cases: @@ -166,8 +166,7 @@ In each case, the move fails if the field is invalid. If the modified field is valid, the form driver copies the modified data from the window associated with the field to the field buffer. -.SS Mouse handling -.PP +.SS "Mouse Handling" If the second argument is the KEY_MOUSE special key, the associated mouse event is translated into one of the above pre-defined requests. Currently only clicks in the user window (e.g., inside the form display @@ -214,8 +213,7 @@ into a request was done, \fBform_driver\fP returns the result of this request. If you clicked outside the user window or the mouse event could not be translated into a form request an \fBE_REQUEST_DENIED\fP is returned. -.SS Application-defined commands -.PP +.SS "Application-defined Commands" If the second argument is neither printable nor one of the above pre-defined form requests, the driver assumes it is an application-specific command and returns \fBE_UNKNOWN_COMMAND\fP. Application-defined commands @@ -250,18 +248,6 @@ System error occurred (see \fBerrno\fP(3)). .TP 5 .B E_UNKNOWN_COMMAND The form driver code saw an unknown request code. -. -.SH SEE ALSO -\fBcurses\fP(3X), -\fBform\fP(3X), -\fBform_fieldtype\fP(3X), -\fBform_field_buffer\fP(3X), -\fBform_field_validation\fP(3X), -\fBform_variables\fP(3X), -\fBgetch\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header files -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -269,3 +255,11 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X), +\fB\%form_fieldtype\fP(3X), +\fB\%form_field_buffer\fP(3X), +\fB\%form_field_validation\fP(3X), +\fB\%form_variables\fP(3X), +\fB\%getch\fP(3X) diff --git a/upstream/archlinux/man3/form_field.3x b/upstream/archlinux/man3/form_field.3x index c9cfbf2e..cf93fda6 100644 --- a/upstream/archlinux/man3/form_field.3x +++ b/upstream/archlinux/man3/form_field.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2012 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,21 +28,20 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field.3x,v 1.20 2022/02/12 20:03:40 tom Exp $ -.TH form_field 3X "" +.\" $Id: form_field.3x,v 1.34 2024/03/16 15:35:01 tom Exp $ +.TH form_field 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBform_field\fP \- make and break connections between fields and forms +\fBform_field\fP \- +make and break connections between fields and forms .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint set_form_fields(FORM *\fIform\fB, FIELD **\fIfields\fB);\fR -.br -\fBFIELD **form_fields(const FORM *\fIform\fB);\fR -.br -\fBint field_count(const FORM *\fIform\fB);\fR -.br -\fBint move_field(FIELD *\fIfield\fB, int \fIfrow\fB, int \fIfcol\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBint set_form_fields(FORM *\fIform\fP, FIELD **\fIfields\fP); +\fBFIELD **form_fields(const FORM *\fIform\fP); +\fBint field_count(const FORM *\fIform\fP); +\fBint move_field(FIELD *\fIfield\fP, int \fIfrow\fP, int \fIfcol\fP); +.fi .SH DESCRIPTION The function \fBset_form_fields\fP changes the field pointer array of the given \fIform\fP. The array must be terminated by a \fBNULL\fP. @@ -77,11 +76,6 @@ The form is already posted. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -.SH SEE ALSO -\fBcurses\fP(3X), \fBform\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -92,3 +86,6 @@ as \-1 (which is the value of \fBERR\fP). .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X) diff --git a/upstream/archlinux/man3/form_field_attributes.3x b/upstream/archlinux/man3/form_field_attributes.3x index 5a90cf8b..72c6b281 100644 --- a/upstream/archlinux/man3/form_field_attributes.3x +++ b/upstream/archlinux/man3/form_field_attributes.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2006,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,29 +28,34 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_attributes.3x,v 1.21 2022/02/12 20:03:40 tom Exp $ -.TH form_field_attributes 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: form_field_attributes.3x,v 1.35 2024/03/16 15:35:01 tom Exp $ +.TH form_field_attributes 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME -\fBform_field_attributes\fP \- color and attribute control for form fields +\fBform_field_attributes\fP \- +color and attribute control for form fields .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint set_field_fore(FIELD *\fIfield\fB, chtype \fIattr\fB);\fR -.br -\fBchtype field_fore(const FIELD *\fIfield\fB);\fR -.sp -\fBint set_field_back(FIELD *\fIfield\fB, chtype \fIattr\fB);\fR -.br -\fBchtype field_back(const FIELD *\fIfield\fB);\fR -.sp -\fBint set_field_pad(FIELD *\fIfield\fB, int \fIpad\fB);\fR -.br -\fBint field_pad(const FIELD *\fIfield\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBint set_field_fore(FIELD *\fIfield\fP, chtype \fIattr\fP); +\fBchtype field_fore(const FIELD *\fIfield\fP); +.PP +\fBint set_field_back(FIELD *\fIfield\fP, chtype \fIattr\fP); +\fBchtype field_back(const FIELD *\fIfield\fP); +.PP +\fBint set_field_pad(FIELD *\fIfield\fP, int \fIpad\fP); +\fBint field_pad(const FIELD *\fIfield\fP); +.fi .SH DESCRIPTION The function \fBset_field_fore\fP sets the foreground attribute of \fIfield\fP. This is the highlight used to display the field contents. The @@ -80,13 +85,6 @@ Routine detected an incorrect or out-of-range argument. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -. -.SH SEE ALSO -\fBcurses\fP(3X) and related pages whose names begin \*(``form_\*('' for detailed -descriptions of the entry points. -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -94,3 +92,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X) and related pages whose names begin \*(``form_\*('' +for detailed descriptions of the entry points. diff --git a/upstream/archlinux/man3/form_field_buffer.3x b/upstream/archlinux/man3/form_field_buffer.3x index 8688b7b6..0a5386f1 100644 --- a/upstream/archlinux/man3/form_field_buffer.3x +++ b/upstream/archlinux/man3/form_field_buffer.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,31 +27,38 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_buffer.3x,v 1.30 2022/02/12 20:03:40 tom Exp $ -.TH form_field_buffer 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: form_field_buffer.3x,v 1.45 2024/03/16 15:35:01 tom Exp $ +.TH form_field_buffer 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBform_field_buffer\fP \- field buffer control +\fBform_field_buffer\fP \- +field buffer control .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint set_field_buffer(FIELD *\fIfield\fB, int \fIbuf\fB, const char *\fIvalue\fB);\fR -.br -\fBchar *field_buffer(const FIELD *\fIfield\fB, int \fIbuffer\fB);\fR -.sp -\fBint set_field_status(FIELD *\fIfield\fB, bool \fIstatus\fB);\fR -.br -\fBbool field_status(const FIELD *\fIfield\fB);\fR -.sp -\fBint set_max_field(FIELD *\fIfield\fB, int \fImax\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBint set_field_buffer(FIELD *\fIfield\fP, int \fIbuf\fP, const char *\fIvalue\fP); +\fBchar *field_buffer(const FIELD *\fIfield\fP, int \fIbuffer\fP); +.PP +\fBint set_field_status(FIELD *\fIfield\fP, bool \fIstatus\fP); +\fBbool field_status(const FIELD *\fIfield\fP); +.PP +\fBint set_max_field(FIELD *\fIfield\fP, int \fImax\fP); +.fi .SH DESCRIPTION The function \fBset_field_buffer\fP sets the numbered buffer of the given field to contain a given string: @@ -119,26 +125,23 @@ System error occurred (see \fBerrno\fP(3)). .TP 5 .B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. -.SH SEE ALSO -\fBcurses\fP(3X) and related pages whose names begin \*(``form_\*('' for detailed -descriptions of the entry points. .SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -.PP When configured for wide characters, \fBfield_buffer\fP returns a pointer to temporary storage (allocated and freed by the library). The application should not attempt to modify the data. It will be freed on the next call to \fBfield_buffer\fP to return the same buffer. -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions. .PP -The \fBset_max_field\fP function checks for an ncurses extension +The \fBset_max_field\fP function checks for an \fI\%ncurses\fP extension \fBO_INPUT_FIELD\fP which allows a dynamic field to shrink if the new limit is smaller than the current field size. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X) and related pages whose names begin \*(``form_\*('' +for detailed descriptions of the entry points. diff --git a/upstream/archlinux/man3/form_field_info.3x b/upstream/archlinux/man3/form_field_info.3x index f5d77778..88a8bea1 100644 --- a/upstream/archlinux/man3/form_field_info.3x +++ b/upstream/archlinux/man3/form_field_info.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,24 +27,31 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_info.3x,v 1.21 2022/02/12 20:03:40 tom Exp $ -.TH form_field_info 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: form_field_info.3x,v 1.32 2024/03/16 15:35:01 tom Exp $ +.TH form_field_info 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME \fBdynamic_field_info\fP, -\fBfield_info\fP \- retrieve field characteristics +\fBfield_info\fP \- +retrieve field characteristics .SH SYNOPSIS .nf -\fB#include <form.h>\fP -.sp -\fBint field_info(const FIELD *\fIfield\fB,\fR +\fB#include <form.h> +.PP +\fBint field_info(const FIELD *\fIfield\fP, \fBint *\fIrows\fB, int *\fIcols\fB,\fR \fBint *\fIfrow\fB, int *\fIfcol\fB,\fR \fBint *\fInrow\fB, int *\fInbuf\fB);\fR -.sp +.PP \fBint dynamic_field_info(const FIELD *\fIfield\fB,\fR \fBint *\fIrows\fB, int *\fIcols\fB, int *\fImax\fB);\fR .fi @@ -73,12 +79,6 @@ System error occurred (see \fBerrno\fP(3)). .TP 5 .B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. -.SH SEE ALSO -\fBcurses\fP(3X) and related pages whose names begin \*(``form_\*('' for detailed -descriptions of the entry points. -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -90,3 +90,6 @@ Not all implementations allow this, e.g., Solaris 2.7 does not. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X) and related pages whose names begin \*(``form_\*('' +for detailed descriptions of the entry points. diff --git a/upstream/archlinux/man3/form_field_just.3x b/upstream/archlinux/man3/form_field_just.3x index 8f5efa61..91f19067 100644 --- a/upstream/archlinux/man3/form_field_just.3x +++ b/upstream/archlinux/man3/form_field_just.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,22 +27,29 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_just.3x,v 1.21 2022/02/12 20:03:40 tom Exp $ -.TH form_field_just 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: form_field_just.3x,v 1.35 2024/03/16 15:35:01 tom Exp $ +.TH form_field_just 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME \fBset_field_just\fP, -\fBfield_just\fP \- retrieve field characteristics +\fBfield_just\fP \- +retrieve field characteristics .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint set_field_just(FIELD *\fIfield\fB, int \fIjustification\fB);\fR -.br -\fBint field_just(const FIELD *\fIfield\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBint set_field_just(FIELD *\fIfield\fP, int \fIjustification\fP); +\fBint field_just(const FIELD *\fIfield\fP); +.fi .SH DESCRIPTION The function \fBset_field_just\fP sets the justification attribute of a field; \fBfield_just\fP returns a field's justification attribute. @@ -64,12 +70,6 @@ System error occurred (see \fBerrno\fP(3)). .TP 5 .B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. -.SH SEE ALSO -\fBcurses\fP(3X) and related pages whose names begin \*(``form_\*('' for detailed -descriptions of the entry points. -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -77,3 +77,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X) and related pages whose names begin \*(``form_\*('' +for detailed descriptions of the entry points. diff --git a/upstream/archlinux/man3/form_field_new.3x b/upstream/archlinux/man3/form_field_new.3x index 05d6d03c..fc0bbc62 100644 --- a/upstream/archlinux/man3/form_field_new.3x +++ b/upstream/archlinux/man3/form_field_new.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,26 +27,25 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_new.3x,v 1.27 2022/02/12 20:03:40 tom Exp $ -.TH form_field_new 3X "" +.\" $Id: form_field_new.3x,v 1.41 2024/03/16 15:35:01 tom Exp $ +.TH form_field_new 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBnew_field\fP, \fBdup_field\fP, \fBlink_field\fP, -\fBfree_field\fP \- create and destroy form fields +\fBfree_field\fP \- +create and destroy form fields .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBFIELD *new_field(int \fIheight\fB, int \fIwidth\fB,\fR +.nf +\fB#include <form.h> +.PP +\fBFIELD *new_field(int \fIheight\fP, int \fIwidth\fP, \fBint \fItoprow\fB, int \fIleftcol\fB,\fR \fBint \fIoffscreen\fB, int \fInbuffers\fB);\fR -.br \fBFIELD *dup_field(FIELD *\fIfield\fB, int \fItoprow\fB, int \fIleftcol\fB);\fR -.br \fBFIELD *link_field(FIELD *\fIfield\fB, int \fItoprow\fB, int \fIleftcol\fB);\fR -.br \fBint free_field(FIELD *\fIfield\fB);\fR -.br +.fi .SH DESCRIPTION The function \fBnew_field\fP allocates a new field and initializes it from the parameters given: height, width, row of upper-left corner, column of upper-left @@ -90,11 +88,6 @@ Routine detected an incorrect or out-of-range argument. .TP 5 .B E_CONNECTED field is connected. -.SH SEE ALSO -\fBcurses\fP(3X), \fBform\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -106,3 +99,6 @@ not very explicit about what gets copied and what does not. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X) diff --git a/upstream/archlinux/man3/form_field_opts.3x b/upstream/archlinux/man3/form_field_opts.3x index e19f6bd9..9f13d3b2 100644 --- a/upstream/archlinux/man3/form_field_opts.3x +++ b/upstream/archlinux/man3/form_field_opts.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2014,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,24 +27,24 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_opts.3x,v 1.30 2022/02/12 20:03:40 tom Exp $ -.TH form_field_opts 3X "" +.\" $Id: form_field_opts.3x,v 1.44 2024/03/16 15:35:01 tom Exp $ +.TH form_field_opts 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBset_field_opts\fP, \fBfield_opts_on\fP, \fBfield_opts_off\fP, -\fBfield_opts\fP \- set and get field options +\fBfield_opts\fP \- +set and get field options .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint set_field_opts(FIELD *\fIfield\fB, Field_Options \fIopts\fB);\fR -.br -\fBField_Options field_opts(const FIELD *\fIfield\fB);\fR -.sp -\fBint field_opts_on(FIELD *\fIfield\fB, Field_Options \fIopts\fB);\fR -.br -\fBint field_opts_off(FIELD *\fIfield\fB, Field_Options \fIopts\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBint set_field_opts(FIELD *\fIfield\fP, Field_Options \fIopts\fP); +\fBField_Options field_opts(const FIELD *\fIfield\fP); +.PP +\fBint field_opts_on(FIELD *\fIfield\fP, Field_Options \fIopts\fP); +\fBint field_opts_off(FIELD *\fIfield\fP, Field_Options \fIopts\fP); +.fi .SH DESCRIPTION The function \fBset_field_opts\fP sets all the given field's option bits (field option bits may be logically-OR'ed together). @@ -134,13 +133,6 @@ The field is the current field. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -.SH SEE ALSO -\fBcurses\fP(3X), -\fBform\fP(3X). -\fBform_field_just\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -148,3 +140,7 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X), +\fB\%form_field_just\fP(3X) diff --git a/upstream/archlinux/man3/form_field_userptr.3x b/upstream/archlinux/man3/form_field_userptr.3x index ae5f7512..fda9ce67 100644 --- a/upstream/archlinux/man3/form_field_userptr.3x +++ b/upstream/archlinux/man3/form_field_userptr.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,17 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_userptr.3x,v 1.19 2022/02/12 20:03:40 tom Exp $ -.TH form_field_userptr 3X "" +.\" $Id: form_field_userptr.3x,v 1.30 2024/03/16 15:35:01 tom Exp $ +.TH form_field_userptr 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBset_field_userptr\fP, -\fBfield_userptr\fP \- associate application data with a form field +\fBfield_userptr\fP \- +associate application data with a form field .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint set_field_userptr(FIELD *\fIfield\fB, void *\fIuserptr\fB);\fR -.br -\fBvoid *field_userptr(const FIELD *\fIfield\fB);\fR +.nf +\fB#include <form.h> +.PP +\fBint set_field_userptr(FIELD *\fIfield\fP, void *\fIuserptr\fP); +\fBvoid *field_userptr(const FIELD *\fIfield\fP); +.fi .SH DESCRIPTION Every form field has a field that can be used to hold application-specific data (that is, the form-driver code leaves it alone). @@ -49,11 +50,6 @@ The function \fBfield_userptr\fP returns a pointer (which may be \fBNULL\fP). It does not set \fBerrno\fP. .PP The function \fBset_field_userptr\fP returns \fBE_OK\fP (success). -.SH SEE ALSO -\fBcurses\fP(3X), \fBform\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -64,3 +60,6 @@ We chose not to leave it as a char pointer for SVr4 compatibility. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X) diff --git a/upstream/archlinux/man3/form_field_validation.3x b/upstream/archlinux/man3/form_field_validation.3x index ec68a90f..5202959e 100644 --- a/upstream/archlinux/man3/form_field_validation.3x +++ b/upstream/archlinux/man3/form_field_validation.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,43 +27,43 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_validation.3x,v 1.36 2022/02/12 20:03:40 tom Exp $ -.TH form_field_validation 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: form_field_validation.3x,v 1.53 2024/03/16 15:35:01 tom Exp $ +.TH form_field_validation 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBform_field_validation\fP \- data type validation for fields +\fBform_field_validation\fP \- +data type validation for fields .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBvoid *field_arg(const FIELD *\fIfield\fB);\fR -.br -\fBFIELDTYPE *field_type(const FIELD *\fIfield\fB);\fR -.br -\fBint set_field_type(FIELD *\fIfield\fB, FIELDTYPE *\fItype\fB, ...);\fR -.sp -/* predefined field types */ -.br -\fBFIELDTYPE *TYPE_ALNUM;\fP -.br -\fBFIELDTYPE *TYPE_ALPHA;\fP -.br -\fBFIELDTYPE *TYPE_ENUM;\fP -.br -\fBFIELDTYPE *TYPE_INTEGER;\fP -.br -\fBFIELDTYPE *TYPE_NUMERIC;\fP -.br -\fBFIELDTYPE *TYPE_REGEXP;\fP -.br -\fBFIELDTYPE *TYPE_IPV4;\fP -.br +.nf +\fB#include <form.h> +.PP +\fBvoid *field_arg(const FIELD *\fIfield\fP); +\fBFIELDTYPE *field_type(const FIELD *\fIfield\fP); +\fBint set_field_type(FIELD *\fIfield\fP, FIELDTYPE *\fItype\fP, ...); +.PP +\fI/* predefined field types */\fP +\fBFIELDTYPE *TYPE_ALNUM; +\fBFIELDTYPE *TYPE_ALPHA; +\fBFIELDTYPE *TYPE_ENUM; +\fBFIELDTYPE *TYPE_INTEGER; +\fBFIELDTYPE *TYPE_NUMERIC; +\fBFIELDTYPE *TYPE_REGEXP; +\fBFIELDTYPE *TYPE_IPV4; +.fi .SH DESCRIPTION By default, no validation is done on form fields. You can associate a form with with a \fIfield type\fP, @@ -83,8 +83,7 @@ Most field types are configurable, via arguments which the caller provides when calling \fBset_field_type\fP. .PP Several field types are predefined by the form library. -.SS Predefined types -.PP +.SH PREDEFINED TYPES It is possible to set up new programmer-defined field types. Field types are implemented via the \fBFIELDTYPE\fP data structure, which contains several pointers to functions. @@ -94,27 +93,19 @@ which describes functions which can be used to construct a field-type dynamically. .PP The predefined types are as follows: -.TP 5 -TYPE_ALNUM +.SS TYPE_ALNUM Alphanumeric data. Required parameter: -.RS .bP a third \fBint\fP argument, a minimum field width. -.RE -.TP 5 -TYPE_ALPHA +.SS TYPE_ALPHA Character data. Required parameter: -.RS .bP a third \fBint\fP argument, a minimum field width. -.RE -.TP 5 -TYPE_ENUM +.SS TYPE_ENUM Accept one of a specified set of strings. Required parameters: -.RS .bP a third \fB(char **)\fP argument pointing to a string list; .bP @@ -124,15 +115,12 @@ a fifth \fBint\fP flag argument specifying whether a partial match must be a unique one. If this flag is off, a prefix matches the first of any set of more than one list elements with that prefix. -.RE -.IP +.PP The library copies the string list, so you may use a list that lives in automatic variables on the stack. -.TP 5 -TYPE_INTEGER +.SS TYPE_INTEGER Integer data, parsable to an integer by \fBatoi\fP(3). Required parameters: -.RS .bP a third \fBint\fP argument controlling the precision, .bP @@ -141,18 +129,15 @@ a fourth \fBlong\fP argument constraining minimum value, a fifth \fBlong\fP constraining maximum value. If the maximum value is less than or equal to the minimum value, the range is simply ignored. -.RE -.IP +.PP On return, the field buffer is formatted according to the \fBprintf\fP format specification \*(``.*ld\*('', where the \*(``*\*('' is replaced by the precision argument. -.IP +.PP For details of the precision handling see \fBprintf\fP(3). -.TP 5 -TYPE_NUMERIC +.SS TYPE_NUMERIC Numeric data (may have a decimal-point part). Required parameters: -.RS .bP a third \fBint\fP argument controlling the precision, .bP @@ -163,26 +148,22 @@ If your system supports locales, the decimal point character must be the one specified by your locale. If the maximum value is less than or equal to the minimum value, the range is simply ignored. -.RE -.IP +.PP On return, the field buffer is formatted according to the \fBprintf\fP format specification \*(``.*f\*('', where the \*(``*\*('' is replaced by the precision argument. -.IP +.PP For details of the precision handling see \fBprintf\fP(3). -.TP 5 -TYPE_REGEXP +.SS TYPE_REGEXP Regular expression data. Required parameter: -.RS .bP a third argument, a regular expression \fB(char *)\fP string. The data is valid if the regular expression matches it. -.RE -.IP +.PP Regular expressions are in the format of \fBregcomp\fP and \fBregexec\fP. -.IP +.PP The regular expression must match the whole field. If you have for example, an eight character wide field, a regular expression "^[0\-9]*$" always @@ -192,21 +173,18 @@ you may use for example "^[0\-9]* *$" which is good for trailing spaces (up to an empty field), or "^ *[0\-9]* *$" which is good for leading and trailing spaces around the digits. -.TP 5 -TYPE_IPV4 +.SS TYPE_IPV4 An Internet Protocol Version 4 address. Required parameter: -.RS .bP none -.RE -.IP +.PP The form library checks whether or not the buffer has the form \fIa.b.c.d\fP, where \fIa\fP, \fIb\fP, \fIc\fP, and \fId\fP are numbers in the range 0 to 255. Trailing blanks in the buffer are ignored. The address itself is not validated. -.IP -This is an ncurses extension; +.PP +This is an \fI\%ncurses\fP extension; this field type may not be available in other curses implementations. .SH RETURN VALUE The functions \fBfield_type\fP and \fBfield_arg\fP return \fBNULL\fP on error. @@ -217,14 +195,6 @@ The routine succeeded. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -.SH SEE ALSO -\fBcurses\fP(3X), -\fBform\fP(3X), -\fBform_fieldtype\fP(3X), -\fBform_variables\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -232,3 +202,8 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X), +\fB\%form_fieldtype\fP(3X), +\fB\%form_variables\fP(3X) diff --git a/upstream/archlinux/man3/form_fieldtype.3x b/upstream/archlinux/man3/form_fieldtype.3x index 7a23bb86..e0a37a76 100644 --- a/upstream/archlinux/man3/form_fieldtype.3x +++ b/upstream/archlinux/man3/form_fieldtype.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2006,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,36 +27,37 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_fieldtype.3x,v 1.31 2022/02/12 20:03:40 tom Exp $ +.\" $Id: form_fieldtype.3x,v 1.46 2024/03/16 15:35:01 tom Exp $ +.TH form_fieldtype 3X 2024-03-16 "ncurses 6.5" "Library calls" .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.TH form_fieldtype 3X "" .SH NAME -\fBform_fieldtype\fP \- define validation-field types +\fBform_fieldtype\fP \- +define validation-field types .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBFIELDTYPE *new_fieldtype(\fP +.nf +\fB#include <form.h> +.PP +\fBFIELDTYPE *new_fieldtype( \fBbool (* const \fIfield_check\fB)(FIELD *, const void *),\fR \fBbool (* const \fIchar_check\fB)(int, const void *));\fR -.br \fBint free_fieldtype(FIELDTYPE *\fIfieldtype\fB);\fR -.sp +.PP \fBint set_fieldtype_arg(\fP \fBFIELDTYPE *\fIfieldtype\fB,\fR \fBvoid *(* const \fImake_arg\fB)(va_list *),\fR \fBvoid *(* const \fIcopy_arg\fB)(const void *),\fR \fBvoid (* const \fIfree_arg\fB)(void *));\fR -.br \fBint set_fieldtype_choice(\fP \fBFIELDTYPE *\fIfieldtype\fB,\fR \fBbool (* const \fInext_choice\fB)(FIELD *, const void *),\fR \fBbool (* const \fIprev_choice\fB)(FIELD *, const void *));\fR -.sp +.PP \fBFIELDTYPE *link_fieldtype(FIELDTYPE *\fItype1\fB,\fR \fBFIELDTYPE *\fItype2\fB);\fR +.fi .SH DESCRIPTION .SS new_fieldtype The function \fBnew_fieldtype\fP creates a new field type usable for data @@ -82,11 +82,9 @@ This function validates input characters as they are entered. The form library passes it the character to be checked and a pointer to an argument-block structure. .SS free_fieldtype -.PP The \fBfree_fieldtype\fP function frees the space allocated for a given validation type by \fBnew_fieldtype\fP. .SS set_fieldtype_arg -.PP The function \fBset_fieldtype_arg\fP associates three storage-management functions with a field type: .TP 5 @@ -109,7 +107,6 @@ In this case, the form library assumes that \fImake_arg\fP does not allocate memory but simply loads the argument into a single scalar value. .SS set_fieldtype_choice -.PP The form driver requests \fBREQ_NEXT_CHOICE\fP and \fBREQ_PREV_CHOICE\fP assume that the possible values of a field form an ordered set, and provide the forms user with a way to move through the set. @@ -120,7 +117,6 @@ for the field type. These functions take the field pointer and an argument-block structure as arguments. .SS link_fieldtype -.PP The function \fBlink_fieldtype\fP creates a new field type from the two given types. They are connected by an logical 'OR'. @@ -154,13 +150,6 @@ The field is the current field. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -.SH SEE ALSO -\fBcurses\fP(3X), -\fBform\fP(3X), -\fBform_field_validation\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -168,3 +157,7 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X), +\fB\%form_field_validation\fP(3X) diff --git a/upstream/archlinux/man3/form_hook.3x b/upstream/archlinux/man3/form_hook.3x index b4f17ed1..30cc777c 100644 --- a/upstream/archlinux/man3/form_hook.3x +++ b/upstream/archlinux/man3/form_hook.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2007,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,53 +27,52 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_hook.3x,v 1.19 2022/02/12 20:03:40 tom Exp $ -.TH form_hook 3X "" +.\" $Id: form_hook.3x,v 1.37 2024/03/16 15:35:01 tom Exp $ +.TH form_hook 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBform_hook\fP \- set hooks for automatic invocation by applications +\fBform_hook\fP \- +set hooks for automatic invocation by applications .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint set_field_init(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR -.br -\fBForm_Hook field_init(const FORM *\fIform\fB);\fR -.sp -\fBint set_field_term(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR -.br -\fBForm_Hook field_term(const FORM *\fIform\fB);\fR -.sp -\fBint set_form_init(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR -.br -\fBForm_Hook form_init(const FORM *\fIform\fB);\fR -.sp -\fBint set_form_term(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR -.br -\fBForm_Hook form_term(const FORM *\fIform\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBint set_field_init(FORM *\fIform\fP, Form_Hook \fIfunc\fP); +\fBForm_Hook field_init(const FORM *\fIform\fP); +.PP +\fBint set_field_term(FORM *\fIform\fP, Form_Hook \fIfunc\fP); +\fBForm_Hook field_term(const FORM *\fIform\fP); +.PP +\fBint set_form_init(FORM *\fIform\fP, Form_Hook \fIfunc\fP); +\fBForm_Hook form_init(const FORM *\fIform\fP); +.PP +\fBint set_form_term(FORM *\fIform\fP, Form_Hook \fIfunc\fP); +\fBForm_Hook form_term(const FORM *\fIform\fP); +.fi .SH DESCRIPTION These functions make it possible to set hook functions to be called at various points in the automatic processing of input event codes by \fBform_driver\fP. -.PP -The function \fBset_field_init\fP sets a hook to be called at form-post time +.SS set_field_init +sets a hook to be called at form-post time and each time the selected field changes (after the change). -\fBfield_init\fP +.SS field_init returns the current field init hook, if any (\fBNULL\fP if there is no such hook). -.PP -The function \fBset_field_term\fP sets a hook to be called at form-unpost time +.SS set_field_term +sets a hook to be called at form-unpost time and each time the selected field changes (before the change). -\fBfield_term\fP +.SS field_term returns the current field term hook, if any (\fBNULL\fP if there is no such hook). -.PP -The function \fBset_form_init\fP sets a hook to be called at form-post time and +.SS set_form_init +sets a hook to be called at form-post time and just after a page change once it is posted. -\fBform_init\fP returns the -current form init hook, if any (\fBNULL\fP if there is no such hook). -.PP -The function \fBset_form_term\fP sets a hook to be called at form-unpost time +.SS form_init +returns the current form init hook, +if any (\fBNULL\fP if there is no such hook). +.SS set_form_term +sets a hook to be called at form-unpost time and just before a page change once it is posted. -\fBform_init\fP +.SS form_term returns the current form term hook, if any (\fBNULL\fP if there is no such hook). .SH RETURN VALUE @@ -87,11 +85,6 @@ The routine succeeded. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -.SH SEE ALSO -\fBcurses\fP(3X), \fBform\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -99,3 +92,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X) diff --git a/upstream/archlinux/man3/form_new.3x b/upstream/archlinux/man3/form_new.3x index 901d94d5..f6de6745 100644 --- a/upstream/archlinux/man3/form_new.3x +++ b/upstream/archlinux/man3/form_new.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,18 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_new.3x,v 1.18 2022/02/12 20:03:40 tom Exp $ -.TH form_new 3X "" +.\" $Id: form_new.3x,v 1.32 2024/03/16 15:35:01 tom Exp $ +.TH form_new 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBnew_form\fP, -\fBfree_form\fP \- create and destroy forms +\fBfree_form\fP \- +create and destroy forms .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBFORM *new_form(FIELD **\fIfields\fB);\fR -.br -\fBint free_form(FORM *\fIform\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBFORM *new_form(FIELD **\fIfields\fP); +\fBint free_form(FORM *\fIform\fP); +.fi .SH DESCRIPTION The function \fBnew_form\fP creates a new form connected to a specified field pointer array (which must be \fBNULL\fP-terminated). @@ -72,11 +72,6 @@ Routine detected an incorrect or out-of-range argument. .TP 5 .B E_POSTED The form has already been posted. -.SH SEE ALSO -\fBcurses\fP(3X), \fBform\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -84,3 +79,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X) diff --git a/upstream/archlinux/man3/form_new_page.3x b/upstream/archlinux/man3/form_new_page.3x index fa1660a1..cba71b3f 100644 --- a/upstream/archlinux/man3/form_new_page.3x +++ b/upstream/archlinux/man3/form_new_page.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,22 +27,29 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_new_page.3x,v 1.20 2022/02/12 20:03:40 tom Exp $ -.TH form_new_page 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: form_new_page.3x,v 1.34 2024/03/16 15:35:01 tom Exp $ +.TH form_new_page 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME \fBset_new_page\fP, -\fBnew_page\fP \- form pagination functions +\fBnew_page\fP \- +form pagination functions .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint set_new_page(FIELD *\fIfield\fB, bool \fInew_page_flag\fB);\fR -.br -\fBbool new_page(const FIELD *\fIfield\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBint set_new_page(FIELD *\fIfield\fP, bool \fInew_page_flag\fP); +\fBbool new_page(const FIELD *\fIfield\fP); +.fi .SH DESCRIPTION The function \fBset_new_page\fP sets or resets a flag marking the given field as the beginning of a new page on its form. @@ -60,12 +66,6 @@ The routine succeeded. .TP 5 .B E_CONNECTED The given field is already connected to a form. -.SH SEE ALSO -\fBcurses\fP(3X) and related pages whose names begin \*(``form_\*('' for detailed -descriptions of the entry points. -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -73,3 +73,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X) and related pages whose names begin \*(``form_\*('' +for detailed descriptions of the entry points. diff --git a/upstream/archlinux/man3/form_opts.3x b/upstream/archlinux/man3/form_opts.3x index 75ee62a7..6463b683 100644 --- a/upstream/archlinux/man3/form_opts.3x +++ b/upstream/archlinux/man3/form_opts.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,24 +27,24 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_opts.3x,v 1.20 2022/02/12 20:03:40 tom Exp $ -.TH form_opts 3X "" +.\" $Id: form_opts.3x,v 1.34 2024/03/16 15:35:01 tom Exp $ +.TH form_opts 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBset_form_opts\fP, \fBform_opts_on\fP, \fBform_opts_off\fP, -\fBform_opts\fP \- set and get form options +\fBform_opts\fP \- +set and get form options .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint set_form_opts(FORM *\fIform\fB, Field_Options \fIopts\fB);\fR -.br -\fBField_Options form_opts(const FORM *\fIform\fB);\fR -.sp -\fBint form_opts_on(FORM *\fIform\fB, Field_Options \fIopts\fB);\fR -.br -\fBint form_opts_off(FORM *\fIform\fB, Field_Options \fIopts\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBint set_form_opts(FORM *\fIform\fP, Field_Options \fIopts\fP); +\fBField_Options form_opts(const FORM *\fIform\fP); +.PP +\fBint form_opts_on(FORM *\fIform\fP, Field_Options \fIopts\fP); +\fBint form_opts_off(FORM *\fIform\fP, Field_Options \fIopts\fP); +.fi .SH DESCRIPTION The function \fBset_form_opts\fP sets all the given form's option bits (form option bits may be logically-OR'ed together). @@ -75,11 +74,6 @@ The routine succeeded. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -.SH SEE ALSO -\fBcurses\fP(3X), \fBform\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -87,3 +81,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X) diff --git a/upstream/archlinux/man3/form_page.3x b/upstream/archlinux/man3/form_page.3x index 5205859e..142e2759 100644 --- a/upstream/archlinux/man3/form_page.3x +++ b/upstream/archlinux/man3/form_page.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2016 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,25 +27,25 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_page.3x,v 1.22 2022/02/12 20:03:40 tom Exp $ -.TH form_page 3X "" +.\" $Id: form_page.3x,v 1.37 2024/03/16 15:35:01 tom Exp $ +.TH form_page 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBform_page\fP \- set and get form page number +\fBform_page\fP \- +set and get form page number .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint set_current_field(FORM *\fIform\fB, FIELD *\fIfield\fB);\fR -.br -\fBFIELD *current_field(const FORM *\fIform\fB);\fR -.sp -\fBint unfocus_current_field(FORM *\fIform\fB);\fR -.sp -\fBint set_form_page(FORM *\fIform\fB, int \fIn\fB);\fR -.br -\fBint form_page(const FORM *\fIform\fB);\fR -.sp -\fBint field_index(const FIELD *\fIfield\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBint set_current_field(FORM *\fIform\fP, FIELD *\fIfield\fP); +\fBFIELD *current_field(const FORM *\fIform\fP); +.PP +\fBint unfocus_current_field(FORM *\fIform\fP); +.PP +\fBint set_form_page(FORM *\fIform\fP, int \fIn\fP); +\fBint form_page(const FORM *\fIform\fP); +.PP +\fBint field_index(const FIELD *\fIfield\fP); +.fi .SH DESCRIPTION The function \fBset_current_field\fP sets the current field of the given form; \fBcurrent_field\fP returns the current field of the given form. @@ -84,18 +83,16 @@ The form driver could not process the request. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -. -.SH SEE ALSO -\fBcurses\fP(3X), \fBform\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions. .PP -The \fBunfocus_current_field\fP function is an ncurses extension. +The \fBunfocus_current_field\fP function is an \fI\%ncurses\fP +extension. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X) diff --git a/upstream/archlinux/man3/form_post.3x b/upstream/archlinux/man3/form_post.3x index 689ab975..267f7b17 100644 --- a/upstream/archlinux/man3/form_post.3x +++ b/upstream/archlinux/man3/form_post.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,18 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_post.3x,v 1.19 2022/02/12 20:03:40 tom Exp $ -.TH form_post 3X "" +.\" $Id: form_post.3x,v 1.33 2024/03/16 15:35:01 tom Exp $ +.TH form_post 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBpost_form\fP, -\fBunpost_form\fP \- write or erase forms from associated subwindows +\fBunpost_form\fP \- +write or erase forms from associated subwindows .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint post_form(FORM *\fIform\fB);\fR -.br -\fBint unpost_form(FORM *\fIform\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBint post_form(FORM *\fIform\fP); +\fBint unpost_form(FORM *\fIform\fP); +.fi .SH DESCRIPTION The function \fBpost_form\fP displays a form to its associated subwindow. To trigger physical display of the subwindow, @@ -74,12 +74,6 @@ The form has already been posted. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -. -.SH SEE ALSO -\fBcurses\fP(3X), \fBform\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -87,3 +81,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X) diff --git a/upstream/archlinux/man3/form_requestname.3x b/upstream/archlinux/man3/form_requestname.3x index e26dfd82..b09143d2 100644 --- a/upstream/archlinux/man3/form_requestname.3x +++ b/upstream/archlinux/man3/form_requestname.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,23 +27,22 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_requestname.3x,v 1.19 2022/02/12 20:03:40 tom Exp $ -.TH form_requestname 3X "" +.\" $Id: form_requestname.3x,v 1.35 2024/03/16 15:35:01 tom Exp $ +.TH form_requestname 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBform_request_by_name\fP, -\fBform_request_name\fP \- handle printable form request names +\fBform_request_name\fP \- +handle printable form request names .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBconst char *form_request_name(int \fIrequest\fB);\fR -.br -\fBint form_request_by_name(const char *\fIname\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBconst char *form_request_name(int \fIrequest\fP); +\fBint form_request_by_name(const char *\fIname\fP); +.fi .SH DESCRIPTION -.SS form_request_name The function \fBform_request_name\fP returns the printable name of a form request code. -.SS form_request_name_by_name The function \fBform_request_by_name\fP searches in the name-table for a request with the given name and returns its request code. Otherwise E_NO_MATCH is returned. @@ -54,13 +52,8 @@ to \fBE_BAD_ARGUMENT\fP. .PP \fBform_request_by_name\fP returns \fBE_NO_MATCH\fP on error. It does not set \fBerrno\fP. -.SH SEE ALSO -\fBcurses\fP(3X), \fBform\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY -These routines are specific to ncurses. +These routines are specific to \fI\%ncurses\fP. They were not supported on Version 7, BSD or System V implementations. It is recommended that @@ -68,3 +61,6 @@ any code depending on them be conditioned using NCURSES_VERSION. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X) diff --git a/upstream/archlinux/man3/form_userptr.3x b/upstream/archlinux/man3/form_userptr.3x index 47fcc294..dc4d6ab9 100644 --- a/upstream/archlinux/man3/form_userptr.3x +++ b/upstream/archlinux/man3/form_userptr.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,18 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_userptr.3x,v 1.22 2022/02/12 20:03:40 tom Exp $ -.TH form_userptr 3X "" +.\" $Id: form_userptr.3x,v 1.36 2024/03/16 15:35:01 tom Exp $ +.TH form_userptr 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBset_form_userptr\fP, -\fBform_userptr\fP \- associate application data with a form item +\fBform_userptr\fP \- +associate application data with a form item .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint set_form_userptr(FORM *\fIform\fB, void *\fIuserptr\fB);\fR -.br -\fBvoid* form_userptr(const FORM *\fIform\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBint set_form_userptr(FORM *\fIform\fP, void *\fIuserptr\fP); +\fBvoid* form_userptr(const FORM *\fIform\fP); +.fi .SH DESCRIPTION Every form and every form item has a field that can be used to hold application-specific data (that is, the form-driver code leaves it alone). @@ -49,11 +49,6 @@ The function \fBform_userptr\fP returns a pointer (which may be \fBNULL\fP). It does not set \fBerrno\fP. .PP The function \fBset_form_userptr\fP returns \fBE_OK\fP (success). -.SH SEE ALSO -\fBcurses\fP(3X), \fBform\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -64,3 +59,6 @@ We chose not to leave it as a char pointer for SVr4 compatibility. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X) diff --git a/upstream/archlinux/man3/form_variables.3x b/upstream/archlinux/man3/form_variables.3x index 5a1712d5..5ba03d00 100644 --- a/upstream/archlinux/man3/form_variables.3x +++ b/upstream/archlinux/man3/form_variables.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2020,2021 Thomas E. Dickey * +.\" Copyright 2020-2023,2024 Thomas E. Dickey * .\" Copyright 2010-2013,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,32 +27,28 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_variables.3x,v 1.9 2021/12/25 21:50:36 tom Exp $ -.TH form_variables 3X "" -.na -.hy 0 +.\" $Id: form_variables.3x,v 1.18 2024/03/16 15:35:01 tom Exp $ +.TH form_variables 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBTYPE_ALNUM\fP, -\fBTYPE_ALPHA\fP, -\fBTYPE_ENUM\fP, -\fBTYPE_INTEGER\fP, -\fBTYPE_IPV4\fP, -\fBTYPE_NUMERIC\fP, -\fBTYPE_REGEXP\fP -\- form system global variables -.ad -.hy +\fB\%TYPE_ALNUM\fP, +\fB\%TYPE_ALPHA\fP, +\fB\%TYPE_ENUM\fP, +\fB\%TYPE_INTEGER\fP, +\fB\%TYPE_IPV4\fP, +\fB\%TYPE_NUMERIC\fP, +\fB\%TYPE_REGEXP\fP \- +form system global variables .SH SYNOPSIS .nf -\fB#include <form.h>\fP +\fB#include <form.h> .PP -\fBFIELDTYPE * TYPE_ALNUM;\fP -\fBFIELDTYPE * TYPE_ALPHA;\fP -\fBFIELDTYPE * TYPE_ENUM;\fP -\fBFIELDTYPE * TYPE_INTEGER;\fP -\fBFIELDTYPE * TYPE_IPV4;\fP -\fBFIELDTYPE * TYPE_NUMERIC;\fP -\fBFIELDTYPE * TYPE_REGEXP;\fP +\fBFIELDTYPE * TYPE_ALNUM; +\fBFIELDTYPE * TYPE_ALPHA; +\fBFIELDTYPE * TYPE_ENUM; +\fBFIELDTYPE * TYPE_INTEGER; +\fBFIELDTYPE * TYPE_IPV4; +\fBFIELDTYPE * TYPE_NUMERIC; +\fBFIELDTYPE * TYPE_REGEXP; .fi .SH DESCRIPTION These are building blocks for the form library, @@ -78,4 +74,4 @@ This holds a regular expression. The \fBTYPE_IPV4\fP variable is an extension not provided by older implementations of the form library. .SH SEE ALSO -\fBform\fP(3X). +\fB\%form\fP(3X) diff --git a/upstream/archlinux/man3/form_win.3x b/upstream/archlinux/man3/form_win.3x index 49c007fc..a6edcb32 100644 --- a/upstream/archlinux/man3/form_win.3x +++ b/upstream/archlinux/man3/form_win.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2006,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,23 +27,23 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_win.3x,v 1.21 2022/02/12 20:03:40 tom Exp $ -.TH form_win 3X "" +.\" $Id: form_win.3x,v 1.35 2024/03/16 15:35:01 tom Exp $ +.TH form_win 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBform_win\fP \- make and break form window and subwindow associations +\fBform_win\fP \- +make and break form window and subwindow associations .SH SYNOPSIS -\fB#include <form.h>\fP -.sp -\fBint set_form_win(FORM *\fIform\fB, WINDOW *\fIwin\fB);\fR -.br -\fBWINDOW *form_win(const FORM *\fIform\fB);\fR -.sp -\fBint set_form_sub(FORM *\fIform\fB, WINDOW *\fIsub\fB);\fR -.br -\fBWINDOW *form_sub(const FORM *\fIform\fB);\fR -.sp -\fBint scale_form(const FORM *\fIform\fB, int *\fIrows\fB, int *\fIcolumns\fB);\fR -.br +.nf +\fB#include <form.h> +.PP +\fBint set_form_win(FORM *\fIform\fP, WINDOW *\fIwin\fP); +\fBWINDOW *form_win(const FORM *\fIform\fP); +.PP +\fBint set_form_sub(FORM *\fIform\fP, WINDOW *\fIsub\fP); +\fBWINDOW *form_sub(const FORM *\fIform\fP); +.PP +\fBint scale_form(const FORM *\fIform\fP, int *\fIrows\fP, int *\fIcolumns\fP); +.fi .SH DESCRIPTION Every form has an associated pair of \fBcurses\fP windows. The form window @@ -80,13 +79,6 @@ The form has already been posted. .TP 5 .B E_NOT_CONNECTED No items are connected to the form. -.SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_variables\fP(3X), -\fBform\fP(3X). -.SH NOTES -The header file \fB<form.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -94,3 +86,7 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%curs_variables\fP(3X), +\fB\%form\fP(3X) diff --git a/upstream/archlinux/man3/fpathconf.3 b/upstream/archlinux/man3/fpathconf.3 index f510736f..982483cb 100644 --- a/upstream/archlinux/man3/fpathconf.3 +++ b/upstream/archlinux/man3/fpathconf.3 @@ -20,7 +20,7 @@ .\" _PC_SYMLINK_MAX, .\" _PC_2_SYMLINKS .\" -.TH fpathconf 3 2023-10-31 "Linux man-pages 6.06" +.TH fpathconf 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fpathconf, pathconf \- get configuration values for files .SH LIBRARY diff --git a/upstream/archlinux/man3/fpclassify.3 b/upstream/archlinux/man3/fpclassify.3 index a520dd07..f3a47893 100644 --- a/upstream/archlinux/man3/fpclassify.3 +++ b/upstream/archlinux/man3/fpclassify.3 @@ -6,7 +6,7 @@ .\" This was done with the help of the glibc manual. .\" .\" 2004-10-31, aeb, corrected -.TH fpclassify 3 2023-10-31 "Linux man-pages 6.06" +.TH fpclassify 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fpclassify, isfinite, isnormal, isnan, isinf \- floating-point classification macros diff --git a/upstream/archlinux/man3/fpurge.3 b/upstream/archlinux/man3/fpurge.3 index 996cd9c4..3967cb1a 100644 --- a/upstream/archlinux/man3/fpurge.3 +++ b/upstream/archlinux/man3/fpurge.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH fpurge 3 2023-10-31 "Linux man-pages 6.06" +.TH fpurge 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fpurge, __fpurge \- purge a stream .SH LIBRARY diff --git a/upstream/archlinux/man3/fputwc.3 b/upstream/archlinux/man3/fputwc.3 index 816feeba..d6c252c9 100644 --- a/upstream/archlinux/man3/fputwc.3 +++ b/upstream/archlinux/man3/fputwc.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH fputwc 3 2023-10-31 "Linux man-pages 6.06" +.TH fputwc 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fputwc, putwc \- write a wide character to a FILE stream .SH LIBRARY diff --git a/upstream/archlinux/man3/fputws.3 b/upstream/archlinux/man3/fputws.3 index 7db42a9e..4b66bac8 100644 --- a/upstream/archlinux/man3/fputws.3 +++ b/upstream/archlinux/man3/fputws.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH fputws 3 2023-10-31 "Linux man-pages 6.06" +.TH fputws 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fputws \- write a wide-character string to a FILE stream .SH LIBRARY diff --git a/upstream/archlinux/man3/fread.3 b/upstream/archlinux/man3/fread.3 index f89c1742..2224d151 100644 --- a/upstream/archlinux/man3/fread.3 +++ b/upstream/archlinux/man3/fread.3 @@ -16,7 +16,7 @@ .\" Modified Thu Apr 20 20:43:53 1995 by Jim Van Zandt <jrv@vanzandt.mv.com> .\" Modified Fri May 17 10:21:51 1996 by Martin Schulze <joey@infodrom.north.de> .\" -.TH fread 3 2023-10-31 "Linux man-pages 6.06" +.TH fread 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fread, fwrite \- binary stream input/output .SH LIBRARY diff --git a/upstream/archlinux/man3/frexp.3 b/upstream/archlinux/man3/frexp.3 index 30e16a8b..a10d7266 100644 --- a/upstream/archlinux/man3/frexp.3 +++ b/upstream/archlinux/man3/frexp.3 @@ -11,7 +11,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH frexp 3 2024-01-29 "Linux man-pages 6.06" +.TH frexp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME frexp, frexpf, frexpl \- convert floating-point number to fractional and integral components diff --git a/upstream/archlinux/man3/fseek.3 b/upstream/archlinux/man3/fseek.3 index 3217f03f..05a3bc79 100644 --- a/upstream/archlinux/man3/fseek.3 +++ b/upstream/archlinux/man3/fseek.3 @@ -12,7 +12,7 @@ .\" .\" Converted for Linux, Mon Nov 29 15:22:01 1993, faith@cs.unc.edu .\" -.TH fseek 3 2023-10-31 "Linux man-pages 6.06" +.TH fseek 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fgetpos, fseek, fsetpos, ftell, rewind \- reposition a stream .SH LIBRARY diff --git a/upstream/archlinux/man3/fseeko.3 b/upstream/archlinux/man3/fseeko.3 index 9d4e631f..0b1a089f 100644 --- a/upstream/archlinux/man3/fseeko.3 +++ b/upstream/archlinux/man3/fseeko.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH fseeko 3 2023-10-31 "Linux man-pages 6.06" +.TH fseeko 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fseeko, ftello \- seek to or report file position .SH LIBRARY diff --git a/upstream/archlinux/man3/ftime.3 b/upstream/archlinux/man3/ftime.3 index c7b78538..1f8a96ed 100644 --- a/upstream/archlinux/man3/ftime.3 +++ b/upstream/archlinux/man3/ftime.3 @@ -9,7 +9,7 @@ .\" Modified Sun Oct 18 17:31:43 1998 by Andries Brouwer (aeb@cwi.nl) .\" 2008-06-23, mtk, minor rewrites, added some details .\" -.TH ftime 3 2023-10-31 "Linux man-pages 6.06" +.TH ftime 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ftime \- return date and time .SH LIBRARY diff --git a/upstream/archlinux/man3/ftok.3 b/upstream/archlinux/man3/ftok.3 index 781a2569..38689fdf 100644 --- a/upstream/archlinux/man3/ftok.3 +++ b/upstream/archlinux/man3/ftok.3 @@ -7,7 +7,7 @@ .\" Changed data type of proj_id; minor fixes .\" aeb: further fixes; added notes. .\" -.TH ftok 3 2023-10-31 "Linux man-pages 6.06" +.TH ftok 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ftok \- convert a pathname and a project identifier to a System V IPC key .SH LIBRARY diff --git a/upstream/archlinux/man3/fts.3 b/upstream/archlinux/man3/fts.3 index a67d94d5..332053dc 100644 --- a/upstream/archlinux/man3/fts.3 +++ b/upstream/archlinux/man3/fts.3 @@ -10,7 +10,7 @@ .\" .\" 2007-12-08, mtk, Converted from mdoc to man macros .\" -.TH fts 3 2024-01-16 "Linux man-pages 6.06" +.TH fts 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fts, fts_open, fts_read, fts_children, fts_set, fts_close \- \ traverse a file hierarchy diff --git a/upstream/archlinux/man3/ftw.3 b/upstream/archlinux/man3/ftw.3 index 0ca77929..36c63981 100644 --- a/upstream/archlinux/man3/ftw.3 +++ b/upstream/archlinux/man3/ftw.3 @@ -15,7 +15,7 @@ .\" 2006-05-24, Michael Kerrisk <mtk.manpages@gmail.com> .\" Added an example program. .\" -.TH ftw 3 2023-10-31 "Linux man-pages 6.06" +.TH ftw 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ftw, nftw \- file tree walk .SH LIBRARY diff --git a/upstream/archlinux/man3/futimes.3 b/upstream/archlinux/man3/futimes.3 index bb07d039..593dff49 100644 --- a/upstream/archlinux/man3/futimes.3 +++ b/upstream/archlinux/man3/futimes.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH futimes 3 2023-10-31 "Linux man-pages 6.06" +.TH futimes 3 2024-05-02 "Linux man-pages 6.8" .SH NAME futimes, lutimes \- change file timestamps .SH LIBRARY diff --git a/upstream/archlinux/man3/fwide.3 b/upstream/archlinux/man3/fwide.3 index 04944ddb..b12387c5 100644 --- a/upstream/archlinux/man3/fwide.3 +++ b/upstream/archlinux/man3/fwide.3 @@ -8,7 +8,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH fwide 3 2023-10-31 "Linux man-pages 6.06" +.TH fwide 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fwide \- set and determine the orientation of a FILE stream .SH LIBRARY diff --git a/upstream/archlinux/man3/gamma.3 b/upstream/archlinux/man3/gamma.3 index c1a1589d..db30404d 100644 --- a/upstream/archlinux/man3/gamma.3 +++ b/upstream/archlinux/man3/gamma.3 @@ -5,7 +5,7 @@ .\" .\" Modified 2003-11-18, aeb: historical remarks .\" -.TH gamma 3 2023-10-31 "Linux man-pages 6.06" +.TH gamma 3 2024-05-02 "Linux man-pages 6.8" .SH NAME gamma, gammaf, gammal \- (logarithm of the) gamma function .SH LIBRARY diff --git a/upstream/archlinux/man3/gcvt.3 b/upstream/archlinux/man3/gcvt.3 index 5945e78c..c6422cfe 100644 --- a/upstream/archlinux/man3/gcvt.3 +++ b/upstream/archlinux/man3/gcvt.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 19:32:25 1993 by Rik Faith (faith@cs.unc.edu) -.TH gcvt 3 2023-10-31 "Linux man-pages 6.06" +.TH gcvt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME gcvt \- convert a floating-point number to a string .SH LIBRARY diff --git a/upstream/archlinux/man3/get_nprocs.3 b/upstream/archlinux/man3/get_nprocs.3 index 3cc99d7f..15996777 100644 --- a/upstream/archlinux/man3/get_nprocs.3 +++ b/upstream/archlinux/man3/get_nprocs.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH get_nprocs 3 2023-10-31 "Linux man-pages 6.06" +.TH get_nprocs 3 2024-05-02 "Linux man-pages 6.8" .SH NAME get_nprocs, get_nprocs_conf \- get number of processors .SH LIBRARY diff --git a/upstream/archlinux/man3/get_phys_pages.3 b/upstream/archlinux/man3/get_phys_pages.3 index 6ace9a7a..8a9d07c2 100644 --- a/upstream/archlinux/man3/get_phys_pages.3 +++ b/upstream/archlinux/man3/get_phys_pages.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH get_phys_pages 3 2023-10-31 "Linux man-pages 6.06" +.TH get_phys_pages 3 2024-05-02 "Linux man-pages 6.8" .SH NAME get_phys_pages, get_avphys_pages \- get total and available physical page counts diff --git a/upstream/archlinux/man3/getaddrinfo.3 b/upstream/archlinux/man3/getaddrinfo.3 index 7b421486..c0749fbf 100644 --- a/upstream/archlinux/man3/getaddrinfo.3 +++ b/upstream/archlinux/man3/getaddrinfo.3 @@ -22,7 +22,7 @@ .\" FIXME . glibc's 2.9 NEWS file documents DCCP and UDP-lite support .\" and is SCTP support now also there? .\" -.TH getaddrinfo 3 2023-10-31 "Linux man-pages 6.06" +.TH getaddrinfo 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getaddrinfo, freeaddrinfo, gai_strerror \- network address and service translation @@ -501,7 +501,7 @@ contains invalid flags; or, included .B AI_CANONNAME and -.I name +.I node was NULL. .TP .B EAI_FAIL diff --git a/upstream/archlinux/man3/getaddrinfo_a.3 b/upstream/archlinux/man3/getaddrinfo_a.3 index fa1b6c3b..d5936907 100644 --- a/upstream/archlinux/man3/getaddrinfo_a.3 +++ b/upstream/archlinux/man3/getaddrinfo_a.3 @@ -8,7 +8,7 @@ .\" References: http://people.redhat.com/drepper/asynchnl.pdf, .\" http://www.imperialviolet.org/2005/06/01/asynchronous-dns-lookups-with-glibc.html .\" -.TH getaddrinfo_a 3 2023-10-31 "Linux man-pages 6.06" +.TH getaddrinfo_a 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getaddrinfo_a, gai_suspend, gai_error, gai_cancel \- asynchronous network address and service translation diff --git a/upstream/archlinux/man3/getauxval.3 b/upstream/archlinux/man3/getauxval.3 index d4fbc1e8..1b53fe65 100644 --- a/upstream/archlinux/man3/getauxval.3 +++ b/upstream/archlinux/man3/getauxval.3 @@ -5,7 +5,7 @@ .\" .\" See also https://lwn.net/Articles/519085/ .\" -.TH getauxval 3 2023-10-31 "Linux man-pages 6.06" +.TH getauxval 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getauxval \- retrieve a value from the auxiliary vector .SH LIBRARY diff --git a/upstream/archlinux/man3/getcontext.3 b/upstream/archlinux/man3/getcontext.3 index 246d3dfc..40f01f71 100644 --- a/upstream/archlinux/man3/getcontext.3 +++ b/upstream/archlinux/man3/getcontext.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH getcontext 3 2023-10-31 "Linux man-pages 6.06" +.TH getcontext 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getcontext, setcontext \- get or set the user context .SH LIBRARY diff --git a/upstream/archlinux/man3/getcwd.3 b/upstream/archlinux/man3/getcwd.3 index db0f981d..d054dc49 100644 --- a/upstream/archlinux/man3/getcwd.3 +++ b/upstream/archlinux/man3/getcwd.3 @@ -10,7 +10,7 @@ .\" Modified Mon Dec 11 13:32:51 MET 2000 by aeb .\" Modified Thu Apr 22 03:49:15 CEST 2002 by Roger Luethi <rl@hellgate.ch> .\" -.TH getcwd 3 2023-10-31 "Linux man-pages 6.06" +.TH getcwd 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getcwd, getwd, get_current_dir_name \- get current working directory .SH LIBRARY diff --git a/upstream/archlinux/man3/getdate.3 b/upstream/archlinux/man3/getdate.3 index abb4480f..cc838bcc 100644 --- a/upstream/archlinux/man3/getdate.3 +++ b/upstream/archlinux/man3/getdate.3 @@ -8,7 +8,7 @@ .\" Modified, 2001-12-26, aeb .\" 2008-09-07, mtk, Various rewrites; added an example program. .\" -.TH getdate 3 2023-10-31 "Linux man-pages 6.06" +.TH getdate 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getdate, getdate_r \- convert a date-plus-time string to broken-down time .SH LIBRARY diff --git a/upstream/archlinux/man3/getdirentries.3 b/upstream/archlinux/man3/getdirentries.3 index 48c29037..e55b510d 100644 --- a/upstream/archlinux/man3/getdirentries.3 +++ b/upstream/archlinux/man3/getdirentries.3 @@ -5,7 +5,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH getdirentries 3 2023-10-31 "Linux man-pages 6.06" +.TH getdirentries 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getdirentries \- get directory entries in a filesystem-independent format .SH LIBRARY diff --git a/upstream/archlinux/man3/getdtablesize.3 b/upstream/archlinux/man3/getdtablesize.3 index b938a4c6..45dd0992 100644 --- a/upstream/archlinux/man3/getdtablesize.3 +++ b/upstream/archlinux/man3/getdtablesize.3 @@ -5,7 +5,7 @@ .\" .\" Modified 2002-04-15 by Roger Luethi <rl@hellgate.ch> and aeb .\" -.TH getdtablesize 3 2023-10-31 "Linux man-pages 6.06" +.TH getdtablesize 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getdtablesize \- get file descriptor table size .SH LIBRARY diff --git a/upstream/archlinux/man3/getentropy.3 b/upstream/archlinux/man3/getentropy.3 index 7d6c5aba..828eab6c 100644 --- a/upstream/archlinux/man3/getentropy.3 +++ b/upstream/archlinux/man3/getentropy.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH getentropy 3 2023-10-31 "Linux man-pages 6.06" +.TH getentropy 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getentropy \- fill a buffer with random bytes .SH LIBRARY diff --git a/upstream/archlinux/man3/getenv.3 b/upstream/archlinux/man3/getenv.3 index 5e4280f3..712a6287 100644 --- a/upstream/archlinux/man3/getenv.3 +++ b/upstream/archlinux/man3/getenv.3 @@ -11,7 +11,7 @@ .\" Modified Sat Jul 24 19:30:29 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Fri Feb 14 21:47:50 1997 by Andries Brouwer (aeb@cwi.nl) .\" -.TH getenv 3 2023-10-31 "Linux man-pages 6.06" +.TH getenv 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getenv, secure_getenv \- get an environment variable .SH LIBRARY diff --git a/upstream/archlinux/man3/getfsent.3 b/upstream/archlinux/man3/getfsent.3 index d866e4b7..a6761871 100644 --- a/upstream/archlinux/man3/getfsent.3 +++ b/upstream/archlinux/man3/getfsent.3 @@ -5,7 +5,7 @@ .\" .\" Inspired by a page written by Walter Harms. .\" -.TH getfsent 3 2023-10-31 "Linux man-pages 6.06" +.TH getfsent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getfsent, getfsspec, getfsfile, setfsent, endfsent \- handle fstab entries .SH LIBRARY diff --git a/upstream/archlinux/man3/getgrent.3 b/upstream/archlinux/man3/getgrent.3 index f9abfdcb..c12143a2 100644 --- a/upstream/archlinux/man3/getgrent.3 +++ b/upstream/archlinux/man3/getgrent.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 19:29:54 1993 by Rik Faith (faith@cs.unc.edu) -.TH getgrent 3 2023-10-31 "Linux man-pages 6.06" +.TH getgrent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getgrent, setgrent, endgrent \- get group file entry .SH LIBRARY diff --git a/upstream/archlinux/man3/getgrent_r.3 b/upstream/archlinux/man3/getgrent_r.3 index 80ef3539..c83b9429 100644 --- a/upstream/archlinux/man3/getgrent_r.3 +++ b/upstream/archlinux/man3/getgrent_r.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH getgrent_r 3 2023-10-31 "Linux man-pages 6.06" +.TH getgrent_r 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getgrent_r, fgetgrent_r \- get group file entry reentrantly .SH LIBRARY diff --git a/upstream/archlinux/man3/getgrnam.3 b/upstream/archlinux/man3/getgrnam.3 index 81eb1398..51bf188d 100644 --- a/upstream/archlinux/man3/getgrnam.3 +++ b/upstream/archlinux/man3/getgrnam.3 @@ -11,7 +11,7 @@ .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu) .\" Modified 2003-11-15 by aeb .\" -.TH getgrnam 3 2023-10-31 "Linux man-pages 6.06" +.TH getgrnam 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getgrnam, getgrnam_r, getgrgid, getgrgid_r \- get group file entry .SH LIBRARY diff --git a/upstream/archlinux/man3/getgrouplist.3 b/upstream/archlinux/man3/getgrouplist.3 index 2852a9e2..8b86cbec 100644 --- a/upstream/archlinux/man3/getgrouplist.3 +++ b/upstream/archlinux/man3/getgrouplist.3 @@ -7,7 +7,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH getgrouplist 3 2023-10-31 "Linux man-pages 6.06" +.TH getgrouplist 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getgrouplist \- get list of groups to which a user belongs .SH LIBRARY @@ -134,6 +134,7 @@ ngroups = 3 \& .\" SRC BEGIN (getgrouplist.c) .EX +#include <errno.h> #include <grp.h> #include <pwd.h> #include <stdio.h> @@ -142,10 +143,10 @@ ngroups = 3 int main(int argc, char *argv[]) { - int ngroups; - struct passwd *pw; - struct group *gr; - gid_t *groups; + int ngroups; + gid_t *groups; + struct group *gr; + struct passwd *pw; \& if (argc != 3) { fprintf(stderr, "Usage: %s <user> <ngroups>\en", argv[0]); @@ -162,10 +163,14 @@ main(int argc, char *argv[]) \& /* Fetch passwd structure (contains first group ID for user). */ \& + errno = 0; pw = getpwnam(argv[1]); if (pw == NULL) { - perror("getpwnam"); - exit(EXIT_SUCCESS); + if (errno) + perror("getpwnam"); + else + fprintf(stderr, "no such user\en"); + exit(EXIT_FAILURE); } \& /* Retrieve group list. */ @@ -179,7 +184,7 @@ main(int argc, char *argv[]) /* Display list of retrieved groups, along with group names. */ \& fprintf(stderr, "ngroups = %d\en", ngroups); - for (size_t j = 0; j < ngroups; j++) { + for (int j = 0; j < ngroups; j++) { printf("%d", groups[j]); gr = getgrgid(groups[j]); if (gr != NULL) diff --git a/upstream/archlinux/man3/gethostbyname.3 b/upstream/archlinux/man3/gethostbyname.3 index a9d1dacb..a36726bc 100644 --- a/upstream/archlinux/man3/gethostbyname.3 +++ b/upstream/archlinux/man3/gethostbyname.3 @@ -16,7 +16,7 @@ .\" Modified 2002-08-05, Michael Kerrisk .\" Modified 2004-10-31, Andries Brouwer .\" -.TH gethostbyname 3 2023-10-31 "Linux man-pages 6.06" +.TH gethostbyname 3 2024-05-02 "Linux man-pages 6.8" .SH NAME gethostbyname, gethostbyaddr, sethostent, gethostent, endhostent, h_errno, diff --git a/upstream/archlinux/man3/gethostid.3 b/upstream/archlinux/man3/gethostid.3 index 13246b3b..22275b87 100644 --- a/upstream/archlinux/man3/gethostid.3 +++ b/upstream/archlinux/man3/gethostid.3 @@ -7,7 +7,7 @@ .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" Modified Tue Oct 22 00:22:35 EDT 1996 by Eric S. Raymond <esr@thyrsus.com> -.TH gethostid 3 2023-10-31 "Linux man-pages 6.06" +.TH gethostid 3 2024-05-02 "Linux man-pages 6.8" .SH NAME gethostid, sethostid \- get or set the unique identifier of the current host .SH LIBRARY diff --git a/upstream/archlinux/man3/getifaddrs.3 b/upstream/archlinux/man3/getifaddrs.3 index b8146be5..e9389139 100644 --- a/upstream/archlinux/man3/getifaddrs.3 +++ b/upstream/archlinux/man3/getifaddrs.3 @@ -14,7 +14,7 @@ .\" for glibc specificities, provide an example. .\" 2009-01-14 mtk, many edits and changes, rewrote example program. .\" -.TH getifaddrs 3 2023-10-31 "Linux man-pages 6.06" +.TH getifaddrs 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getifaddrs, freeifaddrs \- get interface addresses .SH LIBRARY diff --git a/upstream/archlinux/man3/getipnodebyname.3 b/upstream/archlinux/man3/getipnodebyname.3 index a336a2a7..5aefa12a 100644 --- a/upstream/archlinux/man3/getipnodebyname.3 +++ b/upstream/archlinux/man3/getipnodebyname.3 @@ -3,7 +3,7 @@ .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" References: RFC 2553 -.TH getipnodebyname 3 2023-10-31 "Linux man-pages 6.06" +.TH getipnodebyname 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getipnodebyname, getipnodebyaddr, freehostent \- get network hostnames and addresses diff --git a/upstream/archlinux/man3/getline.3 b/upstream/archlinux/man3/getline.3 index 863860f8..ce6cf0a6 100644 --- a/upstream/archlinux/man3/getline.3 +++ b/upstream/archlinux/man3/getline.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH getline 3 2023-10-31 "Linux man-pages 6.06" +.TH getline 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getline, getdelim \- delimited string input .SH LIBRARY diff --git a/upstream/archlinux/man3/getloadavg.3 b/upstream/archlinux/man3/getloadavg.3 index 643b7f90..067f399a 100644 --- a/upstream/archlinux/man3/getloadavg.3 +++ b/upstream/archlinux/man3/getloadavg.3 @@ -8,7 +8,7 @@ .\" .\" 2007-12-08, mtk, Converted from mdoc to man macros .\" -.TH getloadavg 3 2023-10-31 "Linux man-pages 6.06" +.TH getloadavg 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getloadavg \- get system load averages .SH LIBRARY diff --git a/upstream/archlinux/man3/getlogin.3 b/upstream/archlinux/man3/getlogin.3 index 48ec6344..0178d567 100644 --- a/upstream/archlinux/man3/getlogin.3 +++ b/upstream/archlinux/man3/getlogin.3 @@ -6,7 +6,7 @@ .\" Changed Tue Sep 19 01:49:29 1995, aeb: moved from man2 to man3 .\" added ref to /etc/utmp, added BUGS section, etc. .\" modified 2003 Walter Harms, aeb - added getlogin_r, note on stdin use -.TH getlogin 3 2023-10-31 "Linux man-pages 6.06" +.TH getlogin 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getlogin, getlogin_r, cuserid \- get username .SH LIBRARY diff --git a/upstream/archlinux/man3/getmntent.3 b/upstream/archlinux/man3/getmntent.3 index 67fb0925..c5dff1b7 100644 --- a/upstream/archlinux/man3/getmntent.3 +++ b/upstream/archlinux/man3/getmntent.3 @@ -10,7 +10,7 @@ .\" Modified Sat Jul 24 21:46:57 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified 961109, 031115, aeb .\" -.TH getmntent 3 2023-10-31 "Linux man-pages 6.06" +.TH getmntent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getmntent, setmntent, addmntent, endmntent, hasmntopt, getmntent_r \- get filesystem descriptor file entry diff --git a/upstream/archlinux/man3/getnameinfo.3 b/upstream/archlinux/man3/getnameinfo.3 index ed2c4f9e..96ac15ad 100644 --- a/upstream/archlinux/man3/getnameinfo.3 +++ b/upstream/archlinux/man3/getnameinfo.3 @@ -8,7 +8,7 @@ .\" 2004-12-14, mtk, Added EAI_OVERFLOW error .\" 2004-12-14 Fixed description of error return .\" -.TH getnameinfo 3 2023-10-31 "Linux man-pages 6.06" +.TH getnameinfo 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getnameinfo \- address-to-name translation in protocol-independent manner .SH LIBRARY diff --git a/upstream/archlinux/man3/getnetent.3 b/upstream/archlinux/man3/getnetent.3 index cbfaadea..9f1308f7 100644 --- a/upstream/archlinux/man3/getnetent.3 +++ b/upstream/archlinux/man3/getnetent.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 21:48:06 1993 by Rik Faith (faith@cs.unc.edu) -.TH getnetent 3 2023-10-31 "Linux man-pages 6.06" +.TH getnetent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getnetent, getnetbyname, getnetbyaddr, setnetent, endnetent \- get network entry diff --git a/upstream/archlinux/man3/getnetent_r.3 b/upstream/archlinux/man3/getnetent_r.3 index e3021430..05674a5b 100644 --- a/upstream/archlinux/man3/getnetent_r.3 +++ b/upstream/archlinux/man3/getnetent_r.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH getnetent_r 3 2023-10-31 "Linux man-pages 6.06" +.TH getnetent_r 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getnetent_r, getnetbyname_r, getnetbyaddr_r \- get network entry (reentrant) diff --git a/upstream/archlinux/man3/getopt.3 b/upstream/archlinux/man3/getopt.3 index d3a1bc93..370ec878 100644 --- a/upstream/archlinux/man3/getopt.3 +++ b/upstream/archlinux/man3/getopt.3 @@ -20,7 +20,7 @@ .\" the start of optstring .\" Modified 2006-12-15, mtk, Added getopt() example program. .\" -.TH getopt 3 2023-10-31 "Linux man-pages 6.06" +.TH getopt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getopt, getopt_long, getopt_long_only, optarg, optind, opterr, optopt \- Parse command-line options diff --git a/upstream/archlinux/man3/getpass.3 b/upstream/archlinux/man3/getpass.3 index 661693f7..eb725137 100644 --- a/upstream/archlinux/man3/getpass.3 +++ b/upstream/archlinux/man3/getpass.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH getpass 3 2023-10-31 "Linux man-pages 6.06" +.TH getpass 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getpass \- get a password .SH LIBRARY diff --git a/upstream/archlinux/man3/getprotoent.3 b/upstream/archlinux/man3/getprotoent.3 index c65939b5..3e5728e1 100644 --- a/upstream/archlinux/man3/getprotoent.3 +++ b/upstream/archlinux/man3/getprotoent.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 19:26:03 1993 by Rik Faith (faith@cs.unc.edu) -.TH getprotoent 3 2023-10-31 "Linux man-pages 6.06" +.TH getprotoent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getprotoent, getprotobyname, getprotobynumber, setprotoent, endprotoent \- get protocol entry diff --git a/upstream/archlinux/man3/getprotoent_r.3 b/upstream/archlinux/man3/getprotoent_r.3 index 0868e79e..ab92316e 100644 --- a/upstream/archlinux/man3/getprotoent_r.3 +++ b/upstream/archlinux/man3/getprotoent_r.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH getprotoent_r 3 2023-10-31 "Linux man-pages 6.06" +.TH getprotoent_r 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getprotoent_r, getprotobyname_r, getprotobynumber_r \- get protocol entry (reentrant) diff --git a/upstream/archlinux/man3/getpt.3 b/upstream/archlinux/man3/getpt.3 index 3483495e..4060c1fc 100644 --- a/upstream/archlinux/man3/getpt.3 +++ b/upstream/archlinux/man3/getpt.3 @@ -5,7 +5,7 @@ .\" Redistribute and modify at will. .\" %%%LICENSE_END .\" -.TH getpt 3 2023-10-31 "Linux man-pages 6.06" +.TH getpt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getpt \- open a new pseudoterminal master .SH LIBRARY diff --git a/upstream/archlinux/man3/getpw.3 b/upstream/archlinux/man3/getpw.3 index 544dcaeb..c1af4dae 100644 --- a/upstream/archlinux/man3/getpw.3 +++ b/upstream/archlinux/man3/getpw.3 @@ -10,7 +10,7 @@ .\" Modified Sat Jul 24 19:23:25 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Mon May 27 21:37:47 1996 by Martin Schulze (joey@linux.de) .\" -.TH getpw 3 2023-10-31 "Linux man-pages 6.06" +.TH getpw 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getpw \- reconstruct password line entry .SH LIBRARY diff --git a/upstream/archlinux/man3/getpwent.3 b/upstream/archlinux/man3/getpwent.3 index 0e34f603..a62519fc 100644 --- a/upstream/archlinux/man3/getpwent.3 +++ b/upstream/archlinux/man3/getpwent.3 @@ -11,7 +11,7 @@ .\" Modified Sat Jul 24 19:22:14 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Mon May 27 21:37:47 1996 by Martin Schulze (joey@linux.de) .\" -.TH getpwent 3 2023-10-31 "Linux man-pages 6.06" +.TH getpwent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getpwent, setpwent, endpwent \- get password file entry .SH LIBRARY diff --git a/upstream/archlinux/man3/getpwent_r.3 b/upstream/archlinux/man3/getpwent_r.3 index 5cdbec48..2c2f38de 100644 --- a/upstream/archlinux/man3/getpwent_r.3 +++ b/upstream/archlinux/man3/getpwent_r.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH getpwent_r 3 2023-10-31 "Linux man-pages 6.06" +.TH getpwent_r 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getpwent_r, fgetpwent_r \- get passwd file entry reentrantly .SH LIBRARY diff --git a/upstream/archlinux/man3/getpwnam.3 b/upstream/archlinux/man3/getpwnam.3 index 9d13d032..41851600 100644 --- a/upstream/archlinux/man3/getpwnam.3 +++ b/upstream/archlinux/man3/getpwnam.3 @@ -15,7 +15,7 @@ .\" Modified 2003-11-15 by aeb .\" 2008-11-07, mtk, Added an example program for getpwnam_r(). .\" -.TH getpwnam 3 2023-10-31 "Linux man-pages 6.06" +.TH getpwnam 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getpwnam, getpwnam_r, getpwuid, getpwuid_r \- get password file entry .SH LIBRARY diff --git a/upstream/archlinux/man3/getrpcent.3 b/upstream/archlinux/man3/getrpcent.3 index 5193b654..d19f68c0 100644 --- a/upstream/archlinux/man3/getrpcent.3 +++ b/upstream/archlinux/man3/getrpcent.3 @@ -6,7 +6,7 @@ .\" %%%LICENSE_END .\" .\" @(#)getrpcent.3n 2.2 88/08/02 4.0 RPCSRC; from 1.11 88/03/14 SMI -.TH getrpcent 3 2023-10-31 "Linux man-pages 6.06" +.TH getrpcent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getrpcent, getrpcbyname, getrpcbynumber, setrpcent, endrpcent \- get RPC entry diff --git a/upstream/archlinux/man3/getrpcent_r.3 b/upstream/archlinux/man3/getrpcent_r.3 index a2175532..abd3ea07 100644 --- a/upstream/archlinux/man3/getrpcent_r.3 +++ b/upstream/archlinux/man3/getrpcent_r.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH getrpcent_r 3 2023-10-31 "Linux man-pages 6.06" +.TH getrpcent_r 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getrpcent_r, getrpcbyname_r, getrpcbynumber_r \- get RPC entry (reentrant) diff --git a/upstream/archlinux/man3/getrpcport.3 b/upstream/archlinux/man3/getrpcport.3 index 87d20dbd..f0fdc314 100644 --- a/upstream/archlinux/man3/getrpcport.3 +++ b/upstream/archlinux/man3/getrpcport.3 @@ -6,7 +6,7 @@ .\" %%%LICENSE_END .\" .\" @(#)getrpcport.3r 2.2 88/08/02 4.0 RPCSRC; from 1.12 88/02/26 SMI -.TH getrpcport 3 2023-10-31 "Linux man-pages 6.06" +.TH getrpcport 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getrpcport \- get RPC port number .SH LIBRARY diff --git a/upstream/archlinux/man3/gets.3 b/upstream/archlinux/man3/gets.3 index d3e1a306..2640db37 100644 --- a/upstream/archlinux/man3/gets.3 +++ b/upstream/archlinux/man3/gets.3 @@ -7,7 +7,7 @@ .\" Modified Fri Sep 8 15:48:13 1995 by Andries Brouwer (aeb@cwi.nl) .\" Modified 2013-12-31, David Malcolm <dmalcolm@redhat.com> .\" Split gets(3) into its own page; fgetc() et al. move to fgetc(3) -.TH gets 3 2023-10-31 "Linux man-pages 6.06" +.TH gets 3 2024-05-02 "Linux man-pages 6.8" .SH NAME gets \- get a string from standard input (DEPRECATED) .SH LIBRARY diff --git a/upstream/archlinux/man3/getservent.3 b/upstream/archlinux/man3/getservent.3 index 5d52bcb8..98168e4f 100644 --- a/upstream/archlinux/man3/getservent.3 +++ b/upstream/archlinux/man3/getservent.3 @@ -12,7 +12,7 @@ .\" Modified Mon Apr 22 01:50:54 1996 by Martin Schulze <joey@infodrom.north.de> .\" 2001-07-25 added a clause about NULL proto (Martin Michlmayr or David N. Welton) .\" -.TH getservent 3 2023-10-31 "Linux man-pages 6.06" +.TH getservent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getservent, getservbyname, getservbyport, setservent, endservent \- get service entry diff --git a/upstream/archlinux/man3/getservent_r.3 b/upstream/archlinux/man3/getservent_r.3 index 4606a7f8..9cc2f205 100644 --- a/upstream/archlinux/man3/getservent_r.3 +++ b/upstream/archlinux/man3/getservent_r.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH getservent_r 3 2023-10-31 "Linux man-pages 6.06" +.TH getservent_r 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getservent_r, getservbyname_r, getservbyport_r \- get service entry (reentrant) diff --git a/upstream/archlinux/man3/getsubopt.3 b/upstream/archlinux/man3/getsubopt.3 index 7c3e2c4e..713edf8f 100644 --- a/upstream/archlinux/man3/getsubopt.3 +++ b/upstream/archlinux/man3/getsubopt.3 @@ -23,7 +23,7 @@ .\" SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. .\" %%%LICENSE_END .\" -.TH getsubopt 3 2023-10-31 "Linux man-pages 6.06" +.TH getsubopt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getsubopt \- parse suboption arguments from a string .SH LIBRARY diff --git a/upstream/archlinux/man3/gettext.3 b/upstream/archlinux/man3/gettext.3 index 19db8b9d..968ab72f 100644 --- a/upstream/archlinux/man3/gettext.3 +++ b/upstream/archlinux/man3/gettext.3 @@ -10,7 +10,7 @@ .\" GNU gettext source code and manual .\" LI18NUX 2000 Globalization Specification .\" -.TH GETTEXT 3 "May 2001" "GNU gettext 0.22.2" +.TH GETTEXT 3 "May 2001" "GNU gettext 0.22.5" .SH NAME gettext, dgettext, dcgettext \- translate message .SH SYNOPSIS diff --git a/upstream/archlinux/man3/getttyent.3 b/upstream/archlinux/man3/getttyent.3 index 7ed4fd03..fe6c8f35 100644 --- a/upstream/archlinux/man3/getttyent.3 +++ b/upstream/archlinux/man3/getttyent.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH getttyent 3 2023-10-31 "Linux man-pages 6.06" +.TH getttyent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getttyent, getttynam, setttyent, endttyent \- get ttys file entry .SH LIBRARY diff --git a/upstream/archlinux/man3/getusershell.3 b/upstream/archlinux/man3/getusershell.3 index 3c2a09f5..a7f6f982 100644 --- a/upstream/archlinux/man3/getusershell.3 +++ b/upstream/archlinux/man3/getusershell.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 19:17:53 1993 by Rik Faith (faith@cs.unc.edu) -.TH getusershell 3 2023-10-31 "Linux man-pages 6.06" +.TH getusershell 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getusershell, setusershell, endusershell \- get permitted user shells .SH LIBRARY diff --git a/upstream/archlinux/man3/getutent.3 b/upstream/archlinux/man3/getutent.3 index d04ebbc3..df7a0205 100644 --- a/upstream/archlinux/man3/getutent.3 +++ b/upstream/archlinux/man3/getutent.3 @@ -10,7 +10,7 @@ .\" Modified Thu Jul 25 14:43:46 MET DST 1996 by Michael Haardt .\" <michael@cantor.informatik.rwth-aachen.de> .\" -.TH getutent 3 2023-10-31 "Linux man-pages 6.06" +.TH getutent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getutent, getutid, getutline, pututline, setutent, endutent, utmpname \- access utmp file entries diff --git a/upstream/archlinux/man3/getutmp.3 b/upstream/archlinux/man3/getutmp.3 index 3b48e875..54eb5d73 100644 --- a/upstream/archlinux/man3/getutmp.3 +++ b/upstream/archlinux/man3/getutmp.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH getutmp 3 2023-10-31 "Linux man-pages 6.06" +.TH getutmp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getutmp, getutmpx \- copy utmp structure to utmpx, and vice versa .SH LIBRARY diff --git a/upstream/archlinux/man3/getw.3 b/upstream/archlinux/man3/getw.3 index 00d0322c..581da937 100644 --- a/upstream/archlinux/man3/getw.3 +++ b/upstream/archlinux/man3/getw.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH getw 3 2023-10-31 "Linux man-pages 6.06" +.TH getw 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getw, putw \- input and output of words (ints) .SH LIBRARY diff --git a/upstream/archlinux/man3/getwchar.3 b/upstream/archlinux/man3/getwchar.3 index 77a421c9..99775e4d 100644 --- a/upstream/archlinux/man3/getwchar.3 +++ b/upstream/archlinux/man3/getwchar.3 @@ -10,7 +10,7 @@ .\" http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH getwchar 3 2023-10-31 "Linux man-pages 6.06" +.TH getwchar 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getwchar \- read a wide character from standard input .SH LIBRARY diff --git a/upstream/archlinux/man3/glob.3 b/upstream/archlinux/man3/glob.3 index 53dacacd..f10ae133 100644 --- a/upstream/archlinux/man3/glob.3 +++ b/upstream/archlinux/man3/glob.3 @@ -12,7 +12,7 @@ .\" Expanded the description of various flags .\" Various wording fixes. .\" -.TH glob 3 2023-10-31 "Linux man-pages 6.06" +.TH glob 3 2024-05-02 "Linux man-pages 6.8" .SH NAME glob, globfree \- find pathnames matching a pattern, free memory from glob() .SH LIBRARY diff --git a/upstream/archlinux/man3/gnu_get_libc_version.3 b/upstream/archlinux/man3/gnu_get_libc_version.3 index b5d23fce..aa85e864 100644 --- a/upstream/archlinux/man3/gnu_get_libc_version.3 +++ b/upstream/archlinux/man3/gnu_get_libc_version.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH gnu_get_libc_version 3 2023-10-31 "Linux man-pages 6.06" +.TH gnu_get_libc_version 3 2024-05-02 "Linux man-pages 6.8" .SH NAME gnu_get_libc_version, gnu_get_libc_release \- get glibc version and release .SH LIBRARY diff --git a/upstream/archlinux/man3/grantpt.3 b/upstream/archlinux/man3/grantpt.3 index 89735e8e..caf95c6b 100644 --- a/upstream/archlinux/man3/grantpt.3 +++ b/upstream/archlinux/man3/grantpt.3 @@ -3,7 +3,7 @@ .\" This page is in the public domain. - aeb .\" %%%LICENSE_END .\" -.TH grantpt 3 2023-10-31 "Linux man-pages 6.06" +.TH grantpt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME grantpt \- grant access to the slave pseudoterminal .SH LIBRARY diff --git a/upstream/archlinux/man3/group_member.3 b/upstream/archlinux/man3/group_member.3 index b6012622..f5089636 100644 --- a/upstream/archlinux/man3/group_member.3 +++ b/upstream/archlinux/man3/group_member.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH group_member 3 2023-10-31 "Linux man-pages 6.06" +.TH group_member 3 2024-05-02 "Linux man-pages 6.8" .SH NAME group_member \- test whether a process is in a group .SH LIBRARY diff --git a/upstream/archlinux/man3/gsignal.3 b/upstream/archlinux/man3/gsignal.3 index 1270baff..e495c235 100644 --- a/upstream/archlinux/man3/gsignal.3 +++ b/upstream/archlinux/man3/gsignal.3 @@ -5,7 +5,7 @@ .\" .\" This replaces an earlier man page written by Walter Harms .\" <walter.harms@informatik.uni-oldenburg.de>. -.TH gsignal 3 2023-10-31 "Linux man-pages 6.06" +.TH gsignal 3 2024-05-02 "Linux man-pages 6.8" .SH NAME gsignal, ssignal \- software signal facility .SH LIBRARY diff --git a/upstream/archlinux/man3/hash.3 b/upstream/archlinux/man3/hash.3 index 5a6d1d7a..decd0055 100644 --- a/upstream/archlinux/man3/hash.3 +++ b/upstream/archlinux/man3/hash.3 @@ -5,7 +5,7 @@ .\" .\" @(#)hash.3 8.6 (Berkeley) 8/18/94 .\" -.TH hash 3 2023-10-31 "Linux man-pages 6.06" +.TH hash 3 2024-05-02 "Linux man-pages 6.8" .UC 7 .SH NAME hash \- hash database access method diff --git a/upstream/archlinux/man3/hsearch.3 b/upstream/archlinux/man3/hsearch.3 index 2c3f7bb4..c902050e 100644 --- a/upstream/archlinux/man3/hsearch.3 +++ b/upstream/archlinux/man3/hsearch.3 @@ -14,7 +14,7 @@ .\" 2008-09-03, mtk, restructured somewhat, in part after suggestions from .\" Timothy S. Nelson <wayland@wayland.id.au> .\" -.TH hsearch 3 2023-10-31 "Linux man-pages 6.06" +.TH hsearch 3 2024-05-02 "Linux man-pages 6.8" .SH NAME hcreate, hdestroy, hsearch, hcreate_r, hdestroy_r, hsearch_r \- hash table management diff --git a/upstream/archlinux/man3/hypot.3 b/upstream/archlinux/man3/hypot.3 index 16b8a85d..0bd705ff 100644 --- a/upstream/archlinux/man3/hypot.3 +++ b/upstream/archlinux/man3/hypot.3 @@ -11,7 +11,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH hypot 3 2023-10-31 "Linux man-pages 6.06" +.TH hypot 3 2024-05-02 "Linux man-pages 6.8" .SH NAME hypot, hypotf, hypotl \- Euclidean distance function .SH LIBRARY diff --git a/upstream/archlinux/man3/i2d_CMS_bio_stream.3ssl b/upstream/archlinux/man3/i2d_CMS_bio_stream.3ssl index 02536ebe..576651f1 100644 --- a/upstream/archlinux/man3/i2d_CMS_bio_stream.3ssl +++ b/upstream/archlinux/man3/i2d_CMS_bio_stream.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "I2D_CMS_BIO_STREAM 3ssl" -.TH I2D_CMS_BIO_STREAM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH I2D_CMS_BIO_STREAM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/i2d_PKCS7_bio_stream.3ssl b/upstream/archlinux/man3/i2d_PKCS7_bio_stream.3ssl index 46a7e97f..ae0665d6 100644 --- a/upstream/archlinux/man3/i2d_PKCS7_bio_stream.3ssl +++ b/upstream/archlinux/man3/i2d_PKCS7_bio_stream.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "I2D_PKCS7_BIO_STREAM 3ssl" -.TH I2D_PKCS7_BIO_STREAM 3ssl 2024-01-30 3.2.1 OpenSSL +.TH I2D_PKCS7_BIO_STREAM 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/i2d_re_X509_tbs.3ssl b/upstream/archlinux/man3/i2d_re_X509_tbs.3ssl index 7c742a1d..171fe242 100644 --- a/upstream/archlinux/man3/i2d_re_X509_tbs.3ssl +++ b/upstream/archlinux/man3/i2d_re_X509_tbs.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "I2D_RE_X509_TBS 3ssl" -.TH I2D_RE_X509_TBS 3ssl 2024-01-30 3.2.1 OpenSSL +.TH I2D_RE_X509_TBS 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/iconv.3 b/upstream/archlinux/man3/iconv.3 index fcd3024a..49c87a3a 100644 --- a/upstream/archlinux/man3/iconv.3 +++ b/upstream/archlinux/man3/iconv.3 @@ -11,7 +11,7 @@ .\" 2000-06-30 correction by Yuichi SATO <sato@complex.eng.hokudai.ac.jp> .\" 2000-11-15 aeb, fixed prototype .\" -.TH iconv 3 2023-10-31 "Linux man-pages 6.06" +.TH iconv 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iconv \- perform character set conversion .SH LIBRARY diff --git a/upstream/archlinux/man3/iconv_close.3 b/upstream/archlinux/man3/iconv_close.3 index b5bb16b8..e5f0009f 100644 --- a/upstream/archlinux/man3/iconv_close.3 +++ b/upstream/archlinux/man3/iconv_close.3 @@ -7,7 +7,7 @@ .\" GNU glibc-2 source code and manual .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" -.TH iconv_close 3 2023-10-31 "Linux man-pages 6.06" +.TH iconv_close 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iconv_close \- deallocate descriptor for character set conversion .SH LIBRARY diff --git a/upstream/archlinux/man3/iconv_open.3 b/upstream/archlinux/man3/iconv_open.3 index 24e18ae9..44fb723e 100644 --- a/upstream/archlinux/man3/iconv_open.3 +++ b/upstream/archlinux/man3/iconv_open.3 @@ -11,7 +11,7 @@ .\" 2007-03-31 Bruno Haible, Describe the glibc/libiconv //TRANSLIT .\" and //IGNORE extensions for 'tocode'. .\" -.TH iconv_open 3 2023-10-31 "Linux man-pages 6.06" +.TH iconv_open 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iconv_open \- allocate descriptor for character set conversion .SH LIBRARY diff --git a/upstream/archlinux/man3/if_nameindex.3 b/upstream/archlinux/man3/if_nameindex.3 index 63f3c10c..af5e030d 100644 --- a/upstream/archlinux/man3/if_nameindex.3 +++ b/upstream/archlinux/man3/if_nameindex.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH if_nameindex 3 2023-10-31 "Linux man-pages 6.06" +.TH if_nameindex 3 2024-05-02 "Linux man-pages 6.8" .SH NAME if_nameindex, if_freenameindex \- get network interface names and indexes .SH LIBRARY diff --git a/upstream/archlinux/man3/if_nametoindex.3 b/upstream/archlinux/man3/if_nametoindex.3 index 87fc5b19..574457c4 100644 --- a/upstream/archlinux/man3/if_nametoindex.3 +++ b/upstream/archlinux/man3/if_nametoindex.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH if_nametoindex 3 2023-10-31 "Linux man-pages 6.06" +.TH if_nametoindex 3 2024-05-02 "Linux man-pages 6.8" .SH NAME if_nametoindex, if_indextoname \- mappings between network interface names and indexes diff --git a/upstream/archlinux/man3/ilogb.3 b/upstream/archlinux/man3/ilogb.3 index c819b085..9a68a5aa 100644 --- a/upstream/archlinux/man3/ilogb.3 +++ b/upstream/archlinux/man3/ilogb.3 @@ -7,7 +7,7 @@ .\" .\" Inspired by a page by Walter Harms created 2002-08-10 .\" -.TH ilogb 3 2023-10-31 "Linux man-pages 6.06" +.TH ilogb 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ilogb, ilogbf, ilogbl \- get integer exponent of a floating-point value .SH LIBRARY diff --git a/upstream/archlinux/man3/index.3 b/upstream/archlinux/man3/index.3 index 94739e8b..6db14991 100644 --- a/upstream/archlinux/man3/index.3 +++ b/upstream/archlinux/man3/index.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH index 3 2023-10-31 "Linux man-pages 6.06" +.TH index 3 2024-05-02 "Linux man-pages 6.8" .SH NAME index, rindex \- locate character in string .SH LIBRARY diff --git a/upstream/archlinux/man3/inet.3 b/upstream/archlinux/man3/inet.3 index e7794341..7cbb9ac9 100644 --- a/upstream/archlinux/man3/inet.3 +++ b/upstream/archlinux/man3/inet.3 @@ -20,7 +20,7 @@ .\" Add discussion of Classful Addressing, noting that it is obsolete. .\" Added an EXAMPLE program. .\" -.TH inet 3 2023-10-31 "Linux man-pages 6.06" +.TH inet 3 2024-05-02 "Linux man-pages 6.8" .SH NAME inet_aton, inet_addr, inet_network, inet_ntoa, inet_makeaddr, inet_lnaof, inet_netof \- Internet address manipulation routines diff --git a/upstream/archlinux/man3/inet_net_pton.3 b/upstream/archlinux/man3/inet_net_pton.3 index 7c1ba43b..ce70caba 100644 --- a/upstream/archlinux/man3/inet_net_pton.3 +++ b/upstream/archlinux/man3/inet_net_pton.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH inet_net_pton 3 2023-10-31 "Linux man-pages 6.06" +.TH inet_net_pton 3 2024-05-02 "Linux man-pages 6.8" .SH NAME inet_net_pton, inet_net_ntop \- Internet network number conversion .SH LIBRARY diff --git a/upstream/archlinux/man3/inet_ntop.3 b/upstream/archlinux/man3/inet_ntop.3 index 9f7df8f6..8c94dea5 100644 --- a/upstream/archlinux/man3/inet_ntop.3 +++ b/upstream/archlinux/man3/inet_ntop.3 @@ -4,7 +4,7 @@ .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" References: RFC 2553 -.TH inet_ntop 3 2023-10-31 "Linux man-pages 6.06" +.TH inet_ntop 3 2024-05-02 "Linux man-pages 6.8" .SH NAME inet_ntop \- convert IPv4 and IPv6 addresses from binary to text form .SH LIBRARY diff --git a/upstream/archlinux/man3/inet_pton.3 b/upstream/archlinux/man3/inet_pton.3 index f3176247..fa82116e 100644 --- a/upstream/archlinux/man3/inet_pton.3 +++ b/upstream/archlinux/man3/inet_pton.3 @@ -5,7 +5,7 @@ .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" References: RFC 2553 -.TH inet_pton 3 2023-10-31 "Linux man-pages 6.06" +.TH inet_pton 3 2024-05-02 "Linux man-pages 6.8" .SH NAME inet_pton \- convert IPv4 and IPv6 addresses from text to binary form .SH LIBRARY diff --git a/upstream/archlinux/man3/initgroups.3 b/upstream/archlinux/man3/initgroups.3 index 7e2fd08b..459ce50f 100644 --- a/upstream/archlinux/man3/initgroups.3 +++ b/upstream/archlinux/man3/initgroups.3 @@ -10,7 +10,7 @@ .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu> .\" Modified 2004-10-10 by aeb .\" -.TH initgroups 3 2023-10-31 "Linux man-pages 6.06" +.TH initgroups 3 2024-05-02 "Linux man-pages 6.8" .SH NAME initgroups \- initialize the supplementary group access list .SH LIBRARY diff --git a/upstream/archlinux/man3/insque.3 b/upstream/archlinux/man3/insque.3 index 49504941..eeddc2da 100644 --- a/upstream/archlinux/man3/insque.3 +++ b/upstream/archlinux/man3/insque.3 @@ -14,7 +14,7 @@ .\" mtk, 2010-09-09: Noted glibc 2.4 bug, added info on circular .\" lists, added example program .\" -.TH insque 3 2023-10-31 "Linux man-pages 6.06" +.TH insque 3 2024-05-02 "Linux man-pages 6.8" .SH NAME insque, remque \- insert/remove an item from a queue .SH LIBRARY diff --git a/upstream/archlinux/man3/intro.3 b/upstream/archlinux/man3/intro.3 index e9f0e0e7..8a7f420f 100644 --- a/upstream/archlinux/man3/intro.3 +++ b/upstream/archlinux/man3/intro.3 @@ -3,7 +3,7 @@ .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" 2007-10-23 mtk, Nearly a complete rewrite of the earlier page. -.TH intro 3 2023-10-31 "Linux man-pages 6.06" +.TH intro 3 2024-05-02 "Linux man-pages 6.8" .SH NAME intro \- introduction to library functions .SH DESCRIPTION diff --git a/upstream/archlinux/man3/isalpha.3 b/upstream/archlinux/man3/isalpha.3 index 076ab191..0ee417f8 100644 --- a/upstream/archlinux/man3/isalpha.3 +++ b/upstream/archlinux/man3/isalpha.3 @@ -8,7 +8,7 @@ .\" Modified Sat Sep 2 21:52:01 1995 by Jim Van Zandt <jrv@vanzandt.mv.com> .\" Modified Mon May 27 22:55:26 1996 by Martin Schulze (joey@linux.de) .\" -.TH isalpha 3 2023-10-31 "Linux man-pages 6.06" +.TH isalpha 3 2024-05-02 "Linux man-pages 6.8" .SH NAME isalnum, isalpha, isascii, isblank, iscntrl, isdigit, isgraph, islower, isprint, ispunct, isspace, isupper, isxdigit, @@ -170,9 +170,9 @@ alphanumeric character. .BR isspace () checks for white-space characters. In the -.B """C""" +.B \[dq]C\[dq] and -.B """POSIX""" +.B \[dq]POSIX\[dq] locales, these are: space, form-feed .RB ( \[aq]\ef\[aq] ), newline diff --git a/upstream/archlinux/man3/isatty.3 b/upstream/archlinux/man3/isatty.3 index 13933e3b..5141b03b 100644 --- a/upstream/archlinux/man3/isatty.3 +++ b/upstream/archlinux/man3/isatty.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH isatty 3 2023-10-31 "Linux man-pages 6.06" +.TH isatty 3 2024-05-02 "Linux man-pages 6.8" .SH NAME isatty \- test whether a file descriptor refers to a terminal .SH LIBRARY diff --git a/upstream/archlinux/man3/isfdtype.3 b/upstream/archlinux/man3/isfdtype.3 index f5b64bb3..53b80d39 100644 --- a/upstream/archlinux/man3/isfdtype.3 +++ b/upstream/archlinux/man3/isfdtype.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH isfdtype 3 2023-10-31 "Linux man-pages 6.06" +.TH isfdtype 3 2024-05-02 "Linux man-pages 6.8" .SH NAME isfdtype \- test file type of a file descriptor .SH LIBRARY diff --git a/upstream/archlinux/man3/isgreater.3 b/upstream/archlinux/man3/isgreater.3 index 82dff9b5..c7e1726b 100644 --- a/upstream/archlinux/man3/isgreater.3 +++ b/upstream/archlinux/man3/isgreater.3 @@ -6,7 +6,7 @@ .\" 2002-07-27 Walter Harms .\" this was done with the help of the glibc manual .\" -.TH isgreater 3 2023-10-31 "Linux man-pages 6.06" +.TH isgreater 3 2024-05-02 "Linux man-pages 6.8" .SH NAME isgreater, isgreaterequal, isless, islessequal, islessgreater, isunordered \- floating-point relational tests without exception for NaN diff --git a/upstream/archlinux/man3/iswalnum.3 b/upstream/archlinux/man3/iswalnum.3 index fae45e35..f6699a62 100644 --- a/upstream/archlinux/man3/iswalnum.3 +++ b/upstream/archlinux/man3/iswalnum.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH iswalnum 3 2023-10-31 "Linux man-pages 6.06" +.TH iswalnum 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iswalnum \- test for alphanumeric wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/iswalpha.3 b/upstream/archlinux/man3/iswalpha.3 index 2f0d74f7..28084bed 100644 --- a/upstream/archlinux/man3/iswalpha.3 +++ b/upstream/archlinux/man3/iswalpha.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH iswalpha 3 2023-10-31 "Linux man-pages 6.06" +.TH iswalpha 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iswalpha \- test for alphabetic wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/iswblank.3 b/upstream/archlinux/man3/iswblank.3 index fc6d96d9..b381ae2a 100644 --- a/upstream/archlinux/man3/iswblank.3 +++ b/upstream/archlinux/man3/iswblank.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH iswblank 3 2023-10-31 "Linux man-pages 6.06" +.TH iswblank 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iswblank \- test for whitespace wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/iswcntrl.3 b/upstream/archlinux/man3/iswcntrl.3 index 3f8fc550..a45207d7 100644 --- a/upstream/archlinux/man3/iswcntrl.3 +++ b/upstream/archlinux/man3/iswcntrl.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH iswcntrl 3 2023-10-31 "Linux man-pages 6.06" +.TH iswcntrl 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iswcntrl \- test for control wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/iswctype.3 b/upstream/archlinux/man3/iswctype.3 index 177f8120..16db5a76 100644 --- a/upstream/archlinux/man3/iswctype.3 +++ b/upstream/archlinux/man3/iswctype.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH iswctype 3 2023-10-31 "Linux man-pages 6.06" +.TH iswctype 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iswctype \- wide-character classification .SH LIBRARY diff --git a/upstream/archlinux/man3/iswdigit.3 b/upstream/archlinux/man3/iswdigit.3 index 07226801..1346987b 100644 --- a/upstream/archlinux/man3/iswdigit.3 +++ b/upstream/archlinux/man3/iswdigit.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH iswdigit 3 2023-10-31 "Linux man-pages 6.06" +.TH iswdigit 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iswdigit \- test for decimal digit wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/iswgraph.3 b/upstream/archlinux/man3/iswgraph.3 index 5a7e145c..f07e3ef7 100644 --- a/upstream/archlinux/man3/iswgraph.3 +++ b/upstream/archlinux/man3/iswgraph.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH iswgraph 3 2023-10-31 "Linux man-pages 6.06" +.TH iswgraph 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iswgraph \- test for graphic wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/iswlower.3 b/upstream/archlinux/man3/iswlower.3 index c36aa060..f4e12d9b 100644 --- a/upstream/archlinux/man3/iswlower.3 +++ b/upstream/archlinux/man3/iswlower.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH iswlower 3 2023-10-31 "Linux man-pages 6.06" +.TH iswlower 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iswlower \- test for lowercase wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/iswprint.3 b/upstream/archlinux/man3/iswprint.3 index 67fe6c19..0d9bbb99 100644 --- a/upstream/archlinux/man3/iswprint.3 +++ b/upstream/archlinux/man3/iswprint.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH iswprint 3 2023-10-31 "Linux man-pages 6.06" +.TH iswprint 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iswprint \- test for printing wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/iswpunct.3 b/upstream/archlinux/man3/iswpunct.3 index 535f133d..86491ac8 100644 --- a/upstream/archlinux/man3/iswpunct.3 +++ b/upstream/archlinux/man3/iswpunct.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH iswpunct 3 2023-10-31 "Linux man-pages 6.06" +.TH iswpunct 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iswpunct \- test for punctuation or symbolic wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/iswspace.3 b/upstream/archlinux/man3/iswspace.3 index 1bdd9beb..aa284572 100644 --- a/upstream/archlinux/man3/iswspace.3 +++ b/upstream/archlinux/man3/iswspace.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH iswspace 3 2023-10-31 "Linux man-pages 6.06" +.TH iswspace 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iswspace \- test for whitespace wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/iswupper.3 b/upstream/archlinux/man3/iswupper.3 index d6413621..f50fa665 100644 --- a/upstream/archlinux/man3/iswupper.3 +++ b/upstream/archlinux/man3/iswupper.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH iswupper 3 2023-10-31 "Linux man-pages 6.06" +.TH iswupper 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iswupper \- test for uppercase wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/iswxdigit.3 b/upstream/archlinux/man3/iswxdigit.3 index 5e76e39f..e55952b3 100644 --- a/upstream/archlinux/man3/iswxdigit.3 +++ b/upstream/archlinux/man3/iswxdigit.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH iswxdigit 3 2023-10-31 "Linux man-pages 6.06" +.TH iswxdigit 3 2024-05-02 "Linux man-pages 6.8" .SH NAME iswxdigit \- test for hexadecimal digit wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/j0.3 b/upstream/archlinux/man3/j0.3 index fcff0703..d9688a26 100644 --- a/upstream/archlinux/man3/j0.3 +++ b/upstream/archlinux/man3/j0.3 @@ -14,7 +14,7 @@ .\" Modified 2004-11-12 as per suggestion by Fabian Kreutz/AEB .\" 2008-07-24, mtk, moved yxx() material into separate y0.3 page .\" -.TH j0 3 2023-10-31 "Linux man-pages 6.06" +.TH j0 3 2024-05-02 "Linux man-pages 6.8" .SH NAME j0, j0f, j0l, j1, j1f, j1l, jn, jnf, jnl \- Bessel functions of the first kind diff --git a/upstream/archlinux/man3/key_defined.3x b/upstream/archlinux/man3/key_defined.3x index d190c790..060ea234 100644 --- a/upstream/archlinux/man3/key_defined.3x +++ b/upstream/archlinux/man3/key_defined.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 2003-2006,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -29,16 +29,19 @@ .\" .\" Author: Thomas E. Dickey 2003 .\" -.\" $Id: key_defined.3x,v 1.13 2022/02/12 20:03:40 tom Exp $ -.TH key_defined 3X "" +.\" $Id: key_defined.3x,v 1.34 2024/03/16 15:35:01 tom Exp $ +.TH key_defined 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBkey_defined\fP \- check if a keycode is defined +\fB\%key_defined\fP \- +test whether a \fIcurses\fR keycode is defined .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint key_defined(const char *\fIdefinition\fB);\fR +.nf +\fB#include <curses.h> +.PP +\fBint key_defined(const char *\fIdefinition\fP); +.fi .SH DESCRIPTION -This is an extension to the curses library. +This is an extension to the \fIcurses\fP library. It permits an application to determine if a string is currently bound to any keycode. .SH RETURN VALUE @@ -47,12 +50,12 @@ If no keycode is bound, zero is returned. If the string conflicts with longer strings which are bound to keys, \-1 is returned. .SH PORTABILITY -These routines are specific to ncurses. -They were not supported on +This routine is specific to \fI\%ncurses\fP. +It was not supported on Version 7, BSD or System V implementations. It is recommended that -any code depending on them be conditioned using NCURSES_VERSION. +any code depending on them be conditioned using \fB\%NCURSES_VERSION\fP. +.SH AUTHORS +Thomas Dickey .SH SEE ALSO -\fBdefine_key\fP(3X). -.SH AUTHOR -Thomas Dickey. +\fB\%define_key\fP(3X) diff --git a/upstream/archlinux/man3/key_setsecret.3 b/upstream/archlinux/man3/key_setsecret.3 index 0025b6a8..5404f0df 100644 --- a/upstream/archlinux/man3/key_setsecret.3 +++ b/upstream/archlinux/man3/key_setsecret.3 @@ -5,7 +5,7 @@ .\" .\" I had no way the check the functions out .\" be careful -.TH key_setsecret 3 2023-10-31 "Linux man-pages 6.06" +.TH key_setsecret 3 2024-05-02 "Linux man-pages 6.8" .SH NAME key_decryptsession, key_encryptsession, key_setsecret, key_gendes, key_secretkey_is_set \- interfaces to rpc keyserver daemon diff --git a/upstream/archlinux/man3/keybound.3x b/upstream/archlinux/man3/keybound.3x index a49b9670..5f4badba 100644 --- a/upstream/archlinux/man3/keybound.3x +++ b/upstream/archlinux/man3/keybound.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1999-2008,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -29,33 +29,37 @@ .\" .\" Author: Thomas E. Dickey 1999 .\" -.\" $Id: keybound.3x,v 1.14 2022/02/12 20:03:40 tom Exp $ -.TH keybound 3X "" +.\" $Id: keybound.3x,v 1.36 2024/03/16 15:35:01 tom Exp $ +.TH keybound 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBkeybound\fP \- return definition of keycode +\fB\%keybound\fP \- +get definition of \fIcurses\fR keycode .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBchar * keybound(int \fIkeycode\fB, int \fIcount);\fR +.nf +\fB#include <curses.h> +.PP +\fBchar * keybound(int \fIkeycode\fP, int \fIcount\fP); +.fi .SH DESCRIPTION -This is an extension to the curses library. +This is an extension to the \fIcurses\fP library. It permits an application to determine the string which is defined in the terminfo for specific keycodes. .SH RETURN VALUE -The \fIkeycode\fP parameter must be greater than zero, else NULL is returned. -If it does not correspond to a defined key, then NULL is returned. +The \fIkeycode\fP parameter must be greater than zero, +else \fBNULL\fP is returned. +If it does not correspond to a defined key, then \fBNULL\fP is returned. The \fIcount\fP parameter is used to allow the application to iterate through multiple definitions, counting from zero. When successful, the function returns a string which must be freed by the caller. .SH PORTABILITY -These routines are specific to ncurses. -They were not supported on +This routine is specific to \fI\%ncurses\fP. +It was not supported on Version 7, BSD or System V implementations. It is recommended that -any code depending on them be conditioned using NCURSES_VERSION. +any code depending on them be conditioned using \fB\%NCURSES_VERSION\fP. +.SH AUTHORS +Thomas Dickey .SH SEE ALSO -\fBdefine_key\fP(3X), -\fBkeyok\fP(3X). -.SH AUTHOR -Thomas Dickey. +\fB\%define_key\fP(3X), +\fB\%keyok\fP(3X) diff --git a/upstream/archlinux/man3/keyok.3x b/upstream/archlinux/man3/keyok.3x index d31d5b1f..5f3ecbde 100644 --- a/upstream/archlinux/man3/keyok.3x +++ b/upstream/archlinux/man3/keyok.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -29,18 +29,21 @@ .\" .\" Author: Thomas E. Dickey 1997 .\" -.\" $Id: keyok.3x,v 1.19 2022/02/12 20:03:40 tom Exp $ -.TH keyok 3X "" +.\" $Id: keyok.3x,v 1.40 2024/03/16 15:35:01 tom Exp $ +.TH keyok 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBkeyok\fP \- enable or disable a keycode +\fB\%keyok\fP \- +enable or disable a \fIcurses\fR keycode .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint keyok(int \fIkeycode\fB, bool \fIenable\fB);\fR +.nf +\fB#include <curses.h> +.PP +\fBint keyok(int \fIkeycode\fP, bool \fIenable\fP); +.fi .SH DESCRIPTION -This is an extension to the curses library. +This is an extension to the \fIcurses\fP library. It permits an application to disable specific keycodes, rather than -use the \fBkeypad\fP function to disable all keycodes. +use the \fB\%keypad\fP function to disable all keycodes. Keys that have been disabled can be re-enabled. .SH RETURN VALUE The keycode must be greater than zero, else \fBERR\fP is returned. @@ -49,12 +52,12 @@ If the \fIenable\fP parameter is true, then the key must have been disabled, and vice versa. Otherwise, the function returns \fBOK\fP. .SH PORTABILITY -These routines are specific to ncurses. -They were not supported on +This routine is specific to \fI\%ncurses\fP. +It was not supported on Version 7, BSD or System V implementations. It is recommended that -any code depending on them be conditioned using NCURSES_VERSION. +any code depending on them be conditioned using \fB\%NCURSES_VERSION\fP. +.SH AUTHORS +Thomas Dickey .SH SEE ALSO -\fBdefine_key\fP(3X). -.SH AUTHOR -Thomas Dickey. +\fB\%define_key\fP(3X) diff --git a/upstream/archlinux/man3/killpg.3 b/upstream/archlinux/man3/killpg.3 index 49fdcb89..81f0c168 100644 --- a/upstream/archlinux/man3/killpg.3 +++ b/upstream/archlinux/man3/killpg.3 @@ -11,7 +11,7 @@ .\" Added notes on CAP_KILL .\" Modified 2004-06-21 by aeb .\" -.TH killpg 3 2023-10-31 "Linux man-pages 6.06" +.TH killpg 3 2024-05-02 "Linux man-pages 6.8" .SH NAME killpg \- send signal to a process group .SH LIBRARY diff --git a/upstream/archlinux/man3/ldexp.3 b/upstream/archlinux/man3/ldexp.3 index 070e92ad..cd21ebee 100644 --- a/upstream/archlinux/man3/ldexp.3 +++ b/upstream/archlinux/man3/ldexp.3 @@ -12,7 +12,7 @@ .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu) .\" Modified 2004-10-31 by aeb .\" -.TH ldexp 3 2023-10-31 "Linux man-pages 6.06" +.TH ldexp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ldexp, ldexpf, ldexpl \- multiply floating-point number by integral power of 2 .SH LIBRARY diff --git a/upstream/archlinux/man3/legacy_coding.3x b/upstream/archlinux/man3/legacy_coding.3x index 0fbd5c96..2eb4fff6 100644 --- a/upstream/archlinux/man3/legacy_coding.3x +++ b/upstream/archlinux/man3/legacy_coding.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2020-2021,2022 Thomas E. Dickey * +.\" Copyright 2020-2023,2024 Thomas E. Dickey * .\" Copyright 2005-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -29,47 +29,75 @@ .\" .\" Author: Thomas E. Dickey .\" -.\" $Id: legacy_coding.3x,v 1.11 2022/02/12 20:07:56 tom Exp $ -.TH legacy_coding 3X "" +.\" $Id: legacy_coding.3x,v 1.28 2024/04/20 19:13:50 tom Exp $ +.TH legacy_coding 3X 2024-04-20 "ncurses 6.5" "Library calls" .SH NAME -\fBuse_legacy_coding\fP \- override locale-encoding checks +\fB\%use_legacy_coding\fP \- +override \fIcurses\fR locale encoding checks .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint use_legacy_coding(int \fIlevel\fB);\fR +.nf +\fB#include <curses.h> +.PP +\fBint use_legacy_coding(int \fIlevel\fP); +.fi .SH DESCRIPTION -The \fBuse_legacy_coding\fP function is an extension to the curses library. -It allows the caller to change the result of \fBunctrl\fP, -and suppress related checks within the library that would normally -cause nonprinting characters to be rendered in visible form. -This affects only 8-bit characters. +.B \%use_legacy_coding +is an extension to the +.I curses +library. +It allows the caller to change the result of \fB\%unctrl\fP(3X), +suppressing \fI\%isprint\fP(3)-based checks within the library that +would normally cause nonprinting characters to be rendered in visible +form. +The alteration affects only eight-bit characters. .PP -The \fIlevel\fP parameter controls the result: +The +.I level +parameter controls the result. .RS .TP 5 -0 -the library functions normally, -rendering nonprinting characters as described in \fBunctrl\fP. +.B 0 +The library functions normally, +rendering nonprinting characters as described in \fB\%unctrl\fP(3X), .TP -1 -the library ignores \fBisprintf\fP for codes in the range 160-255. +.B 1 +the library ignores +.I \%isprint +for codes in the range 160-255. .TP -2 -the library ignores \fBisprintf\fP for codes in the range 128-255. -It also modifies the output of \fBunctrl\fP, showing codes in the -range 128-159 as is. +.B 2 +the library ignores +.I \%isprint +for codes in the range 128-255. +It also modifies the output of \fB\%unctrl\fP(3X), +showing codes in the range 128-159 as is. .RE .SH RETURN VALUE If the screen has not been initialized, -or the \fIlevel\fP parameter is out of range, -the function returns \fBERR\fP. -Otherwise, it returns the previous level: \fB0\fP, \fB1\fP or \fB2\fP. +or the +.I level +parameter is out of range, +.B \%use_legacy_coding +returns +.BR ERR . +Otherwise, +it returns the previous level: +.BR 0 , +.BR 1 , +or +.BR 2 . .SH PORTABILITY -This routine is specific to ncurses. +.B \%use_legacy_coding +is specific to +.IR \%ncurses . It was not supported on Version 7, BSD or System V implementations. -It is recommended that any code depending on ncurses extensions -be conditioned using NCURSES_VERSION. +Applications employing +.I \%ncurses +extensions should condition their use on the visibility of the +.B \%NCURSES_VERSION +preprocessor macro. +.SH AUTHORS +Thomas Dickey +(to support \fI\%lynx\fP(1)'s font-switching feature). .SH SEE ALSO -\fBunctrl\fP(3X). -.SH AUTHOR -Thomas Dickey (to support lynx's font-switching feature). +\fB\%unctrl\fP(3X) diff --git a/upstream/archlinux/man3/lgamma.3 b/upstream/archlinux/man3/lgamma.3 index a08e2d87..5e46ada5 100644 --- a/upstream/archlinux/man3/lgamma.3 +++ b/upstream/archlinux/man3/lgamma.3 @@ -6,7 +6,7 @@ .\" .\" based on glibc infopages .\" -.TH lgamma 3 2023-10-31 "Linux man-pages 6.06" +.TH lgamma 3 2024-05-02 "Linux man-pages 6.8" .SH NAME lgamma, lgammaf, lgammal, lgamma_r, lgammaf_r, lgammal_r, signgam \- log gamma function diff --git a/upstream/archlinux/man3/libalpm.3 b/upstream/archlinux/man3/libalpm.3 index 9420fd7a..2d975fca 100644 --- a/upstream/archlinux/man3/libalpm.3 +++ b/upstream/archlinux/man3/libalpm.3 @@ -1,4 +1,4 @@ -.TH "libalpm" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME @@ -66,6 +66,14 @@ libalpm \- The libalpm Public API .br .RI "" .in -1c +.SS "Data Structures" + +.in +1c +.ti -1c +.RI "struct \fBalpm_pkg_xdata_t\fP" +.br +.RI "The extended data type used to store non-standard package data fields\&. " +.in -1c .SH "Detailed Description" .PP @@ -74,6 +82,22 @@ libalpm is a package management library, primarily used by pacman\&. For ease of .SH "See Also" .PP \fBlibalpm_list(3)\fP, \fBlibalpm_cb(3)\fP, \fBlibalpm_databases(3)\fP, \fBlibalpm_depends(3)\fP, \fBlibalpm_errors(3)\fP, \fBlibalpm_files(3)\fP, \fBlibalpm_groups(3)\fP, \fBlibalpm_handle(3)\fP, \fBlibalpm_log(3)\fP, \fBlibalpm_misc(3)\fP, \fBlibalpm_options(3)\fP, \fBlibalpm_packages(3)\fP, \fBlibalpm_sig(3)\fP, \fBlibalpm_trans(3)\fP +.SH "Data Structure Documentation" +.PP +.SH "struct alpm_pkg_xdata_t" +.PP +The extended data type used to store non-standard package data fields\&. +.PP +\fBData Fields:\fP +.RS 4 +char * \fIname\fP +.br +.PP +char * \fIvalue\fP +.br +.PP +.RE +.PP .SH "Author" .PP Generated automatically by Doxygen for libalpm from the source code\&. diff --git a/upstream/archlinux/man3/libalpm_cb.3 b/upstream/archlinux/man3/libalpm_cb.3 index 12ec2252..12b0d535 100644 --- a/upstream/archlinux/man3/libalpm_cb.3 +++ b/upstream/archlinux/man3/libalpm_cb.3 @@ -1,4 +1,4 @@ -.TH "libalpm_cb" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_cb" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME @@ -114,11 +114,11 @@ libalpm_cb \- Callbacks .in +1c .ti -1c -.RI "typedef void(* \fBalpm_cb_event\fP) (void *ctx, \fBalpm_event_t\fP *)" +.RI "typedef void(* \fBalpm_cb_event\fP) (void *ctx, \fBalpm_event_t\fP *event)" .br .RI "Event callback\&. " .ti -1c -.RI "typedef void(* \fBalpm_cb_question\fP) (void *ctx, \fBalpm_question_t\fP *)" +.RI "typedef void(* \fBalpm_cb_question\fP) (void *ctx, \fBalpm_question_t\fP *question)" .br .RI "Question callback\&. " .ti -1c @@ -537,15 +537,18 @@ Should a key be imported? .PP \fBData Fields:\fP .RS 4 -int \fIimport\fP Answer: whether or not to import key\&. +const char * \fIfingerprint\fP Fingerprint the key to import\&. .br .PP -\fBalpm_pgpkey_t\fP * \fIkey\fP The key to import\&. +int \fIimport\fP Answer: whether or not to import key\&. .br .PP \fBalpm_question_type_t\fP \fItype\fP Type of question\&. .br .PP +const char * \fIuid\fP UID of the key to import\&. +.br +.PP .RE .PP .SH "union alpm_question_t" @@ -658,7 +661,7 @@ Type of download progress callbacks\&. .RE .PP -.SS "typedef void(* alpm_cb_event) (void *ctx, \fBalpm_event_t\fP *)" +.SS "typedef void(* alpm_cb_event) (void *ctx, \fBalpm_event_t\fP *event)" .PP Event callback\&. Called when an event occurs @@ -714,7 +717,7 @@ Progress callback\&. Alert the front end about the progress of certain events\&. .RE .PP -.SS "typedef void(* alpm_cb_question) (void *ctx, \fBalpm_question_t\fP *)" +.SS "typedef void(* alpm_cb_question) (void *ctx, \fBalpm_question_t\fP *question)" .PP Question callback\&. This callback allows user to give input and decide what to do during certain events diff --git a/upstream/archlinux/man3/libalpm_databases.3 b/upstream/archlinux/man3/libalpm_databases.3 index 4c3f3381..0f8343c8 100644 --- a/upstream/archlinux/man3/libalpm_databases.3 +++ b/upstream/archlinux/man3/libalpm_databases.3 @@ -1,4 +1,4 @@ -.TH "libalpm_databases" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_databases" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME @@ -10,7 +10,7 @@ libalpm_databases \- Database .in +1c .ti -1c -.RI "typedef struct __alpm_db_t \fBalpm_db_t\fP" +.RI "typedef struct _alpm_db_t \fBalpm_db_t\fP" .br .RI "A database\&. " .in -1c @@ -46,6 +46,10 @@ libalpm_databases \- Database .br .RI "Unregister a package database\&. " .ti -1c +.RI "\fBalpm_handle_t\fP * \fBalpm_db_get_handle\fP (\fBalpm_db_t\fP *db)" +.br +.RI "Get the handle of a package database\&. " +.ti -1c .RI "const char * \fBalpm_db_get_name\fP (const \fBalpm_db_t\fP *db)" .br .RI "Get the name of a package database\&. " @@ -101,6 +105,22 @@ libalpm_databases \- Database .RI "int \fBalpm_db_remove_server\fP (\fBalpm_db_t\fP *db, const char *url)" .br .RI "Remove a download server from a database\&. " +.ti -1c +.RI "\fBalpm_list_t\fP * \fBalpm_db_get_cache_servers\fP (const \fBalpm_db_t\fP *db)" +.br +.RI "Get the list of cache servers assigned to this db\&. " +.ti -1c +.RI "int \fBalpm_db_set_cache_servers\fP (\fBalpm_db_t\fP *db, \fBalpm_list_t\fP *servers)" +.br +.RI "Sets the list of cache servers for the database to use\&. " +.ti -1c +.RI "int \fBalpm_db_add_cache_server\fP (\fBalpm_db_t\fP *db, const char *url)" +.br +.RI "Add a download cache server to a database\&. " +.ti -1c +.RI "int \fBalpm_db_remove_cache_server\fP (\fBalpm_db_t\fP *db, const char *url)" +.br +.RI "Remove a download cache server from a database\&. " .in -1c .SS "Usage accessors" @@ -121,7 +141,7 @@ libalpm_databases \- Database Functions to query and manipulate the database of libalpm\&. .SH "Typedef Documentation" .PP -.SS "typedef struct __alpm_db_t \fBalpm_db_t\fP" +.SS "typedef struct _alpm_db_t \fBalpm_db_t\fP" .PP A database\&. A database is a container that stores metadata about packages\&. @@ -159,6 +179,24 @@ Enable sysupgrades with this database\&. Enable all usage levels\&. .SH "Function Documentation" .PP +.SS "int alpm_db_add_cache_server (\fBalpm_db_t\fP * db, const char * url)" + +.PP +Add a download cache server to a database\&. +.PP +\fBParameters\fP +.RS 4 +\fIdb\fP database pointer +.br +\fIurl\fP url of the server +.RE +.PP +\fBReturns\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + .SS "int alpm_db_add_server (\fBalpm_db_t\fP * db, const char * url)" .PP @@ -177,6 +215,22 @@ Add a download server to a database\&. .RE .PP +.SS "\fBalpm_list_t\fP * alpm_db_get_cache_servers (const \fBalpm_db_t\fP * db)" + +.PP +Get the list of cache servers assigned to this db\&. +.PP +\fBParameters\fP +.RS 4 +\fIdb\fP pointer to the database to get the servers from +.RE +.PP +\fBReturns\fP +.RS 4 +a char* list of servers +.RE +.PP + .SS "\fBalpm_group_t\fP * alpm_db_get_group (\fBalpm_db_t\fP * db, const char * name)" .PP @@ -211,6 +265,22 @@ the list of groups on success, NULL on error .RE .PP +.SS "\fBalpm_handle_t\fP * alpm_db_get_handle (\fBalpm_db_t\fP * db)" + +.PP +Get the handle of a package database\&. +.PP +\fBParameters\fP +.RS 4 +\fIdb\fP pointer to the package database +.RE +.PP +\fBReturns\fP +.RS 4 +the alpm handle that the package database belongs to +.RE +.PP + .SS "const char * alpm_db_get_name (const \fBalpm_db_t\fP * db)" .PP @@ -327,6 +397,24 @@ Check the validity of a database\&. This is most useful for sync databases and v .RE .PP +.SS "int alpm_db_remove_cache_server (\fBalpm_db_t\fP * db, const char * url)" + +.PP +Remove a download cache server from a database\&. +.PP +\fBParameters\fP +.RS 4 +\fIdb\fP database pointer +.br +\fIurl\fP url of the server +.RE +.PP +\fBReturns\fP +.RS 4 +0 on success, 1 on server not present, -1 on error (pm_errno is set accordingly) +.RE +.PP + .SS "int alpm_db_remove_server (\fBalpm_db_t\fP * db, const char * url)" .PP @@ -365,6 +453,19 @@ Searches a database with regular expressions\&. .RE .PP +.SS "int alpm_db_set_cache_servers (\fBalpm_db_t\fP * db, \fBalpm_list_t\fP * servers)" + +.PP +Sets the list of cache servers for the database to use\&. +.PP +\fBParameters\fP +.RS 4 +\fIdb\fP the database to set the servers\&. The list will be duped and the original will still need to be freed by the caller\&. +.br +\fIservers\fP a char* list of servers\&. +.RE +.PP + .SS "int alpm_db_set_servers (\fBalpm_db_t\fP * db, \fBalpm_list_t\fP * servers)" .PP diff --git a/upstream/archlinux/man3/libalpm_depends.3 b/upstream/archlinux/man3/libalpm_depends.3 index 424d1b68..286048d5 100644 --- a/upstream/archlinux/man3/libalpm_depends.3 +++ b/upstream/archlinux/man3/libalpm_depends.3 @@ -1,4 +1,4 @@ -.TH "libalpm_depends" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_depends" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME @@ -137,16 +137,10 @@ A conflict that has occurred between two packages\&. .PP \fBData Fields:\fP .RS 4 -char * \fIpackage1\fP Name of the first package\&. +\fBalpm_pkg_t\fP * \fIpackage1\fP The first package\&. .br .PP -unsigned long \fIpackage1_hash\fP Hash of the first package name (used internally to speed up conflict checks) -.br -.PP -char * \fIpackage2\fP Name of the second package\&. -.br -.PP -unsigned long \fIpackage2_hash\fP Hash of the second package name (used internally to speed up conflict checks) +\fBalpm_pkg_t\fP * \fIpackage2\fP The second package\&. .br .PP \fBalpm_depend_t\fP * \fIreason\fP The conflict\&. diff --git a/upstream/archlinux/man3/libalpm_errors.3 b/upstream/archlinux/man3/libalpm_errors.3 index 6a6d81aa..c54f01b8 100644 --- a/upstream/archlinux/man3/libalpm_errors.3 +++ b/upstream/archlinux/man3/libalpm_errors.3 @@ -1,4 +1,4 @@ -.TH "libalpm_errors" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_errors" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/upstream/archlinux/man3/libalpm_files.3 b/upstream/archlinux/man3/libalpm_files.3 index 1895c8bc..26766ec6 100644 --- a/upstream/archlinux/man3/libalpm_files.3 +++ b/upstream/archlinux/man3/libalpm_files.3 @@ -1,4 +1,4 @@ -.TH "libalpm_files" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_files" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME @@ -26,7 +26,7 @@ libalpm_files \- Files .in +1c .ti -1c -.RI "\fBalpm_file_t\fP * \fBalpm_filelist_contains\fP (\fBalpm_filelist_t\fP *filelist, const char *path)" +.RI "\fBalpm_file_t\fP * \fBalpm_filelist_contains\fP (const \fBalpm_filelist_t\fP *filelist, const char *path)" .br .RI "Determines whether a package filelist contains a given path\&. " .in -1c @@ -84,7 +84,7 @@ char * \fIname\fP Name of the file (without \&.pacsave extension) .PP .SH "Function Documentation" .PP -.SS "\fBalpm_file_t\fP * alpm_filelist_contains (\fBalpm_filelist_t\fP * filelist, const char * path)" +.SS "\fBalpm_file_t\fP * alpm_filelist_contains (const \fBalpm_filelist_t\fP * filelist, const char * path)" .PP Determines whether a package filelist contains a given path\&. The provided path should be relative to the install root with no leading slashes, e\&.g\&. 'etc/localtime'\&. When searching for directories, the path must have a trailing slash\&. diff --git a/upstream/archlinux/man3/libalpm_groups.3 b/upstream/archlinux/man3/libalpm_groups.3 index 83c2780e..5766ba07 100644 --- a/upstream/archlinux/man3/libalpm_groups.3 +++ b/upstream/archlinux/man3/libalpm_groups.3 @@ -1,4 +1,4 @@ -.TH "libalpm_groups" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_groups" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/upstream/archlinux/man3/libalpm_handle.3 b/upstream/archlinux/man3/libalpm_handle.3 index 3663da4b..2369abf6 100644 --- a/upstream/archlinux/man3/libalpm_handle.3 +++ b/upstream/archlinux/man3/libalpm_handle.3 @@ -1,4 +1,4 @@ -.TH "libalpm_handle" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_handle" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME @@ -10,7 +10,7 @@ libalpm_handle \- Handle .in +1c .ti -1c -.RI "typedef struct __alpm_handle_t \fBalpm_handle_t\fP" +.RI "typedef struct _alpm_handle_t \fBalpm_handle_t\fP" .br .RI "The libalpm context handle\&. " .in -1c @@ -33,7 +33,7 @@ libalpm_handle \- Handle Functions to initialize and release libalpm .SH "Typedef Documentation" .PP -.SS "typedef struct __alpm_handle_t \fBalpm_handle_t\fP" +.SS "typedef struct _alpm_handle_t \fBalpm_handle_t\fP" .PP The libalpm context handle\&. This struct represents an instance of libalpm\&. diff --git a/upstream/archlinux/man3/libalpm_list.3 b/upstream/archlinux/man3/libalpm_list.3 index c53c2f02..fefddc34 100644 --- a/upstream/archlinux/man3/libalpm_list.3 +++ b/upstream/archlinux/man3/libalpm_list.3 @@ -1,4 +1,4 @@ -.TH "libalpm_list" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_list" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME @@ -138,6 +138,10 @@ libalpm_list \- libalpm_list(3) .br .RI "Find a string in a list\&. " .ti -1c +.RI "int \fBalpm_list_cmp_unsorted\fP (const \fBalpm_list_t\fP *left, const \fBalpm_list_t\fP *right, \fBalpm_list_fn_cmp\fP fn)" +.br +.RI "Check if two lists contain the same data, ignoring order\&. " +.ti -1c .RI "void \fBalpm_list_diff_sorted\fP (const \fBalpm_list_t\fP *left, const \fBalpm_list_t\fP *right, \fBalpm_list_fn_cmp\fP fn, \fBalpm_list_t\fP **onlyleft, \fBalpm_list_t\fP **onlyright)" .br .RI "Find the differences between list \fRleft\fP and list \fRright\fP " @@ -170,10 +174,10 @@ A doubly linked list\&. void * \fIdata\fP data held by the list node .br .PP -struct __alpm_list_t * \fInext\fP pointer to the next node +struct _alpm_list_t * \fInext\fP pointer to the next node .br .PP -struct __alpm_list_t * \fIprev\fP pointer to the previous node +struct _alpm_list_t * \fIprev\fP pointer to the previous node .br .PP .RE @@ -277,6 +281,26 @@ the newly added item .RE .PP +.SS "int alpm_list_cmp_unsorted (const \fBalpm_list_t\fP * left, const \fBalpm_list_t\fP * right, \fBalpm_list_fn_cmp\fP fn)" + +.PP +Check if two lists contain the same data, ignoring order\&. Lists are considered equal if they both contain the same data regardless of order\&. +.PP +\fBParameters\fP +.RS 4 +\fIleft\fP the first list +.br +\fIright\fP the second list +.br +\fIfn\fP the comparison function +.RE +.PP +\fBReturns\fP +.RS 4 +1 if the lists are equal, 0 if not equal, -1 on error\&. +.RE +.PP + .SS "\fBalpm_list_t\fP * alpm_list_copy (const \fBalpm_list_t\fP * list)" .PP diff --git a/upstream/archlinux/man3/libalpm_log.3 b/upstream/archlinux/man3/libalpm_log.3 index 01defc87..78b867ef 100644 --- a/upstream/archlinux/man3/libalpm_log.3 +++ b/upstream/archlinux/man3/libalpm_log.3 @@ -1,4 +1,4 @@ -.TH "libalpm_log" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_log" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/upstream/archlinux/man3/libalpm_misc.3 b/upstream/archlinux/man3/libalpm_misc.3 index 92a28bd4..0727e693 100644 --- a/upstream/archlinux/man3/libalpm_misc.3 +++ b/upstream/archlinux/man3/libalpm_misc.3 @@ -1,4 +1,4 @@ -.TH "libalpm_misc" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_misc" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/upstream/archlinux/man3/libalpm_options.3 b/upstream/archlinux/man3/libalpm_options.3 index b1287bf0..70876bea 100644 --- a/upstream/archlinux/man3/libalpm_options.3 +++ b/upstream/archlinux/man3/libalpm_options.3 @@ -1,4 +1,4 @@ -.TH "libalpm_options" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_options" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/upstream/archlinux/man3/libalpm_packages.3 b/upstream/archlinux/man3/libalpm_packages.3 index 9bd81164..72c11325 100644 --- a/upstream/archlinux/man3/libalpm_packages.3 +++ b/upstream/archlinux/man3/libalpm_packages.3 @@ -1,4 +1,4 @@ -.TH "libalpm_packages" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_packages" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME @@ -9,11 +9,19 @@ libalpm_packages \- Package Functions .SH SYNOPSIS .br .PP +.SS "Data Structures" + +.in +1c +.ti -1c +.RI "struct \fBalpm_pkg_xdata_t\fP" +.br +.RI "The extended data type used to store non-standard package data fields\&. " +.in -1c .SS "Typedefs" .in +1c .ti -1c -.RI "typedef struct __alpm_pkg_t \fBalpm_pkg_t\fP" +.RI "typedef struct _alpm_pkg_t \fBalpm_pkg_t\fP" .br .RI "A package\&. " .in -1c @@ -21,7 +29,7 @@ libalpm_packages \- Package Functions .in +1c .ti -1c -.RI "enum \fBalpm_pkgreason_t\fP { \fBALPM_PKG_REASON_EXPLICIT\fP = 0, \fBALPM_PKG_REASON_DEPEND\fP = 1 }" +.RI "enum \fBalpm_pkgreason_t\fP { \fBALPM_PKG_REASON_EXPLICIT\fP = 0, \fBALPM_PKG_REASON_DEPEND\fP = 1, \fBALPM_PKG_REASON_UNKNOWN\fP = 2 }" .br .RI "Package install reasons\&. " .ti -1c @@ -81,6 +89,10 @@ They should not be freed nor modified in any way\&. For loaded packages, they will be freed when \fBalpm_pkg_free\fP is called\&. For database packages, they will be freed when the database is unregistered\&. .in +1c .ti -1c +.RI "\fBalpm_handle_t\fP * \fBalpm_pkg_get_handle\fP (\fBalpm_pkg_t\fP *pkg)" +.br +.RI "Gets the handle of a package\&. " +.ti -1c .RI "const char * \fBalpm_pkg_get_filename\fP (\fBalpm_pkg_t\fP *pkg)" .br .RI "Gets the name of the file from which the package was loaded\&. " @@ -205,6 +217,10 @@ For loaded packages, they will be freed when \fBalpm_pkg_free\fP is called\&. Fo .br .RI "Returns the method used to validate a package during install\&. " .ti -1c +.RI "\fBalpm_list_t\fP * \fBalpm_pkg_get_xdata\fP (\fBalpm_pkg_t\fP *pkg)" +.br +.RI "Gets the extended data field of a package\&. " +.ti -1c .RI "int \fBalpm_pkg_has_scriptlet\fP (\fBalpm_pkg_t\fP *pkg)" .br .RI "Returns whether the package has an install scriptlet\&. " @@ -254,14 +270,30 @@ Functions for reading the mtree Functions to manipulate libalpm packages +.SH "Data Structure Documentation" +.PP +.SH "struct alpm_pkg_xdata_t" +.PP +The extended data type used to store non-standard package data fields\&. +.PP +\fBData Fields:\fP +.RS 4 +char * \fIname\fP +.br +.PP +char * \fIvalue\fP +.br +.PP +.RE +.PP .SH "Typedef Documentation" .PP -.SS "typedef struct __alpm_pkg_t \fBalpm_pkg_t\fP" +.SS "typedef struct _alpm_pkg_t \fBalpm_pkg_t\fP" .PP A package\&. A package can be loaded from disk via \fBalpm_pkg_load\fP or retrieved from a database\&. Packages from databases are automatically freed when the database is unregistered\&. Packages loaded from a file must be freed manually\&. .PP -Packages can then be queried for metadata or added to a \fBtransaction \fP to be added or removed from the system\&. +Packages can then be queried for metadata or added to a transaction to be added or removed from the system\&. .SH "Enumeration Type Documentation" .PP .SS "enum \fBalpm_pkgfrom_t\fP" @@ -293,6 +325,9 @@ Explicitly requested by the user\&. .TP \fB\fIALPM_PKG_REASON_DEPEND \fP\fP Installed as a dependency for another package\&. +.TP +\fB\fIALPM_PKG_REASON_UNKNOWN \fP\fP +Failed parsing of local database\&. .SS "enum \fBalpm_pkgvalidation_t\fP" .PP @@ -699,6 +734,22 @@ a pointer to an internal list of strings\&. .RE .PP +.SS "\fBalpm_handle_t\fP * alpm_pkg_get_handle (\fBalpm_pkg_t\fP * pkg)" + +.PP +Gets the handle of a package\&. +.PP +\fBParameters\fP +.RS 4 +\fIpkg\fP a pointer to package +.RE +.PP +\fBReturns\fP +.RS 4 +the alpm handle that the package belongs to +.RE +.PP + .SS "\fBalpm_time_t\fP alpm_pkg_get_installdate (\fBalpm_pkg_t\fP * pkg)" .PP @@ -986,6 +1037,22 @@ a reference to an internal string .RE .PP +.SS "\fBalpm_list_t\fP * alpm_pkg_get_xdata (\fBalpm_pkg_t\fP * pkg)" + +.PP +Gets the extended data field of a package\&. +.PP +\fBParameters\fP +.RS 4 +\fIpkg\fP a pointer to package +.RE +.PP +\fBReturns\fP +.RS 4 +a reference to a list of \fBalpm_pkg_xdata_t\fP objects +.RE +.PP + .SS "int alpm_pkg_has_scriptlet (\fBalpm_pkg_t\fP * pkg)" .PP diff --git a/upstream/archlinux/man3/libalpm_sig.3 b/upstream/archlinux/man3/libalpm_sig.3 index d95befa3..3842d509 100644 --- a/upstream/archlinux/man3/libalpm_sig.3 +++ b/upstream/archlinux/man3/libalpm_sig.3 @@ -1,4 +1,4 @@ -.TH "libalpm_sig" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_sig" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME @@ -237,7 +237,7 @@ Check the PGP signature for the given database\&. .PP \fBReturns\fP .RS 4 -a int value : 0 (valid), 1 (invalid), -1 (an error occurred) +0 if valid, -1 if an error occurred or signature is invalid .RE .PP @@ -299,7 +299,7 @@ Check the PGP signature for the given package file\&. .PP \fBReturns\fP .RS 4 -a int value : 0 (valid), 1 (invalid), -1 (an error occurred) +0 if valid, -1 if an error occurred or signature is invalid .RE .PP diff --git a/upstream/archlinux/man3/libalpm_trans.3 b/upstream/archlinux/man3/libalpm_trans.3 index 25b23749..93ff2aad 100644 --- a/upstream/archlinux/man3/libalpm_trans.3 +++ b/upstream/archlinux/man3/libalpm_trans.3 @@ -1,4 +1,4 @@ -.TH "libalpm_trans" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.TH "libalpm_trans" 3 "libalpm" \" -*- nroff -*- .ad l .nh .SH NAME @@ -6,19 +6,11 @@ libalpm_trans \- Transaction .SH SYNOPSIS .br .PP -.SS "Typedefs" - -.in +1c -.ti -1c -.RI "typedef struct __alpm_trans_t \fBalpm_trans_t\fP" -.br -.RI "Transaction structure used internally by libalpm\&. " -.in -1c .SS "Enumerations" .in +1c .ti -1c -.RI "enum \fBalpm_transflag_t\fP { \fBALPM_TRANS_FLAG_NODEPS\fP = 1, \fBALPM_TRANS_FLAG_NOSAVE\fP = (1 << 2), \fBALPM_TRANS_FLAG_NODEPVERSION\fP = (1 << 3), \fBALPM_TRANS_FLAG_CASCADE\fP = (1 << 4), \fBALPM_TRANS_FLAG_RECURSE\fP = (1 << 5), \fBALPM_TRANS_FLAG_DBONLY\fP = (1 << 6), \fBALPM_TRANS_FLAG_ALLDEPS\fP = (1 << 8), \fBALPM_TRANS_FLAG_DOWNLOADONLY\fP = (1 << 9), \fBALPM_TRANS_FLAG_NOSCRIPTLET\fP = (1 << 10), \fBALPM_TRANS_FLAG_NOCONFLICTS\fP = (1 << 11), \fBALPM_TRANS_FLAG_NEEDED\fP = (1 << 13), \fBALPM_TRANS_FLAG_ALLEXPLICIT\fP = (1 << 14), \fBALPM_TRANS_FLAG_UNNEEDED\fP = (1 << 15), \fBALPM_TRANS_FLAG_RECURSEALL\fP = (1 << 16), \fBALPM_TRANS_FLAG_NOLOCK\fP = (1 << 17) }" +.RI "enum \fBalpm_transflag_t\fP { \fBALPM_TRANS_FLAG_NODEPS\fP = 1, \fBALPM_TRANS_FLAG_NOSAVE\fP = (1 << 2), \fBALPM_TRANS_FLAG_NODEPVERSION\fP = (1 << 3), \fBALPM_TRANS_FLAG_CASCADE\fP = (1 << 4), \fBALPM_TRANS_FLAG_RECURSE\fP = (1 << 5), \fBALPM_TRANS_FLAG_DBONLY\fP = (1 << 6), \fBALPM_TRANS_FLAG_NOHOOKS\fP = (1 << 7), \fBALPM_TRANS_FLAG_ALLDEPS\fP = (1 << 8), \fBALPM_TRANS_FLAG_DOWNLOADONLY\fP = (1 << 9), \fBALPM_TRANS_FLAG_NOSCRIPTLET\fP = (1 << 10), \fBALPM_TRANS_FLAG_NOCONFLICTS\fP = (1 << 11), \fBALPM_TRANS_FLAG_NEEDED\fP = (1 << 13), \fBALPM_TRANS_FLAG_ALLEXPLICIT\fP = (1 << 14), \fBALPM_TRANS_FLAG_UNNEEDED\fP = (1 << 15), \fBALPM_TRANS_FLAG_RECURSEALL\fP = (1 << 16), \fBALPM_TRANS_FLAG_NOLOCK\fP = (1 << 17) }" .br .RI "Transaction flags\&. " .in -1c @@ -97,12 +89,6 @@ Release the transaction with \fBalpm_trans_release\fP .PP .PP A transaction can be released at any time\&. A transaction does not have to be committed\&. -.SH "Typedef Documentation" -.PP -.SS "typedef struct __alpm_trans_t \fBalpm_trans_t\fP" - -.PP -Transaction structure used internally by libalpm\&. .SH "Enumeration Type Documentation" .PP .SS "enum \fBalpm_transflag_t\fP" @@ -131,6 +117,9 @@ Remove packages and their unneeded deps (not explicitly installed)\&. \fB\fIALPM_TRANS_FLAG_DBONLY \fP\fP Modify database but do not commit changes to the filesystem\&. .TP +\fB\fIALPM_TRANS_FLAG_NOHOOKS \fP\fP +Do not run hooks during a transaction\&. +.TP \fB\fIALPM_TRANS_FLAG_ALLDEPS \fP\fP Use ALPM_PKG_REASON_DEPEND when installing packages\&. .TP diff --git a/upstream/archlinux/man3/lio_listio.3 b/upstream/archlinux/man3/lio_listio.3 index 5439e8b5..64c8e6b4 100644 --- a/upstream/archlinux/man3/lio_listio.3 +++ b/upstream/archlinux/man3/lio_listio.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH lio_listio 3 2023-10-31 "Linux man-pages 6.06" +.TH lio_listio 3 2024-05-02 "Linux man-pages 6.8" .SH NAME lio_listio \- initiate a list of I/O requests .SH LIBRARY diff --git a/upstream/archlinux/man3/list.3 b/upstream/archlinux/man3/list.3 index f5ce0fd9..98bf8361 100644 --- a/upstream/archlinux/man3/list.3 +++ b/upstream/archlinux/man3/list.3 @@ -5,7 +5,7 @@ .\" SPDX-License-Identifier: BSD-3-Clause .\" .\" -.TH LIST 3 2023-10-31 "Linux man-pages 6.06" +.TH LIST 3 2024-05-02 "Linux man-pages 6.8" .SH NAME LIST_EMPTY, LIST_ENTRY, diff --git a/upstream/archlinux/man3/localeconv.3 b/upstream/archlinux/man3/localeconv.3 index 5cd8ec49..eeaeca64 100644 --- a/upstream/archlinux/man3/localeconv.3 +++ b/upstream/archlinux/man3/localeconv.3 @@ -4,7 +4,7 @@ .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" Modified Sat Jul 24 19:01:20 1993 by Rik Faith (faith@cs.unc.edu) -.TH localeconv 3 2023-10-31 "Linux man-pages 6.06" +.TH localeconv 3 2024-05-02 "Linux man-pages 6.8" .SH NAME localeconv \- get numeric formatting information .SH LIBRARY diff --git a/upstream/archlinux/man3/lockf.3 b/upstream/archlinux/man3/lockf.3 index fee68f61..ff447267 100644 --- a/upstream/archlinux/man3/lockf.3 +++ b/upstream/archlinux/man3/lockf.3 @@ -7,7 +7,7 @@ .\" Added section stuff, aeb, 2002-04-22. .\" Corrected include file, drepper, 2003-06-15. .\" -.TH lockf 3 2023-10-31 "Linux man-pages 6.06" +.TH lockf 3 2024-05-02 "Linux man-pages 6.8" .SH NAME lockf \- apply, test or remove a POSIX lock on an open file .SH LIBRARY @@ -17,7 +17,7 @@ Standard C library .nf .B #include <unistd.h> .P -.BI "int lockf(int " fd ", int " cmd ", off_t " len ); +.BI "int lockf(int " fd ", int " op ", off_t " len ); .fi .P .RS -4 @@ -37,7 +37,7 @@ Apply, test, or remove a POSIX lock on a section of an open file. The file is specified by .IR fd , a file descriptor open for writing, the action by -.IR cmd , +.IR op , and the section consists of byte positions .IR pos .. pos + len \-1 if @@ -118,7 +118,7 @@ been memory-mapped by another process. .B EBADF .I fd is not an open file descriptor; or -.I cmd +.I op is .B F_LOCK or @@ -128,7 +128,8 @@ and is not a writable file descriptor. .TP .B EDEADLK -The command was +.I op +was .B F_LOCK and this lock operation would cause a deadlock. .TP @@ -139,7 +140,7 @@ delivery of a signal caught by a handler; see .TP .B EINVAL An invalid operation was specified in -.IR cmd . +.IR op . .TP .B ENOLCK Too many segment locks open, lock table is full. diff --git a/upstream/archlinux/man3/log.3 b/upstream/archlinux/man3/log.3 index 392e4a01..59a1b0d0 100644 --- a/upstream/archlinux/man3/log.3 +++ b/upstream/archlinux/man3/log.3 @@ -14,7 +14,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH log 3 2023-10-31 "Linux man-pages 6.06" +.TH log 3 2024-05-02 "Linux man-pages 6.8" .SH NAME log, logf, logl \- natural logarithmic function .SH LIBRARY diff --git a/upstream/archlinux/man3/log10.3 b/upstream/archlinux/man3/log10.3 index 6f80e5ff..0d4672fc 100644 --- a/upstream/archlinux/man3/log10.3 +++ b/upstream/archlinux/man3/log10.3 @@ -14,7 +14,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH log10 3 2023-10-31 "Linux man-pages 6.06" +.TH log10 3 2024-05-02 "Linux man-pages 6.8" .SH NAME log10, log10f, log10l \- base-10 logarithmic function .SH LIBRARY @@ -42,10 +42,10 @@ Feature Test Macro Requirements for glibc (see || /* glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE .fi .SH DESCRIPTION -These functions return the base 10 logarithm of +These functions return the base-10 logarithm of .IR x . .SH RETURN VALUE -On success, these functions return the base 10 logarithm of +On success, these functions return the base-10 logarithm of .IR x . .P For special cases, including where diff --git a/upstream/archlinux/man3/log1p.3 b/upstream/archlinux/man3/log1p.3 index 44249631..e30cb6c5 100644 --- a/upstream/archlinux/man3/log1p.3 +++ b/upstream/archlinux/man3/log1p.3 @@ -7,7 +7,7 @@ .\" .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) -.TH log1p 3 2023-10-31 "Linux man-pages 6.06" +.TH log1p 3 2024-05-02 "Linux man-pages 6.8" .SH NAME log1p, log1pf, log1pl \- logarithm of 1 plus argument .SH LIBRARY diff --git a/upstream/archlinux/man3/log2.3 b/upstream/archlinux/man3/log2.3 index 41edf923..76e63d0c 100644 --- a/upstream/archlinux/man3/log2.3 +++ b/upstream/archlinux/man3/log2.3 @@ -14,7 +14,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH log2 3 2023-10-31 "Linux man-pages 6.06" +.TH log2 3 2024-05-02 "Linux man-pages 6.8" .SH NAME log2, log2f, log2l \- base-2 logarithmic function .SH LIBRARY @@ -41,10 +41,10 @@ Feature Test Macro Requirements for glibc (see _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L .fi .SH DESCRIPTION -These functions return the base 2 logarithm of +These functions return the base-2 logarithm of .IR x . .SH RETURN VALUE -On success, these functions return the base 2 logarithm of +On success, these functions return the base-2 logarithm of .IR x . .P For special cases, including where diff --git a/upstream/archlinux/man3/logb.3 b/upstream/archlinux/man3/logb.3 index c74184ea..965561c2 100644 --- a/upstream/archlinux/man3/logb.3 +++ b/upstream/archlinux/man3/logb.3 @@ -7,7 +7,7 @@ .\" .\" Inspired by a page by Walter Harms created 2002-08-10 .\" -.TH logb 3 2023-10-31 "Linux man-pages 6.06" +.TH logb 3 2024-05-02 "Linux man-pages 6.8" .SH NAME logb, logbf, logbl \- get exponent of a floating-point value .SH LIBRARY @@ -57,9 +57,10 @@ If .B FLT_RADIX is 2, .BI logb( x ) -is equal to -.BI floor(log2( x ))\fR, -except that it is probably faster. +is similar to +.BI floor(log2(fabs( x )))\f[R],\f[] +except that the latter may give an incorrect integer +due to intermediate rounding. .P If .I x diff --git a/upstream/archlinux/man3/login.3 b/upstream/archlinux/man3/login.3 index edf30ef1..5be29494 100644 --- a/upstream/archlinux/man3/login.3 +++ b/upstream/archlinux/man3/login.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH login 3 2023-10-31 "Linux man-pages 6.06" +.TH login 3 2024-05-02 "Linux man-pages 6.8" .SH NAME login, logout \- write utmp and wtmp entries .SH LIBRARY diff --git a/upstream/archlinux/man3/lrint.3 b/upstream/archlinux/man3/lrint.3 index fa346fa8..d6ce1417 100644 --- a/upstream/archlinux/man3/lrint.3 +++ b/upstream/archlinux/man3/lrint.3 @@ -5,7 +5,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH lrint 3 2023-10-31 "Linux man-pages 6.06" +.TH lrint 3 2024-05-02 "Linux man-pages 6.8" .SH NAME lrint, lrintf, lrintl, llrint, llrintf, llrintl \- round to nearest integer .SH LIBRARY diff --git a/upstream/archlinux/man3/lround.3 b/upstream/archlinux/man3/lround.3 index 9cd2d154..ce6a832e 100644 --- a/upstream/archlinux/man3/lround.3 +++ b/upstream/archlinux/man3/lround.3 @@ -5,7 +5,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH lround 3 2023-10-31 "Linux man-pages 6.06" +.TH lround 3 2024-05-02 "Linux man-pages 6.8" .SH NAME lround, lroundf, lroundl, llround, llroundf, llroundl \- round to nearest integer diff --git a/upstream/archlinux/man3/lsearch.3 b/upstream/archlinux/man3/lsearch.3 index e568df94..deabba03 100644 --- a/upstream/archlinux/man3/lsearch.3 +++ b/upstream/archlinux/man3/lsearch.3 @@ -4,7 +4,7 @@ .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" Corrected prototype and include, aeb, 990927 -.TH lsearch 3 2023-10-31 "Linux man-pages 6.06" +.TH lsearch 3 2024-05-02 "Linux man-pages 6.8" .SH NAME lfind, lsearch \- linear search of an array .SH LIBRARY diff --git a/upstream/archlinux/man3/lseek64.3 b/upstream/archlinux/man3/lseek64.3 index 981135da..220053ae 100644 --- a/upstream/archlinux/man3/lseek64.3 +++ b/upstream/archlinux/man3/lseek64.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH lseek64 3 2023-10-31 "Linux man-pages 6.06" +.TH lseek64 3 2024-05-02 "Linux man-pages 6.8" .SH NAME lseek64 \- reposition 64-bit read/write file offset .SH LIBRARY diff --git a/upstream/archlinux/man3/makecontext.3 b/upstream/archlinux/man3/makecontext.3 index cc6d6df8..cb7a9dfe 100644 --- a/upstream/archlinux/man3/makecontext.3 +++ b/upstream/archlinux/man3/makecontext.3 @@ -6,7 +6,7 @@ .\" .\" 2006-08-02, mtk, Added example program .\" -.TH makecontext 3 2023-10-31 "Linux man-pages 6.06" +.TH makecontext 3 2024-05-02 "Linux man-pages 6.8" .SH NAME makecontext, swapcontext \- manipulate user context .SH LIBRARY diff --git a/upstream/archlinux/man3/makedev.3 b/upstream/archlinux/man3/makedev.3 index fde31518..248915c4 100644 --- a/upstream/archlinux/man3/makedev.3 +++ b/upstream/archlinux/man3/makedev.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH makedev 3 2023-10-31 "Linux man-pages 6.06" +.TH makedev 3 2024-05-02 "Linux man-pages 6.8" .SH NAME makedev, major, minor \- manage a device number .SH LIBRARY diff --git a/upstream/archlinux/man3/mallinfo.3 b/upstream/archlinux/man3/mallinfo.3 index f33c67c0..55d34696 100644 --- a/upstream/archlinux/man3/mallinfo.3 +++ b/upstream/archlinux/man3/mallinfo.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH mallinfo 3 2023-10-31 "Linux man-pages 6.06" +.TH mallinfo 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mallinfo, mallinfo2 \- obtain memory allocation information .SH LIBRARY diff --git a/upstream/archlinux/man3/malloc.3 b/upstream/archlinux/man3/malloc.3 index 748a0f30..e79e32e0 100644 --- a/upstream/archlinux/man3/malloc.3 +++ b/upstream/archlinux/man3/malloc.3 @@ -12,7 +12,7 @@ .\" FIXME . Review http://austingroupbugs.net/view.php?id=374 .\" to see what changes are required on this page. .\" -.TH malloc 3 2023-10-31 "Linux man-pages 6.06" +.TH malloc 3 2024-05-02 "Linux man-pages 6.8" .SH NAME malloc, free, calloc, realloc, reallocarray \- allocate and free dynamic memory .SH LIBRARY diff --git a/upstream/archlinux/man3/malloc_get_state.3 b/upstream/archlinux/man3/malloc_get_state.3 index f9c6ee31..8a660d8f 100644 --- a/upstream/archlinux/man3/malloc_get_state.3 +++ b/upstream/archlinux/man3/malloc_get_state.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH malloc_get_state 3 2023-11-01 "Linux man-pages 6.06" +.TH malloc_get_state 3 2024-05-02 "Linux man-pages 6.8" .SH NAME malloc_get_state, malloc_set_state \- record and restore state of malloc implementation diff --git a/upstream/archlinux/man3/malloc_hook.3 b/upstream/archlinux/man3/malloc_hook.3 index 69405ddb..34b107a4 100644 --- a/upstream/archlinux/man3/malloc_hook.3 +++ b/upstream/archlinux/man3/malloc_hook.3 @@ -5,7 +5,7 @@ .\" Heavily based on glibc documentation .\" Polished, added docs, removed glibc doc bug, 2002-07-20, aeb .\" -.TH __malloc_hook 3 2023-10-31 "Linux man-pages 6.06" +.TH __malloc_hook 3 2024-05-02 "Linux man-pages 6.8" .SH NAME __malloc_hook, __malloc_initialize_hook, __memalign_hook, __free_hook, __realloc_hook, diff --git a/upstream/archlinux/man3/malloc_info.3 b/upstream/archlinux/man3/malloc_info.3 index 109adb1e..655fac0f 100644 --- a/upstream/archlinux/man3/malloc_info.3 +++ b/upstream/archlinux/man3/malloc_info.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH malloc_info 3 2023-10-31 "Linux man-pages 6.06" +.TH malloc_info 3 2024-05-02 "Linux man-pages 6.8" .SH NAME malloc_info \- export malloc state to a stream .SH LIBRARY @@ -162,7 +162,7 @@ glibc 2.13 .EE .in .SS Program source -.\" [[memory leak]] SRC BEGIN (malloc_info.c) +.\" SRC BEGIN (malloc_info.c) .EX #include <err.h> #include <errno.h> diff --git a/upstream/archlinux/man3/malloc_stats.3 b/upstream/archlinux/man3/malloc_stats.3 index 47c14f95..d7a35a76 100644 --- a/upstream/archlinux/man3/malloc_stats.3 +++ b/upstream/archlinux/man3/malloc_stats.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH malloc_stats 3 2023-10-31 "Linux man-pages 6.06" +.TH malloc_stats 3 2024-05-02 "Linux man-pages 6.8" .SH NAME malloc_stats \- print memory allocation statistics .SH LIBRARY diff --git a/upstream/archlinux/man3/malloc_trim.3 b/upstream/archlinux/man3/malloc_trim.3 index 46eeb10e..e895384e 100644 --- a/upstream/archlinux/man3/malloc_trim.3 +++ b/upstream/archlinux/man3/malloc_trim.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH malloc_trim 3 2023-10-31 "Linux man-pages 6.06" +.TH malloc_trim 3 2024-05-02 "Linux man-pages 6.8" .SH NAME malloc_trim \- release free memory from the heap .SH LIBRARY diff --git a/upstream/archlinux/man3/malloc_usable_size.3 b/upstream/archlinux/man3/malloc_usable_size.3 index 174d5a17..2900bd0c 100644 --- a/upstream/archlinux/man3/malloc_usable_size.3 +++ b/upstream/archlinux/man3/malloc_usable_size.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH malloc_usable_size 3 2023-10-31 "Linux man-pages 6.06" +.TH malloc_usable_size 3 2024-05-02 "Linux man-pages 6.8" .SH NAME malloc_usable_size \- obtain size of block of memory allocated from heap .SH LIBRARY diff --git a/upstream/archlinux/man3/mallopt.3 b/upstream/archlinux/man3/mallopt.3 index d6557680..ab822dab 100644 --- a/upstream/archlinux/man3/mallopt.3 +++ b/upstream/archlinux/man3/mallopt.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH mallopt 3 2023-10-31 "Linux man-pages 6.06" +.TH mallopt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mallopt \- set memory allocation parameters .SH LIBRARY @@ -569,7 +569,7 @@ main(): returned from second free() call .in .SS Program source \& -.\" [[memory leak]] SRC BEGIN (mallopt.c) +.\" SRC BEGIN (mallopt.c) .EX #include <malloc.h> #include <stdio.h> diff --git a/upstream/archlinux/man3/matherr.3 b/upstream/archlinux/man3/matherr.3 index d8ac97c5..49e42959 100644 --- a/upstream/archlinux/man3/matherr.3 +++ b/upstream/archlinux/man3/matherr.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH matherr 3 2023-10-31 "Linux man-pages 6.06" +.TH matherr 3 2024-05-02 "Linux man-pages 6.8" .SH NAME matherr \- SVID math library exception handling .SH LIBRARY @@ -357,7 +357,7 @@ x=12345.000000 .in .SS Program source \& -.\" [[deprecated]] SRC BEGIN (matherr.c) +.\" SRC BEGIN (matherr.c) .EX #define _SVID_SOURCE #include <errno.h> diff --git a/upstream/archlinux/man3/mblen.3 b/upstream/archlinux/man3/mblen.3 index 888f9d94..642adab1 100644 --- a/upstream/archlinux/man3/mblen.3 +++ b/upstream/archlinux/man3/mblen.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH mblen 3 2023-10-31 "Linux man-pages 6.06" +.TH mblen 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mblen \- determine number of bytes in next multibyte character .SH LIBRARY diff --git a/upstream/archlinux/man3/mbrlen.3 b/upstream/archlinux/man3/mbrlen.3 index dc43678a..18374329 100644 --- a/upstream/archlinux/man3/mbrlen.3 +++ b/upstream/archlinux/man3/mbrlen.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH mbrlen 3 2023-10-31 "Linux man-pages 6.06" +.TH mbrlen 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mbrlen \- determine number of bytes in next multibyte character .SH LIBRARY diff --git a/upstream/archlinux/man3/mbrtowc.3 b/upstream/archlinux/man3/mbrtowc.3 index 000d4564..c3131ad7 100644 --- a/upstream/archlinux/man3/mbrtowc.3 +++ b/upstream/archlinux/man3/mbrtowc.3 @@ -10,7 +10,7 @@ .\" http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH mbrtowc 3 2023-10-31 "Linux man-pages 6.06" +.TH mbrtowc 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mbrtowc \- convert a multibyte sequence to a wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/mbsinit.3 b/upstream/archlinux/man3/mbsinit.3 index 3b6811c8..487b02d7 100644 --- a/upstream/archlinux/man3/mbsinit.3 +++ b/upstream/archlinux/man3/mbsinit.3 @@ -1,5 +1,6 @@ '\" t -.\" Copyright (c) Bruno Haible <haible@clisp.cons.org> +.\" Copyright, Bruno Haible <haible@clisp.cons.org> +.\" Copyright 2024, Alejandro Colomar <alx@kernel.org> .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" @@ -9,9 +10,11 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH mbsinit 3 2024-01-28 "Linux man-pages 6.06" +.TH mbsinit 3 2024-05-03 "Linux man-pages 6.8" .SH NAME -mbsinit \- test for initial shift state +mbsinit +\- +test for initial shift state .SH LIBRARY Standard C library .RI ( libc ", " \-lc ) @@ -22,54 +25,6 @@ Standard C library .BI "int mbsinit(const mbstate_t *" ps ); .fi .SH DESCRIPTION -Character conversion between the multibyte representation and the wide -character representation uses conversion state, of type -.IR mbstate_t . -Conversion of a string uses a finite-state machine; when it is interrupted -after the complete conversion of a number of characters, it may need to -save a state for processing the remaining characters. -Such a conversion -state is needed for the sake of encodings such as ISO/IEC\~2022 and UTF-7. -.P -The initial state is the state at the beginning of conversion of a string. -There are two kinds of state: the one used by multibyte to wide character -conversion functions, such as -.BR mbsrtowcs (3), -and the one used by wide -character to multibyte conversion functions, such as -.BR wcsrtombs (3), -but they both fit in a -.IR mbstate_t , -and they both have the same -representation for an initial state. -.P -For 8-bit encodings, all states are equivalent to the initial state. -For multibyte encodings like UTF-8, EUC-*, BIG5, or SJIS, the wide character -to multibyte conversion functions never produce non-initial states, but the -multibyte to wide-character conversion functions like -.BR mbrtowc (3) -do -produce non-initial states when interrupted in the middle of a character. -.P -One possible way to create an -.I mbstate_t -in initial state is to set it to zero: -.P -.in +4n -.EX -mbstate_t state; -memset(&state, 0, sizeof(state)); -.EE -.in -.P -On Linux, the following works as well, but might generate compiler warnings: -.P -.in +4n -.EX -mbstate_t state = { 0 }; -.EE -.in -.P The function .BR mbsinit () tests whether @@ -110,6 +65,7 @@ depends on the category of the current locale. .SH SEE ALSO +.BR mbstate_t (3type), .BR mbrlen (3), .BR mbrtowc (3), .BR mbsrtowcs (3), diff --git a/upstream/archlinux/man3/mbsnrtowcs.3 b/upstream/archlinux/man3/mbsnrtowcs.3 index f5207b9c..b1332428 100644 --- a/upstream/archlinux/man3/mbsnrtowcs.3 +++ b/upstream/archlinux/man3/mbsnrtowcs.3 @@ -8,7 +8,7 @@ .\" Dinkumware C library reference http://www.dinkumware.com/ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" -.TH mbsnrtowcs 3 2023-10-31 "Linux man-pages 6.06" +.TH mbsnrtowcs 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mbsnrtowcs \- convert a multibyte string to a wide-character string .SH LIBRARY diff --git a/upstream/archlinux/man3/mbsrtowcs.3 b/upstream/archlinux/man3/mbsrtowcs.3 index 0ac883a7..b825b7f2 100644 --- a/upstream/archlinux/man3/mbsrtowcs.3 +++ b/upstream/archlinux/man3/mbsrtowcs.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH mbsrtowcs 3 2023-11-19 "Linux man-pages 6.06" +.TH mbsrtowcs 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mbsrtowcs \- convert a multibyte string to a wide-character string (restartable) .SH LIBRARY @@ -19,7 +19,8 @@ Standard C library .nf .B #include <wchar.h> .P -.BI "size_t mbsrtowcs(wchar_t " dest "[restrict ." dsize "], const char **restrict " src , +.BI "size_t mbsrtowcs(wchar_t " dest "[restrict ." dsize ], +.BI " const char **restrict " src , .BI " size_t " dsize ", mbstate_t *restrict " ps ); .fi .SH DESCRIPTION diff --git a/upstream/archlinux/man3/mbstowcs.3 b/upstream/archlinux/man3/mbstowcs.3 index d26ef0e3..cb208d8c 100644 --- a/upstream/archlinux/man3/mbstowcs.3 +++ b/upstream/archlinux/man3/mbstowcs.3 @@ -10,7 +10,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH mbstowcs 3 2023-11-14 "Linux man-pages 6.06" +.TH mbstowcs 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mbstowcs \- convert a multibyte string to a wide-character string .SH LIBRARY diff --git a/upstream/archlinux/man3/mbtowc.3 b/upstream/archlinux/man3/mbtowc.3 index e095321e..e3077c8e 100644 --- a/upstream/archlinux/man3/mbtowc.3 +++ b/upstream/archlinux/man3/mbtowc.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH mbtowc 3 2023-10-31 "Linux man-pages 6.06" +.TH mbtowc 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mbtowc \- convert a multibyte sequence to a wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/mcheck.3 b/upstream/archlinux/man3/mcheck.3 index 6ad4241d..c493c4b6 100644 --- a/upstream/archlinux/man3/mcheck.3 +++ b/upstream/archlinux/man3/mcheck.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH mcheck 3 2023-10-31 "Linux man-pages 6.06" +.TH mcheck 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mcheck, mcheck_check_all, mcheck_pedantic, mprobe \- heap consistency checking .SH LIBRARY @@ -179,7 +179,7 @@ Aborted (core dumped) .in .SS Program source \& -.\" [[memory leak]] SRC BEGIN (mcheck.c) +.\" SRC BEGIN (mcheck.c) .EX #include <mcheck.h> #include <stdio.h> diff --git a/upstream/archlinux/man3/memccpy.3 b/upstream/archlinux/man3/memccpy.3 index dfb3b1b1..7221d9ad 100644 --- a/upstream/archlinux/man3/memccpy.3 +++ b/upstream/archlinux/man3/memccpy.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 18:57:24 1993 by Rik Faith (faith@cs.unc.edu) -.TH memccpy 3 2023-10-31 "Linux man-pages 6.06" +.TH memccpy 3 2024-05-02 "Linux man-pages 6.8" .SH NAME memccpy \- copy memory area .SH LIBRARY diff --git a/upstream/archlinux/man3/memchr.3 b/upstream/archlinux/man3/memchr.3 index 5cbeed47..d1065aac 100644 --- a/upstream/archlinux/man3/memchr.3 +++ b/upstream/archlinux/man3/memchr.3 @@ -10,7 +10,7 @@ .\" Modified Wed Feb 20 21:09:36 2002, Ian Redfern (redferni@logica.com) .\" 2008-07-09, mtk, add rawmemchr() .\" -.TH memchr 3 2023-10-31 "Linux man-pages 6.06" +.TH memchr 3 2024-05-02 "Linux man-pages 6.8" .SH NAME memchr, memrchr, rawmemchr \- scan memory for a character .SH LIBRARY diff --git a/upstream/archlinux/man3/memcmp.3 b/upstream/archlinux/man3/memcmp.3 index b00efd04..ea92a6b4 100644 --- a/upstream/archlinux/man3/memcmp.3 +++ b/upstream/archlinux/man3/memcmp.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 18:55:27 1993 by Rik Faith (faith@cs.unc.edu) -.TH memcmp 3 2023-10-31 "Linux man-pages 6.06" +.TH memcmp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME memcmp \- compare memory areas .SH LIBRARY diff --git a/upstream/archlinux/man3/memcpy.3 b/upstream/archlinux/man3/memcpy.3 index b1e7168c..8df8f2b9 100644 --- a/upstream/archlinux/man3/memcpy.3 +++ b/upstream/archlinux/man3/memcpy.3 @@ -9,7 +9,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sun Jul 25 10:41:09 1993 by Rik Faith (faith@cs.unc.edu) -.TH memcpy 3 2023-10-31 "Linux man-pages 6.06" +.TH memcpy 3 2024-05-02 "Linux man-pages 6.8" .SH NAME memcpy \- copy memory area .SH LIBRARY diff --git a/upstream/archlinux/man3/memfrob.3 b/upstream/archlinux/man3/memfrob.3 index d4012ea2..10046fe7 100644 --- a/upstream/archlinux/man3/memfrob.3 +++ b/upstream/archlinux/man3/memfrob.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 18:54:45 1993 by Rik Faith (faith@cs.unc.edu) -.TH memfrob 3 2023-10-31 "Linux man-pages 6.06" +.TH memfrob 3 2024-05-02 "Linux man-pages 6.8" .SH NAME memfrob \- frobnicate (obfuscate) a memory area .SH LIBRARY diff --git a/upstream/archlinux/man3/memmem.3 b/upstream/archlinux/man3/memmem.3 index 64f145e7..6dd1d518 100644 --- a/upstream/archlinux/man3/memmem.3 +++ b/upstream/archlinux/man3/memmem.3 @@ -8,7 +8,7 @@ .\" 386BSD man pages .\" Modified Sat Jul 24 18:50:48 1993 by Rik Faith (faith@cs.unc.edu) .\" Interchanged 'needle' and 'haystack'; added history, aeb, 980113. -.TH memmem 3 2023-10-31 "Linux man-pages 6.06" +.TH memmem 3 2024-05-02 "Linux man-pages 6.8" .SH NAME memmem \- locate a substring .SH LIBRARY diff --git a/upstream/archlinux/man3/memmove.3 b/upstream/archlinux/man3/memmove.3 index b05cdd0c..59585733 100644 --- a/upstream/archlinux/man3/memmove.3 +++ b/upstream/archlinux/man3/memmove.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 18:49:59 1993 by Rik Faith (faith@cs.unc.edu) -.TH memmove 3 2023-10-31 "Linux man-pages 6.06" +.TH memmove 3 2024-05-02 "Linux man-pages 6.8" .SH NAME memmove \- copy memory area .SH LIBRARY diff --git a/upstream/archlinux/man3/mempcpy.3 b/upstream/archlinux/man3/mempcpy.3 index 2c3d8086..c9788c2b 100644 --- a/upstream/archlinux/man3/mempcpy.3 +++ b/upstream/archlinux/man3/mempcpy.3 @@ -6,7 +6,7 @@ .\" Heavily based on glibc infopages, copyright Free Software Foundation .\" .\" aeb, 2003, polished a little -.TH mempcpy 3 2023-10-31 "Linux man-pages 6.06" +.TH mempcpy 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mempcpy, wmempcpy \- copy memory area .SH LIBRARY diff --git a/upstream/archlinux/man3/memset.3 b/upstream/archlinux/man3/memset.3 index bf6b7ab1..79a04336 100644 --- a/upstream/archlinux/man3/memset.3 +++ b/upstream/archlinux/man3/memset.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 18:49:23 1993 by Rik Faith (faith@cs.unc.edu) -.TH memset 3 2023-10-31 "Linux man-pages 6.06" +.TH memset 3 2024-05-02 "Linux man-pages 6.8" .SH NAME memset \- fill memory with a constant byte .SH LIBRARY diff --git a/upstream/archlinux/man3/menu.3x b/upstream/archlinux/man3/menu.3x index e74064d3..9c0659b3 100644 --- a/upstream/archlinux/man3/menu.3x +++ b/upstream/archlinux/man3/menu.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2020,2021 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2014,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,21 +28,30 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu.3x,v 1.29 2021/12/25 21:49:32 tom Exp $ -.TH menu 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: menu.3x,v 1.45 2024/03/16 15:35:01 tom Exp $ +.TH menu 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBmenu\fP \- curses extension for programming menus +\fBmenu\fP \- +curses extension for programming menus .SH SYNOPSIS -\fB#include <menu.h>\fP -.br +.nf +\fB#include <menu.h> +.fi .SH DESCRIPTION The \fBmenu\fP library provides terminal-independent facilities for composing menu systems on character-cell terminals. @@ -56,7 +65,7 @@ these functions. To use the \fBmenu\fP library, link with the options \fB\-lmenu \-lcurses\fP. . -.SS Current Default Values for Item Attributes +.SS "Current Default Values for Item Attributes" . The \fBmenu\fP library maintains a default value for item attributes. You can @@ -66,11 +75,11 @@ Changing this default with a \fBset_\fP function affects future item creations, but does not change the rendering of items already created. . -.SS Routine Name Index +.SS "Routine Name Index" . The following table lists each \fBmenu\fP routine and the name of the manual page on which it is described. -. +.PP .TS l l . \fBcurses\fP Routine Name Manual Page Name @@ -181,33 +190,26 @@ System error occurred (see \fBerrno\fP(3)). .B E_UNKNOWN_COMMAND The menu driver code saw an unknown request code. .SH NOTES -The header file \fB<menu.h>\fP automatically includes the header files -\fB<curses.h>\fP and \fB<eti.h>\fP. -.PP -In your library list, libmenu.a should be before libncurses.a; that is, -you should say \*(``\-lmenu \-lncurses\*('', not the other way around -(which would give a link-error when using static libraries). +The header file \fI\%menu.h\fP itself includes the header file +\fI\%curses.h\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions. .PP -The menu facility was documented in SVr4.2 in -\fICharacter User Interface Programming (UNIX SVR4.2)\fP. +A menu facility was documented in SVr4.2's +\fICharacter User Interface Programming\fP document. .PP It is not part of X/Open Curses. .PP -Aside from ncurses, there are few implementations: +Aside from \fI\%ncurses\fP, there are few implementations: .bP systems based on SVr4 source code, e.g., Solaris. .bP NetBSD curses. .SH AUTHORS Juergen Pfeifer. -Manual pages and adaptation for ncurses by Eric S. Raymond. +Manual pages and adaptation for \fI\%ncurses\fP by Eric S. Raymond. .SH SEE ALSO -\fBcurses\fP(3X) and related pages whose names begin \*(``menu_\*('' +\fB\%curses\fP(3X) and related pages whose names begin \*(``menu_\*('' for detailed descriptions of the entry points. -.PP -This describes \fBncurses\fP -version 6.4 (patch 20230520). diff --git a/upstream/archlinux/man3/menu_attributes.3x b/upstream/archlinux/man3/menu_attributes.3x index 9193c195..872fdff3 100644 --- a/upstream/archlinux/man3/menu_attributes.3x +++ b/upstream/archlinux/man3/menu_attributes.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,12 +27,18 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_attributes.3x,v 1.22 2022/02/12 20:05:11 tom Exp $ -.TH menu_attributes 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: menu_attributes.3x,v 1.36 2024/03/16 15:35:01 tom Exp $ +.TH menu_attributes 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME \fBmenu_back\fP, \fBmenu_fore\fP, @@ -42,26 +47,24 @@ \fBset_menu_back\fP, \fBset_menu_fore\fP, \fBset_menu_grey\fP, -\fBset_menu_pad\fP \- color and attribute control for menus +\fBset_menu_pad\fP \- +color and attribute control for menus .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint set_menu_fore(MENU *\fImenu\fB, chtype \fIattr\fB);\fR -.br -\fBchtype menu_fore(const MENU *\fImenu\fB);\fR -.sp -\fBint set_menu_back(MENU *\fImenu\fB, chtype \fIattr\fB);\fR -.br -\fBchtype menu_back(const MENU *\fImenu\fB);\fR -.sp -\fBint set_menu_grey(MENU *\fImenu\fB, chtype \fIattr\fB);\fR -.br -\fBchtype menu_grey(const MENU *\fImenu\fB);\fR -.sp -\fBint set_menu_pad(MENU *\fImenu\fB, int \fIpad\fB);\fR -.br -\fBint menu_pad(const MENU *\fImenu\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint set_menu_fore(MENU *\fImenu\fP, chtype \fIattr\fP); +\fBchtype menu_fore(const MENU *\fImenu\fP); +.PP +\fBint set_menu_back(MENU *\fImenu\fP, chtype \fIattr\fP); +\fBchtype menu_back(const MENU *\fImenu\fP); +.PP +\fBint set_menu_grey(MENU *\fImenu\fP, chtype \fIattr\fP); +\fBchtype menu_grey(const MENU *\fImenu\fP); +.PP +\fBint set_menu_pad(MENU *\fImenu\fP, int \fIpad\fP); +\fBint menu_pad(const MENU *\fImenu\fP); +.fi .SH DESCRIPTION The function \fBset_menu_fore\fP sets the foreground attribute of \fImenu\fP. This is the highlight used for selected menu items. @@ -98,12 +101,6 @@ System error occurred (see \fBerrno\fP(3)). .TP 5 .B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. -.SH SEE ALSO -\fBcurses\fP(3X) and related pages whose names begin \*(``menu_\*('' for detailed -descriptions of the entry points. -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -111,3 +108,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X) and related pages whose names begin \*(``menu_\*('' +for detailed descriptions of the entry points. diff --git a/upstream/archlinux/man3/menu_cursor.3x b/upstream/archlinux/man3/menu_cursor.3x index 28b28408..e64e820a 100644 --- a/upstream/archlinux/man3/menu_cursor.3x +++ b/upstream/archlinux/man3/menu_cursor.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,15 +27,17 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_cursor.3x,v 1.16 2022/02/12 20:05:11 tom Exp $ -.TH menu_cursor 3X "" +.\" $Id: menu_cursor.3x,v 1.30 2024/03/16 15:35:01 tom Exp $ +.TH menu_cursor 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBpos_menu_cursor\fP \- position a menu's cursor +\fBpos_menu_cursor\fP \- +position a menu's cursor .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint pos_menu_cursor(const MENU *\fImenu\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint pos_menu_cursor(const MENU *\fImenu\fP); +.fi .SH DESCRIPTION The function \fBpos_menu_cursor\fP restores the cursor to the current position associated with the menu's selected item. @@ -56,11 +57,6 @@ Routine detected an incorrect or out-of-range argument. .TP 5 .B E_NOT_POSTED The menu has not been posted. -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -68,3 +64,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/menu_driver.3x b/upstream/archlinux/man3/menu_driver.3x index 706005fa..40709831 100644 --- a/upstream/archlinux/man3/menu_driver.3x +++ b/upstream/archlinux/man3/menu_driver.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,19 +27,21 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_driver.3x,v 1.31 2022/02/12 20:05:11 tom Exp $ -.TH menu_driver 3X "" +.\" $Id: menu_driver.3x,v 1.47 2024/03/16 15:35:01 tom Exp $ +.TH menu_driver 3X 2024-03-16 "ncurses 6.5" "Library calls" .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBmenu_driver\fP \- command-processing loop of the menu system +\fBmenu_driver\fP \- +command-processing loop of the menu system .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint menu_driver(MENU *\fImenu\fB, int \fIc\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint menu_driver(MENU *\fImenu\fP, int \fIc\fP); +.fi .SH DESCRIPTION Once a menu has been posted (displayed), you should funnel input events to it through \fBmenu_driver\fP. This routine has three major input cases: @@ -116,8 +118,7 @@ If there is no such match, \fBmenu_driver\fP returns .PP If the second argument is one of the above pre-defined requests, the corresponding action is performed. -.SS MOUSE HANDLING -.PP +.SS "Mouse Handling" If the second argument is the KEY_MOUSE special key, the associated mouse event is translated into one of the above pre-defined requests. Currently only clicks in the user window (e.g., inside the menu display @@ -157,8 +158,7 @@ into a request was done, \fBmenu_driver\fP returns the result of this request. If you clicked outside the user window or the mouse event could not be translated into a menu request an \fBE_REQUEST_DENIED\fP is returned. -.SS APPLICATION-DEFINED COMMANDS -.PP +.SS "Application-defined Commands" If the second argument is neither printable nor one of the above pre-defined menu requests or KEY_MOUSE, the drive assumes it is an application-specific @@ -191,18 +191,15 @@ Character failed to match. .TP 5 .B E_REQUEST_DENIED The menu driver could not process the request. -.SH SEE ALSO -\fBcurses\fP(3X), -\fBgetch\fP(3X), -\fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header files -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions. -The support for mouse events is ncurses specific. +The support for mouse events is \fI\%ncurses\fP specific. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%getch\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/menu_format.3x b/upstream/archlinux/man3/menu_format.3x index 7abe94e6..fb7fb31c 100644 --- a/upstream/archlinux/man3/menu_format.3x +++ b/upstream/archlinux/man3/menu_format.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2015,2016 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,18 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_format.3x,v 1.21 2022/02/12 20:05:11 tom Exp $ -.TH menu_format 3X "" +.\" $Id: menu_format.3x,v 1.35 2024/03/16 15:35:01 tom Exp $ +.TH menu_format 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBset_menu_format\fP, -\fBmenu_format\fP \- set and get menu sizes +\fBmenu_format\fP \- +set and get menu sizes .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint set_menu_format(MENU *\fImenu\fB, int \fIrows\fB, int \fIcols\fB);\fR -.br -\fBvoid menu_format(const MENU *\fImenu\fB, int *\fIrows\fB, int *\fIcols\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint set_menu_format(MENU *\fImenu\fP, int \fIrows\fP, int \fIcols\fP); +\fBvoid menu_format(const MENU *\fImenu\fP, int *\fIrows\fP, int *\fIcols\fP); +.fi .SH DESCRIPTION The function \fBset_menu_format\fP sets the maximum display size of the given menu. @@ -74,11 +74,6 @@ The menu is already posted. .TP 5 .B E_NOT_CONNECTED No items are connected to the menu. -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -86,3 +81,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/menu_hook.3x b/upstream/archlinux/man3/menu_hook.3x index 661e20dc..ad7fb8fb 100644 --- a/upstream/archlinux/man3/menu_hook.3x +++ b/upstream/archlinux/man3/menu_hook.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2007,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,29 +27,27 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_hook.3x,v 1.18 2022/02/12 20:05:11 tom Exp $ -.TH menu_hook 3X "" +.\" $Id: menu_hook.3x,v 1.32 2024/03/16 15:35:01 tom Exp $ +.TH menu_hook 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBmenu_hook\fP \- set hooks for automatic invocation by applications +\fBmenu_hook\fP \- +set hooks for automatic invocation by applications .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint set_item_init(MENU *\fImenu\fB, Menu_Hook \fIfunc);\fR -.br -\fBMenu_Hook item_init(const MENU *\fImenu);\fR -.sp -\fBint set_item_term(MENU *\fImenu\fB, Menu_Hook \fIfunc);\fR -.br -\fBMenu_Hook item_term(const MENU *\fImenu);\fR -.sp -\fBint set_menu_init(MENU *\fImenu\fB, Menu_Hook \fIfunc);\fR -.br -\fBMenu_Hook menu_init(const MENU *\fImenu);\fR -.sp -\fBint set_menu_term(MENU *\fImenu\fB, Menu_Hook \fIfunc);\fR -.br -\fBMenu_Hook menu_term(const MENU *\fImenu);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint set_item_init(MENU *\fImenu\fP, Menu_Hook \fIfunc\fP); +\fBMenu_Hook item_init(const MENU *\fImenu\fP); +.PP +\fBint set_item_term(MENU *\fImenu\fP, Menu_Hook \fIfunc\fP); +\fBMenu_Hook item_term(const MENU *\fImenu\fP); +.PP +\fBint set_menu_init(MENU *\fImenu\fP, Menu_Hook \fIfunc\fP); +\fBMenu_Hook menu_init(const MENU *\fImenu\fP); +.PP +\fBint set_menu_term(MENU *\fImenu\fP, Menu_Hook \fIfunc\fP); +\fBMenu_Hook menu_term(const MENU *\fImenu\fP); +.fi .SH DESCRIPTION These functions make it possible to set hook functions to be called at various points in the automatic processing of input event codes by \fBmenu_driver\fP. @@ -87,11 +84,6 @@ The routine succeeded. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -100,3 +92,6 @@ Version 7 or BSD versions. Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/menu_items.3x b/upstream/archlinux/man3/menu_items.3x index 555498e0..cc2d8769 100644 --- a/upstream/archlinux/man3/menu_items.3x +++ b/upstream/archlinux/man3/menu_items.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2012,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,21 +27,21 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_items.3x,v 1.20 2022/02/12 20:05:11 tom Exp $ -.TH menu_items 3X "" +.\" $Id: menu_items.3x,v 1.34 2024/03/16 15:35:01 tom Exp $ +.TH menu_items 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBset_menu_items\fP, \fBmenu_items\fP, -\fBitem_count\fP \- make and break connections between items and menus +\fBitem_count\fP \- +make and break connections between items and menus .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint set_menu_items(MENU *\fImenu\fB, ITEM **\fIitems\fB);\fR -.br -\fBITEM **menu_items(const MENU *\fImenu\fB);\fR -.br -\fBint item_count(const MENU *\fImenu\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint set_menu_items(MENU *\fImenu\fP, ITEM **\fIitems\fP); +\fBITEM **menu_items(const MENU *\fImenu\fP); +\fBint item_count(const MENU *\fImenu\fP); +.fi .SH DESCRIPTION The function \fBset_menu_items\fP changes the item pointer array of the given \fImenu\fP. The array must be terminated by a \fBNULL\fP. @@ -73,12 +72,6 @@ The menu is already posted. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -. -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -89,3 +82,6 @@ as \-1 (which is the value of \fBERR\fP). .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/menu_mark.3x b/upstream/archlinux/man3/menu_mark.3x index e6936129..bdcf9313 100644 --- a/upstream/archlinux/man3/menu_mark.3x +++ b/upstream/archlinux/man3/menu_mark.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,18 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_mark.3x,v 1.21 2022/02/12 20:02:20 tom Exp $ -.TH menu_mark 3X "" +.\" $Id: menu_mark.3x,v 1.35 2024/03/16 15:35:01 tom Exp $ +.TH menu_mark 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBset_menu_mark\fP, -\fBmenu_mark\fP \- get and set the menu mark string +\fBmenu_mark\fP \- +get and set the menu mark string .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint set_menu_mark(MENU *\fImenu\fB, const char *\fImark\fB);\fR -.br -\fBconst char *menu_mark(const MENU *\fImenu\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint set_menu_mark(MENU *\fImenu\fP, const char *\fImark\fP); +\fBconst char *menu_mark(const MENU *\fImenu\fP); +.fi .SH DESCRIPTION In order to make menu selections visible on older terminals without highlighting or color capability, the menu library marks selected items @@ -70,11 +70,6 @@ Routine detected an incorrect or out-of-range argument. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -82,3 +77,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/menu_new.3x b/upstream/archlinux/man3/menu_new.3x index 00e2bc9c..8bed2356 100644 --- a/upstream/archlinux/man3/menu_new.3x +++ b/upstream/archlinux/man3/menu_new.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,18 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_new.3x,v 1.21 2022/02/12 20:02:20 tom Exp $ -.TH menu_new 3X "" +.\" $Id: menu_new.3x,v 1.35 2024/03/16 15:35:01 tom Exp $ +.TH menu_new 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBnew_menu\fP, -\fBfree_menu\fP \- create and destroy menus +\fBfree_menu\fP \- +create and destroy menus .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBMENU *new_menu(ITEM **\fIitems\fB);\fR -.br -\fBint free_menu(MENU *\fImenu\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBMENU *new_menu(ITEM **\fIitems\fP); +\fBint free_menu(MENU *\fImenu\fP); +.fi .SH DESCRIPTION The function \fBnew_menu\fP creates a new menu connected to a specified item pointer array (which must be \fBNULL\fP-terminated). @@ -69,11 +69,6 @@ Routine detected an incorrect or out-of-range argument. .TP 5 .B E_POSTED The menu has already been posted. -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -81,3 +76,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/menu_opts.3x b/upstream/archlinux/man3/menu_opts.3x index ca61f1bc..fc6868e8 100644 --- a/upstream/archlinux/man3/menu_opts.3x +++ b/upstream/archlinux/man3/menu_opts.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2015,2016 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,24 +27,24 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_opts.3x,v 1.21 2022/02/12 20:02:20 tom Exp $ -.TH menu_opts 3X "" +.\" $Id: menu_opts.3x,v 1.35 2024/03/16 15:35:01 tom Exp $ +.TH menu_opts 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBset_menu_opts\fP, \fBmenu_opts_on\fP, \fBmenu_opts_off\fP, -\fBmenu_opts\fP \- set and get menu options +\fBmenu_opts\fP \- +set and get menu options .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint set_menu_opts(MENU *\fImenu\fB, Menu_Options \fIopts\fB);\fR -.br -\fBMenu_Options menu_opts(const MENU *\fImenu\fB);\fR -.sp -\fBint menu_opts_on(MENU *\fImenu\fB, Menu_Options \fIopts\fB);\fR -.br -\fBint menu_opts_off(MENU *\fImenu\fB, Menu_Options \fIopts\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint set_menu_opts(MENU *\fImenu\fP, Menu_Options \fIopts\fP); +\fBMenu_Options menu_opts(const MENU *\fImenu\fP); +.PP +\fBint menu_opts_on(MENU *\fImenu\fP, Menu_Options \fIopts\fP); +\fBint menu_opts_off(MENU *\fImenu\fP, Menu_Options \fIopts\fP); +.fi .SH DESCRIPTION The function \fBset_menu_opts\fP sets all the given menu's option bits (menu option bits may be logically-OR'ed together). @@ -95,11 +94,6 @@ System error occurred (see \fBerrno\fP(3)). .TP 5 .B E_POSTED The menu is already posted. -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -107,3 +101,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/menu_pattern.3x b/upstream/archlinux/man3/menu_pattern.3x index faaf6475..8965c381 100644 --- a/upstream/archlinux/man3/menu_pattern.3x +++ b/upstream/archlinux/man3/menu_pattern.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,18 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_pattern.3x,v 1.24 2022/02/12 20:02:20 tom Exp $ -.TH menu_pattern 3X "" +.\" $Id: menu_pattern.3x,v 1.38 2024/03/16 15:35:01 tom Exp $ +.TH menu_pattern 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBset_menu_pattern\fP, -\fBmenu_pattern\fP \- set and get a menu's pattern buffer +\fBmenu_pattern\fP \- +set and get a menu's pattern buffer .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint set_menu_pattern(MENU *\fImenu\fB, const char *\fIpattern\fB);\fR -.br -\fBchar *menu_pattern(const MENU *\fImenu\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint set_menu_pattern(MENU *\fImenu\fP, const char *\fIpattern\fP); +\fBchar *menu_pattern(const MENU *\fImenu\fP); +.fi .SH DESCRIPTION Every menu has an associated pattern match buffer. As input events that are @@ -78,11 +79,6 @@ Character failed to match. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -90,3 +86,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/menu_post.3x b/upstream/archlinux/man3/menu_post.3x index 2d96b558..03c762e9 100644 --- a/upstream/archlinux/man3/menu_post.3x +++ b/upstream/archlinux/man3/menu_post.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,18 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_post.3x,v 1.22 2022/02/12 20:02:20 tom Exp $ -.TH menu_post 3X "" +.\" $Id: menu_post.3x,v 1.36 2024/03/16 15:35:01 tom Exp $ +.TH menu_post 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBpost_menu\fP, -\fBunpost_menu\fP \- write or erase menus from associated subwindows +\fBunpost_menu\fP \- +write or erase menus from associated subwindows .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint post_menu(MENU *\fImenu\fB);\fR -.br -\fBint unpost_menu(MENU *\fImenu\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint post_menu(MENU *\fImenu\fP); +\fBint unpost_menu(MENU *\fImenu\fP); +.fi .SH DESCRIPTION The function \fBpost_menu\fP displays a menu to its associated subwindow. To @@ -77,11 +77,6 @@ The menu has not been posted. .TP 5 .B E_NOT_CONNECTED No items are connected to the menu. -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -89,3 +84,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/menu_requestname.3x b/upstream/archlinux/man3/menu_requestname.3x index 5c46f67d..73ae070f 100644 --- a/upstream/archlinux/man3/menu_requestname.3x +++ b/upstream/archlinux/man3/menu_requestname.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,18 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_requestname.3x,v 1.18 2022/02/12 20:02:20 tom Exp $ -.TH menu_requestname 3X "" +.\" $Id: menu_requestname.3x,v 1.33 2024/03/16 15:35:01 tom Exp $ +.TH menu_requestname 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBmenu_request_by_name\fP, -\fBmenu_request_name\fP \- handle printable menu request names +\fBmenu_request_name\fP \- +handle printable menu request names .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBconst char *menu_request_name(int \fIrequest\fB);\fR -.br -\fBint menu_request_by_name(const char *\fIname\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBconst char *menu_request_name(int \fIrequest\fP); +\fBint menu_request_by_name(const char *\fIname\fP); +.fi .SH DESCRIPTION The function \fBmenu_request_name\fP returns the printable name of a menu request code. @@ -53,13 +53,8 @@ and sets \fBerrno\fP to \fBE_BAD_ARGUMENT\fP. .br \fBmenu_request_by_name\fP returns \fBE_NO_MATCH\fP on error. It does not set \fBerrno\fP. -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY -These routines are specific to ncurses. +These routines are specific to \fI\%ncurses\fP. They were not supported on Version 7, BSD or System V implementations. It is recommended that @@ -67,3 +62,6 @@ any code depending on them be conditioned using NCURSES_VERSION. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/menu_spacing.3x b/upstream/archlinux/man3/menu_spacing.3x index bc34806c..a9b71d2a 100644 --- a/upstream/archlinux/man3/menu_spacing.3x +++ b/upstream/archlinux/man3/menu_spacing.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,61 +27,60 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_spacing.3x,v 1.20 2022/02/12 20:02:20 tom Exp $ -.TH menu_spacing 3X "" +.\" $Id: menu_spacing.3x,v 1.37 2024/03/16 15:35:01 tom Exp $ +.TH menu_spacing 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBset_menu_spacing\fP, -\fBmenu_spacing\fP \- set and get spacing between menu items. +\fBmenu_spacing\fP \- +set and get spacing between menu items. .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint set_menu_spacing(MENU *\fImenu\fB,\fR +.nf +\fB#include <menu.h> +.PP +\fBint set_menu_spacing(MENU *\fImenu\fP, \fBint \fIspc_description\fB,\fR \fBint \fIspc_rows\fB,\fR \fBint \fIspc_columns\fB);\fR -.br \fBint menu_spacing(const MENU *\fImenu\fB,\fR \fBint* \fIspc_description\fB,\fR \fBint* \fIspc_rows\fB,\fR \fBint* \fIspc_columns\fB);\fR -.br +.fi .SH DESCRIPTION The function \fBset_menu_spacing\fP sets the spacing information for the menu. -Its parameter \fBspc_description\fP controls the number of spaces +Its parameters provide the description and the size (in rows and columns). +.TP +\fIspc_description\fP +controls the number of spaces between an item name and an item description. It must not be larger than \fBTABSIZE\fP. The menu system puts in the middle of this spacing area the pad character. The remaining parts are filled with spaces. -The \fBspc_rows\fP parameter controls the number of rows +.TP +\fIspc_rows\fP +controls the number of rows that are used for an item. It must not be larger than 3. The menu system inserts the blank lines between item rows, these lines will contain the pad character in the appropriate positions. -The \fBspc_columns\fP parameter controls -the number of blanks between columns of items. +.TP +\fIspc_columns\fP +controls the number of blanks between columns of items. It must not be larger than \fBTABSIZE\fP. A value of 0 for all the spacing values resets them to the default, which is 1 for all of them. -.br -The function \fBmenu_spacing\fP passes back the spacing info for the menu. -If a -pointer is NULL, this specific info is simply not returned. +.PP +The function \fBmenu_spacing\fP returns the spacing information for the menu. +If a pointer is NULL, the corresponding information is simply not returned. .SH RETURN VALUE Both routines return \fBE_OK\fP on success. \fBset_menu_spacing\fP may return \fBE_POSTED\fP if the menu is posted, or \fBE_BAD_ARGUMENT\fP if one of the spacing values is out of range. -.SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_variables\fP(3X), -\fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY -These routines are specific to ncurses. +These routines are specific to \fI\%ncurses\fP. They were not supported on Version 7, BSD or System V implementations. It is recommended that @@ -90,3 +88,7 @@ any code depending on them be conditioned using NCURSES_VERSION. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%curs_variables\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/menu_userptr.3x b/upstream/archlinux/man3/menu_userptr.3x index d0d30bf4..baabf764 100644 --- a/upstream/archlinux/man3/menu_userptr.3x +++ b/upstream/archlinux/man3/menu_userptr.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,18 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_userptr.3x,v 1.19 2022/02/12 20:02:20 tom Exp $ -.TH menu_userptr 3X "" +.\" $Id: menu_userptr.3x,v 1.33 2024/03/16 15:35:01 tom Exp $ +.TH menu_userptr 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBset_menu_userptr\fP, -\fBmenu_userptr\fP \- associate application data with a menu item +\fBmenu_userptr\fP \- +associate application data with a menu item .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint set_menu_userptr(MENU *\fImenu\fB, void *\fIuserptr\fB);\fR -.br -\fBvoid *menu_userptr(const MENU *\fImenu\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint set_menu_userptr(MENU *\fImenu\fP, void *\fIuserptr\fP); +\fBvoid *menu_userptr(const MENU *\fImenu\fP); +.fi .SH DESCRIPTION Every menu and every menu item has a field that can be used to hold application-specific data (that is, the menu-driver code leaves it alone). @@ -49,11 +49,6 @@ These functions get and set the menu user pointer field. It does not set \fBerrno\fP. .PP \fBset_menu_userptr\fP returns \fBE_OK\fP (success). -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -64,3 +59,6 @@ We chose not to leave it as a char pointer for SVr4 compatibility. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/menu_win.3x b/upstream/archlinux/man3/menu_win.3x index 7d88e518..f0a9a840 100644 --- a/upstream/archlinux/man3/menu_win.3x +++ b/upstream/archlinux/man3/menu_win.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2006,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,23 +27,23 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_win.3x,v 1.18 2022/02/12 20:02:20 tom Exp $ -.TH menu_win 3X "" +.\" $Id: menu_win.3x,v 1.32 2024/03/16 15:35:01 tom Exp $ +.TH menu_win 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBmenu_win\fP \- make and break menu window and subwindow associations +\fBmenu_win\fP \- +make and break menu window and subwindow associations .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint set_menu_win(MENU *\fImenu\fB, WINDOW *\fIwin\fB);\fR -.br -\fBWINDOW *menu_win(const MENU *\fImenu\fB);\fR -.sp -\fBint set_menu_sub(MENU *\fImenu\fB, WINDOW *\fIsub\fB);\fR -.br -\fBWINDOW *menu_sub(const MENU *\fImenu\fB);\fR -.sp -\fBint scale_menu(const MENU *\fImenu, int *\fIrows\fB, int *\fIcolumns);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint set_menu_win(MENU *\fImenu\fP, WINDOW *\fIwin\fP); +\fBWINDOW *menu_win(const MENU *\fImenu\fP); +.PP +\fBint set_menu_sub(MENU *\fImenu\fP, WINDOW *\fIsub\fP); +\fBWINDOW *menu_sub(const MENU *\fImenu\fP); +.PP +\fBint scale_menu(const MENU *\fImenu\fP, int *\fIrows\fP, int *\fIcolumns\fP); +.fi .SH DESCRIPTION Every menu has an associated pair of \fBcurses\fP windows. The menu window @@ -80,13 +79,6 @@ The menu has already been posted. .TP 5 .B E_NOT_CONNECTED No items are connected to the menu. -.SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_variables\fP(3X), -\fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -94,3 +86,7 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%curs_variables\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/mitem_current.3x b/upstream/archlinux/man3/mitem_current.3x index 04640420..377e9073 100644 --- a/upstream/archlinux/man3/mitem_current.3x +++ b/upstream/archlinux/man3/mitem_current.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2006,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,23 +27,23 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_current.3x,v 1.23 2022/02/12 20:02:20 tom Exp $ -.TH mitem_current 3X "" +.\" $Id: mitem_current.3x,v 1.37 2024/03/16 15:35:01 tom Exp $ +.TH mitem_current 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBmitem_current\fP \- set and get current_menu_item +\fBmitem_current\fP \- +set and get current_menu_item .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint set_current_item(MENU *\fImenu\fB, ITEM *\fIitem\fB);\fR -.br -\fBITEM *current_item(const MENU *\fImenu\fB);\fR -.sp -\fBint set_top_row(MENU *\fImenu\fB, int \fIrow\fB);\fR -.br -\fBint top_row(const MENU *\fImenu\fB);\fR -.sp -\fBint item_index(const ITEM *\fIitem\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint set_current_item(MENU *\fImenu\fP, ITEM *\fIitem\fP); +\fBITEM *current_item(const MENU *\fImenu\fP); +.PP +\fBint set_top_row(MENU *\fImenu\fP, int \fIrow\fP); +\fBint top_row(const MENU *\fImenu\fP); +.PP +\fBint item_index(const ITEM *\fIitem\fP); +.fi .SH DESCRIPTION The function \fBset_current_item\fP sets the current item (the item on which the menu cursor is positioned). @@ -84,11 +83,6 @@ No items are connected to the menu. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -99,3 +93,6 @@ The SVr4 menu library documentation specifies the \fBtop_row\fP and .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/mitem_name.3x b/upstream/archlinux/man3/mitem_name.3x index 7023b027..8edf0d26 100644 --- a/upstream/archlinux/man3/mitem_name.3x +++ b/upstream/archlinux/man3/mitem_name.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,18 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_name.3x,v 1.17 2022/02/12 20:02:20 tom Exp $ -.TH mitem_name 3X "" +.\" $Id: mitem_name.3x,v 1.31 2024/03/16 15:35:01 tom Exp $ +.TH mitem_name 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBitem_name\fP, -\fBitem_description\fP \- get menu item name and description fields +\fBitem_description\fP \- +get menu item name and description fields .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBconst char *item_name(const ITEM *\fIitem\fB);\fR -.br -\fBconst char *item_description(const ITEM *\fIitem\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBconst char *item_name(const ITEM *\fIitem\fP); +\fBconst char *item_description(const ITEM *\fIitem\fP); +.fi .SH DESCRIPTION The function \fBitem_name\fP returns the name part of the given item. .br @@ -48,14 +48,12 @@ item. .SH RETURN VALUE These routines return a pointer (which may be \fBNULL\fP). They do not set \fBerrno\fP. -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/mitem_new.3x b/upstream/archlinux/man3/mitem_new.3x index 7a0178ac..ecf3925d 100644 --- a/upstream/archlinux/man3/mitem_new.3x +++ b/upstream/archlinux/man3/mitem_new.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,18 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_new.3x,v 1.22 2022/02/12 20:02:20 tom Exp $ -.TH mitem_new 3X "" +.\" $Id: mitem_new.3x,v 1.36 2024/03/16 15:35:01 tom Exp $ +.TH mitem_new 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBnew_item\fP, -\fBfree_item\fP \- create and destroy menu items +\fBfree_item\fP \- +create and destroy menu items .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBITEM *new_item(const char *\fIname\fB, const char *\fIdescription\fB);\fR -.br -\fBint free_item(ITEM *\fIitem\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBITEM *new_item(const char *\fIname\fP, const char *\fIdescription\fP); +\fBint free_item(ITEM *\fIitem\fP); +.fi .SH DESCRIPTION The function \fBnew_item\fP allocates a new item and initializes it from the \fBname\fP and \fBdescription\fP pointers. @@ -77,11 +77,6 @@ Item is connected to a menu. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -89,3 +84,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/mitem_opts.3x b/upstream/archlinux/man3/mitem_opts.3x index 716584c8..9fec8d36 100644 --- a/upstream/archlinux/man3/mitem_opts.3x +++ b/upstream/archlinux/man3/mitem_opts.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,24 +27,24 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_opts.3x,v 1.19 2022/02/12 20:02:20 tom Exp $ -.TH mitem_opts 3X "" +.\" $Id: mitem_opts.3x,v 1.33 2024/03/16 15:35:01 tom Exp $ +.TH mitem_opts 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBset_item_opts\fP, \fBitem_opts_on\fP, \fBitem_opts_off\fP, -\fBitem_opts\fP \- set and get menu item options +\fBitem_opts\fP \- +set and get menu item options .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint set_item_opts(ITEM *\fIitem\fB, Item_Options \fIopts\fB);\fR -.br -\fBItem_Options item_opts(const ITEM *\fIitem\fB);\fR -.sp -\fBint item_opts_on(ITEM *\fIitem\fB, Item_Options \fIopts\fB);\fR -.br -\fBint item_opts_off(ITEM *\fIitem\fB, Item_Options \fIopts\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint set_item_opts(ITEM *\fIitem\fP, Item_Options \fIopts\fP); +\fBItem_Options item_opts(const ITEM *\fIitem\fP); +.PP +\fBint item_opts_on(ITEM *\fIitem\fP, Item_Options \fIopts\fP); +\fBint item_opts_off(ITEM *\fIitem\fP, Item_Options \fIopts\fP); +.fi .SH DESCRIPTION The function \fBset_item_opts\fP sets all the given item's option bits (menu option bits may be logically-OR'ed together). @@ -70,11 +69,6 @@ The routine succeeded. .TP 5 .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fP(3)). -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -82,3 +76,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/mitem_userptr.3x b/upstream/archlinux/man3/mitem_userptr.3x index 1d492c51..0e54199c 100644 --- a/upstream/archlinux/man3/mitem_userptr.3x +++ b/upstream/archlinux/man3/mitem_userptr.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,18 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_userptr.3x,v 1.20 2022/02/12 20:02:20 tom Exp $ -.TH mitem_userptr 3X "" +.\" $Id: mitem_userptr.3x,v 1.34 2024/03/16 15:35:01 tom Exp $ +.TH mitem_userptr 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBset_item_userptr\fP, -\fBitem_userptr\fP \- associate application data with a menu item +\fBitem_userptr\fP \- +associate application data with a menu item .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint set_item_userptr(ITEM *\fIitem\fB, void *\fIuserptr\fB);\fR -.br -\fBvoid *item_userptr(const ITEM *\fIitem\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint set_item_userptr(ITEM *\fIitem\fP, void *\fIuserptr\fP); +\fBvoid *item_userptr(const ITEM *\fIitem\fP); +.fi .SH DESCRIPTION Every menu item has a field that can be used to hold application-specific data (that is, the menu-driver code leaves it alone). @@ -50,12 +50,6 @@ The function \fBitem_userptr\fP returns a pointer (possibly \fBNULL\fP). It does not set \fBerrno\fP. .PP The \fBset_item_userptr\fP always returns \fBE_OK\fP (success). -. -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -66,3 +60,6 @@ We chose not to leave it as a char pointer for SVr4 compatibility. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/mitem_value.3x b/upstream/archlinux/man3/mitem_value.3x index 0677301f..165f5c62 100644 --- a/upstream/archlinux/man3/mitem_value.3x +++ b/upstream/archlinux/man3/mitem_value.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,18 +27,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_value.3x,v 1.18 2022/02/12 20:02:20 tom Exp $ -.TH mitem_value 3X "" +.\" $Id: mitem_value.3x,v 1.32 2024/03/16 15:35:01 tom Exp $ +.TH mitem_value 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME \fBset_item_value\fP, -\fBitem_value\fP \- set and get menu item values +\fBitem_value\fP \- +set and get menu item values .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBint set_item_value(ITEM *\fIitem\fB, bool \fIvalue\fB);\fR -.br -\fBbool item_value(const ITEM *\fIitem\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBint set_item_value(ITEM *\fIitem\fP, bool \fIvalue\fP); +\fBbool item_value(const ITEM *\fIitem\fP); +.fi .SH DESCRIPTION If you turn off the menu option \fBO_ONEVALUE\fP (e.g., with \fBset_menu_opts\fP or \fBmenu_opts_off\fP; see \fBmenu_opts\fP(3X)), the menu @@ -59,11 +60,6 @@ System error occurred (see \fBerrno\fP(3)). .TP 5 .B E_REQUEST_DENIED The menu driver could not process the request. -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -71,3 +67,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/mitem_visible.3x b/upstream/archlinux/man3/mitem_visible.3x index 4fb4e369..0c099409 100644 --- a/upstream/archlinux/man3/mitem_visible.3x +++ b/upstream/archlinux/man3/mitem_visible.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,24 +27,21 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_visible.3x,v 1.13 2022/02/12 20:03:40 tom Exp $ -.TH mitem_visible 3X "" +.\" $Id: mitem_visible.3x,v 1.27 2024/03/16 15:35:01 tom Exp $ +.TH mitem_visible 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBmitem_visible\fP \- check visibility of a menu item +\fBitem_visible\fP \- +check visibility of a menu item .SH SYNOPSIS -\fB#include <menu.h>\fP -.sp -\fBbool item_visible(const ITEM *\fIitem\fB);\fR -.br +.nf +\fB#include <menu.h> +.PP +\fBbool item_visible(const ITEM *\fIitem\fP); +.fi .SH DESCRIPTION A menu item is visible when it is in the portion of a posted menu that is mapped onto the screen (if the menu is scrollable, in particular, this portion will be smaller than the whole menu). -.SH SEE ALSO -\fBcurses\fP(3X), \fBmenu\fP(3X). -.SH NOTES -The header file \fB<menu.h>\fP automatically includes the header file -\fB<curses.h>\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -53,3 +49,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X) diff --git a/upstream/archlinux/man3/mkdtemp.3 b/upstream/archlinux/man3/mkdtemp.3 index 913103b0..5bc3d90f 100644 --- a/upstream/archlinux/man3/mkdtemp.3 +++ b/upstream/archlinux/man3/mkdtemp.3 @@ -4,7 +4,7 @@ .\" and GNU libc documentation .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft -.TH mkdtemp 3 2023-10-31 "Linux man-pages 6.06" +.TH mkdtemp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mkdtemp \- create a unique temporary directory .SH LIBRARY diff --git a/upstream/archlinux/man3/mkfifo.3 b/upstream/archlinux/man3/mkfifo.3 index 273517f0..e14680c2 100644 --- a/upstream/archlinux/man3/mkfifo.3 +++ b/upstream/archlinux/man3/mkfifo.3 @@ -6,7 +6,7 @@ .\" .\" changed section from 2 to 3, aeb, 950919 .\" -.TH mkfifo 3 2023-10-31 "Linux man-pages 6.06" +.TH mkfifo 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mkfifo, mkfifoat \- make a FIFO special file (a named pipe) .SH LIBRARY diff --git a/upstream/archlinux/man3/mkstemp.3 b/upstream/archlinux/man3/mkstemp.3 index 08649356..b72ce3ab 100644 --- a/upstream/archlinux/man3/mkstemp.3 +++ b/upstream/archlinux/man3/mkstemp.3 @@ -13,7 +13,7 @@ .\" Modified 990328, aeb .\" 2008-06-19, mtk, Added mkostemp(); various other changes .\" -.TH mkstemp 3 2023-10-31 "Linux man-pages 6.06" +.TH mkstemp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mkstemp, mkostemp, mkstemps, mkostemps \- create a unique temporary file .SH LIBRARY diff --git a/upstream/archlinux/man3/mktemp.3 b/upstream/archlinux/man3/mktemp.3 index dbc7d0e8..b3b2837d 100644 --- a/upstream/archlinux/man3/mktemp.3 +++ b/upstream/archlinux/man3/mktemp.3 @@ -12,7 +12,7 @@ .\" (prompted by Scott Burkett <scottb@IntNet.net>) .\" Modified Sun Mar 28 23:44:38 1999 by Andries Brouwer (aeb@cwi.nl) .\" -.TH mktemp 3 2023-10-31 "Linux man-pages 6.06" +.TH mktemp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mktemp \- make a unique temporary filename .SH LIBRARY diff --git a/upstream/archlinux/man3/modf.3 b/upstream/archlinux/man3/modf.3 index b5c88f61..5350a2e6 100644 --- a/upstream/archlinux/man3/modf.3 +++ b/upstream/archlinux/man3/modf.3 @@ -11,7 +11,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH modf 3 2023-10-31 "Linux man-pages 6.06" +.TH modf 3 2024-05-02 "Linux man-pages 6.8" .SH NAME modf, modff, modfl \- extract signed integral and fractional values from floating-point number diff --git a/upstream/archlinux/man3/mpool.3 b/upstream/archlinux/man3/mpool.3 index 75ac55bd..8368b11c 100644 --- a/upstream/archlinux/man3/mpool.3 +++ b/upstream/archlinux/man3/mpool.3 @@ -5,7 +5,7 @@ .\" .\" @(#)mpool.3 8.1 (Berkeley) 6/4/93 .\" -.TH mpool 3 2023-10-31 "Linux man-pages 6.06" +.TH mpool 3 2024-05-02 "Linux man-pages 6.8" .UC 7 .SH NAME mpool \- shared memory buffer pool diff --git a/upstream/archlinux/man3/mq_close.3 b/upstream/archlinux/man3/mq_close.3 index 7640af41..08af2c20 100644 --- a/upstream/archlinux/man3/mq_close.3 +++ b/upstream/archlinux/man3/mq_close.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH mq_close 3 2023-10-31 "Linux man-pages 6.06" +.TH mq_close 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mq_close \- close a message queue descriptor .SH LIBRARY diff --git a/upstream/archlinux/man3/mq_getattr.3 b/upstream/archlinux/man3/mq_getattr.3 index 7737679a..e5c2a007 100644 --- a/upstream/archlinux/man3/mq_getattr.3 +++ b/upstream/archlinux/man3/mq_getattr.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH mq_getattr 3 2023-10-31 "Linux man-pages 6.06" +.TH mq_getattr 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mq_getattr, mq_setattr \- get/set message queue attributes .SH LIBRARY diff --git a/upstream/archlinux/man3/mq_notify.3 b/upstream/archlinux/man3/mq_notify.3 index c3ba915d..6e4ee927 100644 --- a/upstream/archlinux/man3/mq_notify.3 +++ b/upstream/archlinux/man3/mq_notify.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH mq_notify 3 2023-10-31 "Linux man-pages 6.06" +.TH mq_notify 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mq_notify \- register for notification when a message is available .SH LIBRARY diff --git a/upstream/archlinux/man3/mq_open.3 b/upstream/archlinux/man3/mq_open.3 index 5a61f3d5..404ea35e 100644 --- a/upstream/archlinux/man3/mq_open.3 +++ b/upstream/archlinux/man3/mq_open.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH mq_open 3 2023-10-31 "Linux man-pages 6.06" +.TH mq_open 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mq_open \- open a message queue .SH LIBRARY diff --git a/upstream/archlinux/man3/mq_receive.3 b/upstream/archlinux/man3/mq_receive.3 index 62459e53..c3969b43 100644 --- a/upstream/archlinux/man3/mq_receive.3 +++ b/upstream/archlinux/man3/mq_receive.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH mq_receive 3 2023-10-31 "Linux man-pages 6.06" +.TH mq_receive 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mq_receive, mq_timedreceive \- receive a message from a message queue .SH LIBRARY diff --git a/upstream/archlinux/man3/mq_send.3 b/upstream/archlinux/man3/mq_send.3 index 701abf31..86d515ed 100644 --- a/upstream/archlinux/man3/mq_send.3 +++ b/upstream/archlinux/man3/mq_send.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH mq_send 3 2023-10-31 "Linux man-pages 6.06" +.TH mq_send 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mq_send, mq_timedsend \- send a message to a message queue .SH LIBRARY diff --git a/upstream/archlinux/man3/mq_unlink.3 b/upstream/archlinux/man3/mq_unlink.3 index c68e663b..0f81ba06 100644 --- a/upstream/archlinux/man3/mq_unlink.3 +++ b/upstream/archlinux/man3/mq_unlink.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH mq_unlink 3 2023-10-31 "Linux man-pages 6.06" +.TH mq_unlink 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mq_unlink \- remove a message queue .SH LIBRARY diff --git a/upstream/archlinux/man3/mtrace.3 b/upstream/archlinux/man3/mtrace.3 index 8a98fae2..8123ed98 100644 --- a/upstream/archlinux/man3/mtrace.3 +++ b/upstream/archlinux/man3/mtrace.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH mtrace 3 2023-10-31 "Linux man-pages 6.06" +.TH mtrace 3 2024-05-02 "Linux man-pages 6.8" .SH NAME mtrace, muntrace \- malloc tracing .SH LIBRARY @@ -124,7 +124,7 @@ The demonstration uses the following program: .P .in +4n .RB "$ " "cat t_mtrace.c" -.\" [[memory leak]] SRC BEGIN (t_mtrace.c) +.\" SRC BEGIN (t_mtrace.c) .EX #include <mcheck.h> #include <stdio.h> diff --git a/upstream/archlinux/man3/nan.3 b/upstream/archlinux/man3/nan.3 index 4ee2f7cd..778b6f8f 100644 --- a/upstream/archlinux/man3/nan.3 +++ b/upstream/archlinux/man3/nan.3 @@ -7,7 +7,7 @@ .\" .\" Corrections by aeb .\" -.TH nan 3 2023-10-31 "Linux man-pages 6.06" +.TH nan 3 2024-05-02 "Linux man-pages 6.8" .SH NAME nan, nanf, nanl \- return 'Not a Number' .SH LIBRARY diff --git a/upstream/archlinux/man3/ncurses.3x b/upstream/archlinux/man3/ncurses.3x index 97438adf..7e94f433 100644 --- a/upstream/archlinux/man3/ncurses.3x +++ b/upstream/archlinux/man3/ncurses.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2021,2023 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,310 +28,542 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: ncurses.3x,v 1.157 2023/04/23 23:17:26 tom Exp $ -.hy 0 -.TH ncurses 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: ncurses.3x,v 1.214 2024/04/27 17:55:43 tom Exp $ +.TH ncurses 3X 2024-04-27 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.de NS -.ie n .sp -.el .sp .5 -.ie n .in +4 -.el .in +2 -.nf -.ft C \" Courier -.. -.de NE -.fi -.ft R -.ie n .in -4 -.el .in -2 +. +.\" Add supplementary paragraph tag on its own line after TP. +.\" Adapted from TQ (which would produce mandoc warnings). +.de tQ +. br +. ns +. TP .. -.ds n 5 +. .ds d /usr/share/terminfo .SH NAME -\fBncurses\fP \- CRT screen handling and optimization package +\fB\%ncurses\fP \- +character-cell terminal interface with optimized output .SH SYNOPSIS -\fB#include <curses.h>\fP -.br +.nf +\fB#include <curses.h> +.fi .SH DESCRIPTION -The \fBncurses\fP library routines give the user a terminal-independent method -of updating character screens with reasonable optimization. -This implementation is \*(``new curses\*('' (ncurses) and -is the approved replacement for -4.4BSD classic curses, which has been discontinued. -This describes \fBncurses\fP -version 6.4 (patch 20230520). -.PP -The \fBncurses\fP library emulates the curses library of -System V Release 4 UNIX, -and XPG4 (X/Open Portability Guide) curses (also known as XSI curses). -XSI stands for X/Open System Interfaces Extension. -The \fBncurses\fP library is freely redistributable in source form. -Differences from the SVr4 -curses are summarized under the -\fIEXTENSIONS\fP and \fIPORTABILITY\fP sections below and -described in detail in the respective -\fIEXTENSIONS\fP, \fIPORTABILITY\fP and \fIBUGS\fP sections -of individual man pages. -.PP -The \fBncurses\fP library also provides many useful extensions, -i.e., features which cannot be implemented by a simple add-on library -but which require access to the internals of the library. -.PP -A program using these routines must be linked with the \fB\-lncurses\fP option, -or (if it has been generated) with the debugging library \fB\-lncurses_g\fP. -(Your system integrator may also have installed these libraries under -the names \fB\-lcurses\fP and \fB\-lcurses_g\fP.) -The ncurses_g library generates trace logs (in a file called \*(``trace\*('' in the -current directory) that describe curses actions. -See also the section on \fBALTERNATE CONFIGURATIONS\fP. -.PP -The \fBncurses\fP package supports: overall screen, window and pad -manipulation; output to windows and pads; reading terminal input; control over -terminal and \fBcurses\fP input and output options; environment query -routines; color manipulation; use of soft label keys; terminfo capabilities; -and access to low-level terminal-manipulation routines. -.SS Initialization -.PP -The library uses the locale which the calling program has initialized. -That is normally done with \fBsetlocale\fP(3): -.NS -\fBsetlocale(LC_ALL, "");\fP -.NE -.PP -If the locale is not initialized, -the library assumes that characters are printable as in ISO\-8859\-1, +The \*(``new curses\*('' library offers the programmer a +terminal-independent means of reading keyboard and mouse input and +updating character-cell terminals with output optimized to minimize +screen updates. +.I \%ncurses +replaces the +.I curses +libraries from +System V Release 4 Unix (\*(``SVr4\*('') +and +4.4BSD Unix, +the development of which ceased in the 1990s. +This document describes +.I \%ncurses +version 6.5 +(patch 20240427). +.PP +.I \%ncurses +permits control of the terminal screen's contents; +abstraction and subdivision thereof with +.I windows +and +.IR pads ; +the reading of terminal input; +control of terminal input and output options; +environment query routines; +color manipulation; +the definition and use of +.I "soft label" +keys; +.I \%term\%info +capability access; +a +.I termcap +compatibility interface; +and an abstraction of the system's API for manipulating the terminal +(such as \fI\%termios\fP(3)). +.PP +.I \%ncurses +implements the standard interface described by +X/Open Curses Issue\ 7. +In many behavioral details not standardized by X/Open, +.I \%ncurses +emulates the +.I curses +library of SVr4 and provides numerous useful extensions. +.PP +.I \%ncurses +man pages employ several sections to clarify matters of usage and +interoperability with other +.I curses +implementations. +.bP +\*(``NOTES\*('' describes issues and caveats of which any user of the +.I \%ncurses +API should be aware, +such as limitations on the size of an underlying integral type or the +availability of a preprocessor macro exclusive of a function definition +(which prevents its address from being taken). +This section also describes implementation details that will be +significant to the programmer but which are not standardized. +.bP +\*(``EXTENSIONS\*('' presents +.I \%ncurses +innovations beyond the X/Open Curses standard and/or the SVr4 +.I curses +implementation. +They are termed +.I extensions +to indicate that they cannot be implemented solely by using the library +API, +but require access to the library's internal state. +.bP +\*(``PORTABILITY\*('' discusses matters +(beyond the exercise of extensions) +that should be considered when writing to a +.I curses +standard, +or for multiple implementations. +.bP +\*(``HISTORY\*('' examines points of detail in +.I \%ncurses +and other +.I curses +implementations over the decades of their development, +particularly where precedent or inertia have frustrated better design +(and, +in a few cases, +where such inertia has been overcome). +.PP +A +.I curses +application must be linked with the library; +use the +.B \-lncurses +option to your compiler or linker. +A debugging version of the library may be available; +if so, +link with it using +.BR \-lncurses_g . +(Your system integrator may have installed these libraries such that you +can use the options +.B \-lcurses +and +.BR \-lcurses_g , +respectively.) +The +.I \%ncurses_g +library generates trace logs +(in a file called +.I \%trace +in the current directory) +that describe +.I \%ncurses +actions. +See section \*(``ALTERNATE CONFIGURATIONS\*('' below. +.SS "Application Structure" +A +.I curses +application uses information from the system locale; +\fI\%setlocale\fP(3) prepares it for +.I curses +library calls. +.PP +.RS 4 +.EX +setlocale(LC_ALL, ""); +.EE +.RE +.PP +If the locale is not thus initialized, +the library assumes that characters are printable as in ISO\ 8859-1, to work with certain legacy programs. -You should initialize the locale and not rely on specific details of -the library when the locale has not been setup. -.PP -The function \fBinitscr\fP or \fBnewterm\fP -must be called to initialize the library -before any of the other routines that deal with windows -and screens are used. -The routine \fBendwin\fP(3X) must be called before exiting. -.PP -To get character-at-a-time input without echoing (most -interactive, screen oriented programs want this), the following -sequence should be used: -.NS -\fBinitscr(); cbreak(); noecho();\fP -.NE -.PP -Most programs would additionally use the sequence: -.NS -\fBintrflush(stdscr, FALSE);\fP -\fBkeypad(stdscr, TRUE);\fP -.NE -.PP -Before a \fBcurses\fP program is run, the tab stops of the terminal -should be set and its initialization strings, if defined, must be output. -This can be done by executing the \fBtput init\fP command -after the shell environment variable \fBTERM\fP has been exported. -\fBtset(1)\fP is usually responsible for doing this. -[See \fBterminfo\fP(\*n) for further details.] -.SS Datatypes -.PP -The \fBncurses\fP library permits manipulation of data structures, -called \fIwindows\fP, which can be thought of as two-dimensional -arrays of characters representing all or part of a CRT screen. -A default window called \fBstdscr\fP, which is the size of the terminal -screen, is supplied. -Others may be created with \fBnewwin\fP. -.PP -Note that \fBcurses\fP does not handle overlapping windows, that's done by -the \fBpanel\fP(3X) library. -This means that you can either use -\fBstdscr\fP or divide the screen into tiled windows and not using -\fBstdscr\fP at all. -Mixing the two will result in unpredictable, and undesired, effects. -.PP -Windows are referred to by variables declared as \fBWINDOW *\fP. -These data structures are manipulated with routines described here and -elsewhere in the \fBncurses\fP manual pages. -Among those, the most basic -routines are \fBmove\fP and \fBaddch\fP. -More general versions of -these routines are included with names beginning with \fBw\fP, -allowing the user to specify a window. -The routines not beginning -with \fBw\fP affect \fBstdscr\fP. -.PP -After using routines to manipulate a window, \fBrefresh\fP(3X) is called, -telling \fBcurses\fP to make the user's CRT screen look like -\fBstdscr\fP. -The characters in a window are actually of type -\fBchtype\fP, (character and attribute data) so that other information -about the character may also be stored with each character. -.PP -Special windows called \fIpads\fP may also be manipulated. -These are windows -which are not constrained to the size of the screen and whose contents need not -be completely displayed. -See \fBcurs_pad\fP(3X) for more information. -.PP -In addition to drawing characters on the screen, video attributes and colors -may be supported, causing the characters to show up in such modes as -underlined, in reverse video, or in color on terminals that support such -display enhancements. -Line drawing characters may be specified to be output. -On input, \fBcurses\fP is also able to translate arrow and function keys that -transmit escape sequences into single values. -The video attributes, line -drawing characters, and input values use names, defined in \fB<curses.h>\fP, -such as \fBA_REVERSE\fP, \fBACS_HLINE\fP, and \fBKEY_LEFT\fP. -.SS Environment variables -.PP -If the environment variables \fBLINES\fP and \fBCOLUMNS\fP are set, or if the -program is executing in a window environment, line and column information in -the environment will override information read by \fIterminfo\fP. -This would affect a program running in an AT&T 630 layer, -for example, where the size of a -screen is changeable (see \fBENVIRONMENT\fP). -.PP -If the environment variable \fBTERMINFO\fP is defined, any program using -\fBcurses\fP checks for a local terminal definition before checking in the -standard place. -For example, if \fBTERM\fP is set to \fBatt4424\fP, then the -compiled terminal definition is found in -.NS -\fB\*d/a/att4424\fP. -.NE -.PP -(The \fBa\fP is copied from the first letter of \fBatt4424\fP to avoid -creation of huge directories.) However, if \fBTERMINFO\fP is set to -\fB$HOME/myterms\fP, \fBcurses\fP first checks -.NS -\fB$HOME/myterms/a/att4424\fP, -.NE -.PP -and if that fails, it then checks -.NS -\fB\*d/a/att4424\fP. -.NE -.PP -This is useful for developing experimental definitions or when write -permission in \fB\*d\fP is not available. -.PP -The integer variables \fBLINES\fP and \fBCOLS\fP are defined in -\fB<curses.h>\fP and will be filled in by \fBinitscr\fP with the size of the -screen. -The constants \fBTRUE\fP and \fBFALSE\fP have the values \fB1\fP and -\fB0\fP, respectively. -.PP -The \fBcurses\fP routines also define the \fBWINDOW *\fP variable \fBcurscr\fP -which is used for certain low-level operations like clearing and redrawing a -screen containing garbage. -The \fBcurscr\fP can be used in only a few routines. -.\" -.SS Routine and Argument Names -Many \fBcurses\fP routines have two or more versions. -The routines prefixed with \fIw\fP require a window argument. -The routines prefixed with \fIp\fP require a pad argument. -Those without a prefix generally use \fBstdscr\fP. -.PP -The routines prefixed with \fBmv\fP require a \fIy\fP and \fIx\fP -coordinate to move to before performing the appropriate action. -The \fBmv\fP routines imply a call to \fBmove\fP before the call to the -other routine. -The coordinate \fIy\fP always refers to the row (of -the window), and \fIx\fP always refers to the column. -The upper left-hand corner is always (0,0), not (1,1). -.PP -The routines prefixed with \fBmvw\fP take both a window argument and -\fIx\fP and \fIy\fP coordinates. -The window argument is always specified before the coordinates. -.PP -In each case, \fIwin\fP is the window affected, and \fIpad\fP is the -pad affected; \fIwin\fP and \fIpad\fP are always pointers to type -\fBWINDOW\fP. -.PP -Option setting routines require a Boolean flag \fIbf\fP with the value -\fBTRUE\fP or \fBFALSE\fP; \fIbf\fP is always of type \fBbool\fP. -Most of the data types used in the library routines, -such as \fBWINDOW\fP, \fBSCREEN\fP, \fBbool\fP, and \fBchtype\fP -are defined in \fB<curses.h>\fP. -Types used for the terminfo routines such as -\fBTERMINAL\fP are defined in \fB<term.h>\fP. -.PP -This manual page describes functions which may appear in any configuration +You should initialize the locale; +do not expect consistent behavior from the library when the locale has +not been set up. +.PP +\fB\%initscr\fP(3X) or \fB\%newterm\fP(3X) +must be called to initialize +.I curses +before use of any functions that deal with windows and screens. +.PP +To get character-at-a-time input without echoing\(emmost interactive, +screen-oriented programs want this\(emuse the following sequence. +.PP +.RS 4 +.EX +initscr(); cbreak(); noecho(); +.EE +.RE +.PP +Most applications perform further setup as follows. +.PP +.RS 4 +.EX +intrflush(stdscr, FALSE); +keypad(stdscr, TRUE); +.EE +.RE +.PP +A +.I curses +program then often enters an event loop of some sort. +Call \fB\%endwin\fP(3X) before exiting. +.SS Overview +A +.I curses +library abstracts the terminal screen by representing all or part of it +as a +.I \%WINDOW +data structure. +A +.I window +is a rectangular grid of character cells, +addressed by row and column coordinates +.RI ( y , +.IR x ), +with the upper left corner as (0, 0). +A window called +.BR \%stdscr , +the same size as the terminal screen, +is always available. +Create others with \fB\%newwin\fP(3X). +.PP +A +.I curses +library does not manage overlapping windows +(but see below). +You can either use +.B \%stdscr +to manage one screen-filling window, +or tile the screen into non-overlapping windows and not use +.B \%stdscr +at all. +Mixing the two approaches will result in unpredictable and undesired +effects. +.PP +Functions permit manipulation of a window and the +.I cursor +identifying the cell within it at which the next output operation will +occur. +Among those, +the most basic are \fB\%move\fP(3X) and \fB\%addch\fP(3X): +these place the cursor and write a character to +.BR \%stdscr , +respectively. +.PP +Frequent changes to the terminal screen can cause unpleasant flicker or +inefficient use of the communication channel to the device, +so the library does not generally update it automatically. +Therefore, +after using +.I curses +functions to accumulate a set of desired updates that make sense to +present together, +call \fB\%refresh\fP(3X) to tell the library to make the user's screen +look like \fBstdscr\fP. +The library +.\" X/Open Curses Issue 7 assumes some optimization will be done, but +.\" does not mandate it in any way. +.I optimizes +its output by computing a minimal number of operations to mutate the +screen from its state at the previous refresh to the new one. +Effective optimization demands accurate information about the terminal +device: +the management of such information is the province of the +\fB\%terminfo\fP(3X) API, +a feature of every standard +.I curses +implementation. +.PP +Special windows called +.I pads +may also be manipulated. +These are windows that are not constrained to the size of the terminal +screen and whose contents need not be completely displayed. +See \fB\%curs_pad\fP(3X). +.PP +In addition to drawing characters on the screen, +rendering attributes and colors may be supported, +causing the characters to show up in such modes as underlined, +in reverse video, +or in color on terminals that support such display enhancements. +See \fB\%curs_attr\fP(3X). +.PP +.I curses +predefines constants for a small set of forms-drawing graphics +corresponding to the DEC Alternate Character Set (ACS), +a feature of VT100 and other terminals. +See \fB\%waddch\fP(3X). +.PP +.I curses +is implemented using the operating system's terminal driver; +keystroke events are received not as scan codes but as byte sequences. +Graphical keycaps +(alphanumeric and punctuation keys, +and the space) +appear as-is. +Everything else, +including the tab, +enter/return, +keypad, +arrow, +and function keys, +appears as a control character or a multibyte +.I "escape sequence." +.I curses +translates these into unique +.I "key codes." +See \fB\%getch\fP(3X). +.PP +.I \%ncurses +provides reimplementations of the SVr4 \fBpanel\fP(3X), \fBform\fP(3X), +and \fBmenu\fP(3X) libraries to ease construction of user interfaces +with +.IR curses . +.SS "Initialization" +The selection of an appropriate value of +.I TERM +in the process environment is essential to correct +.I curses +and +.I \%term\%info +library operation. +A well-configured system selects a correct +.I TERM +value automatically; +\fB\%tset\fP(1) may assist with troubleshooting exotic situations. +.PP +If you change the terminal type, +export the +.I TERM +environment variable in the shell, +then run \fB\%tset\fP(1) or the +.RB \*(`` "tput init" \*('' +command. +See subsection \*(``Tabs and Initialization\*('' of \fB\%terminfo\fP(5). +.PP +If the environment variables +.I \%LINES +and +.I \%COLUMNS +are set, +or if the +.I curses +program is executing in a graphical windowing environment, +the information obtained thence overrides that obtained by +.IR \%term\%info . +An +.I \%ncurses +extension supports resizable terminals; +see \fB\%wresize\fP(3X). +.PP +If the environment variable +.I \%TERMINFO +is defined, +a +.I curses +program checks first for a terminal type description in the location it +identifies. +.I \%TERMINFO +is useful for developing experimental type descriptions or when write +permission to +.I \%\*d +is not available. +.PP +See section \*(``ENVIRONMENT\*('' below. +.SS "Naming Conventions" +.I curses +offers many functions in variant forms using a regular set of +alternatives to the name of an elemental one. +Those prefixed with \*(``w\*('' require a +.I \%WINDOW +pointer argument; +those with a \*(``mv\*('' prefix first perform cursor movement using +\fB\%wmove\fP(3X); +a \*(``mvw\*('' prefix indicates both. +The \*(``w\*('' function is typically the elemental one; +the removal of this prefix usually indicates operation on +.BR \%stdscr . +.PP +Four functions prefixed with \*(``p\*('' require a pad argument. +.PP +In function synopses, +.I \%ncurses +man pages apply the following names to parameters. +.PP +.TS +center; +Li L. +bf \fIbool\fP (\fBTRUE\fP or \fBFALSE\fP) +c a \fIchar\fP or \fIint\fP +ch a \fIchtype\fP +wc a \fIwchar_t\fP or \fIwint_t\fP +wch a \fIcchar_t\fP +win pointer to a \fIWINDOW\fP +pad pointer to a \fIWINDOW\fP that is a pad +.TE +.SS "Wide and Non-wide Character Configurations" +This manual page describes functions that appear in any configuration of the library. -There are two common configurations of the library: -.RS 3 -.TP 5 -.I ncurses -the \*(``normal\*('' library, which handles 8-bit characters. -The normal (8-bit) library stores characters combined with attributes -in \fBchtype\fP data. -.IP -Attributes alone (no corresponding character) may be stored in \fBchtype\fP -or the equivalent \fBattr_t\fP data. -In either case, the data is stored in something like an integer. +There are two common configurations; +see section \*(``ALTERNATE CONFIGURATIONS\*('' below. +.TP 10 \" "ncursesw" + 2n +.I \%ncurses +is the library in its \*(``non-wide\*('' configuration, +handling only eight-bit characters. +It stores a character combined with attributes in a +.I \%chtype +datum, +which is often an alias of +.IR int . .IP -Each cell (row and column) in a \fBWINDOW\fP is stored as a \fBchtype\fP. -.TP 5 -.I ncursesw -the so-called \*(``wide\*('' library, which handles multibyte characters -(see the section on \fBALTERNATE CONFIGURATIONS\fP). -The \*(``wide\*('' library includes all of the calls -from the \*(``normal\*('' library. -It adds about one third more calls using data types which store -multibyte characters: -.RS 5 -.TP 5 -.B cchar_t -corresponds to \fBchtype\fP. -However it is a structure, because more data is stored than can fit into -an integer. -The characters are large enough to require a full integer value \- and there -may be more than one character per cell. -The video attributes and color are stored in separate fields of the structure. +Attributes alone +(with no corresponding character) +can be stored in variables of +.I \%chtype +or +.I \%attr_t +type. +In either case, +they are represented as an integral bit mask. .IP -Each cell (row and column) in a \fBWINDOW\fP is stored as a \fBcchar_t\fP. -.IP -The \fBsetcchar\fP(3X) and \fBgetcchar\fP(3X) -functions store and retrieve the data from -a \fBcchar_t\fP structure. -.TP 5 -.B wchar_t -stores a \*(``wide\*('' character. -Like \fBchtype\fP, this may be an integer. -.TP 5 -.B wint_t -stores a \fBwchar_t\fP or \fBWEOF\fP \- not the same, though both may have -the same size. +Each cell of a +.I \%WINDOW +is stored as a +.IR \%chtype . +.TP 10 +.I \%ncursesw +is the library in its \*(``wide\*('' configuration, +which handles character encodings requiring a larger data type than +.I \%char +(a byte-sized type) +can represent. +It adds about one third more calls using additional data types that +can store such +.I multibyte +characters. +.RS 10 \" same as foregoing tag width +.TP 9 \" "cchar_t" + 2n +.I \%cchar_t +corresponds to the non-wide configuration's +.IR \%chtype . +It always a structure type, +because it stores more data than fit into a standard scalar type. +A character code may not be representable as a +.IR \%char , +and moreover more than one character may occupy a cell +(as with accent marks and other diacritics). +Each character is of type +.IR \%wchar_t ; +a complex character contains one spacing character and zero or more +non-spacing characters +(see below). +Attributes and color data are stored in separate fields of the +structure, +not combined as in +.IR \%chtype . +.PP +Each cell of a +.I \%WINDOW +is stored as a +.IR \%cchar_t . +.PP +\fB\%setcchar\fP(3X) and \fB\%getcchar\fP(3X) +store and retrieve +.I \%cchar_t +data. +The wide library API of +.I \%ncurses +depends on two data types standardized by ISO C95. +.TP 9 +.I \%wchar_t +stores a wide character. +Like +.IR \%chtype , +it may be an alias of +.IR int . +Depending on the character encoding, +a wide character may be +.IR spacing , +meaning that it occupies a character cell by itself and typically +accompanies cursor advancement, +or +.IR non-spacing , +meaning that it occupies the same cell as a spacing character, +is often regarded as a \*(``modifier\*('' of the base glyph with which +it combines, +and typically does not advance the cursor. +.TP 9 +.I \%wint_t +can store a +.I \%wchar_t +or the constant +.BR \%WEOF , +analogously to the +.IR int -sized +character manipulation functions of ISO C and its constant +.BR \%EOF . .RE .IP -The \*(``wide\*('' library provides new functions which are analogous to -functions in the \*(``normal\*('' library. -There is a naming convention which relates many of the normal/wide variants: -a \*(``_w\*('' is inserted into the name. -For example, \fBwaddch\fP becomes \fBwadd_wch\fP. -.RE -.PP +The wide library provides additional functions that complement those in +the non-wide library where the size of the underlying character type is +significant. +A somewhat regular naming convention relates many of the wide variants +to their non-wide counterparts; +where a non-wide function name contains \*(``ch\*('' or \*(``str\*('', +prefix it with \*(``_w\*('' to obtain the wide counterpart. +For example, +\fB\%waddch\fP becomes \fB\%wadd_wch\fP. +(Exceptions that add only \*(``w\*('' comprise +.BR \%addwstr , +.BR \%inwstr , +and their variants.) +.IP +This convention is inapplicable to some non-wide function names, +so other transformations are used for the wide configuration: +the window background management function \*(``bkgd\*('' becomes +\*(``bkgrnd\*(''; +the window border-drawing and -clearing functions are suffixed with +\*(``_set\*(''; +and character attribute manipulation functions like +\*(``attron\*('' become \*(``attr_on\*(''. .\" -.SS Routine Name Index -The following table lists the \fBcurses\fP routines provided in -the \*(``normal\*('' and \*(``wide\*('' libraries and the names of -the manual pages on which they are described. -Routines flagged with \*(``*\*('' -are ncurses-specific, not described by XPG4 or present in SVr4. +.SS "Function Name Index" +The following table lists the +.I curses +functions provided in the non-wide and wide APIs and the corresponding +man pages that describe them. +Those flagged with \*(``*\*('' +are +.IR \%ncurses "-specific," +neither described by X/Open Curses nor present in SVr4. .PP .TS center tab(/); -l l l l . -\fBcurses\fP Routine Name/Manual Page Name -= +\f(BIcurses\fP Function Name/Man Page +_ COLOR_PAIR/\fBcurs_color\fP(3X) -PAIR_NUMBER/\fBcurs_attr\fP(3X) +PAIR_NUMBER/\fBcurs_color\fP(3X) add_wch/\fBcurs_add_wch\fP(3X) add_wchnstr/\fBcurs_add_wchstr\fP(3X) add_wchstr/\fBcurs_add_wchstr\fP(3X) @@ -403,6 +635,7 @@ find_pair/\fBnew_pair\fP(3X)* flash/\fBcurs_beep\fP(3X) flushinp/\fBcurs_util\fP(3X) free_pair/\fBnew_pair\fP(3X)* +get_escdelay/\fBcurs_threads\fP(3X)* get_wch/\fBcurs_get_wch\fP(3X) get_wstr/\fBcurs_get_wstr\fP(3X) getattrs/\fBcurs_attr\fP(3X) @@ -463,16 +696,20 @@ insstr/\fBcurs_insstr\fP(3X) instr/\fBcurs_instr\fP(3X) intrflush/\fBcurs_inopts\fP(3X) inwstr/\fBcurs_inwstr\fP(3X) +is_cbreak/\fBcurs_inopts\fP(3X)* is_cleared/\fBcurs_opaque\fP(3X)* +is_echo/\fBcurs_inopts\fP(3X)* is_idcok/\fBcurs_opaque\fP(3X)* is_idlok/\fBcurs_opaque\fP(3X)* is_immedok/\fBcurs_opaque\fP(3X)* is_keypad/\fBcurs_opaque\fP(3X)* is_leaveok/\fBcurs_opaque\fP(3X)* is_linetouched/\fBcurs_touch\fP(3X) +is_nl/\fBcurs_inopts\fP(3X)* is_nodelay/\fBcurs_opaque\fP(3X)* is_notimeout/\fBcurs_opaque\fP(3X)* is_pad/\fBcurs_opaque\fP(3X)* +is_raw/\fBcurs_inopts\fP(3X)* is_scrollok/\fBcurs_opaque\fP(3X)* is_subwin/\fBcurs_opaque\fP(3X)* is_syncok/\fBcurs_opaque\fP(3X)* @@ -594,7 +831,7 @@ notimeout/\fBcurs_inopts\fP(3X) overlay/\fBcurs_overlay\fP(3X) overwrite/\fBcurs_overlay\fP(3X) pair_content/\fBcurs_color\fP(3X) -pecho_wchar/\fBcurs_pad\fP(3X)* +pecho_wchar/\fBcurs_pad\fP(3X) pechochar/\fBcurs_pad\fP(3X) pnoutrefresh/\fBcurs_pad\fP(3X) prefresh/\fBcurs_pad\fP(3X) @@ -623,6 +860,8 @@ scrl/\fBcurs_scroll\fP(3X) scroll/\fBcurs_scroll\fP(3X) scrollok/\fBcurs_outopts\fP(3X) set_curterm/\fBcurs_terminfo\fP(3X) +set_escdelay/\fBcurs_threads\fP(3X)* +set_tabsize/\fBcurs_threads\fP(3X)* set_term/\fBcurs_initscr\fP(3X) setcchar/\fBcurs_getcchar\fP(3X) setscrreg/\fBcurs_outopts\fP(3X) @@ -644,7 +883,7 @@ slk_refresh/\fBcurs_slk\fP(3X) slk_restore/\fBcurs_slk\fP(3X) slk_set/\fBcurs_slk\fP(3X) slk_touch/\fBcurs_slk\fP(3X) -slk_wset/\fBcurs_slk\fP(3X)* +slk_wset/\fBcurs_slk\fP(3X) standend/\fBcurs_attr\fP(3X) standout/\fBcurs_attr\fP(3X) start_color/\fBcurs_color\fP(3X) @@ -663,7 +902,7 @@ tigetflag/\fBcurs_terminfo\fP(3X) tigetnum/\fBcurs_terminfo\fP(3X) tigetstr/\fBcurs_terminfo\fP(3X) timeout/\fBcurs_inopts\fP(3X) -tiparm/\fBcurs_terminfo\fP(3X)* +tiparm/\fBcurs_terminfo\fP(3X) tiparm_s/\fBcurs_terminfo\fP(3X)* tiscan_s/\fBcurs_terminfo\fP(3X)* touchline/\fBcurs_touch\fP(3X) @@ -682,7 +921,9 @@ use_default_colors/\fBdefault_colors\fP(3X)* use_env/\fBcurs_util\fP(3X) use_extended_names/\fBcurs_extend\fP(3X)* use_legacy_coding/\fBlegacy_coding\fP(3X)* +use_screen/\fBcurs_threads\fP(3X)* use_tioctl/\fBcurs_util\fP(3X)* +use_window/\fBcurs_threads\fP(3X)* vid_attr/\fBcurs_terminfo\fP(3X) vid_puts/\fBcurs_terminfo\fP(3X) vidattr/\fBcurs_terminfo\fP(3X) @@ -779,483 +1020,699 @@ wvline/\fBcurs_border\fP(3X) wvline_set/\fBcurs_border_set\fP(3X) .TE .PP -Depending on the configuration, -additional sets of functions may be available: -.RS 3 -.TP 5 -\fBcurs_memleaks\fP(3X) - curses memory-leak checking -.TP 5 -\fBcurs_sp_funcs\fP(3X) - curses screen-pointer extension -.TP 5 -\fBcurs_threads\fP(3X) - curses thread support -.TP 5 -\fBcurs_trace\fP(3X) - curses debugging routines -.RE +.IR \%ncurses 's +.I "screen-pointer extension" +adds additional functions corresponding to many of the above, +each with an \*(``_sp\*('' suffix; +see \fBcurs_sp_funcs\fP(3X). +.PP +The availability of some extensions is configurable when +.I \%ncurses +is compiled; +see sections \*(``ALTERNATE CONFIGURATIONS\*('' and \*(``EXTENSIONS\*('' +below. .SH RETURN VALUE -Routines that return an integer return \fBERR\fP upon failure and an -integer value other than \fBERR\fP upon successful completion, unless -otherwise noted in the routine descriptions. -.PP -As a general rule, routines check for null pointers passed as parameters, -and handle this as an error. -.PP -All macros return the value of the \fBw\fP version, except \fBsetscrreg\fP, -\fBwsetscrreg\fP, \fBgetyx\fP, \fBgetbegyx\fP, and \fBgetmaxyx\fP. -The return values of -\fBsetscrreg\fP, -\fBwsetscrreg\fP, -\fBgetyx\fP, -\fBgetbegyx\fP, and -\fBgetmaxyx\fP are undefined (i.e., these should not be used as the -right-hand side of assignment statements). -.PP -Functions with a \*(``mv\*('' prefix first perform a cursor movement using -\fBwmove\fP, and return an error if the position is outside the window, -or if the window pointer is null. -Most \*(``mv\*(''-prefixed functions -(except variadic functions such as \fBmvprintw\fP) -are provided both as macros and functions. -.PP -Routines that return pointers return \fBNULL\fP on error. +Unless otherwise noted, +functions that return an integer return +.B OK +on success and +.B ERR +on failure. +Functions that return pointers return +.B NULL +on failure. +Typically, +.I \%ncurses +treats a null pointer passed as a function parameter as a failure. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH ENVIRONMENT -.PP -The following environment symbols are useful for customizing the -runtime behavior of the \fBncurses\fP library. -The most important ones have been already discussed in detail. -.SS CC command-character -.PP -When set, change occurrences of the command_character -(i.e., the \fBcmdch\fP capability) -of the loaded terminfo entries to the value of this variable. -Very few terminfo entries provide this feature. +The following symbols from the process environment customize the +runtime behavior of +.I \%ncurses +applications. +The library may be configured to disregard the variables +.IR \%TERMINFO , +.IR \%TERMINFO_DIRS , +.IR \%TERMPATH , +and +.IR HOME , +if the user is the superuser (root), +or the application uses \fI\%setuid\fP(2) or \fI\%setgid\fP(2). +.SS "\fIBAUDRATE\fP" +The debugging library checks this variable when the application has +redirected output to a file. +Its integral value is used for the baud rate. +If that value is absent or invalid, +.I \%ncurses +uses 9600. +This feature allows testers to construct repeatable test cases +that take into account optimization decisions that depend on baud rate. +.SS "\fICC\fP (command character)" +When set, +the +.B \%command_character +.RB ( \%cmdch ) +capability value of loaded +.I \%term\%info +entries changes to the value of this variable. +Very few +.I \%term\%info +entries provide this feature. .PP Because this name is also used in development environments to represent -the C compiler's name, \fBncurses\fP ignores it if it does not happen to -be a single character. -.SS BAUDRATE -.PP -The debugging library checks this environment variable when the application -has redirected output to a file. -The variable's numeric value is used for the baudrate. -If no value is found, \fBncurses\fP uses 9600. -This allows testers to construct repeatable test-cases -that take into account costs that depend on baudrate. -.SS COLUMNS -.PP -Specify the width of the screen in characters. +the C compiler's name, +.I \%ncurses +ignores its value if it is not one character in length. +.SS "\fICOLUMNS\fP" +This variable specifies the width of the screen in characters. Applications running in a windowing environment usually are able to obtain the width of the window in which they are executing. -If neither the \fBCOLUMNS\fP value nor the terminal's screen size is available, -\fBncurses\fP uses the size which may be specified in the terminfo database -(i.e., the \fBcols\fP capability). -.PP -It is important that your application use a correct size for the screen. -This is not always possible because your application may be -running on a host which does not honor NAWS (Negotiations About Window -Size), or because you are temporarily running as another user. -However, setting \fBCOLUMNS\fP and/or \fBLINES\fP overrides the library's -use of the screen size obtained from the operating system. -.PP -Either \fBCOLUMNS\fP or \fBLINES\fP symbols may be specified independently. -This is mainly useful to circumvent legacy misfeatures of terminal descriptions, -e.g., xterm which commonly specifies a 65 line screen. -For best results, \fBlines\fP and \fBcols\fP should not be specified in -a terminal description for terminals which are run as emulations. -.PP -Use the \fBuse_env\fP function to disable all use of external environment -(but not including system calls) to determine the screen size. -Use the \fBuse_tioctl\fP function to update \fBCOLUMNS\fP or \fBLINES\fP -to match the screen size obtained from system calls or the terminal database. -.SS ESCDELAY -.PP -Specifies the total time, in milliseconds, for which ncurses will -await a character sequence, e.g., a function key. -The default value, 1000 milliseconds, is enough for most uses. -However, it is made a variable to accommodate unusual applications. +If +.I \%COLUMNS +is not defined and the terminal's screen size is not available from the +terminal driver, +.I \%ncurses +uses the size specified by the +.B \%columns +.RB ( \%cols ) +capability of the terminal type's entry in the +.I \%term\%info +database, +if any. +.PP +It is important that your application use the correct screen size. +Automatic detection thereof is not always possible because an +application may be running on a host that does not honor NAWS +(Negotiations About Window Size) +or as a different user ID than the owner of the terminal device file. +Setting +.I \%COLUMNS +and/or +.I \%LINES +overrides the library's use of the screen size obtained from the +operating system. +.PP +The +.I \%COLUMNS +and +.I \%LINES +variables may be specified independently. +This property is useful to circumvent misfeatures of legacy terminal +type descriptions; +\fI\%xterm\fP(1) descriptions specifying 65 lines were once notorious. +For best results, +avoid specifying +.B cols +and +.B lines +capability codes in +.I \%term\%info +descriptions of terminal emulators. +.PP +\fBuse_env\fP(3X) can disable use of the process environment +in determining the screen size. +\fBuse_tioctl\fP(3X) can update +.I \%COLUMNS +and +.I \%LINES +to match the screen size obtained from system calls or the terminal +database. +.SS "\fIESCDELAY\fP" +For +.I curses +to distinguish the ESC character resulting from a user's press of the +\*(``Escape\*('' key on the input device from one beginning an +.I "escape sequence" +(as commonly produced by function keys), +it waits after receiving the escape character to see if further +characters are available on the input stream within a short interval. +A global variable +.B \%ESCDELAY +stores this interval in milliseconds. +The default value of 1000 +(one second) +is adequate for most uses. +This environment variable overrides it. .PP The most common instance where you may wish to change this value -is to work with slow hosts, e.g., running on a network. -If the host cannot read characters rapidly enough, it will have the same -effect as if the terminal did not send characters rapidly enough. -The library will still see a timeout. -.PP -Note that xterm mouse events are built up from character sequences -received from the xterm. -If your application makes heavy use of multiple-clicking, you may -wish to lengthen this default value because the timeout applies -to the composed multi-click event as well as the individual clicks. -.PP -In addition to the environment variable, -this implementation provides a global variable with the same name. -Portable applications should not rely upon the presence of ESCDELAY +is to work with a remote host over a slow communication channel. +If the host running a +.I curses +application does not receive the characters of an escape sequence in a +timely manner, +the library can interpret them as multiple key stroke events. +.PP +\fI\%xterm\fP(1) mouse events are a form of escape sequence; +therefore, +if your application makes heavy use of multiple-clicking, +you may wish to lengthen the default value because the delay applies +to the composite multi-click event as well as the individual clicks. +.PP +Portable applications should not rely upon the presence of +.B \%ESCDELAY in either form, but setting the environment variable rather than the global variable does not create problems when compiling an application. -.SS HOME -Tells \fBncurses\fP where your home directory is. -That is where it may read and write auxiliary terminal descriptions: -.NS -$HOME/.termcap -$HOME/.terminfo -.NE -.SS LINES -.PP -Like COLUMNS, specify the height of the screen in characters. -See COLUMNS for a detailed description. -.SS MOUSE_BUTTONS_123 -.PP -This applies only to the OS/2 EMX port. -It specifies the order of buttons on the mouse. -OS/2 numbers a 3-button mouse inconsistently from other -platforms: -.NS -1 = left -.br -2 = right -.br -3 = middle. -.NE -.PP -This variable lets you customize the mouse. -The variable must be three numeric digits 1\-3 in any order, e.g., 123 or 321. -If it is not specified, \fBncurses\fP uses 132. -.SS NCURSES_ASSUMED_COLORS -.PP -Override the compiled-in assumption that the -terminal's default colors are white-on-black -(see \fBdefault_colors\fP(3X)). -You may set the foreground and background color values with this environment -variable by proving a 2-element list: foreground,background. -For example, to tell ncurses to not assume anything -about the colors, set this to "\-1,\-1". -To make it green-on-black, set it to "2,0". -Any positive value from zero to the terminfo \fBmax_colors\fP value is allowed. -.SS NCURSES_CONSOLE2 -This applies only to the MinGW port of ncurses. -.PP -The \fBConsole2\fP program's handling of the Microsoft Console API call -\fBCreateConsoleScreenBuffer\fP is defective. -Applications which use this will hang. -However, it is possible to simulate the action of this call by -mapping coordinates, -explicitly saving and restoring the original screen contents. -Setting the environment variable \fBNCGDB\fP has the same effect. -.SS NCURSES_GPM_TERMS -.PP -This applies only to ncurses configured to use the GPM interface. -.PP -If present, -the environment variable is a list of one or more terminal names -against which the \fBTERM\fP environment variable is matched. -Setting it to an empty value disables the GPM interface; -using the built-in support for xterm, etc. .PP -If the environment variable is absent, -ncurses will attempt to open GPM if \fBTERM\fP contains \*(``linux\*(''. -.SS NCURSES_NO_HARD_TABS -.PP -\fBNcurses\fP may use tabs as part of the cursor movement optimization. +If \fB\%keypad\fP(3X) is disabled for the +.I curses +window receiving input, +a program must disambiguate escape sequences itself. +.SS "\fIHOME\fP" +.I \%ncurses +may read and write auxiliary terminal descriptions in +.I \%.termcap +and +.I \%.terminfo +files in the user's home directory. +.SS "\fILINES\fP" +This counterpart to +.I \%COLUMNS +specifies the height of the screen in characters. +The corresponding +.I \%term\%info +capability and code is +.BR \%lines . +See the description of the +.I \%COLUMNS +variable above. +.SS "\fIMOUSE_BUTTONS_123\fP" +(OS/2 EMX port only) +OS/2 numbers a three-button mouse inconsistently with other platforms, +such that 1 is the left button, +2 the right, +and 3 the middle. +This variable customizes the mouse button numbering. +Its value must be three digits 1\-3 in any order. +By default, +.I \%ncurses +assumes a numbering of \*(``132\*(''. +.SS "\fINCURSES_ASSUMED_COLORS\fP" +If set, +this variable overrides the +.I \%ncurses +library's compiled-in assumption that the terminal's default colors are +white on black; +see \fB\%default_colors\fP(3X). +Set the foreground and background color values with this environment +variable by assigning it two integer values separated by a comma, +indicating foregound and background color numbers, +respectively. +.PP +For example, +to tell +.I \%ncurses +not to assume anything about the colors, +use a value of \*(``\-1,\-1\*(''. +To make the default color scheme green on black, +use \*(``2,0\*(''. +.I \%ncurses +accepts integral values from \-1 up to the value of the +.I \%term\%info +.B \%max_colors +.RB ( colors ) +capability. +.SS "\fINCURSES_CONSOLE2\fP" +(MinGW port only) +The +.I \%Console2 +.\" https://www.hanselman.com/blog/console2-a-better-windows-command-prompt +program defectively handles the Microsoft Console API call +.IR \%Create\%Console\%Screen\%Buffer . +Applications that use it will hang. +However, +it is possible to simulate the action of this call by mapping +coordinates, +explicitly saving and restoring the original screen contents. +Setting the environment variable +.I \%NCGDB +has the same effect. +.SS "\fINCURSES_GPM_TERMS\fP" +(Linux only) +When +.I \%ncurses +is configured to use the GPM interface, +this variable may list one or more terminal names +against which the +.I TERM +variable +(see below) +is matched. +An empty value disables the GPM interface, +using +.IR \%ncurses 's +built-in support for \fIxterm\fP(1) mouse protocols instead. +If the variable is absent, +.I \%ncurses +attempts to open GPM if +.I TERM +contains \*(``linux\*(''. +.SS "\fINCURSES_NO_HARD_TABS\fP" +.I \%ncurses +may use tab characters in cursor movement optimization. In some cases, -your terminal driver may not handle these properly. -Set this environment variable to disable the feature. -You can also adjust your \fBstty\fP(1) settings to avoid the problem. -.SS NCURSES_NO_MAGIC_COOKIE -.PP -Some terminals use a magic-cookie feature which requires special handling -to make highlighting and other video attributes display properly. -You can suppress the highlighting entirely for these terminals by -setting this environment variable. -.SS NCURSES_NO_PADDING -.PP -Most of the terminal descriptions in the terminfo database are written -for real \*(``hardware\*('' terminals. -Many people use terminal emulators -which run in a windowing environment and use curses-based applications. -Terminal emulators can duplicate -all of the important aspects of a hardware terminal, but they do not -have the same limitations. -The chief limitation of a hardware terminal from the standpoint -of your application is the management of dataflow, i.e., timing. +your terminal driver may not handle them properly. +Set this environment variable to any value to disable the feature. +You can also adjust your \fI\%stty\fP(1) settings to avoid the problem. +.SS "\fINCURSES_NO_MAGIC_COOKIE\fP" +Many terminals store video attributes as a property of a character cell, +as +.I curses +does. +Historically, +some recorded changes in video attributes as data that logically +.I occupies +character cells on the display, +switching attributes on or off, +similarly to tags in a markup language; +these are termed \*(``magic cookies\*('', +and must be subsequently overprinted. +If the +.I \%term\%info +entry for your terminal type does not adequately describe its handling +of magic cookies, +set this variable to any value to instruct +.I \%ncurses +to disable attributes entirely. +.SS "\fINCURSES_NO_PADDING\fP" +Most terminal type descriptions in the +.I \%term\%info +database detail hardware devices. +Many people use +.IR curses -based +applications in terminal emulator programs that run in a windowing +environment. +These programs can duplicate all of the important features of a hardware +terminal, +but often lack their limitations. +Chief among these absent drawbacks is the problem of data flow +management; +that is, +limiting the speed of communication to what the hardware could handle. Unless a hardware terminal is interfaced into a terminal concentrator (which does flow control), -it (or your application) must manage dataflow, preventing overruns. -The cheapest solution (no hardware cost) -is for your program to do this by pausing after -operations that the terminal does slowly, such as clearing the display. -.PP -As a result, many terminal descriptions (including the vt100) -have delay times embedded. -You may wish to use these descriptions, -but not want to pay the performance penalty. -.PP -Set the NCURSES_NO_PADDING environment variable to disable all but mandatory -padding. -Mandatory padding is used as a part of special control -sequences such as \fBflash\fP. -.SS NCURSES_NO_SETBUF -This setting is obsolete. -Before changes -.RS 3 -.bP -started with 5.9 patch 20120825 -and -.bP -continued -though 5.9 patch 20130126 -.RE -.PP -\fBncurses\fP enabled buffered output during terminal initialization. -This was done (as in SVr4 curses) for performance reasons. -For testing purposes, both of \fBncurses\fP and certain applications, +an application must manage flow control itself to prevent overruns and +data loss. +.PP +A solution that comes at no hardware cost is for an application to pause +after directing a terminal to execute an operation that it performs +slowly, +such as clearing the display. +Many terminal type descriptions, +including that for the VT100, +embed delay specifications in capabilities. +You may wish to use these terminal descriptions without paying the +performance penalty. +Set +.I \%NCURSES_NO_PADDING +to any value to disable all but mandatory padding. +Mandatory padding is used by such terminal capabilities as +.B \%flash_screen +.RB ( flash ). +.SS "\fINCURSES_NO_SETBUF\fP" +(Obsolete) +Prior to internal changes developed in +.I \%ncurses +5.9 +(patches 20120825 through 20130126), +the library used \fI\%setbuf\fP(3) to enable fully buffered output when +initializing the terminal. +This was done, +as in SVr4 +.IR curses , +to increase performance. +For testing purposes, +both of +.I \%ncurses +and of certain applications, this feature was made optional. -Setting the NCURSES_NO_SETBUF variable -disabled output buffering, leaving the output in the original (usually -line buffered) mode. -.PP -In the current implementation, -ncurses performs its own buffering and does not require this workaround. -It does not modify the buffering of the standard output. -.PP -The reason for the change was to make the behavior for interrupts and -other signals more robust. -One drawback is that certain nonconventional programs would mix -ordinary stdio calls with ncurses calls and (usually) work. -This is no longer possible since ncurses is not using -the buffered standard output but its own output (to the same file descriptor). -As a special case, the low-level calls such as \fBputp\fP still use the -standard output. -But high-level curses calls do not. -.SS NCURSES_NO_UTF8_ACS -.PP -During initialization, the \fBncurses\fP library -checks for special cases where VT100 line-drawing (and the corresponding -alternate character set capabilities) described in the terminfo are known -to be missing. -Specifically, when running in a UTF\-8 locale, -the Linux console emulator and the GNU screen program ignore these. -Ncurses checks the \fBTERM\fP environment variable for these. -For other special cases, you should set this environment variable. -Doing this tells ncurses to use Unicode values which correspond to -the VT100 line-drawing glyphs. -That works for the special cases cited, -and is likely to work for terminal emulators. -.PP -When setting this variable, you should set it to a nonzero value. -Setting it to zero (or to a nonnumber) -disables the special check for \*(``linux\*('' and \*(``screen\*(''. -.PP -As an alternative to the environment variable, -ncurses checks for an extended terminfo capability \fBU8\fP. -This is a numeric capability which can be compiled using \fBtic\ \-x\fP. -For example +Setting this variable disabled output buffering, +leaving the output stream in the original +(usually line-buffered) +mode. +.PP +Nowadays, +.I \%ncurses +performs its own buffering and does not require this workaround; +it does not modify the buffering of the standard output stream. +This approach makes signal handling, +as for interrupts, +more robust. +A drawback is that certain unconventional programs mixed +\fI\%stdio\fP(3) calls with +.I \%ncurses +calls and (usually) +got the behavior they expected. +This is no longer the case; +.I \%ncurses +does not write to the standard output file descriptor through a +.IR stdio -buffered +stream. +.PP +As a special case, +low-level API calls such as \fB\%putp\fP(3X) still use the +standard output stream. +High-level +.I curses +calls such as \fB\%printw\fP(3X) do not. +.SS "\fINCURSES_NO_UTF8_ACS\fP" +At initialization, +.I \%ncurses +inspects the +.I TERM +environment variable for special cases where VT100 forms-drawing +characters +(and the corresponding alternate character set +.I \%term\%info +capabilities) +are known to be unsupported by terminal types that otherwise claim VT100 +compatibility. +Specifically, +when running in a UTF-8 locale, +the Linux virtual console device and the GNU \fI\%screen\fP(1) +program ignore them. +Set this variable to a nonzero value to instruct +.I \%ncurses +that the terminal's ACS support is broken; +the library then outputs Unicode code points that correspond to the +forms-drawing +characters. +Set it to zero +(or a non-integer) +to disable the special check for terminal type names matching +\*(``linux\*('' or \*(``screen\*('', +directing +.I \%ncurses +to assume that the ACS feature works if the terminal type description +advertises it. +.PP +As an alternative to use of this variable, +.I \%ncurses +checks for an extended +.I \%term\%info +numeric capability \fBU8\fP +that can be compiled using +.RB \*(`` "tic \-x" \*(''. +Examples follow. +.PP .RS 3 -.ft CW -.sp -.nf +.EX # linux console, if patched to provide working -# VT100 shift-in/shift-out, with corresponding font. -linux-vt100|linux console with VT100 line-graphics, +# VT100 shift\-in/shift\-out, with corresponding font. +linux\-vt100|linux console with VT100 line\-graphics, U8#0, use=linux, -.sp +\& # uxterm with vt100Graphics resource set to false -xterm-utf8|xterm relying on UTF-8 line-graphics, +xterm\-utf8|xterm relying on UTF\-8 line\-graphics, U8#1, use=xterm, -.fi -.ft +.EE .RE .PP -The name \*(``U8\*('' is chosen to be two characters, -to permit it to be used by applications that use ncurses' -termcap interface. -.SS NCURSES_TRACE -.PP -During initialization, the \fBncurses\fP debugging library -checks the NCURSES_TRACE environment variable. -If it is defined, to a numeric value, \fBncurses\fP calls the \fBtrace\fP -function, using that value as the argument. -.PP -The argument values, which are defined in \fBcurses.h\fP, provide several -types of information. -When running with traces enabled, your application will write the -file \fBtrace\fP to the current directory. -.PP -See \fBcurs_trace\fP(3X) for more information. -.SS TERM -.PP -Denotes your terminal type. -Each terminal type is distinct, though many are similar. -.PP -\fBTERM\fP is commonly set by terminal emulators to help -applications find a workable terminal description. -Some of those choose a popular approximation, e.g., -\*(``ansi\*('', \*(``vt100\*('', \*(``xterm\*('' rather than an exact fit. -Not infrequently, your application will have problems with that approach, -e.g., incorrect function-key definitions. -.PP -If you set \fBTERM\fP in your environment, -it has no effect on the operation of the terminal emulator. -It only affects the way applications work within the terminal. -Likewise, as a general rule (\fBxterm\fP(1) being a rare exception), -terminal emulators which allow you to -specify \fBTERM\fP as a parameter or configuration value do -not change their behavior to match that setting. -.SS TERMCAP -If the \fBncurses\fP library has been configured with \fItermcap\fP -support, \fBncurses\fP will check for a terminal's description in -termcap form if it is not available in the terminfo database. -.PP -The \fBTERMCAP\fP environment variable contains -either a terminal description (with newlines stripped out), -or a file name telling where the information denoted by -the \fBTERM\fP environment variable exists. -In either case, setting it directs \fBncurses\fP to ignore -the usual place for this information, e.g., /etc/termcap. -.SS TERMINFO -.PP -\fBncurses\fP can be configured to read from multiple terminal databases. -The \fBTERMINFO\fP variable overrides the location for -the default terminal database. -Terminal descriptions (in terminal format) are stored in terminal databases: +The two-character name \*(``U8\*('' was chosen to permit its use via +.IR \%ncurses 's +.I termcap +interface. +.SS "\fINCURSES_TRACE\fP" +At initialization, +.I \%ncurses +(in its debugging configuration) +checks for this variable's presence. +If defined with an integral value, +the library calls \fB\%curses_trace\fP(3X) with that value as the +argument. +.SS "\fITERM\fP" +The +.I TERM +variable denotes the terminal type. +Each is distinct, +though many are similar. +It is commonly set by terminal emulators to help applications find a +workable terminal description. +Some choose a popular approximation such as \*(``ansi\*('', +\*(``vt100\*('', or \*(``xterm\*('' rather than an exact fit to their +capabilities. +Not infrequently, +an application will have problems with that approach; +for example, +a key stroke may not operate correctly, +or produce no effect but seeming garbage characters on the screen. +.PP +Setting +.I TERM +has no effect on hardware operation; +it affects the way applications communicate with the terminal. +Likewise, +as a general rule +(\fIxterm\fP(1) being a rare exception), +terminal emulators that allow you to specify +.I TERM +as a parameter or configuration value do not change their behavior to +match that setting. +.SS "\fITERMCAP\fP" +If +.I \%ncurses +is configured with +.I termcap +support, +it checks for a terminal type description in +.I termcap +format if one in +.I \%term\%info +format is not available. +Setting this variable directs +.I \%ncurses +to ignore the usual +.I termcap +database location, +.IR \%/etc/termcap ; +see +.I \%TERMPATH +below. +.I \%TERMCAP +should contain either a terminal description +(with newlines stripped out), +or a file name indicating where the information required by the +.I TERM +environment variable is stored. +.SS "\fITERMINFO\fP" +.I \%ncurses +can be configured to read terminal type description databases in various +locations using different formats. +This variable overrides the default location. .bP -Normally these are stored in a directory tree, -using subdirectories named by the first letter of the terminal names therein. -.IP -This is the scheme used in System V, which legacy Unix systems use, -and the \fBTERMINFO\fP variable is used by \fIcurses\fP applications on those -systems to override the default location of the terminal database. +Descriptions in +.I \%term\%info +format are normally stored in a directory tree using subdirectories +named by the common first letters of the terminal types named therein. +This is the scheme used in System\ V. .bP -If \fBncurses\fP is built to use hashed databases, -then each entry in this list may be the path of a hashed database file, e.g., -.NS -/usr/share/terminfo.db -.NE -.IP +If +.I \%ncurses +is configured to use hashed databases, +then +.I \%TERM\%INFO +may name its location, +such as +.IR \%/usr/share/terminfo.db , rather than -.NS -/usr/share/terminfo/ -.NE -.IP -The hashed database uses less disk-space and is a little faster than the +.IR \%/usr/share/terminfo/ . +.PP +The hashed database uses less disk space and is a little faster than the directory tree. However, some applications assume the existence of the directory tree, -reading it directly -rather than using the terminfo library calls. +and read it directly +rather than using the +.I \%term\%info +API. .bP -If \fBncurses\fP is built with a support for reading termcap files -directly, then an entry in this list may be the path of a termcap file. +If +.I \%ncurses +is configured with +.I termcap +support, +this variable may contain the location of a +.I \%termcap +file. .bP -If the \fBTERMINFO\fP variable begins with -\*(``hex:\*('' or \*(``b64:\*('', -\fBncurses\fP uses the remainder of that variable as a compiled terminal +If the value of +.I \%TERM\%INFO +begins with \*(``hex:\*('' or \*(``b64:\*('', +.I \%ncurses +uses the remainder of the value as a compiled +.I \%term\%info description. -You might produce the base64 format using \fBinfocmp\fP(1M): -.NS -TERMINFO="$(infocmp -0 -Q2 -q)" +You might produce the base64 format using \fB\%infocmp\fP(1M). +.RS 4 +.IP +.EX +TERMINFO=$(infocmp \-0 \-Q2 \-q) export TERMINFO -.NE +.EE +.RE .IP -The compiled description is used if it corresponds to the terminal identified -by the \fBTERM\fP variable. -.PP -Setting \fBTERMINFO\fP is the simplest, -but not the only way to set location of the default terminal database. -The complete list of database locations in order follows: -.RS 3 +The compiled description is used only if it corresponds to the terminal +type identified by +.IR TERM . +.PP +Setting +.I \%TERM\%INFO +is the simplest, +but not the only, +way to direct +.I \%ncurses +to a terminal database. +The search path is as follows. .bP -the last terminal database to which \fBncurses\fP wrote, -if any, is searched first +the last terminal database to which the running +.I \%ncurses +application wrote, +if any .bP -the location specified by the TERMINFO environment variable +the location specified by the +.I \%TERM\%INFO +environment variable .bP -$HOME/.terminfo +.I $HOME/.terminfo .bP -locations listed in the TERMINFO_DIRS environment variable +locations listed in the +.I \%TERMINFO_DIRS +environment variable +.ds td \" empty +.if !'/usr/share/terminfo'no default value' .as td /usr/share/terminfo +.if !'/usr/share/terminfo\*(td'' \{\ .bP -one or more locations whose names are configured and compiled into the -ncurses library, i.e., +location(s) configured and compiled into +.I \%ncurses .RS 3 +.if !'\*(td'' \{\ .bP -no default value (corresponding to the TERMINFO_DIRS variable) +.I \%/usr/share/terminfo +.\} +.if !'@TERMINFO'' .if !'\*(td'/usr/share/terminfo' \{\ .bP -/usr/share/terminfo (corresponding to the TERMINFO variable) +.I \%/usr/share/terminfo +.\} +.\} .RE -.RE -.PP -.SS TERMINFO_DIRS -.PP -Specifies a list of locations to search for terminal descriptions. -Each location in the list is a terminal database as described in -the section on the \fBTERMINFO\fP variable. -The list is separated by colons (i.e., ":") on Unix, semicolons on OS/2 EMX. -.PP -There is no corresponding feature in System V terminfo; -it is an extension developed for \fBncurses\fP. -.SS TERMPATH -.PP -If \fBTERMCAP\fP does not hold a file name then \fBncurses\fP checks -the \fBTERMPATH\fP environment variable. -This is a list of filenames separated by spaces or colons (i.e., ":") on Unix, -semicolons on OS/2 EMX. -.PP -If the \fBTERMPATH\fP environment variable is not set, -\fBncurses\fP looks in the files -.NS -/etc/termcap, /usr/share/misc/termcap and $HOME/.termcap, -.NE -.PP +.SS "\fITERMINFO_DIRS\fP" +This variable specifies a list of locations, +akin to +.IR PATH , +in which +.I \%ncurses +searches for the terminal type descriptions described by +.I \%TERMINFO +above. +The list items are separated by colons on Unix +and semicolons on OS/2 EMX. +System\ V +.I \%term\%info +lacks a corresponding feature; +.I \%TERMINFO_DIRS +is an +.I \%ncurses +extension. +.SS "\fITERMPATH\fP" +If +.I \%TERMCAP +does not hold a terminal type description or file name, +then +.I \%ncurses +checks the contents of +.IR \%TERMPATH , +a list of locations, +akin to +.IR PATH , +in which it searches for +.I termcap +terminal type descriptions. +The list items are separated by colons on Unix +and semicolons on OS/2 EMX. +.PP +If both +.I \%TERMCAP +and +.I \%TERMPATH +are unset or invalid, +.I \%ncurses +searches for the files +.IR \%/etc/termcap , +.IR \%/usr/share/misc/termcap , +and +.IR \%$HOME/.termcap , in that order. -.PP -The library may be configured to disregard the following variables when the -current user is the superuser (root), or if the application uses setuid or -setgid permissions: -.NS -$TERMINFO, $TERMINFO_DIRS, $TERMPATH, as well as $HOME. -.NE -.SH ALTERNATE CONFIGURATIONS -.PP -Several different configurations are possible, -depending on the configure script options used when building \fBncurses\fP. -There are a few main options whose effects are visible to the applications -developer using \fBncurses\fP: +.SH "ALTERNATE CONFIGURATIONS" +Many different +.I \%ncurses +configurations are possible, +determined by the options given to the +.I \%configure +script when building the library. +Run the script with the +.B \-\-help +option to peruse them all. +A few are of particular significance to the application developer +employing +.IR \%ncurses . .TP 5 -\-\-disable\-overwrite -The standard include for \fBncurses\fP is as noted in \fBSYNOPSIS\fP: -.NS +.B \-\-disable\-overwrite +The standard include for \fI\%ncurses\fP is as noted in \fBSYNOPSIS\fP: +.RS 5 +.PP +.RS 4 +.EX \fB#include <curses.h>\fP -.NE -.IP -This option is used to avoid filename conflicts when \fBncurses\fP +.EE +.RE +.PP +This option is used to avoid filename conflicts when \fI\%ncurses\fP is not the main implementation of curses of the computer. -If \fBncurses\fP is installed disabling overwrite, it puts its headers in -a subdirectory, e.g., -.NS +If \fI\%ncurses\fP is installed disabling overwrite, +it puts its headers in a subdirectory, +e.g., +.PP +.RS 4 +.EX \fB#include <ncurses/curses.h>\fP -.NE -.IP +.EE +.RE +.PP It also omits a symbolic link which would allow you to use \fB\-lcurses\fP to build executables. +.RE .TP 5 -\-\-enable\-widec +.B \-\-enable\-widec The configure script renames the library and (if the \fB\-\-disable\-overwrite\fP option is used) puts the header files in a different subdirectory. All of the library names have a \*(``w\*('' appended to them, i.e., instead of -.NS +.RS 5 +.PP +.RS 4 +.EX \fB\-lncurses\fP -.NE -.IP +.EE +.RE +.PP you link with -.NS +.PP +.RS 4 +.EX \fB\-lncursesw\fP -.NE -.IP +.EE +.RE +.PP You must also enable the wide-character features in the header file when compiling for the wide-character library to use the extended (wide-character) functions. -The symbol which enables these features has changed since XSI Curses, Issue 4: -.RS +The symbol which enables these features has changed +since X/Open Curses, Issue 4: .bP Originally, the wide-character feature required the symbol \fB_XOPEN_SOURCE_EXTENDED\fP @@ -1272,19 +1729,19 @@ Alternatively, you can enable the feature by defining \fBNCURSES_WIDECHAR\fP with the caveat that some other header file than \fBcurses.h\fP may require a specific value for \fB_XOPEN_SOURCE\fP (or a system-specific symbol). -.RE -.IP -The \fBcurses.h\fP file which is installed for the wide-character -library is designed to be compatible with the normal library's header. -Only the size of the \fBWINDOW\fP structure differs, and very few -applications require more than a pointer to \fBWINDOW\fPs. -.IP +.PP +The \fI\%curses.h\fP header file installed for the wide-character +library is designed to be compatible with the non-wide library's header. +Only the size of the \fI\%WINDOW\fP structure differs; +few applications require more than pointers to \fI\%WINDOW\fPs. +.PP If the headers are installed allowing overwrite, the wide-character library's headers should be installed last, to allow applications to be built using either library from the same set of headers. +.RE .TP 5 -\-\-with\-pthread +.B \-\-with\-pthread The configure script renames the library. All of the library names have a \*(``t\*('' appended to them (before any \*(``w\*('' added by \fB\-\-enable\-widec\fP). @@ -1294,20 +1751,20 @@ allow read-only access. At the same time, setter-functions are provided to set these values. Some applications (very few) may require changes to work with this convention. .TP 5 -\-\-with\-shared -.TP -\-\-with\-normal -.TP -\-\-with\-debug -.TP -\-\-with\-profile +.B \-\-with\-shared +.tQ +.B \-\-with\-normal +.tQ +.B \-\-with\-debug +.tQ +.B \-\-with\-profile The shared and normal (static) library names differ by their suffixes, e.g., \fBlibncurses.so\fP and \fBlibncurses.a\fP. The debug and profiling libraries add a \*(``_g\*('' and a \*(``_p\*('' to the root names respectively, e.g., \fBlibncurses_g.a\fP and \fBlibncurses_p.a\fP. .TP 5 -\-\-with\-termlib +.B \-\-with\-termlib Low-level functions which do not depend upon whether the library supports wide-characters, are provided in the tinfo library. .IP @@ -1318,242 +1775,487 @@ when only low-level functions are needed. Those functions are described in these pages: .RS .bP -\fBcurs_extend\fP(3X) \- miscellaneous curses extensions +\fB\%curs_extend\fP(3X) \- miscellaneous \fIcurses\fP extensions .bP -\fBcurs_inopts\fP(3X) \- \fBcurses\fP input options +\fB\%curs_inopts\fP(3X) \- \fIcurses\fP input options .bP -\fBcurs_kernel\fP(3X) \- low-level \fBcurses\fP routines +\fB\%curs_kernel\fP(3X) \- low-level \fIcurses\fP routines .bP -\fBcurs_termattrs\fP(3X) \- \fBcurses\fP environment query routines +\fB\%curs_termattrs\fP(3X) \- \fIcurses\fP environment query routines .bP -\fBcurs_termcap\fP(3X) \- \fBcurses\fP emulation of termcap +\fB\%curs_termcap\fP(3X) \- \fIcurses\fP emulation of \fItermcap\fP .bP -\fBcurs_terminfo\fP(3X) \- \fBcurses\fP interfaces to terminfo database +\fB\%curs_terminfo\fP(3X) \- \fIcurses\fP interface to \fIterminfo\fP +database .bP -\fBcurs_util\fP(3X) \- miscellaneous \fBcurses\fP utility routines +\fB\%curs_util\fP(3X) \- miscellaneous \fIcurses\fP utility routines .RE .TP 5 -\-\-with\-trace +.B \-\-with\-trace The \fBtrace\fP function normally resides in the debug library, but it is sometimes useful to configure this in the shared library. Configure scripts should check for the function's existence rather than assuming it is always in the debug library. .SH FILES -.TP 5 -/usr/share/tabset -directory containing initialization files for the terminal capability database -/usr/share/terminfo -terminal capability database -.SH SEE ALSO -\fBterminfo\fP(\*n) and related pages whose names begin -\*(``curs_\*('' for detailed routine descriptions. -.br -\fBcurs_variables\fP(3X) -.br -\fBuser_caps\fP(5) for user-defined capabilities -.SH EXTENSIONS -The \fBncurses\fP library can be compiled with an option (\fB\-DUSE_GETCAP\fP) -that falls back to the old-style /etc/termcap file if the terminal setup code -cannot find a terminfo entry corresponding to \fBTERM\fP. -Use of this feature -is not recommended, as it essentially includes an entire termcap compiler in -the \fBncurses\fP startup code, at significant cost in core and startup cycles. -.PP -The \fBncurses\fP library includes facilities for capturing mouse events on -certain terminals (including xterm). -See the \fBcurs_mouse\fP(3X) -manual page for details. -.PP -The \fBncurses\fP library includes facilities for responding to window -resizing events, e.g., when running in an xterm. -See the \fBresizeterm\fP(3X) -and \fBwresize\fP(3X) manual pages for details. -In addition, the library may be configured with a \fBSIGWINCH\fP handler. -.PP -The \fBncurses\fP library extends the fixed set of function key capabilities -of terminals by allowing the application designer to define additional -key sequences at runtime. -See the \fBdefine_key\fP(3X) -\fBkey_defined\fP(3X), -and \fBkeyok\fP(3X) manual pages for details. -.PP -The \fBncurses\fP library can exploit the capabilities of terminals which -implement the ISO\-6429 SGR 39 and SGR 49 controls, which allow an application -to reset the terminal to its original foreground and background colors. -From the users' perspective, the application is able to draw colored -text on a background whose color is set independently, providing better -control over color contrasts. -See the \fBdefault_colors\fP(3X) manual page for details. -.PP -The \fBncurses\fP library includes a function for directing application output -to a printer attached to the terminal device. -See the \fBcurs_print\fP(3X) manual page for details. -.SH PORTABILITY -The \fBncurses\fP library is intended to be BASE-level conformant with XSI -Curses. -The EXTENDED XSI Curses functionality -(including color support) is supported. -.PP -A small number of local differences (that is, individual differences between -the XSI Curses and \fBncurses\fP calls) are described in \fBPORTABILITY\fP -sections of the library man pages. -.SS Error checking -.PP -In many cases, X/Open Curses is vague about error conditions, -omitting some of the SVr4 documentation. -.PP -Unlike other implementations, this one checks parameters such as pointers -to WINDOW structures to ensure they are not null. -The main reason for providing this behavior is to guard against programmer -error. -The standard interface does not provide a way for the library -to tell an application which of several possible errors were detected. -Relying on this (or some other) extension will adversely affect the -portability of curses applications. -.SS Extensions versus portability -.PP -Most of the extensions provided by ncurses have not been standardized. -Some have been incorporated into other implementations, such as -PDCurses or NetBSD curses. -Here are a few to consider: +.TP +.I /usr/share/tabset +tab stop initialization database +.TP +.I \*d +compiled terminal capability database +.SH NOTES +X/Open Curses permits most functions it specifies to be made available +as macros as well. +.\" See X/Open Curses Issue 4, Version 2, pp. 227-234. +.\" See X/Open Curses Issue 7, pp. 311-318. +\fI\%ncurses\fP does so .bP -The routine \fBhas_key\fP is not part of XPG4, nor is it present in SVr4. -See the \fBcurs_getch\fP(3X) manual page for details. +for functions that return values via their parameters, .bP -The routine \fBslk_attr\fP is not part of XPG4, nor is it present in SVr4. -See the \fBcurs_slk\fP(3X) manual page for details. +to support obsolete features, +.bP +to reuse functions +(for example, +those that move the cursor before another operation), +and .bP -The routines \fBgetmouse\fP, \fBmousemask\fP, \fBungetmouse\fP, -\fBmouseinterval\fP, and \fBwenclose\fP relating to mouse interfacing are not -part of XPG4, nor are they present in SVr4. -See the \fBcurs_mouse\fP(3X) manual page for details. +a few special cases. +.PP +If the standard output file descriptor of an +.I \%ncurses +program is redirected to something that is not a terminal device, +the library writes screen updates to the standard error file descriptor. +This was an undocumented feature of SVr3 +.IR curses . +.PP +See subsection \*(``Header Files\*('' below regarding symbols exposed by +inclusion of \fI\%curses.h\fP. +.SH EXTENSIONS +.I \%ncurses +enables an application to capture mouse events on certain terminals, +including \fI\%xterm\fP(1); +see \fB\%curs_mouse\fP(3X). +.PP +.I \%ncurses +provides a means of responding to window resizing events, +as when running in a GUI terminal emulator application such as +.IR \%xterm ; +see \fB\%resizeterm\fP(3X) and \fB\%wresize\fP(3X). +.PP +.I \%ncurses +allows an application to query the terminal for the presence of a wide +variety of special keys; +see \fB\%has_key\fP(3X). +.PP +.I \%ncurses +extends the fixed set of function key capabilities specified by X/Open +Curses by allowing the application programmer to define additional key +events at runtime; +see +\fB\%define_key\fP(3X), +\fB\%key_defined\fP(3X), +\fB\%keybound\fP(3X), +and +\fB\%keyok\fP(3X). +.PP +.I \%ncurses +can exploit the capabilities of terminals implementing ISO\ 6429/ECMA-48 +SGR\ 39 and SGR\ 49 sequences, +which allow an application to reset the terminal to its original +foreground and background colors. +From a user's perspective, +the application is able to draw colored text on a background whose color +is set independently, +providing better control over color contrasts. +See \fB\%default_colors\fP(3X). +.PP +An +.I \%ncurses +application can eschew knowledge of +.I \%WINDOW +structure internals, +instead using accessor functions such as +\fB\%is_scrollok\fP(3X). +.PP +.I \%ncurses +enables an application to direct application output to a printer +attached to the terminal device; +see \fB\%curs_print\fP(3X). +.PP +.I \%ncurses +offers \fB\%slk_attr\fP(3X) as a counterpart of \fB\%attr_get\fP(3X) for +soft-label key lines, +and \fB\%extended_slk_color\fP(3X) as a form of \fB\%slk_color\fP(3X) +that can gather color information from them when many colors are +supported. +.PP +Some extensions are available only if +.I \%ncurses +permits modification of \fB\%unctrl\fP(3X)'s behavior; +see \fB\%use_legacy_coding\fP(3X). +.I \%ncurses +is compiled to support them; +section \*(``ALTERNATE CONFIGURATIONS\*('' describes how. .bP -The routine \fBmcprint\fP was not present in any previous curses implementation. -See the \fBcurs_print\fP(3X) manual page for details. +Rudimentary support for multi-threaded applications may be available; +see \fBcurs_threads\fP(3X). .bP -The routine \fBwresize\fP is not part of XPG4, nor is it present in SVr4. -See the \fBwresize\fP(3X) manual page for details. +Functions that ease the management of multiple screens can be exposed; +see \fBcurs_sp_funcs\fP(3X). .bP -The WINDOW structure's internal details can be hidden from application -programs. -See \fBcurs_opaque\fP(3X) for the discussion of \fBis_scrollok\fP, etc. +To aid applications to debug their memory usage, +.I ncurses +optionally offers functions to more aggressively free memory it +dynamically allocates itself; +see \fBcurs_memleaks\fP(3X). .bP -This implementation can be configured to provide rudimentary support -for multi-threaded applications. -See \fBcurs_threads\fP(3X) for details. +The library facilitates auditing and troubleshooting of its behavior; +see \fBcurs_trace\fP(3X). .bP -This implementation can also be configured to provide a set of functions which -improve the ability to manage multiple screens. -See \fBcurs_sp_funcs\fP(3X) for details. -.SS Padding differences -.PP -In historic curses versions, delays embedded in the capabilities \fBcr\fP, -\fBind\fP, \fBcub1\fP, \fBff\fP and \fBtab\fP activated corresponding delay -bits in the UNIX tty driver. -In this implementation, all padding is done by sending NUL bytes. -This method is slightly more expensive, but narrows the interface -to the UNIX kernel significantly and increases the package's portability -correspondingly. -.SS Header files -The header file \fB<curses.h>\fP automatically includes the header files -\fB<stdio.h>\fP and \fB<unctrl.h>\fP. +The compiler option +.B \%\-DUSE_GETCAP +causes the library to fall back to reading +.I \%/etc/termcap +if the terminal setup code cannot find a +.I \%term\%info +entry corresponding to +.IR TERM . +Use of this feature is not recommended, +as it essentially includes an entire +.I termcap +compiler in the +.I \%ncurses +startup code, +at a cost in memory usage and application launch latency. +.PP +.I \%PDCurses +and NetBSD +.I curses +incorporate some +.I \%ncurses +extensions. +Individual man pages indicate where this is the case. +.SH PORTABILITY +X/Open Curses defines two levels of conformance, +\*(``base\*('' and \*(``enhanced\*(''. +The latter includes several additional features, +such as wide-character and color support. +.I \%ncurses +intends base-level conformance with X/Open Curses, +and supports all features of its enhanced level +except the \fB\%untic\fP utility. +.PP +Differences between X/Open Curses and +.I \%ncurses +are documented in the \*(``PORTABILITY\*('' sections of applicable man +pages. +.SS "Error Checking" +In many cases, X/Open Curses is vague about error conditions, +omitting some of the SVr4 documentation. +.PP +Unlike other implementations, +.I \%ncurses +checks pointer parameters, +such as those to +.I \%WINDOW +structures, +to ensure that they are not null. +This is done primarily to guard against programmer error. +The standard interface does not provide a way for the library +to tell an application which of several possible errors occurred. +Relying on this +(or some other) +extension adversely affects the portability of +.I curses +applications. +.SS "Padding Differences" +In historical +.I curses +implementations, +delays embedded in the +.I \%term\%info +capabilities +.B \%carriage_return +.RB ( cr ), +.B \%scroll_forward +.RB ( ind ), +.B \%cursor_left +.RB ( cub1 ), +.B \%form_feed +.RB ( ff ), +and +.B \%tab +.RB ( ht ) +activated corresponding delay bits in the Unix terminal driver. +.I \%ncurses +performs all padding by sending NUL bytes to the device. +This method is slightly more expensive, +but narrows the interface to the Unix kernel significantly and +correspondingly increases the package's portability. +.SS "Header Files" +The header file +.I \%curses.h +itself includes the header files +.I \%stdio.h +and +.IR \%unctrl.h . .PP X/Open Curses has more to say, -but does not finish the story: .RS 4 .PP -The inclusion of <curses.h> may make visible all symbols -from the headers <stdio.h>, <term.h>, <termios.h>, and <wchar.h>. +The inclusion of +.I \%curses.h +may make visible all symbols from the headers +.IR \%stdio.h , +.IR \%term.h , +.IR \%termios.h , +and +.IR \%wchar.h . .RE .PP -Here is a more complete story: +but does not finish the story. +A more complete account follows. .bP -Starting with BSD curses, all implementations have included <stdio.h>. +Starting with 4BSD +.I curses +(1980) +all implementations have provided a +.I \%curses.h +file. .IP -BSD curses included <curses.h> and <unctrl.h> from an internal header -"curses.ext" ("ext" was a short name for \fIexterns\fP). +BSD +.I curses +code included +.I \%curses.h +and +.I \%unctrl.h +from an internal header file +.IR \%curses.ext , +where +\*(``ext\*('' abbreviated \*(``externs\*(''. .IP -BSD curses used <stdio.h> internally (for \fBprintw\fP and \fBscanw\fP), -but nothing in <curses.h> itself relied upon <stdio.h>. +The implementations of +.I \%printw +and +.I \%scanw +used undocumented internal functions of the standard I/O library +.RI ( _doprnt +and +.IR _doscan ), +but nothing in +.I \%curses.h +itself relied upon +.IR \%stdio.h . .bP -SVr2 curses added \fBnewterm\fP(3X), which relies upon <stdio.h>. -That is, the function prototype uses \fBFILE\fP. +SVr2 +.I curses +added +.IR \%newterm , +which relies upon +.I \%stdio.h +because its function prototype employs the +.I FILE +type. .IP -SVr4 curses added \fBputwin\fP and \fBgetwin\fP, which also use <stdio.h>. +SVr4 +.I curses +added +.I \%putwin +and +.IR \%getwin , +which also use +.IR \%stdio.h . .IP -X/Open Curses documents all three of these functions. +X/Open Curses specifies all three of these functions. .IP -SVr4 curses and X/Open Curses do not require the developer to -include <stdio.h> before including <curses.h>. -Both document curses showing <curses.h> as the only required header. +SVr4 +.I curses +and X/Open Curses do not require the developer to include +.I \%stdio.h +before +.IR \%curses.h . +Both document use of +.I curses +as requiring only +.IR \%curses.h . .IP -As a result, standard <curses.h> will always include <stdio.h>. +As a result, +standard +.I \%curses.h +always includes +.IR \%stdio.h . .bP -X/Open Curses is inconsistent with respect to SVr4 regarding <unctrl.h>. +X/Open Curses and SVr4 +.I curses +are inconsistent with respect to +.IR \%unctrl.h . .IP -As noted in \fBcurs_util\fP(3X), ncurses includes <unctrl.h> from -<curses.h> (like SVr4). +As noted in \fBcurs_util\fP(3X), +.I \%ncurses +includes +.I \%unctrl.h +from +.I \%curses.h +(as SVr4 does). .bP -X/Open's comments about <term.h> and <termios.h> may refer to HP-UX and AIX: +X/Open Curses's comments about +.I \%term.h +and +.I \%termios.h +may refer to HP-UX and AIX. .IP -HP-UX curses includes <term.h> from <curses.h> -to declare \fBsetupterm\fP in curses.h, -but ncurses (and Solaris curses) do not. +HP-UX +.I curses +includes +.I \%term.h +from +.I \%curses.h +to declare +.I \%setupterm +in +.IR \%curses.h , +but +.I \%ncurses +and Solaris +.I curses +do not. .IP -AIX curses includes <term.h> and <termios.h>. -Again, ncurses (and Solaris curses) do not. +AIX +.I curses +includes +.I \%term.h +and +.IR \% termios.h . +Again, +.I \%ncurses +and Solaris +.I curses +do not. .bP -X/Open says that <curses.h> \fImay\fP include <term.h>, -but there is no requirement that it do that. +X/Open Curses says that +.I \%curses.h +.B may +include +.IR \%term.h , +but does not require it to do so. .IP -Some programs use functions declared in both <curses.h> and <term.h>, -and must include both headers in the same module. -Very old versions of AIX curses required including <curses.h> -before including <term.h>. +Some programs use functions declared in both +.I \%curses.h +and +.IR \%term.h , +and must include both header files in the same module. +Very old versions of AIX +.I curses +required inclusion of +.I \%curses.h +before +.IR \%term.h . .IP -Because ncurses header files include the headers needed to -define datatypes used in the headers, -ncurses header files can be included in any order. -But for portability, you should include <curses.h> before <term.h>. +The header files supplied by +.I \%ncurses +include the standard library headers required for its declarations, +so +.IR \%ncurses 's +own header files can be included in any order. +But for portability, +you should include +.I \%curses.h +before +.IR \%term.h . .bP -X/Open Curses says \fI"may make visible"\fP -because including a header file does not necessarily make all symbols -in it visible (there are ifdef's to consider). +X/Open Curses says \*(``may make visible\*('' because including a header +file does not necessarily make visible all of the symbols in it +(consider +.B \%#ifdef +and similar). .IP -For instance, in ncurses <wchar.h> \fImay\fP be included if -the proper symbol is defined, and if ncurses is configured for -wide-character support. -If the header is included, its symbols may be made visible. -That depends on the value used for \fB_XOPEN_SOURCE\fP +For instance, +.IR \%ncurses 's +.I \%curses.h +.B may \" bold to contrast with preceding italic +include +.I \%wchar.h +if the proper symbol is defined, +and if +.I \%ncurses +is configured for wide-character support. +If +.I \%wchar.h +is included, +its symbols +.B may \" bold for consistency in this paragraph +be made visible depending on the value of the +.B _XOPEN_SOURCE feature test macro. .bP -X/Open Curses documents one required header, -in a special case: <stdarg.h> before <curses.h> to prototype -the \fBvw_printw\fP and \fBvw_scanw\fP functions +X/Open Curses mandates an application's inclusion of one standard C +library header in a special case: +.I \%stdarg.h +before +.I \%curses.h +to prototype the functions +.I \%vw_printw +and +.I \%vw_scanw (as well as the obsolete -the \fBvwprintw\fP and \fBvwscanw\fP functions). -Each of those uses a \fBva_list\fP parameter. +.I \%vwprintw +and +.IR \%vwscanw ). +Each of these takes a variadic argument list, +a +.I \%va_list +parameter, +like that of \fI\%printf\fP(3). .IP -The two obsolete functions were introduced in SVr3. -The other functions were introduced in X/Open Curses. -In between, SVr4 curses provided for the possibility that -an application might include either <varargs.h> or <stdarg.h>. -Initially, that was done by using \fBvoid*\fP for the \fBva_list\fP +SVr3 +.I curses +introduced +the two obsolete functions, +and X/Open Curses the others. +In between, +SVr4 +.I curses +provided for the possibility that an application might include either +.I \%varargs.h +or +.IR \%stdarg.h . +These represented contrasting approaches to handling variadic +argument lists. +The older interface, +.IR \%varargs.h , +used a pointer to +.I char \" V7, 32V, System III, 3BSD +for variadic functions' +.I \%va_list parameter. -Later, a special type (defined in <stdio.h>) was introduced, -to allow for compiler type-checking. -That special type is always available, -because <stdio.h> is always included by <curses.h>. +Later, +the list acquired its own standard data type, +.IR \%va_list , +defined in +.IR \%stdarg.h , +empowering the compiler to check the types of a function call's actual +parameters against the formal ones declared in its prototype. .IP -None of the X/Open Curses implementations require an application -to include <stdarg.h> before <curses.h> because they either -have allowed for a special type, or (like ncurses) include <stdarg.h> -directly to provide a portable interface. -.SH NOTES -.PP -If standard output from a \fBncurses\fP program is re-directed to something -which is not a tty, screen updates will be directed to standard error. -This was an undocumented feature of AT&T System V Release 3 curses. +No conforming implementations of X/Open Curses require an application +to include +.I \%stdarg.h +before +.I \%curses.h +because they either have allowed for a special type, +or, +like +.IR \%ncurses , +they include +.I \%stdarg.h +themselves to provide a portable interface. .SH AUTHORS -Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. -Based on \fIpcurses\fP by Pavel Curtis. +Zeyd M. Ben-Halim, +Eric S. Raymond, +Thomas E. Dickey. +Based on +.I \%pcurses +by Pavel Curtis. +.SH SEE ALSO +\fB\%curs_variables\fP(3X), +\fB\%terminfo\fP(5), +\fB\%user_caps\fP(5) diff --git a/upstream/archlinux/man3/netlink.3 b/upstream/archlinux/man3/netlink.3 index 4f964418..9b2bcfae 100644 --- a/upstream/archlinux/man3/netlink.3 +++ b/upstream/archlinux/man3/netlink.3 @@ -5,7 +5,7 @@ .\" Based on the original comments from Alexey Kuznetsov .\" $Id: netlink.3,v 1.1 1999/05/14 17:17:24 freitag Exp $ .\" -.TH netlink 3 2023-10-31 "Linux man-pages 6.06" +.TH netlink 3 2024-05-02 "Linux man-pages 6.8" .SH NAME netlink \- Netlink macros .SH LIBRARY diff --git a/upstream/archlinux/man3/new_pair.3x b/upstream/archlinux/man3/new_pair.3x index ae20dd44..958200be 100644 --- a/upstream/archlinux/man3/new_pair.3x +++ b/upstream/archlinux/man3/new_pair.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -29,44 +29,38 @@ .\" .\" Author: Thomas E. Dickey .\" -.\" $Id: new_pair.3x,v 1.19 2022/02/12 20:03:40 tom Exp $ -.TH new_pair 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: new_pair.3x,v 1.46 2024/03/16 15:35:01 tom Exp $ +.TH new_pair 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.de NS -.ie n .sp -.el .sp .5 -.ie n .in +4 -.el .in +2 -.nf -.ft C \" Courier -.. -.de NE -.fi -.ft R -.ie n .in -4 -.el .in -2 -.. .SH NAME -\fBalloc_pair\fP, -\fBfind_pair\fP, -\fBfree_pair\fP \- new curses color-pair functions +\fB\%alloc_pair\fP, +\fB\%find_pair\fP, +\fB\%free_pair\fP \- +dynamically allocate \fIcurses\fR color pairs .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint alloc_pair(int \fIfg\fB, int \fIbg\fB);\fR -.br -\fBint find_pair(int \fIfg\fB, int \fIbg\fB);\fR -.br -\fBint free_pair(int \fIpair\fB);\fR +.nf +\fB#include <curses.h> +.PP +\fBint alloc_pair(int \fIfg\fP, int \fIbg\fP); +\fBint find_pair(int \fIfg\fP, int \fIbg\fP); +\fBint free_pair(int \fIpair\fP); +.fi .SH DESCRIPTION -These functions are an extension to the curses library. +These functions are an extension to the \fIcurses\fP library. They permit an application to dynamically allocate a color pair using the foreground/background colors rather than assign a fixed color pair number, and return an unused pair to the pool. @@ -80,25 +74,31 @@ it is unlikely that your terminal allows you to modify the attributes of a given character cell without rewriting it. That is, the foreground and background colors are applied as a pair. .bP -Color pairs are the curses library's way of managing a color palette +Color pairs are the \fIcurses\fP library's way of managing a color palette on a terminal. If the library does not keep track of the \fIcombinations\fP of colors which are displayed, it will be inefficient. -.bP +.IP \(bu 4 For simple terminal emulators with only a few dozen color combinations, it is convenient to use the maximum number of combinations as the limit on color pairs: -.NS +.PP +.RS 8 +.EX \fBCOLORS\fI * \fBCOLORS\fR -.NE -.bP +.EE +.RE +.IP \(bu 4 Terminals which support \fIdefault colors\fP distinct from \*(``ANSI colors\*('' add to the possible combinations, producing this total: -.NS +.PP +.RS 8 +.EX \fI( \fBCOLORS\fI + 1 ) * ( \fBCOLORS\fI + 1 )\fR -.NE +.EE +.RE .bP An application might use up to a few dozen color pairs to implement a predefined color scheme. @@ -130,7 +130,8 @@ All of the color pairs are allocated from a table of possible color pairs. The size of the table is determined by the terminfo \fBpairs\fP capability. The table is shared with \fBinit_pair\fP; in fact \fBalloc_pair\fP calls \fBinit_pair\fP after -updating the ncurses library's fast index to the colors versus color pairs. +updating the \fI\%ncurses\fP library's fast index +to the colors versus color pairs. .SS find_pair The \fBfind_pair\fP function accepts parameters for foreground and background color, and @@ -141,7 +142,6 @@ Otherwise it returns \-1. Marks the given color pair as unused, i.e., like color pair 0. .SH RETURN VALUE -.PP The \fBalloc_pair\fP function returns a color pair number in the range 1 through \fBCOLOR_PAIRS\fP\-1, unless it encounters an error updating its fast index to the color pair values, preventing it from allocating @@ -155,12 +155,12 @@ or \-1 if not. Likewise, \fBfree_pair\fP returns \fBOK\fP unless it encounters an error updating the fast index or if no such color pair is in use. .SH PORTABILITY -These routines are specific to ncurses. +These routines are specific to \fI\%ncurses\fP. They were not supported on Version 7, BSD or System V implementations. It is recommended that -any code depending on them be conditioned using NCURSES_VERSION. +any code depending on them be conditioned using \fB\%NCURSES_VERSION\fP. +.SH AUTHORS +Thomas Dickey .SH SEE ALSO -\fBcurs_color\fP(3X). -.SH AUTHOR -Thomas Dickey. +\fB\%curs_color\fP(3X) diff --git a/upstream/archlinux/man3/newlocale.3 b/upstream/archlinux/man3/newlocale.3 index 40d53798..5ea78007 100644 --- a/upstream/archlinux/man3/newlocale.3 +++ b/upstream/archlinux/man3/newlocale.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH newlocale 3 2023-10-31 "Linux man-pages 6.06" +.TH newlocale 3 2024-05-02 "Linux man-pages 6.8" .SH NAME newlocale, freelocale \- create, modify, and free a locale object .SH LIBRARY diff --git a/upstream/archlinux/man3/nextafter.3 b/upstream/archlinux/man3/nextafter.3 index 589b4892..62341014 100644 --- a/upstream/archlinux/man3/nextafter.3 +++ b/upstream/archlinux/man3/nextafter.3 @@ -7,7 +7,7 @@ .\" .\" Based on glibc infopages .\" -.TH nextafter 3 2023-10-31 "Linux man-pages 6.06" +.TH nextafter 3 2024-05-02 "Linux man-pages 6.8" .SH NAME nextafter, nextafterf, nextafterl, nexttoward, nexttowardf, nexttowardl \- floating-point number manipulation diff --git a/upstream/archlinux/man3/nextup.3 b/upstream/archlinux/man3/nextup.3 index b1594f9c..1c42365b 100644 --- a/upstream/archlinux/man3/nextup.3 +++ b/upstream/archlinux/man3/nextup.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH nextup 3 2023-10-31 "Linux man-pages 6.06" +.TH nextup 3 2024-05-02 "Linux man-pages 6.8" .SH NAME nextup, nextupf, nextupl, nextdown, nextdownf, nextdownl \- return next floating-point number toward positive/negative infinity diff --git a/upstream/archlinux/man3/ngettext.3 b/upstream/archlinux/man3/ngettext.3 index 9f687cb8..d6f9283f 100644 --- a/upstream/archlinux/man3/ngettext.3 +++ b/upstream/archlinux/man3/ngettext.3 @@ -10,7 +10,7 @@ .\" GNU gettext source code and manual .\" LI18NUX 2000 Globalization Specification .\" -.TH NGETTEXT 3 "May 2001" "GNU gettext 0.22.2" +.TH NGETTEXT 3 "May 2001" "GNU gettext 0.22.5" .SH NAME ngettext, dngettext, dcngettext \- translate message and choose plural form .SH SYNOPSIS diff --git a/upstream/archlinux/man3/nl_langinfo.3 b/upstream/archlinux/man3/nl_langinfo.3 index a605b8e3..339652b8 100644 --- a/upstream/archlinux/man3/nl_langinfo.3 +++ b/upstream/archlinux/man3/nl_langinfo.3 @@ -11,7 +11,7 @@ .\" .\" Corrected prototype, 2002-10-18, aeb .\" -.TH nl_langinfo 3 2024-01-28 "Linux man-pages 6.06" +.TH nl_langinfo 3 2024-05-02 "Linux man-pages 6.8" .SH NAME nl_langinfo, nl_langinfo_l \- query language and locale information .SH LIBRARY diff --git a/upstream/archlinux/man3/ntp_gettime.3 b/upstream/archlinux/man3/ntp_gettime.3 index 1bc71f76..7404d5f7 100644 --- a/upstream/archlinux/man3/ntp_gettime.3 +++ b/upstream/archlinux/man3/ntp_gettime.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH ntp_gettime 3 2023-10-31 "Linux man-pages 6.06" +.TH ntp_gettime 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ntp_gettime, ntp_gettimex \- get time parameters (NTP daemon interface) .SH LIBRARY diff --git a/upstream/archlinux/man3/o2i_SCT_LIST.3ssl b/upstream/archlinux/man3/o2i_SCT_LIST.3ssl index 7067533d..2714974f 100644 --- a/upstream/archlinux/man3/o2i_SCT_LIST.3ssl +++ b/upstream/archlinux/man3/o2i_SCT_LIST.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "O2I_SCT_LIST 3ssl" -.TH O2I_SCT_LIST 3ssl 2024-01-30 3.2.1 OpenSSL +.TH O2I_SCT_LIST 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/offsetof.3 b/upstream/archlinux/man3/offsetof.3 index b63e94f5..8b93a802 100644 --- a/upstream/archlinux/man3/offsetof.3 +++ b/upstream/archlinux/man3/offsetof.3 @@ -25,7 +25,7 @@ .\" References: .\" /usr/lib/gcc/i486-linux-gnu/4.1.1/include/stddef.h .\" glibc-doc -.TH offsetof 3 2023-10-31 "Linux man-pages 6.06" +.TH offsetof 3 2024-05-02 "Linux man-pages 6.8" .SH NAME offsetof \- offset of a structure member .SH LIBRARY diff --git a/upstream/archlinux/man3/on_exit.3 b/upstream/archlinux/man3/on_exit.3 index ad3402a6..d69f7fb1 100644 --- a/upstream/archlinux/man3/on_exit.3 +++ b/upstream/archlinux/man3/on_exit.3 @@ -9,7 +9,7 @@ .\" 386BSD man pages .\" Modified 1993-04-02, David Metcalfe .\" Modified 1993-07-25, Rik Faith (faith@cs.unc.edu) -.TH on_exit 3 2023-10-31 "Linux man-pages 6.06" +.TH on_exit 3 2024-05-02 "Linux man-pages 6.8" .SH NAME on_exit \- register a function to be called at normal process termination .SH LIBRARY diff --git a/upstream/archlinux/man3/open_memstream.3 b/upstream/archlinux/man3/open_memstream.3 index f7e928e9..8e86d144 100644 --- a/upstream/archlinux/man3/open_memstream.3 +++ b/upstream/archlinux/man3/open_memstream.3 @@ -5,7 +5,7 @@ .\" .\" 2008-12-04, Petr Baudis <pasky@suse.cz>: Document open_wmemstream() .\" -.TH open_memstream 3 2023-12-28 "Linux man-pages 6.06" +.TH open_memstream 3 2024-05-02 "Linux man-pages 6.8" .SH NAME open_memstream, open_wmemstream \- open a dynamic memory buffer stream .SH LIBRARY diff --git a/upstream/archlinux/man3/opendir.3 b/upstream/archlinux/man3/opendir.3 index 1bbe0e44..72fd5321 100644 --- a/upstream/archlinux/man3/opendir.3 +++ b/upstream/archlinux/man3/opendir.3 @@ -10,7 +10,7 @@ .\" Modified Sat Jul 24 18:46:01 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified 11 June 1995 by Andries Brouwer (aeb@cwi.nl) .\" 2007-07-30 Ulrich Drepper <drepper@redhat.com>: document fdopendir(). -.TH opendir 3 2023-10-31 "Linux man-pages 6.06" +.TH opendir 3 2024-05-02 "Linux man-pages 6.8" .SH NAME opendir, fdopendir \- open a directory .SH LIBRARY diff --git a/upstream/archlinux/man3/openpty.3 b/upstream/archlinux/man3/openpty.3 index 32081d28..5f0fa9cd 100644 --- a/upstream/archlinux/man3/openpty.3 +++ b/upstream/archlinux/man3/openpty.3 @@ -8,7 +8,7 @@ .\" .\" Added -lutil remark, 030718 .\" -.TH openpty 3 2023-10-31 "Linux man-pages 6.06" +.TH openpty 3 2024-05-02 "Linux man-pages 6.8" .SH NAME openpty, login_tty, forkpty \- terminal utility functions .SH LIBRARY diff --git a/upstream/archlinux/man3/pacutils-mtree.3 b/upstream/archlinux/man3/pacutils-mtree.3 index d2997fa1..f2b5eb89 100644 --- a/upstream/archlinux/man3/pacutils-mtree.3 +++ b/upstream/archlinux/man3/pacutils-mtree.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.01 (Pod::Simple 3.43) .\" .\" 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,79 +52,17 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" 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 "pacutils-mtree 3" -.TH pacutils-mtree 3 "2021-08-14" "pacutils" "pacutils-mtree" +.TH pacutils-mtree 3 2024-04-16 pacutils pacutils-mtree .\" 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 pacutils\-mtree \- read mtree data for installed packages -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <pacutils/mtree.h> @@ -171,13 +93,13 @@ pacutils\-mtree \- read mtree data for installed packages \& /* deprecated */ \& alpm_list_t *pu_mtree_load_pkg_mtree(alpm_handle_t *handle, alpm_pkg_t *pkg); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" Package mtree reading functions are provided to fill gaps in libarchive's mtree reader, notably \f(CW\*(C`md5digest\*(C'\fR and \f(CW\*(C`sha256digest\*(C'\fR which are currently not read by libarchive. Support is incomplete and should only be used to supplement libalpm's native mtree reader. -.IP "pu_mtree_reader_t *pu_mtree_reader_open_stream(\s-1FILE\s0 *stream);" 4 +.IP "pu_mtree_reader_t *pu_mtree_reader_open_stream(FILE *stream);" 4 .IX Item "pu_mtree_reader_t *pu_mtree_reader_open_stream(FILE *stream);" Open a file stream for parsing. .IP "pu_mtree_reader_t *pu_mtree_reader_open_package(alpm_handle_t *h, alpm_pkg_t *p);" 4 @@ -198,9 +120,9 @@ Free a \f(CW\*(C`pu_mtree_t\*(C'\fR struct. Free a \f(CW\*(C`pu_mtree_reader_t\*(C'\fR object. .IP "alpm_list_t *pu_mtree_load_pkg_mtree(alpm_handle_t *handle, alpm_pkg_t *pkg);" 4 .IX Item "alpm_list_t *pu_mtree_load_pkg_mtree(alpm_handle_t *handle, alpm_pkg_t *pkg);" -Returns a list of mtree entries for \f(CW\*(C`pkg\*(C'\fR. \fB\s-1DEPRECATED\s0\fR: use +Returns a list of mtree entries for \f(CW\*(C`pkg\*(C'\fR. \fBDEPRECATED\fR: use \&\f(CW\*(C`pu_mtree_reader_open_package\*(C'\fR instead. -.SH "EXAMPLES" +.SH EXAMPLES .IX Header "EXAMPLES" .IP "Print file md5sums for a package:" 4 .IX Item "Print file md5sums for a package:" diff --git a/upstream/archlinux/man3/panel.3x b/upstream/archlinux/man3/panel.3x index 9fa3ae2b..d86f240d 100644 --- a/upstream/archlinux/man3/panel.3x +++ b/upstream/archlinux/man3/panel.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,253 +27,264 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: panel.3x,v 1.42 2022/02/12 20:03:40 tom Exp $ -.TH panel 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: panel.3x,v 1.63 2024/03/16 15:35:01 tom Exp $ +.TH panel 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -panel \- panel stack extension for curses +panel \- +panel stack extension for \fIcurses\fP .SH SYNOPSIS -\fB#include <panel.h>\fP -.P -\fBcc [flags] sourcefiles \-lpanel \-lncurses\fP -.P -\fBPANEL *new_panel(WINDOW *\fIwin\fB);\fR -.sp -\fBint bottom_panel(PANEL *\fIpan\fB);\fR -.br -\fBint top_panel(PANEL *\fIpan\fB);\fR -.br -\fBint show_panel(PANEL *\fIpan\fB);\fR -.br -\fBvoid update_panels(void);\fP -.br -\fBint hide_panel(PANEL *\fIpan\fB);\fR -.sp -\fBWINDOW *panel_window(const PANEL *\fIpan\fB);\fR -.br -\fBint replace_panel(PANEL *\fIpan\fB, WINDOW *\fIwindow\fB);\fR -.br -\fBint move_panel(PANEL *\fIpan\fB, int \fIstarty\fB, int \fIstartx\fB);\fR -.br -\fBint panel_hidden(const PANEL *\fIpan\fB);\fR -.sp -\fBPANEL *panel_above(const PANEL *\fIpan\fB);\fR -.br -\fBPANEL *panel_below(const PANEL *\fIpan\fB);\fR -.sp -\fBint set_panel_userptr(PANEL *\fIpan\fB, const void *\fIptr\fB);\fR -.br -\fBconst void *panel_userptr(const PANEL *\fIpan\fB);\fR -.sp -\fBint del_panel(PANEL *\fIpan\fB);\fR -.sp -\fR/* ncurses-extensions */\fP -.br -\fBPANEL *ground_panel(SCREEN *\fIsp\fB);\fR -.br -\fBPANEL *ceiling_panel(SCREEN *\fIsp\fB);\fR -.br +.nf +\fB#include <panel.h> +.PP +\fBPANEL *new_panel(WINDOW *\fIwin\fP); +.PP +\fBint bottom_panel(PANEL *\fIpan\fP); +\fBint top_panel(PANEL *\fIpan\fP); +\fBint show_panel(PANEL *\fIpan\fP); +\fBvoid update_panels(void); +\fBint hide_panel(PANEL *\fIpan\fP); +.PP +\fBWINDOW *panel_window(const PANEL *\fIpan\fP); +\fBint replace_panel(PANEL *\fIpan\fP, WINDOW *\fIwindow\fP); +\fBint move_panel(PANEL *\fIpan\fP, int \fIstarty\fP, int \fIstartx\fP); +\fBint panel_hidden(const PANEL *\fIpan\fP); +.PP +\fBPANEL *panel_above(const PANEL *\fIpan\fP); +\fBPANEL *panel_below(const PANEL *\fIpan\fP); +.PP +\fBint set_panel_userptr(PANEL *\fIpan\fP, const void *\fIptr\fP); +\fBconst void *panel_userptr(const PANEL *\fIpan\fP); +.PP +\fBint del_panel(PANEL *\fIpan\fP); +.PP +\fI/* ncurses extensions */\fP +\fBPANEL *ground_panel(SCREEN *\fIsp\fP); +\fBPANEL *ceiling_panel(SCREEN *\fIsp\fP); +.fi .SH DESCRIPTION -Panels are \fBcurses\fP(3X) windows with the added feature of +Panels are \fBcurses\fP(3X) windows with the added property of depth. -Panel functions allow the use of stacked windows and ensure -the proper portions of each window and the curses \fBstdscr\fP window are -hidden or displayed when panels are added, moved, modified or removed. +Panel functions allow the use of stacked windows and ensure that the +proper portions of each window and the \fIcurses\fP \fB\%stdscr\fP +window are hidden or displayed when panels are added, +moved, +modified, +or removed. The set of currently visible panels is the stack of panels. The -\fBstdscr\fP window is beneath all panels, and is not considered part -of the stack. -.P -A window is associated with every panel. -The panel routines enable -you to create, move, hide, and show panels, as well as position a -panel at any desired location in the stack. -.P -Panel routines are a functional layer added to \fBcurses\fP(3X), make only -high-level curses calls, and work anywhere terminfo curses does. +\fB\%stdscr\fP window is beneath all panels, +and is not considered part of the stack. +.PP +A window is associated with each panel. +The panel routines enable you to create, +move, +hide, +and show panels. +You can relocate a panel to any desired position in the stack. +.PP +Panel routines are a functional layer added to \fIcurses\fP, +make only high-level \fIcurses\fP calls, +and work anywhere \fIcurses\fP does. .SH FUNCTIONS .\" --------- .SS bottom_panel -\fBbottom_panel(\fIpan\fB)\fR +\fB\%bottom_panel(\fIpan\fB)\fR puts panel \fIpan\fP at the bottom of all panels. .\" --------- .SS ceiling_panel -\fBceiling_panel(\fIsp\fB)\fR -acts like \fBpanel_below(NULL)\fP, for the given \fBSCREEN\fP \fIsp\fP. +\fB\%ceiling_panel(\fIsp\fB)\fR +acts like \fB\%panel_below(NULL)\fP +for the given \fISCREEN\fP \fIsp\fP. .\" --------- .SS del_panel -\fBdel_panel(\fIpan\fB)\fR -removes the given panel \fIpan\fP from the stack and deallocates the -\fBPANEL\fP structure (but not its associated window). +\fB\%del_panel(\fIpan\fB)\fR +removes the given panel \fIpan\fP from the stack and deallocates the +\fI\%PANEL\fP structure (but not its associated window). .\" --------- .SS ground_panel -\fBground_panel(\fIsp\fB)\fR -acts like \fBpanel_above(NULL)\fP, for the given \fBSCREEN\fP \fIsp\fP. +\fB\%ground_panel(\fIsp\fB)\fR +acts like \fB\%panel_above(NULL)\fP +for the given \fISCREEN\fP \fIsp\fP. .\" --------- .SS hide_panel -\fBhide_panel(\fIpan\fB)\fR +\fB\%hide_panel(\fIpan\fB)\fR removes the given panel \fIpan\fP from the panel stack and thus hides it from view. -The \fBPANEL\fP structure is not lost, merely removed from the stack. +The \fI\%PANEL\fP structure is not lost, +merely removed from the stack. .\" --------- .SS move_panel -\fBmove_panel(\fIpan\fB,\fIstarty\fB,\fIstartx\fB)\fR -moves the given panel \fIpan\fP's window so that its upper-left corner is at -\fIstarty\fP, \fIstartx\fP. +\fB\%move_panel(\fIpan\fB, \fIstarty\fB, \fIstartx\fB)\fR +moves the given panel \fIpan\fP's window so that its upper-left corner +is at +\fIstarty\fP, +\fIstartx\fP. It does not change the position of the panel in the stack. -Be sure to use this function, not \fBmvwin\fP(3X), to move a panel window. +Be sure to use this function, +not \fB\%mvwin\fP(3X), +to move a panel window. .\" --------- .SS new_panel -\fBnew_panel(\fIwin\fB)\fR allocates a \fBPANEL\fR structure, -associates it with \fIwin\fP, places the panel on the top of the stack -(causes it to be displayed above any other panel) and returns a -pointer to the new panel. +\fB\%new_panel(\fIwin\fB)\fR allocates a \fI\%PANEL\fR structure, +associates it with \fIwin\fP, +places the panel on the top of the stack +(causes it to be displayed above any other panel) +and returns a pointer to the new panel. .\" --------- .SS panel_above -\fBpanel_above(\fIpan\fB)\fR +\fB\%panel_above(\fIpan\fB)\fR returns a pointer to the panel above \fIpan\fP. If the panel argument is -\fB(PANEL *)0\fP, it returns a pointer to the bottom panel in the stack. +\*(``\fB(PANEL *)0\fP\*('', +it returns a pointer to the bottom panel in the stack. .\" --------- .SS panel_below -\fBpanel_below(\fIpan\fB)\fR +\fB\%panel_below(\fIpan\fB)\fR returns a pointer to the panel just below \fIpan\fP. -If the panel argument -is \fB(PANEL *)0\fP, it returns a pointer to the top panel in the stack. +If the panel argument is +\*(``\fB(PANEL *)0\fP\*('', +it returns a pointer to the top panel in the stack. .\" --------- .SS panel_hidden -\fBpanel_hidden(\fIpan\fB)\fR -returns \fBTRUE\fP if the panel \fIpan\fP is in the panel stack, -\fBFALSE\fP if it is not. -If the panel is a null pointer, return \fBERR\fP. +\fB\%panel_hidden(\fIpan\fB)\fR +returns \fBFALSE\fP if the panel \fIpan\fP is in the panel stack, +and \fBTRUE\fP if it is not. +If the panel is a null pointer, +it returns \fBERR\fP. .\" --------- .SS panel_userptr -\fBpanel_userptr(\fIpan\fB)\fR +\fB\%panel_userptr(\fIpan\fB)\fR returns the user pointer for a given panel \fIpan\fP. .\" --------- .SS panel_window -\fBpanel_window(\fIpan\fB)\fR +\fB\%panel_window(\fIpan\fB)\fR returns a pointer to the window of the given panel \fIpan\fP. .\" --------- .SS replace_panel -\fBreplace_panel(\fIpan\fB,\fIwindow\fB)\fR +\fB\%replace_panel(\fIpan\fB, \fIwindow\fB)\fR replaces the current window of panel \fIpan\fP with \fIwindow\fP -This is useful, for example if you want to resize a panel. -In \fBncurses\fP, you can call \fBreplace_panel\fP -to resize a panel using a window resized with \fBwresize\fP(3X). +This is useful if, +for example, +you want to resize a panel. +In \fI\%ncurses\fP, +you can call \fB\%replace_panel\fP +to resize a panel using a window resized with \fB\%wresize\fP(3X). It does not change the position of the panel in the stack. .\" --------- .SS set_panel_userptr -\fBset_panel_userptr(\fIpan\fB,\fIptr\fB)\fR +\fB\%set_panel_userptr(\fIpan\fB, \fIptr\fB)\fR sets the panel's user pointer. .\" --------- .SS show_panel -\fBshow_panel(\fIpan\fB)\fR +\fB\%show_panel(\fIpan\fB)\fR makes a hidden panel visible by placing it on top of the panels in the panel stack. -See \fBCOMPATIBILITY\fP below. +See \*(``PORTABILITY\*('' below. .\" --------- .SS top_panel -\fBtop_panel(\fIpan\fB)\fR -puts the given visible panel \fIpan\fP on top of all panels in the stack. -See \fBCOMPATIBILITY\fP below. +\fB\%top_panel(\fIpan\fB)\fR +puts the given visible panel \fIpan\fP on top of all panels in the +stack. +See \*(``PORTABILITY\*('' below. .\" --------- .SS update_panels -\fBupdate_panels()\fR -refreshes the \fIvirtual screen\fP to reflect the relations between the -panels in the stack, but does not call \fBdoupdate\fP(3X) to refresh the -\fIphysical screen\fP. -Use this function and not \fBwrefresh\fP(3X) or \fBwnoutrefresh\fP(3X). +\fB\%update_panels()\fR +refreshes the virtual screen to reflect the relations between the panels +in the stack, +but does not call \fB\%doupdate\fP(3X) to refresh the physical screen. +Use this function and not \fB\%wrefresh\fP(3X) or +\fB\%wnoutrefresh\fP(3X). .PP -\fBupdate_panels\fP may be called more than once before a call to -\fBdoupdate\fP, but \fBdoupdate\fP is the function responsible for updating -the \fIphysical screen\fP. -.SH DIAGNOSTICS +\fB\%update_panels\fP may be called more than once before a call to +\fB\%doupdate\fP, +but \fB\%doupdate\fP is the function responsible for updating +the physical screen. +.SH "RETURN VALUE" Each routine that returns a pointer returns \fBNULL\fP if an error occurs. Each routine that returns an int value returns \fBOK\fP if it executes successfully and \fBERR\fP if not. .PP -Except as noted, the \fIpan\fP and \fIwindow\fP parameters must be non-null. -If those are null, an error is returned. +Except as noted, +the \fIpan\fP and \fIwindow\fP parameters must be non-null. +If either is null, +an error is returned. .PP -The \fBmove_panel\fP function uses \fBmvwin\fP(3X), -and will return an error if \fBmvwin\fP returns an error. -.SH COMPATIBILITY -Reasonable care has been taken to ensure compatibility -with the native panel facility introduced in System V (inspection of -the SVr4 manual pages suggests the programming interface is unchanged). -The \fBPANEL\fP data structures are merely similar. -The programmer -is cautioned not to directly use \fBPANEL\fP fields. -.P -The functions \fBshow_panel\fP and \fBtop_panel\fP are identical -in this implementation, and work equally well with displayed or hidden -panels. -In the native System V implementation, \fBshow_panel\fP is -intended for making a hidden panel visible (at the top of the stack) -and \fBtop_panel\fP is intended for making an already-visible panel -move to the top of the stack. -You are cautioned to use the correct -function to ensure compatibility with native panel libraries. -.SH NOTE -In your library list, libpanel.a should be before libncurses.a; that is, -you should say \*(``\-lpanel \-lncurses\*('', not the other way around -(which would give a link-error with static libraries). +The \fB\%move_panel\fP function uses \fBmvwin\fP(3X), +and returns an error if \fB\%mvwin\fP returns an error. +.SH NOTES +The header file \fI\%panel.h\fP itself includes the header file +\fI\%curses.h\fP. .SH PORTABILITY +Reasonable care has been taken to ensure compatibility +with the native panel facility introduced in System\ V; +inspection of the SVr4 manual pages suggests the programming interface +never changed. +The \fI\%PANEL\fP data structures are merely similar. +The programmer is cautioned not to directly use \fI\%PANEL\fP fields. .PP -The panel facility was documented in SVr4.2 in -\fICharacter User Interface Programming (UNIX SVR4.2)\fP. +The functions \fB\%show_panel\fP and \fB\%top_panel\fP are identical +in this implementation, +and work equally well with displayed or hidden panels. +In the System\ V implementation, +\fB\%show_panel\fP is intended for making a hidden panel visible +(at the top of the stack) +and \fB\%top_panel\fP is intended for making an already-visible panel +move to the top of the stack. +You are cautioned to use the correct +function to ensure compatibility with System\ V panel libraries. +.SH HISTORY +A panel facility was documented in SVr4.2's +\fICharacter User Interface Programming\fP document. .PP It is not part of X/Open Curses. .PP A few implementations exist: .bP Systems based on SVr4 source code, -e.g., Solaris, provide this library. +such as Solaris, +provide this library. .bP -\fBncurses\fP (since version 0.6 in 1993) -and \fBPDCurses\fP (since version 2.2 in 1995) +\fI\%ncurses\fP (since version 0.6 in 1993) +and \fIPDCurses\fP (since version 2.2 in 1995) provide a panel library whose common ancestor -was a public domain implementation by Warren Tucker +is a public domain implementation by Warren Tucker published in \fIu386mon\fP 2.20 (1990). .IP -According to Tucker, the SystemV panel library -was first released in SVr3.2 (1988), +According to Tucker, +the System\ V panel library was first released in SVr3.2 (1988), and his implementation helped with a port to SVr3.1 (1987). .IP Several developers have improved each of these; they are no longer the same as Tucker's implementation. .bP NetBSD 8 (2018) -has a panel library begun by Valery Ushakov in 2015. -This is based on the AT&T documentation. -.SH FILES -.P -panel.h -interface for the panels library -.P -libpanel.a -the panels library itself -.SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_variables\fP(3X), -.PP -This describes \fBncurses\fP -version 6.4 (patch 20230520). -.SH AUTHOR +has a panel library begun by Valery Ushakov in 2015, +based on the System\ V documentation. +.SH AUTHORS +Warren Tucker <wht@n4hgf.mt\-park.ga.us> originally wrote this +implementation, +primarily to assist in porting \fI\%u386mon\fP to systems without a +native panel library. .PP -Originally written by Warren Tucker <wht@n4hgf.mt-park.ga.us>, -primarily to assist in porting \fIu386mon\fP to systems without a native -panels library. +Zeyd ben-Halim repackaged it for \fI\%ncurses\fP. .PP -Repackaged for ncurses by Zeyd ben-Halim. -.PP -Juergen Pfeifer and Thomas E. Dickey revised/improved the library. +Juergen Pfeifer and Thomas E. Dickey revised and improved the library. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%curs_variables\fP(3X) diff --git a/upstream/archlinux/man3/perror.3 b/upstream/archlinux/man3/perror.3 index 7dd1fff5..b66f33c4 100644 --- a/upstream/archlinux/man3/perror.3 +++ b/upstream/archlinux/man3/perror.3 @@ -10,7 +10,7 @@ .\" (msmith@falcon.mercer.peachnet.edu) and various other changes. .\" Modified 1996-05-16 by Martin Schulze (joey@infodrom.north.de) .\" -.TH perror 3 2023-10-31 "Linux man-pages 6.06" +.TH perror 3 2024-05-02 "Linux man-pages 6.8" .SH NAME perror \- print a system error message .SH LIBRARY diff --git a/upstream/archlinux/man3/popen.3 b/upstream/archlinux/man3/popen.3 index a02754b9..c4d34bc2 100644 --- a/upstream/archlinux/man3/popen.3 +++ b/upstream/archlinux/man3/popen.3 @@ -10,7 +10,7 @@ .\" Modified Sat May 18 20:37:44 1996 by Martin Schulze (joey@linux.de) .\" Modified 7 May 1998 by Joseph S. Myers (jsm28@cam.ac.uk) .\" -.TH popen 3 2023-10-31 "Linux man-pages 6.06" +.TH popen 3 2024-05-02 "Linux man-pages 6.8" .SH NAME popen, pclose \- pipe stream to or from a process .SH LIBRARY diff --git a/upstream/archlinux/man3/posix_fallocate.3 b/upstream/archlinux/man3/posix_fallocate.3 index fad84750..e03c68e6 100644 --- a/upstream/archlinux/man3/posix_fallocate.3 +++ b/upstream/archlinux/man3/posix_fallocate.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH posix_fallocate 3 2023-10-31 "Linux man-pages 6.06" +.TH posix_fallocate 3 2024-05-02 "Linux man-pages 6.8" .SH NAME posix_fallocate \- allocate file space .SH LIBRARY diff --git a/upstream/archlinux/man3/posix_madvise.3 b/upstream/archlinux/man3/posix_madvise.3 index 4ccffc0c..c33aa907 100644 --- a/upstream/archlinux/man3/posix_madvise.3 +++ b/upstream/archlinux/man3/posix_madvise.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH posix_madvise 3 2023-10-31 "Linux man-pages 6.06" +.TH posix_madvise 3 2024-05-02 "Linux man-pages 6.8" .SH NAME posix_madvise \- give advice about patterns of memory usage .SH LIBRARY diff --git a/upstream/archlinux/man3/posix_memalign.3 b/upstream/archlinux/man3/posix_memalign.3 index 903704ad..f1c982d7 100644 --- a/upstream/archlinux/man3/posix_memalign.3 +++ b/upstream/archlinux/man3/posix_memalign.3 @@ -7,7 +7,7 @@ .\" 2001-10-11, 2003-08-22, aeb, added some details .\" 2012-03-23, Michael Kerrisk <mtk.manpages@mail.com> .\" Document pvalloc() and aligned_alloc() -.TH posix_memalign 3 2023-11-24 "Linux man-pages 6.06" +.TH posix_memalign 3 2024-05-02 "Linux man-pages 6.8" .SH NAME posix_memalign, aligned_alloc, memalign, valloc, pvalloc \- allocate aligned memory diff --git a/upstream/archlinux/man3/posix_openpt.3 b/upstream/archlinux/man3/posix_openpt.3 index 79f6af9b..a7f1f369 100644 --- a/upstream/archlinux/man3/posix_openpt.3 +++ b/upstream/archlinux/man3/posix_openpt.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH posix_openpt 3 2023-10-31 "Linux man-pages 6.06" +.TH posix_openpt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME posix_openpt \- open a pseudoterminal device .SH LIBRARY diff --git a/upstream/archlinux/man3/posix_spawn.3 b/upstream/archlinux/man3/posix_spawn.3 index 6b3fcd5f..479f9d55 100644 --- a/upstream/archlinux/man3/posix_spawn.3 +++ b/upstream/archlinux/man3/posix_spawn.3 @@ -8,7 +8,7 @@ .\" POSIX 1003.1-2004 documentation .\" (http://www.opengroup.org/onlinepubs/009695399) .\" -.TH posix_spawn 3 2023-10-31 "Linux man-pages 6.06" +.TH posix_spawn 3 2024-05-02 "Linux man-pages 6.8" .SH NAME posix_spawn, posix_spawnp \- spawn a process .SH LIBRARY diff --git a/upstream/archlinux/man3/pow.3 b/upstream/archlinux/man3/pow.3 index 3703978b..7d9cd53a 100644 --- a/upstream/archlinux/man3/pow.3 +++ b/upstream/archlinux/man3/pow.3 @@ -13,7 +13,7 @@ .\" Modified 1995-08-14 by Arnt Gulbrandsen <agulbra@troll.no> .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) -.TH pow 3 2023-10-31 "Linux man-pages 6.06" +.TH pow 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pow, powf, powl \- power functions .SH LIBRARY diff --git a/upstream/archlinux/man3/pow10.3 b/upstream/archlinux/man3/pow10.3 index 0f9a03eb..909c9806 100644 --- a/upstream/archlinux/man3/pow10.3 +++ b/upstream/archlinux/man3/pow10.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pow10 3 2023-10-31 "Linux man-pages 6.06" +.TH pow10 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pow10, pow10f, pow10l \- base-10 power functions .SH LIBRARY diff --git a/upstream/archlinux/man3/powerof2.3 b/upstream/archlinux/man3/powerof2.3 index cd8965f4..389600ee 100644 --- a/upstream/archlinux/man3/powerof2.3 +++ b/upstream/archlinux/man3/powerof2.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH powerof2 3 2023-10-31 "Linux man-pages 6.06" +.TH powerof2 3 2024-05-02 "Linux man-pages 6.8" .SH NAME powerof2 \- test if a value is a power of 2 .SH LIBRARY diff --git a/upstream/archlinux/man3/printf.3 b/upstream/archlinux/man3/printf.3 index 1cee91c6..58ce9100 100644 --- a/upstream/archlinux/man3/printf.3 +++ b/upstream/archlinux/man3/printf.3 @@ -13,7 +13,7 @@ .\" 2000-07-26 jsm28@hermes.cam.ac.uk - three small fixes .\" 2000-10-16 jsm28@hermes.cam.ac.uk - more fixes .\" -.TH printf 3 2023-10-31 "Linux man-pages 6.06" +.TH printf 3 2024-05-02 "Linux man-pages 6.8" .SH NAME printf, fprintf, dprintf, sprintf, snprintf, vprintf, vfprintf, vdprintf, vsprintf, vsnprintf \- formatted output conversion @@ -875,7 +875,7 @@ No argument is converted. The complete conversion specification is \[aq]%%\[aq]. .SH RETURN VALUE -Upon successful return, these functions return the number of characters +Upon successful return, these functions return the number of bytes printed (excluding the null byte used to end output to strings). .P The functions diff --git a/upstream/archlinux/man3/profil.3 b/upstream/archlinux/man3/profil.3 index c247d225..77504351 100644 --- a/upstream/archlinux/man3/profil.3 +++ b/upstream/archlinux/man3/profil.3 @@ -6,7 +6,7 @@ .\" Modified Fri Jun 23 01:35:19 1995 Andries Brouwer <aeb@cwi.nl> .\" (prompted by Bas V. de Bakker <bas@phys.uva.nl>) .\" Corrected (and moved to man3), 980612, aeb -.TH profil 3 2023-10-31 "Linux man-pages 6.06" +.TH profil 3 2024-05-02 "Linux man-pages 6.8" .SH NAME profil \- execution time profile .SH LIBRARY diff --git a/upstream/archlinux/man3/program_invocation_name.3 b/upstream/archlinux/man3/program_invocation_name.3 index aec726d0..99de552e 100644 --- a/upstream/archlinux/man3/program_invocation_name.3 +++ b/upstream/archlinux/man3/program_invocation_name.3 @@ -21,7 +21,7 @@ .\" SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. .\" %%%LICENSE_END .\" -.TH program_invocation_name 3 2023-10-31 "Linux man-pages 6.06" +.TH program_invocation_name 3 2024-05-02 "Linux man-pages 6.8" .SH NAME program_invocation_name, program_invocation_short_name \- \ obtain name used to invoke calling program diff --git a/upstream/archlinux/man3/psignal.3 b/upstream/archlinux/man3/psignal.3 index a1884fb6..8064467f 100644 --- a/upstream/archlinux/man3/psignal.3 +++ b/upstream/archlinux/man3/psignal.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 18:45:17 1993 by Rik Faith (faith@cs.unc.edu) -.TH psignal 3 2023-10-31 "Linux man-pages 6.06" +.TH psignal 3 2024-05-02 "Linux man-pages 6.8" .SH NAME psignal, psiginfo \- print signal description .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_atfork.3 b/upstream/archlinux/man3/pthread_atfork.3 index d711959e..fcd512e6 100644 --- a/upstream/archlinux/man3/pthread_atfork.3 +++ b/upstream/archlinux/man3/pthread_atfork.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_atfork 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_atfork 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_atfork \- register fork handlers .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_attr_init.3 b/upstream/archlinux/man3/pthread_attr_init.3 index d11dbf3e..96d22cd2 100644 --- a/upstream/archlinux/man3/pthread_attr_init.3 +++ b/upstream/archlinux/man3/pthread_attr_init.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_attr_init 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_attr_init 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_attr_init, pthread_attr_destroy \- initialize and destroy thread attributes object diff --git a/upstream/archlinux/man3/pthread_attr_setaffinity_np.3 b/upstream/archlinux/man3/pthread_attr_setaffinity_np.3 index 71d52a58..51936c58 100644 --- a/upstream/archlinux/man3/pthread_attr_setaffinity_np.3 +++ b/upstream/archlinux/man3/pthread_attr_setaffinity_np.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_attr_setaffinity_np 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_attr_setaffinity_np 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_attr_setaffinity_np, pthread_attr_getaffinity_np \- set/get CPU affinity attribute in thread attributes object diff --git a/upstream/archlinux/man3/pthread_attr_setdetachstate.3 b/upstream/archlinux/man3/pthread_attr_setdetachstate.3 index 12a6db12..99d77dbc 100644 --- a/upstream/archlinux/man3/pthread_attr_setdetachstate.3 +++ b/upstream/archlinux/man3/pthread_attr_setdetachstate.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_attr_setdetachstate 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_attr_setdetachstate 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_attr_setdetachstate, pthread_attr_getdetachstate \- set/get detach state attribute in thread attributes object diff --git a/upstream/archlinux/man3/pthread_attr_setguardsize.3 b/upstream/archlinux/man3/pthread_attr_setguardsize.3 index 9cabd8cc..4114d151 100644 --- a/upstream/archlinux/man3/pthread_attr_setguardsize.3 +++ b/upstream/archlinux/man3/pthread_attr_setguardsize.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_attr_setguardsize 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_attr_setguardsize 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_attr_setguardsize, pthread_attr_getguardsize \- set/get guard size attribute in thread attributes object diff --git a/upstream/archlinux/man3/pthread_attr_setinheritsched.3 b/upstream/archlinux/man3/pthread_attr_setinheritsched.3 index 3753a834..731389d7 100644 --- a/upstream/archlinux/man3/pthread_attr_setinheritsched.3 +++ b/upstream/archlinux/man3/pthread_attr_setinheritsched.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_attr_setinheritsched 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_attr_setinheritsched 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_attr_setinheritsched, pthread_attr_getinheritsched \- set/get inherit-scheduler attribute in thread attributes object diff --git a/upstream/archlinux/man3/pthread_attr_setschedparam.3 b/upstream/archlinux/man3/pthread_attr_setschedparam.3 index 2cb2afc8..2eca5eff 100644 --- a/upstream/archlinux/man3/pthread_attr_setschedparam.3 +++ b/upstream/archlinux/man3/pthread_attr_setschedparam.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_attr_setschedparam 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_attr_setschedparam 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_attr_setschedparam, pthread_attr_getschedparam \- set/get scheduling parameter attributes in thread attributes object diff --git a/upstream/archlinux/man3/pthread_attr_setschedpolicy.3 b/upstream/archlinux/man3/pthread_attr_setschedpolicy.3 index bff4b4c6..f703240f 100644 --- a/upstream/archlinux/man3/pthread_attr_setschedpolicy.3 +++ b/upstream/archlinux/man3/pthread_attr_setschedpolicy.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_attr_setschedpolicy 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_attr_setschedpolicy 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_attr_setschedpolicy, pthread_attr_getschedpolicy \- set/get scheduling policy attribute in thread attributes object diff --git a/upstream/archlinux/man3/pthread_attr_setscope.3 b/upstream/archlinux/man3/pthread_attr_setscope.3 index 37ab1046..9964fb8e 100644 --- a/upstream/archlinux/man3/pthread_attr_setscope.3 +++ b/upstream/archlinux/man3/pthread_attr_setscope.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_attr_setscope 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_attr_setscope 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_attr_setscope, pthread_attr_getscope \- set/get contention scope attribute in thread attributes object diff --git a/upstream/archlinux/man3/pthread_attr_setsigmask_np.3 b/upstream/archlinux/man3/pthread_attr_setsigmask_np.3 index 5271074b..0e839a45 100644 --- a/upstream/archlinux/man3/pthread_attr_setsigmask_np.3 +++ b/upstream/archlinux/man3/pthread_attr_setsigmask_np.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_attr_setsigmask_np 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_attr_setsigmask_np 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_attr_setsigmask_np, pthread_attr_getsigmask_np \- set/get signal mask attribute in thread attributes object diff --git a/upstream/archlinux/man3/pthread_attr_setstack.3 b/upstream/archlinux/man3/pthread_attr_setstack.3 index 31ec24ca..a147e004 100644 --- a/upstream/archlinux/man3/pthread_attr_setstack.3 +++ b/upstream/archlinux/man3/pthread_attr_setstack.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_attr_setstack 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_attr_setstack 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_attr_setstack, pthread_attr_getstack \- set/get stack attributes in thread attributes object diff --git a/upstream/archlinux/man3/pthread_attr_setstackaddr.3 b/upstream/archlinux/man3/pthread_attr_setstackaddr.3 index 8503c42c..a39fbc81 100644 --- a/upstream/archlinux/man3/pthread_attr_setstackaddr.3 +++ b/upstream/archlinux/man3/pthread_attr_setstackaddr.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_attr_setstackaddr 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_attr_setstackaddr 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_attr_setstackaddr, pthread_attr_getstackaddr \- set/get stack address attribute in thread attributes object diff --git a/upstream/archlinux/man3/pthread_attr_setstacksize.3 b/upstream/archlinux/man3/pthread_attr_setstacksize.3 index 791bcb8c..7d204629 100644 --- a/upstream/archlinux/man3/pthread_attr_setstacksize.3 +++ b/upstream/archlinux/man3/pthread_attr_setstacksize.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_attr_setstacksize 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_attr_setstacksize 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_attr_setstacksize, pthread_attr_getstacksize \- set/get stack size attribute in thread attributes object diff --git a/upstream/archlinux/man3/pthread_cancel.3 b/upstream/archlinux/man3/pthread_cancel.3 index 10a43e18..862f695b 100644 --- a/upstream/archlinux/man3/pthread_cancel.3 +++ b/upstream/archlinux/man3/pthread_cancel.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_cancel 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_cancel 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_cancel \- send a cancelation request to a thread .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_cleanup_push.3 b/upstream/archlinux/man3/pthread_cleanup_push.3 index 106154b5..a0b54776 100644 --- a/upstream/archlinux/man3/pthread_cleanup_push.3 +++ b/upstream/archlinux/man3/pthread_cleanup_push.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_cleanup_push 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_cleanup_push 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_cleanup_push, pthread_cleanup_pop \- push and pop thread cancelation clean-up handlers diff --git a/upstream/archlinux/man3/pthread_cleanup_push_defer_np.3 b/upstream/archlinux/man3/pthread_cleanup_push_defer_np.3 index 0a2a374e..ea977c55 100644 --- a/upstream/archlinux/man3/pthread_cleanup_push_defer_np.3 +++ b/upstream/archlinux/man3/pthread_cleanup_push_defer_np.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_cleanup_push_defer_np 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_cleanup_push_defer_np 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_cleanup_push_defer_np, pthread_cleanup_pop_restore_np \- push and pop thread cancelation clean-up handlers while saving cancelability type diff --git a/upstream/archlinux/man3/pthread_cond_init.3 b/upstream/archlinux/man3/pthread_cond_init.3 index cfe5dbaa..a89d65b0 100644 --- a/upstream/archlinux/man3/pthread_cond_init.3 +++ b/upstream/archlinux/man3/pthread_cond_init.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_cond_init 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_cond_init 3 2024-05-19 "Linux man-pages 6.8" . . .SH NAME @@ -18,16 +18,20 @@ operations on conditions . . .SH SYNOPSIS +.nf .B #include <pthread.h> .P .BI "pthread_cond_t " cond " = PTHREAD_COND_INITIALIZER;" .P -.BI "int pthread_cond_init(pthread_cond_t *" cond ", pthread_condattr_t *" cond_attr ");" -.BI "int pthread_cond_signal(pthread_cond_t *" cond ");" -.BI "int pthread_cond_broadcast(pthread_cond_t *" cond ");" -.BI "int pthread_cond_wait(pthread_cond_t *" cond ", pthread_mutex_t *" mutex ");" -.BI "int pthread_cond_timedwait(pthread_cond_t *" cond ", pthread_mutex_t *" mutex ", const struct timespec *" abstime ");" -.BI "int pthread_cond_destroy(pthread_cond_t *" cond ");" +.BI "int pthread_cond_init(pthread_cond_t *" cond , +.BI " pthread_condattr_t *" cond_attr ); +.BI "int pthread_cond_signal(pthread_cond_t *" cond ); +.BI "int pthread_cond_broadcast(pthread_cond_t *" cond ); +.BI "int pthread_cond_wait(pthread_cond_t *" cond ", pthread_mutex_t *" mutex ); +.BI "int pthread_cond_timedwait(pthread_cond_t *" cond ", pthread_mutex_t *" mutex , +.BI " const struct timespec *" abstime ); +.BI "int pthread_cond_destroy(pthread_cond_t *" cond ); +.fi . . .SH DESCRIPTION @@ -110,12 +114,12 @@ except checking that the condition has no waiting threads. . .SH CANCELLATION \fBpthread_cond_wait\fP and \fBpthread_cond_timedwait\fP -are cancellation points. +are cancelation points. If a thread is cancelled while suspended in one of these functions, the thread immediately resumes execution, then locks again the \fImutex\fP argument to \fBpthread_cond_wait\fP and \fBpthread_cond_timedwait\fP, -and finally executes the cancellation. +and finally executes the cancelation. Consequently, cleanup handlers are assured that \fImutex\fP is locked when they are called. diff --git a/upstream/archlinux/man3/pthread_condattr_init.3 b/upstream/archlinux/man3/pthread_condattr_init.3 index 2fda7f3e..10910428 100644 --- a/upstream/archlinux/man3/pthread_condattr_init.3 +++ b/upstream/archlinux/man3/pthread_condattr_init.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_condattr_init 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_condattr_init 3 2024-05-02 "Linux man-pages 6.8" . . .SH NAME diff --git a/upstream/archlinux/man3/pthread_create.3 b/upstream/archlinux/man3/pthread_create.3 index c592e1b9..47ff51a2 100644 --- a/upstream/archlinux/man3/pthread_create.3 +++ b/upstream/archlinux/man3/pthread_create.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_create 3 2024-02-12 "Linux man-pages 6.06" +.TH pthread_create 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_create \- create a new thread .SH LIBRARY @@ -257,6 +257,7 @@ Joined with thread 3; returned value was SERVUS #include <stdio.h> #include <stdlib.h> #include <string.h> +#include <sys/types.h> #include <unistd.h> \& #define handle_error_en(en, msg) \e diff --git a/upstream/archlinux/man3/pthread_detach.3 b/upstream/archlinux/man3/pthread_detach.3 index 336a0707..d9da1bf8 100644 --- a/upstream/archlinux/man3/pthread_detach.3 +++ b/upstream/archlinux/man3/pthread_detach.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_detach 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_detach 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_detach \- detach a thread .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_equal.3 b/upstream/archlinux/man3/pthread_equal.3 index 754b558f..187fe7da 100644 --- a/upstream/archlinux/man3/pthread_equal.3 +++ b/upstream/archlinux/man3/pthread_equal.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_equal 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_equal 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_equal \- compare thread IDs .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_exit.3 b/upstream/archlinux/man3/pthread_exit.3 index 5a693541..c7c214d9 100644 --- a/upstream/archlinux/man3/pthread_exit.3 +++ b/upstream/archlinux/man3/pthread_exit.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_exit 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_exit 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_exit \- terminate calling thread .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_getattr_default_np.3 b/upstream/archlinux/man3/pthread_getattr_default_np.3 index c18761eb..dd088819 100644 --- a/upstream/archlinux/man3/pthread_getattr_default_np.3 +++ b/upstream/archlinux/man3/pthread_getattr_default_np.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_getattr_default_np 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_getattr_default_np 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_getattr_default_np, pthread_setattr_default_np, \- get or set default thread-creation attributes diff --git a/upstream/archlinux/man3/pthread_getattr_np.3 b/upstream/archlinux/man3/pthread_getattr_np.3 index 1069b0c0..b9fcbdb1 100644 --- a/upstream/archlinux/man3/pthread_getattr_np.3 +++ b/upstream/archlinux/man3/pthread_getattr_np.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_getattr_np 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_getattr_np 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_getattr_np \- get attributes of created thread .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_getcpuclockid.3 b/upstream/archlinux/man3/pthread_getcpuclockid.3 index 60389446..8c327ab8 100644 --- a/upstream/archlinux/man3/pthread_getcpuclockid.3 +++ b/upstream/archlinux/man3/pthread_getcpuclockid.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_getcpuclockid 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_getcpuclockid 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_getcpuclockid \- retrieve ID of a thread's CPU time clock .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_join.3 b/upstream/archlinux/man3/pthread_join.3 index 5ae8658f..a907ede7 100644 --- a/upstream/archlinux/man3/pthread_join.3 +++ b/upstream/archlinux/man3/pthread_join.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_join 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_join 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_join \- join with a terminated thread .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_key_create.3 b/upstream/archlinux/man3/pthread_key_create.3 index 75ad8f47..71cc41c8 100644 --- a/upstream/archlinux/man3/pthread_key_create.3 +++ b/upstream/archlinux/man3/pthread_key_create.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_key_create 3 2023-11-24 "Linux man-pages 6.06" +.TH pthread_key_create 3 2024-05-19 "Linux man-pages 6.8" . . .SH NAME @@ -16,12 +16,15 @@ management of thread-specific data . . .SH SYNOPSIS +.nf .B #include <pthread.h> .P -.BI "int pthread_key_create(pthread_key_t *" key ", void (*" destr_function ") (void *));" -.BI "int pthread_key_delete(pthread_key_t " key ");" -.BI "int pthread_setspecific(pthread_key_t " key ", const void *" pointer ");" -.BI "void * pthread_getspecific(pthread_key_t " key ");" +.BI "int pthread_key_create(pthread_key_t *" key , +.BI " void (*" destr_function ") (void *));" +.BI "int pthread_key_delete(pthread_key_t " key ); +.BI "int pthread_setspecific(pthread_key_t " key ", const void *" pointer ); +.BI "void * pthread_getspecific(pthread_key_t " key ); +.fi . . .SH DESCRIPTION @@ -59,7 +62,7 @@ is \fBNULL\fP in all currently executing threads. The \fIdestr_function\fP argument, if not \fBNULL\fP, specifies a destructor function associated with the key. -When a thread terminates via \fBpthread_exit\fP or by cancellation, +When a thread terminates via \fBpthread_exit\fP or by cancelation, \fIdestr_function\fP is called with arguments the value associated with the key in that thread. The \fIdestr_function\fP is not called if that value is \fBNULL\fP. diff --git a/upstream/archlinux/man3/pthread_kill.3 b/upstream/archlinux/man3/pthread_kill.3 index 9adc7849..7afdcefc 100644 --- a/upstream/archlinux/man3/pthread_kill.3 +++ b/upstream/archlinux/man3/pthread_kill.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_kill 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_kill 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_kill \- send a signal to a thread .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_kill_other_threads_np.3 b/upstream/archlinux/man3/pthread_kill_other_threads_np.3 index cc1b3544..219912d9 100644 --- a/upstream/archlinux/man3/pthread_kill_other_threads_np.3 +++ b/upstream/archlinux/man3/pthread_kill_other_threads_np.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_kill_other_threads_np 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_kill_other_threads_np 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_kill_other_threads_np \- terminate all other threads in process .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_mutex_consistent.3 b/upstream/archlinux/man3/pthread_mutex_consistent.3 index 822602a8..fc8353d8 100644 --- a/upstream/archlinux/man3/pthread_mutex_consistent.3 +++ b/upstream/archlinux/man3/pthread_mutex_consistent.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_mutex_consistent 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_mutex_consistent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_mutex_consistent \- make a robust mutex consistent .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_mutex_init.3 b/upstream/archlinux/man3/pthread_mutex_init.3 index 1574489c..6f1c2150 100644 --- a/upstream/archlinux/man3/pthread_mutex_init.3 +++ b/upstream/archlinux/man3/pthread_mutex_init.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_mutex_init 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_mutex_init 3 2024-05-19 "Linux man-pages 6.8" . . .SH NAME @@ -17,17 +17,20 @@ operations on mutexes . . .SH SYNOPSIS +.nf .B #include <pthread.h> .P .BI "pthread_mutex_t " fastmutex " = PTHREAD_MUTEX_INITIALIZER;" .BI "pthread_mutex_t " recmutex " = PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP;" .BI "pthread_mutex_t " errchkmutex " = PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP;" .P -.BI "int pthread_mutex_init(pthread_mutex_t *" mutex ", const pthread_mutexattr_t *" mutexattr ");" -.BI "int pthread_mutex_lock(pthread_mutex_t *" mutex ");" -.BI "int pthread_mutex_trylock(pthread_mutex_t *" mutex ");" -.BI "int pthread_mutex_unlock(pthread_mutex_t *" mutex ");" -.BI "int pthread_mutex_destroy(pthread_mutex_t *" mutex ");" +.BI "int pthread_mutex_init(pthread_mutex_t *" mutex , +.BI " const pthread_mutexattr_t *" mutexattr ); +.BI "int pthread_mutex_lock(pthread_mutex_t *" mutex ); +.BI "int pthread_mutex_trylock(pthread_mutex_t *" mutex ); +.BI "int pthread_mutex_unlock(pthread_mutex_t *" mutex ); +.BI "int pthread_mutex_destroy(pthread_mutex_t *" mutex ); +.fi . . .SH DESCRIPTION @@ -130,16 +133,16 @@ except checking that the mutex is unlocked. . . .SH CANCELLATION -None of the mutex functions is a cancellation point, +None of the mutex functions is a cancelation point, not even \fBpthread_mutex_lock\fP, in spite of the fact that it can suspend a thread for arbitrary durations. This way, -the status of mutexes at cancellation points is predictable, -allowing cancellation handlers +the status of mutexes at cancelation points is predictable, +allowing cancelation handlers to unlock precisely those mutexes that need to be unlocked before the thread stops executing. Consequently, -threads using deferred cancellation +threads using deferred cancelation should never hold a mutex for extended periods of time. . . diff --git a/upstream/archlinux/man3/pthread_mutexattr_getpshared.3 b/upstream/archlinux/man3/pthread_mutexattr_getpshared.3 index eeab6751..422e52fe 100644 --- a/upstream/archlinux/man3/pthread_mutexattr_getpshared.3 +++ b/upstream/archlinux/man3/pthread_mutexattr_getpshared.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_mutexattr_getpshared 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_mutexattr_getpshared 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_mutexattr_getpshared, pthread_mutexattr_setpshared \- get/set process-shared mutex attribute diff --git a/upstream/archlinux/man3/pthread_mutexattr_init.3 b/upstream/archlinux/man3/pthread_mutexattr_init.3 index 29abfd0e..4ee4af6d 100644 --- a/upstream/archlinux/man3/pthread_mutexattr_init.3 +++ b/upstream/archlinux/man3/pthread_mutexattr_init.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_mutexattr_init 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_mutexattr_init 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_mutexattr_init, pthread_mutexattr_destroy \- initialize and destroy a mutex attributes object diff --git a/upstream/archlinux/man3/pthread_mutexattr_setkind_np.3 b/upstream/archlinux/man3/pthread_mutexattr_setkind_np.3 index 641ba536..d2ba8302 100644 --- a/upstream/archlinux/man3/pthread_mutexattr_setkind_np.3 +++ b/upstream/archlinux/man3/pthread_mutexattr_setkind_np.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_mutexattr_setkind_np 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_mutexattr_setkind_np 3 2024-05-19 "Linux man-pages 6.8" . . .SH NAME @@ -14,10 +14,13 @@ deprecated mutex creation attributes . . .SH SYNOPSIS +.nf .B #include <pthread.h> .P -.BI "int pthread_mutexattr_setkind_np(pthread_mutexattr_t *" attr ", int " kind ");" -.BI "int pthread_mutexattr_getkind_np(const pthread_mutexattr_t *" attr ", int *" kind ");" +.BI "int pthread_mutexattr_setkind_np(pthread_mutexattr_t *" attr ", int " kind ); +.BI "int pthread_mutexattr_getkind_np(const pthread_mutexattr_t *" attr , +.BI " int *" kind ); +.fi . . .SH DESCRIPTION diff --git a/upstream/archlinux/man3/pthread_mutexattr_setrobust.3 b/upstream/archlinux/man3/pthread_mutexattr_setrobust.3 index e412307d..b7438336 100644 --- a/upstream/archlinux/man3/pthread_mutexattr_setrobust.3 +++ b/upstream/archlinux/man3/pthread_mutexattr_setrobust.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_mutexattr_setrobust 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_mutexattr_setrobust 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_mutexattr_getrobust, pthread_mutexattr_setrobust \- get and set the robustness attribute of a mutex attributes object diff --git a/upstream/archlinux/man3/pthread_once.3 b/upstream/archlinux/man3/pthread_once.3 index 14bad388..565ad3a0 100644 --- a/upstream/archlinux/man3/pthread_once.3 +++ b/upstream/archlinux/man3/pthread_once.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_once 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_once 3 2024-05-02 "Linux man-pages 6.8" . . .SH NAME diff --git a/upstream/archlinux/man3/pthread_rwlockattr_setkind_np.3 b/upstream/archlinux/man3/pthread_rwlockattr_setkind_np.3 index 703deaa8..d6163197 100644 --- a/upstream/archlinux/man3/pthread_rwlockattr_setkind_np.3 +++ b/upstream/archlinux/man3/pthread_rwlockattr_setkind_np.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_rwlockattr_setkind_np 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_rwlockattr_setkind_np 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_rwlockattr_setkind_np, pthread_rwlockattr_getkind_np \- set/get the read-write lock kind of the thread read-write lock attribute object diff --git a/upstream/archlinux/man3/pthread_self.3 b/upstream/archlinux/man3/pthread_self.3 index 2477a9d6..e356273c 100644 --- a/upstream/archlinux/man3/pthread_self.3 +++ b/upstream/archlinux/man3/pthread_self.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_self 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_self 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_self \- obtain ID of the calling thread .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_setaffinity_np.3 b/upstream/archlinux/man3/pthread_setaffinity_np.3 index 5ec71657..531f59a0 100644 --- a/upstream/archlinux/man3/pthread_setaffinity_np.3 +++ b/upstream/archlinux/man3/pthread_setaffinity_np.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_setaffinity_np 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_setaffinity_np 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_setaffinity_np, pthread_getaffinity_np \- set/get CPU affinity of a thread diff --git a/upstream/archlinux/man3/pthread_setcancelstate.3 b/upstream/archlinux/man3/pthread_setcancelstate.3 index 28cb353a..0d4fd479 100644 --- a/upstream/archlinux/man3/pthread_setcancelstate.3 +++ b/upstream/archlinux/man3/pthread_setcancelstate.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_setcancelstate 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_setcancelstate 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_setcancelstate, pthread_setcanceltype \- set cancelability state and type diff --git a/upstream/archlinux/man3/pthread_setconcurrency.3 b/upstream/archlinux/man3/pthread_setconcurrency.3 index 5e39e8b9..d2a0aa1a 100644 --- a/upstream/archlinux/man3/pthread_setconcurrency.3 +++ b/upstream/archlinux/man3/pthread_setconcurrency.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_setconcurrency 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_setconcurrency 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_setconcurrency, pthread_getconcurrency \- set/get the concurrency level diff --git a/upstream/archlinux/man3/pthread_setname_np.3 b/upstream/archlinux/man3/pthread_setname_np.3 index fca43314..437496d6 100644 --- a/upstream/archlinux/man3/pthread_setname_np.3 +++ b/upstream/archlinux/man3/pthread_setname_np.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_setname_np 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_setname_np 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_setname_np, pthread_getname_np \- set/get the name of a thread .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_setschedparam.3 b/upstream/archlinux/man3/pthread_setschedparam.3 index 4c420d8c..c9273c14 100644 --- a/upstream/archlinux/man3/pthread_setschedparam.3 +++ b/upstream/archlinux/man3/pthread_setschedparam.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_setschedparam 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_setschedparam 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_setschedparam, pthread_getschedparam \- set/get scheduling policy and parameters of a thread diff --git a/upstream/archlinux/man3/pthread_setschedprio.3 b/upstream/archlinux/man3/pthread_setschedprio.3 index e70fb1d3..023b89a0 100644 --- a/upstream/archlinux/man3/pthread_setschedprio.3 +++ b/upstream/archlinux/man3/pthread_setschedprio.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_setschedprio 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_setschedprio 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_setschedprio \- set scheduling priority of a thread .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_sigmask.3 b/upstream/archlinux/man3/pthread_sigmask.3 index 343c2d33..6585a33e 100644 --- a/upstream/archlinux/man3/pthread_sigmask.3 +++ b/upstream/archlinux/man3/pthread_sigmask.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_sigmask 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_sigmask 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_sigmask \- examine and change mask of blocked signals .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_sigqueue.3 b/upstream/archlinux/man3/pthread_sigqueue.3 index 3fd51d1b..dcea60b7 100644 --- a/upstream/archlinux/man3/pthread_sigqueue.3 +++ b/upstream/archlinux/man3/pthread_sigqueue.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_sigqueue 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_sigqueue 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_sigqueue \- queue a signal and data to a thread .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_spin_init.3 b/upstream/archlinux/man3/pthread_spin_init.3 index b7676d76..a1650b4e 100644 --- a/upstream/archlinux/man3/pthread_spin_init.3 +++ b/upstream/archlinux/man3/pthread_spin_init.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_spin_init 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_spin_init 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_spin_init, pthread_spin_destroy \- initialize or destroy a spin lock .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_spin_lock.3 b/upstream/archlinux/man3/pthread_spin_lock.3 index 1717e939..b7ec0528 100644 --- a/upstream/archlinux/man3/pthread_spin_lock.3 +++ b/upstream/archlinux/man3/pthread_spin_lock.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_spin_lock 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_spin_lock 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_spin_lock, pthread_spin_trylock, pthread_spin_unlock \- lock and unlock a spin lock diff --git a/upstream/archlinux/man3/pthread_testcancel.3 b/upstream/archlinux/man3/pthread_testcancel.3 index d654aca6..a22d1b4c 100644 --- a/upstream/archlinux/man3/pthread_testcancel.3 +++ b/upstream/archlinux/man3/pthread_testcancel.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_testcancel 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_testcancel 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_testcancel \- request delivery of any pending cancelation request .SH LIBRARY diff --git a/upstream/archlinux/man3/pthread_tryjoin_np.3 b/upstream/archlinux/man3/pthread_tryjoin_np.3 index b2d60ab4..4dfacfc6 100644 --- a/upstream/archlinux/man3/pthread_tryjoin_np.3 +++ b/upstream/archlinux/man3/pthread_tryjoin_np.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_tryjoin_np 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_tryjoin_np 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_tryjoin_np, pthread_timedjoin_np \- try to join with a terminated thread diff --git a/upstream/archlinux/man3/pthread_yield.3 b/upstream/archlinux/man3/pthread_yield.3 index abbc4b2c..b86698cd 100644 --- a/upstream/archlinux/man3/pthread_yield.3 +++ b/upstream/archlinux/man3/pthread_yield.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH pthread_yield 3 2023-10-31 "Linux man-pages 6.06" +.TH pthread_yield 3 2024-05-02 "Linux man-pages 6.8" .SH NAME pthread_yield \- yield the processor .SH LIBRARY diff --git a/upstream/archlinux/man3/ptsname.3 b/upstream/archlinux/man3/ptsname.3 index 4a3a10a3..da73e1cd 100644 --- a/upstream/archlinux/man3/ptsname.3 +++ b/upstream/archlinux/man3/ptsname.3 @@ -5,7 +5,7 @@ .\" .\" 2004-12-17, mtk, added description of ptsname_r() + ERRORS .\" -.TH ptsname 3 2023-10-31 "Linux man-pages 6.06" +.TH ptsname 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ptsname, ptsname_r \- get the name of the slave pseudoterminal .SH LIBRARY diff --git a/upstream/archlinux/man3/putenv.3 b/upstream/archlinux/man3/putenv.3 index 30abe807..6311ae86 100644 --- a/upstream/archlinux/man3/putenv.3 +++ b/upstream/archlinux/man3/putenv.3 @@ -14,7 +14,7 @@ .\" Modified Mon Oct 11 11:11:11 1999 by Andries Brouwer (aeb@cwi.nl) .\" Modified Wed Nov 10 00:02:26 1999 by Andries Brouwer (aeb@cwi.nl) .\" Modified Sun May 20 22:17:20 2001 by Andries Brouwer (aeb@cwi.nl) -.TH putenv 3 2023-10-31 "Linux man-pages 6.06" +.TH putenv 3 2024-05-02 "Linux man-pages 6.8" .SH NAME putenv \- change or add an environment variable .SH LIBRARY diff --git a/upstream/archlinux/man3/putgrent.3 b/upstream/archlinux/man3/putgrent.3 index 85f78553..982929dc 100644 --- a/upstream/archlinux/man3/putgrent.3 +++ b/upstream/archlinux/man3/putgrent.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH putgrent 3 2023-10-31 "Linux man-pages 6.06" +.TH putgrent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME putgrent \- write a group database entry to a file .SH LIBRARY diff --git a/upstream/archlinux/man3/putpwent.3 b/upstream/archlinux/man3/putpwent.3 index dae023b9..5fbc8319 100644 --- a/upstream/archlinux/man3/putpwent.3 +++ b/upstream/archlinux/man3/putpwent.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 18:43:46 1993 by Rik Faith (faith@cs.unc.edu) -.TH putpwent 3 2023-10-31 "Linux man-pages 6.06" +.TH putpwent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME putpwent \- write a password file entry .SH LIBRARY diff --git a/upstream/archlinux/man3/puts.3 b/upstream/archlinux/man3/puts.3 index 33361bfd..0f783010 100644 --- a/upstream/archlinux/man3/puts.3 +++ b/upstream/archlinux/man3/puts.3 @@ -4,7 +4,7 @@ .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" Modified Sat Jul 24 18:42:59 1993 by Rik Faith (faith@cs.unc.edu) -.TH puts 3 2023-10-31 "Linux man-pages 6.06" +.TH puts 3 2024-05-02 "Linux man-pages 6.8" .SH NAME fputc, fputs, putc, putchar, puts \- output of characters and strings .SH LIBRARY diff --git a/upstream/archlinux/man3/putwchar.3 b/upstream/archlinux/man3/putwchar.3 index a98ca979..1e74bb17 100644 --- a/upstream/archlinux/man3/putwchar.3 +++ b/upstream/archlinux/man3/putwchar.3 @@ -10,7 +10,7 @@ .\" http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH putwchar 3 2023-10-31 "Linux man-pages 6.06" +.TH putwchar 3 2024-05-02 "Linux man-pages 6.8" .SH NAME putwchar \- write a wide character to standard output .SH LIBRARY diff --git a/upstream/archlinux/man3/qecvt.3 b/upstream/archlinux/man3/qecvt.3 index d6ae1e70..4e9184a0 100644 --- a/upstream/archlinux/man3/qecvt.3 +++ b/upstream/archlinux/man3/qecvt.3 @@ -6,7 +6,7 @@ .\" This replaces an earlier man page written by Walter Harms .\" <walter.harms@informatik.uni-oldenburg.de>. .\" -.TH qecvt 3 2023-10-31 "Linux man-pages 6.06" +.TH qecvt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME qecvt, qfcvt, qgcvt \- convert a floating-point number to a string .SH LIBRARY diff --git a/upstream/archlinux/man3/qsort.3 b/upstream/archlinux/man3/qsort.3 index 19e4e333..c1d998c6 100644 --- a/upstream/archlinux/man3/qsort.3 +++ b/upstream/archlinux/man3/qsort.3 @@ -15,7 +15,7 @@ .\" and Ben Bacarisse <software@bsb.me.uk> .\" Document qsort_r() .\" -.TH qsort 3 2023-10-31 "Linux man-pages 6.06" +.TH qsort 3 2024-05-02 "Linux man-pages 6.8" .SH NAME qsort, qsort_r \- sort an array .SH LIBRARY diff --git a/upstream/archlinux/man3/raise.3 b/upstream/archlinux/man3/raise.3 index 0a72a76c..417097d1 100644 --- a/upstream/archlinux/man3/raise.3 +++ b/upstream/archlinux/man3/raise.3 @@ -7,7 +7,7 @@ .\" Modified Sat Jul 24 18:40:56 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified 1995 by Mike Battersby (mib@deakin.edu.au) .\" -.TH raise 3 2023-10-31 "Linux man-pages 6.06" +.TH raise 3 2024-05-02 "Linux man-pages 6.8" .SH NAME raise \- send a signal to the caller .SH LIBRARY diff --git a/upstream/archlinux/man3/rand.3 b/upstream/archlinux/man3/rand.3 index 7b1242b6..6f81e2ea 100644 --- a/upstream/archlinux/man3/rand.3 +++ b/upstream/archlinux/man3/rand.3 @@ -19,7 +19,7 @@ .\" Modified 2003-11-15, aeb, added rand_r .\" 2010-09-13, mtk, added example program .\" -.TH rand 3 2023-10-31 "Linux man-pages 6.06" +.TH rand 3 2024-05-02 "Linux man-pages 6.8" .SH NAME rand, rand_r, srand \- pseudo-random number generator .SH LIBRARY diff --git a/upstream/archlinux/man3/random.3 b/upstream/archlinux/man3/random.3 index 0effb243..648b4501 100644 --- a/upstream/archlinux/man3/random.3 +++ b/upstream/archlinux/man3/random.3 @@ -11,7 +11,7 @@ .\" Modified Sat Jul 24 18:13:39 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Sun Aug 20 21:47:07 2000, aeb .\" -.TH random 3 2023-10-31 "Linux man-pages 6.06" +.TH random 3 2024-05-02 "Linux man-pages 6.8" .SH NAME random, srandom, initstate, setstate \- random number generator .SH LIBRARY diff --git a/upstream/archlinux/man3/random_r.3 b/upstream/archlinux/man3/random_r.3 index ec360248..b57473fb 100644 --- a/upstream/archlinux/man3/random_r.3 +++ b/upstream/archlinux/man3/random_r.3 @@ -4,7 +4,7 @@ .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" -.TH random_r 3 2023-10-31 "Linux man-pages 6.06" +.TH random_r 3 2024-05-02 "Linux man-pages 6.8" .SH NAME random_r, srandom_r, initstate_r, setstate_r \- reentrant random number generator diff --git a/upstream/archlinux/man3/rcmd.3 b/upstream/archlinux/man3/rcmd.3 index ddea6ae3..e1f27871 100644 --- a/upstream/archlinux/man3/rcmd.3 +++ b/upstream/archlinux/man3/rcmd.3 @@ -13,7 +13,7 @@ .\" .\" 2007-12-08, mtk, Converted from mdoc to man macros .\" -.TH rcmd 3 2023-10-31 "Linux man-pages 6.06" +.TH rcmd 3 2024-05-02 "Linux man-pages 6.8" .SH NAME rcmd, rresvport, iruserok, ruserok, rcmd_af, rresvport_af, iruserok_af, ruserok_af \- routines for returning a diff --git a/upstream/archlinux/man3/re_comp.3 b/upstream/archlinux/man3/re_comp.3 index c2d4024c..0922691c 100644 --- a/upstream/archlinux/man3/re_comp.3 +++ b/upstream/archlinux/man3/re_comp.3 @@ -5,7 +5,7 @@ .\" .\" Wed Jun 14 16:10:28 BST 1995 Wilf. (G.Wilford@@ee.surrey.ac.uk) .\" -.TH re_comp 3 2023-10-31 "Linux man-pages 6.06" +.TH re_comp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME re_comp, re_exec \- BSD regex functions .SH LIBRARY diff --git a/upstream/archlinux/man3/readdir.3 b/upstream/archlinux/man3/readdir.3 index c41afede..ac9cc2c9 100644 --- a/upstream/archlinux/man3/readdir.3 +++ b/upstream/archlinux/man3/readdir.3 @@ -14,7 +14,7 @@ .\" 2007-07-30 Ulrich Drepper <drepper@redhat.com>, mtk: .\" Rework discussion of nonstandard structure fields. .\" -.TH readdir 3 2023-10-31 "Linux man-pages 6.06" +.TH readdir 3 2024-05-02 "Linux man-pages 6.8" .SH NAME readdir \- read a directory .SH LIBRARY diff --git a/upstream/archlinux/man3/readdir_r.3 b/upstream/archlinux/man3/readdir_r.3 index 7eff5847..f4aab58f 100644 --- a/upstream/archlinux/man3/readdir_r.3 +++ b/upstream/archlinux/man3/readdir_r.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH readdir_r 3 2023-10-31 "Linux man-pages 6.06" +.TH readdir_r 3 2024-05-02 "Linux man-pages 6.8" .SH NAME readdir_r \- read a directory .SH LIBRARY diff --git a/upstream/archlinux/man3/realpath.3 b/upstream/archlinux/man3/realpath.3 index fa714077..0ad4f75a 100644 --- a/upstream/archlinux/man3/realpath.3 +++ b/upstream/archlinux/man3/realpath.3 @@ -6,7 +6,7 @@ .\" Rewritten old page, 990824, aeb@cwi.nl .\" 2004-12-14, mtk, added discussion of resolved_path == NULL .\" -.TH realpath 3 2023-10-31 "Linux man-pages 6.06" +.TH realpath 3 2024-05-02 "Linux man-pages 6.8" .SH NAME realpath \- return the canonicalized absolute pathname .SH LIBRARY diff --git a/upstream/archlinux/man3/recno.3 b/upstream/archlinux/man3/recno.3 index 81d39d7a..c0b23f9d 100644 --- a/upstream/archlinux/man3/recno.3 +++ b/upstream/archlinux/man3/recno.3 @@ -5,7 +5,7 @@ .\" .\" @(#)recno.3 8.5 (Berkeley) 8/18/94 .\" -.TH recno 3 2023-10-31 "Linux man-pages 6.06" +.TH recno 3 2024-05-02 "Linux man-pages 6.8" .UC 7 .SH NAME recno \- record number database access method diff --git a/upstream/archlinux/man3/regex.3 b/upstream/archlinux/man3/regex.3 index be71ab02..ca759ada 100644 --- a/upstream/archlinux/man3/regex.3 +++ b/upstream/archlinux/man3/regex.3 @@ -10,7 +10,7 @@ .\" Modified 8 May 1998 by Joseph S. Myers (jsm28@cam.ac.uk) .\" .\" show the synopsis section nicely -.TH regex 3 2023-10-31 "Linux man-pages 6.06" +.TH regex 3 2024-05-02 "Linux man-pages 6.8" .SH NAME regcomp, regexec, regerror, regfree \- POSIX regex functions .SH LIBRARY diff --git a/upstream/archlinux/man3/remainder.3 b/upstream/archlinux/man3/remainder.3 index 07d697e7..3bc1bba0 100644 --- a/upstream/archlinux/man3/remainder.3 +++ b/upstream/archlinux/man3/remainder.3 @@ -15,7 +15,7 @@ .\" (walter.harms@informatik.uni-oldenburg.de) .\" Modified 2003-11-18, 2004-10-05 aeb .\" -.TH remainder 3 2023-10-31 "Linux man-pages 6.06" +.TH remainder 3 2024-05-02 "Linux man-pages 6.8" .SH NAME drem, dremf, dreml, remainder, remainderf, remainderl \- \ floating-point remainder function diff --git a/upstream/archlinux/man3/remove.3 b/upstream/archlinux/man3/remove.3 index 0dfa4d36..78b30c52 100644 --- a/upstream/archlinux/man3/remove.3 +++ b/upstream/archlinux/man3/remove.3 @@ -9,7 +9,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH remove 3 2023-10-31 "Linux man-pages 6.06" +.TH remove 3 2024-05-02 "Linux man-pages 6.8" .SH NAME remove \- remove a file or directory .SH LIBRARY diff --git a/upstream/archlinux/man3/remquo.3 b/upstream/archlinux/man3/remquo.3 index 0424af68..e2ec6035 100644 --- a/upstream/archlinux/man3/remquo.3 +++ b/upstream/archlinux/man3/remquo.3 @@ -8,7 +8,7 @@ .\" based on glibc infopages .\" polished, aeb .\" -.TH remquo 3 2023-10-31 "Linux man-pages 6.06" +.TH remquo 3 2024-05-02 "Linux man-pages 6.8" .SH NAME remquo, remquof, remquol \- remainder and part of quotient .SH LIBRARY diff --git a/upstream/archlinux/man3/resizeterm.3x b/upstream/archlinux/man3/resizeterm.3x index 37094d80..7dde0d6f 100644 --- a/upstream/archlinux/man3/resizeterm.3x +++ b/upstream/archlinux/man3/resizeterm.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -29,96 +29,95 @@ .\" .\" Author: Thomas E. Dickey 1996-on .\" -.\" $Id: resizeterm.3x,v 1.32 2022/02/20 00:32:18 tom Exp $ -.TH resizeterm 3X "" +.\" $Id: resizeterm.3x,v 1.56 2024/03/16 15:35:01 tom Exp $ +.TH resizeterm 3X 2024-03-16 "ncurses 6.5" "Library calls" .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .SH NAME -\fBis_term_resized\fP, -\fBresize_term\fP, -\fBresizeterm\fP \- change the curses terminal size +\fB\%is_term_resized\fP, +\fB\%resize_term\fP, +\fB\%resizeterm\fP \- +manage the terminal dimensions understood by \fIcurses\fR .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBbool is_term_resized(int \fIlines\fB, int \fIcolumns\fB);\fR -.br -\fBint resize_term(int \fIlines\fB, int \fIcolumns\fB);\fR -.br -\fBint resizeterm(int \fIlines\fB, int \fIcolumns\fB);\fR -.SH DESCRIPTION +.nf +\fB#include <curses.h> .PP -This is an extension to the curses library. -It provides callers with a hook into the \fBncurses\fP data to resize windows, +\fBbool is_term_resized(int \fIlines\fP, int \fIcolumns\fP); +\fBint resize_term(int \fIlines\fP, int \fIcolumns\fP); +\fBint resizeterm(int \fIlines\fP, int \fIcolumns\fP); +.fi +.SH DESCRIPTION +This is an extension to the \fIcurses\fP library. +It provides callers with a hook into the \fI\%ncurses\fP data to resize +windows, primarily for use by programs running in an X Window terminal (e.g., xterm) when the terminal's screen size is changed by the user: .bP -Curses windows cannot extend outside the screen. -If the terminal is shrunk, curses windows must be shrunk to fit. +\fIcurses\fP windows cannot extend outside the screen. +If the terminal is shrunk, \fIcurses\fP windows must be shrunk to fit. .bP If the terminal is stretched, rows and/or columns can be added to existing windows. The added cells should match the current attributes of the windows. .PP -If the calling program has not set up a handler for \fBSIGWINCH\fP -when it initializes \fBncurses\fP -(e.g., using \fBinitscr\fP(3X) or \fBnewterm\fP(3X)), -then \fBncurses\fP sets a handler for \fBSIGWINCH\fP which notifies +If the calling program has not set up a handler for \fB\%SIGWINCH\fP +when it initializes \fI\%ncurses\fP +(e.g., using \fB\%initscr\fP(3X) or \fB\%newterm\fP(3X)), +then \fI\%ncurses\fP sets a handler for \fB\%SIGWINCH\fP which notifies the library when a window-size event has occurred. The library checks for this notification .bP when reading input data, .bP when implicitly resuming program mode -(e.g., between \fBendwin\fP(3X) and \fBwrefresh\fP(3X)), +(e.g., between \fB\%endwin\fP(3X) and \fB\%wrefresh\fP(3X)), and .bP -when explicitly resuming program mode in \fBrestartterm\fP(3X). +when explicitly resuming program mode in \fB\%restartterm\fP(3X). .PP When the library has found that the terminal's window-size has -changed, it calls \fBresizeterm\fP to update its data structures. +changed, it calls \fB\%resizeterm\fP to update its data structures. .PP -An application which establishes its own \fBSIGWINCH\fP handler -can call \fBresizeterm\fP, but in that case, the library will not -see \fBSIGWINCH\fP, and proper layout will rely upon the application. +An application which establishes its own \fB\%SIGWINCH\fP handler +can call \fB\%resizeterm\fP, but in that case, the library will not +see \fB\%SIGWINCH\fP, and proper layout will rely upon the application. .SH FUNCTIONS .SS resizeterm -.PP -The function \fBresizeterm\fP resizes the standard and current windows -(i.e., \fBstdscr\fP and \fBcurscr\fP) +The function \fB\%resizeterm\fP resizes the standard and current windows +(i.e., \fB\%stdscr\fP and \fB\%curscr\fP) to the specified dimensions, and adjusts other bookkeeping data used by -the \fBncurses\fP library that record the window dimensions -such as the \fBLINES\fP and \fBCOLS\fP variables. +the \fI\%ncurses\fP library that record the window dimensions +such as the \fB\%LINES\fP and \fB\%COLS\fP variables. .SS resize_term +Most of the work for \fB\%resizeterm\fP is +done by the inner function \fB\%resize_term\fP. +The outer function \fB\%resizeterm\fP adds bookkeeping +for the \fB\%SIGWINCH\fP handler, +as well as repainting the soft-key area (see \fB\%slk_touch\fP(3X)). .PP -Most of the work for \fBresizeterm\fP is -done by the inner function \fBresize_term\fP. -The outer function \fBresizeterm\fP adds bookkeeping -for the \fBSIGWINCH\fP handler, -as well as repainting the soft-key area (see \fBslk_touch\fP(3X)). -.PP -The \fBresize_term\fP function attempts to resize all windows. +The \fB\%resize_term\fP function attempts to resize all windows. This helps with simple applications. However: .bP It is not possible to automatically resize pads. .bP Applications which have complicated layouts should check for -\fBKEY_RESIZE\fP returned from \fBwgetch\fP, -and adjust their layout, e.g., using \fBwresize\fP and \fBmvwin\fP, +\fB\%KEY_RESIZE\fP returned from \fB\%wgetch\fP, +and adjust their layout, e.g., using \fB\%wresize\fP and \fB\%mvwin\fP, or by recreating the windows. .PP -When resizing windows, \fBresize_term\fP recursively adjusts subwindows, +When resizing windows, \fB\%resize_term\fP recursively adjusts subwindows, keeping them within the updated parent window's limits. If a top-level window happens to extend to the screen's limits, -then on resizing the window, \fBresize_term\fP will keep the window +then on resizing the window, \fB\%resize_term\fP will keep the window extending to the corresponding limit, regardless of whether the screen has shrunk or grown. .SS is_term_resized -.PP -A support function \fBis_term_resized\fP is provided so that applications -can check if the \fBresize_term\fP function would modify the window structures. +A support function \fB\%is_term_resized\fP is provided so that applications +can check if the \fB\%resize_term\fP function would modify +the window structures. It returns \fBTRUE\fP if the windows would be modified, and \fBFALSE\fP otherwise. .SH RETURN VALUE @@ -128,54 +127,54 @@ They will fail if either of the dimensions are less than or equal to zero, or if an error occurs while (re)allocating memory for the windows. .SH NOTES While these functions are intended to be used to support a signal handler -(i.e., for \fBSIGWINCH\fP), care should be taken to avoid invoking them in a -context where \fBmalloc\fP or \fBrealloc\fP may have been interrupted, +(i.e., for \fB\%SIGWINCH\fP), care should be taken to avoid invoking them in a +context where \fB\%malloc\fP or \fB\%realloc\fP may have been interrupted, since it uses those functions. .PP -If ncurses is configured to supply its own \fBSIGWINCH\fP handler, +If \fI\%ncurses\fP is configured to supply its own \fB\%SIGWINCH\fP +handler, .bP -on receipt of a \fBSIGWINCH\fP, the handler sets a flag +on receipt of a \fB\%SIGWINCH\fP, the handler sets a flag .bP which is tested in -\fBwgetch\fP(3X), -\fBdoupdate\fP(3X) and -\fBrestartterm\fP(3X), +\fB\%wgetch\fP(3X), +\fB\%doupdate\fP(3X) and +\fB\%restartterm\fP(3X), .bP -in turn, calling the \fBresizeterm\fP function, +in turn, calling the \fB\%resizeterm\fP function, .bP -which \fBungetch\fP's a \fBKEY_RESIZE\fP which -will be read on the next call to \fBwgetch\fP. +which \fB\%ungetch\fP's a \fB\%KEY_RESIZE\fP which +will be read on the next call to \fB\%wgetch\fP. .IP -The \fBKEY_RESIZE\fP alerts an application that the screen size has changed, +The \fB\%KEY_RESIZE\fP alerts an application that the screen size has changed, and that it should repaint special features such as pads that cannot be done automatically. .IP -Calling \fBresizeterm\fP or \fBresize_term\fP +Calling \fB\%resizeterm\fP or \fB\%resize_term\fP directly from a signal handler is unsafe. -This indirect method is used to provide a safe way to resize the ncurses -data structures. +This indirect method is used to provide a safe way to resize the +\fI\%ncurses\fP data structures. .PP -If the environment variables \fBLINES\fP or \fBCOLUMNS\fP are set, +If the environment variables \fILINES\fP or \fI\%COLUMNS\fP are set, this overrides the library's use of the window size obtained from the operating system. -Thus, even if a \fBSIGWINCH\fP is received, +Thus, even if a \fB\%SIGWINCH\fP is received, no screen size change may be recorded. .SH PORTABILITY -.PP -It is possible to resize the screen with SVr4 curses, +It is possible to resize the screen with SVr4 \fIcurses\fP, by .bP -exiting curses with \fBendwin\fP(3X) and +exiting \fIcurses\fP with \fB\%endwin\fP(3X) and .bP -resuming using \fBrefresh\fP(3X). +resuming using \fB\%refresh\fP(3X). .PP Doing that clears the screen and is visually distracting. .PP -This extension of ncurses was introduced in mid-1995. -It was adopted in NetBSD curses (2001) and PDCurses (2003). +This extension of \fI\%ncurses\fP was introduced in mid-1995. +It was adopted in NetBSD \fIcurses\fP (2001) and PDCurses (2003). +.SH AUTHORS +Thomas Dickey (from an equivalent function written in 1988 for BSD \fIcurses\fP) .SH SEE ALSO -\fBcurs_getch\fP(3X), -\fBcurs_variables\fP(3X), -\fBwresize\fP(3X). -.SH AUTHOR -Thomas Dickey (from an equivalent function written in 1988 for BSD curses). +\fB\%curs_getch\fP(3X), +\fB\%curs_variables\fP(3X), +\fB\%wresize\fP(3X) diff --git a/upstream/archlinux/man3/resolver.3 b/upstream/archlinux/man3/resolver.3 index 4759d97c..0d5c1edb 100644 --- a/upstream/archlinux/man3/resolver.3 +++ b/upstream/archlinux/man3/resolver.3 @@ -11,7 +11,7 @@ .\" Modified 1993-07-25 by Rik Faith (faith@cs.unc.edu) .\" Modified 2004-10-31 by aeb .\" -.TH resolver 3 2023-10-31 "Linux man-pages 6.06" +.TH resolver 3 2024-05-02 "Linux man-pages 6.8" .SH NAME res_ninit, res_nquery, res_nsearch, res_nquerydomain, res_nmkquery, res_nsend, res_nclose, diff --git a/upstream/archlinux/man3/rewinddir.3 b/upstream/archlinux/man3/rewinddir.3 index e14a7b54..fcc30027 100644 --- a/upstream/archlinux/man3/rewinddir.3 +++ b/upstream/archlinux/man3/rewinddir.3 @@ -9,7 +9,7 @@ .\" 386BSD man pages .\" Modified Sat Jul 24 18:29:11 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified 11 June 1995 by Andries Brouwer (aeb@cwi.nl) -.TH rewinddir 3 2023-10-31 "Linux man-pages 6.06" +.TH rewinddir 3 2024-05-02 "Linux man-pages 6.8" .SH NAME rewinddir \- reset directory stream .SH LIBRARY diff --git a/upstream/archlinux/man3/rexec.3 b/upstream/archlinux/man3/rexec.3 index 238de2bc..11395377 100644 --- a/upstream/archlinux/man3/rexec.3 +++ b/upstream/archlinux/man3/rexec.3 @@ -11,7 +11,7 @@ .\" .\" 2013-06-21, mtk, Converted from mdoc to man macros .\" -.TH rexec 3 2023-10-31 "Linux man-pages 6.06" +.TH rexec 3 2024-05-02 "Linux man-pages 6.8" .SH NAME rexec, rexec_af \- return stream to a remote command .SH LIBRARY diff --git a/upstream/archlinux/man3/rint.3 b/upstream/archlinux/man3/rint.3 index cfb60ccd..645f95cd 100644 --- a/upstream/archlinux/man3/rint.3 +++ b/upstream/archlinux/man3/rint.3 @@ -5,7 +5,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH rint 3 2023-10-31 "Linux man-pages 6.06" +.TH rint 3 2024-05-02 "Linux man-pages 6.8" .SH NAME nearbyint, nearbyintf, nearbyintl, rint, rintf, rintl \- round to nearest integer diff --git a/upstream/archlinux/man3/round.3 b/upstream/archlinux/man3/round.3 index a96e9420..6d9934de 100644 --- a/upstream/archlinux/man3/round.3 +++ b/upstream/archlinux/man3/round.3 @@ -5,7 +5,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH round 3 2023-10-31 "Linux man-pages 6.06" +.TH round 3 2024-05-02 "Linux man-pages 6.8" .SH NAME round, roundf, roundl \- round to nearest integer, away from zero .SH LIBRARY diff --git a/upstream/archlinux/man3/roundup.3 b/upstream/archlinux/man3/roundup.3 index d7f69796..4021e31e 100644 --- a/upstream/archlinux/man3/roundup.3 +++ b/upstream/archlinux/man3/roundup.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH roundup 3 2023-10-31 "Linux man-pages 6.06" +.TH roundup 3 2024-05-02 "Linux man-pages 6.8" .SH NAME roundup \- round up in steps .SH LIBRARY diff --git a/upstream/archlinux/man3/rpc.3 b/upstream/archlinux/man3/rpc.3 index 1359bb8a..9b7d34bf 100644 --- a/upstream/archlinux/man3/rpc.3 +++ b/upstream/archlinux/man3/rpc.3 @@ -9,7 +9,7 @@ .\" .\" 2007-12-30, mtk, Convert function prototypes to modern C syntax .\" -.TH rpc 3 2023-10-31 "Linux man-pages 6.06" +.TH rpc 3 2024-05-02 "Linux man-pages 6.8" .SH NAME rpc \- library routines for remote procedure calls .SH LIBRARY diff --git a/upstream/archlinux/man3/rpmatch.3 b/upstream/archlinux/man3/rpmatch.3 index d2958a57..d884f313 100644 --- a/upstream/archlinux/man3/rpmatch.3 +++ b/upstream/archlinux/man3/rpmatch.3 @@ -27,7 +27,7 @@ .\" .\" 2006-05-19, mtk, various edits and example program .\" -.TH rpmatch 3 2023-10-31 "Linux man-pages 6.06" +.TH rpmatch 3 2024-05-02 "Linux man-pages 6.8" .SH NAME rpmatch \- determine if the answer to a question is affirmative or negative .SH LIBRARY diff --git a/upstream/archlinux/man3/rtime.3 b/upstream/archlinux/man3/rtime.3 index 7b6b9ca1..fe541e78 100644 --- a/upstream/archlinux/man3/rtime.3 +++ b/upstream/archlinux/man3/rtime.3 @@ -8,7 +8,7 @@ .\" .\" Slightly polished, aeb, 2003-04-06 .\" -.TH rtime 3 2023-10-31 "Linux man-pages 6.06" +.TH rtime 3 2024-05-02 "Linux man-pages 6.8" .SH NAME rtime \- get time from a remote machine .SH LIBRARY diff --git a/upstream/archlinux/man3/rtnetlink.3 b/upstream/archlinux/man3/rtnetlink.3 index 94a9a910..a0281539 100644 --- a/upstream/archlinux/man3/rtnetlink.3 +++ b/upstream/archlinux/man3/rtnetlink.3 @@ -4,7 +4,7 @@ .\" .\" $Id: rtnetlink.3,v 1.2 1999/05/18 10:35:10 freitag Exp $ .\" -.TH rtnetlink 3 2023-10-31 "Linux man-pages 6.06" +.TH rtnetlink 3 2024-05-02 "Linux man-pages 6.8" .SH NAME rtnetlink \- macros to manipulate rtnetlink messages .SH LIBRARY diff --git a/upstream/archlinux/man3/s2i_ASN1_IA5STRING.3ssl b/upstream/archlinux/man3/s2i_ASN1_IA5STRING.3ssl index c0d1809f..7b13ae12 100644 --- a/upstream/archlinux/man3/s2i_ASN1_IA5STRING.3ssl +++ b/upstream/archlinux/man3/s2i_ASN1_IA5STRING.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "S2I_ASN1_IA5STRING 3ssl" -.TH S2I_ASN1_IA5STRING 3ssl 2024-01-30 3.2.1 OpenSSL +.TH S2I_ASN1_IA5STRING 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/upstream/archlinux/man3/scalb.3 b/upstream/archlinux/man3/scalb.3 index 88cd14b4..5163b6e9 100644 --- a/upstream/archlinux/man3/scalb.3 +++ b/upstream/archlinux/man3/scalb.3 @@ -5,7 +5,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH scalb 3 2023-10-31 "Linux man-pages 6.06" +.TH scalb 3 2024-05-02 "Linux man-pages 6.8" .SH NAME scalb, scalbf, scalbl \- multiply floating-point number by integral power of radix (OBSOLETE) diff --git a/upstream/archlinux/man3/scalbln.3 b/upstream/archlinux/man3/scalbln.3 index 043b7f67..621e0b58 100644 --- a/upstream/archlinux/man3/scalbln.3 +++ b/upstream/archlinux/man3/scalbln.3 @@ -5,7 +5,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH scalbln 3 2023-10-31 "Linux man-pages 6.06" +.TH scalbln 3 2024-05-02 "Linux man-pages 6.8" .SH NAME scalbn, scalbnf, scalbnl, scalbln, scalblnf, scalblnl \- multiply floating-point number by integral power of radix diff --git a/upstream/archlinux/man3/scandir.3 b/upstream/archlinux/man3/scandir.3 index 1f3ec156..fbc41fee 100644 --- a/upstream/archlinux/man3/scandir.3 +++ b/upstream/archlinux/man3/scandir.3 @@ -21,7 +21,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH scandir 3 2023-10-31 "Linux man-pages 6.06" +.TH scandir 3 2024-05-02 "Linux man-pages 6.8" .SH NAME scandir, scandirat, alphasort, versionsort \- scan a directory for matching entries diff --git a/upstream/archlinux/man3/scanf.3 b/upstream/archlinux/man3/scanf.3 index 17a7db08..a875beb7 100644 --- a/upstream/archlinux/man3/scanf.3 +++ b/upstream/archlinux/man3/scanf.3 @@ -2,7 +2,7 @@ .\" Copyright 2022 Alejandro Colomar <alx@kernel.org> .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH scanf 3 2023-12-09 "Linux man-pages 6.06" +.TH scanf 3 2024-05-02 "Linux man-pages 6.8" .SH NAME scanf, fscanf, vscanf, vfscanf \- input FILE format conversion .SH LIBRARY diff --git a/upstream/archlinux/man3/sched_getcpu.3 b/upstream/archlinux/man3/sched_getcpu.3 index 36f4546c..0e962b3f 100644 --- a/upstream/archlinux/man3/sched_getcpu.3 +++ b/upstream/archlinux/man3/sched_getcpu.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sched_getcpu 3 2024-01-01 "Linux man-pages 6.06" +.TH sched_getcpu 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sched_getcpu \- determine CPU on which the calling thread is running .SH LIBRARY diff --git a/upstream/archlinux/man3/sd_bus_error.3 b/upstream/archlinux/man3/sd_bus_error.3 index dba26b16..5be72f31 100644 --- a/upstream/archlinux/man3/sd_bus_error.3 +++ b/upstream/archlinux/man3/sd_bus_error.3 @@ -437,7 +437,7 @@ or unset\&. D\-Bus errors are converted to the integral #include <errno\&.h> #include <string\&.h> #include <unistd\&.h> -#include <sd\-bus\&.h> +#include <systemd/sd\-bus\&.h> int writer_with_negative_errno_return(int fd, sd_bus_error *error) { const char *message = "Hello, World!\en"; diff --git a/upstream/archlinux/man3/sd_event_add_child.3 b/upstream/archlinux/man3/sd_event_add_child.3 index 736efa60..ecb70c6c 100644 --- a/upstream/archlinux/man3/sd_event_add_child.3 +++ b/upstream/archlinux/man3/sd_event_add_child.3 @@ -268,7 +268,7 @@ from an early phase of the program when no other threads have been started\&. #include <assert\&.h> #include <stdio\&.h> #include <unistd\&.h> -#include <sd\-event\&.h> +#include <systemd/sd\-event\&.h> int main(int argc, char **argv) { pid_t pid = fork(); diff --git a/upstream/archlinux/man3/sd_event_add_io.3 b/upstream/archlinux/man3/sd_event_add_io.3 index 4cf99760..dc8d2a73 100644 --- a/upstream/archlinux/man3/sd_event_add_io.3 +++ b/upstream/archlinux/man3/sd_event_add_io.3 @@ -169,10 +169,13 @@ retrieves the UNIX file descriptor of an event source created previously with .PP \fBsd_event_source_set_io_fd()\fR changes the UNIX file descriptor of an I/O event source created previously with -\fBsd_event_add_io()\fR\&. It takes the event source object and the new file descriptor\&. +\fBsd_event_add_io()\fR\&. It takes the event source object and the new file descriptor\&. If the event source takes the ownership of the previous file descriptor, that is, +\fBsd_event_source_set_io_fd_own()\fR +was called for the event source with a non\-zero value, then the previous file descriptor will be closed and the event source will also take the ownership of the new file descriptor on success\&. .PP \fBsd_event_source_set_io_fd_own()\fR -controls whether the file descriptor of the event source shall be closed automatically when the event source is freed, i\&.e\&. whether it shall be considered \*(Aqowned\*(Aq by the event source object\&. By default it is not closed automatically, and the application has to do this on its own\&. The +controls whether the file descriptor of the event source shall be closed automatically when the event source is freed (or when the file descriptor assigned to the event source is replaced by +\fBsd_event_source_set_io_fd()\fR), i\&.e\&. whether it shall be considered \*(Aqowned\*(Aq by the event source object\&. By default it is not closed automatically, and the application has to do this on its own\&. The \fIb\fR parameter is a boolean parameter: if zero, the file descriptor is not closed automatically when the event source is freed, otherwise it is closed\&. .PP diff --git a/upstream/archlinux/man3/sd_hwdb_get.3 b/upstream/archlinux/man3/sd_hwdb_get.3 index 2a6d51ee..5444f6bd 100644 --- a/upstream/archlinux/man3/sd_hwdb_get.3 +++ b/upstream/archlinux/man3/sd_hwdb_get.3 @@ -142,16 +142,16 @@ from an early phase of the program when no other threads have been started\&. #include <stdio\&.h> #include <stdint\&.h> -#include <sd\-hwdb\&.h> +#include <systemd/sd\-hwdb\&.h> int print_usb_properties(uint16_t vid, uint16_t pid) { - char match[STRLEN("usb:vp") + DECIMAL_STR_MAX(uint16_t) * 2]; + char match[128]; sd_hwdb *hwdb; const char *key, *value; int r; /* Match this USB vendor and product ID combination */ - xsprintf(match, "usb:v%04Xp%04X", vid, pid); + snprintf(match, sizeof match, "usb:v%04Xp%04X", vid, pid); r = sd_hwdb_new(&hwdb); if (r < 0) diff --git a/upstream/archlinux/man3/sd_journal_get_cursor.3 b/upstream/archlinux/man3/sd_journal_get_cursor.3 index 82d21b07..80eec75f 100644 --- a/upstream/archlinux/man3/sd_journal_get_cursor.3 +++ b/upstream/archlinux/man3/sd_journal_get_cursor.3 @@ -41,16 +41,17 @@ returns a cursor string for the current journal entry\&. A cursor is a serializa and should be freed after use with \fBfree\fR(3)\&. .PP +\fBsd_journal_test_cursor()\fR +may be used to check whether the current position in the journal matches the specified cursor\&. This is useful since cursor strings do not uniquely identify an entry: the same entry might be referred to by multiple different cursor strings, and hence string comparing cursors is not possible\&. Use this call to verify after an invocation of +\fBsd_journal_seek_cursor\fR(3), whether the entry being sought to was actually found in the journal or the next closest entry was used instead\&. +.PP Note that \fBsd_journal_get_cursor()\fR +and +\fBsd_journal_test_cursor()\fR will not work before \fBsd_journal_next\fR(3) -(or related call) has been called at least once, in order to position the read pointer at a valid entry\&. -.PP -\fBsd_journal_test_cursor()\fR -may be used to check whether the current position in the journal matches the specified cursor\&. This is useful since cursor strings do not uniquely identify an entry: the same entry might be referred to by multiple different cursor strings, and hence string comparing cursors is not possible\&. Use this call to verify after an invocation of -\fBsd_journal_seek_cursor\fR(3) -whether the entry being sought to was actually found in the journal or the next closest entry was used instead\&. +(or one of the other functions which move to an entry) has been called at least once to position the read pointer at a valid entry\&. .SH "RETURN VALUE" .PP \fBsd_journal_get_cursor()\fR diff --git a/upstream/archlinux/man3/sd_journal_seek_head.3 b/upstream/archlinux/man3/sd_journal_seek_head.3 index 08c83b87..90958be7 100644 --- a/upstream/archlinux/man3/sd_journal_seek_head.3 +++ b/upstream/archlinux/man3/sd_journal_seek_head.3 @@ -57,8 +57,7 @@ seeks to a position with the specified realtime (wallclock) timestamp, i\&.e\&. .PP \fBsd_journal_seek_cursor()\fR seeks to the position at the specified cursor string\&. For details on cursors, see -\fBsd_journal_get_cursor\fR(3)\&. If no entry matching the specified cursor is found the call will seek to the next closest entry (in terms of time) instead\&. To verify whether the newly selected entry actually matches the cursor, use -\fBsd_journal_test_cursor\fR(3)\&. +\fBsd_journal_get_cursor\fR(3)\&. If no entry matching the specified cursor is found the call will seek to the next closest entry (in terms of time) instead\&. .PP Note that these calls do not actually make any entry the new current entry, this needs to be done in a separate step with a subsequent \fBsd_journal_next\fR(3) @@ -70,6 +69,12 @@ or an entry cursor be retrieved via is used, the closest following entry will be sought to, if \fBsd_journal_previous\fR(3) is used the closest preceding entry is sought to\&. +.PP +After the seek is done, and +\fBsd_journal_next\fR(3) +or a similar call has been made, +\fBsd_journal_test_cursor\fR(3) +may be used to verify whether the newly selected entry actually matches the cursor\&. .SH "RETURN VALUE" .PP The functions return 0 on success or a negative errno\-style error code\&. diff --git a/upstream/archlinux/man3/sd_notify.3 b/upstream/archlinux/man3/sd_notify.3 index 204db883..48274b00 100644 --- a/upstream/archlinux/man3/sd_notify.3 +++ b/upstream/archlinux/man3/sd_notify.3 @@ -425,6 +425,190 @@ over will be used instead\&. The address should be in the form: "vsock:CID:PORT"\&. Note that unlike other uses of vsock, the CID is mandatory and cannot be "VMADDR_CID_ANY"\&. Note that PID1 will send the VSOCK packets from a privileged port (i\&.e\&.: lower than 1024), as an attempt to address concerns that unprivileged processes in the guest might try to send malicious notifications to the host, driving it to make destructive decisions based on them\&. +.PP +Note that, while using this library should be preferred in order to avoid code duplication, it is also possible to reimplement the simple readiness notification protocol without external dependencies, as demonstrated in the following self\-contained example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +/* SPDX\-License\-Identifier: MIT\-0 */ + +/* Implement the systemd notify protocol without external dependencies\&. + * Supports both readiness notification on startup and on reloading, + * according to the protocol defined at: + * https://www\&.freedesktop\&.org/software/systemd/man/latest/sd_notify\&.html + * This protocol is guaranteed to be stable as per: + * https://systemd\&.io/PORTABILITY_AND_STABILITY/ */ + +#include <errno\&.h> +#include <inttypes\&.h> +#include <signal\&.h> +#include <stdbool\&.h> +#include <stddef\&.h> +#include <stdlib\&.h> +#include <stdio\&.h> +#include <sys/socket\&.h> +#include <sys/un\&.h> +#include <time\&.h> +#include <unistd\&.h> + +#define _cleanup_(f) __attribute__((cleanup(f))) + +static void closep(int *fd) { + if (!fd || *fd < 0) + return; + + close(*fd); + *fd = \-1; +} + +static int notify(const char *message) { + union sockaddr_union { + struct sockaddr sa; + struct sockaddr_un sun; + } socket_addr = { + \&.sun\&.sun_family = AF_UNIX, + }; + size_t path_length, message_length; + _cleanup_(closep) int fd = \-1; + const char *socket_path; + + socket_path = getenv("NOTIFY_SOCKET"); + if (!socket_path) + return 0; /* Not running under systemd? Nothing to do */ + + if (!message) + return \-EINVAL; + + message_length = strlen(message); + if (message_length == 0) + return \-EINVAL; + + /* Only AF_UNIX is supported, with path or abstract sockets */ + if (socket_path[0] != \*(Aq/\*(Aq && socket_path[0] != \*(Aq@\*(Aq) + return \-EAFNOSUPPORT; + + path_length = strlen(socket_path); + /* Ensure there is room for NUL byte */ + if (path_length >= sizeof(socket_addr\&.sun\&.sun_path)) + return \-E2BIG; + + memcpy(socket_addr\&.sun\&.sun_path, socket_path, path_length); + + /* Support for abstract socket */ + if (socket_addr\&.sun\&.sun_path[0] == \*(Aq@\*(Aq) + socket_addr\&.sun\&.sun_path[0] = 0; + + fd = socket(AF_UNIX, SOCK_DGRAM|SOCK_CLOEXEC, 0); + if (fd < 0) + return \-errno; + + if (connect(fd, &socket_addr\&.sa, offsetof(struct sockaddr_un, sun_path) + path_length) != 0) + return \-errno; + + ssize_t written = write(fd, message, message_length); + if (written != (ssize_t) message_length) + return written < 0 ? \-errno : \-EPROTO; + + return 1; /* Notified! */ +} + +static int notify_ready(void) { + return notify("READY=1"); +} + +static int notify_reloading(void) { + /* A buffer with length sufficient to format the maximum UINT64 value\&. */ + char reload_message[sizeof("RELOADING=1\enMONOTONIC_USEC=18446744073709551615")]; + struct timespec ts; + uint64_t now; + + /* Notify systemd that we are reloading, including a CLOCK_MONOTONIC timestamp in usec + * so that the program is compatible with a Type=notify\-reload service\&. */ + + if (clock_gettime(CLOCK_MONOTONIC, &ts) < 0) + return \-errno; + + if (ts\&.tv_sec < 0 || ts\&.tv_nsec < 0 || + (uint64_t) ts\&.tv_sec > (UINT64_MAX \- (ts\&.tv_nsec / 1000ULL)) / 1000000ULL) + return \-EINVAL; + + now = (uint64_t) ts\&.tv_sec * 1000000ULL + (uint64_t) ts\&.tv_nsec / 1000ULL; + + if (snprintf(reload_message, sizeof(reload_message), "RELOADING=1\enMONOTONIC_USEC=%" PRIu64, now) < 0) + return \-EINVAL; + + return notify(reload_message); +} + +static volatile sig_atomic_t reloading = 0; +static volatile sig_atomic_t terminating = 0; + +static void signal_handler(int sig) { + if (sig == SIGHUP) + reloading = 1; + else if (sig == SIGINT || sig == SIGTERM) + terminating = 1; +} + +int main(int argc, char **argv) { + struct sigaction sa = { + \&.sa_handler = signal_handler, + \&.sa_flags = SA_RESTART, + }; + int r; + + /* Setup signal handlers */ + sigemptyset(&sa\&.sa_mask); + sigaction(SIGHUP, &sa, NULL); + sigaction(SIGINT, &sa, NULL); + sigaction(SIGTERM, &sa, NULL); + + /* Do more service initialization work here \&... */ + + /* Now that all the preparations steps are done, signal readiness */ + + r = notify_ready(); + if (r < 0) { + fprintf(stderr, "Failed to notify readiness to $NOTIFY_SOCKET: %s\en", strerror(\-r)); + return EXIT_FAILURE; + } + + while (!terminating) { + if (reloading) { + reloading = false; + + /* As a separate but related feature, we can also notify the manager + * when reloading configuration\&. This allows accurate state\-tracking, + * and also automated hook\-in of \*(Aqsystemctl reload\*(Aq without having to + * specify manually an ExecReload= line in the unit file\&. */ + + r = notify_reloading(); + if (r < 0) { + fprintf(stderr, "Failed to notify reloading to $NOTIFY_SOCKET: %s\en", strerror(\-r)); + return EXIT_FAILURE; + } + + /* Do some reconfiguration work here \&... */ + + r = notify_ready(); + if (r < 0) { + fprintf(stderr, "Failed to notify readiness to $NOTIFY_SOCKET: %s\en", strerror(\-r)); + return EXIT_FAILURE; + } + } + + /* Do some daemon work here \&... */ + sleep(5); + } + + return EXIT_SUCCESS; +} +.fi +.if n \{\ +.RE +.\} .SH "ENVIRONMENT" .PP \fI$NOTIFY_SOCKET\fR diff --git a/upstream/archlinux/man3/sd_path_lookup.3 b/upstream/archlinux/man3/sd_path_lookup.3 index 7b5b0515..22b15c1a 100644 --- a/upstream/archlinux/man3/sd_path_lookup.3 +++ b/upstream/archlinux/man3/sd_path_lookup.3 @@ -210,7 +210,7 @@ Added in version 246\&. #include <stdio\&.h> #include <stdlib\&.h> -#include <sd\-path\&.h> +#include <systemd/sd\-path\&.h> int main(void) { int r; diff --git a/upstream/archlinux/man3/seekdir.3 b/upstream/archlinux/man3/seekdir.3 index 70e535c3..f584f5e7 100644 --- a/upstream/archlinux/man3/seekdir.3 +++ b/upstream/archlinux/man3/seekdir.3 @@ -9,7 +9,7 @@ .\" 386BSD man pages .\" Modified Sat Jul 24 18:25:21 1993 by Rik Faith (faith@cs.unc.edu) .\" -.TH seekdir 3 2023-10-31 "Linux man-pages 6.06" +.TH seekdir 3 2024-05-02 "Linux man-pages 6.8" .SH NAME seekdir \- set the position of the next readdir() call in the directory stream. diff --git a/upstream/archlinux/man3/sem_close.3 b/upstream/archlinux/man3/sem_close.3 index e53abca5..9b2e9281 100644 --- a/upstream/archlinux/man3/sem_close.3 +++ b/upstream/archlinux/man3/sem_close.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sem_close 3 2023-10-31 "Linux man-pages 6.06" +.TH sem_close 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sem_close \- close a named semaphore .SH LIBRARY diff --git a/upstream/archlinux/man3/sem_destroy.3 b/upstream/archlinux/man3/sem_destroy.3 index 0df3e097..55d6028f 100644 --- a/upstream/archlinux/man3/sem_destroy.3 +++ b/upstream/archlinux/man3/sem_destroy.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sem_destroy 3 2023-10-31 "Linux man-pages 6.06" +.TH sem_destroy 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sem_destroy \- destroy an unnamed semaphore .SH LIBRARY diff --git a/upstream/archlinux/man3/sem_getvalue.3 b/upstream/archlinux/man3/sem_getvalue.3 index cb155bd6..ea80f560 100644 --- a/upstream/archlinux/man3/sem_getvalue.3 +++ b/upstream/archlinux/man3/sem_getvalue.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sem_getvalue 3 2023-10-31 "Linux man-pages 6.06" +.TH sem_getvalue 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sem_getvalue \- get the value of a semaphore .SH LIBRARY diff --git a/upstream/archlinux/man3/sem_init.3 b/upstream/archlinux/man3/sem_init.3 index 904f32b6..931bc911 100644 --- a/upstream/archlinux/man3/sem_init.3 +++ b/upstream/archlinux/man3/sem_init.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sem_init 3 2023-10-31 "Linux man-pages 6.06" +.TH sem_init 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sem_init \- initialize an unnamed semaphore .SH LIBRARY diff --git a/upstream/archlinux/man3/sem_open.3 b/upstream/archlinux/man3/sem_open.3 index 7fc749dd..5506453d 100644 --- a/upstream/archlinux/man3/sem_open.3 +++ b/upstream/archlinux/man3/sem_open.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sem_open 3 2023-10-31 "Linux man-pages 6.06" +.TH sem_open 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sem_open \- initialize and open a named semaphore .SH LIBRARY diff --git a/upstream/archlinux/man3/sem_post.3 b/upstream/archlinux/man3/sem_post.3 index 7fe204e4..b1990be9 100644 --- a/upstream/archlinux/man3/sem_post.3 +++ b/upstream/archlinux/man3/sem_post.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sem_post 3 2023-10-31 "Linux man-pages 6.06" +.TH sem_post 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sem_post \- unlock a semaphore .SH LIBRARY diff --git a/upstream/archlinux/man3/sem_unlink.3 b/upstream/archlinux/man3/sem_unlink.3 index c41f24b3..e1636e84 100644 --- a/upstream/archlinux/man3/sem_unlink.3 +++ b/upstream/archlinux/man3/sem_unlink.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sem_unlink 3 2023-10-31 "Linux man-pages 6.06" +.TH sem_unlink 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sem_unlink \- remove a named semaphore .SH LIBRARY diff --git a/upstream/archlinux/man3/sem_wait.3 b/upstream/archlinux/man3/sem_wait.3 index e6b9de57..71e33f1a 100644 --- a/upstream/archlinux/man3/sem_wait.3 +++ b/upstream/archlinux/man3/sem_wait.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sem_wait 3 2023-10-31 "Linux man-pages 6.06" +.TH sem_wait 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sem_wait, sem_timedwait, sem_trywait \- lock a semaphore .SH LIBRARY diff --git a/upstream/archlinux/man3/setaliasent.3 b/upstream/archlinux/man3/setaliasent.3 index fa022b87..3f605ab3 100644 --- a/upstream/archlinux/man3/setaliasent.3 +++ b/upstream/archlinux/man3/setaliasent.3 @@ -5,7 +5,7 @@ .\" .\" Polished a bit, added a little, aeb .\" -.TH setaliasent 3 2023-10-31 "Linux man-pages 6.06" +.TH setaliasent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME setaliasent, endaliasent, getaliasent, getaliasent_r, getaliasbyname, getaliasbyname_r \- read an alias entry diff --git a/upstream/archlinux/man3/setbuf.3 b/upstream/archlinux/man3/setbuf.3 index 80eee7ba..e7229452 100644 --- a/upstream/archlinux/man3/setbuf.3 +++ b/upstream/archlinux/man3/setbuf.3 @@ -18,7 +18,7 @@ .\" Correction, 2000-03-03, Andreas Jaeger <aj@suse.de> .\" Added return value for setvbuf, aeb, .\" -.TH setbuf 3 2023-10-31 "Linux man-pages 6.06" +.TH setbuf 3 2024-05-02 "Linux man-pages 6.8" .SH NAME setbuf, setbuffer, setlinebuf, setvbuf \- stream buffering operations .SH LIBRARY @@ -201,7 +201,7 @@ points to still exists by the time is closed, which also happens at program termination. For example, the following is invalid: .P -.\" [[invalid]] SRC BEGIN (setbuf.c) +.\" SRC BEGIN (setbuf.c) .EX #include <stdio.h> \& diff --git a/upstream/archlinux/man3/setenv.3 b/upstream/archlinux/man3/setenv.3 index 7d7ed3d9..eebf32b0 100644 --- a/upstream/archlinux/man3/setenv.3 +++ b/upstream/archlinux/man3/setenv.3 @@ -15,7 +15,7 @@ .\" Noted nonstandard behavior of setenv() if name contains '=' .\" 2005-08-12, mtk, glibc 2.3.4 fixed the "name contains '='" bug .\" -.TH setenv 3 2023-10-31 "Linux man-pages 6.06" +.TH setenv 3 2024-05-02 "Linux man-pages 6.8" .SH NAME setenv \- change or add an environment variable .SH LIBRARY diff --git a/upstream/archlinux/man3/setjmp.3 b/upstream/archlinux/man3/setjmp.3 index babfc89d..7404b286 100644 --- a/upstream/archlinux/man3/setjmp.3 +++ b/upstream/archlinux/man3/setjmp.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH setjmp 3 2023-10-31 "Linux man-pages 6.06" +.TH setjmp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME setjmp, sigsetjmp, longjmp, siglongjmp \- performing a nonlocal goto .SH LIBRARY diff --git a/upstream/archlinux/man3/setlocale.3 b/upstream/archlinux/man3/setlocale.3 index a7fb1a52..d898ada7 100644 --- a/upstream/archlinux/man3/setlocale.3 +++ b/upstream/archlinux/man3/setlocale.3 @@ -10,7 +10,7 @@ .\" Modified Tue Aug 24 17:11:01 1999 by Andries Brouwer (aeb@cwi.nl) .\" Modified Tue Feb 6 03:31:55 2001 by Andries Brouwer (aeb@cwi.nl) .\" -.TH setlocale 3 2024-01-28 "Linux man-pages 6.06" +.TH setlocale 3 2024-05-02 "Linux man-pages 6.8" .SH NAME setlocale \- set the current locale .SH LIBRARY @@ -92,7 +92,7 @@ Such a string is either a well-known constant like "C" or "da_DK" If .I locale is an empty string, -.BR """""" , +.BR \[dq]\[dq] , each part of the locale that should be modified is set according to the environment variables. The details are implementation-dependent. @@ -112,9 +112,9 @@ is unchanged, and returns NULL. .P The locale -.B """C""" +.B \[dq]C\[dq] or -.B """POSIX""" +.B \[dq]POSIX\[dq] is a portable locale; it exists on all conforming systems. .P @@ -138,7 +138,7 @@ If is NULL, the current locale is only queried, not modified. .P On startup of the main program, the portable -.B """C""" +.B \[dq]C\[dq] locale is selected as default. A program may be made portable to all locales by calling: .P diff --git a/upstream/archlinux/man3/setlogmask.3 b/upstream/archlinux/man3/setlogmask.3 index 863660fa..0a1ba9c2 100644 --- a/upstream/archlinux/man3/setlogmask.3 +++ b/upstream/archlinux/man3/setlogmask.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH setlogmask 3 2023-11-01 "Linux man-pages 6.06" +.TH setlogmask 3 2024-05-02 "Linux man-pages 6.8" .SH NAME setlogmask \- set log priority mask .SH LIBRARY diff --git a/upstream/archlinux/man3/setnetgrent.3 b/upstream/archlinux/man3/setnetgrent.3 index a4ea3272..b8a22562 100644 --- a/upstream/archlinux/man3/setnetgrent.3 +++ b/upstream/archlinux/man3/setnetgrent.3 @@ -6,7 +6,7 @@ .\" based on glibc infopages .\" polished - aeb .\" -.TH setnetgrent 3 2023-10-31 "Linux man-pages 6.06" +.TH setnetgrent 3 2024-05-02 "Linux man-pages 6.8" .SH NAME setnetgrent, endnetgrent, getnetgrent, getnetgrent_r, innetgr \- handle network group entries diff --git a/upstream/archlinux/man3/shm_open.3 b/upstream/archlinux/man3/shm_open.3 index dafc95d2..25ff059f 100644 --- a/upstream/archlinux/man3/shm_open.3 +++ b/upstream/archlinux/man3/shm_open.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH shm_open 3 2023-10-31 "Linux man-pages 6.06" +.TH shm_open 3 2024-05-02 "Linux man-pages 6.8" .SH NAME shm_open, shm_unlink \- create/open or unlink POSIX shared memory objects .SH LIBRARY @@ -290,13 +290,13 @@ on the memory object that is shared between the two programs. .in +4n .\" SRC BEGIN (pshm_ucase.h) .EX -#include <fcntl.h> +#ifndef PSHM_UCASE_H +#define PSHM_UCASE_H +\& #include <semaphore.h> +#include <stddef.h> #include <stdio.h> #include <stdlib.h> -#include <sys/mman.h> -#include <sys/stat.h> -#include <unistd.h> \& #define errExit(msg) do { perror(msg); exit(EXIT_FAILURE); \e } while (0) @@ -312,6 +312,8 @@ struct shmbuf { size_t cnt; /* Number of bytes used in \[aq]buf\[aq] */ char buf[BUF_SIZE]; /* Data being transferred */ }; +\& +#endif // include guard .EE .\" SRC END .in @@ -338,6 +340,11 @@ to tell the "send" program that it may now access the shared memory. Licensed under GNU General Public License v2 or later. */ #include <ctype.h> +#include <fcntl.h> +#include <stdio.h> +#include <stdlib.h> +#include <sys/mman.h> +#include <unistd.h> \& #include "pshm_ucase.h" \& @@ -430,7 +437,13 @@ on standard output. \& Licensed under GNU General Public License v2 or later. */ +#include <fcntl.h> +#include <stddef.h> +#include <stdio.h> +#include <stdlib.h> #include <string.h> +#include <sys/mman.h> +#include <unistd.h> \& #include "pshm_ucase.h" \& diff --git a/upstream/archlinux/man3/siginterrupt.3 b/upstream/archlinux/man3/siginterrupt.3 index a1ab93a2..52eb639a 100644 --- a/upstream/archlinux/man3/siginterrupt.3 +++ b/upstream/archlinux/man3/siginterrupt.3 @@ -9,7 +9,7 @@ .\" 386BSD man pages .\" Modified Sun Jul 25 10:40:51 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Sun Apr 14 16:20:34 1996 by Andries Brouwer (aeb@cwi.nl) -.TH siginterrupt 3 2023-10-31 "Linux man-pages 6.06" +.TH siginterrupt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME siginterrupt \- allow signals to interrupt system calls .SH LIBRARY diff --git a/upstream/archlinux/man3/signbit.3 b/upstream/archlinux/man3/signbit.3 index 48ae0e21..f7a95919 100644 --- a/upstream/archlinux/man3/signbit.3 +++ b/upstream/archlinux/man3/signbit.3 @@ -7,7 +7,7 @@ .\" .\" Based on glibc infopages, copyright Free Software Foundation .\" -.TH signbit 3 2023-10-31 "Linux man-pages 6.06" +.TH signbit 3 2024-05-02 "Linux man-pages 6.8" .SH NAME signbit \- test sign of a real floating-point number .SH LIBRARY diff --git a/upstream/archlinux/man3/significand.3 b/upstream/archlinux/man3/significand.3 index 3cea3113..d418c0f5 100644 --- a/upstream/archlinux/man3/significand.3 +++ b/upstream/archlinux/man3/significand.3 @@ -5,7 +5,7 @@ .\" .\" heavily based on glibc infopages, copyright Free Software Foundation .\" -.TH significand 3 2023-10-31 "Linux man-pages 6.06" +.TH significand 3 2024-05-02 "Linux man-pages 6.8" .SH NAME significand, significandf, significandl \- get mantissa of floating-point number @@ -36,7 +36,8 @@ Feature Test Macro Requirements for glibc (see .SH DESCRIPTION These functions return the mantissa of .I x -scaled to the range [1,2). +scaled to the range +.RB [ 1 ,\~ FLT_RADIX ). They are equivalent to .P .in +4n diff --git a/upstream/archlinux/man3/sigpause.3 b/upstream/archlinux/man3/sigpause.3 index 9e2305d3..dd6714e3 100644 --- a/upstream/archlinux/man3/sigpause.3 +++ b/upstream/archlinux/man3/sigpause.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sigpause 3 2023-10-31 "Linux man-pages 6.06" +.TH sigpause 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sigpause \- atomically release blocked signals and wait for interrupt .SH LIBRARY diff --git a/upstream/archlinux/man3/sigqueue.3 b/upstream/archlinux/man3/sigqueue.3 index 90459043..885f4c0b 100644 --- a/upstream/archlinux/man3/sigqueue.3 +++ b/upstream/archlinux/man3/sigqueue.3 @@ -6,7 +6,7 @@ .\" added note on self-signaling, aeb, 2002-06-07 .\" added note on CAP_KILL, mtk, 2004-06-16 .\" -.TH sigqueue 3 2023-10-31 "Linux man-pages 6.06" +.TH sigqueue 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sigqueue \- queue a signal and data to a process .SH LIBRARY diff --git a/upstream/archlinux/man3/sigset.3 b/upstream/archlinux/man3/sigset.3 index 588627ee..136bc6b5 100644 --- a/upstream/archlinux/man3/sigset.3 +++ b/upstream/archlinux/man3/sigset.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sigset 3 2023-10-31 "Linux man-pages 6.06" +.TH sigset 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sigset, sighold, sigrelse, sigignore \- System V signal API .SH LIBRARY diff --git a/upstream/archlinux/man3/sigsetops.3 b/upstream/archlinux/man3/sigsetops.3 index a998236f..be7136ff 100644 --- a/upstream/archlinux/man3/sigsetops.3 +++ b/upstream/archlinux/man3/sigsetops.3 @@ -9,7 +9,7 @@ .\" 2007-10-26 mdw added wording that a sigset_t must be initialized .\" prior to use .\" -.TH SIGSETOPS 3 2023-10-31 "Linux man-pages 6.06" +.TH SIGSETOPS 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sigemptyset, sigfillset, sigaddset, sigdelset, sigismember \- POSIX signal set operations diff --git a/upstream/archlinux/man3/sigvec.3 b/upstream/archlinux/man3/sigvec.3 index e7e1393c..578a44a3 100644 --- a/upstream/archlinux/man3/sigvec.3 +++ b/upstream/archlinux/man3/sigvec.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sigvec 3 2023-10-31 "Linux man-pages 6.06" +.TH sigvec 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sigvec, sigblock, sigsetmask, siggetmask, sigmask \- BSD signal API .SH LIBRARY diff --git a/upstream/archlinux/man3/sigwait.3 b/upstream/archlinux/man3/sigwait.3 index 9c0a1e77..6a52ce83 100644 --- a/upstream/archlinux/man3/sigwait.3 +++ b/upstream/archlinux/man3/sigwait.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sigwait 3 2023-10-31 "Linux man-pages 6.06" +.TH sigwait 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sigwait \- wait for a signal .SH LIBRARY @@ -36,6 +36,9 @@ function suspends execution of the calling thread until one of the signals specified in the signal set .I set becomes pending. +For a signal to become pending, +it must first be blocked with +.BR sigprocmask (2). The function accepts the signal (removes it from the pending list of signals), and returns the signal number in @@ -81,7 +84,9 @@ T} Thread safety MT-Safe .SH VERSIONS .BR sigwait () is implemented using -.BR sigtimedwait (2). +.BR sigtimedwait (2); +consult its +.BR NOTES . .P The glibc implementation of .BR sigwait () diff --git a/upstream/archlinux/man3/sin.3 b/upstream/archlinux/man3/sin.3 index 383839b7..61d21467 100644 --- a/upstream/archlinux/man3/sin.3 +++ b/upstream/archlinux/man3/sin.3 @@ -13,7 +13,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH sin 3 2023-10-31 "Linux man-pages 6.06" +.TH sin 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sin, sinf, sinl \- sine function .SH LIBRARY diff --git a/upstream/archlinux/man3/sincos.3 b/upstream/archlinux/man3/sincos.3 index f9b20ba5..4809982a 100644 --- a/upstream/archlinux/man3/sincos.3 +++ b/upstream/archlinux/man3/sincos.3 @@ -5,7 +5,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH sincos 3 2023-10-31 "Linux man-pages 6.06" +.TH sincos 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sincos, sincosf, sincosl \- calculate sin and cos simultaneously .SH LIBRARY diff --git a/upstream/archlinux/man3/sinh.3 b/upstream/archlinux/man3/sinh.3 index 269fee09..d91096bb 100644 --- a/upstream/archlinux/man3/sinh.3 +++ b/upstream/archlinux/man3/sinh.3 @@ -14,7 +14,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH sinh 3 2023-10-31 "Linux man-pages 6.06" +.TH sinh 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sinh, sinhf, sinhl \- hyperbolic sine function .SH LIBRARY diff --git a/upstream/archlinux/man3/sleep.3 b/upstream/archlinux/man3/sleep.3 index f8a0fdac..1486e4aa 100644 --- a/upstream/archlinux/man3/sleep.3 +++ b/upstream/archlinux/man3/sleep.3 @@ -4,7 +4,7 @@ .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" .\" Modified Sat Jul 24 18:16:02 1993 by Rik Faith (faith@cs.unc.edu) -.TH sleep 3 2023-10-31 "Linux man-pages 6.06" +.TH sleep 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sleep \- sleep for a specified number of seconds .SH LIBRARY diff --git a/upstream/archlinux/man3/slist.3 b/upstream/archlinux/man3/slist.3 index 13f50bba..04b1aacc 100644 --- a/upstream/archlinux/man3/slist.3 +++ b/upstream/archlinux/man3/slist.3 @@ -5,7 +5,7 @@ .\" SPDX-License-Identifier: BSD-3-Clause .\" .\" -.TH SLIST 3 2023-10-31 "Linux man-pages 6.06" +.TH SLIST 3 2024-05-02 "Linux man-pages 6.8" .SH NAME SLIST_EMPTY, SLIST_ENTRY, @@ -68,7 +68,7 @@ Standard C library .\" .BI " SLIST_ENTRY " NAME ); .fi .SH DESCRIPTION -These macros define and operate on doubly linked lists. +These macros define and operate on singly linked lists. .P In the macro definitions, .I TYPE diff --git a/upstream/archlinux/man3/sockatmark.3 b/upstream/archlinux/man3/sockatmark.3 index a1ede91e..ad5a0152 100644 --- a/upstream/archlinux/man3/sockatmark.3 +++ b/upstream/archlinux/man3/sockatmark.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sockatmark 3 2023-10-31 "Linux man-pages 6.06" +.TH sockatmark 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sockatmark \- determine whether socket is at out-of-band mark .SH LIBRARY diff --git a/upstream/archlinux/man3/sqrt.3 b/upstream/archlinux/man3/sqrt.3 index 298f52a4..878c1440 100644 --- a/upstream/archlinux/man3/sqrt.3 +++ b/upstream/archlinux/man3/sqrt.3 @@ -12,7 +12,7 @@ .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu) .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) -.TH sqrt 3 2023-10-31 "Linux man-pages 6.06" +.TH sqrt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sqrt, sqrtf, sqrtl \- square root function .SH LIBRARY diff --git a/upstream/archlinux/man3/sscanf.3 b/upstream/archlinux/man3/sscanf.3 index b2759df7..2653c65b 100644 --- a/upstream/archlinux/man3/sscanf.3 +++ b/upstream/archlinux/man3/sscanf.3 @@ -22,7 +22,7 @@ .\" Add ERRORS section. .\" Document the 'a' and 'm' modifiers for dynamic string allocation. .\" -.TH sscanf 3 2023-12-09 "Linux man-pages 6.06" +.TH sscanf 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sscanf, vsscanf \- input string format conversion .SH LIBRARY diff --git a/upstream/archlinux/man3/stailq.3 b/upstream/archlinux/man3/stailq.3 index 37101ca2..bfb48693 100644 --- a/upstream/archlinux/man3/stailq.3 +++ b/upstream/archlinux/man3/stailq.3 @@ -5,7 +5,7 @@ .\" SPDX-License-Identifier: BSD-3-Clause .\" .\" -.TH STAILQ 3 2023-10-31 "Linux man-pages 6.06" +.TH STAILQ 3 2024-05-02 "Linux man-pages 6.8" .SH NAME .\"SIMPLEQ_CONCAT, SIMPLEQ_EMPTY, diff --git a/upstream/archlinux/man3/static_assert.3 b/upstream/archlinux/man3/static_assert.3 index dfc70520..fd09f064 100644 --- a/upstream/archlinux/man3/static_assert.3 +++ b/upstream/archlinux/man3/static_assert.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH static_assert 3 2023-10-31 "Linux man-pages 6.06" +.TH static_assert 3 2024-05-02 "Linux man-pages 6.8" .SH NAME static_assert, _Static_assert \- fail compilation if assertion is false .SH LIBRARY diff --git a/upstream/archlinux/man3/statvfs.3 b/upstream/archlinux/man3/statvfs.3 index 58bc7f8f..e0e88bd3 100644 --- a/upstream/archlinux/man3/statvfs.3 +++ b/upstream/archlinux/man3/statvfs.3 @@ -8,7 +8,7 @@ .\" .\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com> .\" -.TH statvfs 3 2023-10-31 "Linux man-pages 6.06" +.TH statvfs 3 2024-05-02 "Linux man-pages 6.8" .SH NAME statvfs, fstatvfs \- get filesystem statistics .SH LIBRARY diff --git a/upstream/archlinux/man3/stdarg.3 b/upstream/archlinux/man3/stdarg.3 index 85fd684c..8c581af8 100644 --- a/upstream/archlinux/man3/stdarg.3 +++ b/upstream/archlinux/man3/stdarg.3 @@ -13,7 +13,7 @@ .\" Converted for Linux, Mon Nov 29 15:11:11 1993, faith@cs.unc.edu .\" Additions, 2001-10-14, aeb .\" -.TH stdarg 3 2023-10-31 "Linux man-pages 6.06" +.TH stdarg 3 2024-05-02 "Linux man-pages 6.8" .SH NAME stdarg, va_start, va_arg, va_end, va_copy \- variable argument lists .SH LIBRARY diff --git a/upstream/archlinux/man3/stdin.3 b/upstream/archlinux/man3/stdin.3 index a94040a6..305eab7a 100644 --- a/upstream/archlinux/man3/stdin.3 +++ b/upstream/archlinux/man3/stdin.3 @@ -10,7 +10,7 @@ .\" 2005-06-16 mtk, mentioned freopen() .\" 2007-12-08, mtk, Converted from mdoc to man macros .\" -.TH stdin 3 2023-10-31 "Linux man-pages 6.06" +.TH stdin 3 2024-05-02 "Linux man-pages 6.8" .SH NAME stdin, stdout, stderr \- standard I/O streams .SH LIBRARY diff --git a/upstream/archlinux/man3/stdio.3 b/upstream/archlinux/man3/stdio.3 index 08e3558c..b7a3c072 100644 --- a/upstream/archlinux/man3/stdio.3 +++ b/upstream/archlinux/man3/stdio.3 @@ -9,7 +9,7 @@ .\" Converted for Linux, Mon Nov 29 16:07:22 1993, faith@cs.unc.edu .\" Modified, 2001-12-26, aeb .\" -.TH stdio 3 2023-12-29 "Linux man-pages 6.06" +.TH stdio 3 2024-05-02 "Linux man-pages 6.8" .SH NAME stdio \- standard input/output library functions .SH LIBRARY diff --git a/upstream/archlinux/man3/stdio_ext.3 b/upstream/archlinux/man3/stdio_ext.3 index 133f3689..6d69817f 100644 --- a/upstream/archlinux/man3/stdio_ext.3 +++ b/upstream/archlinux/man3/stdio_ext.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH stdio_ext 3 2023-10-31 "Linux man-pages 6.06" +.TH stdio_ext 3 2024-05-02 "Linux man-pages 6.8" .SH NAME __fbufsize, __flbf, __fpending, __fpurge, __freadable, __freading, __fsetlocking, __fwritable, __fwriting, _flushlbf \- diff --git a/upstream/archlinux/man3/stpncpy.3 b/upstream/archlinux/man3/stpncpy.3 index c8e12d90..10b28084 100644 --- a/upstream/archlinux/man3/stpncpy.3 +++ b/upstream/archlinux/man3/stpncpy.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH stpncpy 3 2024-02-12 "Linux man-pages 6.06" +.TH stpncpy 3 2024-05-02 "Linux man-pages 6.8" .SH NAME stpncpy, strncpy \- diff --git a/upstream/archlinux/man3/strcasecmp.3 b/upstream/archlinux/man3/strcasecmp.3 index 22c21abc..8539159e 100644 --- a/upstream/archlinux/man3/strcasecmp.3 +++ b/upstream/archlinux/man3/strcasecmp.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 18:12:45 1993 by Rik Faith (faith@cs.unc.edu) -.TH strcasecmp 3 2023-10-31 "Linux man-pages 6.06" +.TH strcasecmp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strcasecmp, strncasecmp \- compare two strings ignoring case .SH LIBRARY diff --git a/upstream/archlinux/man3/strchr.3 b/upstream/archlinux/man3/strchr.3 index 2f74a4ea..446a698b 100644 --- a/upstream/archlinux/man3/strchr.3 +++ b/upstream/archlinux/man3/strchr.3 @@ -11,7 +11,7 @@ .\" 2006-05-19, Justin Pryzby <pryzbyj@justinpryzby.com> .\" Document strchrnul(3). .\" -.TH strchr 3 2023-10-31 "Linux man-pages 6.06" +.TH strchr 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strchr, strrchr, strchrnul \- locate character in string .SH LIBRARY @@ -115,7 +115,9 @@ GNU. POSIX.1-2001, C89, SVr4, 4.3BSD. .TP .BR strchrnul () -glibc 2.1.1. +glibc 2.1.1, +FreeBSD 10, +NetBSD 8. .SH SEE ALSO .BR memchr (3), .BR string (3), diff --git a/upstream/archlinux/man3/strcmp.3 b/upstream/archlinux/man3/strcmp.3 index 21f3e1a7..4a69227c 100644 --- a/upstream/archlinux/man3/strcmp.3 +++ b/upstream/archlinux/man3/strcmp.3 @@ -11,7 +11,7 @@ .\" Modified Sat Jul 24 18:08:52 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified 2001-08-31, aeb .\" -.TH strcmp 3 2023-10-31 "Linux man-pages 6.06" +.TH strcmp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strcmp, strncmp \- compare two strings .SH LIBRARY diff --git a/upstream/archlinux/man3/strcoll.3 b/upstream/archlinux/man3/strcoll.3 index 6ad9486e..d7070d63 100644 --- a/upstream/archlinux/man3/strcoll.3 +++ b/upstream/archlinux/man3/strcoll.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sun Jul 25 10:40:44 1993 by Rik Faith (faith@cs.unc.edu) -.TH strcoll 3 2023-10-31 "Linux man-pages 6.06" +.TH strcoll 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strcoll \- compare two strings using the current locale .SH LIBRARY diff --git a/upstream/archlinux/man3/strcpy.3 b/upstream/archlinux/man3/strcpy.3 index 65e1a389..7b6a8fef 100644 --- a/upstream/archlinux/man3/strcpy.3 +++ b/upstream/archlinux/man3/strcpy.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH strcpy 3 2023-10-31 "Linux man-pages 6.06" +.TH strcpy 3 2024-05-02 "Linux man-pages 6.8" .SH NAME stpcpy, strcpy, strcat \- copy or catenate a string .SH LIBRARY diff --git a/upstream/archlinux/man3/strdup.3 b/upstream/archlinux/man3/strdup.3 index 287b3711..65ba8814 100644 --- a/upstream/archlinux/man3/strdup.3 +++ b/upstream/archlinux/man3/strdup.3 @@ -9,7 +9,7 @@ .\" 386BSD man pages .\" Modified Sun Jul 25 10:41:34 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Wed Oct 17 01:12:26 2001 by John Levon <moz@compsoc.man.ac.uk> -.TH strdup 3 2023-10-31 "Linux man-pages 6.06" +.TH strdup 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strdup, strndup, strdupa, strndupa \- duplicate a string .SH LIBRARY diff --git a/upstream/archlinux/man3/strerror.3 b/upstream/archlinux/man3/strerror.3 index 4251ebb5..96338d2c 100644 --- a/upstream/archlinux/man3/strerror.3 +++ b/upstream/archlinux/man3/strerror.3 @@ -17,7 +17,7 @@ .\" 2005-12-13, mtk, Substantial rewrite of strerror_r() description .\" Addition of extra material on portability and standards. .\" -.TH strerror 3 2023-10-31 "Linux man-pages 6.06" +.TH strerror 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strerror, strerrorname_np, strerrordesc_np, strerror_r, strerror_l \- return string describing error number diff --git a/upstream/archlinux/man3/strfmon.3 b/upstream/archlinux/man3/strfmon.3 index d198e5bc..8954cf12 100644 --- a/upstream/archlinux/man3/strfmon.3 +++ b/upstream/archlinux/man3/strfmon.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH strfmon 3 2023-10-31 "Linux man-pages 6.06" +.TH strfmon 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strfmon, strfmon_l \- convert monetary value to a string .SH LIBRARY diff --git a/upstream/archlinux/man3/strfromd.3 b/upstream/archlinux/man3/strfromd.3 index d65e6182..2085703f 100644 --- a/upstream/archlinux/man3/strfromd.3 +++ b/upstream/archlinux/man3/strfromd.3 @@ -10,7 +10,7 @@ .\" ISO/IEC TS 18661-1 technical specification. .\" snprintf and other man.3 pages. .\" -.TH strfromd 3 2023-10-31 "Linux man-pages 6.06" +.TH strfromd 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strfromd, strfromf, strfroml \- convert a floating-point value into a string diff --git a/upstream/archlinux/man3/strfry.3 b/upstream/archlinux/man3/strfry.3 index 9faaae15..723b79ae 100644 --- a/upstream/archlinux/man3/strfry.3 +++ b/upstream/archlinux/man3/strfry.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sun Jul 25 10:39:43 1993 by Rik Faith (faith@cs.unc.edu) -.TH strfry 3 2023-10-31 "Linux man-pages 6.06" +.TH strfry 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strfry \- randomize a string .SH LIBRARY diff --git a/upstream/archlinux/man3/strftime.3 b/upstream/archlinux/man3/strftime.3 index d7e27806..21c3f30a 100644 --- a/upstream/archlinux/man3/strftime.3 +++ b/upstream/archlinux/man3/strftime.3 @@ -15,7 +15,7 @@ .\" 2005-11-22 mtk, added glibc Notes covering optional 'flag' and .\" 'width' components of conversion specifications. .\" -.TH strftime 3 2024-01-28 "Linux man-pages 6.06" +.TH strftime 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strftime \- format date and time .SH LIBRARY diff --git a/upstream/archlinux/man3/string.3 b/upstream/archlinux/man3/string.3 index 4a9c62de..1f4c96b4 100644 --- a/upstream/archlinux/man3/string.3 +++ b/upstream/archlinux/man3/string.3 @@ -7,7 +7,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sun Jul 25 10:54:31 1993, Rik Faith (faith@cs.unc.edu) -.TH string 3 2023-11-14 "Linux man-pages 6.06" +.TH string 3 2024-05-02 "Linux man-pages 6.8" .SH NAME stpcpy, strcasecmp, strcat, strchr, strcmp, strcoll, strcpy, strcspn, strdup, strfry, strlen, strncat, strncmp, strncpy, strncasecmp, strpbrk, diff --git a/upstream/archlinux/man3/strlen.3 b/upstream/archlinux/man3/strlen.3 index 28eee927..dfe6dab4 100644 --- a/upstream/archlinux/man3/strlen.3 +++ b/upstream/archlinux/man3/strlen.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 18:02:26 1993 by Rik Faith (faith@cs.unc.edu) -.TH strlen 3 2023-10-31 "Linux man-pages 6.06" +.TH strlen 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strlen \- calculate the length of a string .SH LIBRARY diff --git a/upstream/archlinux/man3/strncat.3 b/upstream/archlinux/man3/strncat.3 index c388e1fb..50c7e81b 100644 --- a/upstream/archlinux/man3/strncat.3 +++ b/upstream/archlinux/man3/strncat.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH strncat 3 2023-12-05 "Linux man-pages 6.06" +.TH strncat 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strncat \- diff --git a/upstream/archlinux/man3/strnlen.3 b/upstream/archlinux/man3/strnlen.3 index 2a741927..b05a4a47 100644 --- a/upstream/archlinux/man3/strnlen.3 +++ b/upstream/archlinux/man3/strnlen.3 @@ -6,7 +6,7 @@ .\" References consulted: .\" GNU glibc-2 source code and manual .\" -.TH strnlen 3 2023-10-31 "Linux man-pages 6.06" +.TH strnlen 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strnlen \- determine the length of a fixed-size string .SH LIBRARY diff --git a/upstream/archlinux/man3/strpbrk.3 b/upstream/archlinux/man3/strpbrk.3 index 7f464d07..767fb954 100644 --- a/upstream/archlinux/man3/strpbrk.3 +++ b/upstream/archlinux/man3/strpbrk.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 18:01:24 1993 by Rik Faith (faith@cs.unc.edu) -.TH strpbrk 3 2023-10-31 "Linux man-pages 6.06" +.TH strpbrk 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strpbrk \- search a string for any of a set of bytes .SH LIBRARY diff --git a/upstream/archlinux/man3/strptime.3 b/upstream/archlinux/man3/strptime.3 index 8cff78f0..597aabff 100644 --- a/upstream/archlinux/man3/strptime.3 +++ b/upstream/archlinux/man3/strptime.3 @@ -9,7 +9,7 @@ .\" Modified, aeb, 2001-08-31 .\" Modified, wharms 2001-11-12, remark on white space and example .\" -.TH strptime 3 2024-01-28 "Linux man-pages 6.06" +.TH strptime 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strptime \- convert a string representation of time to a time tm structure .SH LIBRARY diff --git a/upstream/archlinux/man3/strsep.3 b/upstream/archlinux/man3/strsep.3 index 285dd03a..94a20c27 100644 --- a/upstream/archlinux/man3/strsep.3 +++ b/upstream/archlinux/man3/strsep.3 @@ -11,7 +11,7 @@ .\" Modified Mon Jan 20 12:04:18 1997 by Andries Brouwer (aeb@cwi.nl) .\" Modified Tue Jan 23 20:23:07 2001 by Andries Brouwer (aeb@cwi.nl) .\" -.TH strsep 3 2023-10-31 "Linux man-pages 6.06" +.TH strsep 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strsep \- extract token from string .SH LIBRARY diff --git a/upstream/archlinux/man3/strsignal.3 b/upstream/archlinux/man3/strsignal.3 index edd33042..1ec08e82 100644 --- a/upstream/archlinux/man3/strsignal.3 +++ b/upstream/archlinux/man3/strsignal.3 @@ -9,7 +9,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 17:59:03 1993 by Rik Faith (faith@cs.unc.edu) -.TH strsignal 3 2023-10-31 "Linux man-pages 6.06" +.TH strsignal 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strsignal, sigabbrev_np, sigdescr_np, sys_siglist \- return string describing signal diff --git a/upstream/archlinux/man3/strspn.3 b/upstream/archlinux/man3/strspn.3 index c6f9358b..c34e5014 100644 --- a/upstream/archlinux/man3/strspn.3 +++ b/upstream/archlinux/man3/strspn.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 17:57:50 1993 by Rik Faith (faith@cs.unc.edu) -.TH strspn 3 2023-10-31 "Linux man-pages 6.06" +.TH strspn 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strspn, strcspn \- get length of a prefix substring .SH LIBRARY diff --git a/upstream/archlinux/man3/strstr.3 b/upstream/archlinux/man3/strstr.3 index 7b22a94d..a4f6e56f 100644 --- a/upstream/archlinux/man3/strstr.3 +++ b/upstream/archlinux/man3/strstr.3 @@ -11,7 +11,7 @@ .\" Added history, aeb, 980113. .\" 2005-05-05 mtk: added strcasestr() .\" -.TH strstr 3 2023-10-31 "Linux man-pages 6.06" +.TH strstr 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strstr, strcasestr \- locate a substring .SH LIBRARY diff --git a/upstream/archlinux/man3/strtod.3 b/upstream/archlinux/man3/strtod.3 index 652a426d..f3129d6a 100644 --- a/upstream/archlinux/man3/strtod.3 +++ b/upstream/archlinux/man3/strtod.3 @@ -15,7 +15,7 @@ .\" (michael@cantor.informatik.rwth-aachen.de) .\" Added strof, strtold, aeb, 2001-06-07 .\" -.TH strtod 3 2023-10-31 "Linux man-pages 6.06" +.TH strtod 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strtod, strtof, strtold \- convert ASCII string to floating-point number .SH LIBRARY diff --git a/upstream/archlinux/man3/strtoimax.3 b/upstream/archlinux/man3/strtoimax.3 index e55b3e57..af75ba4b 100644 --- a/upstream/archlinux/man3/strtoimax.3 +++ b/upstream/archlinux/man3/strtoimax.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH strtoimax 3 2023-10-31 "Linux man-pages 6.06" +.TH strtoimax 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strtoimax, strtoumax \- convert string to integer .SH LIBRARY diff --git a/upstream/archlinux/man3/strtok.3 b/upstream/archlinux/man3/strtok.3 index 0c3bcd1b..d4928540 100644 --- a/upstream/archlinux/man3/strtok.3 +++ b/upstream/archlinux/man3/strtok.3 @@ -10,7 +10,7 @@ .\" 2005-11-17, mtk: Substantial parts rewritten .\" 2013-05-19, mtk: added much further detail on the operation of strtok() .\" -.TH strtok 3 2023-10-31 "Linux man-pages 6.06" +.TH strtok 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strtok, strtok_r \- extract tokens from strings .SH LIBRARY diff --git a/upstream/archlinux/man3/strtol.3 b/upstream/archlinux/man3/strtol.3 index 23ee7225..7f743cd0 100644 --- a/upstream/archlinux/man3/strtol.3 +++ b/upstream/archlinux/man3/strtol.3 @@ -10,7 +10,7 @@ .\" 386BSD man pages .\" Modified Sun Jul 25 10:53:39 1993 by Rik Faith (faith@cs.unc.edu) .\" Added correction due to nsd@bbc.com (Nick Duffek) - aeb, 950610 -.TH strtol 3 2023-12-19 "Linux man-pages 6.06" +.TH strtol 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strtol, strtoll, strtoq \- convert a string to a long integer .SH LIBRARY diff --git a/upstream/archlinux/man3/strtoul.3 b/upstream/archlinux/man3/strtoul.3 index 5982f732..a35df84f 100644 --- a/upstream/archlinux/man3/strtoul.3 +++ b/upstream/archlinux/man3/strtoul.3 @@ -11,7 +11,7 @@ .\" Fixed typo, aeb, 950823 .\" 2002-02-22, joey, mihtjel: Added strtoull() .\" -.TH strtoul 3 2023-12-19 "Linux man-pages 6.06" +.TH strtoul 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strtoul, strtoull, strtouq \- convert a string to an unsigned long integer .SH LIBRARY diff --git a/upstream/archlinux/man3/strverscmp.3 b/upstream/archlinux/man3/strverscmp.3 index 967da711..1ebd99c2 100644 --- a/upstream/archlinux/man3/strverscmp.3 +++ b/upstream/archlinux/man3/strverscmp.3 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH strverscmp 3 2023-10-31 "Linux man-pages 6.06" +.TH strverscmp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strverscmp \- compare two version strings .SH LIBRARY diff --git a/upstream/archlinux/man3/strxfrm.3 b/upstream/archlinux/man3/strxfrm.3 index 9fa0b971..d6968b76 100644 --- a/upstream/archlinux/man3/strxfrm.3 +++ b/upstream/archlinux/man3/strxfrm.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sun Jul 25 10:41:28 1993 by Rik Faith (faith@cs.unc.edu) -.TH strxfrm 3 2023-10-31 "Linux man-pages 6.06" +.TH strxfrm 3 2024-05-02 "Linux man-pages 6.8" .SH NAME strxfrm \- string transformation .SH LIBRARY diff --git a/upstream/archlinux/man3/swab.3 b/upstream/archlinux/man3/swab.3 index c4ecfa27..ea9720a8 100644 --- a/upstream/archlinux/man3/swab.3 +++ b/upstream/archlinux/man3/swab.3 @@ -9,7 +9,7 @@ .\" 386BSD man pages .\" Modified Sat Jul 24 17:52:15 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified 2001-12-15, aeb -.TH swab 3 2023-10-31 "Linux man-pages 6.06" +.TH swab 3 2024-05-02 "Linux man-pages 6.8" .SH NAME swab \- swap adjacent bytes .SH LIBRARY diff --git a/upstream/archlinux/man3/sysconf.3 b/upstream/archlinux/man3/sysconf.3 index e4e57b64..139d2ae5 100644 --- a/upstream/archlinux/man3/sysconf.3 +++ b/upstream/archlinux/man3/sysconf.3 @@ -5,7 +5,7 @@ .\" .\" Modified Sat Jul 24 17:51:42 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified Tue Aug 17 11:42:20 1999 by Ariel Scolnicov (ariels@compugen.co.il) -.TH sysconf 3 2023-10-31 "Linux man-pages 6.06" +.TH sysconf 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sysconf \- get configuration information at run time .SH LIBRARY diff --git a/upstream/archlinux/man3/syslog.3 b/upstream/archlinux/man3/syslog.3 index 485777f6..5c5a2eab 100644 --- a/upstream/archlinux/man3/syslog.3 +++ b/upstream/archlinux/man3/syslog.3 @@ -15,7 +15,7 @@ .\" Modified 13 Dec 2001, Martin Schulze <joey@infodrom.org> .\" Modified 3 Jan 2002, Michael Kerrisk <mtk.manpages@gmail.com> .\" -.TH syslog 3 2023-10-31 "Linux man-pages 6.06" +.TH syslog 3 2024-05-02 "Linux man-pages 6.8" .SH NAME closelog, openlog, syslog, vsyslog \- send messages to the system logger .SH LIBRARY diff --git a/upstream/archlinux/man3/system.3 b/upstream/archlinux/man3/system.3 index 29cfbc55..9f31bd92 100644 --- a/upstream/archlinux/man3/system.3 +++ b/upstream/archlinux/man3/system.3 @@ -9,7 +9,7 @@ .\" Modified 14 May 2001, 23 Sep 2001 by aeb .\" 2004-12-20, mtk .\" -.TH system 3 2023-10-31 "Linux man-pages 6.06" +.TH system 3 2024-05-02 "Linux man-pages 6.8" .SH NAME system \- execute a shell command .SH LIBRARY diff --git a/upstream/archlinux/man3/sysv_signal.3 b/upstream/archlinux/man3/sysv_signal.3 index f4351e07..00c34c8a 100644 --- a/upstream/archlinux/man3/sysv_signal.3 +++ b/upstream/archlinux/man3/sysv_signal.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH sysv_signal 3 2023-10-31 "Linux man-pages 6.06" +.TH sysv_signal 3 2024-05-02 "Linux man-pages 6.8" .SH NAME sysv_signal \- signal handling with System V semantics .SH LIBRARY diff --git a/upstream/archlinux/man3/tailq.3 b/upstream/archlinux/man3/tailq.3 index 8beecf04..865478d4 100644 --- a/upstream/archlinux/man3/tailq.3 +++ b/upstream/archlinux/man3/tailq.3 @@ -5,7 +5,7 @@ .\" SPDX-License-Identifier: BSD-3-Clause .\" .\" -.TH TAILQ 3 2023-10-31 "Linux man-pages 6.06" +.TH TAILQ 3 2024-05-02 "Linux man-pages 6.8" .SH NAME TAILQ_CONCAT, TAILQ_EMPTY, diff --git a/upstream/archlinux/man3/tan.3 b/upstream/archlinux/man3/tan.3 index bef7feee..7af7e2fa 100644 --- a/upstream/archlinux/man3/tan.3 +++ b/upstream/archlinux/man3/tan.3 @@ -13,7 +13,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH tan 3 2023-10-31 "Linux man-pages 6.06" +.TH tan 3 2024-05-02 "Linux man-pages 6.8" .SH NAME tan, tanf, tanl \- tangent function .SH LIBRARY diff --git a/upstream/archlinux/man3/tanh.3 b/upstream/archlinux/man3/tanh.3 index 9d9d194c..f2fd1966 100644 --- a/upstream/archlinux/man3/tanh.3 +++ b/upstream/archlinux/man3/tanh.3 @@ -13,7 +13,7 @@ .\" Modified 2002-07-27 by Walter Harms .\" (walter.harms@informatik.uni-oldenburg.de) .\" -.TH tanh 3 2023-10-31 "Linux man-pages 6.06" +.TH tanh 3 2024-05-02 "Linux man-pages 6.8" .SH NAME tanh, tanhf, tanhl \- hyperbolic tangent function .SH LIBRARY diff --git a/upstream/archlinux/man3/tcgetpgrp.3 b/upstream/archlinux/man3/tcgetpgrp.3 index 77e8f11b..76eec66b 100644 --- a/upstream/archlinux/man3/tcgetpgrp.3 +++ b/upstream/archlinux/man3/tcgetpgrp.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH tcgetpgrp 3 2023-10-31 "Linux man-pages 6.06" +.TH tcgetpgrp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME tcgetpgrp, tcsetpgrp \- get and set terminal foreground process group .SH LIBRARY diff --git a/upstream/archlinux/man3/tcgetsid.3 b/upstream/archlinux/man3/tcgetsid.3 index 959e75e8..e17140da 100644 --- a/upstream/archlinux/man3/tcgetsid.3 +++ b/upstream/archlinux/man3/tcgetsid.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH tcgetsid 3 2023-10-31 "Linux man-pages 6.06" +.TH tcgetsid 3 2024-05-02 "Linux man-pages 6.8" .SH NAME tcgetsid \- get session ID .SH LIBRARY diff --git a/upstream/archlinux/man3/telldir.3 b/upstream/archlinux/man3/telldir.3 index a15a7380..95535723 100644 --- a/upstream/archlinux/man3/telldir.3 +++ b/upstream/archlinux/man3/telldir.3 @@ -8,7 +8,7 @@ .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) .\" 386BSD man pages .\" Modified Sat Jul 24 17:48:42 1993 by Rik Faith (faith@cs.unc.edu) -.TH telldir 3 2023-10-31 "Linux man-pages 6.06" +.TH telldir 3 2024-05-02 "Linux man-pages 6.8" .SH NAME telldir \- return current location in directory stream .SH LIBRARY diff --git a/upstream/archlinux/man3/tempnam.3 b/upstream/archlinux/man3/tempnam.3 index 873b3ae8..0387e026 100644 --- a/upstream/archlinux/man3/tempnam.3 +++ b/upstream/archlinux/man3/tempnam.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH tempnam 3 2023-10-31 "Linux man-pages 6.06" +.TH tempnam 3 2024-05-02 "Linux man-pages 6.8" .SH NAME tempnam \- create a name for a temporary file .SH LIBRARY diff --git a/upstream/archlinux/man3/term_variables.3x b/upstream/archlinux/man3/term_variables.3x index 732f9650..f3be2290 100644 --- a/upstream/archlinux/man3/term_variables.3x +++ b/upstream/archlinux/man3/term_variables.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2022,2023 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 2010-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,64 +27,58 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: term_variables.3x,v 1.17 2023/01/02 12:17:34 tom Exp $ -.TH term_variables 3X "" -.ds n 5 -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' -.na -.hy 0 +.\" $Id: term_variables.3x,v 1.36 2024/03/16 15:35:01 tom Exp $ +.TH term_variables 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .SH NAME -\fBSP\fP, -\fBacs_map\fP, -\fBboolcodes\fP, -\fBboolfnames\fP, -\fBboolnames\fP, -\fBcur_term\fP, -\fBnumcodes\fP, -\fBnumfnames\fP, -\fBnumnames\fP, -\fBstrcodes\fP, -\fBstrfnames\fP, -\fBstrnames\fP, -\fBttytype\fP -\- \fBcurses\fP terminfo global variables -.ad -.hy +\fB\%SP\fP, +\fB\%acs_map\fP, +\fB\%boolcodes\fP, +\fB\%boolfnames\fP, +\fB\%boolnames\fP, +\fB\%cur_term\fP, +\fB\%numcodes\fP, +\fB\%numfnames\fP, +\fB\%numnames\fP, +\fB\%strcodes\fP, +\fB\%strfnames\fP, +\fB\%strnames\fP, +\fB\%ttytype\fP \- +\fIterminfo\fR global variables .SH SYNOPSIS .nf -\fB#include <curses.h>\fP -.br -\fB#include <term.h>\fP -.PP -\fBchtype acs_map[];\fP -.sp -\fBSCREEN * SP;\fP -.sp -\fBTERMINAL * cur_term;\fP -.sp -\fBchar ttytype[];\fP -.sp -\fBNCURSES_CONST char * const boolcodes[];\fP -.br -\fBNCURSES_CONST char * const boolfnames[];\fP -.br -\fBNCURSES_CONST char * const boolnames[];\fP -.sp -\fBNCURSES_CONST char * const numcodes[];\fP -.br -\fBNCURSES_CONST char * const numfnames[];\fP -.br -\fBNCURSES_CONST char * const numnames[];\fP -.sp -\fBNCURSES_CONST char * const strcodes[];\fP -.br -\fBNCURSES_CONST char * const strfnames[];\fP -.br -\fBNCURSES_CONST char * const strnames[];\fP -.br +\fB#include <curses.h> +\fB#include <term.h> +.PP +\fBchtype acs_map[]; +.PP +\fBSCREEN * SP; +.PP +\fBTERMINAL * cur_term; +.PP +\fBchar ttytype[]; +.PP +\fBNCURSES_CONST char * const boolcodes[]; +\fBNCURSES_CONST char * const boolfnames[]; +\fBNCURSES_CONST char * const boolnames[]; +.PP +\fBNCURSES_CONST char * const numcodes[]; +\fBNCURSES_CONST char * const numfnames[]; +\fBNCURSES_CONST char * const numnames[]; +.PP +\fBNCURSES_CONST char * const strcodes[]; +\fBNCURSES_CONST char * const strfnames[]; +\fBNCURSES_CONST char * const strnames[]; .fi .SH DESCRIPTION This page summarizes variables provided by the \fBcurses\fP library's @@ -96,7 +90,7 @@ or macros (see \fBcurs_threads\fP(3X)) which provide read-only access to \fIcurses\fP's state. In either case, applications should treat them as read-only to avoid confusing the library. -.SS Alternate Character Set Mapping +.SS "Alternate Character Set Mapping" After initializing the curses or terminfo interfaces, the \fBacs_map\fP array holds information used to translate cells with the \fBA_ALTCHARSET\fP video attribute into line-drawing characters. @@ -106,7 +100,7 @@ Application developers need only know that it is used for the \*(``ACS_\*('' constants in <curses.h>. .PP The comparable data for the wide-character library is a private variable. -.SS Current Terminal Data +.SS "Current Terminal Data" After initializing the curses or terminfo interfaces, the \fBcur_term\fP contains data describing the current terminal. This variable is also set as a side-effect of \fBset_term\fP(3X) @@ -116,7 +110,7 @@ It is possible to save a value of \fBcur_term\fP for subsequent use as a parameter to \fBset_term\fP, for switching between screens. Alternatively, one can save the return value from \fBnewterm\fP or \fBsetupterm\fP(3X) to reuse in \fBset_term\fP. -.SS Terminfo Lookup Tables +.SS "\fIterminfo\fP Lookup Tables" The \fBtic\fP(1) and \fBinfocmp\fP(1) programs use lookup tables for the long and short names of terminfo capabilities, as well as the corresponding names for termcap capabilities. @@ -139,24 +133,21 @@ These are the corresponding names used for termcap descriptions: \fBnumcodes\fP, and \fBstrcodes\fP. .\" -.SS Terminal Type +.SS "Terminal Type" A terminal description begins with one or more terminal names separated by \*(``|\*('' (vertical bars). On initialization of the curses or terminfo interfaces, \fBsetupterm\fP(3X) copies the terminal names to the array \fBttytype\fP. .\" -.SS Terminfo Names -.PP +.SS "\fIterminfo\fP Names" In addition to the variables, \fB<term.h>\fP also defines a symbol for each terminfo capability \fIlong name\fP. These are in terms of the symbol \fBCUR\fP, which is defined .PP -.nf -.ft CW -#define CUR ((TERMTYPE *)(cur_term))-> -.fi -.ft R +.EX +#define CUR ((TERMTYPE *)(cur_term))\-> +.EE .PP These symbols provide a faster method of accessing terminfo capabilities than using \fBtigetstr\fP(3X), etc. @@ -167,9 +158,7 @@ into the current terminal description loaded into memory. .\" .SH NOTES The low-level terminfo interface is initialized using -.hy 0 -\fBsetupterm\fP(3X). -.hy +\fB\%setupterm\fP(3X). The upper-level curses interface uses the low-level terminfo interface, internally. .\" @@ -186,9 +175,7 @@ All implementations which provide terminfo interfaces add definitions as described in the \fBTerminfo Names\fP section. Most, but not all, base the definition upon the \fBcur_term\fP variable. .SH SEE ALSO -.hy 0 -\fBcurses\fP(3X), -\fBcurs_terminfo\fP(3X), -\fBcurs_threads\fP(3X), -\fBterminfo\fP(\*n). -.hy +\fB\%curses\fP(3X), +\fB\%curs_terminfo\fP(3X), +\fB\%curs_threads\fP(3X), +\fB\%terminfo\fP(5) diff --git a/upstream/archlinux/man3/termios.3 b/upstream/archlinux/man3/termios.3 index 78523a2e..24902b3c 100644 --- a/upstream/archlinux/man3/termios.3 +++ b/upstream/archlinux/man3/termios.3 @@ -19,7 +19,7 @@ .\" Enhanced the discussion of "raw" mode for cfmakeraw(). .\" Document CMSPAR. .\" -.TH termios 3 2023-10-31 "Linux man-pages 6.06" +.TH termios 3 2024-05-02 "Linux man-pages 6.8" .SH NAME termios, tcgetattr, tcsetattr, tcsendbreak, tcdrain, tcflush, tcflow, cfmakeraw, cfgetospeed, cfgetispeed, cfsetispeed, cfsetospeed, cfsetspeed \- diff --git a/upstream/archlinux/man3/textdomain.3 b/upstream/archlinux/man3/textdomain.3 index aed23921..49d7dfc4 100644 --- a/upstream/archlinux/man3/textdomain.3 +++ b/upstream/archlinux/man3/textdomain.3 @@ -10,7 +10,7 @@ .\" GNU gettext source code and manual .\" LI18NUX 2000 Globalization Specification .\" -.TH TEXTDOMAIN 3 "May 2001" "GNU gettext 0.22.2" +.TH TEXTDOMAIN 3 "May 2001" "GNU gettext 0.22.5" .SH NAME textdomain \- set domain for future gettext() calls .SH SYNOPSIS diff --git a/upstream/archlinux/man3/tgamma.3 b/upstream/archlinux/man3/tgamma.3 index 89bab480..64df8357 100644 --- a/upstream/archlinux/man3/tgamma.3 +++ b/upstream/archlinux/man3/tgamma.3 @@ -9,7 +9,7 @@ .\" Modified 2004-11-15, fixed error noted by Fabian Kreutz .\" <kreutz@dbs.uni-hannover.de> .\" -.TH tgamma 3 2023-10-31 "Linux man-pages 6.06" +.TH tgamma 3 2024-05-02 "Linux man-pages 6.8" .SH NAME tgamma, tgammaf, tgammal \- true gamma function .SH LIBRARY diff --git a/upstream/archlinux/man3/timegm.3 b/upstream/archlinux/man3/timegm.3 index a521333b..efabc06f 100644 --- a/upstream/archlinux/man3/timegm.3 +++ b/upstream/archlinux/man3/timegm.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH timegm 3 2023-10-31 "Linux man-pages 6.06" +.TH timegm 3 2024-05-02 "Linux man-pages 6.8" .SH NAME timegm, timelocal \- inverses of gmtime and localtime .SH LIBRARY diff --git a/upstream/archlinux/man3/timeradd.3 b/upstream/archlinux/man3/timeradd.3 index 3f317b52..cbeda280 100644 --- a/upstream/archlinux/man3/timeradd.3 +++ b/upstream/archlinux/man3/timeradd.3 @@ -4,7 +4,7 @@ .\" .\" 2007-07-31, mtk, Created .\" -.TH timeradd 3 2023-10-31 "Linux man-pages 6.06" +.TH timeradd 3 2024-05-02 "Linux man-pages 6.8" .SH NAME timeradd, timersub, timercmp, timerclear, timerisset \- timeval operations .SH LIBRARY diff --git a/upstream/archlinux/man3/tmpfile.3 b/upstream/archlinux/man3/tmpfile.3 index 6dd760ba..65ba2483 100644 --- a/upstream/archlinux/man3/tmpfile.3 +++ b/upstream/archlinux/man3/tmpfile.3 @@ -9,7 +9,7 @@ .\" 386BSD man pages .\" Modified Sat Jul 24 17:46:57 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified 2001-11-17, aeb -.TH tmpfile 3 2023-10-31 "Linux man-pages 6.06" +.TH tmpfile 3 2024-05-02 "Linux man-pages 6.8" .SH NAME tmpfile \- create a temporary file .SH LIBRARY diff --git a/upstream/archlinux/man3/tmpnam.3 b/upstream/archlinux/man3/tmpnam.3 index 13799eea..f1fc8676 100644 --- a/upstream/archlinux/man3/tmpnam.3 +++ b/upstream/archlinux/man3/tmpnam.3 @@ -5,7 +5,7 @@ .\" .\" 2003-11-15, aeb, added tmpnam_r .\" -.TH tmpnam 3 2023-10-31 "Linux man-pages 6.06" +.TH tmpnam 3 2024-05-02 "Linux man-pages 6.8" .SH NAME tmpnam, tmpnam_r \- create a name for a temporary file .SH LIBRARY diff --git a/upstream/archlinux/man3/toascii.3 b/upstream/archlinux/man3/toascii.3 index 245b3ab3..ba7ed8a0 100644 --- a/upstream/archlinux/man3/toascii.3 +++ b/upstream/archlinux/man3/toascii.3 @@ -5,7 +5,7 @@ .\" .\" Added BUGS section, aeb, 950919 .\" -.TH toascii 3 2023-10-31 "Linux man-pages 6.06" +.TH toascii 3 2024-05-02 "Linux man-pages 6.8" .SH NAME toascii \- convert character to ASCII .SH LIBRARY diff --git a/upstream/archlinux/man3/toupper.3 b/upstream/archlinux/man3/toupper.3 index 05cfdc51..4f8102c9 100644 --- a/upstream/archlinux/man3/toupper.3 +++ b/upstream/archlinux/man3/toupper.3 @@ -6,7 +6,7 @@ .\" .\" Modified Sat Jul 24 17:45:39 1993 by Rik Faith (faith@cs.unc.edu) .\" Modified 2000-02-13 by Nicolás Lichtmaier <nick@debian.org> -.TH toupper 3 2023-10-31 "Linux man-pages 6.06" +.TH toupper 3 2024-05-02 "Linux man-pages 6.8" .SH NAME toupper, tolower, toupper_l, tolower_l \- convert uppercase or lowercase .SH LIBRARY @@ -166,7 +166,7 @@ yielding a value that is outside the range of The details of what constitutes an uppercase or lowercase letter depend on the locale. For example, the default -.B """C""" +.B \[dq]C\[dq] locale does not know about umlauts, so no conversion is done for them. .P In some non-English locales, there are lowercase letters with no diff --git a/upstream/archlinux/man3/towctrans.3 b/upstream/archlinux/man3/towctrans.3 index e122d59c..9861ca42 100644 --- a/upstream/archlinux/man3/towctrans.3 +++ b/upstream/archlinux/man3/towctrans.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH towctrans 3 2023-10-31 "Linux man-pages 6.06" +.TH towctrans 3 2024-05-02 "Linux man-pages 6.8" .SH NAME towctrans \- wide-character transliteration .SH LIBRARY diff --git a/upstream/archlinux/man3/towlower.3 b/upstream/archlinux/man3/towlower.3 index 1e4d1d26..136a3fca 100644 --- a/upstream/archlinux/man3/towlower.3 +++ b/upstream/archlinux/man3/towlower.3 @@ -10,7 +10,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH towlower 3 2023-10-31 "Linux man-pages 6.06" +.TH towlower 3 2024-05-02 "Linux man-pages 6.8" .SH NAME towlower, towlower_l \- convert a wide character to lowercase .SH LIBRARY diff --git a/upstream/archlinux/man3/towupper.3 b/upstream/archlinux/man3/towupper.3 index d3c77d9b..78d94117 100644 --- a/upstream/archlinux/man3/towupper.3 +++ b/upstream/archlinux/man3/towupper.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH towupper 3 2023-10-31 "Linux man-pages 6.06" +.TH towupper 3 2024-05-02 "Linux man-pages 6.8" .SH NAME towupper, towupper_l \- convert a wide character to uppercase .SH LIBRARY diff --git a/upstream/archlinux/man3/trunc.3 b/upstream/archlinux/man3/trunc.3 index e609aa89..95b86914 100644 --- a/upstream/archlinux/man3/trunc.3 +++ b/upstream/archlinux/man3/trunc.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH trunc 3 2023-10-31 "Linux man-pages 6.06" +.TH trunc 3 2024-05-02 "Linux man-pages 6.8" .SH NAME trunc, truncf, truncl \- round to integer, toward zero .SH LIBRARY diff --git a/upstream/archlinux/man3/tsearch.3 b/upstream/archlinux/man3/tsearch.3 index 933a3bed..f2642741 100644 --- a/upstream/archlinux/man3/tsearch.3 +++ b/upstream/archlinux/man3/tsearch.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH tsearch 3 2023-10-31 "Linux man-pages 6.06" +.TH tsearch 3 2024-05-02 "Linux man-pages 6.8" .SH NAME tsearch, tfind, tdelete, twalk, twalk_r, tdestroy \- manage a binary search tree .SH LIBRARY diff --git a/upstream/archlinux/man3/ttyname.3 b/upstream/archlinux/man3/ttyname.3 index 9007204d..6f743666 100644 --- a/upstream/archlinux/man3/ttyname.3 +++ b/upstream/archlinux/man3/ttyname.3 @@ -6,7 +6,7 @@ .\" Modified 2001-12-13, Martin Schulze <joey@infodrom.org> .\" Added ttyname_r, aeb, 2002-07-20 .\" -.TH ttyname 3 2023-10-31 "Linux man-pages 6.06" +.TH ttyname 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ttyname, ttyname_r \- return name of a terminal .SH LIBRARY diff --git a/upstream/archlinux/man3/ttyslot.3 b/upstream/archlinux/man3/ttyslot.3 index a36f186f..7e17868b 100644 --- a/upstream/archlinux/man3/ttyslot.3 +++ b/upstream/archlinux/man3/ttyslot.3 @@ -6,7 +6,7 @@ .\" This replaces an earlier man page written by Walter Harms .\" <walter.harms@informatik.uni-oldenburg.de>. .\" -.TH ttyslot 3 2023-10-31 "Linux man-pages 6.06" +.TH ttyslot 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ttyslot \- find the slot of the current user's terminal in some file .SH LIBRARY diff --git a/upstream/archlinux/man3/tzset.3 b/upstream/archlinux/man3/tzset.3 index 3ef33fd4..1048286b 100644 --- a/upstream/archlinux/man3/tzset.3 +++ b/upstream/archlinux/man3/tzset.3 @@ -11,7 +11,7 @@ .\" Modified 2001-11-13, aeb .\" Modified 2004-12-01 mtk and Martin Schulze <joey@infodrom.org> .\" -.TH tzset 3 2023-10-31 "Linux man-pages 6.06" +.TH tzset 3 2024-05-02 "Linux man-pages 6.8" .SH NAME tzset, tzname, timezone, daylight \- initialize time conversion information .SH LIBRARY diff --git a/upstream/archlinux/man3/ualarm.3 b/upstream/archlinux/man3/ualarm.3 index 622c7cef..333ca503 100644 --- a/upstream/archlinux/man3/ualarm.3 +++ b/upstream/archlinux/man3/ualarm.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH ualarm 3 2023-10-31 "Linux man-pages 6.06" +.TH ualarm 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ualarm \- schedule signal after given number of microseconds .SH LIBRARY diff --git a/upstream/archlinux/man3/ulimit.3 b/upstream/archlinux/man3/ulimit.3 index ff8c64fa..ba0bf3fb 100644 --- a/upstream/archlinux/man3/ulimit.3 +++ b/upstream/archlinux/man3/ulimit.3 @@ -5,7 +5,7 @@ .\" .\" Moved to man3, aeb, 980612 .\" -.TH ulimit 3 2023-10-31 "Linux man-pages 6.06" +.TH ulimit 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ulimit \- get and set user limits .SH LIBRARY diff --git a/upstream/archlinux/man3/undocumented.3 b/upstream/archlinux/man3/undocumented.3 index 6fab6b27..703b861b 100644 --- a/upstream/archlinux/man3/undocumented.3 +++ b/upstream/archlinux/man3/undocumented.3 @@ -7,7 +7,7 @@ .\" 2004-10-31, aeb, changed maintainer address, updated list .\" 2015-04-20, william@tuffbizz.com, updated list .\" -.TH undocumented 3 2022-10-30 "Linux man-pages 6.06" +.TH undocumented 3 2024-05-02 "Linux man-pages 6.8" .SH NAME undocumented \- undocumented library functions .SH SYNOPSIS diff --git a/upstream/archlinux/man3/ungetwc.3 b/upstream/archlinux/man3/ungetwc.3 index 4aaff0a2..a3b9c27d 100644 --- a/upstream/archlinux/man3/ungetwc.3 +++ b/upstream/archlinux/man3/ungetwc.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH ungetwc 3 2023-10-31 "Linux man-pages 6.06" +.TH ungetwc 3 2024-05-02 "Linux man-pages 6.8" .SH NAME ungetwc \- push back a wide character onto a FILE stream .SH LIBRARY diff --git a/upstream/archlinux/man3/unlocked_stdio.3 b/upstream/archlinux/man3/unlocked_stdio.3 index 7cc6f023..7ea5f26e 100644 --- a/upstream/archlinux/man3/unlocked_stdio.3 +++ b/upstream/archlinux/man3/unlocked_stdio.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH unlocked_stdio 3 2023-10-31 "Linux man-pages 6.06" +.TH unlocked_stdio 3 2024-05-02 "Linux man-pages 6.8" .SH NAME getc_unlocked, getchar_unlocked, putc_unlocked, putchar_unlocked \- nonlocking stdio functions diff --git a/upstream/archlinux/man3/unlockpt.3 b/upstream/archlinux/man3/unlockpt.3 index 9d173ace..f3507858 100644 --- a/upstream/archlinux/man3/unlockpt.3 +++ b/upstream/archlinux/man3/unlockpt.3 @@ -3,7 +3,7 @@ .\" This page is in the public domain. - aeb .\" %%%LICENSE_END .\" -.TH unlockpt 3 2023-10-31 "Linux man-pages 6.06" +.TH unlockpt 3 2024-05-02 "Linux man-pages 6.8" .SH NAME unlockpt \- unlock a pseudoterminal master/slave pair .SH LIBRARY diff --git a/upstream/archlinux/man3/updwtmp.3 b/upstream/archlinux/man3/updwtmp.3 index a2dc7da2..6949a628 100644 --- a/upstream/archlinux/man3/updwtmp.3 +++ b/upstream/archlinux/man3/updwtmp.3 @@ -8,7 +8,7 @@ .\" Added -lutil remark, 030718 .\" 2008-07-02, mtk, document updwtmpx() .\" -.TH updwtmp 3 2023-10-31 "Linux man-pages 6.06" +.TH updwtmp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME updwtmp, logwtmp \- append an entry to the wtmp file .SH LIBRARY diff --git a/upstream/archlinux/man3/uselocale.3 b/upstream/archlinux/man3/uselocale.3 index c0d632d3..f8d1e4e9 100644 --- a/upstream/archlinux/man3/uselocale.3 +++ b/upstream/archlinux/man3/uselocale.3 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH uselocale 3 2023-10-31 "Linux man-pages 6.06" +.TH uselocale 3 2024-05-02 "Linux man-pages 6.8" .SH NAME uselocale \- set/get the locale for the calling thread .SH LIBRARY diff --git a/upstream/archlinux/man3/usleep.3 b/upstream/archlinux/man3/usleep.3 index 34c09a03..9a5d7633 100644 --- a/upstream/archlinux/man3/usleep.3 +++ b/upstream/archlinux/man3/usleep.3 @@ -11,7 +11,7 @@ .\" Modified 2001-04-01 by aeb .\" Modified 2003-07-23 by aeb .\" -.TH usleep 3 2023-10-31 "Linux man-pages 6.06" +.TH usleep 3 2024-05-02 "Linux man-pages 6.8" .SH NAME usleep \- suspend execution for microsecond intervals .SH LIBRARY diff --git a/upstream/archlinux/man3/wcpcpy.3 b/upstream/archlinux/man3/wcpcpy.3 index ed3c86c9..65c752bc 100644 --- a/upstream/archlinux/man3/wcpcpy.3 +++ b/upstream/archlinux/man3/wcpcpy.3 @@ -8,7 +8,7 @@ .\" Dinkumware C library reference http://www.dinkumware.com/ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" -.TH wcpcpy 3 2023-10-31 "Linux man-pages 6.06" +.TH wcpcpy 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcpcpy \- copy a wide-character string, returning a pointer to its end .SH LIBRARY diff --git a/upstream/archlinux/man3/wcpncpy.3 b/upstream/archlinux/man3/wcpncpy.3 index b1530beb..998c49b4 100644 --- a/upstream/archlinux/man3/wcpncpy.3 +++ b/upstream/archlinux/man3/wcpncpy.3 @@ -8,7 +8,7 @@ .\" Dinkumware C library reference http://www.dinkumware.com/ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" -.TH wcpncpy 3 2023-10-31 "Linux man-pages 6.06" +.TH wcpncpy 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcpncpy \- copy a fixed-size string of wide characters, returning a pointer to its end diff --git a/upstream/archlinux/man3/wcrtomb.3 b/upstream/archlinux/man3/wcrtomb.3 index af44f7ed..d76c1228 100644 --- a/upstream/archlinux/man3/wcrtomb.3 +++ b/upstream/archlinux/man3/wcrtomb.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcrtomb 3 2023-10-31 "Linux man-pages 6.06" +.TH wcrtomb 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcrtomb \- convert a wide character to a multibyte sequence .SH LIBRARY diff --git a/upstream/archlinux/man3/wcscasecmp.3 b/upstream/archlinux/man3/wcscasecmp.3 index 672eaca9..070ea0fc 100644 --- a/upstream/archlinux/man3/wcscasecmp.3 +++ b/upstream/archlinux/man3/wcscasecmp.3 @@ -8,7 +8,7 @@ .\" Dinkumware C library reference http://www.dinkumware.com/ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" -.TH wcscasecmp 3 2023-10-31 "Linux man-pages 6.06" +.TH wcscasecmp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcscasecmp \- compare two wide-character strings, ignoring case .SH LIBRARY diff --git a/upstream/archlinux/man3/wcscat.3 b/upstream/archlinux/man3/wcscat.3 index c77e5e7c..e23e7d16 100644 --- a/upstream/archlinux/man3/wcscat.3 +++ b/upstream/archlinux/man3/wcscat.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcscat 3 2023-10-31 "Linux man-pages 6.06" +.TH wcscat 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcscat \- concatenate two wide-character strings .SH LIBRARY diff --git a/upstream/archlinux/man3/wcschr.3 b/upstream/archlinux/man3/wcschr.3 index 1838cb1f..703ef171 100644 --- a/upstream/archlinux/man3/wcschr.3 +++ b/upstream/archlinux/man3/wcschr.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcschr 3 2023-10-31 "Linux man-pages 6.06" +.TH wcschr 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcschr \- search a wide character in a wide-character string .SH LIBRARY diff --git a/upstream/archlinux/man3/wcscmp.3 b/upstream/archlinux/man3/wcscmp.3 index 82df840c..5e72b9e2 100644 --- a/upstream/archlinux/man3/wcscmp.3 +++ b/upstream/archlinux/man3/wcscmp.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcscmp 3 2023-10-31 "Linux man-pages 6.06" +.TH wcscmp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcscmp \- compare two wide-character strings .SH LIBRARY diff --git a/upstream/archlinux/man3/wcscpy.3 b/upstream/archlinux/man3/wcscpy.3 index 0c90e9be..0d0c393b 100644 --- a/upstream/archlinux/man3/wcscpy.3 +++ b/upstream/archlinux/man3/wcscpy.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcscpy 3 2023-10-31 "Linux man-pages 6.06" +.TH wcscpy 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcscpy \- copy a wide-character string .SH LIBRARY diff --git a/upstream/archlinux/man3/wcscspn.3 b/upstream/archlinux/man3/wcscspn.3 index 84b0dc81..4474a9d9 100644 --- a/upstream/archlinux/man3/wcscspn.3 +++ b/upstream/archlinux/man3/wcscspn.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcscspn 3 2023-10-31 "Linux man-pages 6.06" +.TH wcscspn 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcscspn \- search a wide-character string for any of a set of wide characters .SH LIBRARY diff --git a/upstream/archlinux/man3/wcsdup.3 b/upstream/archlinux/man3/wcsdup.3 index da85a6de..09715dfc 100644 --- a/upstream/archlinux/man3/wcsdup.3 +++ b/upstream/archlinux/man3/wcsdup.3 @@ -8,7 +8,7 @@ .\" Dinkumware C library reference http://www.dinkumware.com/ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" -.TH wcsdup 3 2023-10-31 "Linux man-pages 6.06" +.TH wcsdup 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcsdup \- duplicate a wide-character string .SH LIBRARY diff --git a/upstream/archlinux/man3/wcslen.3 b/upstream/archlinux/man3/wcslen.3 index 4481bcf8..03b71692 100644 --- a/upstream/archlinux/man3/wcslen.3 +++ b/upstream/archlinux/man3/wcslen.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcslen 3 2023-10-31 "Linux man-pages 6.06" +.TH wcslen 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcslen \- determine the length of a wide-character string .SH LIBRARY diff --git a/upstream/archlinux/man3/wcsncasecmp.3 b/upstream/archlinux/man3/wcsncasecmp.3 index 4107beb1..a1b29249 100644 --- a/upstream/archlinux/man3/wcsncasecmp.3 +++ b/upstream/archlinux/man3/wcsncasecmp.3 @@ -8,7 +8,7 @@ .\" Dinkumware C library reference http://www.dinkumware.com/ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" -.TH wcsncasecmp 3 2023-10-31 "Linux man-pages 6.06" +.TH wcsncasecmp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcsncasecmp \- compare two fixed-size wide-character strings, ignoring case .SH LIBRARY diff --git a/upstream/archlinux/man3/wcsncat.3 b/upstream/archlinux/man3/wcsncat.3 index e2e18414..e1320b7a 100644 --- a/upstream/archlinux/man3/wcsncat.3 +++ b/upstream/archlinux/man3/wcsncat.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcsncat 3 2023-10-31 "Linux man-pages 6.06" +.TH wcsncat 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcsncat \- concatenate two wide-character strings .SH LIBRARY diff --git a/upstream/archlinux/man3/wcsncmp.3 b/upstream/archlinux/man3/wcsncmp.3 index f6f87600..8acfc003 100644 --- a/upstream/archlinux/man3/wcsncmp.3 +++ b/upstream/archlinux/man3/wcsncmp.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcsncmp 3 2023-10-31 "Linux man-pages 6.06" +.TH wcsncmp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcsncmp \- compare two fixed-size wide-character strings .SH LIBRARY diff --git a/upstream/archlinux/man3/wcsncpy.3 b/upstream/archlinux/man3/wcsncpy.3 index 247e9aaf..6a6a15d1 100644 --- a/upstream/archlinux/man3/wcsncpy.3 +++ b/upstream/archlinux/man3/wcsncpy.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcsncpy 3 2023-10-31 "Linux man-pages 6.06" +.TH wcsncpy 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcsncpy \- copy a fixed-size string of wide characters .SH LIBRARY diff --git a/upstream/archlinux/man3/wcsnlen.3 b/upstream/archlinux/man3/wcsnlen.3 index 3398b601..d43987c7 100644 --- a/upstream/archlinux/man3/wcsnlen.3 +++ b/upstream/archlinux/man3/wcsnlen.3 @@ -8,7 +8,7 @@ .\" Dinkumware C library reference http://www.dinkumware.com/ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" -.TH wcsnlen 3 2023-10-31 "Linux man-pages 6.06" +.TH wcsnlen 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcsnlen \- determine the length of a fixed-size wide-character string .SH LIBRARY diff --git a/upstream/archlinux/man3/wcsnrtombs.3 b/upstream/archlinux/man3/wcsnrtombs.3 index 44241532..fd68ee37 100644 --- a/upstream/archlinux/man3/wcsnrtombs.3 +++ b/upstream/archlinux/man3/wcsnrtombs.3 @@ -8,7 +8,7 @@ .\" Dinkumware C library reference http://www.dinkumware.com/ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" -.TH wcsnrtombs 3 2023-10-31 "Linux man-pages 6.06" +.TH wcsnrtombs 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcsnrtombs \- convert a wide-character string to a multibyte string .SH LIBRARY diff --git a/upstream/archlinux/man3/wcspbrk.3 b/upstream/archlinux/man3/wcspbrk.3 index 2cd60cc5..49170439 100644 --- a/upstream/archlinux/man3/wcspbrk.3 +++ b/upstream/archlinux/man3/wcspbrk.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcspbrk 3 2023-10-31 "Linux man-pages 6.06" +.TH wcspbrk 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcspbrk \- search a wide-character string for any of a set of wide characters .SH LIBRARY diff --git a/upstream/archlinux/man3/wcsrchr.3 b/upstream/archlinux/man3/wcsrchr.3 index 8345be8f..97b6dc4f 100644 --- a/upstream/archlinux/man3/wcsrchr.3 +++ b/upstream/archlinux/man3/wcsrchr.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcsrchr 3 2023-10-31 "Linux man-pages 6.06" +.TH wcsrchr 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcsrchr \- search a wide character in a wide-character string .SH LIBRARY diff --git a/upstream/archlinux/man3/wcsrtombs.3 b/upstream/archlinux/man3/wcsrtombs.3 index fdcecdc7..8af68d5e 100644 --- a/upstream/archlinux/man3/wcsrtombs.3 +++ b/upstream/archlinux/man3/wcsrtombs.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcsrtombs 3 2023-10-31 "Linux man-pages 6.06" +.TH wcsrtombs 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcsrtombs \- convert a wide-character string to a multibyte string .SH LIBRARY diff --git a/upstream/archlinux/man3/wcsspn.3 b/upstream/archlinux/man3/wcsspn.3 index 6c5279f2..4f7c754e 100644 --- a/upstream/archlinux/man3/wcsspn.3 +++ b/upstream/archlinux/man3/wcsspn.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcsspn 3 2023-10-31 "Linux man-pages 6.06" +.TH wcsspn 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcsspn \- get length of a prefix wide-character substring .SH LIBRARY diff --git a/upstream/archlinux/man3/wcsstr.3 b/upstream/archlinux/man3/wcsstr.3 index b4aee784..7ba722fd 100644 --- a/upstream/archlinux/man3/wcsstr.3 +++ b/upstream/archlinux/man3/wcsstr.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcsstr 3 2023-10-31 "Linux man-pages 6.06" +.TH wcsstr 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcsstr \- locate a substring in a wide-character string .SH LIBRARY diff --git a/upstream/archlinux/man3/wcstoimax.3 b/upstream/archlinux/man3/wcstoimax.3 index 32e52e92..c2a7269a 100644 --- a/upstream/archlinux/man3/wcstoimax.3 +++ b/upstream/archlinux/man3/wcstoimax.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH wcstoimax 3 2023-10-31 "Linux man-pages 6.06" +.TH wcstoimax 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcstoimax, wcstoumax \- convert wide-character string to integer .SH LIBRARY diff --git a/upstream/archlinux/man3/wcstok.3 b/upstream/archlinux/man3/wcstok.3 index 1f7a98be..a604d014 100644 --- a/upstream/archlinux/man3/wcstok.3 +++ b/upstream/archlinux/man3/wcstok.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcstok 3 2023-10-31 "Linux man-pages 6.06" +.TH wcstok 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcstok \- split wide-character string into tokens .SH LIBRARY diff --git a/upstream/archlinux/man3/wcstombs.3 b/upstream/archlinux/man3/wcstombs.3 index 7f0fe451..82a1ca61 100644 --- a/upstream/archlinux/man3/wcstombs.3 +++ b/upstream/archlinux/man3/wcstombs.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wcstombs 3 2023-10-31 "Linux man-pages 6.06" +.TH wcstombs 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcstombs \- convert a wide-character string to a multibyte string .SH LIBRARY diff --git a/upstream/archlinux/man3/wcswidth.3 b/upstream/archlinux/man3/wcswidth.3 index 6d3e40a4..074d3018 100644 --- a/upstream/archlinux/man3/wcswidth.3 +++ b/upstream/archlinux/man3/wcswidth.3 @@ -8,7 +8,7 @@ .\" Dinkumware C library reference http://www.dinkumware.com/ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" -.TH wcswidth 3 2023-10-31 "Linux man-pages 6.06" +.TH wcswidth 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcswidth \- determine columns needed for a fixed-size wide-character string .SH LIBRARY diff --git a/upstream/archlinux/man3/wctob.3 b/upstream/archlinux/man3/wctob.3 index 09341731..3abfa168 100644 --- a/upstream/archlinux/man3/wctob.3 +++ b/upstream/archlinux/man3/wctob.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wctob 3 2023-10-31 "Linux man-pages 6.06" +.TH wctob 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wctob \- try to represent a wide character as a single byte .SH LIBRARY diff --git a/upstream/archlinux/man3/wctomb.3 b/upstream/archlinux/man3/wctomb.3 index 6b3a9e96..c2ea5446 100644 --- a/upstream/archlinux/man3/wctomb.3 +++ b/upstream/archlinux/man3/wctomb.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wctomb 3 2023-10-31 "Linux man-pages 6.06" +.TH wctomb 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wctomb \- convert a wide character to a multibyte sequence .SH LIBRARY diff --git a/upstream/archlinux/man3/wctrans.3 b/upstream/archlinux/man3/wctrans.3 index 29ccf308..369d5256 100644 --- a/upstream/archlinux/man3/wctrans.3 +++ b/upstream/archlinux/man3/wctrans.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wctrans 3 2023-10-31 "Linux man-pages 6.06" +.TH wctrans 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wctrans \- wide-character translation mapping .SH LIBRARY diff --git a/upstream/archlinux/man3/wctype.3 b/upstream/archlinux/man3/wctype.3 index 4a1bcab4..e4a87c8f 100644 --- a/upstream/archlinux/man3/wctype.3 +++ b/upstream/archlinux/man3/wctype.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wctype 3 2023-10-31 "Linux man-pages 6.06" +.TH wctype 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wctype \- wide-character classification .SH LIBRARY diff --git a/upstream/archlinux/man3/wcwidth.3 b/upstream/archlinux/man3/wcwidth.3 index 9397d141..51f0ed78 100644 --- a/upstream/archlinux/man3/wcwidth.3 +++ b/upstream/archlinux/man3/wcwidth.3 @@ -8,7 +8,7 @@ .\" Dinkumware C library reference http://www.dinkumware.com/ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" -.TH wcwidth 3 2023-10-31 "Linux man-pages 6.06" +.TH wcwidth 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wcwidth \- determine columns needed for a wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/wmemchr.3 b/upstream/archlinux/man3/wmemchr.3 index 9770d896..baa46a33 100644 --- a/upstream/archlinux/man3/wmemchr.3 +++ b/upstream/archlinux/man3/wmemchr.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wmemchr 3 2023-10-31 "Linux man-pages 6.06" +.TH wmemchr 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wmemchr \- search a wide character in a wide-character array .SH LIBRARY diff --git a/upstream/archlinux/man3/wmemcmp.3 b/upstream/archlinux/man3/wmemcmp.3 index 6687199a..3372a1f8 100644 --- a/upstream/archlinux/man3/wmemcmp.3 +++ b/upstream/archlinux/man3/wmemcmp.3 @@ -8,7 +8,7 @@ .\" Dinkumware C library reference http://www.dinkumware.com/ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" -.TH wmemcmp 3 2023-10-31 "Linux man-pages 6.06" +.TH wmemcmp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wmemcmp \- compare two arrays of wide-characters .SH LIBRARY diff --git a/upstream/archlinux/man3/wmemcpy.3 b/upstream/archlinux/man3/wmemcpy.3 index 59043b86..65cf5c67 100644 --- a/upstream/archlinux/man3/wmemcpy.3 +++ b/upstream/archlinux/man3/wmemcpy.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wmemcpy 3 2023-10-31 "Linux man-pages 6.06" +.TH wmemcpy 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wmemcpy \- copy an array of wide-characters .SH LIBRARY diff --git a/upstream/archlinux/man3/wmemmove.3 b/upstream/archlinux/man3/wmemmove.3 index bee481bf..c4ab2a21 100644 --- a/upstream/archlinux/man3/wmemmove.3 +++ b/upstream/archlinux/man3/wmemmove.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wmemmove 3 2023-10-31 "Linux man-pages 6.06" +.TH wmemmove 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wmemmove \- copy an array of wide-characters .SH LIBRARY diff --git a/upstream/archlinux/man3/wmemset.3 b/upstream/archlinux/man3/wmemset.3 index dd844337..16f6eb27 100644 --- a/upstream/archlinux/man3/wmemset.3 +++ b/upstream/archlinux/man3/wmemset.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wmemset 3 2023-10-31 "Linux man-pages 6.06" +.TH wmemset 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wmemset \- fill an array of wide-characters with a constant wide character .SH LIBRARY diff --git a/upstream/archlinux/man3/wordexp.3 b/upstream/archlinux/man3/wordexp.3 index ef666a17..86d87ea7 100644 --- a/upstream/archlinux/man3/wordexp.3 +++ b/upstream/archlinux/man3/wordexp.3 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH wordexp 3 2023-10-31 "Linux man-pages 6.06" +.TH wordexp 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wordexp, wordfree \- perform word expansion like a posix-shell .SH LIBRARY diff --git a/upstream/archlinux/man3/wprintf.3 b/upstream/archlinux/man3/wprintf.3 index 757b74e5..be0224ca 100644 --- a/upstream/archlinux/man3/wprintf.3 +++ b/upstream/archlinux/man3/wprintf.3 @@ -9,7 +9,7 @@ .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html .\" ISO/IEC 9899:1999 .\" -.TH wprintf 3 2023-10-31 "Linux man-pages 6.06" +.TH wprintf 3 2024-05-02 "Linux man-pages 6.8" .SH NAME wprintf, fwprintf, swprintf, vwprintf, vfwprintf, vswprintf \- formatted wide-character output conversion diff --git a/upstream/archlinux/man3/wresize.3x b/upstream/archlinux/man3/wresize.3x index 1500913b..0b02e7fa 100644 --- a/upstream/archlinux/man3/wresize.3x +++ b/upstream/archlinux/man3/wresize.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -29,38 +29,44 @@ .\" .\" Author: Thomas E. Dickey 1996 .\" -.\" $Id: wresize.3x,v 1.20 2022/02/12 20:07:29 tom Exp $ -.TH wresize 3X "" +.\" $Id: wresize.3x,v 1.36 2024/03/16 15:35:01 tom Exp $ +.TH wresize 3X 2024-03-16 "ncurses 6.5" "Library calls" .SH NAME -\fBwresize\fP \- resize a curses window +\fB\%wresize\fP \- +resize a \fIcurses\fR window .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBint wresize(WINDOW *\fIwin\fB, int \fIlines\fB, int \fIcolumns\fB);\fR +.nf +\fB#include <curses.h> +.PP +\fBint wresize(WINDOW *\fIwin\fP, int \fIlines\fP, int \fIcolumns\fP); +.fi .SH DESCRIPTION -This is an extension to the curses library. -It reallocates storage for an \fBncurses\fP -window to adjust its dimensions to the specified values. -If either dimension is larger than the current values, the -window's data is filled with blanks that have the current background rendition -(as set by \fBwbkgdset\fP) merged into them. +This \fI\%ncurses\fP extension to standard \fIcurses\fP reallocates +storage for a \fIcurses\fP window to adjust its dimensions to the +specified values. +If either dimension is larger than its current value, +the expanded part of the window is filled with blanks merged with +current background rendition +(as set by \fB\%wbkgdset\fP(3X)). .SH RETURN VALUE -The function returns the integer \fBERR\fP upon failure and \fBOK\fP on success. -It will fail if either of the dimensions less than or equal to zero, +\fB\%wresize\fP returns \fBERR\fP upon failure and \fBOK\fP on success. +It will fail if either of the dimensions is less than or equal to zero, or if an error occurs while (re)allocating memory for the window. .SH NOTES -The only restriction placed on the dimensions is that they be greater than zero. -The dimensions are not compared to \fBcurses\fP screen dimensions to -simplify the logic of \fBresizeterm\fP. +The only restriction placed on the dimensions is that they be greater +than zero. +They are \fInot\fP compared to the \fIcurses\fP screen dimensions; +this keeps the logic of \fB\%resizeterm\fP(3X) simple. The caller must ensure that the window's dimensions fit within the actual screen dimensions. .SH PORTABILITY +It is not possible to resize windows with SVr4 \fIcurses\fP. .PP -It is not possible to resize windows with SVr4 curses. -.PP -This extension of ncurses was introduced in mid-1995. -It was adopted in NetBSD curses (2001) and PDCurses (2003). +\fI\%ncurses\fP introduced this extension in mid-1995. +NetBSD \fIcurses\fP adopted it in 2001, +and \fI\%PDCurses\fP in 2003. +.SH AUTHORS +Thomas Dickey +(from an equivalent function written in 1988 for BSD \fIcurses\fP). .SH SEE ALSO -\fBresizeterm\fP(3X). -.SH AUTHOR -Thomas Dickey (from an equivalent function written in 1988 for BSD curses). +\fB\%resizeterm\fP(3X) diff --git a/upstream/archlinux/man3/xcrypt.3 b/upstream/archlinux/man3/xcrypt.3 index cd139b5c..07efbc72 100644 --- a/upstream/archlinux/man3/xcrypt.3 +++ b/upstream/archlinux/man3/xcrypt.3 @@ -9,7 +9,7 @@ .\" 3. xencrypt() a hexstring .\" to bad to be true :( .\" -.TH XCRYPT 3 2023-10-31 "Linux man-pages 6.06" +.TH XCRYPT 3 2024-05-02 "Linux man-pages 6.8" .SH NAME xencrypt, xdecrypt, passwd2des \- RFS password encryption .SH LIBRARY diff --git a/upstream/archlinux/man3/xdr.3 b/upstream/archlinux/man3/xdr.3 index ae82885c..31359a54 100644 --- a/upstream/archlinux/man3/xdr.3 +++ b/upstream/archlinux/man3/xdr.3 @@ -9,7 +9,7 @@ .\" .\" 2007-12-30, mtk, Convert function prototypes to modern C syntax .\" -.TH xdr 3 2023-10-31 "Linux man-pages 6.06" +.TH xdr 3 2024-05-02 "Linux man-pages 6.8" .SH NAME xdr \- library routines for external data representation .SH LIBRARY diff --git a/upstream/archlinux/man3/y0.3 b/upstream/archlinux/man3/y0.3 index 7058b7b2..d7a1e54c 100644 --- a/upstream/archlinux/man3/y0.3 +++ b/upstream/archlinux/man3/y0.3 @@ -14,7 +14,7 @@ .\" Modified 2004-11-12 as per suggestion by Fabian Kreutz/AEB .\" 2008-07-24, mtk, created this page, based on material from j0.3. .\" -.TH y0 3 2023-10-31 "Linux man-pages 6.06" +.TH y0 3 2024-05-02 "Linux man-pages 6.8" .SH NAME y0, y0f, y0l, y1, y1f, y1l, yn, ynf, ynl \- Bessel functions of the second kind |