umount: getopt return value is int, not char
[minix.git] / man / man8 / inet.8
bloba61ac3f825199ec86467bdc4e1c029fd32e7dda5
1 .TH INET 8
2 .SH NAME
3 inet, inet.conf \- TCP/IP server
4 .SH SYNOPSIS
5 .B inet
6 .SH DESCRIPTION
7 .de SP
8 .if t .sp 0.4
9 .if n .sp
11 .B Inet
12 is the TCP/IP server.  It is a device driver that interfaces between the
13 file server and the low level ethernet device driver.  The interface to this
14 server is described in
15 .BR ip (4).
16 .PP
17 .B Inet
18 starts as a normal process, reads a the configuration file
19 .B /etc/inet.conf
20 to see what it should do, and uses a few special low level system calls 
21 to turn itself into a server.  The format of the configuration file is as
22 follows:
23 .SS Configuration
24 The inet configuration file is fairly simple, here is an example:
25 .PP
26 .RS
27 .ft C
28 .nf
29 eth0 DP8390 0 { default; };
30 psip1;
31 .fi
32 .ft P
33 .RS
34 .PP
35 It tells that network 0 (the one containing devices
36 .BR eth0 ,
37 .BR ip0 ,
38 .BR tcp0
39 and
40 .BR udp0 )
41 uses the ethernet device driver handled
42 by driver "DP8390" instance 0.  This network is marked as the default
43 network, so most programs use it through the unnumbered devices like
44 .B /dev/tcp
46 .BR /dev/udp .
47 Network 1 is a Pseudo IP network that can be used for
48 a serial IP over a modem for instance.
49 .PP
50 The configuration file uses a simple line-based format.
51 Each network definition has to be fully on its own line.
52 Empty lines and lines that start with a `#' symbol are ignored.
53 The following network definitions are possible:
54 .PP
55 .BI eth N
56 .I driver instance
57 .RI { options };
58 .RS
59 This sets up an ethernet with device name
60 .BI /dev/eth N\fR,
61 built on the given ethernet device driver with the given instance number.
62 (If there are two network cards of the same type
63 then they will be managed by instance 0 and 1 of the corresponding driver.)
64 .br
65 .RE
66 .PP
67 .BI eth N
68 .B vlan
69 .I id
70 .BI eth M
71 .RI { options };
72 \0\0\0\0
73 .RS
74 The ethernet
75 .BI eth N
76 uses VLAN number
77 .I id
78 and is built on ethernet
79 .BI eth M\fR.
80 A packet given to this network has a VLAN tag prefixed to it and is then
81 handed over to another ethernet for transmission.  Likewise a packet on
82 that ethernet carrying the appropriate VLAN tag has this tag removed and is
83 sent on to this network.  The VLAN ethernet behaves like an ordinary ethernet
84 as far as applications are concerned.
85 .RE
86 .PP
87 .BI psip N
88 .RI { options };
89 .RS
90 Creates pseudo IP network
91 .BI /dev/psip N\fR,
92 usable for IP over serial lines, tunnels and whatnot.
93 .RE
94 .SH OPTIONS
95 Some options can be given between braces. 
96 .PP
97 .BR default ;
98 .RS
99 Mark this network as the default network.  Exactly one of the networks must
100 be so marked.
101 When
102 .B inet
103 is started it will check and create all the necessary network devices before
104 becoming a server.  To know what major device number to use it checks
105 .BR /dev/ip ,
106 so that device must already exist.  It can be created by
107 .B MAKEDEV
108 if need be.
111 .BR "no ip" ;
113 .BR "no tcp" ;
115 .BR "no udp" ;
117 These options turn the IP, TCP, or UDP layer off.  Inet will not enable the
118 devices for these layers, and will deactivate code for these layers.
119 Disabling IP will also disable TCP or UDP, because they need IP to function.
120 An ethernet without an IP layer can be used as for stealth listening.  An IP
121 network without TCP or UDP can be used to pester students into creating the
122 missing functionality.  Keeps them off the streets, and maybe they'll learn
123 something.
125 .SH "SEE ALSO"
126 .BR ip (4),
127 .BR boot (8).
128 .SH NOTES
129 The number of networks that can be defined are 2 (Minix-86), 4 (Minix-386)
130 or 16 (Minix-vmd).  This limits both the total number and the highest
131 device number you can use.
133 Getting a network administrator to give you a trunk or multi-VLAN port to
134 run multiple networks on can be a challenge.  It questions their idea that
135 VLANs are separate networks, while in reality it is just one big ethernet.
136 .SH ACKNOWLEDGMENTS
137 Cindy Crawford, for providing invaluable help debugging this server.
138 .SH AUTHOR
139 .ta \w'Manual:'u+2n
140 Code:   Philip Homburg <philip@cs.vu.nl>
142 Manual: Kees J. Bot <kjb@cs.vu.nl>
145 .\" $PchId: inet.8,v 1.6 2001/10/08 19:01:35 philip Exp $