https://github.com/mikkoi/plenv-man

A plenv plugin to help read man pages from different Perl versions
https://github.com/mikkoi/plenv-man

bash hacktoberfest perl plenv script

Last synced: about 4 hours ago
JSON representation

A plenv plugin to help read man pages from different Perl versions

• Host: GitHub
• URL: https://github.com/mikkoi/plenv-man
• Owner: mikkoi
• License: other
• Created: 2022-10-12T20:05:04.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-08T20:32:42.000Z (about 2 years ago)
• Last Synced: 2024-11-15T12:27:27.936Z (2 months ago)
• Topics: bash, hacktoberfest, perl, plenv, script
• Language: Shell
• Homepage:
• Size: 15.6 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# plenv-man

A [plenv](https://github.com/tokuhirom/plenv) plugin to help read man pages from different Perl versions.

## Usage

```

$ plenv man perl

$ plenv man 3 open

$ plenv man --version 5.34.1 perldelta

$ plenv man --version 5.34.1 --executable manpath -g -d

```

## The Explicit Way, Using Plenv Command `plenv man`.

EXAMPLES

Read man page of currently active perl:

```sh

plenv man perl

```

You can use any arguments you would normally give to `man`:

```sh

plenv man 3 open

```

Read man page of any installed perl version:

```sh

plenv man --version 5.34.1 perldelta

```

Instead of `man`, run any command which makes use of $MANPATH environmental variable:

```sh

plenv man --version 5.34.1 --executable manpath -g -d

```

## Installation

```sh

mkdir -p ${PLENV_ROOT}/plugins

git clone https://github.com/mikkoi/plenv-man.git ${PLENV_ROOT}/plugins/plenv-man

```

## The Implicit Way, Using Plenv Hook.

The implicit way creates a pseudo-`man` command in `${PLENV_ROOT}/shims/`

and other pseudo commands in all v`${PLENV_ROOT}/versions//bin/`

directories. There are created by hooking into `plenv rehash` command.

When running `man`, these shims set the correct `$MANPATH` variable contents

and then call system `man`.

### Installation

```sh

mkdir -p ${PLENV_ROOT}/plugins

git clone https://github.com/mikkoi/plenv-man.git ${PLENV_ROOT}/plugins/plenv-man

mkdir -p ${PLENV_ROOT}/plenv.d/rehash

cp ${PLENV_ROOT}/plugins/plenv-man/plenv.d/rehash/man.bash ${PLENV_ROOT}/plenv.d/rehash/

plenv rehash

```

## AUTHOR

Mikko Koivunalho

## LICENSE

See [LICENSE](./LICENSE).