From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Howard Melman Newsgroups: gmane.emacs.devel Subject: Re: Proposal for an improved `help-for-help' Date: Sun, 21 Feb 2021 14:27:17 -0500 Message-ID: References: Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="5105"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.1 (darwin) To: emacs-devel@gnu.org Cancel-Lock: sha1:0WD+GvU7TJwduVElYhB9hrZ1mxU= Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Feb 21 20:29:55 2021 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1lDuQU-0001Ej-4p for ged-emacs-devel@m.gmane-mx.org; Sun, 21 Feb 2021 20:29:54 +0100 Original-Received: from localhost ([::1]:44378 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lDuQT-0003jO-0M for ged-emacs-devel@m.gmane-mx.org; Sun, 21 Feb 2021 14:29:53 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:56678) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lDuOC-00031o-RU for emacs-devel@gnu.org; Sun, 21 Feb 2021 14:27:33 -0500 Original-Received: from ciao.gmane.io ([116.202.254.214]:56514) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lDuO8-0000DR-Nr for emacs-devel@gnu.org; Sun, 21 Feb 2021 14:27:31 -0500 Original-Received: from list by ciao.gmane.io with local (Exim 4.92) (envelope-from ) id 1lDuO5-0008va-5W for emacs-devel@gnu.org; Sun, 21 Feb 2021 20:27:25 +0100 X-Injected-Via-Gmane: http://gmane.org/ Received-SPF: pass client-ip=116.202.254.214; envelope-from=ged-emacs-devel@m.gmane-mx.org; helo=ciao.gmane.io X-Spam_score_int: 5 X-Spam_score: 0.5 X-Spam_bar: / X-Spam_report: (0.5 / 5.0 requ) BAYES_00=-1.9, DKIM_ADSP_CUSTOM_MED=0.001, FORGED_GMAIL_RCVD=1, FREEMAIL_FORGED_FROMDOMAIN=0.249, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.249, NML_ADSP_CUSTOM_MED=0.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:265432 Archived-At: Stefan Kangas writes: > I have attached a rough draft for what an improved version of might look > like. It would be great to get some feedback. I think this is a good improvement. I'd like to see some of the help text normalized to be more consistent. Here's an attempt at that, though it could us another pass too. Basic Help m Display documentation of current major and minor modes and their commands. x COMMAND Display documentation of the command. k KEYS Display documentation of the key sequence. f FUNCTION Display documentation of the function. v VARIABLE Display documentation and value of the variable. o SYMBOL Display documentation and value of the function or variable. c KEYS Display the command name bound to the key sequence. b Display all bindings of commands to keys. w COMMAND Display which keys are bound to the command. . Display any available local help at point. Documentation t Start the Emacs learn-by-doing tutorial. r Show the Emacs manual in Info mode. F COMMAND Show the Emacs manual's section for the command. K KEYS Show the Emacs manual's section for the command bound to KEYS. i Show the Info documentation reader listing all available manuals. S SYMBOL Show the section of the relevant Info manual for the symbol. SEARCHING AND PACKAGES a PATTERN Show commands whose name matches the PATTERN (a list of words or a regexp). See also the `apropos' command. d PATTERN Show a list of functions, variables, and other items whose documentation matches the PATTERN (a list of words or a regexp). P PACKAGE Describe the given Emacs Lisp package. p TOPIC Find packages matching a given topic keyword. OTHER e Go to the *Messages* buffer which logs echo-area messages. l Show last 300 input keystrokes (lossage). C CODING Describe the given coding system, or RET for current ones. I METHOD Describe a specific input method, or RET for current. L LANG-ENV Describes a specific language environment, or RET for current. s Display contents of current syntax table, plus explanations. g Display information about the GNU project. n Display news of recent Emacs changes. h Display the HELLO file which illustrates various scripts. C-a Information about Emacs. C-c Emacs copying permission (GNU General Public License). C-d Instructions for debugging GNU Emacs. C-e External packages and information about Emacs. C-f Emacs FAQ. C-m How to order printed Emacs manuals. C-n News of recent Emacs changes. C-o Emacs ordering and distribution information. C-p Info about known Emacs problems. C-s Search forward \"help window\". C-t Emacs TODO list. C-w Information on absence of warranty for GNU Emacs." -- Howard