Skip to content

Commit 670a3a0

Browse files
committed
man: rephrase description and other parts
Signed-off-by: Nejc Bertoncelj <bertronika@mailo.com>
1 parent d8ad8fb commit 670a3a0

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

fuse-overlayfs.1.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
fuse-overlayfs 1 "User Commands"
2-
==================================================
2+
================================
33

44
# NAME
55

6-
fuse-overlayfs - overlayfs FUSE implementation
6+
fuse-overlayfs - combine directory trees in userspace
77

88
# SYNOPSIS
99

@@ -15,9 +15,7 @@ unmounting
1515

1616
# DESCRIPTION
1717

18-
fuse-overlayfs provides an overlayfs FUSE implementation so that it
19-
can be used since Linux 4.18 by unprivileged users in an user
20-
namespace.
18+
**fuse-overlayfs** combines (overlays) two or more directory trees into one. It can be used by unprivileged users in an user namespace. It is built with FUSE and works with Linux 4.18 or newer.
2119

2220
# OPTIONS
2321

@@ -67,31 +65,31 @@ The fuse-overlayfs dynamic mapping is an alternative and cheaper way to chown'in
6765

6866
It is useful to share the same storage among different user namespaces and counter effect the mapping done by the user namespace itself, and without requiring to chown the files.
6967

70-
For example, given on the host two files like:
68+
Take, for example, two files with the following user and group IDs:
7169

7270
```
7371
$ stat -c %u:%g lower/a lower/b
7472
0:0
7573
1:1
7674
```
7775

78-
When we run in a user namespace with the following configuration:
76+
Also take note of the following user namespace configuration:
7977

8078
```
8179
$ cat /proc/self/uid_map
8280
0 1000 1
8381
1 110000 65536
8482
```
8583

86-
We would see:
84+
After mounting with fuse-overlayfs, the ownership would change:
8785

8886
```
8987
$ stat -c %u:%g merged/a merged/b
9088
65534:65534
9189
65534:65534
9290
```
9391

94-
65534 is the overflow ID used when the UID/GID is not known inside the user namespace. This happens because both users 0:0 and 1:1 are not mapped.
92+
65534 is the overflow ID used when the UID/GID is not known inside the user namespace. This happens because neither user IDs 0 nor 1 are mapped.
9593

9694
To map them, we'd mount the fuse-overlayfs file system using the following namespace configuration:
9795

0 commit comments

Comments
 (0)