man/man8/hgfs.8

   1 .TH HGFS 8
   2 .SH NAME
   3 hgfs \- VMware Host/Guest File System server
   4 .SH SYNOPSIS
   5 \fBmount \-t hgfs \fR[\fB\-r\fR] [\fB\-o \fIoptions\fR] \fBnone \fImountpoint
   6 .SH DESCRIPTION
   7 The Host/Guest File System (HGFS) server allows one to mount
   8 VMware Shared Folders as a file system. This makes it possible to access
   9 selected portions of the VMware host file system when MINIX is run as a
  10 VMware guest.
  11 .PP
  12 The above mount command will mount the hgfs 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 VMware host. The \fIoptions\fR field is a string consisting of
  16 comma-delimited \fIkey\fR or \fIkey\fB=\fIvalue\fR options. The following
  17 options are supported.
  18 .TP 4
  19 \fBprefix=\fIpath\fR
  20 This option sets a path prefix that will be prepended to all file system
  21 operations on the host system. When mounted without a prefix (the default),
  22 the root directory of an HGFS mount will contain all the names of the
  23 available shares. The prefix option can be used to mount one of those shares,
  24 by specifying its name as the prefix. Multi-component path prefixes are
  25 supported as well.
  26 .TP
  27 \fBuid=\fInumber\fR
  28 This sets the user ID used for all the files and directories in the file
  29 system, allowing a non-root user to be the owner. The value must be specified
  30 as a decimal number.
  31 The default is root (the number \fB0\fR).
  32 .TP
  33 \fBgid=\fInumber\fR
  34 Likewise, sets the group ID for all files and directories.
  35 The default is operator (the number \fB0\fR).
  36 .TP
  37 \fBfmask=\fInumber\fR
  38 This option sets the file permission mask of regular files. It is specified as
  39 an octal number. For example, a value of \fB600\fR makes all files readable and
  40 writable by the owning user (see the "\fBuid\fR" option).
  41 The default is \fB755\fR.
  42 .TP
  43 \fBdmask=\fInumber\fR
  44 Likewise, sets the file permission mask of directories.
  45 The default is also \fB755\fR.
  46 .TP
  47 \fBicase\fR
  48 This option tells HGFS to treat names as case-insensitive.
  49 .TP
  50 \fBnoicase\fR
  51 This option, set by default, reverts the effect of an earlier specified
  52 "\fBicase\fR" option.
  53 .SH EXAMPLES
  54 .TP 20
  55 .B mount \-t hgfs none /mnt
  56 # Mount the entire shared folders tree on \fI/mnt\fR
  57 .TP 20
  58 .B mount \-t hgfs \-o prefix=shared,uid=20,fmask=644,icase none /usr/shared
  59 # Mount the "\fIshared\fR" shared folder on \fI/usr/shared\fR
  60 .SH LIMITATIONS
  61 HGFS uses the first and original version of the VMware Shared Folders protocol
  62 to talk to the VMware host. That means that HGFS should work with all VMware
  63 products that support shared folders. However, this also imposes a number of
  64 limitations. For example, the first version of the protocol supports only
  65 regular files and directories (and not links), and does not have support for
  66 automatic case sensitivity handling.
  67 .PP
  68 Some file system operations may not behave as expected, because the behavior
  69 of HGFS is determined largely by the host. Other file system operations
  70 (in particular, using directories as mountpoints) are not implemented,
  71 because the file system structure as perceived by HGFS may change arbitrarily
  72 at any time, due to modifications on the host side.
  73 .SH "SEE ALSO"
  74 .BR mount (1),
  75 .BR vbfs (8)
  76 .SH AUTHOR
  77 David van Moolenbroek <dcvmoole@cs.vu.nl>