1
0
Fork 0
mirror of https://github.com/alacritty/alacritty.git synced 2024-11-11 13:51:01 -05:00
A cross-platform, OpenGL terminal emulator.
Find a file
Christian Duerr 5174f9b274
Fix duplicate resize events
If a resize event is identical to the current size, it is no longer
propagated but the resize is discarded immediately.

To further prevent resizes when not necessary, the list of monitors is
enumerated and the DPR of the first display is assumed to be the target
DPR.

This allows spawning a window with dimensions when the config has
columns and lines specified and the window only needs to be resized if
the estimated DPR is not correct.

Fixes #1825.
Fixes #204.
2019-04-14 15:37:58 +00:00
.github
ci Document distro support for precompiled binaries 2019-04-09 20:59:46 +00:00
copypasta Remove redundant closures and imports 2019-04-11 07:54:26 +00:00
docs
extra Fix Alacritty icon background on Windows 2019-04-10 00:04:24 +00:00
font Fix duplicate resize events 2019-04-14 15:37:58 +00:00
res
scripts
servo-freetype-proxy
src Fix duplicate resize events 2019-04-14 15:37:58 +00:00
tests
winpty Set maximum Rust version to 1.31.0 2019-04-09 19:29:46 +00:00
.agignore
.gitignore
.travis.yml Set maximum Rust version to 1.31.0 2019-04-09 19:29:46 +00:00
alacritty.yml Document URL launcher parameter options 2019-04-09 21:17:22 +00:00
build.rs
Cargo.lock Set maximum Rust version to 1.31.0 2019-04-09 19:29:46 +00:00
Cargo.toml Set maximum Rust version to 1.31.0 2019-04-09 19:29:46 +00:00
CHANGELOG.md Fix duplicate resize events 2019-04-14 15:37:58 +00:00
CONTRIBUTING.md Set maximum Rust version to 1.31.0 2019-04-09 19:29:46 +00:00
INSTALL.md Document EGL driver dependency on Wayland 2019-04-09 21:11:54 +00:00
LICENSE-APACHE
Makefile
README.md Add Pop!_OS to the list of supported Linux distros 2019-04-10 18:29:53 +00:00
rustfmt.toml

Alacritty

Alacritty Logo

Alacritty is the fastest terminal emulator in existence. Using the GPU for rendering enables optimizations that simply aren't possible without it. Alacritty currently supports macOS, Linux, BSD, and Windows.

Alacritty running vim inside tmux

About

Alacritty is a terminal emulator with a strong focus on simplicity and performance. With such a strong focus on performance, included features are carefully considered and you can always expect Alacritty to be blazingly fast. By making sane choices for defaults, Alacritty requires no additional setup. However, it does allow configuration of many aspects of the terminal.

The software is considered to be at a beta level of readiness -- there are a few missing features and bugs to be fixed, but it is already used by many as a daily driver.

Precompiled binaries are available from the GitHub releases page.

Further information

Installation

Some operating systems already provide binaries for Alacritty, for everyone else the instructions to build Alacritty from source can be found here.

Pop!_OS

Provided in the Pop!_OS repositories for 18.04 (bionic) and higher.

apt install alacritty

Arch Linux

pacman -S alacritty

openSUSE Tumbleweed

zypper in alacritty

Void Linux

xbps-install alacritty

Gentoo Linux

emerge x11-terms/alacritty

Mageia 7+

urpmi alacritty

FreeBSD

pkg install alacritty

NixOS

nix-env -iA nixos.alacritty

Solus

eopkg install alacritty

macOS

brew cask install alacritty

Once the cask is installed, it is recommended to setup the manual page, shell completions, and terminfo definitions.

Windows

Via Chocolatey

choco install alacritty

Via Scoop

scoop bucket add extras
scoop install alacritty

Other

Prebuilt binaries for Linux, macOS, and Windows can be downloaded from the GitHub releases page.

To work properly on Windows, Alacritty requires winpty to emulate UNIX's PTY API. The agent is a single binary (winpty-agent.exe) which must be in the same directory as the Alacritty executable and is available through the GitHub releases page.

On Windows, Alacritty also requires Microsoft's VC++ redistributable to work properly.

Configuration

Although it's possible the default configuration would work on your system, you'll probably end up wanting to customize it anyhow. There is a default alacritty.yml at the Git repository root. Alacritty looks for the configuration file at the following paths:

  1. $XDG_CONFIG_HOME/alacritty/alacritty.yml
  2. $XDG_CONFIG_HOME/alacritty.yml
  3. $HOME/.config/alacritty/alacritty.yml
  4. $HOME/.alacritty.yml

If none of these paths are found then $XDG_CONFIG_HOME/alacritty/alacritty.yml is created once Alacritty is first run. On most systems this often defaults to $HOME/.config/alacritty/alacritty.yml.

Many configuration options will take effect immediately upon saving changes to the config file. For more information about the config file structure, refer to the default config file.

Windows

On Windows the config file is located at:

%APPDATA%\alacritty\alacritty.yml

Contributing

A full guideline about contributing to Alacritty can be found in the CONTRIBUTING.md file.

Issues (known, unknown, feature requests, etc.)

If you run into a problem with Alacritty, please file an issue. If you've got a feature request, feel free to ask about it. Please just keep in mind Alacritty is focused on simplicity and performance, and not all features are in line with that goal.

Before opening a new issue, please check if it has already been reported. There's a chance someone else has already reported it, and you can subscribe to that issue to keep up on the latest developments.

FAQ

Is it really the fastest terminal emulator?

In the terminals we've benchmarked, Alacritty is either faster or way faster than the others. If you've found a case where this isn't true, please report a bug.

Why isn't feature X implemented?

Alacritty has many great features, but not every feature from every other terminal. This could be for a number of reasons, but sometimes it's just not a good fit for Alacritty. This means you won't find things like tabs or splits (which are best left to a window manager or terminal multiplexer) nor niceties like a GUI config editor.

macOS + tmux + vim is slow! I thought this was supposed to be fast!

This appears to be an issue outside of terminal emulators; either macOS has an IPC performance issue, or either tmux or vim (or both) have a bug. This same issue can be seen in iTerm2 and Terminal.app. I've found that if tmux is running on another machine which is connected to Alacritty via SSH, this issue disappears. Actual throughput and rendering performance are still better in Alacritty.

My arrow keys don't work.

It sounds like you deleted some key bindings from your config file. Please reference the default config file to restore them.

IRC

Alacritty discussion can be found in #alacritty on freenode.

Wayland

Wayland support is available, but not everything works as expected. Many people have found a better experience using XWayland which can be achieved by launching Alacritty with the WAYLAND_DISPLAY environment variable cleared:

env WAYLAND_DISPLAY="" alacritty

If you're interested in seeing our Wayland support improve, please head over to the Wayland meta issue on the winit project to see how you may contribute.

License

Alacritty is released under the Apache License, Version 2.0.