X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-enable-channel.1.txt;h=b1514ed5162c4a8b0616c7a19b56961cdbf27fb7;hp=9365a7806e658fb1fd30a7e7e4a0896a0085a8d1;hb=c93eadade27794fe724cc457c4452eee9dad9060;hpb=ce19b9ed9bd9591bd0c4d1998780082a490991fd diff --git a/doc/man/lttng-enable-channel.1.txt b/doc/man/lttng-enable-channel.1.txt index 9365a7806..b1514ed51 100644 --- a/doc/man/lttng-enable-channel.1.txt +++ b/doc/man/lttng-enable-channel.1.txt @@ -42,7 +42,7 @@ The `lttng enable-channel` command can create a new channel, or enable one or more existing and disabled ones. A channel is the owner of sub-buffers holding recorded events. Event, -rules, when created using linklttng:lttng-enable-event(1), are always +rules, when created using man:lttng-enable-event(1), are always assigned to a channel. When creating a new channel, many parameters related to those sub-buffers can be fine-tuned. They are described in the subsections below. @@ -51,18 +51,18 @@ When 'CHANNEL' does not name an existing channel, a channel named 'CHANNEL' is created. Otherwise, the disabled channel named 'CHANNEL' is enabled. -Note that the linklttng:lttng-enable-event(1) command can automatically +Note that the man:lttng-enable-event(1) command can automatically create default channels when no channel exist. A channel is always contained in a tracing session -(see linklttng:lttng-create(1) for creating a tracing session). The +(see man:lttng-create(1) for creating a tracing session). The session in which a channel is created using `lttng enable-channel` can be specified using the option:--session option. If the option:--session option is omitted, the current tracing session is targeted. Existing enabled channels can be disabled using -linklttng:lttng-disable-channel(1). Channels of a given session can be -listed using linklttng:lttng-list(1). +man:lttng-disable-channel(1). Channels of a given session can be +listed using man:lttng-list(1). See the <> section below for a list of limitations of this command to consider. @@ -252,8 +252,12 @@ option:--num-subbuf='COUNT':: + Default values: + -* `metadata` channel: 2 -* Everything else: 4 +* option:--userspace and option:--buffers-uid options: + {default_ust_uid_channel_subbuf_num} +* option:--userspace and option:--buffers-pid options: + {default_ust_pid_channel_subbuf_num} +* option:--kernel option: {default_kernel_channel_subbuf_num} +* `metadata` channel: {default_metadata_subbuf_num} option:--subbuf-size='SIZE':: Set the individual size of sub-buffers to 'SIZE' bytes. @@ -266,10 +270,12 @@ command shows the current system's page size: `getconf PAGE_SIZE`. + Default values: + -* option:--userspace and option:--buffers-uid options: `128k` -* option:--userspace and option:--buffers-pid options: `4k` -* option:--kernel option: `256k` -* `metadata` channel: `4k` +* option:--userspace and option:--buffers-uid options: + {default_ust_uid_channel_subbuf_size} +* option:--userspace and option:--buffers-pid options: + {default_ust_pid_channel_subbuf_size} +* option:--kernel option: {default_kernel_channel_subbuf_size} +* `metadata` channel: {default_metadata_subbuf_size} option:--output='TYPE':: Set channel's output type to 'TYPE'. @@ -306,7 +312,8 @@ Trace files ~~~~~~~~~~~ option:--tracefile-count='COUNT':: Limit the number of trace files created by this channel to - 'COUNT'. 0 means unlimited. Default: 0. + 'COUNT'. 0 means unlimited. Default: + {default_channel_tracefile_count}. + Use this option in conjunction with the option:--tracefile-size option. + @@ -317,7 +324,7 @@ the first trace file of the stream is cleared and used again. option:--tracefile-size='SIZE':: Set the maximum size of each trace file written by this channel within a stream to 'SIZE' bytes. 0 means unlimited. - Default: 0. + Default: {default_channel_tracefile_size}. + Note: traces generated with this option may inaccurately report discarded events as of CTF 1.8. @@ -331,14 +338,25 @@ option:--read-timer:: + Default values: + -* option:--userspace and option:--buffers-uid options: 0 -* option:--userspace and option:--buffers-pid options: 0 -* option:--kernel option: 200000 -* `metadata` channel: 0 +* option:--userspace and option:--buffers-uid options: + {default_ust_uid_channel_read_timer} +* option:--userspace and option:--buffers-pid options: + {default_ust_pid_channel_read_timer} +* option:--kernel option: {default_kernel_channel_read_timer} +* `metadata` channel: {default_metadata_read_timer} option:--switch-timer='PERIODUS':: Set the channel's switch timer's period to 'PERIODUS' µs. 0 means - a disabled switch timer. Default: 0. + a disabled switch timer. ++ +Default values: ++ +* option:--userspace and option:--buffers-uid options: + {default_ust_uid_channel_switch_timer} +* option:--userspace and option:--buffers-pid options: + {default_ust_pid_channel_switch_timer} +* option:--kernel option: {default_kernel_channel_switch_timer} +* `metadata` channel: {default_metadata_switch_timer} include::common-cmd-help-options.txt[] @@ -366,5 +384,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -linklttng:lttng-disable-channel(1), -linklttng:lttng(1) +man:lttng-disable-channel(1), +man:lttng(1)