From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Wed, 24 Oct 2012 13:04:32 +0000 (-0400)
Subject: Manpage: document supported UST contexts
X-Git-Tag: v2.1.0-rc2~24
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=94c9c48da8ea6424c01d17409cc6788f7ea70450;p=lttng-ust.git

Manpage: document supported UST contexts

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3
index c6f1935c..818ef103 100644
--- a/doc/man/lttng-ust.3
+++ b/doc/man/lttng-ust.3
@@ -304,6 +304,38 @@ LD_PRELOAD=liblttng-ust-fork.so appname).
 
 .fi
 
+.SH "CONTEXT"
+
+.PP
+Context information can be prepended by the tracer before each, or some,
+events. The following context information is supported by LTTng-UST:
+.PP
+
+.PP
+.IP "vtid"
+Virtual thread ID: thread ID as seen from the point of view of the
+process namespace.
+.PP
+
+.PP
+.IP "vpid"
+Virtual process ID: process ID as seen from the point of view of the
+process namespace.
+.PP
+
+.PP
+.IP "procname"
+Thread name, as set by exec() or prctl(). It is recommended that
+programs set their thread name with prctl() before hitting the first
+tracepoint for that thread.
+.PP
+
+.PP
+.IP "pthread_id"
+Pthread identifier. Can be used on architectures where pthread_t maps
+nicely to an unsigned long type.
+.PP
+
 .SH "ENVIRONMENT VARIABLES"
 
 .PP