From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Marcin Borkowski Newsgroups: gmane.emacs.help Subject: Best way to get hang of an elisp file? Date: Fri, 18 Oct 2013 18:52:32 +0200 Organization: WMI UAM Message-ID: <20131018185232.2084581e@aga-netbook> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1382115175 15756 80.91.229.3 (18 Oct 2013 16:52:55 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 18 Oct 2013 16:52:55 +0000 (UTC) To: GNU Emacs users list Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Fri Oct 18 18:53:01 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 1VXDIF-0002wi-IP for geh-help-gnu-emacs@m.gmane.org; Fri, 18 Oct 2013 18:52:55 +0200 Original-Received: from localhost ([::1]:58762 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VXDIF-0003Ei-8d for geh-help-gnu-emacs@m.gmane.org; Fri, 18 Oct 2013 12:52:55 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:56390) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VXDI1-0003EJ-CR for help-gnu-emacs@gnu.org; Fri, 18 Oct 2013 12:52:45 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VXDHw-00033W-Hq for help-gnu-emacs@gnu.org; Fri, 18 Oct 2013 12:52:41 -0400 Original-Received: from msg.wmi.amu.edu.pl ([2001:808:114:2::50]:47800) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VXDHw-000338-AM for help-gnu-emacs@gnu.org; Fri, 18 Oct 2013 12:52:36 -0400 Original-Received: from localhost (localhost [127.0.0.1]) by msg.wmi.amu.edu.pl (Postfix) with ESMTP id 0877D4E1FD for ; Fri, 18 Oct 2013 18:52:35 +0200 (CEST) Original-Received: from msg.wmi.amu.edu.pl ([127.0.0.1]) by localhost (msg.wmi.amu.edu.pl [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id fwMN1a0QGYU3 for ; Fri, 18 Oct 2013 18:52:34 +0200 (CEST) Original-Received: from aga-netbook (99-52.echostar.pl [213.156.99.52]) by msg.wmi.amu.edu.pl (Postfix) with ESMTPSA id B51504E1F8 for ; Fri, 18 Oct 2013 18:52:34 +0200 (CEST) X-Mailer: Claws Mail 3.8.1 (GTK+ 2.24.17; i686-pc-linux-gnu) X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2001:808:114:2::50 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:94086 Archived-At: Hi all, I'd like to look at AUCTeX sources. This means that I have a rather large elisp file, and I'd like to skim through it. Since I want to know more or less /what/ functions, variables etc. there are and what they /do/ instead of how they are implemented, I'm curious whether there exists something like "outline mode", hiding everything but the signature of a function and its docstring etc. (Or better yet, generating a file with everything but signatures and docstrings etc. deleted.) Or is there any other way to accomplish my goal? I know that there are tags etc., but this is not what I want: I'd prefer to skim through the file /sequentially/, just to learn what's in there, I'm not interested in jumping to a function whose name I know - since I don't know these names, and I want to learn them. I also know that I can navigate through sexps, and probably jumping "to the end of the outermost sexp" could be easy. But I don't want to limit myself to Emacs when reading the file: my workflow would be to transfer it to an ebook reader (I spend more than one hour commuting almost every day, you know;)). (Of course, in this case hiding won't help.) I am also aware that there exists a Perl script doing exactly this (http://cpansearch.perl.org/src/DOOM/Emacs-Run-ExtractDocs-0.03/lib/Emacs/Run/ExtractDocs.pm), but for some strange reason I get the feeling that using Perl to manipulate Elisp sources is... strange at least. Any hints? (If not, I'll try to implement something like this myself.) -- Marcin Borkowski http://octd.wmi.amu.edu.pl/en/Marcin_Borkowski Adam Mickiewicz University