ceph/doc/man/8/ceph-fuse.rst

   1 :orphan:
   2
   3 =========================================
   4  ceph-fuse -- FUSE-based client for ceph
   5 =========================================
   6
   7 .. program:: ceph-fuse
   8
   9 Synopsis
  10 ========
  11
  12 | **ceph-fuse** [-n *client.username*] [ -m *monaddr*:*port* ] *mountpoint* [ *fuse options* ]
  13
  14
  15 Description
  16 ===========
  17
  18 **ceph-fuse** is a FUSE ("Filesystem in USErspace") client for Ceph
  19 distributed file system. It will mount a ceph file system specified via the -m
  20 option or described by ceph.conf (see below) at the specific mount point. See
  21 `Mount CephFS using FUSE`_ for detailed information.
  22
  23 The file system can be unmounted with::
  24
  25         fusermount -u mountpoint
  26
  27 or by sending ``SIGINT`` to the ``ceph-fuse`` process.
  28
  29
  30 Options
  31 =======
  32
  33 Any options not recognized by ceph-fuse will be passed on to libfuse.
  34
  35 .. option:: -o opt,[opt...]
  36
  37    Mount options.
  38
  39 .. option:: -d
  40
  41    Run in foreground, send all log output to stderr and enable FUSE debugging (-o debug).
  42
  43 .. option:: -c ceph.conf, --conf=ceph.conf
  44
  45    Use *ceph.conf* configuration file instead of the default
  46    ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.
  47
  48 .. option:: -m monaddress[:port]
  49
  50    Connect to specified monitor (instead of looking through ceph.conf).
  51
  52 .. option:: -n client.{cephx-username}
  53
  54    Pass the name of CephX user whose secret key is be to used for mounting.
  55
  56 .. option:: -k <path-to-keyring>
  57
  58    Provide path to keyring; useful when it's absent in standard locations.
  59
  60 .. option:: --client_mountpoint/-r root_directory
  61
  62    Use root_directory as the mounted root, rather than the full Ceph tree.
  63
  64 .. option:: -f
  65
  66    Foreground: do not daemonize after startup (run in foreground). Do not generate a pid file.
  67
  68 .. option:: -s
  69
  70    Disable multi-threaded operation.
  71
  72 Availability
  73 ============
  74
  75 **ceph-fuse** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
  76 the Ceph documentation at http://ceph.com/docs for more information.
  77
  78
  79 See also
  80 ========
  81
  82 fusermount(8),
  83 :doc:`ceph <ceph>`\(8)
  84
  85 .. _Mount CephFS using FUSE: ../../../cephfs/fuse/