share/man/man5/dirfs.5

   1 .\"
   2 .\" Copyright (c) 2013 Antonio Huete Jimenez <tuxillo@quantumachine.net>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote products
  14 .\"    derived from this software without specific prior written permission
  15 .\"
  16 .\" THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\"
  28 .Dd September 5, 2013
  29 .Dt DIRFS 5
  30 .Os
  31 .Sh NAME
  32 .Nm dirfs
  33 .Nd "pseudo-filesystem for vkernel"
  34 .Sh SYNOPSIS
  35 To compile this driver into the vkernel,
  36 place the following line in your
  37 vkernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "options DIRFS"
  40 .Ed
  41 .Pp
  42 Actually this driver does not provide a loadable module.
  43 .Pp
  44 In
  45 .Xr fstab 5 :
  46 .Bd -literal -compact
  47 /usr/src     /mnt dirfs rw 0 0
  48 .Sh DESCRIPTION
  49 .Nm
  50 was born from the idea of providing an easy way for
  51 .Xr vkernel 7
  52 to access host's directories without any sort of configuration as it would be
  53 needed by NFS for example.
  54 .Pp
  55 It runs directly in the vkernel's
  56 .Xr VFS 9
  57 code, as any other regular filesystem but it uses syscalls to retrieve the
  58 information needed for every operation requested.
  59 .Pp
  60 It should be noted that when the vkernel is run by a regular user, the
  61 operations
  62 .Nm
  63 can perform on the mounted host directory are bound to the permissions of
  64 the aforementioned user.
  65 .Pp
  66 Multiple
  67 .Nm
  68 mounts are allowed.
  69 .Sh EXAMPLES
  70 To mount a
  71 .Nm
  72 memory file system:
  73 .Pp
  74 .Dl "mount -t dirfs /usr/src /mnt"
  75 .Sh SEE ALSO
  76 .Xr fstab 5 ,
  77 .Xr mount_dirfs 8 ,
  78 .Sh HISTORY
  79 The
  80 .Nm
  81 driver first appeared in
  82 .Dx 3.5 .
  83 .Sh AUTHORS
  84 .An -nosplit
  85 The
  86 .Nm
  87 vkernel implementation was written from the scratch by
  88 .An Antonio Huete Jimenez Aq Mt tuxillo@quantumachine.net
  89 .Pp
  90 Numerous fixes and pointers by
  91 .An Matthew Dillon Aq Mt dillon@apollo.backplane.com
  92 .Pp
  93 This manual page was written by
  94 .An Antonio Huete Jimenez Aq Mt tuxillo@quantumachine.net
  95 .Sh BUGS
  96 Currently there is no locking on file descriptors between the host
  97 and the vkernel.
  98 This means that there might be problems with concurrent accesses to the same
  99 file.
 100 .Pp
 101 There is no support for hardlinks in
 102 .Nm
 103 yet.