diff options
| author | Christian Duerr <contact@christianduerr.com> | 2022-08-31 22:48:38 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-01 01:48:38 +0300 |
| commit | 4ddb608563d985060d69594d1004550a680ae3bd (patch) | |
| tree | 0b02a330b3e59300cff80a147f3c1bdab7f9ea57 /extra/alacritty-msg.man | |
| parent | 18f9c2793924aec91c80a69ccb45f529adaffae5 (diff) | |
| download | alacritty-4ddb608563d985060d69594d1004550a680ae3bd.tar.gz alacritty-4ddb608563d985060d69594d1004550a680ae3bd.zip | |
Add IPC config subcommand
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.
Diffstat (limited to 'extra/alacritty-msg.man')
| -rw-r--r-- | extra/alacritty-msg.man | 27 |
1 files changed, 25 insertions, 2 deletions
diff --git a/extra/alacritty-msg.man b/extra/alacritty-msg.man index ed600d40..f4a34f46 100644 --- a/extra/alacritty-msg.man +++ b/extra/alacritty-msg.man @@ -10,20 +10,43 @@ making it possible to control Alacritty without directly accessing it. \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" |