ncurses 6.4 - patch 20240113

[ncurses.git] / man / curs_inch.3x

diff --git a/man/curs_inch.3x b/man/curs_inch.3x
index aef2c7d9f11287fb7e81e0f1ea6156d925661d94..54a57228f9775912ebc23f6a38431db50aaffa4e 100644 (file)
--- a/man/curs_inch.3x
+++ b/man/curs_inch.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" Copyright 2018-2022,2023 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  *
 .\" Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -28,31 +28,39 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_inch.3x,v 1.32 2023/07/01 15:43:20 tom Exp $
-.TH curs_inch 3X 2023-07-01 "ncurses 6.4" "Library calls"
-.ie \n(.g .ds `` \(lq
-.el       .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el       .ds '' ''
+.\" $Id: curs_inch.3x,v 1.44 2024/01/13 22:05:39 tom Exp $
+.TH curs_inch 3X 2024-01-13 "ncurses 6.4" "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
 .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
 .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
+.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.
 .SH DESCRIPTION
 These routines return the character, of type \fBchtype\fP, at the current
 position in the named window.


@@ -63,13 +71,16 @@ Constants defined in
 extract the character or attributes alone.
 .
 .SS Attributes
 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
 .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
 .TE
 .SH RETURN VALUE
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using


@@ -106,13 +117,15 @@ 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
 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)
+.TP
+\fB\%curses\fP(3X)
+gives an overview of the \fB\%WINDOW\fP and \fB\%chtype\fP data types.
+.TP
+\fB\%curs_attr\fP(3X)

 goes into more detail, pointing out portability problems and
 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.
+constraints on the use of \fB\%chtype\fP for returning window
+information.
+.TP
+\fB\%curs_in_wch\fP(3X)
+describes comparable functions for the wide-character (ncursesw)
+library.