NAME

pkgman-readme — print the package's README

SYNOPSIS

DESCRIPTION

Print the package's README.md/README file if it exists. If the package source directory contains both files README.md and README, the markdown markup (README.md) takes precedence.

ENVIRONMENT

If the following environment variable exists it will be utilized by pkgman(1):

PAGER

If the package source directory has a README.md/README file, then pkgman-readme will try to open it using a PAGER. If PAGER is unset, then pkgman-readme prints the README to stdout.

EXIT STATUS

0 if success, 255 otherwise.