Added utrace probe documentation.

2008-04-18  David Smith  <dsmith@redhat.com>

	* stapprobes.5.in: Added information about utrace probes.

1 files changed, 34 insertions, 0 deletions

diff --git a/stapprobes.5.in b/stapprobes.5.in
index ce8ef52d..fdba10be 100644
--- a/stapprobes.5.in
+++ b/stapprobes.5.in
@@ -306,6 +306,40 @@ in that both use raw (unverified) virtual addresses and provide
 no $variables.  The target PID parameter must identify a running
 process, and ADDRESS should identify a valid instruction address.
 All threads of that process will be probed.
+.PP
+Additional user-space probing is available in the following forms:
+.SAMPLE
+process(PID).clone
+process("PATH").clone
+process(PID).death
+process("PATH").death
+process(PID).syscall
+process("PATH").syscall
+process(PID).syscall.return
+process("PATH").syscall.return
+.ESAMPLE
+.PP
+A
+.B .clone
+probe gets called when a thread described by PID or PATH creates a new
+thread.
+A
+.B .death
+probe gets called when a thread described by PID or PATH dies.
+A
+.B .syscall
+probe gets called when a thread described by PID or PATH makes a
+system call.  The system call number is available in the "$syscall"
+context variable.
+A
+.B .syscall.return
+probe gets called when a thread described by PID or PATH returns from a
+system call.  The system call number is available in the "$syscall"
+context variable.
+.PP
+Note that
+.I PATH
+pathnames must be absolute.
 
 .SS PROCFS