doc/man: put short option's argument too

[lttng-tools.git] / doc / man / lttng-enable-channel.1.txt

diff --git a/doc/man/lttng-enable-channel.1.txt b/doc/man/lttng-enable-channel.1.txt
index 1178b08d202a08e8c4aaf9297a32b1107bd6b0da..315f1c54e30e5334df1c7348238418d8d516ccf5 100644 (file)
--- a/doc/man/lttng-enable-channel.1.txt
+++ b/doc/man/lttng-enable-channel.1.txt
@@ -13,7 +13,7 @@ Create a Linux kernel channel:
 
 [verse]
 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-channel* option:--kernel
 
 [verse]
 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-channel* option:--kernel

-      [option:--discard | option:--overwrite] [option:--output=(`mmap` | `splice`)]
+      [option:--overwrite] [option:--output=(`mmap` | `splice`)]

       [option:--subbuf-size='SIZE'] [option:--num-subbuf='COUNT']
       [option:--switch-timer='PERIODUS'] [option:--read-timer='PERIODUS']
       [option:--tracefile-size='SIZE'] [option:--tracefile-count='COUNT']
       [option:--subbuf-size='SIZE'] [option:--num-subbuf='COUNT']
       [option:--switch-timer='PERIODUS'] [option:--read-timer='PERIODUS']
       [option:--tracefile-size='SIZE'] [option:--tracefile-count='COUNT']


@@ -23,7 +23,7 @@ Create a user space channel:
 
 [verse]
 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-channel* option:--userspace
 
 [verse]
 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-channel* option:--userspace

-      [option:--discard | option:--overwrite] [option:--buffers-pid]
+      [option:--overwrite] [option:--buffers-pid]

       [option:--subbuf-size='SIZE'] [option:--num-subbuf='COUNT']
       [option:--switch-timer='PERIODUS'] [option:--read-timer='PERIODUS']
       [option:--tracefile-size='SIZE'] [option:--tracefile-count='COUNT']
       [option:--subbuf-size='SIZE'] [option:--num-subbuf='COUNT']
       [option:--switch-timer='PERIODUS'] [option:--read-timer='PERIODUS']
       [option:--tracefile-size='SIZE'] [option:--tracefile-count='COUNT']


@@ -228,7 +228,7 @@ option:-u, option:--userspace::
 
 Target
 ~~~~~~
 
 Target
 ~~~~~~

-option:-s, option:--session='SESSION'::
+option:-s 'SESSION', option:--session='SESSION'::

     Create or enable channel in the tracing session named 'SESSION'
     instead of the current tracing session.
 
     Create or enable channel in the tracing session named 'SESSION'
     instead of the current tracing session.
 


@@ -252,8 +252,12 @@ option:--num-subbuf='COUNT'::
 +
 Default values:
 +
 +
 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.
 
 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:
 +
 +
 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:--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
 ~~~~~~~~~~~
 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.
 +
 +
 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.
 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.
 +
 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:
 +
 +
 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
 
 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[]
 
 
 include::common-cmd-help-options.txt[]