commands/showdebug/showdebug.cif
changeset 73 dc41da2f70a4
equal deleted inserted replaced
69:849a0b46c767 73:dc41da2f70a4
       
     1 # showdebug.cif
       
     2 # 
       
     3 # Copyright (c) 2010 Accenture. All rights reserved.
       
     4 # This component and the accompanying materials are made available
       
     5 # under the terms of the "Eclipse Public License v1.0"
       
     6 # which accompanies this distribution, and is available
       
     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 # 
       
     9 # Initial Contributors:
       
    10 # Accenture - Initial contribution
       
    11 #
       
    12 
       
    13 ==name showdebug
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Redirects RDebug::Print to the console.
       
    18 
       
    19 ==long-description
       
    20 
       
    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.
       
    22 
       
    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.
       
    24 
       
    25 ==argument string process optional
       
    26 
       
    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.
       
    28 
       
    29 ==argument string arguments optional last
       
    30 
       
    31 Arguments to pass to process.
       
    32 
       
    33 ==option bool v verbose multiple
       
    34 
       
    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.
       
    36 
       
    37 ==option bool f filter
       
    38 
       
    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.
       
    40 
       
    41 ==see-also
       
    42 
       
    43 L<cloggerconfig|cloggerconfig>
       
    44 
       
    45 ==copyright
       
    46 
       
    47 Copyright (c) 2010 Accenture. All rights reserved.