Manpage: cleanup layout of add-context
[lttng-tools.git] / doc / man / lttng.1
index 484b365b4d9787bbf1d6b99e07d7e71c0ff2e52a..87afb37b2c5a05b78c18ed54304458eec201dfaa 100644 (file)
@@ -82,9 +82,9 @@ Simple listing of lttng options.
 Simple listing of lttng commands.
 .SH "COMMANDS"
 
-.TP
+.PP
 \fBadd-context\fP
-.nf
+.RS
 Add context to event(s) and/or channel(s).
 
 A context is basically extra information appended to a channel. For instance,
@@ -96,7 +96,10 @@ For example, this command will add the context information 'prio' and two perf
 counters (hardware branch misses and cache misses), to all events in the trace
 data output:
 
-# lttng add-context \-k \-t prio \-t perf:branch-misses \-t perf:cache-misses
+.nf
+# lttng add-context \-k \-t prio \-t perf:branch-misses \\
+               \-t perf:cache-misses
+.fi
 
 Please take a look at the help (\-h/\-\-help) for a detailed list of available
 contexts.
@@ -107,25 +110,30 @@ Otherwise the context will be added only to the given channel (\-c).
 
 If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
 file.
-.fi
 
 .B OPTIONS:
 
-.nf
-\-h, \-\-help
-        Show summary of possible options and commands.
-\-s, \-\-session NAME
-        Apply on session name.
-\-c, \-\-channel NAME
-        Apply on channel name.
-\-k, \-\-kernel
-        Apply for the kernel tracer
-\-u, \-\-userspace
-        Apply for the user-space tracer
-\-t, \-\-type TYPE
-        Context type. You can repeat this option on the command line. Please
-        use "lttng add-context \-h" to list all available types.
-.fi
+.TP
+.BR "\-h, \-\-help"
+Show summary of possible options and commands.
+.TP
+.BR "\-s, \-\-session NAME"
+Apply on session name.
+.TP
+.BR "\-c, \-\-channel NAME"
+Apply on channel name.
+.TP
+.BR "\-k, \-\-kernel"
+Apply for the kernel tracer
+.TP
+.BR "\-u, \-\-userspace"
+Apply for the user-space tracer
+.TP
+.BR "\-t, \-\-type TYPE"
+Context type. You can repeat this option on the command line. Please
+use "lttng add-context \-h" to list all available types.
+.RE
+.PP
 
 .IP
 
@@ -230,6 +238,13 @@ a non-writeable home directory.
         Simple listing of options
 \-o, \-\-output PATH
         Specify output path for traces
+\-\-no-output
+       Traces will not be outputed
+\-\-snapshot
+       Set the session in snapshot mode. Created in no-output mode
+       and uses the URL, if one, as the default snapshot output.
+       Every channel will be set in overwrite mode and with mmap
+       output (splice not supported).
 
 Using these options, each API call can be controlled individually. For
 instance, \-C does not enable the consumer automatically. You'll need the \-e
@@ -645,12 +660,17 @@ rather then in mysnapshot*/
 .B LONG OPTIONS
 
 .nf
-\-s, \-\-session NAME   Apply to session name.
-\-n, \-\-name NAME      Name of the snapshot's output.
-\-m, \-\-max-size SIZE  Maximum size in bytes of the snapshot.
-                        The maxium size does not count the metadata file.
-\-C, \-\-ctrl-url URL   Set control path URL. (Must use -D also)
-\-D, \-\-data-url URL   Set data path URL. (Must use -C also)
+\-s, \-\-session NAME
+        Apply to session name.
+\-n, \-\-name NAME
+        Name of the snapshot's output.
+\-m, \-\-max-size SIZE
+        Maximum size in bytes of the snapshot. The maxium size does not
+        include the metadata file.
+\-C, \-\-ctrl-url URL
+        Set control path URL. (Must use -D also)
+\-D, \-\-data-url URL
+        Set data path URL. (Must use -C also)
 .fi
 
 .IP
This page took 0.024321 seconds and 4 git commands to generate.