Skip to content

Update readme and fix python tests #238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Convert README.md from Restructured Text to Github Flavored Markdown …
…(GFM)
  • Loading branch information
ElectricRCAircraftGuy committed Dec 23, 2020
commit 006b1faf5450d0491d53fc31b768fd2a78088170
54 changes: 25 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
SSHFS
=====
# SSHFS


About
-----
## About

SSHFS allows you to mount a remote filesystem using SFTP. Most SSH
servers support and enable this SFTP access by default, so SSHFS is
very simple to use - there's nothing to do on the server-side.


Development Status
------------------
## Development Status

SSHFS is shipped by all major Linux distributions and has been in
production use across a wide range of systems for many years. However,
Expand All @@ -24,10 +21,9 @@ understand that unless you are including a pull request or are
reporting a critical issue, you will probably not get a response.


How to use
----------
## How to use

Once sshfs is installed (see next section) running it is very simple::
Once sshfs is installed (see next section) running it is very simple:

sshfs [user@]hostname:[directory] mountpoint

Expand All @@ -40,61 +36,61 @@ which ask for the password if needed).

Also many ssh options can be specified (see the manual pages for
*sftp(1)* and *ssh_config(5)*), including the remote port number
(``-oport=PORT``)
(`-oport=PORT`)

To unmount the filesystem::
To unmount the filesystem:

fusermount -u mountpoint

On BSD and macOS, to unmount the filesystem::
On BSD and macOS, to unmount the filesystem:

umount mountpoint


Installation
------------
## Installation

First, download the latest SSHFS release from
https://github.com/libfuse/sshfs/releases. On Linux and BSD, you will
also need to install libfuse_ 3.1.0 or newer. On macOS, you need
OSXFUSE_ instead. Finally, you need the Glib_ library with development
also need to install [libfuse][libfuse] 3.1.0 or newer. On macOS, you need
[OSXFUSE][OSXFUSE] instead. Finally, you need the [Glib][Glib] library with development
headers (which should be available from your operating system's
package manager).

To build and install, we recommend to use Meson_ (version 0.38 or
newer) and Ninja_. After extracting the sshfs tarball, create a
(temporary) build directory and run Meson::
To build and install, we recommend to use [Meson][Meson] (version 0.38 or
newer) and [Ninja][Ninja]. After extracting the sshfs tarball, create a
(temporary) build directory and run Meson:

$ mkdir build; cd build
$ meson ..

Normally, the default build options will work fine. If you
nevertheless want to adjust them, you can do so with the *mesonconf*
command::
command:

$ mesonconf # list options
$ mesonconf -D strip=true # set an option

To build, test and install SSHFS, you then use Ninja (running the
tests requires the `py.test`_ Python module)::
tests requires the [`py.test`][py.test] Python module):

$ ninja
$ python3 -m pytest test/ # optional, but recommended
$ sudo ninja install

.. _libfuse: http://github.com/libfuse/libfuse
.. _OSXFUSE: https://osxfuse.github.io/
.. _Glib: https://developer.gnome.org/glib/stable/
.. _Meson: http://mesonbuild.com/
.. _Ninja: https://ninja-build.org/
.. _`py.test`: http://www.pytest.org/

Getting Help
------------
## Getting Help

If you need help, please ask on the <[email protected]>
mailing list (subscribe at
https://lists.sourceforge.net/lists/listinfo/fuse-sshfs).

Please report any bugs on the GitHub issue tracker at
https://github.com/libfuse/libfuse/issues.


[libfuse]: http://github.com/libfuse/libfuse
[OSXFUSE]: https://osxfuse.github.io/
[Glib]: https://developer.gnome.org/glib/stable/
[Meson]: http://mesonbuild.com/
[Ninja]: https://ninja-build.org/
[py.test]: http://www.pytest.org/