doc/man: put short option's argument too

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt
index a1e0fe78f14035015e00c7bd4185b9f3f7a2b732..fe2412e30c993f9ce739489872c1802fecf95aa4 100644 (file)
--- a/doc/man/lttng-add-context.1.txt
+++ b/doc/man/lttng-add-context.1.txt
@@ -98,11 +98,11 @@ option:-u, option:--userspace::
 
 Target
 ~~~~~~
-option:-c, option:--channel='CHANNEL'::
+option:-c 'CHANNEL', option:--channel='CHANNEL'::
     Add context fields to a channel named 'CHANNEL' instead of adding
     them to all the channels.
 
-option:-s, option:--session='SESSION'::
+option:-s 'SESSION', option:--session='SESSION'::
     Add context fields to a channel in the tracing session named 'SESSION'
     instead of the current tracing session.
 
@@ -112,7 +112,7 @@ Context
 option:--list::
     List the available context fields. Use this option alone.
 
-option:-t, option:--type='TYPE'::
+option:-t 'TYPE', option:--type='TYPE'::
     Add context field named 'TYPE'. This option can be repeated as
     many times as needed on the command-line.
 

diff --git a/doc/man/lttng-crash.1.txt b/doc/man/lttng-crash.1.txt
index 7427af94f5db14b0b6270153180ec6843b6e7b3c..7c3ebcea64da0cf5ed88756e2b641c1ccbd6ea71 100644 (file)
--- a/doc/man/lttng-crash.1.txt
+++ b/doc/man/lttng-crash.1.txt
@@ -28,7 +28,7 @@ LTTng trace buffers in the event of a system crash.
 
 OPTIONS
 -------
-option:-x, option:--extract='PATH'::
+option:-x 'PATH', option:--extract='PATH'::
     Extract recovered traces to path 'PATH'; do not execute the trace
     viewer.
 
@@ -39,7 +39,7 @@ Three levels of verbosity are available, which are triggered by
 appending additional `v` letters to the option
 (that is, `-vv` and `-vvv`).
 
-option:-e, option:--viewer='VIEWER'::
+option:-e 'VIEWER', option:--viewer='VIEWER'::
     Use trace viewer 'VIEWER' to view the trace buffers. 'VIEWER' is the
     absolute path to the viewer command to use, and it can contain
     command arguments as well. The trace directory paths are passed to

diff --git a/doc/man/lttng-create.1.txt b/doc/man/lttng-create.1.txt
index 14c9b0182f139c86b3418dd0c520e98b5c189469..8c61b0926247ffdbb49bef8c22f856944dfde1b6 100644 (file)
--- a/doc/man/lttng-create.1.txt
+++ b/doc/man/lttng-create.1.txt
@@ -194,7 +194,7 @@ Output
 option:--no-output::
     In <<local-mode,local mode>>, do not output any trace data.
 
-option:-o, option:--output='PATH'::
+option:-o 'PATH', option:--output='PATH'::
     In <<local-mode,local mode>>, set trace output path to 'PATH'.
 
 option:--shm-path='PATH'::
@@ -206,15 +206,15 @@ URL
 See the <<url-format,URL format>> 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)

diff --git a/doc/man/lttng-disable-channel.1.txt b/doc/man/lttng-disable-channel.1.txt
index 1218739f3f3b521eb311610511f3717e0140d13e..d3fe61e8145701a2357a766e52d5c81162a80f1b 100644 (file)
--- a/doc/man/lttng-disable-channel.1.txt
+++ b/doc/man/lttng-disable-channel.1.txt
@@ -45,7 +45,7 @@ option:-u, option:--userspace::
 
 Target
 ~~~~~~
-option:-s, option:--session='SESSION'::
+option:-s 'SESSION', option:--session='SESSION'::
     Disable channels in the tracing session named 'SESSION'
     instead of the current tracing session.
 

diff --git a/doc/man/lttng-disable-event.1.txt b/doc/man/lttng-disable-event.1.txt
index 8004e7b527a7710849bbdfceb56f54f07bb92025..595706eb3ace8701872cf36d169ed8b1a0c15778 100644 (file)
--- a/doc/man/lttng-disable-event.1.txt
+++ b/doc/man/lttng-disable-event.1.txt
@@ -67,11 +67,11 @@ option:-u, option:--userspace::
 
 Target
 ~~~~~~
-option:-c, option:--channel='CHANNEL'::
+option:-c 'CHANNEL', option:--channel='CHANNEL'::
     Disable event rules in the channel named 'CHANNEL' instead
     of the default channel name `channel0`.
 
-option:-s, option:--session='SESSION'::
+option:-s 'SESSION', option:--session='SESSION'::
     Disable event rules in the tracing session named 'SESSION'
     instead of the current tracing session.
 

diff --git a/doc/man/lttng-enable-channel.1.txt b/doc/man/lttng-enable-channel.1.txt
index e79032a4deae509519aa83e1b101741d16f18fd9..315f1c54e30e5334df1c7348238418d8d516ccf5 100644 (file)
--- a/doc/man/lttng-enable-channel.1.txt
+++ b/doc/man/lttng-enable-channel.1.txt
@@ -228,7 +228,7 @@ option:-u, option:--userspace::
 
 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.
 

diff --git a/doc/man/lttng-enable-event.1.txt b/doc/man/lttng-enable-event.1.txt
index afdbd6747e336fe4a42ae14c311d57011aeb7f57..1a80fe774aaa4a8ba7574ca056d719efbf5ab7ac 100644 (file)
--- a/doc/man/lttng-enable-event.1.txt
+++ b/doc/man/lttng-enable-event.1.txt
@@ -353,11 +353,11 @@ option:-u, option:--userspace::
 
 Target
 ~~~~~~
-option:-c, option:--channel='CHANNEL'::
+option:-c 'CHANNEL', option:--channel='CHANNEL'::
     Create or enable event rules in the channel named 'CHANNEL' instead
     of the default channel name `channel0`.
 
-option:-s, option:--session='SESSION'::
+option:-s 'SESSION', option:--session='SESSION'::
     Create or enable event rules in the tracing session named 'SESSION'
     instead of the current tracing session.
 
@@ -409,13 +409,13 @@ option:--loglevel-only='LOGLEVEL'::
 
 Filtering and exclusion
 ~~~~~~~~~~~~~~~~~~~~~~~
-option:-x, option:--exclude='EVENT'[,'EVENT']...::
+option:-x 'EVENT'[,'EVENT']..., option:--exclude='EVENT'[,'EVENT']...::
     Exclude events named 'EVENT' from the event rule. This option
     can be used when the command's 'EVENT' argument contains a wildcard
     (`*`) to exclude specific names. Only available with application
     domains.
 
-option:-f, option:--filter='EXPR'::
+option:-f 'EXPR', option:--filter='EXPR'::
     Add filter expression condition to the event rule. Expression 'EXPR'
     must evaluate to true when executed against the dynamic values of
     event fields. See the <<filter-syntax,Filter expression syntax>>

diff --git a/doc/man/lttng-list.1.txt b/doc/man/lttng-list.1.txt
index 5dad88376b5a6ab449cd8a9863d2b30bfdf94a08..95025563920993ca64d160c58266cb2346943dac 100644 (file)
--- a/doc/man/lttng-list.1.txt
+++ b/doc/man/lttng-list.1.txt
@@ -80,7 +80,7 @@ option:-u, option:--userspace::
 
 Target
 ~~~~~~
-option:-c, option:--channel='CHANNEL'::
+option:-c 'CHANNEL', option:--channel='CHANNEL'::
     Only list the details of the channel named 'CHANNEL'.
 
 

diff --git a/doc/man/lttng-load.1.txt b/doc/man/lttng-load.1.txt
index 042dbda3d91392808fe0a140b6e323dc7653502c..d68ae5bd715305f5a1da3a700e479ab4f8da0357 100644 (file)
--- a/doc/man/lttng-load.1.txt
+++ b/doc/man/lttng-load.1.txt
@@ -71,7 +71,7 @@ option:-a, option:--all::
 option:-f, option:--force::
     Overwrite existing tracing sessions when loading.
 
-option:-i, option:--input-path='PATH'::
+option:-i 'PATH', option:--input-path='PATH'::
     Load tracing session configurations from 'PATH', either a directory
     or a file, instead of loading them from the default search
     directories.

diff --git a/doc/man/lttng-metadata.1.txt b/doc/man/lttng-metadata.1.txt
index 53489163223ed6fa59fe4c56bf3d2020e230d9d4..8d78d8fadcc6f1d1e372fabab078cdc09e1ba927 100644 (file)
--- a/doc/man/lttng-metadata.1.txt
+++ b/doc/man/lttng-metadata.1.txt
@@ -22,7 +22,7 @@ regenerate metadata* command (see man:lttng-regenerate(1)).
 include::common-cmd-options-head.txt[]
 
 
-option:-s, option:--session='SESSION'::
+option:-s 'SESSION', option:--session='SESSION'::
     Manage the metadata generation of the tracing session named 'SESSION'
     instead of the current tracing session.
 

diff --git a/doc/man/lttng-regenerate.1.txt b/doc/man/lttng-regenerate.1.txt
index a3af401f758d3fa42c7a8a032ed7646afe89364d..fd306ad8099f766b084a99d7e456a68ed52d4123 100644 (file)
--- a/doc/man/lttng-regenerate.1.txt
+++ b/doc/man/lttng-regenerate.1.txt
@@ -52,7 +52,7 @@ lost.
 include::common-cmd-options-head.txt[]
 
 
-option:-s, option:--session='SESSION'::
+option:-s 'SESSION', option:--session='SESSION'::
     Regenerate the data of the tracing session named 'SESSION'
     instead of the current tracing session.
 

diff --git a/doc/man/lttng-relayd.8.txt b/doc/man/lttng-relayd.8.txt
index 4326daba393e53cd477ef92c6b1de508ef8395d1..218526a1a3f9abe206c8a8275ea953289f107141 100644 (file)
--- a/doc/man/lttng-relayd.8.txt
+++ b/doc/man/lttng-relayd.8.txt
@@ -105,10 +105,10 @@ option:-d, option:--daemonize::
     option:--background option instead to keep the file descriptors
     open.
 
-option:-g, option:--group='GROUP'::
+option:-g 'GROUP', option:--group='GROUP'::
     Use 'GROUP' as Unix tracing group (default: `tracing`).
 
-option:-o, option:--output='PATH'::
+option:-o 'PATH', option:--output='PATH'::
     Set base directory of written trace data to 'PATH'.
 +
 See the <<output-directory,Output directory>> section above for more
@@ -127,15 +127,15 @@ Ports
 See the <<url-format,URL format>> section above for more information
 about the syntax of the following options' 'URL' argument.
 
-option:-C, option:--control-port='URL'::
+option:-C 'URL', option:--control-port='URL'::
     Listen to control data on URL 'URL' (default:
     +tcp://{default_network_control_bind_address}:{default_network_control_port}+).
 
-option:-D, option:--data-port='URL'::
+option:-D 'URL', option:--data-port='URL'::
     Listen to trace data on URL 'URL' (default:
     +tcp://{default_network_data_bind_address}:{default_network_data_port}+).
 
-option:-L, option:--live-port='URL'::
+option:-L 'URL', option:--live-port='URL'::
     Listen to LTTng live connections on URL 'URL'
     (default:
     +tcp://{default_network_viewer_bind_address}:{default_network_viewer_port}+).

diff --git a/doc/man/lttng-save.1.txt b/doc/man/lttng-save.1.txt
index 46fdb00b990a66037bedc1be9d2c58d49bdcdff7..5346262ee419af3803fcf5407aa47c77a9e59485 100644 (file)
--- a/doc/man/lttng-save.1.txt
+++ b/doc/man/lttng-save.1.txt
@@ -51,7 +51,7 @@ option:-f, option:--force::
     Overwrite existing tracing session configuration files when
     saving.
 
-option:-o, option:--output-path='PATH'::
+option:-o 'PATH', option:--output-path='PATH'::
     Set output directory path to 'PATH'.
 
 

diff --git a/doc/man/lttng-sessiond.8.txt b/doc/man/lttng-sessiond.8.txt
index d57f5fe1c0de225f49d66ea71c8726fdc9693bbc..2bcfe52375e2f8403495b66c30f19c36b4a23844 100644 (file)
--- a/doc/man/lttng-sessiond.8.txt
+++ b/doc/man/lttng-sessiond.8.txt
@@ -154,10 +154,10 @@ option:--agent-tcp-port='PORT'::
     Listen on TCP port 'PORT' for agent application registrations
     (default: {default_agent_tcp_port}).
 
-option:-a, option:--apps-sock='PATH'::
+option:-a 'PATH', option:--apps-sock='PATH'::
     Set application Unix socket path to 'PATH'.
 
-option:-c, option:--client-sock='PATH'::
+option:-c 'PATH', option:--client-sock='PATH'::
     Set client Unix socket path to 'PATH'.
 
 option:--consumerd32-libdir='PATH'::

diff --git a/doc/man/lttng-snapshot.1.txt b/doc/man/lttng-snapshot.1.txt
index e4a02033a99394008c11bb4a339a5860e77c96d2..a749e1c02e99629945da9a76631459e1a65fd0f1 100644 (file)
--- a/doc/man/lttng-snapshot.1.txt
+++ b/doc/man/lttng-snapshot.1.txt
@@ -106,7 +106,7 @@ include::common-cmd-options-head.txt[]
 
 Target
 ~~~~~~
-option:-s, option:--session='SESSION'::
+option:-s 'SESSION', option:--session='SESSION'::
     Take a snapshot of the sub-buffers of the channels contained in
     the tracing session named 'SESSION' instead of the current
     tracing session.
@@ -114,20 +114,20 @@ option:-s, option:--session='SESSION'::
 
 Snapshot output
 ~~~~~~~~~~~~~~~
-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:-m, option:--max-size='SIZE'::
+option:-m 'SIZE', option:--max-size='SIZE'::
     Limit the total size of all the snapshot files written when
     recording a snapshot to 'SIZE' bytes. The `k` (kiB), `M` (MiB),
     and `G` (GiB) suffixes are supported.
 
-option:-n, option:--name='NAME'::
+option:-n 'NAME', option:--name='NAME'::
     Assign the name 'NAME' to the snapshot output.
 
 

diff --git a/doc/man/lttng-track.1.txt b/doc/man/lttng-track.1.txt
index 739093d723aca09745fcab75ac2f5a67746241ca..f5696f0c22e4030aaba985447d5b2681220ca01b 100644 (file)
--- a/doc/man/lttng-track.1.txt
+++ b/doc/man/lttng-track.1.txt
@@ -122,7 +122,7 @@ option:-u, option:--userspace::
 
 Target
 ~~~~~~
-option:-s, option:--session='SESSION'::
+option:-s 'SESSION', option:--session='SESSION'::
     Track resources in the tracing session named 'SESSION' instead of
     the current tracing session.
 
@@ -133,7 +133,7 @@ option:-a, option:--all::
     Used in conjunction with an empty option:--pid option: track _all_
     process IDs (add all entries to the whitelist).
 
-option:-p, option:--pid[='PID'[,'PID']...]::
+option:-p ['PID'[,'PID']...], option:--pid[='PID'[,'PID']...]::
     Track process IDs 'PID' (add them to the current whitelist).
 +
 The 'PID' argument must be omitted when also using the option:--all

diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt
index 43d135c63aa94676743c6ae49523bc03089661f6..d383740eb851e779be76221b8d6d418db058ee38 100644 (file)
--- a/doc/man/lttng-untrack.1.txt
+++ b/doc/man/lttng-untrack.1.txt
@@ -121,7 +121,7 @@ option:-a, option:--all::
     Used in conjunction with an empty option:--pid option: untrack _all_
     process IDs (clear the whitelist).
 
-option:-p, option:--pid[='PID'[,'PID']...]::
+option:-p ['PID'[,'PID']...], option:--pid[='PID'[,'PID']...]::
     Untrack process IDs 'PID' (remove them from the current whitelist).
 +
 The 'PID' argument must be omitted when also using the option:--all

diff --git a/doc/man/lttng-view.1.txt b/doc/man/lttng-view.1.txt
index 923b117b053d185b9d0b6e04ae92e4ac50a55eef..86d62536b8d38ceac342ce72a5f7a607db23c2d4 100644 (file)
--- a/doc/man/lttng-view.1.txt
+++ b/doc/man/lttng-view.1.txt
@@ -36,11 +36,11 @@ be overridden using the option:--trace-path option.
 include::common-cmd-options-head.txt[]
 
 
-option:-t, option:--trace-path='PATH'::
+option:-t 'PATH', option:--trace-path='PATH'::
     View trace at path 'PATH' instead of using the chosen tracing
     session's trace path.
 
-option:-e, option:--viewer='CMD'::
+option:-e 'CMD', option:--viewer='CMD'::
     Use 'CMD' as the trace viewer.
 
 

diff --git a/doc/man/lttng.1.txt b/doc/man/lttng.1.txt
index 0b7a532f0b4a68d461c1ae7071dd8cea1b0a9136..9ff407094b79190df063efe29ef8bd9c213fb55f 100644 (file)
--- a/doc/man/lttng.1.txt
+++ b/doc/man/lttng.1.txt
@@ -82,10 +82,10 @@ option:--no-sessiond general option can be set to avoid this.
 
 OPTIONS
 -------
-option:-g, option:--group='GROUP'::
+option:-g 'GROUP', option:--group='GROUP'::
     Use 'GROUP' as Unix tracing group (default: `tracing`).
 
-option:-m, option:--mi='TYPE'::
+option:-m 'TYPE', option:--mi='TYPE'::
     Print the command's result using the machine interface type 'TYPE'
     instead of a human-readable output.
 +