Problems of Emacs's “man” Command

By Xah Lee. Date:

Emacs has a “man” command. Its purpose is for display unix documentation called “man page”. However, it does not do syntax coloring. Emacs has a alternative command called “woman” that does do syntax coloring. However, there are some major usability problems for “woman”. (emacs's “man” is a elisp wrapper that calls the unix “man” utility. “woman” is written in elisp entirely.)

• Alias “man” to “woman” ((defalias 'man 'woman)) doesn't work. When you call M-x man, it still invoke “man”.

• When calling “woman”, it takes some 3 secs to start up. In contrast, “man” starts right away without this delay. (The mini buffer message is: “Building list of manual directory expansions...”, “Building completion list of all manual topics...”)

• Often “woman” will prompt me to make a choice among man pages of the same name found in different man paths. Very annoying. From my experiences in unix using in the past 10 years, maybe only once a year that “man” didn't make the right choice.

• Another flaw, perhaps reasonable, is that “woman” does not work for some “man” pages. For example, type 【Alt+x woman Enter killall】, on OS X 10.4.x, and the display returned start with:

.Dd June 25, 1995
.Os
.Dt KILLALL 1
.Sh NAME
.Nm killall

Suggestion

Emacs should fix the above problems. And, perhaps alias “man” to “woman” by default. The goal is that emacs simply provides a command to read unix manual pages, without user having to know the tech details about “man” and “woman”. When “woman” detects a man page in a format it cannot read, automatically launch “man” instead.


Eli Zaretskii wrote:

The problems you mention are a far cry from making WoMan “unusable”.

“unusable” is probably a exaggeration. I'm trying to express how it is unusable to most users who are not emacs enthusiasts.

Consider emacs as a tool. Emacs “man” and “woman” are tools too. People want to run man/woman to get the job done, namely, reading unix man page in emacs. “man” works. “woman” is apparently a improvement, but why isn't it the default? The extra options and configuration adds a burden to the users. Worse is that “woman” itself isn't polished software. So for some emacs user who are beginning to be adventurous, when they read about “woman” and try it, they end up 5 minutes, 10 minutes, 20, or more about the tool itself instead of getting the jobs done.

Each thing individually are trivial problems, but emacs with so many unusual streaks, terminologies, non-standard keyboard shortcut notation, unusual undo/redo scheme, configurations etc, earns emacs the steep learning curve and drive away most professional programers.

I think most, or all of these can be fixed, without sacrificing ANY of emacs's power.

Back to the particular case of “woman” … for example, i think that:

• Man and “woman” should be merged, in the sense that user are taught one single command “man” to read unix manual page. This can possibly be done by aliasing man to “woman”, and:

• The onset delay of “woman” can certainly be minimized, perhaps by looking into ways to optimize, cache, or done after the first call of “woman”, in the background. (example: when user is not typing actively) (so that, at the second call of “woman” in a session, name completion feature is there, transparently) Here, i think caching it under ~/.emacs.d/ is probably a very good solution.

• When “woman” detect a page it cannot read, launch man.

• Eliminate the fact that “woman” prompt user to make a choice. (which i think this thread's patch fixes)

http://lists.gnu.org/archive/html/emacs-devel/2009-03/msg00186.html.

Addendum: Emacs 24.3 will have syntax coloring in man page. Thanks to boostjam for the tip.

Emacs Modernization

  1. Simple Changes Emacs Should Adopt
  2. Why Emacs Keys are Painful
  3. Problems of the Scratch Buffer
  4. M-key Notation vs Alt+key Notation
  5. Menu Problem
  6. Mode Line Problem
  7. cua-mode Problems
  8. kill-buffer Induces Buffer Accumulation
  9. Emacs Form Feed ^L
  10. Inconsistency of Search Features
  11. Single Key to Delete Whole Line
  12. Emacs HTML Mode Sucks
  13. Emacs Does Not Support Viewing Images Files In Windows
  14. Emacs Spell Checker Problems
  15. Adopt HTML as Texinfo Replacement
  16. Support HTML Mail
  17. Problems of “man” Command
  18. Emacs Lisp Mode Syntax Coloring Problem
  19. Emacs Ahk Mode Problems
  20. Problems of Emacs's Manual
  21. Problems of Emacs's Manual; Examples
  22. Emacs: Have You Read Emacs Manual?
  23. Elisp: Ban Syntax Table
  24. Emacs: Make elisp-index-search use Current Symbol
  25. Emacs: Usability Problems of Mode Documentation
  26. Problems of Emacswiki
  27. Emacs GNU Texinfo Problems; Invalid HTML
  28. A Record of Frustration in IT Industry; Disappearing FSF URLs, 2006
  29. Emacs Manual Node Persistency Issues
  30. Emacs: dired-do-query-replace-regex Replace ALL (fixed)
  31. Problems of Emacs Supporting Obsolete Systems
  32. Elisp: Function to Copy/Delete a Dir Recursively (fixed)
  33. Thoughts on Common Lisp Scheme Lisp Based Emacs
  34. Text Editors Popularity and Market Research
  35. Text Editor's Cursor Movement Behavior (emacs, vi, Notepad++)
  36. GNU Emacs Development Inefficiency
  37. Emacs Dev Inefficiency and Emacs Web 2.0?
  38. Letter-Case Commands Usability Problems
  39. Emacs: Select Line, between Quotes, Extend Selection
  40. Emacs: isearch Current Word
  41. Suggestions on Line Wrap Commands
  42. Emacs: Single Key to Delete Whole Line
  43. Emacs Cult Problem: Emacs vs Windows Notepad
  44. Emacs Undo and Emacs Cult Problem

If you have a question, put $5 at patreon and message me.
Or Buy Xah Emacs Tutorial
Or buy a nice keyboard: Best Keyboards for Emacs

Emacs

Emacs Lisp

Misc