Skip to content

Commit

Permalink
Add link to freedesktop.org
Browse files Browse the repository at this point in the history
  • Loading branch information
Will committed May 28, 2022
1 parent 7e6ead0 commit 57def91
Showing 1 changed file with 21 additions and 20 deletions.
41 changes: 21 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
A modern, minimalist, semi-transparent fullscreen "drop-down" terminal emulateur
for freedesktop.org-compatible desktops (e.g. GNOME, KDE).
for [freedesktop.org][1]-compatible desktops (e.g. GNOME, KDE).

It omits many features common in other terminal emulators, such as tabs,
because it's meant to be used in conjunction with a terminal multiplexer such as [tmux][1],
because it's meant to be used in conjunction with a terminal multiplexer such as [tmux][2],
which has a solid, mature UI.
See also [tmux mode][2] for enhanced tmux features.
See also [tmux mode][3] for enhanced tmux features.

Based on [VTE][3].
Based on [VTE][4].

## Usage

Whichever process runs `terminalle` is the "server".
Use [D-Bus][4] to control it.
Use [D-Bus][5] to control it.

```bash
# See usage info.
Expand All @@ -36,7 +36,7 @@ there are four methods to move the terminal window between monitors:
`MoveRight`, `MoveLeft`, `MoveDown`, and `MoveUp`,
each of which moves the window to the next adjacent monitor in a particular direction.
This only works while the window is open.
See [shortcuts][5] for info on mapping keybindings to these D-Bus methods.
See [shortcuts][6] for info on mapping keybindings to these D-Bus methods.

Use `Ctrl+Shift+C` and `Ctrl+Shift+V` to access the clipboard.

Expand Down Expand Up @@ -75,11 +75,11 @@ gsettings set org.gnome.settings-daemon.plugins.media-keys.custom-keybinding:/or
If you use multiple monitors,
consider hooking up shortcuts for the aforementioned movement methods as well.

[KDE can][6] configure shortcuts to call D-Bus methods directly.
[KDE can][7] configure shortcuts to call D-Bus methods directly.

## Configuration

See an [example configuration][7]. See the defaults in [`settings.py`][8].
See an [example configuration][8]. See the defaults in [`settings.py`][9].
Defaults can be selectively overridden in
`${XDG_CONFIG_HOME:-${HOME}/.config}/terminalle.yaml`.

Expand All @@ -93,7 +93,7 @@ Generally replacing the tmux prefix with a simple `Ctrl` modifier,
it cuts the number of keystrokes in half
without requiring you to memorize new shortcuts.
If you're a tmux power-user, this will *change* things for you.
Turn it on by setting `tmux: true` in `terminalle.yaml` (see [configuration][9]).
Turn it on by setting `tmux: true` in `terminalle.yaml` (see [configuration][10]).

The following shortcuts are enabled in tmux mode:

Expand Down Expand Up @@ -145,16 +145,17 @@ bind -n C-Right resize-pane -R
bind -n M-Right resize-pane -R 5
```

This all goes especially well with [vim-tmux-navigator][10],
This all goes especially well with [vim-tmux-navigator][11],
which provides shortened bindings for switching seemlessly between tmux panes and Vim windows.

[1]: https://tmux.github.io/
[2]: #tmux-mode
[3]: https://wiki.gnome.org/Apps/Terminal/VTE
[4]: https://www.freedesktop.org/wiki/Software/dbus/
[5]: #shortcuts
[6]: https://docs.kde.org/trunk5/en/khotkeys/kcontrol/khotkeys/khotkeys.pdf
[7]: terminalle.yaml
[8]: terminalle/settings.py
[9]: #configuration
[10]: https://github.com/christoomey/vim-tmux-navigator
[1]: https://freedesktop.org
[2]: https://tmux.github.io
[3]: #tmux-mode
[4]: https://wiki.gnome.org/Apps/Terminal/VTE
[5]: https://www.freedesktop.org/wiki/Software/dbus
[6]: #shortcuts
[7]: https://docs.kde.org/trunk5/en/khotkeys/kcontrol/khotkeys/khotkeys.pdf
[8]: terminalle.yaml
[9]: terminalle/settings.py
[10]: #configuration
[11]: https://github.com/christoomey/vim-tmux-navigator

0 comments on commit 57def91

Please sign in to comment.