summaryrefslogtreecommitdiffstats
path: root/man/tapset::tcp.3stap
diff options
context:
space:
mode:
authorWilliam Cohen <wcohen@redhat.com>2010-03-09 19:53:52 -0500
committerWilliam Cohen <wcohen@redhat.com>2010-03-09 20:14:19 -0500
commitc24a9d9a9795fac838c4074494006e6e7e1e8835 (patch)
treeee5f4ddc417ae69ea707ad5f92550f8c91544c4e /man/tapset::tcp.3stap
parentc0f562688ae877000f46058f748a8b986679863e (diff)
downloadsystemtap-steved-c24a9d9a9795fac838c4074494006e6e7e1e8835.tar.gz
systemtap-steved-c24a9d9a9795fac838c4074494006e6e7e1e8835.tar.xz
systemtap-steved-c24a9d9a9795fac838c4074494006e6e7e1e8835.zip
PR 11210 move stapprobe.* man pages to tapset::*
Complete the renaming scheme with prefix of "tapset::" for the man pages related to over all description of groups of probes.
Diffstat (limited to 'man/tapset::tcp.3stap')
-rw-r--r--man/tapset::tcp.3stap102
1 files changed, 102 insertions, 0 deletions
diff --git a/man/tapset::tcp.3stap b/man/tapset::tcp.3stap
new file mode 100644
index 00000000..8ebfccb7
--- /dev/null
+++ b/man/tapset::tcp.3stap
@@ -0,0 +1,102 @@
+.\" -*- nroff -*-
+.TH TAPSET::TCP 3stap "" "IBM, Intel"
+.SH NAME
+tapset::tcp \- systemtap tcp 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 TCP layer activities.
+It contains the following probe points:
+
+.P
+.TP
+.B tcp.sendmsg
+
+Fires whenever sending a tcp message
+
+.B Arguments:
+
+.I sock
+ network socket
+
+.I size
+ number of bytes to send
+
+.P
+.TP
+.B tcp.sendmsg.return
+
+Fires whenever sending message is done
+
+.B Arguments:
+
+.I size
+ number of bytes sent
+
+.P
+.TP
+.B tcp.recvmsg
+
+Fires whenever a message is received
+
+.B Arguments:
+
+.I sock
+ network socket
+
+.I size
+ number of bytes to be received
+
+.P
+.TP
+.B tcp.recvmsg.return
+
+Fires whenever message receiving is done
+
+.B Arguments:
+
+.I size
+ number of bytes received
+
+.P
+.TP
+.B tcp.disconnect
+
+Fires whenever tcp is disconnected
+
+.B Arguments:
+
+.I sock
+ network socket
+
+.I flags
+ TCP flags (e.g. FIN, etc)
+
+.P
+.TP
+.B tcp.disconnect.return
+
+Fires when returning from tcp.disconnect
+
+.B Arguments:
+
+.I ret
+ error code (0: no error)
+
+.SH SEE ALSO
+.IR stap (1),
+.IR stapprobes (3stap)
+