mirror of
https://github.com/alacritty/alacritty.git
synced 2024-11-18 13:55:23 -05:00
8dfd2e56ad
This also fixes the escaping in alacritty(5) page.
145 lines
2.7 KiB
Markdown
145 lines
2.7 KiB
Markdown
ALACRITTY(1)
|
|
|
|
# NAME
|
|
|
|
Alacritty - A fast, cross-platform, OpenGL terminal emulator.
|
|
|
|
# SYNOPSIS
|
|
|
|
Alacritty is a modern terminal emulator that comes with sensible defaults, but
|
|
allows for extensive configuration. By integrating with other applications,
|
|
rather than reimplementing their functionality, it manages to provide a flexible
|
|
set of features with high performance.
|
|
|
|
# FLAGS
|
|
|
|
*-h, --help*
|
|
|
|
Prints help information.
|
|
|
|
*--hold*
|
|
|
|
Remain open after child process exits.
|
|
|
|
*--print-events*
|
|
|
|
Print all events to STDOUT.
|
|
|
|
*-q*
|
|
|
|
Reduces the level of verbosity (the min level is *-qq*).
|
|
|
|
*--ref-test*
|
|
|
|
Generates ref test
|
|
|
|
*-v*
|
|
|
|
Increases the level of verbosity (the max level is *-vvv*).
|
|
|
|
*-V, --version*
|
|
|
|
Prints version information.
|
|
|
|
# OPTIONS
|
|
|
|
*--class* _<GENERAL>_ | _<GENERAL>_,_<INSTANCE>_
|
|
|
|
Defines the window class hint on Linux.
|
|
|
|
When only the general class is passed, instance will be set to the same value.
|
|
|
|
On Wayland the general class sets the _app\_id_, while the instance class is ignored.
|
|
|
|
Default: _Alacritty,Alacritty_
|
|
|
|
*-e, --command* _<COMMAND>..._
|
|
|
|
Command and args to execute (must be last argument).
|
|
|
|
*--config-file* _<CONFIG_FILE>_
|
|
|
|
Specify alternative configuration file.
|
|
|
|
Alacritty doesn't create the config file for you, but it looks for one in the
|
|
following locations on UNIX systems:
|
|
|
|
. _$XDG_CONFIG_HOME/alacritty/alacritty.toml_
|
|
. _$XDG_CONFIG_HOME/alacritty.toml_
|
|
. _$HOME/.config/alacritty/alacritty.toml_
|
|
. _$HOME/.alacritty.toml_
|
|
|
|
On Windows, the config file will be looked for in:
|
|
|
|
. _%APPDATA%\\alacritty\\alacritty.toml_
|
|
|
|
*--embed* _<PARENT>_
|
|
|
|
X11 window ID to embed Alacritty within (decimal or hexadecimal with _0x_ prefix).
|
|
|
|
*-o, --option* _<OPTION>..._
|
|
|
|
Override configuration file options.
|
|
|
|
Example: _alacritty -o 'cursor.style="Beam"'_
|
|
|
|
*--socket* _<SOCKET>_
|
|
|
|
Path for IPC socket creation.
|
|
|
|
*-T, --title* _<TITLE>_
|
|
|
|
Defines the window title.
|
|
|
|
Default: _Alacritty_
|
|
|
|
*--working-directory* _<WORKING_DIRECTORY>_
|
|
|
|
Start the shell in the specified working directory.
|
|
|
|
# SUBCOMMANDS
|
|
|
|
*msg*
|
|
|
|
Send IPC socket messages (see *alacritty-msg*(1)).
|
|
|
|
*migrate*
|
|
|
|
Migrate the configuration file.
|
|
|
|
*-c, --config-file* _<CONFIG_FILE>_
|
|
|
|
Path to the configuration file.
|
|
|
|
*-d, --dry-run*
|
|
|
|
Only output TOML config to STDOUT.
|
|
|
|
*-i, --skip-imports*
|
|
|
|
Do not recurse over imports.
|
|
|
|
*--skip-renames*
|
|
|
|
Do not move renamed fields to their new location.
|
|
|
|
*-s, --silent*
|
|
|
|
Do not output to STDOUT.
|
|
|
|
*-h, --help*
|
|
|
|
Print help information.
|
|
|
|
# SEE ALSO
|
|
|
|
*alacritty-msg*(1), *alacritty*(5), *alacritty-bindings*(5)
|
|
|
|
# BUGS
|
|
|
|
Found a bug? Please report it at _https://github.com/alacritty/alacritty/issues_.
|
|
|
|
# MAINTAINERS
|
|
|
|
- Christian Duerr <contact@christianduerr.com>
|
|
- Kirill Chibisov <contact@kchibisov.com>
|