manuals: improve apropos {console, keyboard} #1275
Conversation
usr.sbin/kbdcontrol/kbdcontrol.1
Outdated
| .Dt KBDCONTROL 1 | ||
| .Os | ||
| .Sh NAME | ||
| .Nm kbdcontrol | ||
| .Nd keyboard control and configuration utility | ||
| .Nd system video console (vt) keyboard control/configuration utility |
There was a problem hiding this comment.
still works with sc too... though maybe it's ok we just have this since sc is deprecated.
There was a problem hiding this comment.
That's what I was thinking. sc does have at least one really cool feature we don't have in vt, screensavers. I work around it with a script that does lock -npv and cmatrix, but cmatrix is extremely bloated and not reviewing patches.
There was a problem hiding this comment.
I think leaving sc or vt out of the description is sensible here.
There was a problem hiding this comment.
That solves the regression.
| .Dt KBDMAP 1 | ||
| .Os | ||
| .Sh NAME | ||
| .Nm kbdmap , | ||
| .Nm vidfont | ||
| .Nd front end for syscons and vt |
There was a problem hiding this comment.
syscons is sc and that's what's deprecated, but with an uncertain future.
|
AIUI for man page changes which do not change meaning the |
I usually don't, and actually prefer not to on some of these really old pages because they still talk about sc like it isn't deprecated, and even put not to in CONTRIBUTING, but last time Warner said Nd change bumps it, and I don't want to be bad and make him do it for me or groan to see my PR. Edit: I'm absolutely happy to do it either way, I want to be doing it correctly and be a blessing here. |
concussious
force-pushed
the
apropos.console
branch
2 times, most recently
from
c054345
to
6727dcc
Compare
Update the man page descriptions so that apropos {console,keyboard}
finds more relevant man pages.
MFC after: 3 days
Reviewed by: imp, emase
Pull Request: freebsd#1275
Update the man page descriptions so that apropos are more consistent for console related man pages. Motive: apropos results: clarify consistently MFC after: 3 days Reviewed by: emaste, imp Pull Request: freebsd#1275
Update the man page descriptions so that apropos {console,keyboard}
finds more relevant man pages.
MFC after: 3 days
Reviewed by: imp, emase
Pull Request: freebsd/freebsd-src#1275
Update the man page descriptions so that apropos are more consistent for console related man pages. Motive: apropos results: clarify consistently MFC after: 3 days Reviewed by: emaste, imp Pull Request: freebsd/freebsd-src#1275
I'm trying to make "apropos -s 1 keyboard" and "console" look nice and tell the console user what they're probably looking for, while distinguishing what they're not looking for (graphical environment tooling, serial console tooling, I dont know). Patches sent to freedesktop and libxkbcommon for that effect too. EDIT: all patches upstream accepted.
But, pointy hat to me: my proposed vidfont description is 81 characters. This wraps in man, which I think looks fine, but wraps in apropos, which looks horrible, on 80 char "standard console" including stock xterm; seems unacceptable regression. Ideas?I don't know how it is on other people's boxen but in my house terminus bsd console (vt) is 85 char wide and is unaffected by this proposed regression.