Skip to content

Commit 8a05a78

Browse files
committed
Update README
1 parent 053f98a commit 8a05a78

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,17 @@ Interactive XDebug step debugger for your terminal with vim-like key bindings.
77

88
- **Travel forwards**: step over, into and out.
99
- **Travel backwards**: it's not quite time travel, but you can revisit
10-
previous steps.
10+
previous steps in _history mode_.
1111
- **Vim-like motions**: Typing `100n` will repeat "step into" 100 times.
1212

13-
CLI options:
13+
## CLI options
1414

1515
- `--log`: Debug log to file.
1616
- `--listen`: Listen on an alternative address (defaults to `0.0.0.0:9003`).
1717

18-
Key bindings (prefix with number to repeat):
18+
## Key bindings
19+
20+
Prefix with number to repeat:
1921

2022
- `n` next / step into
2123
- `N` step over
@@ -26,3 +28,16 @@ Key bindings (prefix with number to repeat):
2628
- `tab` switch pane
2729
- `enter` toggle pane focus (full screen)
2830
- `?` Show help
31+
32+
## Setting Breakpoints
33+
34+
`xdebug-tui` has no mechanism for setting a breakpoint but you can use the
35+
function `xdebug_break()` in your code:
36+
37+
```php
38+
<?php
39+
40+
function my_function() {
41+
xdebug_break(); // break after this line
42+
}
43+
```

0 commit comments

Comments
 (0)