[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 18/61] Revise discussion of header inclusion.
|
From: |
G. Branden Robinson |
|
Subject: |
[PATCH 18/61] Revise discussion of header inclusion. |
|
Date: |
Fri, 24 Nov 2023 12:02:08 -0600 |
* man/curs_get_wch.3x: Drop discussion of consequences of #including
curses.h. No other ncurses library function reference page does this;
it's covered in the overall page presenting the library, ncurses.3x.
* man/form.3x (NOTES):
* man/menu.3x (NOTES): Stop mentioning eti.h header file. Its name is
not standardized, nor even mentioned, by XSI Curses (Issue 4 or Issue
7) and therefore appears to be an implementation detail.
* man/form.3x (NOTES):
* man/menu.3x (NOTES):
* man/ncurses.3x (Header files):
* man/panel.3x (NOTES): Recast. Set file names in italics, not
boldface. Protect file name literals from hyphenation. Don't include
angle brackets in the file name.
* man/form_cursor.3x:
* man/form_data.3x:
* man/form_driver.3x:
* man/form_field.3x:
* man/form_field_attributes.3x:
* man/form_field_buffer.3x:
* man/form_field_info.3x:
* man/form_field_just.3x:
* man/form_field_new.3x:
* man/form_field_opts.3x:
* man/form_field_userptr.3x:
* man/form_field_validation.3x:
* man/form_fieldtype.3x:
* man/form_hook.3x:
* man/form_new.3x:
* man/form_new_page.3x:
* man/form_opts.3x:
* man/form_page.3x:
* man/form_post.3x:
* man/form_requestname.3x:
* man/form_userptr.3x:
* man/form_win.3x: Drop discussion of consequences of #including
form.h. This material is covered in the overall page presenting the
library, form.3x.
* man/form_field_buffer.3x: Clean up some damage from earlier relocation
of text.
* man/menu_attributes.3x:
* man/menu_cursor.3x:
* man/menu_driver.3x:
* man/menu_format.3x:
* man/menu_hook.3x:
* man/menu_items.3x:
* man/menu_mark.3x:
* man/menu_new.3x:
* man/menu_opts.3x:
* man/menu_pattern.3x:
* man/menu_post.3x:
* man/menu_requestname.3x:
* man/menu_spacing.3x:
* man/menu_userptr.3x:
* man/menu_win.3x:
* man/mitem_current.3x:
* man/mitem_name.3x:
* man/mitem_new.3x:
* man/mitem_opts.3x:
* man/mitem_userptr.3x:
* man/mitem_value.3x:
* man/mitem_visible.3x: Drop discussion of consequences of #including
menu.h. This material is covered in the overall page presenting the
library, menu.3x.
* man/ncurses.3x (NOTES): Add forward cross reference to "Header files"
subsection, since the user might reasonably, given other ncurses man
pages, expect to find symbol visibility issues arising from header
file inclusion discussed here.
---
man/curs_get_wch.3x | 6 ------
man/form.3x | 3 +--
man/form_cursor.3x | 3 ---
man/form_data.3x | 3 ---
man/form_driver.3x | 3 ---
man/form_field.3x | 3 ---
man/form_field_attributes.3x | 3 ---
man/form_field_buffer.3x | 3 ---
man/form_field_info.3x | 3 ---
man/form_field_just.3x | 3 ---
man/form_field_new.3x | 3 ---
man/form_field_opts.3x | 3 ---
man/form_field_userptr.3x | 3 ---
man/form_field_validation.3x | 3 ---
man/form_fieldtype.3x | 3 ---
man/form_hook.3x | 3 ---
man/form_new.3x | 3 ---
man/form_new_page.3x | 3 ---
man/form_opts.3x | 3 ---
man/form_page.3x | 3 ---
man/form_post.3x | 3 ---
man/form_requestname.3x | 3 ---
man/form_userptr.3x | 3 ---
man/form_win.3x | 3 ---
man/menu.3x | 4 ++--
man/menu_attributes.3x | 3 ---
man/menu_cursor.3x | 3 ---
man/menu_driver.3x | 3 ---
man/menu_format.3x | 3 ---
man/menu_hook.3x | 3 ---
man/menu_items.3x | 3 ---
man/menu_mark.3x | 3 ---
man/menu_new.3x | 3 ---
man/menu_opts.3x | 3 ---
man/menu_pattern.3x | 3 ---
man/menu_post.3x | 3 ---
man/menu_requestname.3x | 3 ---
man/menu_spacing.3x | 3 ---
man/menu_userptr.3x | 3 ---
man/menu_win.3x | 3 ---
man/mitem_current.3x | 3 ---
man/mitem_name.3x | 3 ---
man/mitem_new.3x | 3 ---
man/mitem_opts.3x | 3 ---
man/mitem_userptr.3x | 3 ---
man/mitem_value.3x | 3 ---
man/mitem_visible.3x | 3 ---
man/ncurses.3x | 7 +++++--
man/panel.3x | 3 +++
49 files changed, 11 insertions(+), 144 deletions(-)
diff --git a/man/curs_get_wch.3x b/man/curs_get_wch.3x
index b6a2e8ad..9116365b 100644
--- a/man/curs_get_wch.3x
+++ b/man/curs_get_wch.3x
@@ -163,12 +163,6 @@ .SH RETURN VALUE
\fBwmove\fP, and return an error if the position is outside the window,
or if the window pointer is null.
.SH NOTES
-The header file
-\fB<curses.h>\fP
-automatically
-includes the header file
-\fB<stdio.h>\fP.
-.PP
Applications should not define the escape key by itself as a single-character
function.
.PP
diff --git a/man/form.3x b/man/form.3x
index 11d1e03d..ff9b9ce6 100644
--- a/man/form.3x
+++ b/man/form.3x
@@ -215,8 +215,7 @@ .SH RETURN VALUE
.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.
+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
diff --git a/man/form_cursor.3x b/man/form_cursor.3x
index 3e2e6b2d..f1da6ce1 100644
--- a/man/form_cursor.3x
+++ b/man/form_cursor.3x
@@ -59,9 +59,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/form_data.3x b/man/form_data.3x
index 7c113223..08161d93 100644
--- a/man/form_data.3x
+++ b/man/form_data.3x
@@ -49,9 +49,6 @@ .SH DESCRIPTION
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 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
diff --git a/man/form_driver.3x b/man/form_driver.3x
index 14e7828a..2c073920 100644
--- a/man/form_driver.3x
+++ b/man/form_driver.3x
@@ -248,9 +248,6 @@ .SH RETURN VALUE
.TP 5
.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.
.SH PORTABILITY
These routines emulate the System V forms library.
They were not supported on
diff --git a/man/form_field.3x b/man/form_field.3x
index 036b0ad4..a57a0175 100644
--- a/man/form_field.3x
+++ b/man/form_field.3x
@@ -76,9 +76,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/form_field_attributes.3x b/man/form_field_attributes.3x
index 0b204051..8621604b 100644
--- a/man/form_field_attributes.3x
+++ b/man/form_field_attributes.3x
@@ -85,9 +85,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/form_field_buffer.3x b/man/form_field_buffer.3x
index cba17f75..fa9f1deb 100644
--- a/man/form_field_buffer.3x
+++ b/man/form_field_buffer.3x
@@ -126,14 +126,11 @@ .SH RETURN VALUE
.B E_BAD_ARGUMENT
Routine detected an incorrect or out-of-range argument.
.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
diff --git a/man/form_field_info.3x b/man/form_field_info.3x
index 47ddbd48..51b59221 100644
--- a/man/form_field_info.3x
+++ b/man/form_field_info.3x
@@ -79,9 +79,6 @@ .SH RETURN VALUE
.TP 5
.B E_BAD_ARGUMENT
Routine detected an incorrect or out-of-range argument.
-.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
diff --git a/man/form_field_just.3x b/man/form_field_just.3x
index a9445f83..e9810c7d 100644
--- a/man/form_field_just.3x
+++ b/man/form_field_just.3x
@@ -70,9 +70,6 @@ .SH RETURN VALUE
.TP 5
.B E_BAD_ARGUMENT
Routine detected an incorrect or out-of-range argument.
-.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
diff --git a/man/form_field_new.3x b/man/form_field_new.3x
index cf603edf..91bd698f 100644
--- a/man/form_field_new.3x
+++ b/man/form_field_new.3x
@@ -88,9 +88,6 @@ .SH RETURN VALUE
.TP 5
.B E_CONNECTED
field is connected.
-.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
diff --git a/man/form_field_opts.3x b/man/form_field_opts.3x
index 34e2de93..69166d18 100644
--- a/man/form_field_opts.3x
+++ b/man/form_field_opts.3x
@@ -133,9 +133,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/form_field_userptr.3x b/man/form_field_userptr.3x
index a94215fe..900f4b3a 100644
--- a/man/form_field_userptr.3x
+++ b/man/form_field_userptr.3x
@@ -50,9 +50,6 @@ .SH RETURN VALUE
It does not set \fBerrno\fP.
.PP
The function \fBset_field_userptr\fP returns \fBE_OK\fP (success).
-.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
diff --git a/man/form_field_validation.3x b/man/form_field_validation.3x
index 6b2bddae..553c951a 100644
--- a/man/form_field_validation.3x
+++ b/man/form_field_validation.3x
@@ -195,9 +195,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/form_fieldtype.3x b/man/form_fieldtype.3x
index 376d0f33..f50bfe9e 100644
--- a/man/form_fieldtype.3x
+++ b/man/form_fieldtype.3x
@@ -150,9 +150,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/form_hook.3x b/man/form_hook.3x
index 37b05eb6..50793d6c 100644
--- a/man/form_hook.3x
+++ b/man/form_hook.3x
@@ -85,9 +85,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/form_new.3x b/man/form_new.3x
index cc15c532..2faaf6a5 100644
--- a/man/form_new.3x
+++ b/man/form_new.3x
@@ -72,9 +72,6 @@ .SH RETURN VALUE
.TP 5
.B E_POSTED
The form has already been posted.
-.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
diff --git a/man/form_new_page.3x b/man/form_new_page.3x
index 1a60ac4a..4bf5543f 100644
--- a/man/form_new_page.3x
+++ b/man/form_new_page.3x
@@ -66,9 +66,6 @@ .SH RETURN VALUE
.TP 5
.B E_CONNECTED
The given field is already connected to a form.
-.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
diff --git a/man/form_opts.3x b/man/form_opts.3x
index a662e71b..e6d4faec 100644
--- a/man/form_opts.3x
+++ b/man/form_opts.3x
@@ -74,9 +74,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/form_page.3x b/man/form_page.3x
index ee0b8987..74f02b48 100644
--- a/man/form_page.3x
+++ b/man/form_page.3x
@@ -83,9 +83,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/form_post.3x b/man/form_post.3x
index 82e05ebc..4963eb30 100644
--- a/man/form_post.3x
+++ b/man/form_post.3x
@@ -74,9 +74,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/form_requestname.3x b/man/form_requestname.3x
index 5b1be8d3..cf38a5aa 100644
--- a/man/form_requestname.3x
+++ b/man/form_requestname.3x
@@ -52,9 +52,6 @@ .SH RETURN VALUE
.PP
\fBform_request_by_name\fP returns \fBE_NO_MATCH\fP on error.
It does not set \fBerrno\fP.
-.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.
They were not supported on
diff --git a/man/form_userptr.3x b/man/form_userptr.3x
index 00d49e99..58e9d820 100644
--- a/man/form_userptr.3x
+++ b/man/form_userptr.3x
@@ -49,9 +49,6 @@ .SH RETURN VALUE
It does not set \fBerrno\fP.
.PP
The function \fBset_form_userptr\fP returns \fBE_OK\fP (success).
-.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
diff --git a/man/form_win.3x b/man/form_win.3x
index a4bd5cc0..e0ab532a 100644
--- a/man/form_win.3x
+++ b/man/form_win.3x
@@ -79,9 +79,6 @@ .SH RETURN VALUE
.TP 5
.B E_NOT_CONNECTED
No items are connected to the form.
-.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
diff --git a/man/menu.3x b/man/menu.3x
index 18e4b829..ede1f402 100644
--- a/man/menu.3x
+++ b/man/menu.3x
@@ -190,8 +190,8 @@ .SH RETURN VALUE
.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.
+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
diff --git a/man/menu_attributes.3x b/man/menu_attributes.3x
index 6b4be352..edd04ea0 100644
--- a/man/menu_attributes.3x
+++ b/man/menu_attributes.3x
@@ -101,9 +101,6 @@ .SH RETURN VALUE
.TP 5
.B E_BAD_ARGUMENT
Routine detected an incorrect or out-of-range argument.
-.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
diff --git a/man/menu_cursor.3x b/man/menu_cursor.3x
index 3f01c1e4..ae1f61c5 100644
--- a/man/menu_cursor.3x
+++ b/man/menu_cursor.3x
@@ -57,9 +57,6 @@ .SH RETURN VALUE
.TP 5
.B E_NOT_POSTED
The menu has not been posted.
-.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
diff --git a/man/menu_driver.3x b/man/menu_driver.3x
index 10e9d216..b992280d 100644
--- a/man/menu_driver.3x
+++ b/man/menu_driver.3x
@@ -191,9 +191,6 @@ .SH RETURN VALUE
.TP 5
.B E_REQUEST_DENIED
The menu driver could not process the request.
-.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
diff --git a/man/menu_format.3x b/man/menu_format.3x
index 952ea9a7..d40e13e6 100644
--- a/man/menu_format.3x
+++ b/man/menu_format.3x
@@ -74,9 +74,6 @@ .SH RETURN VALUE
.TP 5
.B E_NOT_CONNECTED
No items are connected to the menu.
-.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
diff --git a/man/menu_hook.3x b/man/menu_hook.3x
index 84463931..0b274b03 100644
--- a/man/menu_hook.3x
+++ b/man/menu_hook.3x
@@ -84,9 +84,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/menu_items.3x b/man/menu_items.3x
index da0b4910..6c7ed855 100644
--- a/man/menu_items.3x
+++ b/man/menu_items.3x
@@ -72,9 +72,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/menu_mark.3x b/man/menu_mark.3x
index 91b891c4..643f0aa3 100644
--- a/man/menu_mark.3x
+++ b/man/menu_mark.3x
@@ -70,9 +70,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/menu_new.3x b/man/menu_new.3x
index 8ead7297..1528a05b 100644
--- a/man/menu_new.3x
+++ b/man/menu_new.3x
@@ -69,9 +69,6 @@ .SH RETURN VALUE
.TP 5
.B E_POSTED
The menu has already been posted.
-.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
diff --git a/man/menu_opts.3x b/man/menu_opts.3x
index 439891ac..62116c2f 100644
--- a/man/menu_opts.3x
+++ b/man/menu_opts.3x
@@ -94,9 +94,6 @@ .SH RETURN VALUE
.TP 5
.B E_POSTED
The menu is already posted.
-.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
diff --git a/man/menu_pattern.3x b/man/menu_pattern.3x
index f5647fb5..c48b6453 100644
--- a/man/menu_pattern.3x
+++ b/man/menu_pattern.3x
@@ -79,9 +79,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/menu_post.3x b/man/menu_post.3x
index 2e855e2f..68dab4e3 100644
--- a/man/menu_post.3x
+++ b/man/menu_post.3x
@@ -77,9 +77,6 @@ .SH RETURN VALUE
.TP 5
.B E_NOT_CONNECTED
No items are connected to the menu.
-.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
diff --git a/man/menu_requestname.3x b/man/menu_requestname.3x
index 8c33b607..665b6006 100644
--- a/man/menu_requestname.3x
+++ b/man/menu_requestname.3x
@@ -53,9 +53,6 @@ .SH RETURN VALUE
.br
\fBmenu_request_by_name\fP returns \fBE_NO_MATCH\fP on error.
It does not set \fBerrno\fP.
-.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.
They were not supported on
diff --git a/man/menu_spacing.3x b/man/menu_spacing.3x
index 4d960b6f..3c6103b4 100644
--- a/man/menu_spacing.3x
+++ b/man/menu_spacing.3x
@@ -79,9 +79,6 @@ .SH RETURN VALUE
\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 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.
They were not supported on
diff --git a/man/menu_userptr.3x b/man/menu_userptr.3x
index 36db008a..265c796e 100644
--- a/man/menu_userptr.3x
+++ b/man/menu_userptr.3x
@@ -49,9 +49,6 @@ .SH RETURN VALUE
It does not set \fBerrno\fP.
.PP
\fBset_menu_userptr\fP returns \fBE_OK\fP (success).
-.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
diff --git a/man/menu_win.3x b/man/menu_win.3x
index bc244b1a..d5175d1e 100644
--- a/man/menu_win.3x
+++ b/man/menu_win.3x
@@ -79,9 +79,6 @@ .SH RETURN VALUE
.TP 5
.B E_NOT_CONNECTED
No items are connected to the menu.
-.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
diff --git a/man/mitem_current.3x b/man/mitem_current.3x
index 648213ac..55a43170 100644
--- a/man/mitem_current.3x
+++ b/man/mitem_current.3x
@@ -83,9 +83,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/mitem_name.3x b/man/mitem_name.3x
index 126c3fb9..21a901fa 100644
--- a/man/mitem_name.3x
+++ b/man/mitem_name.3x
@@ -48,9 +48,6 @@ .SH DESCRIPTION
.SH RETURN VALUE
These routines return a pointer (which may be \fBNULL\fP).
They do not set \fBerrno\fP.
-.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.
diff --git a/man/mitem_new.3x b/man/mitem_new.3x
index 418e6a9f..2b8e380b 100644
--- a/man/mitem_new.3x
+++ b/man/mitem_new.3x
@@ -77,9 +77,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/mitem_opts.3x b/man/mitem_opts.3x
index c9c600b2..e384d77a 100644
--- a/man/mitem_opts.3x
+++ b/man/mitem_opts.3x
@@ -69,9 +69,6 @@ .SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.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
diff --git a/man/mitem_userptr.3x b/man/mitem_userptr.3x
index a723dbf2..c17154d9 100644
--- a/man/mitem_userptr.3x
+++ b/man/mitem_userptr.3x
@@ -50,9 +50,6 @@ .SH RETURN VALUE
It does not set \fBerrno\fP.
.PP
The \fBset_item_userptr\fP always returns \fBE_OK\fP (success).
-.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
diff --git a/man/mitem_value.3x b/man/mitem_value.3x
index 84dd0bfd..d8b8f690 100644
--- a/man/mitem_value.3x
+++ b/man/mitem_value.3x
@@ -60,9 +60,6 @@ .SH RETURN VALUE
.TP 5
.B E_REQUEST_DENIED
The menu driver could not process the request.
-.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
diff --git a/man/mitem_visible.3x b/man/mitem_visible.3x
index abd62943..2aaf9f8b 100644
--- a/man/mitem_visible.3x
+++ b/man/mitem_visible.3x
@@ -42,9 +42,6 @@ .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 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
diff --git a/man/ncurses.3x b/man/ncurses.3x
index 65d826e2..38b12aac 100644
--- a/man/ncurses.3x
+++ b/man/ncurses.3x
@@ -1396,6 +1396,9 @@ .SH NOTES
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.
+.PP
+See subsection \*(``Header files\*('' below regarding symbols exposed by
+inclusion of \fI\%curses.h\fP.
.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
@@ -1497,8 +1500,8 @@ .SS Padding differences
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 header file \fI\%curses.h\fP itself includes the header files
+\fI\%stdio.h\fP and \fI\%unctrl.h\fP.
.PP
X/Open Curses has more to say,
but does not finish the story:
diff --git a/man/panel.3x b/man/panel.3x
index 0b8f96eb..cb8ff0b2 100644
--- a/man/panel.3x
+++ b/man/panel.3x
@@ -202,6 +202,9 @@ .SH DIAGNOSTICS
.PP
The \fBmove_panel\fP function uses \fBmvwin\fP(3X),
and will return an error if \fBmvwin\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
--
2.30.2
signature.asc
Description: PGP signature
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 18/61] Revise discussion of header inclusion.,
G. Branden Robinson <=