X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fman%2Flttng.1;h=0de06d7cbec62ede56a73a24b40bf452ae486269;hb=7972aab22f74b18faa168c0482216a3dd711a075;hp=f773e61f89b7659ad95a5f2a8d9645d3c1ff0864;hpb=c56509420616421ef4f6fff53e1cf09f3ccd56b7;p=lttng-tools.git diff --git a/doc/man/lttng.1 b/doc/man/lttng.1 index f773e61f8..0de06d7cb 100644 --- a/doc/man/lttng.1 +++ b/doc/man/lttng.1 @@ -231,19 +231,31 @@ instance, \-C does not enable the consumer automatically. You'll need the \-e option for that. \-U, \-\-set-uri=URL - Set URL for the enable-consumer destination. It is persistent for the + Set URL for the consumer output destination. It is persistent for the session lifetime. Redo the command to change it. This will set both data and control URL for network. \-C, \-\-ctrl-url=URL Set control path URL. (Must use -D also) \-D, \-\-data-url=URL Set data path URL. (Must use -C also) - \-\-no-consumer - Don't activate a consumer for this session. - \-\-disable-consumer - Disable consumer for this session. -See \fBenable-consumer\fP command below for the supported URL format. +.B URL FORMAT: + +proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH] + +Supported protocols are (proto): +> file://... + Local filesystem full path. + +> net://... + This will use the default network transport layer which is TCP for both + control (PORT1) and data port (PORT2). The default ports are + respectively 5342 and 5343. Note that net[6]:// is not yet supported. + +> tcp[6]://... + Can only be used with -C and -D together + +NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732) .B EXAMPLES: @@ -289,6 +301,10 @@ To enable event, you must first enable a channel which contains event(s). If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc file. + +It is important to note that if a certain type of buffers is used, the session +will be set with that type and all other subsequent channel need to have the +same type. .fi .B OPTIONS: @@ -321,84 +337,17 @@ file. Read timer interval in usec (default: 200) \-\-output TYPE Channel output type. Possible values: mmap, splice +\-\-buffers-uid + Use per UID buffer (\-u only). Buffers are shared between applications + that have the same UID. +\-\-buffers-pid + Use per PID buffer (\-u only). Each application has its own buffers. +\-\-buffers-global + Use shared buffer for the whole system (\-k only) .fi .IP -.IP "\fBenable-consumer\fP [-u|-k] [URL] [OPTIONS]" -.nf -Enable a consumer for the tracing session and domain. - -By default, every tracing session has a consumer attached to it using the local -filesystem as output. The trace is written in $HOME/lttng-traces. This command -allows the user to specify a specific URL after the session was created for a -specific domain. If no domain is specified, the consumer is applied on all -domains. - -Without options, the behavior is to enable a consumer to the current URL. The -default URL is the local filesystem at the path of the session mentioned above. - -The enable-consumer feature supports both local and network transport. You must -have a running \fBlttng-relayd(8)\fP for network transmission or any other daemon -that can understand the streaming protocol of LTTng. -.fi - -.B OPTIONS: - -.nf -\-h, \-\-help - Show summary of possible options and commands. -\-\-list-options - Simple listing of options -\-s, \-\-session NAME - Apply on session name -\-k, \-\-kernel - Apply for the kernel tracer -\-u, \-\-userspace - Apply for the user-space tracer - -Using these options, each API call can be controlled individually. For -instance, \-C does not enable the consumer automatically. You'll need the \-e -option for that. - -\-U, \-\-set-uri=URL - Set URL for the enable-consumer destination. It is persistent for the - session lifetime. Redo the command to change it. This will set both - data and control URL for network. -\-C, \-\-ctrl-url=URL - Set control path URL. (Must use -D also) -\-D, \-\-data-url=URL - Set data path URL. (Must use -C also) -\-e, \-\-enable - Enable consumer - -.B URL FORMAT: - -proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH] - -Supported protocols are (proto): -> file://... - Local filesystem full path. - -> net://... - This will use the default network transport layer which is TCP for both - control (PORT1) and data port (PORT2). The default ports are - respectively 5342 and 5343. Note that net[6]:// is not yet supported. - -> tcp[6]://... - Can only be used with -C and -D together - -NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732) - -.B EXAMPLES: - -$ lttng enable-consumer -u net://192.168.1.42 - -Uses TCP and default ports for user space tracing (-u) where the IP address -above is the destination machine where the traces will be streamed and a -\fBlttng-relayd(8)\fP is listening. -.fi - .IP "\fBenable-event\fP NAME[,NAME2,...] [-k|-u] [OPTIONS]" .nf Enable tracing event @@ -503,28 +452,6 @@ file. Apply for the user-space tracer .fi -.IP "\fBdisable-consumer\fP [\-k|\-u] [OPTIONS]" -.nf -Disable the consumer of a tracing session. - -This call MUST be done BEFORE tracing has started. -.fi - -.B OPTIONS: - -.nf -\-h, \-\-help - Show summary of possible options and commands. -\-\-list-options - Simple listing of options -\-s, \-\-session NAME - Apply on session name -\-k, \-\-kernel - Apply for the kernel tracer -\-u, \-\-userspace - Apply for the user-space tracer -.fi - .IP "\fBdisable-event\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]" .nf Disable tracing event