doc: add -llttng-ust-common to linking cmd in manpages
[lttng-ust.git] / doc / man / lttng-ust.3.txt
index 2a3003a72382a1efb6dcb8e75079db165957fa49..aa157019df41dd474fdeef02ed1984a9b79b6ae3 100644 (file)
@@ -65,7 +65,7 @@ SYNOPSIS
 #define *tracepoint*('prov_name', 't_name', ...)
 #define *tracepoint_enabled*('prov_name', 't_name')
 
-Link with `-llttng-ust -ldl`, following this man page.
+Link with `-llttng-ust -llttng-ust-common -ldl`, following this man page.
 
 
 DESCRIPTION
@@ -636,7 +636,7 @@ library containing it) and with `liblttng-ust` and `libdl`
 
 [role="term"]
 ----
-$ cc -o app tp.o app.o -llttng-ust -ldl
+$ cc -o app tp.o app.o -llttng-ust -llttng-ust-common -ldl
 ----
 
 
@@ -686,7 +686,7 @@ It is then linked as a shared library like this:
 
 [role="term"]
 ----
-$ cc -shared -Wl,--no-as-needed -o tp.so tp.o -llttng-ust
+$ cc -shared -Wl,--no-as-needed -o tp.so tp.o -llttng-ust -llttng-ust-common
 ----
 
 This tracepoint provider shared object isn't linked with the user
@@ -755,7 +755,9 @@ man:lttng-add-context(1).
 
 The following context fields are supported by LTTng-UST:
 
-`cpu_id`::
+General context fields::
++
+`cpu_id`:::
     CPU ID.
 +
 NOTE: This context field is always enabled, and it cannot be added
@@ -763,38 +765,106 @@ with man:lttng-add-context(1). Its main purpose is to be used for
 dynamic event filtering. See man:lttng-enable-event(1) for more
 information about event filtering.
 
-`ip`::
+`ip`:::
     Instruction pointer: enables recording the exact address from which
     an event was emitted. This context field can be used to
     reverse-lookup the source location that caused the event
     to be emitted.
 
-`perf:thread:COUNTER`::
+`pthread_id`:::
+    POSIX thread identifier.
++
+Can be used on architectures where `pthread_t` maps nicely to an
+`unsigned long` type.
+
+Process context fields::
++
+`procname`:::
+    Thread name, as set by man:exec(3) or man:prctl(2). It is
+    recommended that programs set their thread name with man:prctl(2)
+    before hitting the first tracepoint for that thread.
+
+`vpid`:::
+    Virtual process ID: process ID as seen from the point of view of the
+    current process ID namespace (see man:pid_namespaces(7)).
+
+`vtid`:::
+    Virtual thread ID: thread ID as seen from the point of view of the
+    current process ID namespace (see man:pid_namespaces(7)).
+
+perf context fields::
++
+`perf:thread:COUNTER`:::
     perf counter named 'COUNTER'. Use `lttng add-context --list` to
     list the available perf counters.
 +
 Only available on IA-32 and x86-64 architectures.
 
-`perf:thread:raw:rN:NAME`::
+`perf:thread:raw:rN:NAME`:::
     perf counter with raw ID 'N' and custom name 'NAME'. See
     man:lttng-add-context(1) for more details.
 
-`pthread_id`::
-    POSIX thread identifier. Can be used on architectures where
-    `pthread_t` maps nicely to an `unsigned long` type.
+Namespace context fields (see man:namespaces(7))::
++
+`cgroup_ns`:::
+    Inode number of the current control group namespace (see
+    man:cgroup_namespaces(7)) in the proc file system.
 
-`procname`::
-    Thread name, as set by man:exec(3) or man:prctl(2). It is
-    recommended that programs set their thread name with man:prctl(2)
-    before hitting the first tracepoint for that thread.
+`ipc_ns`:::
+    Inode number of the current IPC namespace (see
+    man:ipc_namespaces(7)) in the proc file system.
+
+`mnt_ns`:::
+    Inode number of the current mount point namespace (see
+    man:mount_namespaces(7)) in the proc file system.
+
+`net_ns`:::
+    Inode number of the current network namespace (see
+    man:network_namespaces(7)) in the proc file system.
+
+`pid_ns`:::
+    Inode number of the current process ID namespace (see
+    man:pid_namespaces(7)) in the proc file system.
+
+`time_ns`:::
+    Inode number of the current clock namespace (see
+    man:time_namespaces(7)) in the proc file system.
 
-`vpid`::
-    Virtual process ID: process ID as seen from the point of view of
-    the process namespace.
+`user_ns`:::
+    Inode number of the current user namespace (see
+    man:user_namespaces(7)) in the proc file system.
 
-`vtid`::
-    Virtual thread ID: thread ID as seen from the point of view of
-    the process namespace.
+`uts_ns`:::
+    Inode number of the current UTS namespace (see
+    man:uts_namespaces(7)) in the proc file system.
+
+Credential context fields (see man:credentials(7))::
++
+`vuid`:::
+    Virtual real user ID: real user ID as seen from the point of view of
+    the current user namespace (see man:user_namespaces(7)).
+
+`vgid`:::
+    Virtual real group ID: real group ID as seen from the point of view
+    of the current user namespace (see man:user_namespaces(7)).
+
+`veuid`:::
+    Virtual effective user ID: effective user ID as seen from the point
+    of view of the current user namespace (see man:user_namespaces(7)).
+
+`vegid`:::
+    Virtual effective group ID: effective group ID as seen from the
+    point of view of the current user namespace (see
+    man:user_namespaces(7)).
+
+`vsuid`:::
+    Virtual saved set-user ID: saved set-user ID as seen from the point
+    of view of the current user namespace (see man:user_namespaces(7)).
+
+`vsgid`:::
+    Virtual saved set-group ID: saved set-group ID as seen from the
+    point of view of the current user namespace (see
+    man:user_namespaces(7)).
 
 
 [[state-dump]]
@@ -896,6 +966,20 @@ Fields:
 |Debug link file name.
 |===
 
+`lttng_ust_statedump:procname`::
+    The process procname at process start.
++
+Fields:
++
+[options="header"]
+|===
+|Field name |Description
+
+|`procname`
+|The process name.
+
+|===
+
 
 [[ust-lib]]
 Shared library load/unload tracking
@@ -1036,7 +1120,7 @@ like this:
 ----
 $ cc -c -I. tp.c
 $ cc -c app.c
-$ cc -o app tp.o app.o -llttng-ust -ldl
+$ cc -o app tp.o app.o -llttng-ust -llttng-ust-common -ldl
 ----
 
 Using the man:lttng(1) tool, create an LTTng tracing session, enable
@@ -1333,12 +1417,16 @@ The value `0` means _do not wait_. The value `-1` means _wait forever_.
 Setting this environment variable to `0` is recommended for applications
 with time constraints on the process startup time.
 +
-Default: {lttng_ust_register_timeout}.
+Default: 3000.
 
 `LTTNG_UST_WITHOUT_BADDR_STATEDUMP`::
     If set, prevents `liblttng-ust` from performing a base address state
     dump (see the <<state-dump,LTTng-UST state dump>> section above).
 
+`LTTNG_UST_WITHOUT_PROCNAME_STATEDUMP`::
+    If set, prevents `liblttng-ust` from performing a procname state
+    dump (see the <<state-dump,LTTng-UST state dump>> section above).
+
 
 include::common-footer.txt[]
 
This page took 0.025599 seconds and 4 git commands to generate.