diff --git a/Documentation/lkl.txt b/Documentation/lkl/lkl.txt similarity index 100% rename from Documentation/lkl.txt rename to Documentation/lkl/lkl.txt diff --git a/Documentation/lkl/lklfuse.rst b/Documentation/lkl/lklfuse.rst new file mode 100644 index 000000000000..f3ac736473de --- /dev/null +++ b/Documentation/lkl/lklfuse.rst @@ -0,0 +1,46 @@ +.. SPDX-License-Identifier: GPL-2.0 + +========= + lklfuse +========= + +----------------------------------------- +access LKL mounted block devices via FUSE +----------------------------------------- + +:Date: 2025-06-23 +:Manual section: 8 + +SYNOPSIS +======== + +lklfuse block-device mountpoint [options] + +DESCRIPTION +=========== + +lklfuse uses the Linux Kernel Library (LKL) to mount a block-device or +filesystem image, and provides access to the host system via FUSE. +lklfuse can run as an unprivileged user-space process, while reusing entire +Linux kernel filesystem driver implementations. + +Udev rules and systemd service files are available for automatically mounting +USB storage devices via an unprivileged lklfuse sandbox; see 61-lklfuse.rules +and lklfuse-mount@.service. + +OPTIONS +======= + +-o log= log to . + +-o type=fstype mount with filesystem type . + +-o mb=memory allocate in MB for LKL (default: 64). + +-o part=parition mount . + +-o ro open file read-only. + +-o opts=options Linux kernel mount (use \\ to escape , and =). + +See `lklfuse --help` for additional FUSE specific options. diff --git a/MAINTAINERS b/MAINTAINERS index c3d1e044d481..2f0623f0675e 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -12158,6 +12158,7 @@ M: Octavian Purdila M: Hajime Tazaki L: linux-kernel-library@freelists.org S: Maintained +F: Documentation/lkl/ F: arch/lkl/ F: tools/lkl/ diff --git a/README.md b/README.md index 35c47a921f67..e4af93db81e9 120000 --- a/README.md +++ b/README.md @@ -1 +1 @@ -Documentation/lkl.txt \ No newline at end of file +Documentation/lkl/lkl.txt \ No newline at end of file