From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.help Subject: RE: Best way to get hang of an elisp file? Date: Fri, 18 Oct 2013 14:42:53 -0700 (PDT) Message-ID: <62c5f353-d6a1-4c91-8057-88c7d11bbc49@default> References: <20131018185232.2084581e@aga-netbook> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1382132602 30690 80.91.229.3 (18 Oct 2013 21:43:22 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 18 Oct 2013 21:43:22 +0000 (UTC) To: Marcin Borkowski , GNU Emacs users list Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Fri Oct 18 23:43:24 2013 Return-path: Envelope-to: geh-help-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1VXHpM-0004t9-5f for geh-help-gnu-emacs@m.gmane.org; Fri, 18 Oct 2013 23:43:24 +0200 Original-Received: from localhost ([::1]:59469 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VXHpL-0001Ay-Qt for geh-help-gnu-emacs@m.gmane.org; Fri, 18 Oct 2013 17:43:23 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:56121) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VXHp4-0001Ar-58 for help-gnu-emacs@gnu.org; Fri, 18 Oct 2013 17:43:13 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VXHov-0000Ec-Eg for help-gnu-emacs@gnu.org; Fri, 18 Oct 2013 17:43:06 -0400 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:41112) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VXHov-0000EP-8Z for help-gnu-emacs@gnu.org; Fri, 18 Oct 2013 17:42:57 -0400 Original-Received: from ucsinet21.oracle.com (ucsinet21.oracle.com [156.151.31.93]) by aserp1040.oracle.com (Sentrion-MTA-4.3.1/Sentrion-MTA-4.3.1) with ESMTP id r9ILgthV032192 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Fri, 18 Oct 2013 21:42:56 GMT Original-Received: from userz7022.oracle.com (userz7022.oracle.com [156.151.31.86]) by ucsinet21.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r9ILgs0B018656 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Fri, 18 Oct 2013 21:42:54 GMT Original-Received: from abhmt120.oracle.com (abhmt120.oracle.com [141.146.116.72]) by userz7022.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r9ILgrFD006736; Fri, 18 Oct 2013 21:42:54 GMT In-Reply-To: <20131018185232.2084581e@aga-netbook> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8 (707110) [OL 12.0.6680.5000 (x86)] X-Source-IP: ucsinet21.oracle.com [156.151.31.93] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-Received-From: 141.146.126.69 X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Original-Sender: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.help:94089 Archived-At: > I have a rather large elisp file, and I'd like to skim through it. > I want to know more or less /what/ functions, variables etc. there > are and what they /do/ instead of how they are implemented ... > But I don't want to limit myself to Emacs when reading the file I don't have an answer for use outside Emacs. But this can help in Emacs: In Icicle minor mode, `C-=3D' is by default `icicle-imenu'. It is a multi-command that uses Imenu definition-recognizing regexps. It lets you navigate among definitions (of functions, vars, macros, etc., depending on the language). You can use pattern matching, sorting, and cycling. But you can also ask for information about any definitions by hitting one of the help keys during completion: `C-M-RET' (help on the current definition), `C-M-down' (cycle to the next definition and show its help), `C-M-mouse-2' (help on the definition clicked in buffer *Completions*), etc. The help for a given definition is shown in buffer *Help*. In the case of Emacs things it is just what you would see using `C-h f', `C-h v', `decribe-face', etc.: help on the particular Emacs-Lisp object. So you have three levels of information (3 lists) for such objects: (1) their names, (2) their descriptions (help), and (3) their definitions. [There are also Icicles imenu commands for particular kinds of things, e.g., `icicle-imenu-command', `icicle-imenu-user-option', etc. There are also "full" versions of each of these commands. The full versions use the whole definitions (e.g. whole defuns) as search contexts - you can either navigate among them, as usual, or search them and navigate among specific search hits.] * http://www.emacswiki.org/Icicles_-_Search_Commands%2c_Overview * http://www.emacswiki.org/Icicles_-_Other_Search_Commands#IciclesImenu