[Docutils-develop] [docutils:bugs] Re: #481 manpage: please stop converting text to full capitals

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

but .TH and .SH parameters are uppercase still ?

On Wed, 27 Mar 2024 at 02:12, G. Branden Robinson
<br...@us...> wrote:
>
> ________________________________
>
> [bugs:#481] manpage: please stop converting text to full capitals
>
> Status: open
> Created: Wed Mar 27, 2024 01:12 AM UTC by G. Branden Robinson
> Last Updated: Wed Mar 27, 2024 01:12 AM UTC
> Owner: nobody
>
> mandoc maintainer Ingo Schwarze and I (groff lead developer) reached a consensus a few years ago that man pages should stop shouting. This is a historical artifact of practices at Bell Labs in the 1970s.
>
> It also can, reportedly, create accessibility problems, since a screen reader may pronounce words in FULL CAPS letter by letter instead of reading them as words. (The KDE screen reader I tried with a PDF didn't do this.)
>
> In groff 1.23.0, this behavior is configurable, and the user can turn the full-caps conversion on at rendering time. With man-db, these options can be passed in via the MANROFFOPT environment variable.
>
>      -rCS=1   Set section headings (the argument(s) to .SH) in full
>               capitals.  This transformation is off by default because
>               it discards case distinction information.
>
>      -rCT=1   Set the man page identifier (the first argument to .TH) in
>               full capitals in headers and footers.  This transformation
>               is off by default because it discards case distinction
>               information.
>
> ________________________________
>
> Sent from sourceforge.net because you indicated interest in https://sourceforge.net/p/docutils/bugs/481/
>
> To unsubscribe from further messages, please visit https://sourceforge.net/auth/subscriptions/

---

**[bugs:#481] manpage: please stop converting text to full capitals**

**Status:** open
**Created:** Wed Mar 27, 2024 01:12 AM UTC by G. Branden Robinson
**Last Updated:** Wed Mar 27, 2024 01:12 AM UTC
**Owner:** nobody

*mandoc* maintainer Ingo Schwarze and I (*groff* lead developer) reached a consensus a few years ago that man pages should stop shouting.  This is a historical artifact of practices at Bell Labs in the 1970s.

It also can, reportedly, create accessibility problems, since a screen reader may pronounce words in FULL CAPS letter by letter instead of reading them as words.  (The KDE screen reader I tried with a PDF didn't do this.)

In _groff_ 1.23.0, this behavior is configurable, and the user can turn the full-caps conversion on at rendering time.  With _man-db_, these options can be passed in via the ``MANROFFOPT`` environment variable.

~~~
     -rCS=1   Set section headings (the argument(s) to .SH) in full
              capitals.  This transformation is off by default because
              it discards case distinction information.

     -rCT=1   Set the man page identifier (the first argument to .TH) in
              full capitals in headers and footers.  This transformation
              is off by default because it discards case distinction
              information.
~~~

---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.