borg/docs/usage/umount.rst.inc

.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!

.. _borg_umount:

borg umount
-----------
.. code-block:: none

    borg [common options] umount [options] MOUNTPOINT

.. only:: html

    .. class:: borg-options-table

    +-------------------------------------------------------+----------------+----------------------------------------+
    | **positional arguments**                                                                                        |
    +-------------------------------------------------------+----------------+----------------------------------------+
    |                                                       | ``MOUNTPOINT`` | mountpoint of the filesystem to umount |
    +-------------------------------------------------------+----------------+----------------------------------------+
    | .. class:: borg-common-opt-ref                                                                                  |
    |                                                                                                                 |
    | :ref:`common_options`                                                                                           |
    +-------------------------------------------------------+----------------+----------------------------------------+

    .. raw:: html

        <script type='text/javascript'>
        $(document).ready(function () {
            $('.borg-options-table colgroup').remove();
        })
        </script>

.. only:: latex

    MOUNTPOINT
        mountpoint of the filesystem to umount


    :ref:`common_options`
        |

Description
~~~~~~~~~~~

This command un-mounts a FUSE filesystem that was mounted with ``borg mount``.

This is a convenience wrapper that just calls the platform-specific shell
command - usually this is either umount or fusermount -u.
borg umount, fixes #1855 this refactors umount code we already used for the testsuite into the platform module's namespace. also, it exposes that functionality via the cli api, so users can use it via "borg umount <mountpoint>", which is more consistent than using borg to mount and fusermount -u (or umount) to un-mount. 2016-11-17 19:16:28 +00:00			`.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!`

			`.. _borg_umount:`

			`borg umount`
			`-----------`
docs: usage: avoid bash highlight, [options] instead of <options> 2017-06-06 22:44:53 +00:00			`.. code-block:: none`
borg umount, fixes #1855 this refactors umount code we already used for the testsuite into the platform module's namespace. also, it exposes that functionality via the cli api, so users can use it via "borg umount <mountpoint>", which is more consistent than using borg to mount and fusermount -u (or umount) to un-mount. 2016-11-17 19:16:28 +00:00
docs: usage: avoid bash highlight, [options] instead of <options> 2017-06-06 22:44:53 +00:00			`borg [common options] umount [options] MOUNTPOINT`
ran build_usage had merge conflicts in the usage files, decided to just recreate them afterwards. 2016-11-28 01:25:56 +00:00
ran build_usage 2017-06-20 13:22:24 +00:00			`.. only:: html`
ran build_usage 2017-06-20 09:49:26 +00:00
ran build_usage 2017-06-20 13:22:24 +00:00			`.. class:: borg-options-table`
ran build_usage had merge conflicts in the usage files, decided to just recreate them afterwards. 2016-11-28 01:25:56 +00:00
ran build_usage 2017-06-20 13:22:24 +00:00			`+-------------------------------------------------------+----------------+----------------------------------------+`
			`\| positional arguments \|`
			`+-------------------------------------------------------+----------------+----------------------------------------+`
			\| \| ``MOUNTPOINT`` \| mountpoint of the filesystem to umount \|
			`+-------------------------------------------------------+----------------+----------------------------------------+`
			`\| .. class:: borg-common-opt-ref \|`
			`\| \|`
			\| :ref:`common_options` \|
			`+-------------------------------------------------------+----------------+----------------------------------------+`
docs: less space waste following "Common options" 2017-06-20 09:53:36 +00:00
ran build_usage 2017-06-20 13:22:24 +00:00			`.. raw:: html`
docs: less space waste following "Common options" 2017-06-20 09:53:36 +00:00
ran build_usage 2017-06-20 13:22:24 +00:00			`<script type='text/javascript'>`
docs: use DOM ready event, not document loaded event 2017-06-20 13:48:30 +00:00			`$(document).ready(function () {`
ran build_usage 2017-06-20 13:22:24 +00:00			`$('.borg-options-table colgroup').remove();`
			`})`
			`</script>`

			`.. only:: latex`

			`MOUNTPOINT`
			`mountpoint of the filesystem to umount`


			:ref:`common_options`
			`\|`
ran build_usage had merge conflicts in the usage files, decided to just recreate them afterwards. 2016-11-28 01:25:56 +00:00
borg umount, fixes #1855 this refactors umount code we already used for the testsuite into the platform module's namespace. also, it exposes that functionality via the cli api, so users can use it via "borg umount <mountpoint>", which is more consistent than using borg to mount and fusermount -u (or umount) to un-mount. 2016-11-17 19:16:28 +00:00			`Description`
			`~~~~~~~~~~~`

			This command un-mounts a FUSE filesystem that was mounted with ``borg mount``.

			`This is a convenience wrapper that just calls the platform-specific shell`
ran setup.py build_usage 2017-03-26 23:45:45 +00:00			`command - usually this is either umount or fusermount -u.`