PolytreeDE/alacritty
1
0
Fork 0
mirror of https://github.com/alacritty/alacritty.git synced 2024-11-11 13:51:01 -05:00
Code Releases Activity
alacritty/extra/man/alacritty.1.scd

142 lines
2.6 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
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-23 12:39:18 -05:00
Alacritty - A fast, cross-platform, OpenGL terminal emulator.
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
# 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*
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-23 12:39:18 -05:00
Prints help information.
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
*--hold*
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-23 12:39:18 -05:00
Remain open after child process exits.
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
*--print-events*
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-23 12:39:18 -05:00
Add migrate to alacritty(1)
2023-11-23 13:45:45 -05:00
Print all events to STDOUT.
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
*-q*
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-23 12:39:18 -05:00
Reduces the level of verbosity (the min level is *-qq*).
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
*--ref-test*
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-23 12:39:18 -05:00
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
Generates ref test
*-v*
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-23 12:39:18 -05:00
Increases the level of verbosity (the max level is *-vvv*).
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
*-V, --version*
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-23 12:39:18 -05:00
Prints version information.
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
# OPTIONS
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-23 12:39:18 -05:00
*--class* _<GENERAL>_ | _<GENERAL>_,_<INSTANCE>_
Defines the window class hint on Linux.
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
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.
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-23 12:39:18 -05:00
Default: _Alacritty,Alacritty_
*-e, --command* _<COMMAND>..._
Command and args to execute (must be last argument).
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
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-23 12:39:18 -05:00
*--config-file* _<CONFIG_FILE>_
Specify alternative configuration file.
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 looks for the configuration file at the following paths:
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-23 12:39:18 -05:00
. _$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>..._
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
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-23 12:39:18 -05:00
Override configuration file options.
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
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-23 12:39:18 -05:00
Example: _alacritty -o 'cursor.style="Beam"'_
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
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-23 12:39:18 -05:00
*--socket* _<SOCKET>_
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
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-23 12:39:18 -05:00
Path for IPC socket creation.
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
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-23 12:39:18 -05:00
*-T, --title* _<TITLE>_
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
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-23 12:39:18 -05:00
Defines the window title.
Default: _Alacritty_
*--working-directory* _<WORKING_DIRECTORY>_
Start the shell in the specified working directory.
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
# SUBCOMMANDS
*msg*
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-23 12:39:18 -05:00
Send IPC socket messages (see *alacritty-msg*(1)).
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
Add migrate to alacritty(1)
2023-11-23 13:45:45 -05:00
*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.
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
# SEE ALSO
Add manpage links to "see also" section
2023-07-01 08:41:09 -04:00
*alacritty-msg*(1), *alacritty*(5), *alacritty-bindings*(5)
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
# BUGS
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-23 12:39:18 -05:00
Found a bug? Please report it at _https://github.com/alacritty/alacritty/issues_.
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
# MAINTAINERS
- Christian Duerr <contact@christianduerr.com>
- Kirill Chibisov <contact@kchibisov.com>
Copy permalink