tomo-fail.3

(33 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH fail 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 fail \- abort the program
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI fail\ :\ func(message:\ Text\ ->\ Abort)
  13 .fi
  14 .SH DESCRIPTION
  15 Prints a message to the console, aborts the program, and prints a stack trace.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 message	Text	The error message to print. 
  26 .TE
  27 .SH RETURN
  28 Nothing, aborts the program.
  29 
  30 .SH EXAMPLES
  31 .EX
  32 fail("Oh no!")
  33 .EE