dhcpcd: update README.DRAGONFLY
[dragonfly.git] / sbin / nos-tun / nos-tun.8
blobc7588b65ef46b7cd7b1d792c744366f158034439
1 .\"
2 .\" ----------------------------------------------------------------------------
3 .\" "THE BEER-WARE LICENSE" (Revision 42):
4 .\" <phk@FreeBSD.org> wrote this file.  As long as you retain this notice you
5 .\" can do whatever you want with this stuff. If we meet some day, and you think
6 .\" this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
7 .\" ----------------------------------------------------------------------------
8 .\"
9 .\" $FreeBSD: src/sbin/nos-tun/nos-tun.8,v 1.6.2.6 2003/02/23 20:53:46 trhodes Exp $
10 .\"
11 .Dd August 23, 2018
12 .Dt NOS-TUN 8
13 .Os
14 .Sh NAME
15 .Nm nos-tun
16 .Nd implement ``nos'' or ``ka9q'' style IP over IP tunnel
17 .Sh SYNOPSIS
18 .Nm
19 .Fl s
20 .Ar source
21 .Fl d
22 .Ar destination
23 .Fl p
24 .Ar protocol_number
25 .Ar target
26 .Sh DESCRIPTION
27 The
28 .Nm
29 utility is used to establish an
30 .Em nos
31 style tunnel (also known as
32 .Em ka9q
34 .Em IP-IP
35 tunnel) using a
36 .Xr tun 4
37 kernel interface.
38 .Pp
39 .Ar Source
40 and
41 .Ar destination
42 are the addresses used on the tunnel device.
43 If you configure the tunnel against a cisco router, use a netmask of
44 .Dq 255.255.255.252
45 on the cisco.  This is because the tunnel is a point-to-point interface
46 in the
47 .Dx
48 end, a concept cisco doesn't really implement.
49 .Pp
50 .Ar Protocol number
51 sets tunnel mode.
52 Original KA9Q NOS uses 94 but many people use 4
53 in worldwide backbone of ampr.org.
54 .Pp
55 .Ar Target
56 is the address of the remote tunnel device, this must match the source
57 address set on the remote end.
58 .Sh EXAMPLES
59 This end, a
60 .Dx
61 box on address 192.168.59.34:
62 .Bd -literal -offset indent
63 nos-tun -s 192.168.61.1 -d 192.168.61.2 192.168.56.45
64 .Ed
65 .Pp
66 Remote cisco on address 192.168.56.45:
67 .Bd -literal -offset indent
68 interface tunnel 0
69 ip address 192.168.61.2 255.255.255.252
70 tunnel mode nos
71 tunnel destination 192.168.59.34
72 tunnel source 192.168.56.45
73 .Ed
74 .Sh HISTORY
75 The
76 .Nm
77 utility appeared in
78 .Fx 3.0 .
79 .Sh AUTHORS
80 .An -nosplit
81 .An Nickolay N. Dudorov Aq Mt nnd@itfs.nsk.su
82 wrote the program,
83 .An Poul-Henning Kamp Aq Mt phk@FreeBSD.org
84 wrote the man-page.
85 .An Isao SEKI Aq Mt iseki@gongon.com
86 added a new flag, IP protocol number.
87 .Sh BUGS
88 We don't allow for setting our source address for multihomed machines.