mirror of
https://github.com/alacritty/alacritty.git
synced 2024-11-11 13:51:01 -05:00
4ddb608563
This patch adds a new mechanism for changing configuration options without editing the configuration file, by sending options to running instances through `alacritty msg`. Each window will load Alacritty's configuration file by default and then accept IPC messages for config updates using the `alacritty msg config` subcommand. By default all windows will be updated, individual windows can be addressed using `alacritty msg config --window-id "$ALACRITTY_WINDOW_ID"`. Each option will replace the config's current value and cannot be reset until Alacritty is restarted or the option is overwritten with a new value. Configuration options are passed in the format `field.subfield=value`, where `value` is interpreted as yaml. Closes #472.
64 lines
1.5 KiB
Groff
64 lines
1.5 KiB
Groff
.TH ALACRITTY-MSG "1" "October 2021" "alacritty 0.11.0-dev" "User Commands"
|
|
.SH NAME
|
|
alacritty-msg \- Send messages to Alacritty
|
|
.SH "SYNOPSIS"
|
|
alacritty msg [OPTIONS] <MESSAGE> [MESSAGE_OPTIONS]
|
|
.SH DESCRIPTION
|
|
This command communicates with running Alacritty instances through a socket,
|
|
making it possible to control Alacritty without directly accessing it.
|
|
.SH "OPTIONS"
|
|
\fB\-s\fR, \fB\-\-socket\fR <socket>
|
|
Path for IPC socket creation
|
|
.SH "MESSAGES"
|
|
.TP
|
|
\fBcreate-window\fR
|
|
Create a new window in the same Alacritty process
|
|
.TP
|
|
.SH "\tOPTIONS"
|
|
.RS 12
|
|
.TP
|
|
\fB\-\-hold\fR
|
|
Remain open after child process exits
|
|
.TP
|
|
\fB\-\-working\-directory\fR <working\-directory>
|
|
Start the shell in the specified working directory
|
|
.TP
|
|
\fB\-e\fR, \fB\-\-command\fR <command>...
|
|
Command and args to execute (must be last argument)
|
|
.RE
|
|
.TP
|
|
\fBconfig\fR
|
|
Update the Alacritty configuration
|
|
.TP
|
|
.SH "\tARGS"
|
|
.RS 12
|
|
.TP
|
|
\fB<CONFIG_OPTIONS>...\fR
|
|
Configuration file options [example: cursor.style=Beam]
|
|
.RE
|
|
.TP
|
|
.SH "\tOPTIONS"
|
|
.RS 12
|
|
.TP
|
|
\fB\-w\fR, \fB\-\-window\-id\fR <WINDOW_ID>
|
|
Window ID for the new config.
|
|
|
|
Use `-1` to apply this change to all windows.
|
|
|
|
[default: \fB$ALACRITTY_WINDOW_ID\fR]
|
|
.RE
|
|
.SH "SEE ALSO"
|
|
See the alacritty github repository at https://github.com/alacritty/alacritty for the full documentation.
|
|
.SH "BUGS"
|
|
Found a bug? Please report it at https://github.com/alacritty/alacritty/issues.
|
|
.SH "MAINTAINERS"
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
Christian Duerr <contact@christianduerr.com>
|