1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\"
12.\" Copyright 2020 Oxide Computer Company
13.\"
14.Dd October 31, 2020
15.Dt UPANIC.H 3HEAD
16.Os
17.Sh NAME
18.Nm upanic.h
19.Nd user panic header
20.Sh SYNOPSIS
21.In upanic.h
22.Sh DESCRIPTION
23The
24.In upanic.h
25header provides illumos-specific routines that provide a means for a
26process to terminate itself with an optional message left in a core
27file.
28.Pp
29The
30.In upanic.h
31header defines the following functions:
32.Bl -tag -width upanic
33.It Xr upanic 2
34Panic a user process with an optional message, terminating it and
35generating core files.
36.El
37.Sh INTERFACE STABILITY
38.Sy Committed
39.Sh SEE ALSO
40.Xr upanic 2 ,
41.Xr core 5
42