ncurses 5.7 - patch 20100731

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

diff --git a/man/form_field.3x b/man/form_field.3x
index f452036baeab0ea6722c4d6e49eeb5a417afe3cd..20088135000de97b442c095b691998209b8a5cea 100644 (file)
--- a/man/form_field.3x
+++ b/man/form_field.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


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

-.\" $Id: form_field.3x,v 1.5 1998/11/29 01:05:52 Rick.Ohnemus Exp $
+.\" $Id: form_field.3x,v 1.9 2010/07/31 16:09:36 tom Exp $

 .TH form_field 3X ""
 .SH NAME
 .TH form_field 3X ""
 .SH NAME

-\fBform_field\fR - make and break connections between fields and forms
+\fBform_field\fR \- make and break connections between fields and forms

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


@@ -45,36 +45,37 @@ int move_field(FIELD *field, int frow, int fcol);
 .SH DESCRIPTION
 The function \fBset_form_fields\fR changes the field pointer array of
 the given \fIform\fR.  The array must be terminated by a \fBNULL\fR.
 .SH DESCRIPTION
 The function \fBset_form_fields\fR changes the field pointer array of
 the given \fIform\fR.  The array must be terminated by a \fBNULL\fR.

-
+.PP

 The function \fBform_fields\fR returns the field array of the given form.
 The function \fBform_fields\fR returns the field array of the given form.

-
+.PP

 The function \fBfield_count\fR returns the count of fields in \fIform\fR.
 The function \fBfield_count\fR returns the count of fields in \fIform\fR.

-
-The function \fBmove_field\fR move the given field (which must be disconnected)
+.PP
+The function \fBmove_field\fR moves the given field (which must be disconnected)

 to a specified location on the screen.
 .SH RETURN VALUES
 to a specified location on the screen.
 .SH RETURN VALUES

-The function \fBform_fields\fR returns \fBNULL\fR on error.
-
-The function \fBfield_count\fR returns \fBERR\fR (the general
-\fBcurses\fR error return value) on error.
-
+The function \fBform_fields\fR returns a pointer (which may be \fBNULL\fR).
+It does not set errno.
+.PP
+The function \fBfield_count\fR returns \fBERR\fR if the \fIform\fP parameter
+is \fBNULL\fP.
+.PP

 The functions \fBset_form_fields\fR and \fBmove_field\fR return one of
 the following codes on error:
 .TP 5
 The functions \fBset_form_fields\fR and \fBmove_field\fR return one of
 the following codes on error:
 .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.
 .TP 5
 Routine detected an incorrect or out-of-range argument.
 .TP 5

-\fBE_POSTED\fR
+.B E_CONNECTED
+The field is already connected to a form.
+.TP 5
+.B E_POSTED

 The form is already posted.
 .TP 5
 The form is already posted.
 .TP 5

-\fBE_CONNECTED\fR
-The field is already connected to a form.
+.B E_SYSTEM_ERROR
+System error occurred (see \fBerrno\fR).

 .SH SEE ALSO
 \fBcurses\fR(3X), \fBform\fR(3X).
 .SH NOTES
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBform\fR(3X).
 .SH NOTES


@@ -83,9 +84,9 @@ The header file \fB<form.h>\fR automatically includes the header file
 .SH PORTABILITY
 These routines emulate the System V forms library.  They were not supported on
 Version 7 or BSD versions.
 .SH PORTABILITY
 These routines emulate the System V forms library.  They were not supported on
 Version 7 or BSD versions.

-
+.PP

 The SVr4 forms library documentation specifies the \fBfield_count\fR error value
 The SVr4 forms library documentation specifies the \fBfield_count\fR error value

-as -1 (which is the value of \fBERR\fR).
+as \-1 (which is the value of \fBERR\fR).

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