Skip to content

Commit

Permalink
Writing manual
Browse files Browse the repository at this point in the history
  • Loading branch information
veeso committed Jul 6, 2021
1 parent 30c3da2 commit 58c621c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
Binary file added assets/images/themes.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions docs/man.md
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,28 @@ If left empty, the default formatter syntax will be used: `{NAME:24} {PEX} {USER

---

## Themes 🎨

Termscp provides you with an awesome feature: the possibility to set the colors for several components in the application.
If you want to customize termscp there are two available ways to do so:

- From the **configuration menu**
- Importing a **theme file**

In order to create your own customization from termscp, all you have to do so is to enter the configuration from the auth activity, pressing `<CTRL+C>` and then `<TAB>` twice. You should have now moved to the `themes` panel.

Here you can move with `<UP>` and `<DOWN>` to change the style you want to change, as shown in the gif below:

![Themes](../assets/images/themes.gif)

termscp supports both the traditional explicit hex (`#rrggbb`) and rgb `rgb(r, g, b)` syntax to provide colors, but also **css colors** (such as `crimson`) are accepted 😉. There is also a special keywork which is `Default`. Default means that the color used will be the default foreground or background color based on the situation (foreground for texts and lines, background for well, guess what).

As said before, you can also import theme files. You can take inspiration from or directly use one of the themes provided along with termscp, located in the `themes/` directory of this repository and import them running termscp as `termscp -t <theme_file>`. If everything was fine, it should tell you the theme has successfully been imported.

### Styles 💈

---

## Text Editor ✏

termscp has, as you might have noticed, many features, one of these is the possibility to view and edit text file. It doesn't matter if the file is located on the local host or on the remote host, termscp provides the possibility to open a file in your favourite text editor.
Expand Down

0 comments on commit 58c621c

Please sign in to comment.