Skip to content

Commit ac5cde6

Browse files
authored
Merge pull request #609 from ddiss/lklfuse_rst_manpage
docs: add lklfuse manpage
2 parents b89fbb9 + af20691 commit ac5cde6

File tree

4 files changed

+48
-1
lines changed

4 files changed

+48
-1
lines changed
File renamed without changes.

Documentation/lkl/lklfuse.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
=========
4+
lklfuse
5+
=========
6+
7+
-----------------------------------------
8+
access LKL mounted block devices via FUSE
9+
-----------------------------------------
10+
11+
:Date: 2025-06-23
12+
:Manual section: 8
13+
14+
SYNOPSIS
15+
========
16+
17+
lklfuse block-device mountpoint [options]
18+
19+
DESCRIPTION
20+
===========
21+
22+
lklfuse uses the Linux Kernel Library (LKL) to mount a block-device or
23+
filesystem image, and provides access to the host system via FUSE.
24+
lklfuse can run as an unprivileged user-space process, while reusing entire
25+
Linux kernel filesystem driver implementations.
26+
27+
Udev rules and systemd service files are available for automatically mounting
28+
USB storage devices via an unprivileged lklfuse sandbox; see 61-lklfuse.rules
29+
30+
31+
OPTIONS
32+
=======
33+
34+
-o log=<file> log to <file>.
35+
36+
-o type=fstype mount with filesystem type <fstype>.
37+
38+
-o mb=memory allocate <memory> in MB for LKL (default: 64).
39+
40+
-o part=parition mount <partition>.
41+
42+
-o ro open file read-only.
43+
44+
-o opts=options Linux kernel mount <options> (use \\ to escape , and =).
45+
46+
See `lklfuse --help` for additional FUSE specific options.

MAINTAINERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12158,6 +12158,7 @@ M: Octavian Purdila <[email protected]>
1215812158
M: Hajime Tazaki <[email protected]>
1215912159
1216012160
S: Maintained
12161+
F: Documentation/lkl/
1216112162
F: arch/lkl/
1216212163
F: tools/lkl/
1216312164

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Documentation/lkl.txt
1+
Documentation/lkl/lkl.txt

0 commit comments

Comments
 (0)