ncurses 5.9 - patch 20111217

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

diff --git a/man/form_field_attributes.3x b/man/form_field_attributes.3x
index 610bef2d6f43476603557c96c2ea2c7180239014..da3ad793876b6f31c14823614ef24b9b131f0ff7 100644 (file)
--- a/man/form_field_attributes.3x
+++ b/man/form_field_attributes.3x
@@ -1,7 +1,36 @@
 '\" t
 '\" t

+.\"***************************************************************************
+.\" Copyright (c) 1998-2006,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            *
+.\" "Software"), to deal in the Software without restriction, including      *
+.\" without limitation the rights to use, copy, modify, merge, publish,      *
+.\" distribute, distribute with modifications, sublicense, and/or sell       *
+.\" copies of the Software, and to permit persons to whom the Software is    *
+.\" furnished to do so, subject to the following conditions:                 *
+.\"                                                                          *
+.\" The above copyright notice and this permission notice shall be included  *
+.\" in all copies or substantial portions of the Software.                   *
+.\"                                                                          *
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
+.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
+.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
+.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
+.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
+.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
+.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
+.\"                                                                          *
+.\" Except as contained in this notice, the name(s) of the above copyright   *
+.\" holders shall not be used in advertising or otherwise to promote the     *
+.\" sale, use or other dealings in this Software without prior written       *
+.\" authorization.                                                           *
+.\"***************************************************************************
+.\"
+.\" $Id: form_field_attributes.3x,v 1.12 2010/12/04 18:40:45 tom Exp $

 .TH form_field_attributes 3X ""
 .SH NAME
 .TH form_field_attributes 3X ""
 .SH NAME

-\fBform_field_attributes\fR - color and attribute control for form fields
+\fBform_field_attributes\fR \- color and attribute control for form fields

 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .br
 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .br


@@ -15,35 +44,36 @@ chtype field_back(const FIELD *field);
 .br
 int set_field_pad(FIELD *field, int pad);
 .br
 .br
 int set_field_pad(FIELD *field, int pad);
 .br

-chtype field_pad(const FIELD *field);
+int field_pad(const FIELD *field);

 .br
 .SH DESCRIPTION
 The function \fBset_field_fore\fR sets the foreground attribute of
 \fIfield\fR. This is the highlight used to display the field contents.  The
 function \fBfield_fore\fR returns the foreground attribute.  The default is
 \fBA_STANDOUT\fR.
 .br
 .SH DESCRIPTION
 The function \fBset_field_fore\fR sets the foreground attribute of
 \fIfield\fR. This is the highlight used to display the field contents.  The
 function \fBfield_fore\fR returns the foreground attribute.  The default is
 \fBA_STANDOUT\fR.

-
+.PP

 The function \fBset_field_back\fR sets the background attribute of
 \fIform\fR. This is the highlight used to display the extent fields in the
 form.  The function \fBfield_back\fR returns the background attribute.  The
 default is \fBA_NORMAL\fR.
 The function \fBset_field_back\fR sets the background attribute of
 \fIform\fR. This is the highlight used to display the extent fields in the
 form.  The function \fBfield_back\fR returns the background attribute.  The
 default is \fBA_NORMAL\fR.

-
+.PP

 The function \fBset_field_pad\fR sets the character used to fill the field.
 The function \fBfield_pad\fR returns the given form's pad character.  The
 default is a blank.
 .SH RETURN VALUE
 These routines return one of the following:
 .TP 5
 The function \fBset_field_pad\fR sets the character used to fill the field.
 The function \fBfield_pad\fR returns the given form's pad character.  The
 default is a blank.
 .SH RETURN VALUE
 These routines return one of the following:
 .TP 5

-\fBE_OK\fR
+.B E_OK

 The routine succeeded.
 .TP 5
 The routine succeeded.
 .TP 5

-\fBE_SYSTEM_ERROR\fR
-System error occurred (see \fBerrno\fR).
-.TP 5
-\fBE_BAD_ARGUMENT\fR
+.B E_BAD_ARGUMENT

 Routine detected an incorrect or out-of-range argument.
 Routine detected an incorrect or out-of-range argument.

+.TP 5
+.B E_SYSTEM_ERROR
+System error occurred (see \fBerrno\fR).
+.

 .SH SEE ALSO
 .SH SEE ALSO

-\fBcurses\fR(3X) and 3X pages whose names begin "form_" for detailed
+\fBcurses\fR(3X) and related pages whose names begin "form_" for detailed

 descriptions of the entry points.
 .SH NOTES
 The header file \fB<form.h>\fR automatically includes the header file
 descriptions of the entry points.
 .SH NOTES
 The header file \fB<form.h>\fR automatically includes the header file


@@ -54,9 +84,3 @@ Version 7 or BSD versions.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: