From ce19b9ed9bd9591bd0c4d1998780082a490991fd Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Thu, 24 Mar 2016 13:18:09 -0400 Subject: [PATCH] doc/man: use linkgenoptions macro MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- doc/man/common-cmd-options-head.txt | 2 +- doc/man/lttng-add-context.1.txt | 4 ++-- doc/man/lttng-calibrate.1.txt | 2 +- doc/man/lttng-create.1.txt | 6 +++--- doc/man/lttng-destroy.1.txt | 2 +- doc/man/lttng-disable-channel.1.txt | 2 +- doc/man/lttng-disable-event.1.txt | 2 +- doc/man/lttng-enable-channel.1.txt | 6 +++--- doc/man/lttng-enable-event.1.txt | 6 +++--- doc/man/lttng-help.1.txt | 2 +- doc/man/lttng-list.1.txt | 8 ++++---- doc/man/lttng-load.1.txt | 2 +- doc/man/lttng-metadata.1.txt | 2 +- doc/man/lttng-save.1.txt | 2 +- doc/man/lttng-set-session.1.txt | 2 +- doc/man/lttng-snapshot.1.txt | 8 ++++---- doc/man/lttng-start.1.txt | 2 +- doc/man/lttng-status.1.txt | 2 +- doc/man/lttng-stop.1.txt | 2 +- doc/man/lttng-track.1.txt | 2 +- doc/man/lttng-untrack.1.txt | 2 +- doc/man/lttng-version.1.txt | 2 +- doc/man/lttng-view.1.txt | 2 +- 23 files changed, 36 insertions(+), 36 deletions(-) diff --git a/doc/man/common-cmd-options-head.txt b/doc/man/common-cmd-options-head.txt index fba544ebc..169a869e9 100644 --- a/doc/man/common-cmd-options-head.txt +++ b/doc/man/common-cmd-options-head.txt @@ -1,3 +1,3 @@ OPTIONS ------- -General options are described in linklttng:lttng(1). +linkgenoptions:(General options) are described in linklttng:lttng(1). diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt index c201fa6a6..d9776b7b6 100644 --- a/doc/man/lttng-add-context.1.txt +++ b/doc/man/lttng-add-context.1.txt @@ -12,7 +12,7 @@ SYNOPSIS Add context fields to a channel: [verse] -*lttng* ['GENERAL OPTIONS'] *add-context* +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *add-context* (option:--kernel | option:--userspace | option:--jul | option:--log4j) [option:--session='SESSION'] [option:--channel='CHANNEL'] option:--type='TYPE' [option:--type='TYPE']... @@ -20,7 +20,7 @@ Add context fields to a channel: List the available context fields: [verse] -*lttng* ['GENERAL OPTIONS'] *add-context* --list +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *add-context* --list DESCRIPTION diff --git a/doc/man/lttng-calibrate.1.txt b/doc/man/lttng-calibrate.1.txt index 621a67a88..54d245ef0 100644 --- a/doc/man/lttng-calibrate.1.txt +++ b/doc/man/lttng-calibrate.1.txt @@ -10,7 +10,7 @@ lttng-calibrate - Quantify LTTng overhead SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *calibrate* +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *calibrate* DESCRIPTION diff --git a/doc/man/lttng-create.1.txt b/doc/man/lttng-create.1.txt index 552e61713..6e158ecb7 100644 --- a/doc/man/lttng-create.1.txt +++ b/doc/man/lttng-create.1.txt @@ -12,20 +12,20 @@ SYNOPSIS Normal mode: [verse] -*lttng* ['GENERAL OPTIONS'] *create* [option:--output='PATH' | option:--no-output] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* [option:--output='PATH' | option:--no-output] [option:--shm-path='PATH'] ['SESSION'] Snapshot mode: [verse] -*lttng* ['GENERAL OPTIONS'] *create* option:--snapshot +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* option:--snapshot [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL'] [option:--shm-path='PATH'] ['SESSION'] Live mode: [verse] -*lttng* ['GENERAL OPTIONS'] *create* option:--live[='DELAYUS'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* option:--live[='DELAYUS'] [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL'] [option:--shm-path='PATH'] ['SESSION'] diff --git a/doc/man/lttng-destroy.1.txt b/doc/man/lttng-destroy.1.txt index d23d094eb..74921bb25 100644 --- a/doc/man/lttng-destroy.1.txt +++ b/doc/man/lttng-destroy.1.txt @@ -10,7 +10,7 @@ lttng-destroy - Destroy an LTTng tracing session SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *destroy* [option:--all | 'SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *destroy* [option:--all | 'SESSION'] DESCRIPTION diff --git a/doc/man/lttng-disable-channel.1.txt b/doc/man/lttng-disable-channel.1.txt index 2470c2356..7cd366f03 100644 --- a/doc/man/lttng-disable-channel.1.txt +++ b/doc/man/lttng-disable-channel.1.txt @@ -10,7 +10,7 @@ lttng-disable-channel - Disable LTTng channels SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *disable-channel* (option:--kernel | option:--userspace) +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-channel* (option:--kernel | option:--userspace) [option:--session='SESSION'] 'CHANNEL'[,'CHANNEL']... diff --git a/doc/man/lttng-disable-event.1.txt b/doc/man/lttng-disable-event.1.txt index bf1bc76d9..f135880c9 100644 --- a/doc/man/lttng-disable-event.1.txt +++ b/doc/man/lttng-disable-event.1.txt @@ -10,7 +10,7 @@ lttng-disable-event - Disable LTTng event rules SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *disable-event* +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-event* (option:--kernel [option:--probe | option:--function | option:--syscall] | option:--userspace | option:--jul | option:--log4j | option:--python) [option:--session='SESSION'] [option:--channel='CHANNEL'] diff --git a/doc/man/lttng-enable-channel.1.txt b/doc/man/lttng-enable-channel.1.txt index 5a7f4c55f..9365a7806 100644 --- a/doc/man/lttng-enable-channel.1.txt +++ b/doc/man/lttng-enable-channel.1.txt @@ -12,7 +12,7 @@ SYNOPSIS Create a Linux kernel channel: [verse] -*lttng* ['GENERAL OPTIONS'] *enable-channel* option:--kernel +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-channel* option:--kernel [option:--discard | option:--overwrite] [option:--output=(`mmap` | `splice`)] [option:--subbuf-size='SIZE'] [option:--num-subbuf='COUNT'] [option:--switch-timer='PERIODUS'] [option:--read-timer='PERIODUS'] @@ -22,7 +22,7 @@ Create a Linux kernel channel: Create a user space channel: [verse] -*lttng* ['GENERAL OPTIONS'] *enable-channel* option:--userspace +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-channel* option:--userspace [option:--discard | option:--overwrite] [option:--buffers-pid] [option:--subbuf-size='SIZE'] [option:--num-subbuf='COUNT'] [option:--switch-timer='PERIODUS'] [option:--read-timer='PERIODUS'] @@ -32,7 +32,7 @@ Create a user space channel: Enable existing channel(s): [verse] -*lttng* ['GENERAL OPTIONS'] *enable-channel* (option:--userspace | option:--kernel) +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-channel* (option:--userspace | option:--kernel) [option:--session='SESSION'] 'CHANNEL'[,'CHANNEL']... diff --git a/doc/man/lttng-enable-event.1.txt b/doc/man/lttng-enable-event.1.txt index b58691ba0..f8a630af5 100644 --- a/doc/man/lttng-enable-event.1.txt +++ b/doc/man/lttng-enable-event.1.txt @@ -12,7 +12,7 @@ SYNOPSIS Create or enable Linux kernel event rules: [verse] -*lttng* ['GENERAL OPTIONS'] *enable-event* option:--kernel +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-event* option:--kernel [option:--probe='SOURCE' | option:--function='SOURCE' | option:--syscall] [option:--filter='EXPR'] [option:--session='SESSION'] [option:--channel='CHANNEL'] 'EVENT'[,'EVENT']... @@ -20,13 +20,13 @@ Create or enable Linux kernel event rules: Create or enable an "all" Linux kernel event rule: [verse] -*lttng* ['GENERAL OPTIONS'] *enable-event* option:--kernel option:--all [option:--syscall] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-event* option:--kernel option:--all [option:--syscall] [option:--filter='EXPR'] [option:--session='SESSION'] [option:--channel='CHANNEL'] Create or enable application event rules: [verse] -*lttng* ['GENERAL OPTIONS'] *enable-event* +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-event* (option:--userspace | option:--jul | option:--log4j | option:--python) [option:--filter='EXPR'] [option:--exclude='EVENT'[,'EVENT']...] [option:--loglevel='LOGLEVEL' | option:--loglevel-only='LOGLEVEL'] diff --git a/doc/man/lttng-help.1.txt b/doc/man/lttng-help.1.txt index c0f4d6442..558792e79 100644 --- a/doc/man/lttng-help.1.txt +++ b/doc/man/lttng-help.1.txt @@ -10,7 +10,7 @@ lttng-help - Display help information about an LTTng command SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *help* ['COMMAND'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *help* ['COMMAND'] DESCRIPTION diff --git a/doc/man/lttng-list.1.txt b/doc/man/lttng-list.1.txt index 0edda6e35..b0daca8af 100644 --- a/doc/man/lttng-list.1.txt +++ b/doc/man/lttng-list.1.txt @@ -12,23 +12,23 @@ SYNOPSIS List existing tracing sessions: [verse] -*lttng* ['GENERAL OPTIONS'] *list* +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* List available event sources: [verse] -*lttng* ['GENERAL OPTIONS'] *list* [option:--fields] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* [option:--fields] [option:--kernel [option:--syscall]] [option:--userspace] [option:--jul] [option:--log4j] [option:--python] List tracing session's domains: [verse] -*lttng* ['GENERAL OPTIONS'] *list* option:--domain 'SESSION' +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* option:--domain 'SESSION' List tracing session's channels and event rules: [verse] -*lttng* ['GENERAL OPTIONS'] *list* [option:--channel='CHANNEL'] 'SESSION' +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* [option:--channel='CHANNEL'] 'SESSION' DESCRIPTION diff --git a/doc/man/lttng-load.1.txt b/doc/man/lttng-load.1.txt index 11ab2f6c6..e4cff034f 100644 --- a/doc/man/lttng-load.1.txt +++ b/doc/man/lttng-load.1.txt @@ -10,7 +10,7 @@ lttng-load - Load LTTng tracing session configurations SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *load* [option:--force] [option:--input-path='PATH'] ['SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *load* [option:--force] [option:--input-path='PATH'] ['SESSION'] DESCRIPTION diff --git a/doc/man/lttng-metadata.1.txt b/doc/man/lttng-metadata.1.txt index a146c9324..dfe3d54e4 100644 --- a/doc/man/lttng-metadata.1.txt +++ b/doc/man/lttng-metadata.1.txt @@ -10,7 +10,7 @@ lttng-metadata - Manage an LTTng tracing session's metadata generation SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *metadata regenerate* [option:--session='SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *metadata regenerate* [option:--session='SESSION'] DESCRIPTION diff --git a/doc/man/lttng-save.1.txt b/doc/man/lttng-save.1.txt index 1b69d078a..f7b1c2190 100644 --- a/doc/man/lttng-save.1.txt +++ b/doc/man/lttng-save.1.txt @@ -10,7 +10,7 @@ lttng-save - Save LTTng tracing session configurations SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *save* [option:--force] [option:--output-path='PATH'] ['SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *save* [option:--force] [option:--output-path='PATH'] ['SESSION'] DESCRIPTION diff --git a/doc/man/lttng-set-session.1.txt b/doc/man/lttng-set-session.1.txt index 6e233e946..998266aff 100644 --- a/doc/man/lttng-set-session.1.txt +++ b/doc/man/lttng-set-session.1.txt @@ -10,7 +10,7 @@ lttng-set-session - Set the current LTTng tracing session SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *set-session* 'SESSION' +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *set-session* 'SESSION' DESCRIPTION diff --git a/doc/man/lttng-snapshot.1.txt b/doc/man/lttng-snapshot.1.txt index 2d2b6c68f..7dcfa00a1 100644 --- a/doc/man/lttng-snapshot.1.txt +++ b/doc/man/lttng-snapshot.1.txt @@ -12,25 +12,25 @@ SYNOPSIS Add a snapshot output: [verse] -*lttng* ['GENERAL OPTIONS'] *snapshot add-output* [option:--max-size='SIZE'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *snapshot add-output* [option:--max-size='SIZE'] [option:--name='NAME'] [option:--session='SESSION'] (option:--ctrl-url='URL' option:--data-url='URL' | 'URL') Remove a snapshot output: [verse] -*lttng* ['GENERAL OPTIONS'] *snapshot del-output* [option:--session='SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *snapshot del-output* [option:--session='SESSION'] ('ID' | 'NAME') List current snapshot outputs: [verse] -*lttng* ['GENERAL OPTIONS'] *snapshot list-output* [option:--session='SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *snapshot list-output* [option:--session='SESSION'] Take a snapshot: [verse] -*lttng* ['GENERAL OPTIONS'] *snapshot record* [option:--max-size='SIZE'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *snapshot record* [option:--max-size='SIZE'] [option:--name='NAME'] [option:--session='SESSION'] (option:--ctrl-url='URL' option:--data-url='URL' | 'URL') diff --git a/doc/man/lttng-start.1.txt b/doc/man/lttng-start.1.txt index fff2cf9e2..2c9405bac 100644 --- a/doc/man/lttng-start.1.txt +++ b/doc/man/lttng-start.1.txt @@ -10,7 +10,7 @@ lttng-start - Start LTTng tracers SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *start* ['SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *start* ['SESSION'] DESCRIPTION diff --git a/doc/man/lttng-status.1.txt b/doc/man/lttng-status.1.txt index b156db0a7..5bc6032f5 100644 --- a/doc/man/lttng-status.1.txt +++ b/doc/man/lttng-status.1.txt @@ -10,7 +10,7 @@ lttng-status - Get the current LTTng tracing session's status SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *status* +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *status* DESCRIPTION diff --git a/doc/man/lttng-stop.1.txt b/doc/man/lttng-stop.1.txt index 10ed6b60e..7d71f3be8 100644 --- a/doc/man/lttng-stop.1.txt +++ b/doc/man/lttng-stop.1.txt @@ -10,7 +10,7 @@ lttng-stop - Stop LTTng tracers SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *stop* [option:--no-wait] ['SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *stop* [option:--no-wait] ['SESSION'] DESCRIPTION diff --git a/doc/man/lttng-track.1.txt b/doc/man/lttng-track.1.txt index 9e0d2263f..78bde140f 100644 --- a/doc/man/lttng-track.1.txt +++ b/doc/man/lttng-track.1.txt @@ -10,7 +10,7 @@ lttng-track - Add one or more entries to an LTTng resource tracker SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *track* (option:--kernel | option:--userspace) +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *track* (option:--kernel | option:--userspace) [option:--session='SESSION'] (option:--pid='PID'[,'PID']... | option:--all option:--pid) diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt index b57150633..b7da339df 100644 --- a/doc/man/lttng-untrack.1.txt +++ b/doc/man/lttng-untrack.1.txt @@ -10,7 +10,7 @@ lttng-untrack - Remove one or more entries from an LTTng resource tracker SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *untrack* (option:--kernel | option:--userspace) +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *untrack* (option:--kernel | option:--userspace) [option:--session='SESSION'] (option:--pid='PID'[,'PID']... | option:--all option:--pid) diff --git a/doc/man/lttng-version.1.txt b/doc/man/lttng-version.1.txt index 8c5148f1b..a8397286d 100644 --- a/doc/man/lttng-version.1.txt +++ b/doc/man/lttng-version.1.txt @@ -10,7 +10,7 @@ lttng-version - Get the version of LTTng-tools SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *version* +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *version* DESCRIPTION diff --git a/doc/man/lttng-view.1.txt b/doc/man/lttng-view.1.txt index 184328b51..722a04040 100644 --- a/doc/man/lttng-view.1.txt +++ b/doc/man/lttng-view.1.txt @@ -10,7 +10,7 @@ lttng-view - View the traces of an LTTng tracing session SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *view* [option:--viewer='CMD'] [option:--trace-path='PATH' | 'SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *view* [option:--viewer='CMD'] [option:--trace-path='PATH' | 'SESSION'] DESCRIPTION -- 2.34.1