From 9f2c8da7dda2a2ac5cb061ffb4ad880c24ea81ed Mon Sep 17 00:00:00 2001 From: Bill Zissimopoulos Date: Mon, 8 Jun 2020 11:00:14 -0700 Subject: [PATCH] update README and sshfs-win usage help --- README.md | 52 ++++++++++++++++++++++++++++++++++------------------ sshfs-win.c | 10 ++++++---- 2 files changed, 40 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 3ee1fbf..b7c425d 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,18 @@ - + +

+ +

+ GUI Frontends
 - + + + +

@@ -82,6 +89,7 @@ The complete UNC syntax is as follows: \\sshfs\[LOCUSER=]REMUSER@HOST[!PORT][\PATH] \\sshfs.r\[LOCUSER=]REMUSER@HOST[!PORT][\PATH] \\sshfs.k\[LOCUSER=]REMUSER@HOST[!PORT][\PATH] + \\sshfs.kr\[LOCUSER=]REMUSER@HOST[!PORT][\PATH] - `REMUSER` is the remote user (i.e. the user on the SSHFS host whose credentials are being used for access). - `HOST` is the SSHFS host. @@ -90,6 +98,7 @@ The complete UNC syntax is as follows: - The `sshfs` prefix maps to `HOST:~REMUSER/PATH` on the SSHFS host (i.e. relative to `REMUSER`'s home directory). - The `sshfs.r` prefix maps to `HOST:/PATH` on the SSHFS host (i.e. relative to the `HOST`'s root directory). - The `sshfs.k` prefix maps to `HOST:~REMUSER/PATH` and uses the ssh key in `%USERPROFILE%/.ssh/id_rsa` (where `%USERPROFILE%` is the home directory of the local Windows user). + - The `sshfs.kr` prefix maps to `HOST:/PATH` and uses the ssh key in `%USERPROFILE%/.ssh/id_rsa`. - `LOCUSER` is the local Windows user (optional; `USERNAME` or `DOMAIN+USERNAME` format). - Please note that this functionality is rarely necessary with latest versions of WinFsp. @@ -104,12 +113,17 @@ There are currently 2 GUI front ends for SSHFS-Win: [SiriKali](https://mhogomchu SiriKali supports: - Password authentication. -- Key Agents and KeePass 2. - Public key authentication. +- Key Agents and KeePass 2. ### SSHFS-Win-Manager -[SSHFS-Win-Manager](https://github.com/evsar3/sshfs-win-manager) is a new GUI front end specifically for SSHFS-Win. It is currently in Beta testing. Please report problems with SSHFS-Win-Manager in its [issues](https://github.com/evsar3/sshfs-win-manager/issues) page. +[SSHFS-Win-Manager](https://github.com/evsar3/sshfs-win-manager) is a new GUI front end specifically for SSHFS-Win with a user-friendly and intuitive interface. SSHFS-Win-Manager integrates well with Windows and can be closed to the system tray. Please report problems with SSHFS-Win-Manager in its [issues](https://github.com/evsar3/sshfs-win-manager/issues) page. + +SSHFS-Win-Manager supports: + +- Password authentication. +- Public key authentication. ## Advanced Usage @@ -123,9 +137,11 @@ usage: sshfs-win cmd SSHFS_COMMAND_LINE usage: sshfs-win svc PREFIX X: [LOCUSER] [SSHFS_OPTIONS] PREFIX Windows UNC prefix (note single backslash) - \sshfs[.r|.k]\[LOCUSER=]REMUSER@HOST[!PORT][\PATH] - sshfs: remote home; sshfs.r: remote root - sshfs.k: remote home with key authentication + \sshfs[.SUFFIX]\[LOCUSER=]REMUSER@HOST[!PORT][\PATH] + sshfs: remote user home dir + sshfs.r: remote root dir + sshfs.k: remote user home dir with key authentication + sshfs.kr: remote root dir with key authentication LOCUSER local user (DOMAIN+USERNAME) REMUSER remote user HOST remote host @@ -142,6 +158,16 @@ $ sh "$(cat /proc/registry32/HKEY_LOCAL_MACHINE/SOFTWARE/WinFsp/InstallDir | tr FUSE for Cygwin installed. ``` +## Project Organization + +This is a simple project: + +- `sshfs` is a submodule pointing to the original SSHFS project. +- `sshfs-win.c` is a simple wrapper around the sshfs program that is used to implement the "Map Network Drive" functionality. +- `sshfs-win.wxs` is a the Wix file that describes the SSHFS-Win installer. +- `patches` is a directory with a couple of simple patches over SSHFS. +- `Makefile` drives the overall process of building SSHFS-Win and packaging it into an MSI. + ## Building In order to build SSHFS-Win you will need Cygwin and the following Cygwin packages: @@ -170,16 +196,6 @@ To build: - Issue `make`. - The sshfs-win repository includes the upstream SSHFS project as a submodule; if you have not already done so, you must initialize it with `git submodule update --init sshfs`. -## Project Organization - -This is a simple project: - -- `sshfs` is a submodule pointing to the original SSHFS project. -- `sshfs-win.c` is a simple wrapper around the sshfs program that is used to implement the "Map Network Drive" functionality. -- `sshfs-win.wxs` is a the Wix file that describes the SSHFS-Win installer. -- `patches` is a directory with a couple of simple patches over SSHFS. -- `Makefile` drives the overall process of building SSHFS-Win and packaging it into an MSI. - ## License SSHFS-Win uses the same license as SSHFS, which is GPLv2+. It interfaces with WinFsp which is GPLv3 with a FLOSS exception. diff --git a/sshfs-win.c b/sshfs-win.c index 3432ded..9871e9c 100644 --- a/sshfs-win.c +++ b/sshfs-win.c @@ -40,9 +40,11 @@ static void usage(void) "\n" "usage: sshfs-win svc PREFIX X: [LOCUSER] [SSHFS_OPTIONS]\n" " PREFIX Windows UNC prefix (note single backslash)\n" - " \\sshfs[.r|k]\\[LOCUSER=]REMUSER@HOST[!PORT][\\PATH]\n" - " sshfs: remote home; sshfs.r: remote root\n" - " sshfs.k: remote home with key authentication\n" + " \\sshfs[.SUFFIX]\\[LOCUSER=]REMUSER@HOST[!PORT][\\PATH]\n" + " sshfs: remote user home dir\n" + " sshfs.r: remote root dir\n" + " sshfs.k: remote user home dir with key authentication\n" + " sshfs.kr: remote root dir with key authentication\n" " LOCUSER local user (DOMAIN+USERNAME)\n" " REMUSER remote user\n" " HOST remote host\n" @@ -134,7 +136,7 @@ static int do_svc(int argc, char *argv[]) if ('\\' == *p) *p = '/'; - /* skip class name (\\sshfs\, \\sshfs.r\ or \\sshfs.k\) */ + /* skip class name */ p = argv[1]; while ('/' == *p) p++;