minix/fs/vbfs/vbfs.8

   1 .TH VBFS 8
   2 .SH NAME
   3 vbfs \- VirtualBox Shared Folder File System server
   4 .SH SYNOPSIS
   5 \fBmount \-t vbfs \fR[\fB\-r\fR] \fB\-o
   6 \fBshare=\fIsharename\fR[\fB,\fIoptions\fR] \fBnone \fImountpoint
   7 .SH DESCRIPTION
   8 The \fBvbfs\fR server allows one to mount a VirtualBox shared folder as a file
   9 system. This makes it possible to access selected portions of the VirtualBox
  10 host file system when MINIX is run as a VirtualBox guest.
  11 .PP
  12 The above mount command will mount the vbfs file system onto the directory
  13 \fImountpoint\fR. The \fB\-r\fR mount option makes the file system read-only;
  14 note that shared folders may independently have been configured as read-only
  15 on the VirtualBox host. The \fIoptions\fR field is a string consisting of
  16 comma-delimited \fIkey\fR or \fIkey\fB=\fIvalue\fR options.
  17 The vbfs server can mount only one shared folder at a time, and therefore,
  18 specifying a \fBshare\fR name is required.
  19 The other options are optional. The following options are supported.
  20 .TP 4
  21 \fBshare=\fIname\fR
  22 This required option specifies the share name to mount. It is currently not
  23 possible to list the available share names from within MINIX3.
  24 .TP
  25 \fBprefix=\fIpath\fR
  26 This option sets a path prefix that will be prepended to all file system
  27 operations on the host system. The default is the empty path, exposing the
  28 entire share. Leading and trailing slashes are ignored.
  29 .TP
  30 \fBuid=\fInumber\fR
  31 This sets the user ID used for all the files and directories in the file
  32 system, allowing a non-root user to be the owner. The value must be specified
  33 as a decimal number.
  34 The default is root (the number \fB0\fR).
  35 .TP
  36 \fBgid=\fInumber\fR
  37 Likewise, sets the group ID for all files and directories.
  38 The default is wheel (the number \fB0\fR).
  39 .TP
  40 \fBfmask=\fInumber\fR
  41 This option sets the file permission mask of regular files. It is specified as
  42 an octal number. For example, a value of \fB600\fR makes all files readable and
  43 writable by the owning user (see the "\fBuid\fR" option).
  44 The default is \fB755\fR.
  45 .TP
  46 \fBdmask=\fInumber\fR
  47 Likewise, sets the file permission mask of directories.
  48 The default is also \fB755\fR.
  49 .SH EXAMPLES
  50 .TP 20
  51 .B mount \-t vbfs -o share=myshare none /usr/myshare
  52 # Mount the "\fImyshare\fR" shared folder on \fI/usr/myshare\fR
  53 .TP 20
  54 .B mount \-t vbfs \-o share=shared,prefix=foo/bar,uid=20,fmask=644 none /mnt
  55 # Mount the "\fIfoo/bar\fR" subtree from the "\fIshared\fR" shared folder on
  56 \fI/mnt\fR
  57 .SH LIMITATIONS
  58 VBFS has been designed to provide a convenient means to exchange files between
  59 the guest and the host system, not as a complete file system implementation.
  60 As such, it comes with many limitations. Some of these are VBFS implementation
  61 shortcomings; some are the result of behavioral differences between the host
  62 file system and the guest's expectations; some are the result of a mismatch
  63 between MINIX's VFS/FS protocol and the requirements from VBFS; and finally,
  64 some are the result of the user's ability to change the file system on the
  65 host system at any time.
  66 .SH "SEE ALSO"
  67 .BR mount (1),
  68 .BR hgfs (8)
  69 .SH AUTHOR
  70 David van Moolenbroek <david@minix3.org>