Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use mandoc when nroff not available #5489

merged 2 commits into from Jan 8, 2019


Copy link

@McKayJT McKayJT commented Jan 6, 2019


mandoc is a set of tools that don't rely on roff to display man pages native to the *BSD ecosystem. This change allows users with mandoc to view the manual pages used in the builtin help commands if they don't have roff installed.


  • Changes to fish usage are reflected in user documentation/manpages.
  • Tests have been added for regressions fixed
  • User-visible changes noted in

mandoc users do not need to install nroff to be able to format and view
manual pages. If both nroff and mandoc cannot be found it will show an
Copy link

faho commented Jan 6, 2019


If you'd like, also contains:

builtin commands that have the --help option or print usage messages require nroff and ul

in the dependencies section. Or we can change it.

@faho faho added this to the fish 3.1.0 milestone Jan 6, 2019
Copy link
Contributor Author

McKayJT commented Jan 6, 2019

I didn't see that hiding there. That explains why I was surprised when it complained about not finding nroff in the first place.

@faho faho merged commit f553ced into fish-shell:master Jan 8, 2019
Copy link

faho commented Jan 8, 2019

Merged, thanks!

@McKayJT McKayJT deleted the mandoc-print-help branch January 9, 2019 02:03
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 17, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
None yet

Successfully merging this pull request may close these issues.

None yet

2 participants