# at this point, we know the user asked to build the man pages
if HAVE_ASCIIDOC_XMLTO
# tools
-ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
- -a lttng_version="$(PACKAGE_VERSION)" \
- -a system_sessions_dir="$(sysconfdir)/lttng/sessions" \
- -a system_sessions_auto_dir="$(sysconfdir)/lttng/sessions/auto" \
- -a system_lttng_conf="$(sysconfdir)/lttng/lttng.conf"
+ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage
ADOC_DOCBOOK = $(ADOC) -b docbook
XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
default_network_control_bind_address="@DEFAULT_NETWORK_CONTROL_BIND_ADDRESS@"
default_network_data_bind_address="@DEFAULT_NETWORK_DATA_BIND_ADDRESS@"
default_network_viewer_bind_address="@DEFAULT_NETWORK_VIEWER_BIND_ADDRESS@"
+lttng_version="@PACKAGE_VERSION@"
+system_sessions_dir="@CONFDIR@/lttng/sessions"
+system_sessions_auto_dir="@CONFDIR@/lttng/sessions/auto"
+system_lttng_conf="@CONFDIR@/lttng/lttng.conf"
(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 1000000 and the network URL is set to
-`net://127.0.0.1`.
+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
+
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.
+
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'.
~~~~~~~~~~~
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.
+
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.
+
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[]
it can write to the output directory and listen on the configured ports.
If a user is within a secured network and/or has proper firewall
settings, `lttng-relayd` can listen to LTTng live connections from _all_
-network interfaces by specifying `--live-port=tcp://0.0.0.0:5344`.
+network interfaces by specifying
++--live-port=tcp://{default_network_viewer_bind_address}:{default_network_viewer_port}+.
Once a trace has been streamed completely, the trace can be processed by
any tool that can process an LTTng trace located on the local
about the syntax of the following options' 'URL' argument.
option:-C, option:--control-port='URL'::
- Listen to control data on URL 'URL' (default: `tcp://0.0.0.0:5342`).
+ Listen to control data on URL 'URL' (default:
+ +tcp://{default_network_control_bind_address}:{default_network_control_port}+).
option:-D, option:--data-port='URL'::
- Listen to trace data on URL 'URL' (default: `tcp://0.0.0.0:5343`).
+ Listen to trace data on URL 'URL' (default:
+ +tcp://{default_network_data_bind_address}:{default_network_data_port}+).
option:-L, option:--live-port='URL'::
Listen to LTTng live connections on URL 'URL'
- (default: `tcp://0.0.0.0:5344`).
+ (default:
+ +tcp://{default_network_viewer_bind_address}:{default_network_viewer_port}+).
Program information
~~~~~~~~~~~~~~~
option:--agent-tcp-port='PORT'::
Listen on TCP port 'PORT' for agent application registrations
- (default: 5345).
+ (default: {default_agent_tcp_port}).
option:-a, option:--apps-sock='PATH'::
Set application Unix socket path to 'PATH'.
Application socket's timeout (seconds) when sending/receiving
commands. After this period of time, the application is unregistered
by the session daemon. A value of 0 or -1 means an infinite timeout.
- Default value: 5.
+ Default value: {default_app_socket_rw_timeout}.
`LTTNG_CONSUMERD32_BIN`::
32-bit consumer daemon binary path.
projects / lttng-tools.git / commitdiff
