create src/man/stapprobes.*.in for detailed stap probe points.

1 files changed, 78 insertions, 0 deletions

diff --git a/man/stapprobes.netdev.5.in b/man/stapprobes.netdev.5.in
new file mode 100644
index 00000000..237f5d74
--- /dev/null
+++ b/man/stapprobes.netdev.5.in
@@ -0,0 +1,78 @@
+.\" -*- nroff -*-
+.TH STAPPROBES.NETDEV 5 @DATE@ "IBM"
+.SH NAME
+stapprobes.netdev \- systemtap network device probe points
+
+.\" macros
+.de SAMPLE
+.br
+.RS
+.nf
+.nh
+..
+.de ESAMPLE
+.hy
+.fi
+.RE
+..
+
+.SH DESCRIPTION
+
+This family of probe points is used to probe the activities of network
+device. 
+It contains the following probe points:
+
+.P
+.TP 
+.B netdev.receive
+Fires when data arrives on network device
+
+.B Arguments:
+
+.I dev_name
+  The name of the device. e.g: eth0, ath1
+
+.I length
+  The length of the receiving buffer
+
+.I protocol
+  The possible values of protocol could be:
+     0800    IP
+     8100    802.1Q VLAN
+     0001    802.3
+     0002    AX.25
+     0004    802.2
+     8035    RARP
+     0005    SNAP
+     0805    X.25
+     0806    ARP
+     8137    IPX
+     0009    Localtalk
+     86DD    IPv6
+
+.I truesize
+  The size of the received data
+
+.P
+.TP 
+.B netdev.transmit
+Fires when the network device wants to transmit a buffer
+
+.B Arguments:
+
+.I dev_name
+  The name of the device. e.g: eth0, ath1
+
+.I length
+  The length of the transmit buffer
+
+.I protocol
+  The protocol of this packet.
+
+.I truesize
+  The size of the the data to be transmitted.
+
+.SH SEE ALSO
+.IR stap (1),
+.IR stapprobes (5),
+.IR lket (5)