From 3bc73aa0881d581eadd75ce30e36ad086c7a21a3 Mon Sep 17 00:00:00 2001
From: nia <29542929+AlarixBSD@users.noreply.github.com>
Date: Thu, 15 Jul 2021 04:41:42 +0000
Subject: netbsd: update README.md (#694)

netbsd: update README.md
---
 netbsd/README.md | 40 ++++++++++++++++++++++------------------
 1 file changed, 22 insertions(+), 18 deletions(-)

(limited to 'netbsd')

diff --git a/netbsd/README.md b/netbsd/README.md
index 9285def5..1d13e76e 100644
--- a/netbsd/README.md
+++ b/netbsd/README.md
@@ -1,29 +1,33 @@
 NetBSD support in htop(1)
 ===
 
-This implementation makes NetBSD use htop(1) without the need of mount_procfs(8).
+This implementation utilizes kvm_getprocs(3), sysctl(3), etc, eliminating the
+need for mount_procfs(8) with Linux compatibility enabled.
 
-The implementation has been copied over and modified from the OpenBSD
-implementation in htop(1).
+The implementation was initially based on the OpenBSD support in htop(1).
 
-Current implementation mimics the procfs based implementation in stats
-collection.
+Notes on NetBSD curses
+---
 
-Make NetBSD no longer masquerade as Linux.
+NetBSD is one of the last operating systems to use and maintain its own
+implementation of Curses.
 
-What works
----
+htop(1) can be compiled against either ncurses or NetBSD's curses(3).
+In order for NetBSD's libcurses to be used, htop(1) must be configured with
+`--disable-unicode`. This is necessary because htop(1) with Unicode enabled
+directly accesses ncurses's cchar_t struct, which has different contents
+in NetBSD's curses.
 
-* Builds in NetBSD without any additional patch
-* Uses sysctl(3) and kvm(3) to get basic information
-* Shows basic meters CPU / Memory / Swap
-* Shows basic process listing
+Versions of libcurses in NetBSD 9 and prior have no mouse support
+(this is an ncurses extension). Newer versions contain no-op mouse functions
+for compatibility with ncurses.
 
-What needs to be tested
+What needs improvement
 ---
 
-* Memory being split into used/buffers/cache
-* Basic features of htop(1) like kill / nice / sort / search works as expected
-* If the meter displays are working as expected
-* If the process states are displayed correctly
-* If thread information and count are displayed correctly
+* Kernel and userspace threads are not displayed or counted -
+  maybe look at NetBSD top(1).
+* Battery display - use envsys(4).
+* Support for compiling using libcurses's Unicode support.
+* Support for fstat(1) (view open files, like lsof(8) on Linux).
+* Support for ktrace(1) (like strace(1) on Linux).
-- 
cgit v1.2.3