doc/man: linklttng macro -> man macro
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Thu, 7 Apr 2016 07:17:21 +0000 (03:17 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Sun, 15 May 2016 16:56:47 +0000 (12:56 -0400)
This macro is shorter, and some referenced man pages are not
LTTng man pages, so the linklttng name makes little sense.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
31 files changed:
doc/man/README.md
doc/man/asciidoc.conf
doc/man/common-cmd-footer.txt
doc/man/common-cmd-help-options.txt
doc/man/common-cmd-options-head.txt
doc/man/lttng-add-context.1.txt
doc/man/lttng-calibrate.1.txt
doc/man/lttng-crash.1.txt
doc/man/lttng-create.1.txt
doc/man/lttng-destroy.1.txt
doc/man/lttng-disable-channel.1.txt
doc/man/lttng-disable-event.1.txt
doc/man/lttng-enable-channel.1.txt
doc/man/lttng-enable-event.1.txt
doc/man/lttng-help.1.txt
doc/man/lttng-list.1.txt
doc/man/lttng-load.1.txt
doc/man/lttng-metadata.1.txt
doc/man/lttng-relayd.8.txt
doc/man/lttng-save.1.txt
doc/man/lttng-sessiond.8.txt
doc/man/lttng-set-session.1.txt
doc/man/lttng-snapshot.1.txt
doc/man/lttng-start.1.txt
doc/man/lttng-status.1.txt
doc/man/lttng-stop.1.txt
doc/man/lttng-track.1.txt
doc/man/lttng-untrack.1.txt
doc/man/lttng-version.1.txt
doc/man/lttng-view.1.txt
doc/man/lttng.1.txt

index 316c4d58ca2aa751afd5261c3d85b6a62998179b..c904d77a6d5d9696b29e8d5f6df76377f7f028a2 100644 (file)
@@ -23,13 +23,12 @@ AsciiDoc is configured with `asciidoc.conf` which contains a few
 macro definitions used everywhere in the man page sources.
 
 
-### linklttng
+### man
 
-The linklttng macro is used to link to another LTTng man page. Its
-output is different depending on the back-end. In troff, the man page
-name is rendered in bold, whereas the HTML5 output renders a hyperlink.
+The man macro is used to link to another man page. In troff, the man
+page name is rendered in bold.
 
-Usage example: `linklttng:lttng-enable-channel(1)`.
+Usage example: `man:lttng-enable-channel(1)`.
 
 
 ### linkgenoptions
index d6045fd2052b2770f7283461060f7f6b1177eb9e..d036e09a880102997cd9940921fa129e42abeaf0 100644 (file)
@@ -1,12 +1,12 @@
 [macros]
 
-# linklttng macro
+# man macro
 #
 # Inspired by linkgit macro:
 # <https://github.com/git/git/blob/master/Documentation/asciidoc.conf>
 #
-# Usage: linklttng:command(manpage-section)
-(?su)[\\]?(?P<name>linklttng):(?P<target>\S*?)\((?P<attrlist>.*?)\)=
+# Usage: man:command(manpage-section)
+(?su)[\\]?(?P<name>man):(?P<target>\S*?)\((?P<attrlist>.*?)\)=
 
 # linkgenoptions macro
 #
@@ -38,9 +38,9 @@
 # Usage: :escwc:
 :escwc:=escwc
 
-# linklttng macro expansions
+# man macro expansions
 ifdef::backend-docbook[]
-[linklttng-inlinemacro]
+[man-inlinemacro]
 {0%{target}}
 {0#<citerefentry>}
 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
index 61f5bb0a1ab29fd0f1aae7fd1b62e3989279b04a..329cca6181ad47f0d6e3567fb3fa6c6e3778e505 100644 (file)
@@ -6,7 +6,7 @@ ENVIRONMENT VARIABLES
 
 `LTTNG_MAN_BIN_PATH`::
     Absolute path to the man pager to use for viewing help information
-    about LTTng commands (using linklttng:lttng-help(1) or
+    about LTTng commands (using man:lttng-help(1) or
     `lttng COMMAND --help`).
 
 `LTTNG_SESSION_CONFIG_XSD_PATH`::
@@ -19,9 +19,9 @@ ENVIRONMENT VARIABLES
 The genoption:--sessiond-path option has precedence over this
 environment variable.
 
-Note that the linklttng:lttng-create(1) command can spawn an LTTng
+Note that the man:lttng-create(1) command can spawn an LTTng
 session daemon automatically if none is running. See
-linklttng:lttng-sessiond(8) for the environment variables influencing
+man:lttng-sessiond(8) for the environment variables influencing
 the execution of the session daemon.
 
 
@@ -31,13 +31,13 @@ FILES
     User LTTng runtime configuration.
 +
 This is where the per-user current tracing session is stored between
-executions of linklttng:lttng(1). The current tracing session can be set
-with linklttng:lttng-set-session(1). See linklttng:lttng-create(1) for
+executions of man:lttng(1). The current tracing session can be set
+with man:lttng-set-session(1). See man:lttng-create(1) for
 more information about tracing sessions.
 
 `$LTTNG_HOME/lttng-traces`::
     Default output directory of LTTng traces. This can be overridden
-    with the nloption:--output option of the linklttng:lttng-create(1)
+    with the nloption:--output option of the man:lttng-create(1)
     command.
 
 `$LTTNG_HOME/.lttng`::
@@ -45,11 +45,11 @@ more information about tracing sessions.
 
 `$LTTNG_HOME/.lttng/sessions`::
     Default location of saved user tracing sessions (see
-    linklttng:lttng-save(1) and linklttng:lttng-load(1)).
+    man:lttng-save(1) and man:lttng-load(1)).
 
 `/etc/lttng/sessions`::
     System-wide location of saved tracing sessions
-    (see linklttng:lttng-save(1) and linklttng:lttng-load(1)).
+    (see man:lttng-save(1) and man:lttng-load(1)).
 
 NOTE: `$LTTNG_HOME` defaults to `$HOME` when not explicitly set.
 
index c1120c3c12254cc415a92ef41dc1bb30d71257be..2e5bcf928e176509f2c8a039c4dce9cc927f2eea 100644 (file)
@@ -3,7 +3,7 @@ Program information
 option:-h, option:--help::
     Show command help.
 +
-This option, like linklttng:lttng-help(1), attempts to launch
+This option, like man:lttng-help(1), attempts to launch
 `/usr/bin/man` to view the command's man page. The path to the man pager
 can be overridden by the `LTTNG_MAN_BIN_PATH` environment variable.
 
index 169a869e9a8dd1620b0461e4f7c1c1d0889ab272..362995ecbf4bdf1ad32fe38cfeabc874e670fa97 100644 (file)
@@ -1,3 +1,3 @@
 OPTIONS
 -------
-linkgenoptions:(General options) are described in linklttng:lttng(1).
+linkgenoptions:(General options) are described in man:lttng(1).
index 529a7da26478f15891d002c29e666ad29b7bbd48..f995a7fbe2fd629f1091c68427edc30fc3410db8 100644 (file)
@@ -28,7 +28,7 @@ DESCRIPTION
 The `lttng add-context` command adds one or more context fields to a
 channel.
 
-Channels are created with the linklttng:lttng-enable-channel(1) command.
+Channels are created with the man:lttng-enable-channel(1) command.
 
 When context fields are added to a channel, all the events emitted
 within this channel contain the dynamic values of those context fields.
@@ -116,4 +116,4 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1)
+man:lttng(1)
index 54d245ef0b84ae5f2f5bcc6446518a7aa225bc10..02195b85d08b96c8f9064c5dffe9c1ae3e2a194e 100644 (file)
@@ -56,7 +56,7 @@ lttng destroy
 babeltrace $(ls -1drt ~/lttng-traces/calibrate-function-* | tail -n 1)
 ------------------------------------------------------------------------
 
-The output from linklttng:babeltrace(1) can be saved to a text file and
+The output from man:babeltrace(1) can be saved to a text file and
 opened in a spreadsheet (for example, in LibreOffice) to focus on the
 per-PMU counter delta between consecutive `calibrate_entry` and
 `calibrate_return` events. Note that these counters are per-CPU, so
@@ -113,4 +113,4 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1)
+man:lttng(1)
index 1d74deba113207fba71aac8dd0145119e666bc9a..7427af94f5db14b0b6270153180ec6843b6e7b3c 100644 (file)
@@ -74,8 +74,8 @@ include::common-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1),
-linklttng:lttng-sessiond(8),
-linklttng:lttng-relayd(8),
-linklttng:lttng-ust(3),
-linklttng:babeltrace(1)
+man:lttng(1),
+man:lttng-sessiond(8),
+man:lttng-relayd(8),
+man:lttng-ust(3),
+man:babeltrace(1)
index 6e158ecb7bb1bcdbf467d5b20a5b8b2a45c23013..ef94472f06fd81ee34527b63136e6bf20a69b93f 100644 (file)
@@ -43,7 +43,7 @@ On execution, an `.lttngrc` file is created, if it does not exist, in the
 user's home directory. This file contains the name of the current tracing
 session. When creating a new tracing session with `lttng create`, the
 current tracing session is set to this new tracing session. The
-linklttng:lttng-set-session(1) command can be used to set the current
+man:lttng-set-session(1) command can be used to set the current
 tracing session without manually editing the `.lttngrc` file.
 
 If 'SESSION' is omitted, a session name is automatically created having
@@ -55,9 +55,9 @@ shared memory holding the ring buffers. Specifying a location on an
 NVRAM file system makes it possible to retrieve the latest recorded
 trace data when the system reboots after a crash. To view the events
 of ring buffer files after a system crash, use the
-linklttng:lttng-crash(1) utility.
+man:lttng-crash(1) utility.
 
-Tracing sessions are destroyed using the linklttng:lttng-destroy(1)
+Tracing sessions are destroyed using the man:lttng-destroy(1)
 command.
 
 
@@ -76,14 +76,14 @@ Snapshot mode::
     Traces the local system without writing the trace to the local file
     system (implicit option:--no-output option). Channels are automatically
     configured to be snapshot-ready on creation (see
-    linklttng:lttng-enable-channel(1)). The linklttng:lttng-snapshot(1)
+    man:lttng-enable-channel(1)). The man:lttng-snapshot(1)
     command is used to take snapshots of the current ring buffers.
     The option:--set-url, or option:--ctrl-url and option:--data-url
     options set the default snapshot output destination.
 
 Live mode::
     Traces the local system, sending trace data to an LTTng relay daemon
-    over the network (see linklttng:lttng-relayd(8)). The
+    over the network (see man:lttng-relayd(8)). The
     option:--set-url, or option:--ctrl-url and option:--data-url options
     set the trace output destination. The live output URLs cannot use
     the `file://` protocol (see URL format below).
@@ -132,7 +132,7 @@ The other version is used for *network streaming*.
 'TRACEPATH'::
     Path of trace files on the remote file system. This path is relative
     to the base output directory set on the relay daemon side;
-    see linklttng:lttng-relayd(8).
+    see man:lttng-relayd(8).
 
 
 include::common-cmd-options-head.txt[]
@@ -145,7 +145,7 @@ option:--live[='DELAYUS']::
     given in microseconds, is the maximum time the user can wait for
     the data to be flushed. This mode can be set with a network URL
     (options option:--set-url, or option:--ctrl-url and option:--data-url)
-    and must have a relay daemon listening (see linklttng:lttng-relayd(8)).
+    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`.
@@ -196,6 +196,6 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-destroy(1),
-linklttng:lttng-set-session(1),
-linklttng:lttng(1)
+man:lttng-destroy(1),
+man:lttng-set-session(1),
+man:lttng(1)
index 74921bb25c05889028dac02fed2c1a5e7af6b896..49f3f7a043014cf6dd9b0b0d3a8ff11be9404a4d 100644 (file)
@@ -18,12 +18,12 @@ DESCRIPTION
 The `lttng destroy` command destroys one or more tracing sessions.
 
 If no options are specified, the current tracing session is destroyed
-(see linklttng:lttng-create(1) for more information about the current
+(see man:lttng-create(1) for more information about the current
 tracing session).
 
 If 'SESSION' is specified, the existing tracing session named 'SESSION'
 is destroyed. `lttng list` outputs all the existing tracing sessions
-(see linklttng:lttng-list(1)).
+(see man:lttng-list(1)).
 
 If the option:--all option is used, *all* the tracing sessions, as listed
 in the output of `lttng list`, are destroyed.
@@ -50,6 +50,6 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-create(1),
-linklttng:lttng-set-session(1),
-linklttng:lttng(1)
+man:lttng-create(1),
+man:lttng-set-session(1),
+man:lttng(1)
index 7cd366f038a07a82042e249606308bcc1232bb0e..1218739f3f3b521eb311610511f3717e0140d13e 100644 (file)
@@ -17,10 +17,10 @@ SYNOPSIS
 DESCRIPTION
 -----------
 The `lttng disable-channel` command disables one or more channels
-previously enabled by the linklttng:lttng-enable-channel(1) command.
+previously enabled by the man:lttng-enable-channel(1) command.
 
 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 disabled using `lttng disable-channel` can
 be specified using the option:--session option. If the option:--session
 option is omitted, the current tracing session is targeted.
@@ -58,5 +58,5 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-disable-channel(1),
-linklttng:lttng(1)
+man:lttng-disable-channel(1),
+man:lttng(1)
index f135880c931566b70d6d9a7cf60d28dfb7db7625..8004e7b527a7710849bbdfceb56f54f07bb92025 100644 (file)
@@ -19,7 +19,7 @@ SYNOPSIS
 DESCRIPTION
 -----------
 The `lttng disable-event` command disables one or more event rules
-previously enabled by the linklttng:lttng-enable-event(1) command.
+previously enabled by the man:lttng-enable-event(1) command.
 
 Event rules are always assigned to a channel when they are created. If
 the option:--channel option is omitted, the default channel named
@@ -35,11 +35,11 @@ to disable named 'EVENT' must be specified.
 With the option:--kernel option, the event source type can be specified
 using one of the option:--tracepoint, option:--probe,
 option:--function, or option:--syscall options. See
-linklttng:lttng-enable-event(1) for more details about event source
+man:lttng-enable-event(1) for more details about event source
 types.
 
 Events can be disabled while tracing is active
-(use linklttng:lttng-start(1) to make a tracing session active).
+(use man:lttng-start(1) to make a tracing session active).
 
 
 include::common-cmd-options-head.txt[]
@@ -112,5 +112,5 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-enable-event(1),
-linklttng:lttng(1)
+man:lttng-enable-event(1),
+man:lttng(1)
index 9365a7806e658fb1fd30a7e7e4a0896a0085a8d1..1178b08d202a08e8c4aaf9297a32b1107bd6b0da 100644 (file)
@@ -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 <<limitations,LIMITATIONS>> section below for a list of
 limitations of this command to consider.
@@ -366,5 +366,5 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-disable-channel(1),
-linklttng:lttng(1)
+man:lttng-disable-channel(1),
+man:lttng(1)
index f0755333c8f6ac510ae4b88d79211b4013a29c0b..afdbd6747e336fe4a42ae14c311d57011aeb7f57 100644 (file)
@@ -42,9 +42,9 @@ An event rule created by `lttng enable-event` is a set of conditions
 that must be satisfied in order for an actual event to be emitted by
 an LTTng tracer when the execution of an application or the Linux kernel
 reaches an event source (tracepoint, system call, dynamic probe).
-Event sources can be listed with the linklttng:lttng-list(1) command.
+Event sources can be listed with the man:lttng-list(1) command.
 
-The linklttng:lttng-disable-event(1) command can be used to disable
+The man:lttng-disable-event(1) command can be used to disable
 existing event rules.
 
 Event rules are always assigned to a channel when they are created. If
@@ -56,7 +56,7 @@ If the option:--session option is omitted, the chosen channel is picked
 from the current tracing session.
 
 Events can be enabled while tracing is active
-(use linklttng:lttng-start(1) to make a tracing session active).
+(use man:lttng-start(1) to make a tracing session active).
 
 
 Event source types
@@ -163,7 +163,7 @@ When using `lttng enable-event` with a set of conditions that does not
 currently exist for the chosen tracing session, domain, and channel,
 a new event rule is created. Otherwise, the existing event rule is
 enabled if it is currently disabled
-(see linklttng:lttng-disable-event(1)).
+(see man:lttng-disable-event(1)).
 
 The option:--all option can be used alongside the option:--tracepoint
 or option:--syscall options. When this option is used, no 'EVENT'
@@ -222,11 +222,11 @@ a C identifier.
 The dynamic value of a statically-known context field is read by
 prefixing its name with `$ctx.`. Statically-known context fields are
 context fields added to channels without the `$app.` prefix using the
-linklttng:lttng-add-context(1) command.
+man:lttng-add-context(1) command.
 
 The dynamic value of an application-specific context field is read by
 prefixing its name with `$app.` (follows the format used to add such a
-context field with the linklttng:lttng-add-context(1) command).
+context field with the man:lttng-add-context(1) command).
 
 When a comparison includes a non existent event field, the whole filter
 expression evaluates to false (the event is discarded).
@@ -242,7 +242,7 @@ or constants).
 NOTE: Although it is possible to filter the process ID of an event when
 the `pid` context has been added to its channel using, for example,
 `$ctx.pid == 2832`, it is recommended to use the PID tracker instead,
-which is much more efficient (see linklttng:lttng-track(1)).
+which is much more efficient (see man:lttng-track(1)).
 
 Examples:
 
@@ -437,5 +437,5 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-disable-event(1),
-linklttng:lttng(1)
+man:lttng-disable-event(1),
+man:lttng(1)
index 558792e79bfa46e81fba83002f2e1938bb9c90fc..271e2e86733ece1771484f3c63fae521f743340a 100644 (file)
@@ -27,7 +27,7 @@ lttng COMMAND --help
 
 where `COMMAND` is the name of the command about which to get help. If
 'COMMAND' is omitted, `lttng help` shows general help about the
-linklttng:lttng(1) command.
+man:lttng(1) command.
 
 The `lttng help` command attempts to launch `/usr/bin/man` to view
 the command's man page. The path to the man pager can be overridden
@@ -45,4 +45,4 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1)
+man:lttng(1)
index b0daca8af60a785258badbddaba5413ee18bf8c1..5dad88376b5a6ab449cd8a9863d2b30bfdf94a08 100644 (file)
@@ -107,4 +107,4 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1)
+man:lttng(1)
index e4cff034f4498b5c6cd89e4cc0e936babe74eb54..b0241b61cb6ba2df0d670c374786b0b14d6c44dc 100644 (file)
@@ -19,7 +19,7 @@ The `lttng load` command loads the configurations of one or more
 tracing sessions from files.
 
 The `lttng load` command is used in conjunction with the
-linklttng:lttng-save(1) command to save and restore the complete
+man:lttng-save(1) command to save and restore the complete
 configurations of tracing sessions. This includes the enabled channels
 and event rules, the context added to channels, the tracing activity,
 and more.
@@ -69,5 +69,5 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-save(1),
-linklttng:lttng(1)
+man:lttng-save(1),
+man:lttng(1)
index dfe3d54e447cce790957d13d4b6929e72df40d1f..0fa240edea998f2e17a9c3af1f109d94541dc60e 100644 (file)
@@ -49,8 +49,8 @@ The `lttng metadata regenerate` command can only be used on kernel and
 user space tracing sessions (using per-user buffering), in non-live
 mode.
 
-See linklttng:lttng-enable-channel(1) for more information about
-buffering schemes and linklttng:lttng-create(1) for more information
+See man:lttng-enable-channel(1) for more information about
+buffering schemes and man:lttng-create(1) for more information
 about the different tracing session modes.
 
 
@@ -59,4 +59,4 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1)
+man:lttng(1)
index 3f6759e166110a731b586c772ced9fbd8e9cfdf9..1a366f9b8a50e9f0cb31d2a26942fb1371d089cd 100644 (file)
@@ -198,8 +198,8 @@ include::common-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1),
-linklttng:lttng-sessiond(8),
-linklttng:lttng-crash(1),
-linklttng:lttng-ust(3),
-linklttng:babeltrace(1)
+man:lttng(1),
+man:lttng-sessiond(8),
+man:lttng-crash(1),
+man:lttng-ust(3),
+man:babeltrace(1)
index f7b1c219043e3dfefe52313991d444a82d684d9a..46fdb00b990a66037bedc1be9d2c58d49bdcdff7 100644 (file)
@@ -19,7 +19,7 @@ The `lttng save` command saves the configurations of one or more
 tracing sessions to files.
 
 The `lttng save` command is used in conjunction with the
-linklttng:lttng-load(1) command to save and restore the complete
+man:lttng-load(1) command to save and restore the complete
 configurations of tracing sessions. This includes the enabled channels
 and event rules, the context added to channels, the tracing activity,
 and more. `lttng save` does not save tracing data, only the tracing
@@ -28,7 +28,7 @@ session parameters.
 If 'SESSION' is omitted, all the existing tracing session configurations
 are saved (equivalent to using the option:--all option). Otherwise,
 'SESSION' is the name of an existing tracing session. `lttng list`
-outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
+outputs all the existing tracing sessions (see man:lttng-list(1)).
 
 The default output directory path is `$LTTNG_HOME/.lttng/sessions`
 (`$LTTNG_HOME` defaults to `$HOME`). Each tracing session configuration
@@ -63,5 +63,5 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-load(1),
-linklttng:lttng(1)
+man:lttng-load(1),
+man:lttng(1)
index a373415208f30021614c960755bf482d00c0d900..130a477b0062e00ec603c15b72c2fd046158a1ae 100644 (file)
@@ -40,8 +40,8 @@ The _LTTng session daemon_ is a tracing registry which allows the user
 to interact with multiple tracers (kernel and user space) within the
 same container, a _tracing session_. Traces can be gathered from the
 Linux kernel and/or from instrumented applications (see
-linklttng:lttng-ust(3)). You can aggregate and read the events of LTTng
-traces using linklttng:babeltrace(1).
+man:lttng-ust(3)). You can aggregate and read the events of LTTng
+traces using man:babeltrace(1).
 
 To trace the Linux kernel, the session daemon needs to be running as
 `root`. LTTng uses a _tracing group_ to allow specific users to interact
@@ -102,7 +102,7 @@ option:-l, option:--load='PATH'::
 option:-S, option:--sig-parent::
     Send `SIGUSR1` to parent process to notify readiness.
 +
-NOTE: This is used by linklttng:lttng(1) to get notified when the
+NOTE: This is used by man:lttng(1) to get notified when the
 session daemon is ready to accept commands. When building a third party
 tool on liblttng-ctl, this option can be very handy to synchronize the
 control tool and the session daemon.
@@ -268,16 +268,16 @@ FILES
 
 `$LTTNG_HOME/lttng-traces`::
     Default output directory of LTTng traces. This can be overridden
-    with the nloption:--output option of the linklttng:lttng-create(1)
+    with the nloption:--output option of the man:lttng-create(1)
     command.
 
 `$LTTNG_HOME/.lttng/sessions`::
     Default location of saved user tracing sessions (see
-    linklttng:lttng-save(1) and linklttng:lttng-load(1)).
+    man:lttng-save(1) and man:lttng-load(1)).
 
 `/etc/lttng/sessions`::
     System-wide location of saved tracing sessions
-    (see linklttng:lttng-save(1) and linklttng:lttng-load(1)).
+    (see man:lttng-save(1) and man:lttng-load(1)).
 
 `$LTTNG_HOME/.lttng/lttng.conf`::
     Default location of the session daemon configuration file (see the
@@ -319,8 +319,8 @@ include::common-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1),
-linklttng:lttng-relayd(8),
-linklttng:lttng-crash(1),
-linklttng:lttng-ust(3),
-linklttng:babeltrace(1)
+man:lttng(1),
+man:lttng-relayd(8),
+man:lttng-crash(1),
+man:lttng-ust(3),
+man:babeltrace(1)
index 998266affb5b1a243197988b5e0894a54c5af019..d9c041cf404ba9602b450463e57ecb7602312ad5 100644 (file)
@@ -18,10 +18,10 @@ DESCRIPTION
 The `lttng set-session` command sets the current tracing session.
 
 'SESSION' is the name of an existing tracing session. `lttng list`
-outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
+outputs all the existing tracing sessions (see man:lttng-list(1)).
 
 The current tracing session is used by default when a session can be
-specified in other commands. See linklttng:lttng-create(1) for more
+specified in other commands. See man:lttng-create(1) for more
 information about the current tracing session.
 
 
@@ -36,6 +36,6 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-create(1),
-linklttng:lttng-destroy(1),
-linklttng:lttng(1)
+man:lttng-create(1),
+man:lttng-destroy(1),
+man:lttng(1)
index 7dcfa00a1ed78387eb1259b978b3dfc3e6bd2a53..e4a02033a99394008c11bb4a339a5860e77c96d2 100644 (file)
@@ -46,7 +46,7 @@ is sent to the registered snapshot outputs.
 
 The tracing session should be created in _snapshot mode_ to make sure
 taking snapshots is allowed. This is done at tracing session creation
-time using the linklttng:lttng-create(1) command.
+time using the man:lttng-create(1) command.
 
 Note that, when a snapshot is taken, the sub-buffers are not cleared.
 This means that different recorded snapshots may contain the same
@@ -63,7 +63,7 @@ As of this version, only one snapshot output is allowed.
 A snapshot output can be added using the `add-output` action. The
 output destination URL is set using either the 'URL' positional
 argument, or both the option:--ctrl-url and option:--data-url options.
-See linklttng:lttng-create(1) to learn more about the URL format.
+See man:lttng-create(1) to learn more about the URL format.
 
 A name can be assigned to an output when adding it using the
 option:--name option. This name is part of the names of the
@@ -95,10 +95,10 @@ options supported by the `add-output` action.
 
 NOTE: Before taking a snapshot on a system with a high event throughput,
 it is recommended to first run `lttng stop` (see
-linklttng:lttng-stop(1)). Otherwise, the snapshot could contain "holes",
+man:lttng-stop(1)). Otherwise, the snapshot could contain "holes",
 the result of the tracers overwriting unconsumed trace packets during
 the record operation. After the snapshot is recorded, the tracers can be
-started again with `lttng start` (see linklttng:lttng-start(1)).
+started again with `lttng start` (see man:lttng-start(1)).
 
 
 include::common-cmd-options-head.txt[]
@@ -139,4 +139,4 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1)
+man:lttng(1)
index 2c9405bacc82336a8e391398d0ba2624eac7ad01..541c4aedee71d8927377017e1cb396efb2061c84 100644 (file)
@@ -23,17 +23,17 @@ within enabled channels can make their target event sources _emit_ trace
 events. Whether they are recorded to the local file system, sent over
 the network, or not recorded at all depends on the specific
 configuration of the tracing session in which tracing is started. See
-linklttng:lttng-create(1) for different session modes.
+man:lttng-create(1) for different session modes.
 
 A tracing session with running tracers is said to be _active_. Active
 tracing sessions can return to the inactive state using the
-linklttng:lttng-stop(1) command.
+man:lttng-stop(1) command.
 
 If 'SESSION' is omitted, the LTTng tracers are started for the current
-tracing session (see linklttng:lttng-create(1) for more information
+tracing session (see man:lttng-create(1) for more information
 about the current tracing session). Otherwise, they are started for the
 existing tracing session named 'SESSION'. `lttng list`
-outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
+outputs all the existing tracing sessions (see man:lttng-list(1)).
 
 
 include::common-cmd-options-head.txt[]
@@ -47,5 +47,5 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-stop(1),
-linklttng:lttng(1)
+man:lttng-stop(1),
+man:lttng(1)
index 5bc6032f59385576519665cc5f77a94d4cee2769..0d4965b77320c817b81f8fa75c702fa589f4364d 100644 (file)
@@ -26,7 +26,7 @@ lttng list CURSESSION
 ---------------------
 
 where `CURSESSION` is the name of the current tracing session.
-Use linklttng:lttng-set-session(1) to set the current tracing session.
+Use man:lttng-set-session(1) to set the current tracing session.
 
 
 include::common-cmd-options-head.txt[]
@@ -40,5 +40,5 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-set-session(1),
-linklttng:lttng(1)
+man:lttng-set-session(1),
+man:lttng(1)
index 7d71f3be882d7524c929026c20bb03d7cc2bdbad..6405d7b726a0e55cfb85e5d3326dcdff7c598227 100644 (file)
@@ -24,13 +24,13 @@ anymore.
 
 A tracing session with no running tracers is said to be _inactive_.
 Inactive tracing sessions can be set active using the
-linklttng:lttng-start(1) command.
+man:lttng-start(1) command.
 
 If 'SESSION' is omitted, the LTTng tracers are stopped for the current
-tracing session (see linklttng:lttng-create(1) for more information
+tracing session (see man:lttng-create(1) for more information
 about the current tracing session). Otherwise, they are stopped for the
 existing tracing session named 'SESSION'. `lttng list`
-outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
+outputs all the existing tracing sessions (see man:lttng-list(1)).
 
 By default, the `lttng stop` command ensures that the tracing session's
 trace data is valid before returning to the prompt. With the
@@ -55,5 +55,5 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-start(1),
-linklttng:lttng(1)
+man:lttng-start(1),
+man:lttng(1)
index 78bde140f673fcfe596ee2630bd3a1f17d82ec0e..739093d723aca09745fcab75ac2f5a67746241ca 100644 (file)
@@ -21,10 +21,10 @@ resource tracker.
 
 A resource tracker is a _whitelist_ of resources. Tracked resources are
 allowed to emit events, provided those events are targeted by enabled
-event rules (see linklttng:lttng-enable-event(1)).
+event rules (see man:lttng-enable-event(1)).
 
 Tracker entries can be removed from the whitelist with
-linklttng:lttng-untrack(1).
+man:lttng-untrack(1).
 
 As of this version, the only available tracker is the *PID tracker*. The
 process ID (PID) tracker follows one or more process IDs; only the
@@ -102,7 +102,7 @@ It should be noted that the PID tracker tracks the numeric process IDs.
 Should a process with a given ID exit and another process be given this
 ID, then the latter would also be allowed to emit events.
 
-See the linklttng:lttng-untrack(1) for more details about removing
+See the man:lttng-untrack(1) for more details about removing
 entries.
 
 
@@ -148,5 +148,5 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-untrack(1),
-linklttng:lttng(1)
+man:lttng-untrack(1),
+man:lttng(1)
index b7da339df9c06b2204d0d23b3ed6a8bc9428bf67..43d135c63aa94676743c6ae49523bc03089661f6 100644 (file)
@@ -19,11 +19,11 @@ DESCRIPTION
 The `lttng untrack` commands removes one or more entries from a
 resource tracker.
 
-See linklttng:lttng-track(1) to learn more about LTTng trackers.
+See man:lttng-track(1) to learn more about LTTng trackers.
 
 The untrack command removes specific resources from a tracker. The
 resources to remove must have been precedently added by
-linklttng:lttng-track(1). It is also possible to remove all the
+man:lttng-track(1). It is also possible to remove all the
 resources from the whitelist using the option:--all option.
 
 As of this version, the only available tracker is the PID tracker.
@@ -32,7 +32,7 @@ As of this version, the only available tracker is the PID tracker.
 Example
 ~~~~~~~
 One common operation is to create a tracing session
-(see linklttng:lttng-create(1)), remove all the entries from the PID
+(see man:lttng-create(1)), remove all the entries from the PID
 tracker whitelist, start tracing, and then manually track PIDs
 while tracing is active.
 
@@ -136,5 +136,5 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-track(1),
-linklttng:lttng(1)
+man:lttng-track(1),
+man:lttng(1)
index a8397286dc9d16de07b32854a62a09af68558de5..faa14c58e0f6ebb9c26b4f8b436f0a8024fd0141 100644 (file)
@@ -37,4 +37,4 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1)
+man:lttng(1)
index 722a04040b3f8d696490b4b4f4a3e3c051d7faca..923b117b053d185b9d0b6e04ae92e4ac50a55eef 100644 (file)
@@ -19,12 +19,12 @@ The `lttng view` command launches an external trace viewer to view the
 current trace of a tracing session.
 
 If 'SESSION' is omitted, the viewer is launched for the current tracing
-session (see linklttng:lttng-create(1) for more information
+session (see man:lttng-create(1) for more information
 about the current tracing session). Otherwise, it is launched for the
 existing tracing session named 'SESSION'. `lttng list`
-outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
+outputs all the existing tracing sessions (see man:lttng-list(1)).
 
-By default, the linklttng:babeltrace(1) trace viewer is launched.
+By default, the man:babeltrace(1) trace viewer is launched.
 Another trace viewer command can be specified using the
 option:--viewer option.
 
@@ -52,4 +52,4 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1)
+man:lttng(1)
index c569d3db4332d0ce7d07195acb9427ff11210148..5b30b123b574ce26bcf989057ae058281f91205b 100644 (file)
@@ -23,7 +23,7 @@ user applications, and user libraries.
 LTTng consists of Linux kernel modules (for Linux kernel tracing) and
 dynamically loaded libraries (for user application and library tracing).
 
-An LTTng _session daemon_, linklttng:lttng-sessiond(8), receives
+An LTTng _session daemon_, man:lttng-sessiond(8), receives
 commands from the command-line interface `lttng` to control the LTTng
 tracers. All interactions with the LTTng tracers happen through the
 `lttng` tool or through the liblttng-ctl library shipped with the
@@ -48,14 +48,14 @@ nloption:-p, nloption:--python::
 
 nloption:-u, nloption:--userspace::
     Apply command to the user space domain (application using
-    liblttng-ust directly; see linklttng:lttng-ust(3)).
+    liblttng-ust directly; see man:lttng-ust(3)).
 
 The LTTng session daemon is a tracing registry which allows the user to
 interact with multiple tracers (kernel and user space) within the same
 container, a _tracing session_. Traces can be gathered from the Linux
 kernel and/or from instrumented applications (see
-linklttng:lttng-ust(3)). You can aggregate and read the events of LTTng
-traces using linklttng:babeltrace(1).
+man:lttng-ust(3)). You can aggregate and read the events of LTTng
+traces using man:babeltrace(1).
 
 To trace the Linux kernel, the session daemon needs to be running as
 `root`. LTTng uses a _tracing group_ to allow specific users to interact
@@ -73,9 +73,9 @@ for stable and long-term tracing.
 User applications instrumented with LTTng automatically register to the
 root session daemon and to user session daemons. This allows any session
 daemon to list the available traceable applications and event sources
-(see linklttng:lttng-list(1)).
+(see man:lttng-list(1)).
 
-By default, the linklttng:lttng-create(1) command automatically spawns a
+By default, the man:lttng-create(1) command automatically spawns a
 user session daemon if none is currently running. The
 option:--no-sessiond general option can be set to avoid this.
 
@@ -147,88 +147,88 @@ The following commands also have their own nloption:--help option.
 
 Tracing sessions
 ~~~~~~~~~~~~~~~~
-linklttng:lttng-create(1)::
+man:lttng-create(1)::
     Create a tracing session.
 
-linklttng:lttng-destroy(1)::
+man:lttng-destroy(1)::
     Tear down tracing sessions.
 
-linklttng:lttng-load(1)::
+man:lttng-load(1)::
     Load tracing session configurations.
 
-linklttng:lttng-metadata(1)::
+man:lttng-metadata(1)::
     Manage an LTTng tracing session's metadata generation.
 
-linklttng:lttng-save(1)::
+man:lttng-save(1)::
     Save tracing session configurations.
 
-linklttng:lttng-set-session(1)::
+man:lttng-set-session(1)::
     Set current tracing session.
 
 
 Channels
 ~~~~~~~~
-linklttng:lttng-add-context(1)::
+man:lttng-add-context(1)::
     Add context fields to a channel.
 
-linklttng:lttng-disable-channel(1)::
+man:lttng-disable-channel(1)::
     Disable tracing channels.
 
-linklttng:lttng-enable-channel(1)::
+man:lttng-enable-channel(1)::
     Create or enable tracing channels.
 
 
 Event rules
 ~~~~~~~~~~~
-linklttng:lttng-disable-event(1)::
+man:lttng-disable-event(1)::
     Disable event rules.
 
-linklttng:lttng-enable-event(1)::
+man:lttng-enable-event(1)::
     Create or enable event rules.
 
 
 Status
 ~~~~~~
-linklttng:lttng-list(1)::
+man:lttng-list(1)::
     List tracing sessions, domains, channels, and events.
 
-linklttng:lttng-status(1)::
+man:lttng-status(1)::
     Get the status of the current tracing session.
 
 
 Control
 ~~~~~~~
-linklttng:lttng-snapshot(1)::
+man:lttng-snapshot(1)::
     Snapshot buffers of current tracing session.
 
-linklttng:lttng-start(1)::
+man:lttng-start(1)::
     Start tracing.
 
-linklttng:lttng-stop(1)::
+man:lttng-stop(1)::
     Stop tracing.
 
 
 Resource tracking
 ~~~~~~~~~~~~~~~~~
-linklttng:lttng-track(1)::
+man:lttng-track(1)::
     Track specific system resources.
 
-linklttng:lttng-untrack(1)::
+man:lttng-untrack(1)::
     Untrack specific system resources.
 
 
 Miscellaneous
 ~~~~~~~~~~~~~
-linklttng:lttng-calibrate(1)::
+man:lttng-calibrate(1)::
     Quantify LTTng overhead.
 
-linklttng:lttng-help(1)::
+man:lttng-help(1)::
     Display help information about a command.
 
-linklttng:lttng-version(1)::
+man:lttng-version(1)::
     Show version information.
 
-linklttng:lttng-view(1)::
+man:lttng-view(1)::
     Start trace viewer.
 
 
@@ -237,8 +237,8 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-sessiond(8),
-linklttng:lttng-relayd(8),
-linklttng:lttng-crash(1),
-linklttng:lttng-ust(3),
-linklttng:babeltrace(1)
+man:lttng-sessiond(8),
+man:lttng-relayd(8),
+man:lttng-crash(1),
+man:lttng-ust(3),
+man:babeltrace(1)
This page took 0.051098 seconds and 5 git commands to generate.