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

Include info on how to get the man page #841

Closed
ferhtgoldaraz opened this issue Feb 28, 2018 · 5 comments
Closed

Include info on how to get the man page #841

ferhtgoldaraz opened this issue Feb 28, 2018 · 5 comments
Labels
doc An issue with or an improvement to documentation. invalid An issue that is not actually a bug or a feature that already exists.

Comments

@ferhtgoldaraz
Copy link

Info on how to build the man page would be a good improvement over the already very complete readme. Maybe also mention the install methods that include it (for example the .deb doesn't seem to install it).

I use this command in mac (installed through brew) and the man page is a godsend.

Once I figure that out maybe I'll make a pull request :)

@BurntSushi
Copy link
Owner

I think this FAQ item might answer most of your question?

The deb really should include the man page. In fact, every distro package should include the man page. The deb is under my control, but truthfully, I generate it via the cargo deb tool, and I'm not sure anyone has taught it about man pages yet. I don't have the bandwidth to wade into Debian packaging territory, so it's basically up to someone else at this point.

@BurntSushi
Copy link
Owner

BurntSushi commented Feb 28, 2018

(Also, rg --help is very nearly the same as the contents of the man page. At least, all of the flags are documented using precisely the same text. The man page does contain some additional prose for other sections like config knobs, shell completions and the like. Also, rg -h shows a much more condensed view.)

@ferhtgoldaraz
Copy link
Author

Perfect, I'm in the process of building from source now. I imagine we can close this.

@ferhtgoldaraz
Copy link
Author

ferhtgoldaraz commented Feb 28, 2018

(maybe open some issue for the deb and a help wanted tag or somethting, I'm not even a newbie regarding deb packaging)

@BurntSushi
Copy link
Owner

@ferhtgoldaraz Great! Good idea. Done: #842

@BurntSushi BurntSushi added invalid An issue that is not actually a bug or a feature that already exists. doc An issue with or an improvement to documentation. labels Feb 28, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc An issue with or an improvement to documentation. invalid An issue that is not actually a bug or a feature that already exists.
Projects
None yet
Development

No branches or pull requests

2 participants