From 3d558f47b04e80ffacc8bc7a91dadf5bcf0dd131 Mon Sep 17 00:00:00 2001
From: Andreas Kling <awesomekling@gmail.com>
Date: Sun, 17 Nov 2019 19:48:11 +0100
Subject: Docs: Add uname(1) and uname(2) man pages

---
 Base/usr/share/man/man1/uname.md | 31 +++++++++++++++++++++++++++++++
 Base/usr/share/man/man2/uname.md | 38 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 69 insertions(+)
 create mode 100644 Base/usr/share/man/man1/uname.md
 create mode 100644 Base/usr/share/man/man2/uname.md

(limited to 'Base/usr')

diff --git a/Base/usr/share/man/man1/uname.md b/Base/usr/share/man/man1/uname.md
new file mode 100644
index 0000000000..85bd7103e8
--- /dev/null
+++ b/Base/usr/share/man/man1/uname.md
@@ -0,0 +1,31 @@
+## Name
+
+uname - print kernel information
+
+## Synopsis
+
+`uname [-s] [-n] [-r] [-m] [-a]`
+
+## Description
+
+Print information about the operating system, as reported by the `uname()`
+system call.
+
+## Options
+
+* `-s`: Print the system name
+* `-n`: Print the node name (hostname)
+* `-r`: Print the system release version
+* `-m`: Print the machine type
+* `-a`: Print all of the above
+
+## Examples
+
+```sh
+$ uname -sm
+Serenity i686
+```
+
+## See also
+
+* [`uname`(2)](../man2/uname.md)
diff --git a/Base/usr/share/man/man2/uname.md b/Base/usr/share/man/man2/uname.md
new file mode 100644
index 0000000000..78bdc37199
--- /dev/null
+++ b/Base/usr/share/man/man2/uname.md
@@ -0,0 +1,38 @@
+## Name
+
+uname - retrieve information about the current kernel
+
+## Synopsis
+
+```**c++
+#include <sys/utsname.h>
+
+int uname(struct utsname* buf);
+```
+
+## Description
+
+Retrieves information about the current kernel and writes it into the `utsname`
+structure pointed to by `buf`.
+
+```**c++
+struct utsname {
+    char sysname[];
+    char nodename[];
+    char release[];
+    char version[];
+    char machine[];
+};
+```
+
+## Return value
+
+If successful, returns 0. Otherwise, returns -1 and sets `errno` to describe the error.
+
+## Errors
+
+* `EFAULT`: `buf` is not a writable address.
+
+## See also
+
+* [`uname`(1)](../man1/uname.md)
-- 
cgit v1.2.3