Usage
=====
+Mounting filesystems
+--------------------
+
In order to mount a ceph filesystem, the following command can be used::
ceph-dokan.exe -c c:\ceph.conf -l x
client_mount_uid = 1000
client_mount_gid = 1000
-Please use ``ceph-dokan --help`` for a full list of arguments.
+If you have more than one FS on your Ceph cluster, use the option
+``--client_fs`` to mount the non-default FS::
-The mount can be removed by either issuing ctrl-c or using the unmap command,
-like so::
+ mkdir -Force C:\mnt\mycephfs2
+ ceph-dokan.exe --mountpoint C:\mnt\mycephfs2 --client_fs mycephfs2
- ceph-dokan.exe unmap -l x
+CephFS subdirectories can be mounted using the ``--root-path`` parameter::
-Note that when unmapping Ceph filesystems, the exact same mountpoint argument
-must be used as when the mapping was created.
+ ceph-dokan -l y --root-path /a
+
+If the ``-o --removable`` flags are set, the mounts will show up in the
+``Get-Volume`` results::
+
+ PS C:\> Get-Volume -FriendlyName "Ceph*" | `
+ Select-Object -Property @("DriveLetter", "Filesystem", "FilesystemLabel")
+
+ DriveLetter Filesystem FilesystemLabel
+ ----------- ---------- ---------------
+ Z Ceph Ceph
+ W Ceph Ceph - new_fs
+
+Please use ``ceph-dokan --help`` for a full list of arguments.
Credentials
-----------
ceph-dokan --id foo -l x
ceph-dokan --name client.foo -l x
+Unmounting filesystems
+----------------------
+
+The mount can be removed by either issuing ctrl-c or using the unmap command,
+like so::
+
+ ceph-dokan.exe unmap -l x
+
+Note that when unmapping Ceph filesystems, the exact same mountpoint argument
+must be used as when the mapping was created.
+
Limitations
-----------