mirror of
https://github.com/veeso/termscp.git
synced 2026-06-13 03:59:37 +02:00
docs(en): write usage pages
This commit is contained in:
Christian Visintin
@@ -1 +1,31 @@
|
||||
# Bookmarks and recent hosts
|
||||
|
||||
termscp lets you save your favourite hosts as bookmarks, which can then be loaded quickly from the main layout. termscp also keeps the last 16 hosts you connected to. Both features let you reload all the parameters required to connect to a remote simply by selecting an entry in the tab under the authentication form.
|
||||
|
||||
## Where bookmarks are stored
|
||||
|
||||
Bookmarks are saved, when possible, in the configuration directory:
|
||||
|
||||
- `$HOME/.config/termscp/` on Linux/BSD
|
||||
- `$HOME/Library/Application Support/termscp` on macOS
|
||||
- `FOLDERID_RoamingAppData\termscp\` on Windows
|
||||
|
||||
## Saving passwords
|
||||
|
||||
For bookmarks only, you can optionally save the password used to authenticate. This does not apply to recent hosts, which never save passwords. The password is not saved by default; you are prompted to choose whether to save it when you create a new bookmark.
|
||||
|
||||
If you are concerned about the security of the passwords saved for your bookmarks, see [Are my passwords safe?](../configuration/password-security.md)
|
||||
|
||||
## Creating a bookmark
|
||||
|
||||
1. Fill in the authentication form with the parameters to connect to your remote server.
|
||||
2. Press `<CTRL+S>`.
|
||||
3. Type the name you want to give to the bookmark.
|
||||
4. Choose whether to remember the password.
|
||||
5. Press `<ENTER>` to submit.
|
||||
|
||||
## Loading a bookmark
|
||||
|
||||
To use a previously saved connection, press `<TAB>` to navigate to the bookmarks list, then press `<ENTER>` to load the bookmark parameters into the form.
|
||||
|
||||
|
||||
|
||||
@@ -1 +1,18 @@
|
||||
# The file explorer
|
||||
|
||||
After you establish a connection with a remote host, termscp shows the file explorer. The explorer is made up of three panels.
|
||||
|
||||
- **Local explorer panel**: displayed on the left of the screen. It shows the entries of the current directory on localhost.
|
||||
- **Remote explorer panel**: displayed on the right of the screen. It shows the entries of the current directory on the remote host.
|
||||
- **Find results panel**: shown after you search for files. Depending on where you searched (local or remote), it replaces the local explorer panel or the remote explorer panel and lists the entries matching your search query.
|
||||
|
||||
## Switching between panels
|
||||
|
||||
Use the following keys to move between panels.
|
||||
|
||||
- `<LEFT>`: move to the local explorer panel.
|
||||
- `<RIGHT>`: move to the remote explorer panel.
|
||||
- `<TAB>`: switch the active explorer tab.
|
||||
- `<ESC>`: while in the find results panel, exit it and return to the previous panel.
|
||||
|
||||
For the complete list of keys available in the explorer, see [Keyboard shortcuts](keyboard-shortcuts.md).
|
||||
|
||||
@@ -1 +1,29 @@
|
||||
# Keeping files in sync
|
||||
|
||||
The file watcher synchronizes local paths to a remote path. When a change is detected on a watched local path, it is propagated to the configured remote path within about 5 seconds.
|
||||
|
||||
You can watch as many paths as you like.
|
||||
|
||||
## Watching a path
|
||||
|
||||
1. Put the cursor on the local explorer, on the file or directory you want to keep synchronized.
|
||||
2. In the remote panel, navigate to the directory where the changes should be reported.
|
||||
3. Press `<T>`.
|
||||
4. Answer `<YES>` to the popup.
|
||||
|
||||
## Unwatching a path
|
||||
|
||||
You can stop watching a path in two ways:
|
||||
|
||||
- Press `<T>` on the watched local path (or any of its subfolders).
|
||||
- Press `<CTRL+T>`, then press `<ENTER>` on the path you want to unwatch.
|
||||
|
||||
## Propagated changes
|
||||
|
||||
The following changes are reported to the remote host:
|
||||
|
||||
- New files and file changes
|
||||
- Files moved or renamed
|
||||
- Files removed or unlinked
|
||||
|
||||
The watcher works in one direction only (local to remote). Changes made on the remote host are **not** synchronized back to the local host.
|
||||
|
||||
@@ -1 +1,49 @@
|
||||
# Keyboard shortcuts
|
||||
|
||||
The following keys are available in the file explorer. Press `<H|F1>` at any time to open the in-app help.
|
||||
|
||||
| Key | Action |
|
||||
| -------------- | ---------------------------------------------------------------------- |
|
||||
| `<ESC>` | Disconnect from the remote and return to the authentication page |
|
||||
| `<BACKSPACE>` | Go to the previous directory in the navigation stack |
|
||||
| `<TAB>` | Switch the active explorer tab |
|
||||
| `<RIGHT>` | Move to the remote explorer tab |
|
||||
| `<LEFT>` | Move to the local explorer tab |
|
||||
| `<UP>` | Move up in the selected list |
|
||||
| `<DOWN>` | Move down in the selected list |
|
||||
| `<PGUP>` | Move up in the selected list by 8 rows |
|
||||
| `<PGDOWN>` | Move down in the selected list by 8 rows |
|
||||
| `<ENTER>` | Enter the selected directory |
|
||||
| `<SPACE>` | Upload or download the selected file |
|
||||
| `<BACKTAB>` | Switch between the log tab and the explorer |
|
||||
| `<A>` | Toggle the display of hidden files |
|
||||
| `<B>` | Choose how files are sorted |
|
||||
| `<C\|F5>` | Copy the selected file or directory |
|
||||
| `<D\|F7>` | Make a new directory |
|
||||
| `<E\|F8\|DEL>` | Delete the selected file |
|
||||
| `<F>` | Search for files (wildcard matching is supported) |
|
||||
| `<G>` | Go to the supplied path |
|
||||
| `<H\|F1>` | Show the help |
|
||||
| `<I>` | Show information about the selected file or directory |
|
||||
| `<K>` | Create a symlink pointing to the currently selected entry |
|
||||
| `<L>` | Reload the current directory's content, or clear the current selection |
|
||||
| `<M>` | Select a file |
|
||||
| `<N>` | Create a new file with the provided name |
|
||||
| `<O\|F4>` | Edit the selected file in your text editor |
|
||||
| `<P>` | Open the log panel |
|
||||
| `<Q\|F10>` | Quit termscp |
|
||||
| `<R\|F6>` | Rename the selected file |
|
||||
| `<S\|F2>` | Save the selected file as a new name |
|
||||
| `<T>` | Synchronize changes on the selected path to the remote |
|
||||
| `<U>` | Go to the parent directory |
|
||||
| `<V\|F3>` | Open the selected file with the default program for its file type |
|
||||
| `<W>` | Open the selected file with a program you specify |
|
||||
| `<X>` | Execute a command |
|
||||
| `<Y>` | Toggle synchronized browsing |
|
||||
| `<Z>` | Change the file mode |
|
||||
| `</>` | Filter files (both regex and wildcard matching are supported) |
|
||||
| `<CTRL+A>` | Select all files |
|
||||
| `<ALT+A>` | Deselect all files |
|
||||
| `<CTRL+C>` | Abort the file transfer process |
|
||||
| `<CTRL+S>` | Get the total size of the selected path |
|
||||
| `<CTRL+T>` | Show all synchronized paths |
|
||||
|
||||
@@ -1 +1,32 @@
|
||||
# Working with multiple files
|
||||
|
||||
termscp lets you act on several files at once. Use these controls to build a selection.
|
||||
|
||||
- `<M>`: mark the highlighted file for selection.
|
||||
- `<CTRL+A>`: select all files in the current directory.
|
||||
- `<ALT+A>`: deselect all files.
|
||||
|
||||
Once a file is marked for selection, it is displayed with a highlighted background.
|
||||
|
||||
When a selection exists, only the selected files are processed for actions; the currently highlighted item is ignored. You can also work on multiple files while in the find results panel.
|
||||
|
||||
## Actions on a selection
|
||||
|
||||
All actions are available when working with multiple files, but some behave slightly differently. With a selection, the name you enter refers to the destination directory rather than a single destination file.
|
||||
|
||||
- **Copy**: you are prompted for a destination. With multiple files selected, this name is the destination directory where all the files are copied.
|
||||
- **Rename**: same as copy, but the files are moved to the destination directory.
|
||||
- **Save as**: same as copy, but the files are written to the destination directory.
|
||||
|
||||
## The transfer queue
|
||||
|
||||
If you select a file in a directory (for example `/home`) and then change directory, the file stays selected and is shown in the **transfer queue** in the bottom panel.
|
||||
|
||||
When a file is selected, the remote directory active at that moment is associated with its entry. If the file is later transferred, it is transferred to the remote directory associated with it.
|
||||
|
||||
### Example
|
||||
|
||||
Suppose you select the local file `/home/a.txt` while the remote panel is at `/tmp`, then you move to `/var`, select `/var/b.txt` while the remote panel is at `/home`, and finally perform a transfer. The result is:
|
||||
|
||||
- `/home/a.txt` is transferred to `/tmp/a.txt`
|
||||
- `/var/b.txt` is transferred to `/home/b.txt`
|
||||
|
||||
@@ -1 +1,24 @@
|
||||
# Opening and editing files
|
||||
|
||||
termscp can open files with an external application and edit text files in your configured editor. Both local and remote files are supported.
|
||||
|
||||
## Open and Open With
|
||||
|
||||
Press `<V>` to open a file with the system default application for its file type. termscp relies on your operating system's default opener (powered by the [open](https://docs.rs/crate/open/1.7.0) crate), so make sure at least one of the following is available on your system.
|
||||
|
||||
- **Windows**: handled automatically through the `start` command.
|
||||
- **macOS**: handled automatically through `open`, which is already installed.
|
||||
- **Linux**: one of `xdg-open`, `gio`, `gnome-open`, or `kde-open` must be installed.
|
||||
- **WSL**: `wslview` is required. Install [wslu](https://github.com/wslutilities/wslu).
|
||||
|
||||
Press `<W>` to open a file with a program you specify.
|
||||
|
||||
## Editing text files
|
||||
|
||||
Press `<O>` to open a file in your configured text editor. Only text files are supported; binary files are not.
|
||||
|
||||
If the file is located on the remote host, it is first downloaded into your temporary file directory, and then re-uploaded to the remote host **only** if you changed it. termscp detects changes by checking the file's last modification time.
|
||||
|
||||
## Editing remote files
|
||||
|
||||
You cannot edit a remote file in place directly from the remote panel. When you open a remote file, it is downloaded into a temporary directory, but termscp cannot create a watcher to detect when the external program you used to open it has closed, so it cannot tell when you are done editing. To edit a remote file, download it to a local directory first, edit it there, and then upload it again.
|
||||
|
||||
@@ -1 +1,5 @@
|
||||
# Synchronized browsing
|
||||
|
||||
Synchronized browsing keeps navigation in sync between the two explorer panels. While it is enabled, whenever you change the working directory in one panel, the same change is reproduced in the other panel.
|
||||
|
||||
To enable synchronized browsing, press `<Y>`. Press `<Y>` again to disable it. While it is enabled, the status bar reports the synchronized browsing state as `ON`.
|
||||
|
||||
Reference in New Issue
Block a user