freebsd-src icon indicating copy to clipboard operation
freebsd-src copied to clipboard

man(1) clarify searching + minor nits

Open concussious opened this issue 1 year ago • 3 comments

Attempt to clarify search while maintaining terseness. Inspired by conversations on community discord!

Unresolved:

  1. I'm having trouble understanding example 3, it doesn't find anything on my sparse but inhabited boxen.
  2. logic preventing incompatible flags from being used together (e.g. 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

concussious avatar Sep 28 '24 04:09 concussious

I think these changes should be sensible and non-controversial, but perhaps controversially I'd love to:

  1. Use A a B b sorting like other manuals
  2. s/online/local/. Online is traditional language since ancient times, and I feel tenderly about that, but I'm concerned that nobody who didn't already know knows what that means.

concussious avatar Sep 28 '24 20:09 concussious

Thanks for the review! I worked egrep back into -K description.

concussious avatar Oct 01 '24 01:10 concussious

this may need other changes, but can we not change whitespace on the man pages.

bsdimp avatar Oct 04 '24 18:10 bsdimp

I think this would be a major positive feature for 14.2. This is the introduction to manual pages, and the current explanations for the search features are only useful for people who already know what they mean.

concussious avatar Nov 04 '24 22:11 concussious

Last push removes prompts from examples for triple click copy/paste. Subsequent pushes just tweaking commit message.

concussious avatar Nov 04 '24 22:11 concussious

~~Jose told me he will not approve this or withdraw his objection now that everything he complained about was either his mistake reviewing or resolved. He said he was "commenting" and not "reviewing". Therefore, if it's okay, I don't want his name on the reviewed by trailer for this commit. We have a precedent of doing this already.~~

concussious avatar Nov 14 '24 16:11 concussious

From a sincere place of caring, and with respect and reverence, I would like to humbly ask the masters to consider that this bikeshed is, in fact, 15% better than what I originally proposed. However, I had a watertight, painted bikeshed ready before the code slush, and now new users will be piling their bikes in the rain until June 2025, and complaining to me about it, and that hurts my feelings.

You guys taught me everything, I am not going anywhere, but I am hurt. This negatively impacts me as the Manual Pages Mentor on the community discord. This negatively effects the perception of BSD doc culture when I am busy working, and new users ask how manual page search works (because emulates $unixtool is not an explanation), and someone else answers incorrectly before I have time to take care of it.

This is about showing new users that structured, carefully considered information written by competent passionate people is more accessible than asking chatgpt to hallucinate disinformation at the cost of 2.9 WH per query.

concussious avatar Nov 15 '24 17:11 concussious

@concussious commented: Jose told me he will not approve this or withdraw his objection now that everything he complained about was either his mistake reviewing or resolved. He said he was "commenting" and not "reviewing". Therefore, if it's okay, I don't want his name on the reviewed by trailer for this commit. We have a precedent of doing this already.

For completeness, I agree with the proposed changes, the way they are at this point in time, therefore "withdrawing" my objections. However, the rest of the statement above still holds true.

jlduran avatar Nov 15 '24 17:11 jlduran

Yes! Thank you!

concussious avatar Jan 24 '25 23:01 concussious