ncurses 6.3 - patch 20220618

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

diff --git a/man/curs_inchstr.3x b/man/curs_inchstr.3x
index d352c385c853704b308eb3b8166603e722c62c5f..2ffa4e32d5eab2c902cc2430ea76b0d7df15177a 100644 (file)
--- a/man/curs_inchstr.3x
+++ b/man/curs_inchstr.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright 2018,2020 Thomas E. Dickey                                     *
+.\" Copyright 2018-2021,2022 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  *


@@ -27,7 +27,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_inchstr.3x,v 1.19 2020/02/02 23:34:34 tom Exp $
+.\" $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 `` ``
 .TH curs_inchstr 3X ""
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``


@@ -40,48 +40,48 @@
 .na
 .hy 0
 .SH NAME
 .na
 .hy 0
 .SH NAME

-\fBinchstr\fR,
-\fBinchnstr\fR,
-\fBwinchstr\fR,
-\fBwinchnstr\fR,
-\fBmvinchstr\fR,
-\fBmvinchnstr\fR,
-\fBmvwinchstr\fR,
-\fBmvwinchnstr\fR \- get a string of characters (and attributes) from a \fBcurses\fR window
+\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
 .SH SYNOPSIS
 .ad
 .hy
 .SH SYNOPSIS

-\fB#include <curses.h>\fR
+\fB#include <curses.h>\fP

 .sp
 .sp

-\fBint inchstr(chtype *chstr);\fR
+\fBint inchstr(chtype *\fIchstr\fB);\fR

 .br
 .br

-\fBint inchnstr(chtype *chstr, int n);\fR
+\fBint inchnstr(chtype *\fIchstr\fB, int \fIn\fB);\fR

 .br
 .br

-\fBint winchstr(WINDOW *win, chtype *chstr);\fR
+\fBint winchstr(WINDOW *\fIwin\fB, chtype *\fIchstr\fB);\fR

 .br
 .br

-\fBint winchnstr(WINDOW *win, chtype *chstr, int n);\fR
-.br
-\fBint mvinchstr(int y, int x, chtype *chstr);\fR
+\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
 .br

-\fBint mvinchnstr(int y, int x, chtype *chstr, int n);\fR
+\fBint mvinchnstr(int \fIy\fB, int \fIx\fB, chtype *\fIchstr\fB, int \fIn\fB);\fR

 .br
 .br

-\fBint mvwinchstr(WINDOW *win, int y, int x, chtype *chstr);\fR
+\fBint mvwinchstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, chtype *\fIchstr\fB);\fR

 .br
 .br

-\fBint mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr, int n);\fR
+\fBint mvwinchnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, chtype *\fIchstr\fB, int \fIn\fB);\fR

 .br
 .SH DESCRIPTION
 .br
 .SH DESCRIPTION

-These routines return a NULL-terminated array of \fBchtype\fR quantities,
+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.
 starting at the current cursor position in the named window and ending at the
 right margin of the window.

-The four functions with \fIn\fR as
-the last argument, return a leading substring at most \fIn\fR characters long
+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).
 (exclusive of the trailing (chtype)0).

-Constants defined in \fB<curses.h>\fR can be used with the \fB&\fR (logical
+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
 AND) operator to extract the character or the attribute alone from any position

-in the \fIchstr\fR [see \fBcurs_inch\fR(3X)].
+in the \fIchstr\fP [see \fBcurs_inch\fP(3X)].

 .SH RETURN VALUE
 .SH RETURN VALUE

-All routines return the integer \fBERR\fR upon failure and an integer value
-other than \fBERR\fR upon successful completion (the number of characters
+All routines return the integer \fBERR\fP upon failure and an integer value
+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.
 retrieved, exclusive of the trailing 0).
 .PP
 X/Open Curses defines no error conditions.


@@ -95,7 +95,7 @@ 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 NOTES
 \fBwmove\fP, and return an error if the position is outside the window,
 or if the window pointer is null.
 .SH NOTES

-Note that all routines except \fBwinchnstr\fR may be macros.
+Note that all routines except \fBwinchnstr\fP may be macros.

 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
 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


@@ -105,10 +105,10 @@ These functions are described in the XSI Curses standard, Issue 4.
 It is no
 more specific than the SVr4 documentation on the trailing 0.
 It does specify
 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\fR.
+that the successful return of the functions is \fBOK\fP.

 .SH SEE ALSO
 .SH SEE ALSO

-\fBcurses\fR(3X), \fBcurs_inch\fR(3X).
+\fBcurses\fP(3X), \fBcurs_inch\fP(3X).

 .PP
 Comparable functions in the wide-character (ncursesw) library are
 described in
 .PP
 Comparable functions in the wide-character (ncursesw) library are
 described in

-\fBcurs_in_wchstr\fR(3X).
+\fBcurs_in_wchstr\fP(3X).