summaryrefslogtreecommitdiffhomepage
path: root/public
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-05-16 13:51:45 +0200
committerAmlal El Mahrouss <amlal@nekernel.org>2025-05-16 13:51:45 +0200
commit8e63423ef656d1a403c959589ed19621281ebb0b (patch)
tree59881d21a1a76ff8b5f846af5c830008e81ecad4 /public
parentc589f92ed0f6e462a976c64d533c1d8a21b2a3ba (diff)
feat(manuals): add HTML page for PoC.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
Diffstat (limited to 'public')
-rw-r--r--public/manuals/nekernel/mgmt.util.man52
-rw-r--r--public/manuals/nekernel/mgmt.util.man.html85
2 files changed, 117 insertions, 20 deletions
diff --git a/public/manuals/nekernel/mgmt.util.man b/public/manuals/nekernel/mgmt.util.man
index 929da2d6..1c46002b 100644
--- a/public/manuals/nekernel/mgmt.util.man
+++ b/public/manuals/nekernel/mgmt.util.man
@@ -1,20 +1,32 @@
-Title: mgmt - Management utility command.
-Command: mgmt <OPTIONS>
-
-Body:
-
-The management command serves as the main scheduling and management utility of System One.
-
-Usages include but not limited to:
-
-- Run certain scripts at X time.
-- Verify a device/filesystem integrity.
-- Manage and automate other NeKernel machines.
-
-Example:
-
-mgmt -s -t 2:30PM -d Wed -m Apr -y 2026 -s pgp-update.script
-
-Release:
-
-System One NeKernel
+NAME
+ mgmt — Management utility command
+
+SYNOPSIS
+ mgmt [OPTIONS]
+
+DESCRIPTION
+ The `mgmt` command provides scheduling, execution, and remote orchestration
+ capabilities within the System One operating environment. It serves as the
+ main task and maintenance utility for NeKernel deployments.
+
+ Usages include, but are not limited to:
+ - Schedule scripts or tasks for future execution.
+ - Verify device or filesystem integrity.
+ - Manage and automate remote NeKernel machines.
+
+OPTIONS
+ -s, --script <FILE> Script to execute
+ -t, --time <HH:MMAM/PM> Time to run the script
+ -d, --day <DAY> Day of the week (e.g., Mon, Tue, Wed)
+ -m, --month <MONTH> Month (e.g., Jan, Feb, Mar)
+ -y, --year <YYYY> Year to schedule task
+ -r, --remote <ADDRESS> Remote machine to manage (optional)
+ -v, --verify Run integrity checks only
+ -h, --help Display this help message
+
+EXAMPLES
+ mgmt -s pgp-update.script -t 2:30PM -d Wed -m Apr -y 2026
+ Schedules `pgp-update.script` to run at 2:30PM on Wednesday, April 2026.
+
+RELEASE
+ System One — NeKernel \ No newline at end of file
diff --git a/public/manuals/nekernel/mgmt.util.man.html b/public/manuals/nekernel/mgmt.util.man.html
new file mode 100644
index 00000000..6f1ddc13
--- /dev/null
+++ b/public/manuals/nekernel/mgmt.util.man.html
@@ -0,0 +1,85 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="UTF-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <title>mgmt Manual Page</title>
+ <style>
+ body {
+ font-family: monospace;
+ background-color: #f4f4f4;
+ padding: 2em;
+ color: #222;
+ }
+
+ h1,
+ h2 {
+ border-bottom: 1px solid #aaa;
+ }
+
+ code {
+ background: #eee;
+ padding: 0.2em 0.4em;
+ border-radius: 4px;
+ }
+
+ section {
+ margin-bottom: 2em;
+ }
+ </style>
+</head>
+
+<body>
+ <h1>mgmt</h1>
+ <section>
+ <h2>NAME</h2>
+ <p><strong>mgmt</strong> &mdash; Management utility command</p>
+ </section>
+
+ <section>
+ <h2>SYNOPSIS</h2>
+ <p><code>mgmt [OPTIONS]</code></p>
+ </section>
+
+ <section>
+ <h2>DESCRIPTION</h2>
+ <p>
+ The <code>mgmt</code> command provides scheduling, execution, and remote orchestration
+ capabilities within the System One operating environment. It serves as the main task
+ and maintenance utility for NeKernel deployments.
+ </p>
+ <ul>
+ <li>Schedule scripts or tasks for future execution.</li>
+ <li>Verify device or filesystem integrity.</li>
+ <li>Manage and automate remote NeKernel machines.</li>
+ </ul>
+ </section>
+
+ <section>
+ <h2>OPTIONS</h2>
+ <ul>
+ <li><code>-s, --script &lt;FILE&gt;</code>: Script to execute</li>
+ <li><code>-t, --time &lt;HH:MMAM/PM&gt;</code>: Time to run the script</li>
+ <li><code>-d, --day &lt;DAY&gt;</code>: Day of the week (e.g., Mon, Tue, Wed)</li>
+ <li><code>-m, --month &lt;MONTH&gt;</code>: Month (e.g., Jan, Feb, Mar)</li>
+ <li><code>-y, --year &lt;YYYY&gt;</code>: Year to schedule task</li>
+ <li><code>-r, --remote &lt;ADDRESS&gt;</code>: Remote machine to manage (optional)</li>
+ <li><code>-v, --verify</code>: Run integrity checks only</li>
+ <li><code>-h, --help</code>: Display this help message</li>
+ </ul>
+ </section>
+
+ <section>
+ <h2>EXAMPLES</h2>
+ <pre><code>mgmt -s pgp-update.script -t 2:30PM -d Wed -m Apr -y 2026</code></pre>
+ <p>Schedules <code>pgp-update.script</code> to run at 2:30PM on Wednesday, April 2026.</p>
+ </section>
+
+ <section>
+ <h2>RELEASE</h2>
+ <p>System One &mdash; NeKernel</p>
+ </section>
+</body>
+
+</html> \ No newline at end of file