PolytreeDE/alacritty
1
0
Fork 0
mirror of https://github.com/alacritty/alacritty.git synced 2024-10-27 05:32:54 -04:00
Code Releases Activity
alacritty/extra/man/alacritty.1.scd

93 lines
2.2 KiB
Text
Raw Normal View History

Move manpages to scdoc This rewrites the existing manpages to use the `scdoc` format, making it simpler to read and edit the manpages without intricate roff knowledge. Some minor changes to the manpages were made in the process, mostly focusing on correcting some of the wording. The list of maintainers has also changed to ensure people not involved in the project anymore aren't unnecessarily contacted for support.
2023-05-28 06:13:09 -04:00
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 [default: Alacritty,Alacritty]
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.
*-e, --command* <command>...
Command and args to execute (must be last argument)
*--config-file* <config-file>
Specify alternative configuration file
Alacritty looks for the configuration file at the following paths:
Switch to TOML configuration format This switches Alacritty's default configuration format from yaml to toml. While yaml is still supported, it is done by converting it to toml and should be removed entirely in the future. All existing features were persisted based on my testing. Behavior should not change much, though `--option` might have slightly different behavior since the entire line is not interpreted as one line of toml. A new `alacritty migrate` subcommand has been added which allows automatic migration from yaml to toml. This also could be used as a facility to automatically fix configuration file changes in the future. Closes #6592.
2023-06-11 20:23:41 -04:00
. $XDG_CONFIG_HOME/alacritty/alacritty.toml
. $XDG_CONFIG_HOME/alacritty.toml
. $HOME/.config/alacritty/alacritty.toml
. $HOME/.alacritty.toml
Move manpages to scdoc This rewrites the existing manpages to use the `scdoc` format, making it simpler to read and edit the manpages without intricate roff knowledge. Some minor changes to the manpages were made in the process, mostly focusing on correcting some of the wording. The list of maintainers has also changed to ensure people not involved in the project anymore aren't unnecessarily contacted for support.
2023-05-28 06:13:09 -04:00
Switch to TOML configuration format This switches Alacritty's default configuration format from yaml to toml. While yaml is still supported, it is done by converting it to toml and should be removed entirely in the future. All existing features were persisted based on my testing. Behavior should not change much, though `--option` might have slightly different behavior since the entire line is not interpreted as one line of toml. A new `alacritty migrate` subcommand has been added which allows automatic migration from yaml to toml. This also could be used as a facility to automatically fix configuration file changes in the future. Closes #6592.
2023-06-11 20:23:41 -04:00
On Windows, the configuration file is located at %APPDATA%\\alacritty\\alacritty.toml
Move manpages to scdoc This rewrites the existing manpages to use the `scdoc` format, making it simpler to read and edit the manpages without intricate roff knowledge. Some minor changes to the manpages were made in the process, mostly focusing on correcting some of the wording. The list of maintainers has also changed to ensure people not involved in the project anymore aren't unnecessarily contacted for support.
2023-05-28 06:13:09 -04:00
*--embed* <parent>
X11 window ID to embed Alacritty within (decimal or hexadecimal with _0x_ prefix)
*-o, --option* <option>...
Override configuration file options [example: 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))
# SEE ALSO
See the alacritty github repository at https://github.com/alacritty/alacritty
for the full documentation.
# 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>
Copy permalink