vm: fix sanity checks on arm
[minix.git] / man / man8 / slip.8
blobf9ed3a122e366c68b3ad7617159fd6617f4f7e68
1 .TH SLIP 8
2 .SH NAME
3 slip \- Serial Line IP
4 .SH SYNOPSIS
5 .B slip
6 .I pseudo-ip-device
7 .SH DESCRIPTION
8 .de SP
9 .if t .sp 0.4
10 .if n .sp
12 The
13 .B slip
14 program implements an Internet network connection over a bidirectional 8-bit
15 transport, usually a serial line.  The protocol used for this connection is
16 the Serial Line Internet Protocol, SLIP for short.
17 .PP
18 The
19 .I pseudo-ip-device
20 argument names one of the
21 .B /dev/psip*
22 devices that is offered by the MINIX 3 TCP/IP driver
23 .BR inet (8).
24 The
25 .B slip
26 program reads IP packets from standard input and writes them to the pseudo
27 IP device, and reads packets from the pseudo IP device and writes them to
28 standard output.  A typical use is like this:
29 .PP
30 .RS
31 .nf
32 .ft B
34         stty raw 115200
35         slip /dev/psip2 &
36 } </dev/tty01 >/dev/tty01
37 .ft P
38 .fi
39 .RE
40 .PP
41 The SLIP protocol is just a very simple packet framing protocol.  It defines
42 two characters as markers on a byte stream to frame packets.  SLIP does
43 not implement any higher level addressing, error detection, or compression.
44 Thanks to its simplicity it can be used under MINIX 3, any other system would
45 prefer to use the Point-to-Point protocol: PPP.
46 .PP
47 The SLIP packet framing protocol as defined in RFC-1055 is as follows:
48 .IP "\-"
49 Packets are delimited by an END character, octal 300.  END is often send at
50 the start of a packet too to reset the logic of the receiver, so that random
51 noise isn't added to the beginning of a packet.
52 .IP "\-"
53 An ESC character (octal 333) is used to escape any END or ESC characters
54 that may occur in an IP packet.  END and ESC are changed to ESC 334 and ESC
55 335 in the data stream.  (Note that END doesn't occur within the data stream
56 at all by escaping it this way, making finding the framing END easier.)
57 .ig
58 .PP
59 The manual page
60 .BR serial-ip (8)
61 describes how to configure the MINIX 3 network devices to be used with a
62 serial IP connection.
64 .SH FILES
65 .TP \w'/dev/psip*'u+5n
66 .B /dev/psip*
67 Pseudo-IP devices for use by
68 .BR slip .
69 .SH "SEE ALSO"
70 .ig
71 .BR ppp (8).
72 .br
74 .BR RFC-1055 .
75 .SH NOTES
76 Under MINIX 3
77 .B slip
78 forks in two to handle the two data streams in or out of the serial line.
79 Under Minix-vmd it uses asynchronous I/O to handle the two streams within
80 one program.
81 .SH AUTHOR
82 Kees J. Bot <kjb@cs.vu.nl>