Documentation index
Mikronix documentation lives in two places: the kernel documentation
tree under docs/ (architecture, device descriptions, style guides)
and the man page collection under share/man/ (man1, man8, man9).
Everything is source-grounded -- every claim points to a file, a
man page, or a boot log line.
Kernel documentation (docs/)
| File |
Description |
| architecture.md |
System architecture: kernel/userspace split, boot chain, VFS, device model |
| devices.md |
Device & syscall reference: /dev nodes, kernel API, driver data formats |
| vfs.md |
Virtual filesystem design: mount points, VFS layer, file operations |
| mikrofs-format.md |
MikroFS format specification: on-disk layout, inode structure, log format |
| pitfalls.md |
Known pitfalls and edge cases: hardware-specific issues, driver gotchas |
| posix-compliance.md |
POSIX.1-2017 compliance status and deviations |
| rc.md |
Init system: /etc/rc, rc.d services, configuration |
| c99-guidelines.md |
C99 coding guidelines for the kernel and userland |
Man pages (share/man/)
Userland (man1)
| Name |
Description |
| cat.1 |
Concatenate files |
| chime.1 |
Audio tone generator |
| date.1 |
Display/set date and time |
| echo.1 |
Print arguments |
| false.1 |
Return failure status |
| grep.1 |
Pattern search |
| intro.1 |
Introduction to userland programs |
| ls.1 |
List directory contents |
| msh.1 |
Interactive shell and script runner |
| od.1 |
Octal dump |
| ps.1 |
Process status |
| rm.1 |
Remove files |
| sysctl.1 |
System control |
| threadtest.1 |
Thread creation test |
| true.1 |
Return success status |
| uname.1 |
System information |
| wc.1 |
Word, line, and byte count |
Administration (man8)