summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIan Moffett <ian@osmora.org>2024-12-16 01:43:36 -0500
committerIan Moffett <ian@osmora.org>2024-12-16 01:43:36 -0500
commit3d75719f8b4d4ededfa111337fc97387eaa59a66 (patch)
tree2a318e42aeeb336ac57045c48049f13e29c618a5
parentb4ea35986c4ccb3f96c23bffe9a5a539b9dec148 (diff)
docs: man: Add panic(9)
Signed-off-by: Ian Moffett <ian@osmora.org>
-rw-r--r--share/man/man9/panic.950
1 files changed, 50 insertions, 0 deletions
diff --git a/share/man/man9/panic.9 b/share/man/man9/panic.9
new file mode 100644
index 0000000..bc60547
--- /dev/null
+++ b/share/man/man9/panic.9
@@ -0,0 +1,50 @@
+.\" Copyright (c) 2023-2024 Ian Marco Moffett and the Osmora Team.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright notice,
+.\" this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\" 3. Neither the name of Hyra nor the names of its
+.\" contributors may be used to endorse or promote products derived from
+.\" this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.Dd Dec 16 2024
+.Dt PANIC 9
+.Os Hyra
+.Sh NAME
+.Nm panic - bring the system upon a fatal error
+.Sh SYNOPSIS
+.In sys/panic.h
+
+.Ft void
+.Fn panic "const char *fmt" "..."
+
+.Sh DESCRIPTION
+The
+.Fn panic
+function terminates system operation with a message
+to the console. This is used during fatal errors in order
+to safely bring down the system with some diagnositic information.
+
+The
+.Fa fmt
+argument is a printf style format string.
+
+.Sh AUTHORS
+.An Ian Moffett Aq Mt ian@osmora.org