Skip to content

Commit

Permalink
docs: Improve man pages installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
peterkuma committed Dec 22, 2024
1 parent 43bd9d5 commit f643999
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,17 @@ The instructions below assume that you enter the commands in the terminal.

```sh
pipx install alcf
```

Make sure that `$HOME/.local/bin` is in the PATH environment variable.

If you use pipx < 1.3.0, install the manual pages with:

```sh
mkdir -p ~/.local/share/man/man1
ln -s ~/.local/pipx/venvs/alcf/share/man/man1/alcf*.1 ~/.local/share/man/man1/
```

Make sure that `$HOME/.local/bin` is in the PATH environment variable.

### Windows

It is recommended to run ALCF on [Linux](#linux).
Expand Down Expand Up @@ -152,6 +157,11 @@ To uninstall ALCF on Linux:
```sh
pipx uninstall alcf
```
If you have installed manual pages manually:
```sh
rm ~/.local/share/man/man1/alcf*.1
```
Expand Down

0 comments on commit f643999

Please sign in to comment.