aboutsummaryrefslogtreecommitdiff
path: root/extra/man/alacritty-msg.1.scd
diff options
context:
space:
mode:
authorChristian Duerr <contact@christianduerr.com>2023-05-28 12:13:09 +0200
committerGitHub <noreply@github.com>2023-05-28 10:13:09 +0000
commite3746e49a117ebf8d1f43715554c5a1cf8d4a116 (patch)
treefa5490d36c8b864e3f1f6705c4b0318ea34fa816 /extra/man/alacritty-msg.1.scd
parent32ea98deeba5f0eb6c51062cfb0fd2caa802054d (diff)
downloadalacritty-e3746e49a117ebf8d1f43715554c5a1cf8d4a116.tar.gz
alacritty-e3746e49a117ebf8d1f43715554c5a1cf8d4a116.zip
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.
Diffstat (limited to 'extra/man/alacritty-msg.1.scd')
-rw-r--r--extra/man/alacritty-msg.1.scd59
1 files changed, 59 insertions, 0 deletions
diff --git a/extra/man/alacritty-msg.1.scd b/extra/man/alacritty-msg.1.scd
new file mode 100644
index 00000000..d499f5f1
--- /dev/null
+++ b/extra/man/alacritty-msg.1.scd
@@ -0,0 +1,59 @@
+ALACRITTY-MSG(1)
+
+# NAME
+
+alacritty-msg - Send messages to Alacritty
+
+# SYNOPSIS
+
+This command communicates with running Alacritty instances through a socket,
+making it possible to control Alacritty without directly accessing it.
+
+# OPTIONS
+
+*-s, --socket* <socket>
+ Path for IPC socket communication
+
+# MESSAGES
+
+*create-window*
+ Create a new window in the same Alacritty process
+
+ *OPTIONS*
+ *--hold*
+ Remain open after child process exits
+
+ *--working-directory* <working-directory>
+ Start the shell in the specified working directory
+
+ *command* <command>...
+ Command and args to execute (must be last argument)
+
+*config*
+ Update the Alacritty configuration
+
+ *ARGS*
+ *<CONFIG_OPTIONS>...*
+ Configuration file options [example: cursor.style=Beam]
+
+ *OPTIONS*
+ *-w, --window-id* <WINDOW_ID>
+ Window ID for the new config.
+
+ Use _-1_ to apply this change to all windows.
+
+ \[default: *$ALACRITTY_WINDOW_ID*]
+
+# SEE ALSO
+
+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>