From bc50328006196496fd3ebfbbc0eeb522fa119727 Mon Sep 17 00:00:00 2001 From: veeso Date: Fri, 11 Jun 2021 13:01:28 +0200 Subject: [PATCH] open-rs docs --- README.md | 15 +++++++++++++++ docs/man.md | 16 ++++++++++++++++ 2 files changed, 31 insertions(+) diff --git a/README.md b/README.md index d51afeb..a0dda99 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,20 @@ while if you're a Windows user, you can install termscp with [Chocolatey](https: For more information or other platforms, please visit [veeso.github.io](https://veeso.github.io/termscp/#get-started) to view all installation methods. +### Soft Requirements ✔️ + +These requirements are not forcely required to run termscp, but to enjoy all of its features + +- **Linux** users + - To **open** files via `V` (at least one of these) + - *xdg-open* + - *gio* + - *gnome-open* + - *kde-open* +- **WSL** users + - To **open** files via `V` (at least one of these) + - [wslu](https://github.com/wslutilities/wslu) + --- ## Buy me a coffee ☕ @@ -134,6 +148,7 @@ termscp is powered by these aweseome projects: - [crossterm](https://github.com/crossterm-rs/crossterm) - [edit](https://github.com/milkey-mouse/edit) - [keyring-rs](https://github.com/hwchen/keyring-rs) +- [open-rs](https://github.com/Byron/open-rs) - [rpassword](https://github.com/conradkleinespel/rpassword) - [rust-ftp](https://github.com/mattnenterprise/rust-ftp) - [ssh2-rs](https://github.com/alexcrichton/ssh2-rs) diff --git a/docs/man.md b/docs/man.md index aa49c00..b1a9bf1 100644 --- a/docs/man.md +++ b/docs/man.md @@ -105,6 +105,8 @@ In order to change panel you need to type `` to move the remote explorer p | `` | Rename file | Rename | | `` | Save file as... | Save | | `` | Go to parent directory | Upper | +| `` | Open file with default program for filetype | View | +| `` | Open file with provided program | With | | `` | Execute a command | eXecute | | `` | Toggle synchronized browsing | sYnc | | `` | Delete file | | @@ -130,6 +132,20 @@ This means that whenever you'll change the working directory on one panel, the s *Warning*: at the moment, whenever you try to access an unexisting directory, you won't be prompted to create it. This might change in a future update. +### Open and Open With 🚪 + +Open and open with commands are powered by [open-rs](https://docs.rs/crate/open/1.7.0). +When opening files with View command (``), the system default application for the file type will be used. To do so, the default operting system service will be used, so be sure to have at least one of these installed on your system: + +- **Windows** users: you don't have to worry about it, since the crate will use the `start` command. +- **MacOS** users: you don't have to worry either, since the crate will use `open`, which is already installed on your system. +- **Linux** users: one of these should be installed + - *xdg-open* + - *gio* + - *gnome-open* + - *kde-open* +- **WSL** users: *wslview* is required, you must install [wslu](https://github.com/wslutilities/wslu). + --- ## Bookmarks ⭐