about summary refs log tree commit diff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README38
1 files changed, 38 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..0584a56
--- /dev/null
+++ b/README
@@ -0,0 +1,38 @@
+fjorker(8)                                                           fjorker(8)
+
+NAME
+     fjorker - minimalistic ICMP echo request/reply implementation
+
+SYNOPSIS
+     fjorker host
+     fjorker --version
+
+DESCRIPTION
+     fjorker is a secure-by-default ICMP echo request/reply implementation
+     that follows OpenBSD's philosophy of minimalism and security.
+
+     Unlike traditional ping implementations, fjorker:
+     * Minimizes information disclosure about the source host
+     * Uses random identifiers instead of process IDs
+     * Validates sequence numbers in responses
+     * Has minimal code base for better security
+
+EXAMPLES
+     fjorker 1.1.1.1
+             Ping 1.1.1.1 using ICMP echo requests
+
+     fjorker --version
+             Display version information
+
+EXIT STATUS
+     The fjorker utility exits 0 on success, and >0 if an error occurs.
+
+SEE ALSO
+     ping(8)
+
+STANDARDS
+     The fjorker utility implements ICMP echo request/reply as described in
+     RFC 792.
+
+HISTORY
+     The fjorker utility first appeared in 2025.
\ No newline at end of file