X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-snapshot.1.txt;h=e4a02033a99394008c11bb4a339a5860e77c96d2;hp=2d2b6c68fd5d5167c2b00a8485c12f0dd8769de0;hb=62482ec6cc82b5ee233683ad0a9066974b705edb;hpb=4fd116d0a92783f76416ae77d41b28690e553380 diff --git a/doc/man/lttng-snapshot.1.txt b/doc/man/lttng-snapshot.1.txt index 2d2b6c68f..e4a02033a 100644 --- a/doc/man/lttng-snapshot.1.txt +++ b/doc/man/lttng-snapshot.1.txt @@ -12,25 +12,25 @@ SYNOPSIS Add a snapshot output: [verse] -*lttng* ['GENERAL OPTIONS'] *snapshot add-output* [option:--max-size='SIZE'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *snapshot add-output* [option:--max-size='SIZE'] [option:--name='NAME'] [option:--session='SESSION'] (option:--ctrl-url='URL' option:--data-url='URL' | 'URL') Remove a snapshot output: [verse] -*lttng* ['GENERAL OPTIONS'] *snapshot del-output* [option:--session='SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *snapshot del-output* [option:--session='SESSION'] ('ID' | 'NAME') List current snapshot outputs: [verse] -*lttng* ['GENERAL OPTIONS'] *snapshot list-output* [option:--session='SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *snapshot list-output* [option:--session='SESSION'] Take a snapshot: [verse] -*lttng* ['GENERAL OPTIONS'] *snapshot record* [option:--max-size='SIZE'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *snapshot record* [option:--max-size='SIZE'] [option:--name='NAME'] [option:--session='SESSION'] (option:--ctrl-url='URL' option:--data-url='URL' | 'URL') @@ -46,7 +46,7 @@ is sent to the registered snapshot outputs. The tracing session should be created in _snapshot mode_ to make sure taking snapshots is allowed. This is done at tracing session creation -time using the linklttng:lttng-create(1) command. +time using the man:lttng-create(1) command. Note that, when a snapshot is taken, the sub-buffers are not cleared. This means that different recorded snapshots may contain the same @@ -63,7 +63,7 @@ As of this version, only one snapshot output is allowed. A snapshot output can be added using the `add-output` action. The output destination URL is set using either the 'URL' positional argument, or both the option:--ctrl-url and option:--data-url options. -See linklttng:lttng-create(1) to learn more about the URL format. +See man:lttng-create(1) to learn more about the URL format. A name can be assigned to an output when adding it using the option:--name option. This name is part of the names of the @@ -95,10 +95,10 @@ options supported by the `add-output` action. NOTE: Before taking a snapshot on a system with a high event throughput, it is recommended to first run `lttng stop` (see -linklttng:lttng-stop(1)). Otherwise, the snapshot could contain "holes", +man:lttng-stop(1)). Otherwise, the snapshot could contain "holes", the result of the tracers overwriting unconsumed trace packets during the record operation. After the snapshot is recorded, the tracers can be -started again with `lttng start` (see linklttng:lttng-start(1)). +started again with `lttng start` (see man:lttng-start(1)). include::common-cmd-options-head.txt[] @@ -139,4 +139,4 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -linklttng:lttng(1) +man:lttng(1)