1
0
Fork 0
mirror of https://github.com/alacritty/alacritty.git synced 2024-11-25 14:05:41 -05:00
alacritty/extra/man/alacritty.1.scd
Kirill Chibisov 357c2e0ae4 Make man pages look consistent
Part of the man pages were using _value_, other part were using just
value, thus make everything as _value_.

Also properly dot terminate and add spacing through out the man pages.
2023-11-24 03:01:10 +04:00

116 lines
2.4 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 looks for the configuration file at the following paths:
. _$XDG_CONFIG_HOME/alacritty/alacritty.toml_
. _$XDG_CONFIG_HOME/alacritty.toml_
. _$HOME/.config/alacritty/alacritty.toml_
. _$HOME/.alacritty.toml_
On Windows, the configuration file is located at _%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)).
# SEE ALSO
*alacritty-msg*(1), *alacritty*(5), *alacritty-bindings*(5)
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>