Page MenuHomeFreeBSD

handbook/x11: refactor
Needs ReviewPublic

Authored by concussious.bugzilla_runbox.com on Aug 9 2024, 12:50 AM.
Referenced Files
Unknown Object (File)
Sat, Sep 21, 5:19 AM
Unknown Object (File)
Fri, Sep 20, 7:43 PM
Unknown Object (File)
Fri, Sep 20, 2:00 PM
Unknown Object (File)
Tue, Sep 17, 12:58 AM
Unknown Object (File)
Mon, Sep 16, 11:46 AM
Unknown Object (File)
Sat, Sep 14, 9:52 AM
Unknown Object (File)
Mon, Sep 9, 4:00 AM
Unknown Object (File)
Sun, Sep 8, 2:38 PM
Subscribers

Details

Reviewers
None
Group Reviewers
Doc Committers
doceng
docs
x11
Summary

This chapter is has been getting neglected. Shame, because this is very stable and now that linux has moved to Wayland, upstream has become very agreeable to supporting us. Further, X11 is much lighter and more responsive than equivalent Wayland setups that I've seen. Here is a draft attempting to fix this chapter. Rough changelog:

Graphics

+ drivers logically come first, and explain why we have to install them
+ intel graphics is not always integrated and not always cards
+ clarify whats the vaapi driver package

Xorg
+ disambiguate Xorg server/X Window System
+ xorg-ins should directly precede xorg-cfg
+ try to tersely explain why at more points
+ autoconfiguration should not be a warning in a previous chapter,
  it needs to be part of the introduction to configuration
+ explain why we have xf86-input drivers, there are good use cases for them

Fonts
+ sort and sync fonts intro
+ truetype fonts are what most users are looking for, for screens.
+ postscript fonts are specialized for typography, for printing.
+ therefore, move truetype first, and explain the difference.

Pointy hat for whoever removed XDM:
- XDM Just Works (every single time)
- it is the lightest solution
- it is cfg'd in a very traditional manner consistent with xterm
- there is a massive trove of info and example cfg
- it has literally been stable for generations
- no X11 DM has been left here in it's space!
- forgetting to take it out of the synopsis makes everything look crusty

Outstanding:
+ the fonts section really needs more love. I don't like removing information, but this has become very simple for the user. Just drop the font in .fonts, done.
+ I think the xorg configuration section could possibly say something guiding people to the desktops section.
+ ...the whole thing could still be a little clearer.

If this is acceptable, please set the author appropriately (git commit --amend --author="Alexander Ziaee <concussious@runbox.com>" --no-edit) I am a struggling young man without the weight of a degree trying to make it out here. If the authorship is reflected accurately, it shows on Github in my activity.

Test Plan

Proofread PDF located at doc/documentation/public/en/books/handbook/handbook_en.pdf generated with make pdf-books DOC_LANG="en" HUGO_ARGS="--verbose --debug".

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

Removed duplicated warning after testing and proofreading.

Found a few straggler typos, sorry for the noise.

concussious.bugzilla_runbox.com edited the summary of this revision. (Show Details)
concussious.bugzilla_runbox.com edited the test plan for this revision. (Show Details)

Additional attempting to clarify more of the instructions. It's still WIP, but appreciate any general feedback.
Thanks @bcr for showing me the testing instructions! Proofreading the rendered output is massively easier!

Next revision will include increased detail about fonts and configuring touchpads with libinput, however I am really hoping to fix this problem at what I perceive to be the root with upstream manpage.

Some language and typo fixes.

documentation/content/en/books/handbook/x11/_index.adoc
72

s/so this is/which is why/

219

s/accellerator/accelerator/

291

s/to video group/to the video group/

617

s/breif/brief/