man(1) clarify searching + minor nits #1438
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
concussious
force-pushed
the
man.1
branch
2 times, most recently
from
7464aa7
to
5f1b617
Compare
|
I think these changes should be sensible and non-controversial, but perhaps controversially I'd love to:
|
concussious
changed the title
concussious
force-pushed
the
man.1
branch
3 times, most recently
from
6eba44e
to
78e96d0
Compare
elliejs
approved these changes
Sep 30, 2024
| echo ' [-m arch[:machine]] [-p [eprtv]] [mansect] page [...]' | ||
| echo ' man -f page [...] -- Emulates whatis(1)' | ||
| echo ' man -k page [...] -- Emulates apropos(1)' | ||
| echo ' man -K | -f | -k expression [...] -- Search manual pages' |
There was a problem hiding this comment.
Is there any chance 'expression' is confusing and should be 'regexp' ? either are better than 'page', that's for sure.
There was a problem hiding this comment.
I agree that regexp is less ambiguous for people new to unix, but the term expression is elegant and used in all the rest of the manual manuals like apropos. Also, man -k expression does show re_format(7) - POSIX 1003.2 regular expressions.
|
Thanks for the review! I worked egrep back into -K description. |
People are often stunned by robust manual search functionality on the community discord, so attempt to tidy doc regarding search by: + consolidate and standardize search options in synopsis and usage + call regular expressions `expression` like other manual pages + explain what search related flags do instead of using similies + crossreference the regular expression manual instead of egrep(1) While here, polish and wax: + use consistent spacing and form (Ql) for quoted literals + clean a few linter errors regarding self xref and nospace + tidy examples + align files + tag spdx Notes on currently outstanding issues: - man.1 example 3 is confusing, and shows no results on my boxen - logic preventing -Kk from being used together isn't working MFC after: 3 days
bsdimp
reviewed
Oct 4, 2024
|
this may need other changes, but can we not change whitespace on the man pages. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Attempt to clarify search while maintaining terseness. Inspired by conversations on community discord!
Unresolved:
man -Kk, seems to start around line 600) is not working on CURRENT. I tried playing with it but I don't understand it enough yet.Cc @tetlowgm