Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Themes

termscp lets you set the colors for several components in the application. There are two ways to customize termscp:

  • From the configuration menu
  • Importing a theme file

Customize from the configuration menu

To customize termscp from the configuration menu, enter the configuration from the auth screen by pressing <CTRL+C>, then press <TAB> twice to reach the themes panel. Move with <UP> and <DOWN> to select the style you want to change, as shown in the gif below:

Themes

Import a theme file

You can also import theme files. You can take inspiration from, or directly use, one of the themes bundled with termscp in the themes/ directory of the repository. Import a theme by running:

termscp theme <theme_file>

If everything is fine, termscp confirms the theme has been imported.

Color syntax

termscp accepts the following color formats:

  • Explicit hexadecimal: #rrggbb
  • RGB: rgb(r, g, b)
  • CSS color names (such as crimson)
  • The special keyword Default, which uses the situational default foreground or background color (foreground for texts and lines, background otherwise)

Recovering from a theme that won’t load

After an update, a saved theme can fail to load. This happens when a new key is added to themes: the previously saved theme no longer contains that key. There are two quick fixes:

  1. Re-import the official theme. After each release the official themes are patched, so download the updated theme from the repository and re-import it:

    termscp theme <theme.toml>
    
  2. Edit your theme by hand. If you use a custom theme, edit the file and add the missing key. The theme is located at $CONFIG_DIR/theme.toml, where $CONFIG_DIR is:

    • FreeBSD/Linux: $HOME/.config/termscp
    • macOS: $HOME/.config/termscp
    • Windows: %USERPROFILE%\.termscp

    Missing keys are reported in the CHANGELOG under BREAKING CHANGES for the version you have just installed.

Styles

The tables below describe each style field. Note that styles do not apply to the configuration page, so it always remains usable in case you change something by mistake.

Authentication page

KeyDescription
auth_addressColor of the input field for IP address
auth_bookmarksColor of the bookmarks panel
auth_passwordColor of the input field for password
auth_portColor of the input field for port number
auth_protocolColor of the radio group for protocol
auth_recentsColor of the recents panel
auth_usernameColor of the input field for username

Transfer page

KeyDescription
transfer_local_explorer_backgroundBackground color of localhost explorer
transfer_local_explorer_foregroundForeground color of localhost explorer
transfer_local_explorer_highlightedBorder and highlighted color for localhost explorer
transfer_remote_explorer_backgroundBackground color of remote explorer
transfer_remote_explorer_foregroundForeground color of remote explorer
transfer_remote_explorer_highlightedBorder and highlighted color for remote explorer
transfer_log_backgroundBackground color for log panel
transfer_log_windowWindow color for log panel
transfer_progress_bar_partialPartial progress bar color
transfer_progress_bar_totalTotal progress bar color
transfer_status_hiddenColor for status bar “hidden” label
transfer_status_sortingColor for status bar “sorting” label; applies also to file sorting dialog
transfer_status_sync_browsingColor for status bar “sync browsing” label

Misc

These styles apply to different parts of the application.

KeyDescription
misc_error_dialogColor for error messages
misc_info_dialogColor for info dialogs
misc_input_dialogColor for input dialogs (such as copy file)
misc_keysColor of text for key strokes
misc_quit_dialogColor for quit dialogs
misc_save_dialogColor for save dialogs
misc_warn_dialogColor for warn dialogs