tomo-exit.3

(34 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH exit 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 exit \- exit the program
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI exit\ :\ func(message:\ Text?\ =\ none,\ status:\ Int32\ =\ Int32(1)\ ->\ Abort)
  13 .fi
  14 .SH DESCRIPTION
  15 Exits the program with a given status and optionally prints a message.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx lb
  23 l l l l.
  24 Name	Type	Description	Default
  25 message	Text?	If nonempty, this message will be printed (with a newline) before exiting. 	none
  26 status	Int32	The status code that the program with exit with. 	Int32(1)
  27 .TE
  28 .SH RETURN
  29 This function never returns.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 exit("Goodbye forever!", Int32(1))
  34 .EE