commands/showdebug/showdebug.cif
author Tom Sutcliffe <thomas.sutcliffe@accenture.com>
Thu, 21 Oct 2010 22:32:59 +0100
changeset 73 dc41da2f70a4
permissions -rw-r--r--
Added showdebug command. Also: * Added an exported constructor to RChildProcess so the iProcess handle was set to zero on construction. * Fixed bug in fshell_builddocs script that created HTML relative links with backslashes instead of forward slashes.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
73
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     1
# showdebug.cif
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     2
# 
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     3
# Copyright (c) 2010 Accenture. All rights reserved.
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     4
# This component and the accompanying materials are made available
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     5
# under the terms of the "Eclipse Public License v1.0"
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     6
# which accompanies this distribution, and is available
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     7
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     8
# 
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     9
# Initial Contributors:
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    10
# Accenture - Initial contribution
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    11
#
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    12
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    13
==name showdebug
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    14
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    15
==short-description
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    16
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    17
Redirects RDebug::Print to the console.
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    18
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    19
==long-description
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    20
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    21
Uses the clogger debugrouter LDD to intercept Kern::Printf and RDebug::Print calls and redirect them to the console. Similar to C<cloggerconfig --rdebug> but without all the features clogger layers on top, more focussed on just printing the rdebug data.
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    22
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    23
There can only be one client of the clogger debugrouter, which means you cannot run multiple instances of the showdebug command at the same time.
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    24
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    25
==argument string process optional
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    26
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    27
If specified, showdebug will launch the given process and redirect RDebug until the process exits. If not specified it will do so indefinitely or until CTRL-C is pressed.
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    28
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    29
==argument string arguments optional last
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    30
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    31
Arguments to pass to process.
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    32
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    33
==option bool v verbose multiple
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    34
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    35
If specified, the timestamp and the originating thread of each trace are also printed. If specified twice (ie -vv) thread IDs are additionally expanded to full thread names.
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    36
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    37
==option bool f filter
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    38
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    39
Only display traces that came directly from threads belonging to the process you specified. Use with caution, you may miss traces that are I<about> your process but not directly emitted I<by> it. If the origin of a trace cannot be identified it will be shown even if C<--filter> is specified.
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    40
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    41
==see-also
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    42
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    43
L<cloggerconfig|cloggerconfig>
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    44
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    45
==copyright
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    46
dc41da2f70a4 Added showdebug command.
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    47
Copyright (c) 2010 Accenture. All rights reserved.