Docs: clarify lttng.1 shm-path section

[lttng-tools.git] / doc / man / lttng.1

diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
index fd62558eec7a8e53ea60104be2c2c1b67727fa9f..f2b08bbfa9f6d665d499c0b364adde8b261e8c2f 100644 (file)
--- a/doc/man/lttng.1
+++ b/doc/man/lttng.1
@@ -302,6 +302,13 @@ $ lttng start
 After the start, you'll be able to read the events while they are being
 recorded in /tmp/lttng.
 
+.TP
+.BR "\-\-shm-path PATH"
+
+Path where shared memory holding buffers should be created. Useful
+when used with PRAMFS or other persistent memory filesystems to extract
+trace data in the event of a crash requiring a reboot.
+
 .TP
 .BR "\-U, \-\-set-url=URL"
 Set URL for the consumer output destination. It is persistent for the