summaryrefslogtreecommitdiff
path: root/package/aufs2-util/src/README
diff options
context:
space:
mode:
Diffstat (limited to 'package/aufs2-util/src/README')
-rw-r--r--package/aufs2-util/src/README46
1 files changed, 46 insertions, 0 deletions
diff --git a/package/aufs2-util/src/README b/package/aufs2-util/src/README
new file mode 100644
index 000000000..1e1f45422
--- /dev/null
+++ b/package/aufs2-util/src/README
@@ -0,0 +1,46 @@
+
+Utilities for aufs2
+http://aufs.sf.net
+J. R. Okajima
+
+These utilities are always necessary for aufs2.
+If you forget to install them, your aufs may not work correctly.
+And these are not for aufs1 essentially, except aubrsync. See below in
+detail.
+
+Makefile in this tree has some customizable make-variables.
+- KDIR
+ specify your kernel source path if necessary
+- DESTDIR
+ specify your install path if necessary.
+ some commands have to be installed under /sbin.
+
+o /sbin/mount.aufs, /sbin/umount.aufs
+ Helpers for util-linux-ng package. You should NOT invoke them
+ manually. Just install them by "make install".
+
+o /sbin/auplink
+ Handles aufs pseudo-link at remount/unmount time. You can invoke it
+ manually at anytime.
+
+o /usr/bin/auchk
+ Similar to generic fsck. Checks whether a branch is healthy or not
+ from aufs's point of view.
+
+o /usr/bin/aubrsync
+ Move files from the upper writable branch to the lower branch.
+ If you use this script with aufs1, then you need to install aufs.shlib
+ to /usr/lib/aufs.shlib. Currently only the 20080211 version is tested
+ for aufs1.
+ The development of this script is sponcered by ASUSTek Computer Inc.
+ (http://www.asus.com/).
+ Kindly they agreed that I keep my aufs work as free software as it has
+ been.
+
+o /etc/default/aufs
+ A library for shell scripts.
+
+
+# Local variables: ;
+# mode: text;
+# End: ;