Committer: Michael Beasley <mike@snafu.setup>
[mikesnafu-overlay.git] / Documentation / DocBook / networking.tmpl
blobf24f9e85e4aeba788d7b4557bf19d93efaa7dc99
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
5 <book id="LinuxNetworking">
6 <bookinfo>
7 <title>Linux Networking and Network Devices APIs</title>
9 <legalnotice>
10 <para>
11 This documentation is free software; you can redistribute
12 it and/or modify it under the terms of the GNU General Public
13 License as published by the Free Software Foundation; either
14 version 2 of the License, or (at your option) any later
15 version.
16 </para>
18 <para>
19 This program is distributed in the hope that it will be
20 useful, but WITHOUT ANY WARRANTY; without even the implied
21 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
22 See the GNU General Public License for more details.
23 </para>
25 <para>
26 You should have received a copy of the GNU General Public
27 License along with this program; if not, write to the Free
28 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
29 MA 02111-1307 USA
30 </para>
32 <para>
33 For more details see the file COPYING in the source
34 distribution of Linux.
35 </para>
36 </legalnotice>
37 </bookinfo>
39 <toc></toc>
41 <chapter id="netcore">
42 <title>Linux Networking</title>
43 <sect1><title>Networking Base Types</title>
44 !Iinclude/linux/net.h
45 </sect1>
46 <sect1><title>Socket Buffer Functions</title>
47 !Iinclude/linux/skbuff.h
48 !Iinclude/net/sock.h
49 !Enet/socket.c
50 !Enet/core/skbuff.c
51 !Enet/core/sock.c
52 !Enet/core/datagram.c
53 !Enet/core/stream.c
54 </sect1>
55 <sect1><title>Socket Filter</title>
56 !Enet/core/filter.c
57 </sect1>
58 <sect1><title>Generic Network Statistics</title>
59 !Iinclude/linux/gen_stats.h
60 !Enet/core/gen_stats.c
61 !Enet/core/gen_estimator.c
62 </sect1>
63 <sect1><title>SUN RPC subsystem</title>
64 <!-- The !D functionality is not perfect, garbage has to be protected by comments
65 !Dnet/sunrpc/sunrpc_syms.c
66 -->
67 !Enet/sunrpc/xdr.c
68 !Enet/sunrpc/svc_xprt.c
69 !Enet/sunrpc/xprt.c
70 !Enet/sunrpc/sched.c
71 !Enet/sunrpc/socklib.c
72 !Enet/sunrpc/stats.c
73 !Enet/sunrpc/rpc_pipe.c
74 !Enet/sunrpc/rpcb_clnt.c
75 !Enet/sunrpc/clnt.c
76 </sect1>
77 </chapter>
79 <chapter id="netdev">
80 <title>Network device support</title>
81 <sect1><title>Driver Support</title>
82 !Enet/core/dev.c
83 !Enet/ethernet/eth.c
84 !Enet/sched/sch_generic.c
85 !Iinclude/linux/etherdevice.h
86 !Iinclude/linux/netdevice.h
87 </sect1>
88 <sect1><title>PHY Support</title>
89 !Edrivers/net/phy/phy.c
90 !Idrivers/net/phy/phy.c
91 !Edrivers/net/phy/phy_device.c
92 !Idrivers/net/phy/phy_device.c
93 !Edrivers/net/phy/mdio_bus.c
94 !Idrivers/net/phy/mdio_bus.c
95 </sect1>
96 <!-- FIXME: Removed for now since no structured comments in source
97 <sect1><title>Wireless</title>
98 X!Enet/core/wireless.c
99 </sect1>
101 <sect1><title>Synchronous PPP</title>
102 !Edrivers/net/wan/syncppp.c
103 </sect1>
104 </chapter>
106 </book>