summaryrefslogtreecommitdiff
path: root/Base/usr/share/man
diff options
context:
space:
mode:
authorLinus Groh <mail@linusgroh.de>2021-01-26 09:46:52 +0100
committerAndreas Kling <kling@serenityos.org>2021-01-26 11:40:08 +0100
commit22df4727b1cf4a26d69cf915ca9f9005540149d3 (patch)
tree2d2ad09e75d439b670a914bfcabafbd3f1463f95 /Base/usr/share/man
parentf3f2d776246d61fe916ba11487221c603965ba2d (diff)
downloadserenity-22df4727b1cf4a26d69cf915ca9f9005540149d3.zip
Base: Update crash(1) man page
Update the outdated list of options, mention UserspaceEmulator, update example shell output.
Diffstat (limited to 'Base/usr/share/man')
-rw-r--r--Base/usr/share/man/man1/crash.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/Base/usr/share/man/man1/crash.md b/Base/usr/share/man/man1/crash.md
index f0d8b451ea..9f49428e26 100644
--- a/Base/usr/share/man/man1/crash.md
+++ b/Base/usr/share/man/man1/crash.md
@@ -10,36 +10,36 @@ $ crash [options]
## Description
-This program is used to test how the Serenity kernel handles
-userspace crashes, and can be used to simulate many different
-kinds of crashes.
+This program is used to test how the Serenity kernel or UserspaceEmulator
+handle userspace crashes, and can be used to simulate many different kinds
+of crashes.
## Options
-* `-A`: Test that all of the following crashes crash as intended.
+* `-A`: Test that all of the following crash types crash as expected.
* `-s`: Perform a segmentation violation by dereferencing an invalid pointer.
* `-d`: Perform a division by zero.
* `-i`: Execute an illegal CPU instruction.
* `-a`: Call `abort()`.
-* `-m`: Read a pointer from uninitialized memory, then read from it.
+* `-m`: Read a pointer from uninitialized malloc memory, then read from it.
* `-f`: Read a pointer from memory freed using `free()`, then read from it.
-* `-M`: Read a pointer from uninitialized memory, then write to it.
+* `-M`: Read a pointer from uninitialized malloc memory, then write to it.
* `-F`: Read a pointer from memory freed using `free()`, then write to it.
* `-r`: Write to read-only memory.
* `-T`: Make a syscall while using an invalid stack pointer.
* `-t`: Trigger a page fault while using an invalid stack pointer.
* `-S`: Make a syscall from writeable memory.
-* `-x`: Read from recently freed memory. (Tests an opportunistic malloc guard.)
-* `-y`: Write to recently freed memory. (Tests an opportunistic malloc guard.)
-* `-X`: Attempt to execute non-executable memory. (Not mapped with PROT\_EXEC.)
+* `-X`: Attempt to execute non-executable memory (Not mapped with PROT\_EXEC).
* `-U`: Attempt to trigger an x86 User Mode Instruction Prevention fault.
* `-I`: Use an x86 I/O instruction in userspace.
* `-c`: Read the x86 TSC (Time Stamp Counter) directly.
+* `-p`: Violate `pledge()`'d promises.
+* `-n`: Perform a failing assertion.
## Examples
```sh
$ crash -F
Testing: "Write to freed memory"
-Shell: crash(33) exitied due to signal "Segmentation violation"
+Shell: Job 1 (crash -F) Segmentation violation
```