From 8aa2adf99fd4fcc4b47c534d2fed5ec7ed6ea334 Mon Sep 17 00:00:00 2001
From: Amlal <amlal.elmahrouss@icloud.com>
Date: Mon, 27 Jan 2025 21:49:14 +0100
Subject: ADD: LibDebugger C++ library and improved `dbg` tool. ADD: New manual
 files `dbg` and `ld64`

Signed-off-by: Amlal <amlal.elmahrouss@icloud.com>
---
 man/dbg.7  | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 man/ld64.7 | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 130 insertions(+)
 create mode 100644 man/dbg.7
 create mode 100644 man/ld64.7

(limited to 'man')

diff --git a/man/dbg.7 b/man/dbg.7
new file mode 100644
index 0000000..a198885
--- /dev/null
+++ b/man/dbg.7
@@ -0,0 +1,67 @@
+.TH DBG 1 "NeKernel Internal Kit" "January 2025" "NeKernel Manual"
+.SH NAME
+.B dbg
+\- NeKernel internal debugger
+
+.SH SYNOPSIS
+.B dbg
+[␌IOPTIONS␌R] [␌ICOMMAND␌R]
+
+.SH DESCRIPTION
+.B dbg
+is the internal debugging tool for NeKernel. It provides a low-level
+interface for inspecting and manipulating running processes,
+memory, and kernel state.
+
+.SH OPTIONS
+.TP
+.B -p
+Attach to a process by its PID.
+.TP
+.B -s
+Start a new debugging session.
+.TP
+.B -m
+Enable memory inspection mode.
+.TP
+.B -r
+Display register values.
+.TP
+.B -b
+Set a breakpoint at a function or address.
+.TP
+.B -c
+Continue execution after a breakpoint.
+.TP
+.B -h
+Display help information.
+
+.SH USAGE EXAMPLES
+.TP
+.B Start a new debugging session:
+.B dbg -s
+.TP
+.B Attach to a running process (PID 1234):
+.B dbg -p 1234
+.TP
+.B Inspect memory at address 0x1000:
+.B dbg -m 0x1000
+.TP
+.B Set a breakpoint at function "main":
+.B dbg -b main
+.TP
+.B Display register values:
+.B dbg -r
+
+.SH EXIT STATUS
+.TP
+0  Successful execution.
+.TP
+1  Error occurred during debugging.
+
+.SH SEE ALSO
+.BR nekernel (7), gdb (1)
+
+.SH AUTHOR
+NeKernel Development Team
+
diff --git a/man/ld64.7 b/man/ld64.7
new file mode 100644
index 0000000..388a887
--- /dev/null
+++ b/man/ld64.7
@@ -0,0 +1,63 @@
+.TH LD64 1 "NeKernel Internal Kit" "January 2025" "NeKernel Manual"
+.SH NAME
+.B ld64
+\- PEF binary format linker for NeKernel
+
+.SH SYNOPSIS
+.B ld64
+[␌IOPTIONS␌R] [␌IINPUT_FILES␌R] -o ␌IOUTPUT_FILE␌R
+
+.SH DESCRIPTION
+.B ld64
+is the dedicated linker for the Preferred Executable Format (PEF) used by NeKernel.
+It links object files into a PEF executable suitable for execution within the NeKernel environment.
+
+.SH OPTIONS
+.TP
+.B -o <file>
+Specify the output file.
+.TP
+.B -L <path>
+Add a library search path.
+.TP
+.B -l <lib>
+Link against the specified library.
+.TP
+.B -T <script>
+Specify a linker script.
+.TP
+.B -e <symbol>
+Set the entry point symbol.
+.TP
+.B -M
+Display the memory layout of the linked binary.
+.TP
+.B -v
+Enable verbose output.
+.TP
+.B -h
+Show help information.
+
+.SH USAGE EXAMPLES
+.TP
+.B Link object files into a PEF binary:
+.B ld64 main.o utils.o -o app.exe
+.TP
+.B Link with a custom entry point:
+.B ld64 -e _start main.o -o app.exe
+.TP
+.B Generate a memory layout report:
+.B ld64 -M main.o -o app.exe
+
+.SH EXIT STATUS
+.TP
+0  Successful linking.
+.TP
+1  Error encountered during linking.
+
+.SH SEE ALSO
+.BR nekernel (7), asm (1)
+
+.SH AUTHOR
+NeKernel Development Team
+
-- 
cgit v1.2.3