docs/README-passive-debugging.md

branch
eric7-maintenance
changeset 10148
31ba20629af4
parent 10107
da76865312f1
equal deleted inserted replaced
10102:6ae4d88c722b 10148:31ba20629af4
1 # README for passive mode debugging
2
3 eric7 provides the capability to debug programs using the passive
4 mode. In this mode it is possible to start the debugger separate from
5 the IDE. This may be done on a different computer as well. If the
6 debugger is started on a remote machine, it is your responsibility
7 to ensure, that the paths to the script to be debugged are identical
8 on both machines or you configured the path translation accordingly.
9
10 In order to enable passive mode debugging in the IDE choose the
11 debugger tab of the preferences dialog and enable the passive mode
12 debugging checkbox. You may change the default port as well. Please
13 be aware that you have to tell the debugger the port, if it is different
14 to the default value of 42424.
15
16 On the remote computer you have to have the debugger scripts installed.
17 Use DebugClient.py to debug normal and multi threaded scripts. The debugger
18 knows about the following command line switches.
19
20 -h <hostname>
21 : This specifies the hostname of the machine running the IDE.
22
23 -p <portnumber>
24 : This specifies the portnumber of the IDE.
25
26 -w <directory>
27 : This specifies the working directory to be used for the script
28 to be debugged.
29
30 -t
31 : This enables tracing into the Python library.
32
33 -n
34 : This disables the redirection of stdin, stdout and stderr.
35
36 -e
37 : This disables reporting of exceptions.
38
39 --fork-child
40 : This tells the debugger to follow the child when forking.
41
42 --fork-parent
43 : This tells the debugger to follow the parent when forking
44
45 The command line parameters have to be followed by `--` (double dash),
46 the script to be debugged and its command line parameters.
47
48 Example:
49
50 python DebugClient -h somehost -- myscript.py param1
51
52 After the execution of the debugger command, it connects to the IDE and
53 tells it the filename of the script being debugged. The IDE will try to
54 load it and the script will stop at the first line. After that you may set
55 breakpoints, step through your script and use all the debugging functions.
56
57 __Note__: The port and hostname may alternatively be set through the environment
58 variables ERICPORT and ERICHOST.
59
60 Please send bug reports, feature requests or contributions to eric bugs address
61 [eric-bugs@die-offenbachs.de](mailto:eric-bugs@die-offenbachs.de) or using the
62 built-in bug reporting dialog.

eric ide

mercurial