X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-create.1.txt;h=152e3f39364ee8f5e8795fa8baf2bbcb3feb4ba5;hp=46f2557a07ac90158d7a3c7fbe87e6a51ca4bcd8;hb=1f3c3a24e3a07f6fd032ad50bac92f1f58d33a12;hpb=1f5cd9d570b9f592aee0a80f68617001805fd77f diff --git a/doc/man/lttng-create.1.txt b/doc/man/lttng-create.1.txt index 46f2557a0..152e3f393 100644 --- a/doc/man/lttng-create.1.txt +++ b/doc/man/lttng-create.1.txt @@ -12,27 +12,25 @@ SYNOPSIS Local mode: [verse] -*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* [option:--shm-path='PATH'] - [option:--no-output | option:--output='PATH' | option:--set-url=file://'PATH'] ['SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* ['SESSION'] [option:--shm-path='PATH'] + [option:--no-output | option:--output='PATH' | option:--set-url=file://'PATH'] Network streaming mode: [verse] -*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* [option:--shm-path='PATH'] - (option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL') ['SESSION'] - +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* ['SESSION'] [option:--shm-path='PATH'] + (option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL') Snapshot mode: [verse] -*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* option:--snapshot [option:--shm-path='PATH'] - [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL'] ['SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* ['SESSION'] option:--snapshot + [option:--shm-path='PATH'] [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL'] Live mode: [verse] -*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* option:--live[='DELAYUS'] [option:--shm-path='PATH'] - [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL'] ['SESSION'] - +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* ['SESSION'] option:--live[='DELAYUS'] + [option:--shm-path='PATH'] [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL'] DESCRIPTION ----------- @@ -69,7 +67,7 @@ Creation modes ~~~~~~~~~~~~~~ There are four tracing session modes: -Local mode:: +[[local-mode]]Local mode:: Traces the local system and writes the trace to the local file system. The option:--output option specifies the trace path. Using option:--set-url=file://'PATH' is the equivalent of using @@ -80,14 +78,14 @@ If none of the options mentioned above are used, then the trace is written locally in the `$LTTNG_HOME/lttng-traces` directory (`$LTTNG_HOME` defaults to `$HOME`). -Network streaming mode:: +[[network-streaming-mode]]Network streaming mode:: Traces the local system and sends the trace over the network to a listening relay daemon (see man:lttng-relayd(8)). The option:--set-url, or option:--ctrl-url and option:--data-url options set the trace output destination (see the <> section below). -Snapshot mode:: +[[snapshot-mode]]Snapshot mode:: Traces the local system without writing the trace to the local file system (implicit option:--no-output option). Channels are automatically configured to be snapshot-ready on creation (see @@ -96,7 +94,7 @@ Snapshot mode:: The option:--set-url, or option:--ctrl-url and option:--data-url options set the default snapshot output destination. -Live mode:: +[[live-mode]]Live mode:: Traces the local system, sending trace data to an LTTng relay daemon over the network (see man:lttng-relayd(8)). The option:--set-url, or option:--ctrl-url and option:--data-url options @@ -118,12 +116,15 @@ file://'TRACEPATH' 'NETPROTO'://('HOST' | 'IPADDR')[:__CTRLPORT__[:__DATAPORT__]][/'TRACEPATH'] The `file://` protocol targets the *local file system* and can only -be used as the option:--set-url option's argument in _local mode_. +be used as the option:--set-url option's argument when the session is +created in <> or <> mode. 'TRACEPATH':: Absolute path to trace files on the local file system. -The other version is used for the _network streaming mode_. +The other version is available when the session is created in +<>, +<>, or <> mode. 'NETPROTO':: Network protocol, amongst: @@ -131,7 +132,8 @@ The other version is used for the _network streaming mode_. -- `net`:: TCP over IPv4; the default values of 'CTRLPORT' and 'DATAPORT' - are resp. 5342 and 5343. + are respectively {default_network_control_port} and + {default_network_data_port}. `net6`:: TCP over IPv6: same default ports as the `net` protocol. @@ -167,28 +169,31 @@ include::common-cmd-options-head.txt[] Mode selection ~~~~~~~~~~~~~~ option:--live[='DELAYUS']:: - Create the session in live mode. The optional 'DELAYUS' parameter, - given in microseconds, is the maximum time the user can wait for - the data to be flushed. This mode can be set with a network URL - (options option:--set-url, or option:--ctrl-url and option:--data-url) - and must have a relay daemon listening (see man:lttng-relayd(8)). + Create the session in <>. ++ +The optional 'DELAYUS' parameter, given in microseconds, is the +maximum time the user can wait for the data to be flushed. This mode +can be set with a network URL (options option:--set-url, or +option:--ctrl-url and option:--data-url) and must have a relay +daemon listening (see man:lttng-relayd(8)). + By default, 'DELAYUS' is {default_lttng_live_timer} and the network URL is set to `net://127.0.0.1`. option:--snapshot:: - Create the session in snapshot mode. This is the equivalent of using - the option:--no-output option and creating all the channels of this - new tracing session in overwrite mode with an `mmap` output type. + Create the session in <>. + This is the equivalent of using the option:--no-output option and + creating all the channels of this new tracing session in overwrite + mode with an `mmap` output type. Output ~~~~~~ option:--no-output:: - Do not output any trace data. + In <>, do not output any trace data. -option:-o, option:--output='PATH':: - Set trace output path to 'PATH'. +option:-o 'PATH', option:--output='PATH':: + In <>, set trace output path to 'PATH'. option:--shm-path='PATH':: Create shared memory holding buffers at 'PATH'. @@ -199,19 +204,22 @@ URL See the <> section above for more information about the syntax of the following options' 'URL' argument. -option:-C, option:--ctrl-url='URL':: +option:-C 'URL', option:--ctrl-url='URL':: Set control path URL to 'URL' (must use option:--data-url option also). -option:-D, option:--data-url='URL':: +option:-D 'URL', option:--data-url='URL':: Set data path URL to 'URL' (must use option:--ctrl-url option also). -option:-U, option:--set-url='URL':: +option:-U 'URL', option:--set-url='URL':: Set URL destination of the trace data to 'URL'. It is persistent for the session lifetime. This option sets both data (option:--data-url option) and control (option:--ctrl-url option) URLs at the same time. ++ +In <> mode, 'URL' must start with `file://` followed +by the destination path on the local file system. include::common-cmd-help-options.txt[]