@@ -118,27 +118,48 @@ and from there we can see the IP address of `33.33.33.1`.
118118
119119## using pugdebug
120120
121- In a terminal go to the directory where you have pugdebug cloned and start it by
122- issuing a ` python app.py ` command .
121+ If you are using a pugdebug build, just execute the binary, that should bring up
122+ pugdebug .
123123
124- On the left side you can see a simple file browser that should list your home
125- directory .
124+ If you cloned this repository, go to the sources directory, activate the Python
125+ virtual environment and start pugdebug by issuing a ` python app.py ` command .
126126
127- Under it is an input field with the label ` Root: ` , containing the path to your
128- home directory.
127+ ## pugdebug settings
129128
130- By entering a new root path in the ` root ` input field will change the root
131- directory of the file browser.
129+ To bring up the ` Settings ` window, navigate to ` Files -> Settings ` (shortcut: ` Ctrl+S ` ).
132130
133- For example, on my laptop it starts with ` /home/robert ` and the file browser
134- lists my home directory. If I enter ` /home/robert/www/pugdebug ` into the ` root `
135- input field, the file browser will change to the pugdebug web project.
131+ ### pugdebug path settings
136132
137- But this is just temporary, it will be nicer in the future.
133+ The ` Path ` section refers to the path settings.
134+
135+ The ` Root ` under the ` Path ` section is the root path where the project you want to debug is
136+ located.
137+
138+ The ` Maps from ` under the ` Path ` section is for when the project you want to debug is under
139+ a virtual machine, like Vagrant. Here you would enter the path of the project under that VM.
140+
141+ For example, if a project I'm working on is in ` /home/robert/wwww/pugdebug ` and that maps to
142+ ` /var/www ` under the VM, the ` Root ` would be set to ` /home/robert/www/pugdebug ` and the
143+ ` Maps from ` would be set to ` /var/www ` .
144+
145+ ### pugdebug debugger settings
146+
147+ The ` Host ` setting should be the IP address of the machine on which pugdebug runs. In most cases
148+ it is perfectly fine to leave this field blank.
149+
150+ The ` Port ` setting is the port number on which xdebug will attempt to connect to the machin on
151+ which pugdebug runs. The default port is ` 9000 ` .
152+
153+ The ` IDE Key ` setting allows to filter out messages from xdebug based on this value.
154+
155+ ` Break at first line ` tells the debugger should it break on the first line or not.
156+
157+ ` Max depth ` , ` Max children ` and ` Max data ` settings control the amount of information
158+ about variables is retrieved from xdebug.
138159
139160## debugging sessions
140161
141- To start a debugging session, click the "Start" button in the top left corner.
162+ To start a debugging session, click the "Start" button in the top left corner (Shortcut: F2) .
142163
143164Load your web project in your browser and start a
144165[ HTTP debugging session] ( http://xdebug.org/docs/remote#browser_session ) .
@@ -162,7 +183,7 @@ Double clicking the line with a breakpoint should remove that breakpoint.
162183It is also possible to debug CLI scripts with pugdebug.
163184
164185Start pugdebug as stated in the previous section, click ` Start ` to
165- start a debugging session and then in a second terminal type:
186+ start a debugging session and then in a new terminal type:
166187
167188```
168189export XDEBUG_CONFIG="idekey=pugdebug"
0 commit comments