fuse_xattrs.1.in

   1 .TH FUSE_XATTRS "1" "February 2017" "FUSE_XATTRS version @FUSE_XATTRS_VERSION_MAJOR@.@FUSE_XATTRS_VERSION_MINOR@" "User Commands"
   2 .SH NAME
   3 fuse_xattrs \- Filesystem that adds xattrs support using sidecar files.
   4 .SH SYNOPSIS
   5 .SS \fRmounting
   6 .TP
   7 \fBfuse_xattrs\fP \fBsource_dir\fP \fBmountpoint\fP [ options ]
   8 .SS \fRunmounting
   9 .TP
  10 \fBfusermount -u mountpoint\fP
  11 .SH DESCRIPTION
  12 \fBfuse_xattrs\fR is a way to add extended attribute support (xattrs)
  13 to any filesystem. The attributes are stored in "sidecar files" which
  14 by default are held as siblings to the attributed pathnames with the
  15 addition of the \fB.xattr\fR extension.
  16 .PP
  17 .PD
  18 .SH OPTIONS
  19 .TP
  20 \fB-o\ show_sidecar\fR
  21 .br
  22 Don't hide sidecar files. By default the sidecar files are kept as
  23 siblings to the attributed pathnames plus extension ".xattr", but
  24 hidden from access through the mountpoint. With this option the
  25 sidecar files will show up as files.
  26 .TP
  27 \fB-o\ enable_namespaces\fR
  28 .br
  29 Enable namespaces checks. Restricts attribute setting to the "user"
  30 namespace.
  31 .TP
  32 \fB-o\ sroot=path\fR
  33 .br
  34 Use other sidecar root path. By default the sidecar files are kept as
  35 siblings to the attributed pathnames plus extension ".xattr". By this
  36 option, the sidecar files are instead held as a nominated directory
  37 tree which typically is different from the source directory.
  38 .TP
  39 \fB-o \fIfuse option\fR
  40 .br
  41 See \fBman fuse\fR for details about additional \fBfuse\fR options.
  42 .PP
  43 .SH "EXAMPLES"
  44 .SS
  45 \fBfuse_xattrs /mnt/nfs/data /mnt/xdata\fP
  46
  47 Adds xattrs support for an existing mount, \fB/mnt/nfs/data\fR, at
  48 \fB/mnt/xdata\fP.
  49
  50 .SS
  51 \fBfuse_xattrs /mnt/nfs/data /mnt/xdata -o sroot=/mnt/xattrs\fP
  52
  53 Adds xattrs support for an existing mount, \fB/mnt/nfs/data\fR, at
  54 \fB/mnt/xdata\fP with the sidecar files held under \fB/mnt/xattrs\fR.
  55
  56 .SS
  57 \fBfuse_xattrs /mnt/nfs/data /mnt/xdata \\
  58     \fB-o sroot=/mnt/xattrs -o allow_other\fP
  59 .br
  60 The fuse option \fBallow_other\fR must be enabled in the fuse
  61 configuration, and when so, the \fBfuse_xattr\fR mountpoint will be
  62 available to all users (depending on file permissions).
  63
  64 .SH "AUTHORS"
  65
  66
  67 2021-11-11 - Forked and extended by Ralph Ronnquist
  68 <ralph.ronnquist@gmail.com>.
  69 .br
  70 FUSE_XATTRS version 0.4 written by Felipe Barriga Richards <felipe
  71 {at} felipebarriga.cl>.