ncurses 5.7 - patch 20100911

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

diff --git a/man/curs_addch.3x b/man/curs_addch.3x
index 13053d0053770d5d473f8a45421c7ef99f408b61..903da7564b1ddc39034419c48e2b6abf2f7c7707 100644 (file)
--- a/man/curs_addch.3x
+++ b/man/curs_addch.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998-2003,2004 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2007,2010 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            *
@@ -27,12 +27,15 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_addch.3x,v 1.23 2004/01/31 13:16:21 tom Exp $
+.\" $Id: curs_addch.3x,v 1.29 2010/08/14 23:29:16 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,9 +90,9 @@ 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
-replacement for it (but see the EXTENSIONS section below).  The names are
-taken from VT100 nomenclature.
+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
 .TS
 l l l
@@ -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.
@@ -162,9 +169,17 @@ If \fIch\fR is a carriage return,
 the cursor is moved to the beginning of the current row of the window.
 This is true of other implementations, but is not documented.
 .SH SEE ALSO
-\fBcurses\fR(3X), \fBcurs_attr\fR(3X), \fBcurs_clear\fR(3X),
-\fBcurs_inch\fR(3X), \fBcurs_outopts\fR(3X), \fBcurs_refresh\fR(3X),
-\fBputc\fR(3S).
+\fBcurses\fR(3X),
+\fBcurs_attr\fR(3X),
+\fBcurs_clear\fR(3X),
+\fBcurs_inch\fR(3X),
+\fBcurs_outopts\fR(3X),
+\fBcurs_refresh\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: