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

1 files changed, 107 insertions, 0 deletions

diff --git a/man/stapprobes.process.5.in b/man/stapprobes.process.5.in
new file mode 100644
index 00000000..99418ea5
--- /dev/null
+++ b/man/stapprobes.process.5.in
@@ -0,0 +1,107 @@
+.\" -*- nroff -*-
+.TH STAPPROBES.PROCESS 5 @DATE@ "Intel, IBM"
+.SH NAME
+stapprobes.process \- systemtap process 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 process activities.
+It contains the following probe points:
+
+.P
+.TP 
+.B process.create
+
+Fires whenever a new process is successfully created, either as a 
+result of one of the fork syscall variants, or a new kernel thread.
+
+.B Arguments:
+
+.I task
+  a handle to the newly created process
+
+.I new_pid
+  pid of the newly created process
+
+.P
+.TP 
+.B process.start
+
+Fires immediately before a new process begins execution.
+
+.B Arguments:
+
+.I N/A
+
+.P
+.TP
+.B process.exec
+
+Fires whenever a process attempts to exec to a new program
+
+.B Arguments:
+
+.I filename
+  the path to the new executable
+
+.P
+.TP
+.B process.exec_complete
+
+Fires at the completion of an exec call
+
+.B Arguments:
+
+.I errno
+  the error number resulting from the exec
+
+.I success
+  a boolean indicating whether the exec was successful
+
+.P
+.TP
+.B process.exit
+
+Fires when a process terminates. This will always be followed by a
+process.release, though the latter may be delayed if the process 
+waits in a zombie state.
+
+.B Arguments:
+
+.I code
+  the exit code of the process
+
+.P
+.TP
+.B process.release
+
+Fires when a process is released from the kernel. This always 
+follows a process.exit, though it may be delayed somewhat if the 
+process waits in a zombie state.
+
+.B Arguments:
+
+.I task
+  a task handle to the process being released
+
+.I pid
+  pid of the process being released
+
+.SH SEE ALSO
+.IR stap (1),
+.IR stapprobes (5),
+.IR lket (5)
+