ncurses 5.7 - patch 20110115
[ncurses.git] / man / curs_addch.3x
index d8b645d7c35983dd86b08eb41f1c258d3e4d1092..1ad071a8a8a0e06cabdcd9ad52adbcec9799c1f2 100644 (file)
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2010,2011 Free Software Foundation, Inc.              *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_addch.3x,v 1.25 2006/12/02 17:02:22 tom Exp $
+.\" $Id: curs_addch.3x,v 1.32 2011/01/15 14:15:10 tom Exp $
 .TH curs_addch 3X ""
 .SH NAME
-\fBaddch\fR, \fBwaddch\fR, \fBmvaddch\fR, \fBmvwaddch\fR,
+\fBaddch\fR,
+\fBwaddch\fR,
+\fBmvaddch\fR,
+\fBmvwaddch\fR,
 \fBechochar\fR,
-\fBwechochar\fR - add a character (with attributes) to a \fBcurses\fR window, then advance the cursor
+\fBwechochar\fR \- add a character (with attributes) to a \fBcurses\fR window, then advance the cursor
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .PP
@@ -87,7 +90,7 @@ their equivalents.
 .SS Line Graphics
 The following variables may be used to add line drawing characters to the
 screen with routines of the \fBaddch\fR family.  The default character listed
-below is used if the \fBacsc\fR capability doesn't define a terminal-specific
+below is used if the \fBacsc\fR capability does not define a terminal-specific
 replacement for it.
 The names are taken from VT100 nomenclature.
 .PP
@@ -105,7 +108,7 @@ ACS_DARROW  v       arrow pointing down
 ACS_DEGREE     '       degree symbol
 ACS_DIAMOND    +       diamond
 ACS_GEQUAL     >       greater-than-or-equal-to
-ACS_HLINE            horizontal line
+ACS_HLINE      \-      horizontal line
 ACS_LANTERN    #       lantern symbol
 ACS_LARROW     <       arrow pointing left
 ACS_LEQUAL     <       less-than-or-equal-to
@@ -118,9 +121,9 @@ ACS_PLMINUS #       plus/minus
 ACS_PLUS       +       plus
 ACS_RARROW     >       arrow pointing right
 ACS_RTEE       +       right tee
-ACS_S1       scan line 1
-ACS_S3       scan line 3
-ACS_S7       scan line 7
+ACS_S1 \-      scan line 1
+ACS_S3 \-      scan line 3
+ACS_S7 \-      scan line 7
 ACS_S9 \&_     scan line 9
 ACS_STERLING   f       pound-sterling symbol
 ACS_TTEE       +       top tee
@@ -134,6 +137,10 @@ All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success
 (the SVr4 manuals specify only "an integer value other than \fBERR\fR") upon
 successful completion, unless otherwise noted in the preceding routine
 descriptions.
+.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 NOTES
 Note that \fBaddch\fR, \fBmvaddch\fR, \fBmvwaddch\fR, and
 \fBechochar\fR may be macros.
@@ -141,6 +148,10 @@ Note that \fBaddch\fR, \fBmvaddch\fR, \fBmvwaddch\fR, and
 All these functions are described in the XSI Curses standard, Issue 4.
 The defaults specified for forms-drawing characters apply in the POSIX locale.
 .LP
+X/Open Curses states that the \fIACS_\fP definitions are \fBchar\fP constants.
+For the wide-character implementation (see \fBcurs_add_wch\fP),
+there are analogous \fIWACS_\fP definitions which are \fBcchar_t\fP constants.
+.LP
 Some ACS symbols
 (ACS_S3,
 ACS_S7,
@@ -168,14 +179,9 @@ This is true of other implementations, but is not documented.
 \fBcurs_inch\fR(3X),
 \fBcurs_outopts\fR(3X),
 \fBcurs_refresh\fR(3X),
-\fBputc\fR(3S).
+\fBcurs_variables\fR(3X),
+\fBputc\fR(3).
 .PP
 Comparable functions in the wide-character (ncursesw) library are
 described in
 \fBcurs_add_wch\fR(3X).
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: