bug-ncurses
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 004/177] man/*: Change formatting of logical and bitwise operator


From: G. Branden Robinson
Subject: [PATCH 004/177] man/*: Change formatting of logical and bitwise operators.
Date: Mon, 13 Jan 2025 11:14:18 -0600

Quote them rather than shouting them.

Define page-local `` and '' strings for quotation marks where necessary.
---
 man/curs_attr.3x       | 21 +++++++++++----------
 man/curs_in_wchstr.3x  |  5 +++--
 man/curs_inchstr.3x    |  5 +++--
 man/curs_trace.3x      |  2 +-
 man/form_field_opts.3x | 14 ++++++++++++--
 man/form_fieldtype.3x  | 13 ++++++++++++-
 man/form_opts.3x       | 14 ++++++++++++--
 man/menu_opts.3x       | 14 ++++++++++++--
 man/mitem_opts.3x      | 14 ++++++++++++--
 man/terminfo.tail      |  9 ++++++---
 10 files changed, 84 insertions(+), 27 deletions(-)

diff --git a/man/curs_attr.3x b/man/curs_attr.3x
index f89a64ed3..2da9368f6 100644
--- a/man/curs_attr.3x
+++ b/man/curs_attr.3x
@@ -142,17 +142,18 @@ .SS "Window Attributes"
 Use \fBwattr_get\fP to retrieve attributes for the given window.
 .PP
 Use \fBattr_on\fP and \fBwattr_on\fP to turn on window attributes, i.e.,
-values OR'd together in \fIattr\fP,
+values logically \*(``or\*(''-ed together in \fIattr\fP,
 without affecting other attributes.
 Use \fBattr_off\fP and \fBwattr_off\fP to turn off window attributes,
-again values OR'd together in \fIattr\fP,
+again values logically \*(``or\*(''-ed together in \fIattr\fP,
 without affecting other 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
-which assume that color pairs are OR'd into the attribute parameter.
+which assume that color pairs are logically \*(``or\*(''-ed
+into the attribute parameter.
 These newer routines use similar names, because
 X/Open simply added an underscore (\fB_\fP) for the newer names.
 .PP
@@ -165,8 +166,8 @@ .SS "Legacy Window Attributes"
 It holds the common video attributes (such as bold, reverse),
 as well as a few bits for color.
 Those bits correspond to the \fBA_COLOR\fP symbol.
-The \fBCOLOR_PAIR\fP macro provides a value which can be OR'd into
-the attribute parameter.
+The \fBCOLOR_PAIR\fP macro provides a value which can be
+logically \*(``or\*(''-ed into the attribute parameter.
 For example,
 as long as that value fits into the \fBA_COLOR\fP mask,
 then these calls produce similar results:
@@ -256,8 +257,8 @@ .SS Standout
 .\" ---------------------------------------------------------------------------
 .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)).
+the routines \fBattron\fP, \fBattroff\fP, and \fBattrset\fP,
+or logically \*(``or\*(''-ed with characters passed to \fBaddch\fP(3X).
 .PP
 .ne 15
 .RS
@@ -366,13 +367,13 @@ .SH NOTES
 \fBattrset\fP, \fBwattrset\fP, \fBstandend\fP and \fBstandout\fP.
 .RE
 .PP
-Color pair values can only be OR'd with attributes if the pair
-number is less than 256.
+Color pair values be logically \*(``or\*(''-ed 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,
 .I \%ncurses
-ABI 4 and 5 simply OR this value
+ABI 4 and 5 simply logically \*(``or\*('' this value
 within the alternate functions.
 You must use
 .I \%ncurses
diff --git a/man/curs_in_wchstr.3x b/man/curs_in_wchstr.3x
index 0b821c94a..617b89381 100644
--- a/man/curs_in_wchstr.3x
+++ b/man/curs_in_wchstr.3x
@@ -79,8 +79,9 @@ .SH DESCRIPTION
 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
+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
diff --git a/man/curs_inchstr.3x b/man/curs_inchstr.3x
index 57eef1329..b3fea81e0 100644
--- a/man/curs_inchstr.3x
+++ b/man/curs_inchstr.3x
@@ -81,8 +81,9 @@ .SH DESCRIPTION
 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
+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)].
 .SH RETURN VALUE
 All routines return the integer \fBERR\fP upon failure and an integer value
diff --git a/man/curs_trace.3x b/man/curs_trace.3x
index 19e5d49bf..d3d5a90b0 100644
--- a/man/curs_trace.3x
+++ b/man/curs_trace.3x
@@ -139,7 +139,7 @@ .SS Functions
 .bP
 If tracing is not available, \fBcurses_trace\fP returns zero (0).
 .SS "Trace Parameter"
-The trace parameter is formed by OR'ing
+The trace parameter is formed by logically \*(``or\*(''-ing
 values from the list of \fBTRACE_\fIxxx\fR definitions in \fB<curses.h>\fR.
 These include:
 .TP 5
diff --git a/man/form_field_opts.3x b/man/form_field_opts.3x
index 9ab3ad0cb..ea3373449 100644
--- a/man/form_field_opts.3x
+++ b/man/form_field_opts.3x
@@ -29,6 +29,16 @@
 .\"
 .\" $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 @NCURSES_MAJOR@.@NCURSES_MINOR@" 
"Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
 .SH NAME
 \fBset_field_opts\fP,
 \fBfield_opts_on\fP,
@@ -46,8 +56,8 @@ .SH SYNOPSIS
 \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).
+The function \fBset_field_opts\fP sets all the given field's option bits
+(field option bits may be logically \*(``or\*(''-ed together).
 .PP
 The function \fBfield_opts_on\fP turns on the given option bits, and leaves
 others alone.
diff --git a/man/form_fieldtype.3x b/man/form_fieldtype.3x
index 35b9dd42c..61c04f2cd 100644
--- a/man/form_fieldtype.3x
+++ b/man/form_fieldtype.3x
@@ -29,6 +29,17 @@
 .\"
 .\" $Id: form_fieldtype.3x,v 1.48 2024/12/28 21:26:21 tom Exp $
 .TH form_fieldtype 3X 2024-12-28 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" 
"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
@@ -121,7 +132,7 @@ .SS set_fieldtype_choice
 .SS link_fieldtype
 The function \fBlink_fieldtype\fP creates
 a new field type from the two given types.
-They are connected by an logical 'OR'.
+They are connected by a logical \*(``or\*(''.
 .SH RETURN VALUE
 The pointer-valued routines return NULL on error.
 They set \fBerrno\fP according to their success:
diff --git a/man/form_opts.3x b/man/form_opts.3x
index 74a36d2b3..e706b3142 100644
--- a/man/form_opts.3x
+++ b/man/form_opts.3x
@@ -29,6 +29,16 @@
 .\"
 .\" $Id: form_opts.3x,v 1.34 2024/03/16 15:35:01 tom Exp $
 .TH form_opts 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library 
calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
 .SH NAME
 \fBset_form_opts\fP,
 \fBform_opts_on\fP,
@@ -46,8 +56,8 @@ .SH SYNOPSIS
 \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).
+The function \fBset_form_opts\fP sets all the given form's option bits
+(form option bits may be logically \*(``or\*(''-ed together).
 .PP
 The function \fBform_opts_on\fP turns on the given option bits, and leaves
 others alone.
diff --git a/man/menu_opts.3x b/man/menu_opts.3x
index ad7fe97f3..cb747cefe 100644
--- a/man/menu_opts.3x
+++ b/man/menu_opts.3x
@@ -29,6 +29,16 @@
 .\"
 .\" $Id: menu_opts.3x,v 1.35 2024/03/16 15:35:01 tom Exp $
 .TH menu_opts 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library 
calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
 .SH NAME
 \fBset_menu_opts\fP,
 \fBmenu_opts_on\fP,
@@ -46,8 +56,8 @@ .SH SYNOPSIS
 \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).
+The function \fBset_menu_opts\fP sets all the given menu's option bits
+(menu option bits may be logically \*(``or\*(''-ed together).
 .PP
 The function \fBmenu_opts_on\fP turns on the given option bits, and leaves
 others alone.
diff --git a/man/mitem_opts.3x b/man/mitem_opts.3x
index 5a86516f5..fe7a629ad 100644
--- a/man/mitem_opts.3x
+++ b/man/mitem_opts.3x
@@ -29,6 +29,16 @@
 .\"
 .\" $Id: mitem_opts.3x,v 1.33 2024/03/16 15:35:01 tom Exp $
 .TH mitem_opts 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" 
"Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
 .SH NAME
 \fBset_item_opts\fP,
 \fBitem_opts_on\fP,
@@ -46,8 +56,8 @@ .SH SYNOPSIS
 \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).
+The function \fBset_item_opts\fP sets all the given item's option bits
+(menu option bits may be logically \*(``or\*(''-ed together).
 .PP
 The function \fBitem_opts_on\fP turns on the given option bits, and leaves
 others alone.
diff --git a/man/terminfo.tail b/man/terminfo.tail
index 65bf78dae..3502a8f87 100644
--- a/man/terminfo.tail
+++ b/man/terminfo.tail
@@ -186,7 +186,8 @@ respectively.
 X/Open Curses does not say what \*(``appropriate \fIx\fP\*('' might be.
 In practice, that is a printable ASCII graphic character.
 The special case \*(``\*^?\*('' is interpreted as DEL (127).
-In all other cases, the character value is AND'd with 0x1f,
+In all other cases,
+the character value is logically \*(``and\*(''-ed with 0x1f,
 mapping to ASCII control codes in the range 0 through 31.
 .PP
 Other escapes include
@@ -569,13 +570,15 @@ push strlen(pop)
 arithmetic (%m is \fImod\fP): \fIpush(pop() op pop())\fP
 .TP
 \fB%&\fP, \fB%|\fP, \fB%\*^\fP
-bit operations (AND, OR and exclusive-OR): \fIpush(pop() op pop())\fP
+bit operations
+(\*(``and\*('', \*(``or\*('' and exclusive \*(``or\*(''):
+\fIpush(pop() op pop())\fP
 .TP
 \fB%=\fP, \fB%>\fP, \fB%<\fP
 logical operations: \fIpush(pop() op pop())\fP
 .TP
 \fB%A\fP, \fB%O\fP
-logical AND and OR operations (for conditionals)
+logical \*(``and\*('' and \*(``or\*('' operations (for conditionals)
 .TP
 \fB%!\fP, \fB%\*~\fP
 unary operations (logical and bit complement): \fIpush(op pop())\fP
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]