aboutsummaryrefslogtreecommitdiff
path: root/INSTALL.md
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 /INSTALL.md
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 'INSTALL.md')
-rw-r--r--INSTALL.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/INSTALL.md b/INSTALL.md
index 51bc4762..debe3f81 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -327,12 +327,12 @@ directory.
### Manual Page
-Installing the manual page requires the additional dependency `gzip`.
+Installing the manual page requires the additional dependencies `gzip` and `scdoc`.
```sh
sudo mkdir -p /usr/local/share/man/man1
-gzip -c extra/alacritty.man | sudo tee /usr/local/share/man/man1/alacritty.1.gz > /dev/null
-gzip -c extra/alacritty-msg.man | sudo tee /usr/local/share/man/man1/alacritty-msg.1.gz > /dev/null
+scdoc < extra/man/alacritty.1.scd | gzip -c | sudo tee /usr/local/share/man/man1/alacritty.1.gz > /dev/null
+scdoc < extra/man/alacritty-msg.1.scd | gzip -c | sudo tee /usr/local/share/man/man1/alacritty-msg.1.gz > /dev/null
```
### Shell completions