aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-exit.3
blob: 50c022b88c7e9f99437b88e11c0e2b68bf9abdee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH exit 3 2025-11-23 "Tomo man-pages"
.SH NAME
exit \- exit the program
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI exit\ :\ func(message:\ Text?\ =\ none,\ status:\ Int32\ =\ Int32(1)\ ->\ Abort)
.fi
.SH DESCRIPTION
Exits the program with a given status and optionally prints a message.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
message	Text?	If nonempty, this message will be printed (with a newline) before exiting. 	none
status	Int32	The status code that the program with exit with. 	Int32(1)
.TE
.SH RETURN
This function never returns.

.SH EXAMPLES
.EX
exit(status=1, "Goodbye forever!")
.EE