summaryrefslogtreecommitdiffstats
path: root/extra/alacritty-msg.man
diff options
context:
space:
mode:
authorKirill Chibisov <contact@kchibisov.com>2021-11-22 21:34:09 +0300
committerGitHub <noreply@github.com>2021-11-22 18:34:09 +0000
commit8681f71084894db6d1e258be17db1f80bb669314 (patch)
tree24d3c0ced916d2d171fd03f50cd34dcda8f0aa06 /extra/alacritty-msg.man
parentc89939b5d14e581e1aeaa940d81843192e0abc79 (diff)
Add parameters to `msg create-window` subcommand
Alacritty's `msg create-window` subcommand would previously inherit all the CLI parameters from the original executable. However not only could this lead to unexpected behavior, it also prevents multi-window users from making use of parameters like `-e`, `--working-directory`, or `--hold`. This is solved by adding a JSON-based message format to the IPC socket messages which instructs the Alacritty server on which CLI parameters should be used to create the new window. Fixes #5562. Fixes #5561. Fixes #5560.
Diffstat (limited to 'extra/alacritty-msg.man')
-rw-r--r--extra/alacritty-msg.man16
1 files changed, 13 insertions, 3 deletions
diff --git a/extra/alacritty-msg.man b/extra/alacritty-msg.man
index 818169d0..5ccb3014 100644
--- a/extra/alacritty-msg.man
+++ b/extra/alacritty-msg.man
@@ -2,18 +2,28 @@
.SH NAME
alacritty-msg \- Send messages to Alacritty
.SH "SYNOPSIS"
-alacritty msg [OPTIONS] [MESSAGES]
+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"
-.TP
\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
+\fB\-\-hold\fR
+Remain open after child process exits
+
+\fB\-\-working\-directory\fR <working\-directory>
+Start the shell in the specified working directory
+
+\fB\-e\fR, \fB\-\-command\fR <command>...
+Command and args to execute (must be last argument)
+.RE
.SH "SEE ALSO"
See the alacritty github repository at https://github.com/alacritty/alacritty for the full documentation.
.SH "BUGS"