core/builtins/debug.cif
changeset 0 7f656887cf89
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # debug.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 debug
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Run the specified fshell script under a simple debugger.
       
    18 
       
    19 ==long-description
       
    20 
       
    21 Before executing each line of the script, commands can be entered. Currently the following commands are supported:
       
    22 
       
    23 =over 5
       
    24 
       
    25 =item C<s>
       
    26 
       
    27 Run the next line of the script.
       
    28 
       
    29 =item C<x>
       
    30 
       
    31 Show the next line of the script with its variables expanded.
       
    32 
       
    33 =back
       
    34 
       
    35 Unlike the L<source|source> command, environment variables set by the script being debugged are not inherited by the parent fshell instance.
       
    36 
       
    37 Note, this command is specifically for debugging L<fshell|fshell> scripts. If you were looking for a general-purpose debugger, see L<fdb|fdb>.
       
    38 
       
    39 ==see-also
       
    40 
       
    41 L<fdb|fdb>, L<source|source>
       
    42 
       
    43 ==argument filename script_file_name
       
    44 
       
    45 The name of the script file to be debugged.
       
    46 
       
    47 ==argument string script_args optional last
       
    48 
       
    49 Arguments to be send to the script.
       
    50 
       
    51 ==option bool k keep-going
       
    52 
       
    53 Keep processing the script even if a previous command has returned an error. Without this option set, an error would cause script processing to abort (and the debug command to exit with the error code) unless either C<&&>, C<||> or C<&|> was used to handle the error.
       
    54 
       
    55 ==copyright
       
    56 
       
    57 Copyright (c) 2006-2010 Accenture. All rights reserved.
       
    58