'\" t
.\" Copyright (c) 2026 Bruce Hill
.\" All rights reserved.
.\"
.TH breakpoint 3 2026-08-28 "Tomo man-pages"
.SH NAME
breakpoint \- stop in the debugger
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI breakpoint\ :\ func(->\ Void)
.fi
.SH DESCRIPTION
Stops the program in a debugger at the point where it is called. Running the program under `tomo run --debug` gives a debugger prompt here, showing the surrounding source and the values of the variables in scope.


.SH RETURN
Nothing.

.SH NOTES
Only a program compiled with `--debug` contains this call at all. Without that flag it compiles to nothing, so a `breakpoint()` left in the source costs a release build nothing and does nothing if the program is run outside a debugger. See `docs/debugging.md`.

.SH EXAMPLES
.EX
total := 0
for i in 10
    total += i
breakpoint() # `tomo run --debug` stops here, with `total` and `i` in scope
.EE