From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: martin rudalics Newsgroups: gmane.emacs.devel Subject: help-for-help Date: Thu, 08 Jun 2006 15:19:57 +0200 Message-ID: NNTP-Posting-Host: main.gmane.org X-Trace: sea.gmane.org 1149772764 13315 80.91.229.2 (8 Jun 2006 13:19:24 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Thu, 8 Jun 2006 13:19:24 +0000 (UTC) Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Thu Jun 08 15:19:19 2006 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1FoKPe-0001tx-V7 for ged-emacs-devel@m.gmane.org; Thu, 08 Jun 2006 15:19:03 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1FoKPe-0003C8-9j for ged-emacs-devel@m.gmane.org; Thu, 08 Jun 2006 09:19:02 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1FoKPQ-0003B7-Fk for emacs-devel@gnu.org; Thu, 08 Jun 2006 09:18:48 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1FoKPO-00039H-JO for emacs-devel@gnu.org; Thu, 08 Jun 2006 09:18:48 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1FoKPO-000396-AF for emacs-devel@gnu.org; Thu, 08 Jun 2006 09:18:46 -0400 Original-Received: from [213.165.64.20] (helo=mail.gmx.net) by monty-python.gnu.org with smtp (Exim 4.52) id 1FoKXD-0006pn-DS for emacs-devel@gnu.org; Thu, 08 Jun 2006 09:26:51 -0400 Original-Received: (qmail invoked by alias); 08 Jun 2006 13:18:43 -0000 Original-Received: from N860P016.adsl.highway.telekom.at (EHLO MACHNO) [62.47.51.112] by mail.gmx.net (mp039) with SMTP; 08 Jun 2006 15:18:43 +0200 X-Authenticated: #14592706 Original-To: emacs-devel@gnu.org X-Y-GMX-Trusted: 0 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:55772 Archived-At: `help-for-help-internal' - some naive remarks: a command-apropos. Give a list of words or a regexp, to get a list of commands whose names match. See also the apropos command. "list of commands whose names match" is ambiguous. I'd prefer "Give a pattern (a list of words or a regexp), to get a list of commands whose names match that pattern." just as for the "d" option. How can I "see" the apropos command from here? What's the purpose of the extra spaces around "apropos"? c describe-key-briefly. Type a command key sequence; it prints the function name that sequence runs. What is a "command key sequence", what am I expected to type? Does a sequence run a "function name"? d apropos-documentation. Give a pattern (a list or words or a regexp), and see a list of functions, variables, and other items whose built-in doucmentation string matches that pattern. See also the apropos command. "list or words" should be probably "list of words". "doucmentation" should be "documentation". e view-echo-area-messages. Show the buffer where the echo-area messages are stored. I think "View the log of recent echo-area messages" as in the doc-string is better. F Info-goto-emacs-command-node. Type a function name; it takes you to the on-line manual's section that describes the command. "function name" is wrong: `Info-goto-emacs-command-node' uses `commandp'. K Info-goto-emacs-key-command-node. Type a command key sequence; it takes you to the on-line manual's section that describes the command bound to that key. Insert a space after "K". S info-lookup-symbol. Display the definition of a specific symbol as found in the manual for the language this buffer is written in. The term "language" is ambiguous here (there's already an "L" option). Finally, clicking on a modeline after C-h C-h gets me things like help-for-help: Wrong type argument: commandp, 1 mouse-minibuffer-check: Wrong type argument: window-live-p, # which might be disconcerting (for the naive). Below find my proposal for `help-for-help-internal': (make-help-screen help-for-help-internal "a b c C e f F i I k C-k l L m p r s t v w C-c C-d C-f C-n C-p C-t C-w . or ? :" "You have typed %THIS-KEY%, the help character. Type a Help option: \(Use SPC or DEL to scroll through this text. Type \\\\[help-quit] to exit the Help command.) a command-apropos. Enter a pattern (a list of words or a regexp), to get a list of commands whose names match that pattern. b describe-bindings. Display table of all key bindings. c describe-key-briefly. Type a key sequence to get the name of the command bound to that sequence. C describe-coding-system. This describes either a specific coding system (if you type its name) or the coding systems currently in use (if you type just RET). d apropos-documentation. Give a pattern (a list of words or a regexp), and see a list of functions, variables, and other items whose built-in documentation strings match that pattern. e view-echo-area-messages. View log of messages that were recently displayed in the echo area. f describe-function. Type a function name and get its documentation. F Info-goto-emacs-command-node. Type the name of a command to view the section of the on-line manual describing that command. h Display the HELLO file which illustrates various scripts. i info. The Info documentation reader: read on-line manuals. I describe-input-method. Describe a specific input method (if you type its name) or the current input method (if you type just RET). k describe-key. Type a key sequence and get the full documentation for the command run by that sequence. K Info-goto-emacs-key-command-node. Type a key sequence to view the on-line manual's section describing the command bound to that sequence. l view-lossage. Show last 100 characters you typed. L describe-language-environment. This describes either a specific language environment (if you type its name) or the current language environment (if you type just RET). m describe-mode. Display documentation of current minor modes, and the current major mode, including their special commands. n view-emacs-news. Display news of recent Emacs changes. p finder-by-keyword. Find packages matching a given topic keyword. r info-emacs-manual. Display the Emacs manual in Info mode. s describe-syntax. Display contents of syntax table, plus explanations. S info-lookup-symbol. Display the definition of a specific symbol as found in the manual for the current major mode. t help-with-tutorial. Select the Emacs learn-by-doing tutorial. v describe-variable. Type name of a variable to display the variable's documentation and value. w where-is. Type command name to retrieve which keystrokes invoke that command. . display-local-help. Display any available local help at point in the echo area. C-c Display Emacs copying permission (GNU General Public License). C-d Display Emacs ordering information. C-e Display info about Emacs problems. C-f Display the Emacs FAQ. C-m Display how to order printed Emacs manuals. C-n Display news of recent Emacs changes. C-p Display information about the GNU project. C-t Display the Emacs TODO list. C-w Display information on absence of warranty for GNU Emacs." help-map)