X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-create.1.txt;fp=doc%2Fman%2Flttng-create.1.txt;h=4e997e1d10a0720ca3dbaebca0fa35b592c55d13;hp=a1bf9d80e34fecfbda8d3d26adfff99bfc4e4ab9;hb=da39b67ce2828bfc63a02db969048bfe1abd4ca0;hpb=a55e08e0d331c3c0f75fbc76df660e954ee1337a diff --git a/doc/man/lttng-create.1.txt b/doc/man/lttng-create.1.txt index a1bf9d80e..4e997e1d1 100644 --- a/doc/man/lttng-create.1.txt +++ b/doc/man/lttng-create.1.txt @@ -91,7 +91,7 @@ genoption:--relayd-path option. On success, the `create` command sets the current tracing session (see man:lttng-concepts(7) to learn more) to the created tracing session. -See the <> section below for usage examples. +See the ``<>'' section below for usage examples. Show the status of the current tracing session with the man:lttng-status(1) command. @@ -143,7 +143,7 @@ Otherwise::: + Set the trace output destination with the option:--set-url option, or with the option:--ctrl-url and option:--data-url options (see the -<> section below). +``<>'' section below). [[snapshot-mode]]Snapshot mode (option:--snapshot option):: Only write the trace data to the local file system or send it to a @@ -175,8 +175,8 @@ date/time. + Set the trace output destination with the option:--set-url='URL' option, or with the option:--ctrl-url='URL' and option:--data-url='URL' options -(see the <> section below). 'URL' may :not: start -with `file://`. +(see the ``<>'' section below). 'URL' may :not: +start with `file://`. [[url-format]] @@ -195,8 +195,8 @@ file://'TRACEDIR' + The `file://` protocol targets the *local file system*: you may only use such an URL with the option:--set-url option when you create the tracing -session in local or snapshot mode (see the <> section above). +session in local or snapshot mode (see the ``<>'' section above). + 'TRACEDIR'::: Absolute path to the directory containing the trace data on the @@ -210,7 +210,7 @@ Network format:: + This format is only available when you create the tracing session in network streaming, snapshot (option:--snapshot), or live (option:--live) -mode (see the <> section above). +mode (see the ``<>'' section above). + 'NETPROTO'::: Network protocol, amongst: @@ -268,7 +268,7 @@ include::common-lttng-cmd-options-head.txt[] Mode selection ~~~~~~~~~~~~~~ -See the <> section above. +See the ``<>'' section above. At most one of: @@ -320,8 +320,8 @@ date/time. Output ~~~~~~ option:--no-output:: - Depending on the tracing session mode (see the <> section above): + Depending on the tracing session mode (see the ``<>'' section above): + Local mode::: Disable the file system output. @@ -339,15 +339,15 @@ option:--shm-path='DIR':: URL ~~~ -See the <> section above to learn more about the -syntax of the 'URL' argument of the following options. +See the ``<>'' section above to learn more about +the syntax of the 'URL' argument of the following options. option:-C 'URL', option:--ctrl-url='URL':: Set the control path URL to 'URL'. + You must also use the option:--data-url option. + -Not available in local mode (see the <> +Not available in local mode (see the ``<>'' section above). + In snapshot mode, this is equivalent to using the nloption:--ctrl-url @@ -359,7 +359,7 @@ option:-D 'URL', option:--data-url='URL':: + You must also use the option:--ctrl-url option. + -Not available in local mode (see the <> +Not available in local mode (see the ``<>'' section above). + In snapshot mode, this is equivalent to using the nloption:--data-url @@ -371,8 +371,8 @@ option:-U 'URL', option:--set-url='URL':: + This URL remains unchanged as long as the tracing session exists. + -Depending on the tracing session mode (see the <> section above): +Depending on the tracing session mode (see the ``<>'' section above): + Local mode::: 'URL' must start with `file://`, followed with the destination