1 .\" Copyright (C) 2003-2004 Cronyx Engineering.
2 .\" Copyright (C) 2003-2004 Roman Kurakin <rik@cronyx.ru>
4 .\" This software is distributed with NO WARRANTIES, not even the implied
5 .\" warranties for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7 .\" Authors grant any other persons or organisations a permission to use,
8 .\" modify and redistribute this software in source and binary forms,
9 .\" as long as this message is kept with the software, all derivative
10 .\" works or modified versions.
12 .\" Cronyx Id: ng_sppp.4,v 1.1.2.3 2004/03/30 14:28:34 rik Exp $
20 .Nd sppp netgraph node type
22 .In netgraph/ng_sppp.h
28 interface to the original
30 network module for synchronous lines.
33 supports PPP and Cisco HDLC protocols.
36 node could be considered as an alternative kernel mode PPP
41 and as an alternative to
44 While having less features than
48 it is significantly easier to use in the majority of simple configurations,
49 and allows the administrator to not install the
54 you do not need any other nodes, not even an
59 node is created, a new interface appears which is accessible via
61 Network interfaces corresponding to
66 When a node is shut down, the corresponding interface is removed,
67 and the interface name becomes available for reuse by future
70 New nodes always take the first unused interface.
71 The node itself is assigned the same name as its interface, unless the name
72 already exists, in which case the node remains unnamed.
75 node allows drivers written to the old
77 interface to be rewritten using the
80 interface, and still behave in a compatible manner without supporting both
85 node has a single hook named
87 Usually it is connected directly to
92 nodes support the Berkeley Packet Filter,
95 This node type supports the following hooks:
96 .Bl -tag -width ".Va downstream"
98 The connection to the synchronous line.
101 This node type supports the generic control messages, plus the following:
102 .Bl -tag -width indent
103 .It Dv NGM_IFACE_GET_IFNAME
104 Returns the name of the interface corresponding to this node in a
105 .Vt "struct ng_iface_ifname" :
106 .Bd -literal -offset indent
107 struct ng_iface_ifname {
108 char ngif_name[NG_SPPP_IFACE_NAME_MAX + 1];
113 This node shuts down upon receipt of a
116 The associated interface is removed and becomes available
121 Unlike most other node types and like
127 go away when all hooks have been disconnected; rather, an explicit
129 control message is required.
131 For example, if you have the
133 device, you could run PPP over it with just one command:
135 .Dl "ngctl mkpeer cx0: sppp rawdata downstream"
139 interface (if this was the first
144 as a normal network interface,
162 For complex networking topologies you may want to look at
168 node type was implemented for
170 It was included to the system since
173 Copyright (C) 2003-2004
174 .An Roman Kurakin Aq rik@cronyx.ru .