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

manuals: improve apropos {console, keyboard} #1275

Merged
merged 2 commits into from
Jul 7, 2024

Conversation

concussious
Copy link
Contributor

@concussious concussious commented Jun 4, 2024

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.

.Dt KBDCONTROL 1
.Os
.Sh NAME
.Nm kbdcontrol
.Nd keyboard control and configuration utility
.Nd system video console (vt) keyboard control/configuration utility
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

still works with sc too... though maybe it's ok we just have this since sc is deprecated.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think leaving sc or vt out of the description is sensible here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That solves the regression.

.Dt KBDMAP 1
.Os
.Sh NAME
.Nm kbdmap ,
.Nm vidfont
.Nd front end for syscons and vt
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

syscons is sc and that's what's deprecated, but with an uncertain future.

@bsdimp bsdimp added the man-only label Jun 4, 2024
@emaste
Copy link
Member

emaste commented Jun 4, 2024

AIUI for man page changes which do not change meaning the .Dd doesn't need to be bumped -- e.g. a typo fix, minor clarification etc.

@concussious
Copy link
Contributor Author

concussious commented Jun 4, 2024

AIUI for man page changes which do not change meaning the .Dd doesn't need to be bumped -- e.g. a typo fix, minor clarification etc.

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 concussious force-pushed the apropos.console branch 2 times, most recently from c054345 to 6727dcc Compare June 7, 2024 08:04
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
@freebsd-git freebsd-git merged commit de2ab11 into freebsd:main Jul 7, 2024
7 of 9 checks passed
freebsd-git pushed a commit that referenced this pull request Jul 20, 2024
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:	#1275

(cherry picked from commit 580dc18)
freebsd-git pushed a commit that referenced this pull request Jul 20, 2024
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:	#1275

(cherry picked from commit de2ab11)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants