| Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 1 | .\"*************************************************************************** |
| 2 | .\" Copyright (c) 2010,2013 Free Software Foundation, Inc. * |
| 3 | .\" * |
| 4 | .\" Permission is hereby granted, free of charge, to any person obtaining a * |
| 5 | .\" copy of this software and associated documentation files (the * |
| 6 | .\" "Software"), to deal in the Software without restriction, including * |
| 7 | .\" without limitation the rights to use, copy, modify, merge, publish, * |
| 8 | .\" distribute, distribute with modifications, sublicense, and/or sell * |
| 9 | .\" copies of the Software, and to permit persons to whom the Software is * |
| 10 | .\" furnished to do so, subject to the following conditions: * |
| 11 | .\" * |
| 12 | .\" The above copyright notice and this permission notice shall be included * |
| 13 | .\" in all copies or substantial portions of the Software. * |
| 14 | .\" * |
| 15 | .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| 16 | .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| 17 | .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| 18 | .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| 19 | .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| 20 | .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| 21 | .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| 22 | .\" * |
| 23 | .\" Except as contained in this notice, the name(s) of the above copyright * |
| 24 | .\" holders shall not be used in advertising or otherwise to promote the * |
| 25 | .\" sale, use or other dealings in this Software without prior written * |
| 26 | .\" authorization. * |
| 27 | .\"*************************************************************************** |
| 28 | .\" |
| 29 | .\" $Id: form_variables.3x,v 1.4 2013/06/22 17:58:32 tom Exp $ |
| 30 | .TH form_variables 3X "" |
| 31 | .ds n 5 |
| 32 | .na |
| 33 | .hy 0 |
| 34 | .SH NAME |
| 35 | \fBTYPE_ALNUM\fR, |
| 36 | \fBTYPE_ALPHA\fR, |
| 37 | \fBTYPE_ENUM\fR, |
| 38 | \fBTYPE_INTEGER\fR, |
| 39 | \fBTYPE_IPV4\fR, |
| 40 | \fBTYPE_NUMERIC\fR, |
| 41 | \fBTYPE_REGEXP\fR |
| 42 | \- form system global variables |
| 43 | .ad |
| 44 | .hy |
| 45 | .SH SYNOPSIS |
| 46 | .nf |
| 47 | \fB#include <form.h>\fR |
| 48 | .PP |
| 49 | \fBFIELDTYPE * TYPE_ALNUM;\fR |
| 50 | \fBFIELDTYPE * TYPE_ALPHA;\fR |
| 51 | \fBFIELDTYPE * TYPE_ENUM;\fR |
| 52 | \fBFIELDTYPE * TYPE_INTEGER;\fR |
| 53 | \fBFIELDTYPE * TYPE_IPV4;\fR |
| 54 | \fBFIELDTYPE * TYPE_NUMERIC;\fR |
| 55 | \fBFIELDTYPE * TYPE_REGEXP;\fR |
| 56 | .fi |
| 57 | .SH DESCRIPTION |
| 58 | These are building blocks for the form library, |
| 59 | defining fields that can be created using \fBset_fieldtype\fP(3X). |
| 60 | Each provides functions for field- and character-validation, |
| 61 | according to the given datatype. |
| 62 | .SS TYPE_ALNUM |
| 63 | This holds alphanumeric data. |
| 64 | .SS TYPE_ALPHA |
| 65 | This holds alphabetic data. |
| 66 | .SS TYPE_ENUM |
| 67 | This holds an enumerated type. |
| 68 | .SS TYPE_INTEGER |
| 69 | This holds a decimal integer. |
| 70 | .SS TYPE_IPV4 |
| 71 | This holds an IPv4 internet address, e.g., "127.0.0.1". |
| 72 | .SS TYPE_NUMERIC |
| 73 | This holds a decimal number, with optional sign and decimal point. |
| 74 | .SS TYPE_REGEXP |
| 75 | This holds a regular expression. |
| 76 | .SH PORTABILITY |
| 77 | The \fBTYPE_IPV4\fP variable is an extension not provided by older |
| 78 | implementations of the form library. |
| 79 | .SH SEE ALSO |
| 80 | \fBform\fR(3X). |