Mirrors/asciinema
1
0
Fork 0
mirror of https://github.com/asciinema/asciinema.git synced 2025-12-15 19:28:00 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update info about man page generation

Browse Source
This commit is contained in:
Marcin Kulik
2024-05-15 11:58:17 +02:00
parent 4273767941
commit 6ddaa53be0
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -86,16 +86,15 @@ This produces the binary in _release mode_ (`--release`) at
`target/release/asciinema`. You can just copy the binary to a directory in your
`$PATH`.
To generate man page and shell completion files, set `ASCIINEMA_GEN_DIR` to the
To generate man pages and shell completion files, set `ASCIINEMA_GEN_DIR` to the
path where these artifacts should be stored. For example:
```sh
ASCIINEMA_GEN_DIR=/foo/bar cargo build --release
ASCIINEMA_GEN_DIR=/foo cargo build --release
```
The above command will build the binary and place the man page in
`/foo/bar/man/asciinema.1`, and the shell completion files in the
`/foo/bar/completion/` directory.
The above command will build the binary and place the man pages in `/foo/man/`,
and the shell completion files in the `/foo/completion/` directory.
> [!NOTE]
> Windows is currently not supported. _(See [#467](https://github.com/asciinema/asciinema/issues/467))_