8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man4 / ncaport.conf.4
blobbe865fb174c42fbde0e682c17ccb6e8ab5fc3486
1 '\" te
2 .\" Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH NCAPORT.CONF 4 "Jul 30, 2001"
7 .SH NAME
8 ncaport.conf \- ncaport configuration file
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/etc/nca/ncaport.conf\fR
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBncaport.conf\fR file is used to configure the IP addresses and ports
19 that the Solaris Network Cache and Acceleration (NCA) kernel module services.
20 The file contains two fields, key and value, in the format of
21 \fBncaport=\fIipaddress\fR/\fIport\fR\fR. IPv4 addresses must be in the dot
22 notation \fId\fR.\fId\fR.\fId\fR.\fId\fR. IPv6 addresses must be in one of the
23 three conventional forms (see \fBinet_pton\fR(3SOCKET)). If an asterisk
24 (\fB*\fR) is used for an IP address, it is interpreted as \fBINADDR_ANY\fR,
25 which matches any IP address.
26 .sp
27 .LP
28 A web server uses the environment variable \fBLD_PRELOAD\fR and the
29 \fBncaport.conf\fR configuration file to convert an \fBAF_INET\fR socket to an
30 \fBAF_NCA\fR socket. \fBLD_PRELOAD\fR enables the NCA socket utility library to
31 be loaded before \fBlibsocket.so.1\fR. See the \fBncad_addr\fR(4) for details.
32 When a web server issues the \fBbind\fR(3SOCKET) system call, it is intercepted
33 by the interposition library \fBncad_addr.so\fR. If the bind address is in the
34 \fBncaport.conf\fR file, the \fBAF_INET\fR socket is converted to a
35 \fBAF_NCA\fR socket.
36 .SH EXAMPLES
37 .LP
38 \fBExample 1 \fRSample \fBncaport.conf\fR File
39 .sp
40 .LP
41 The following is a sample \fBncaport.conf\fR file:
43 .sp
44 .in +2
45 .nf
47 # NCA Kernel Module Port Configuration File
49 ncaport=1080:0:0:0:8:800:200C:417A/100
50 ncaport=192.168.84.71/80
51 ncaport=*/9000
52 .fi
53 .in -2
54 .sp
56 .SH SEE ALSO
57 .sp
58 .LP
59 \fBnca\fR(1), \fBbind\fR(3SOCKET), \fBinet_pton\fR(3SOCKET),
60 \fBncad_addr\fR(4), \fBattributes\fR(5)
61 .SH NOTES
62 .sp
63 .LP
64 For those web servers that use \fBAF_NCA\fR sockets, the NCA port configuration
65 described here has no effect.
66 .sp
67 .LP
68 NCA does not currently support IPv6. Any IPv6 addresses in the file
69 \fBncaport.conf\fR are ignored.