summaryrefslogtreecommitdiffstats
path: root/docs/tools
diff options
context:
space:
mode:
Diffstat (limited to 'docs/tools')
-rw-r--r--docs/tools/rmtool.md5
-rw-r--r--docs/tools/rmtop.md5
2 files changed, 10 insertions, 0 deletions
diff --git a/docs/tools/rmtool.md b/docs/tools/rmtool.md
index a7ec2c6..93140f1 100644
--- a/docs/tools/rmtool.md
+++ b/docs/tools/rmtool.md
@@ -1,5 +1,10 @@
# rmtool - RM API Swiss Army Knife
+> **Status: planned / not implemented.** There is no `tools/rmtool/` directory
+> or build target today. The implemented RM-API tooling is the `rmq` subset
+> (`tools/rmq/`, the host RM-API oracle); treat this page as a design sketch,
+> not a user guide. See [tools/README.md](README.md).
+
## Overview
`rmtool` is a comprehensive userspace utility for interacting with the NVIDIA Resource Manager (RM) API. It provides direct access to RM internal state, engine control, memory management, and performance telemetry. Built on top of driver components studied through reverse engineering and
decompilation (referenced by component).
diff --git a/docs/tools/rmtop.md b/docs/tools/rmtop.md
index 6408268..6f9c047 100644
--- a/docs/tools/rmtop.md
+++ b/docs/tools/rmtop.md
@@ -1,5 +1,10 @@
# rmtop - GPU htop Equivalent
+> **Status: planned / not implemented.** There is no `tools/rmtop/` directory
+> or build target today. The implemented RM-API tooling is the `rmq` subset
+> (`tools/rmq/`, the host RM-API oracle); treat this page as a design sketch,
+> not a user guide. See [tools/README.md](README.md).
+
## Overview
`rmtop` is an interactive, ncurses-based real-time GPU monitoring dashboard. Like `htop` but for NVIDIA GPUs, providing live visualization of engine utilization, memory, channels, power, thermals, and GSP-RM telemetry.