diff options
| -rw-r--r-- | README.rst (renamed from README.md) | 42 |
1 files changed, 19 insertions, 23 deletions
@@ -13,7 +13,7 @@ very simple to use - there's nothing to do on the server-side. 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 @@ -26,13 +26,13 @@ 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 OS-X, to unmount the filesystem: +On BSD and OS-X, to unmount the filesystem:: umount mountpoint @@ -42,17 +42,13 @@ Installation First, download the latest SSHFS release from https://github.com/libfuse/sshfs/releases. On Linux and BSD, you will -also need to have [libfuse](http://github.com/libfuse/libfuse) -installed. On OS-X, you need [OSXFUSE](https://osxfuse.github.io/) -instead. Finally, you need the -[glib](https://developer.gnome.org/glib/stable/) development package -(which should be available from your operating system's package -manager). - -To build and install, we recommend to use -[Meson](http://mesonbuild.com/) (version 0.38 or newer) and -[Ninja](https://ninja-build.org). After extracting the sshfs tarball, -create a (temporary) build directory and run Meson and Ninja: +also need to have libfuse_ installed. On OS-X, you need OSXFUSE_ +instead. Finally, you need the Glib_ development package (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 and Ninja:: $ md build; cd build $ meson .. @@ -61,19 +57,24 @@ create a (temporary) build directory and run Meson and Ninja: 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 $ ninja # rebuild +.. _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/ Alternate Installation ---------------------- If you are not able to use Meson and Ninja, please report this to the sshfs mailing list. Until the problem is resolved, you may fall back -to an in-source build using autotools: +to an in-source build using autotools:: $ ./configure $ make @@ -84,11 +85,6 @@ point, so if you depend on using autotools for some reason please let the sshfs developers know! - ./configure - make - sudo make install - - Caveats ------- @@ -102,7 +98,7 @@ someone (or something) recreates the destination file after SSHFS has removed it, but before SSHFS had the time to rename the old file. In this case, the rename will still fail. - + Getting Help ------------ |