From 88a3e54f92d1d19cb2c1580d5e46464d5ac2f7f0 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Mon, 6 Jan 2025 06:33:19 +0100 Subject: [PATCH] Improve Commentary in man.el * lisp/man.el (Commentary): Move "Features" above "Credits and History". The former is more likely to be relevant. (cherry picked from commit 1096d9afaa19799fade32ebada5b16add593511f) --- lisp/man.el | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/lisp/man.el b/lisp/man.el index 9cbc13f3893..25a4ccee897 100644 --- a/lisp/man.el +++ b/lisp/man.el @@ -1,7 +1,6 @@ ;;; man.el --- browse UNIX manual pages -*- lexical-binding: t -*- -;; Copyright (C) 1993-1994, 1996-1997, 2001-2025 Free Software -;; Foundation, Inc. +;; Copyright (C) 1993-2025 Free Software Foundation, Inc. ;; Author: Barry A. Warsaw ;; Maintainer: emacs-devel@gnu.org @@ -30,9 +29,22 @@ ;; can continue to use your Emacs while processing is going on. ;; ;; The mode also supports hypertext-like following of manual page SEE -;; ALSO references, and other features. See below or do `?' in a +;; ALSO references, and other features. See below or type `?' in a ;; manual page buffer for details. +;; ========== Features ========== +;; + Runs "man" in the background and pipes the results through a +;; series of sed and awk scripts so that all retrieving and cleaning +;; is done in the background. The cleaning commands are configurable. +;; + Syntax is the same as Un*x man +;; + Functionality is the same as Un*x man, including "man -k" and +;; "man
", etc. +;; + Provides a manual browsing mode with keybindings for traversing +;; the sections of a manpage, following references in the SEE ALSO +;; section, and more. +;; + Multiple manpages created with the same man command are put into +;; a narrowed buffer circular list. + ;; ========== Credits and History ========== ;; In mid 1991, several people posted some interesting improvements to ;; man.el from the standard Emacs 18.57 distribution. I liked many of @@ -59,19 +71,6 @@ ;; making it faster, more robust and more tolerant of different ;; systems' man idiosyncrasies. -;; ========== Features ========== -;; + Runs "man" in the background and pipes the results through a -;; series of sed and awk scripts so that all retrieving and cleaning -;; is done in the background. The cleaning commands are configurable. -;; + Syntax is the same as Un*x man -;; + Functionality is the same as Un*x man, including "man -k" and -;; "man
", etc. -;; + Provides a manual browsing mode with keybindings for traversing -;; the sections of a manpage, following references in the SEE ALSO -;; section, and more. -;; + Multiple manpages created with the same man command are put into -;; a narrowed buffer circular list. - ;; ============= TODO =========== ;; - Add a command for printing. ;; - The awk script deletes multiple blank lines. This behavior does -- 2.39.5