From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "T. V. Raman" Newsgroups: gmane.emacs.devel Subject: Re: Low-stress useful project Date: Sat, 12 Aug 2006 15:01:18 -0700 Message-ID: <17630.20398.743752.972505@localhost.localdomain> References: <001e01c6bde0$ead3c970$1501a8c0@kodama1> Reply-To: raman@users.sf.net NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit X-Trace: sea.gmane.org 1155420101 20789 80.91.229.2 (12 Aug 2006 22:01:41 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sat, 12 Aug 2006 22:01:41 +0000 (UTC) Cc: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Aug 13 00:01:39 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 1GC1Y3-0003Sf-9W for ged-emacs-devel@m.gmane.org; Sun, 13 Aug 2006 00:01:39 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1GC1Y2-0008H0-TG for ged-emacs-devel@m.gmane.org; Sat, 12 Aug 2006 18:01:38 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1GC1Xn-0008Fc-Q7 for emacs-devel@gnu.org; Sat, 12 Aug 2006 18:01:23 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1GC1Xm-0008ES-9T for emacs-devel@gnu.org; Sat, 12 Aug 2006 18:01:23 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1GC1Xl-0008EG-UB for emacs-devel@gnu.org; Sat, 12 Aug 2006 18:01:22 -0400 Original-Received: from [204.127.200.84] (helo=sccrmhc14.comcast.net) by monty-python.gnu.org with esmtp (Exim 4.52) id 1GC1dD-0003zg-BU for emacs-devel@gnu.org; Sat, 12 Aug 2006 18:06:59 -0400 Original-Received: from labrador (c-71-202-191-236.hsd1.ca.comcast.net[71.202.191.236]) by comcast.net (sccrmhc14) with ESMTP id <20060812220119014006o3che>; Sat, 12 Aug 2006 22:01:19 +0000 Original-Received: by labrador (Postfix, from userid 500) id F2578161C1B2; Sat, 12 Aug 2006 15:01:18 -0700 (PDT) Original-To: yoyu@tiara.ocn.ne.jp In-Reply-To: <001e01c6bde0$ead3c970$1501a8c0@kodama1> X-Mailer: VM 7.19 under Emacs 22.0.50.8 x-attribution: tvr 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:58342 Archived-At: For the emacspeak project, I eventually ended up writing code that extracts variable and function docs from the source code. This is *not* a replacement for a hand-written manual, but it is better than nothing. If there is interest I can contribute this to the Emacs distribution. >>>>> "Mikiya" == Mikiya Matsuzaka writes: Mikiya> Eshell.info has 'Function and Variable Index' Mikiya> section, but almost empty. This means we must read Mikiya> the source code to customize Eshell. Mikiya> Mikiya> I invoked grep command to list all interactive Mikiya> commands of eshell, and edited its output. The list Mikiya> follows. I hope somebody does the list of variables. Mikiya> Mikiya> Mikiya> ------------------------------------------------------------------------ Mikiya> Mikiya> (defun eshell (&optional arg) "Create an interactive Mikiya> Eshell buffer. The buffer used for Eshell sessions Mikiya> is determined by the value of `eshell-buffer-name'. Mikiya> If there is already an Eshell session active in that Mikiya> buffer, Emacs will simply switch to it. Otherwise, a Mikiya> new session will begin. A numeric prefix arg (as in Mikiya> `C-u 42 M-x eshell RET') switches to the session with Mikiya> that number, creating it if necessary. A nonnumeric Mikiya> prefix arg means to create a new session. Returns Mikiya> the buffer selected (or created)." (interactive "P") Mikiya> Mikiya> (defun eshell-command (&optional command arg) Mikiya> "Execute the Eshell command string COMMAND. With Mikiya> prefix ARG, insert output into the current buffer at Mikiya> point." (interactive) Mikiya> Mikiya> (defun eshell-report-bug (topic) "Report a bug in Mikiya> Eshell. Prompts for the TOPIC. Leaves you in a mail Mikiya> buffer. Please include any configuration details Mikiya> that might be involved." (interactive "sBug Subject: Mikiya> ") Mikiya> Mikiya> (defun eshell-insert-envvar (envvar-name) "Insert Mikiya> ENVVAR-NAME into the current buffer at point." Mikiya> (interactive (list (read-envvar-name "Name of Mikiya> environment variable: " t))) Mikiya> Mikiya> (defun eshell-test-goto-func () "Jump to the function Mikiya> that defines a particular test." (interactive) Mikiya> Mikiya> (defun eshell-run-one-test (&optional arg) "Jump to Mikiya> the function that defines a particular test." Mikiya> (interactive "P") Mikiya> Mikiya> (defun eshell-test (&optional arg) "Test Eshell to Mikiya> verify that it works as expected." (interactive "P") Mikiya> Mikiya> (defun eshell-insert-process (process) "Insert the Mikiya> name of PROCESS into the current buffer at point." Mikiya> (interactive (list (get-process Mikiya> (eshell-read-process-name "Name of process: ")))) Mikiya> Mikiya> (defun eshell-interrupt-process () "Interrupt a Mikiya> process." (interactive) Mikiya> Mikiya> (defun eshell-kill-process () "Kill a process." Mikiya> (interactive) Mikiya> Mikiya> (defun eshell-quit-process () "Send quit signal to Mikiya> process." (interactive) Mikiya> Mikiya> (defun eshell-send-eof-to-process () "Send EOF to Mikiya> process." (interactive) Mikiya> Mikiya> (defun eshell-toggle-direct-send () (interactive) Mikiya> Mikiya> (defun eshell-self-insert-command (N) (interactive Mikiya> "i") Mikiya> Mikiya> (defun eshell-find-tag (&optional tagname next-p Mikiya> regexp-p) "A special version of `find-tag' that Mikiya> ignores read-onlyness." (interactive) Mikiya> Mikiya> (defun eshell-forward-argument (&optional arg) "Move Mikiya> forward ARG arguments." (interactive "p") Mikiya> (eshell-move-argument (point-max) 'forward-char Mikiya> 'arg-end arg)) Mikiya> Mikiya> (defun eshell-backward-argument (&optional arg) "Move Mikiya> backward ARG arguments." (interactive "p") Mikiya> Mikiya> (defun eshell-repeat-argument (&optional arg) Mikiya> (interactive "p") Mikiya> Mikiya> (defun eshell-bol () "Goes to the beginning of line, Mikiya> then skips past the prompt, if any." (interactive) Mikiya> Mikiya> (defun eshell-queue-input (&optional use-region) Mikiya> "Queue the current input text for execution by Mikiya> Eshell. Particularly, don't send the text to the Mikiya> current process, even if it's waiting for input." Mikiya> (interactive "P") Mikiya> Mikiya> (defun eshell-send-input (&optional use-region Mikiya> queue-p no-newline) "Send the input received to Mikiya> Eshell for parsing and processing. After Mikiya> `eshell-last-output-end', sends all text from that Mikiya> marker to point as input. Before that marker, calls Mikiya> `eshell-get-old-input' to retrieve old input, copies Mikiya> it to the end of the buffer, and sends it. Mikiya> Mikiya> If USE-REGION is non-nil, the current region (between Mikiya> point and mark) will be used as input. Mikiya> Mikiya> If QUEUE-P is non-nil, input will be queued until the Mikiya> next prompt, rather than sent to the currently active Mikiya> process. If no process, the input is processed Mikiya> immediately. Mikiya> Mikiya> If NO-NEWLINE is non-nil, the input is sent without Mikiya> an implied final newline." (interactive "P") Mikiya> Mikiya> (defun eshell-kill-output () "Kill all output from Mikiya> interpreter since last input. Does not delete the Mikiya> prompt." (interactive) Mikiya> Mikiya> (defun eshell-show-output (&optional arg) "Display Mikiya> start of this batch of interpreter output at top of Mikiya> window. Sets mark to the value of point when this Mikiya> command is run. With a prefix argument, narrows Mikiya> region to last command output." (interactive "P") Mikiya> Mikiya> (defun eshell-mark-output (&optional arg) "Display Mikiya> start of this batch of interpreter output at top of Mikiya> window. Sets mark to the value of point when this Mikiya> command is run. With a prefix argument, narrows Mikiya> region to last command output." (interactive "P") Mikiya> Mikiya> (defun eshell-kill-input () "Kill all text from last Mikiya> stuff output by interpreter to point." (interactive) Mikiya> Mikiya> (defun eshell-show-maximum-output (&optional Mikiya> interactive) "Put the end of the buffer at the bottom Mikiya> of the window. When run interactively, widen the Mikiya> buffer first." (interactive "p") Mikiya> Mikiya> (defun eshell-copy-old-input () "Insert after prompt Mikiya> old input at point as new input to be edited." Mikiya> (interactive) Mikiya> Mikiya> (defun eshell-life-is-too-much () "Kill the current Mikiya> buffer (or bury it). Good-bye Eshell." Mikiya> (interactive) Mikiya> Mikiya> (defun eshell-truncate-buffer () "Truncate the buffer Mikiya> to `eshell-buffer-maximum-lines'. This function Mikiya> could be on `eshell-output-filter-functions' or bound Mikiya> to a key." (interactive) Mikiya> Mikiya> (defun eshell-send-invisible (str) "Read a string Mikiya> without echoing. Then send it to the process running Mikiya> in the current buffer." (interactive "P") ; Defeat Mikiya> snooping via C-x ESC ESC Mikiya> Mikiya> (defun eshell-insert-buffer-name (buffer-name) Mikiya> "Insert BUFFER-NAME into the current buffer at Mikiya> point." (interactive "BName of buffer: ") Mikiya> Mikiya> (defun eshell-occur-mode-goto-occurrence () "Go to Mikiya> the occurrence the current line describes." Mikiya> (interactive) Mikiya> Mikiya> (defun eshell-occur-mode-mouse-goto (event) "In Occur Mikiya> mode, go to the occurrence whose line you click on." Mikiya> (interactive "e") Mikiya> Mikiya> (defun eshell-diff-quit () "Restore the window Mikiya> configuration previous to diff'ing." (interactive) Mikiya> Mikiya> (defun eshell-smart-goto-end () "Like Mikiya> `end-of-buffer', but do not push a mark." Mikiya> (interactive) Mikiya> Mikiya> (defun eshell-source-file (file &optional args Mikiya> subcommand-p) "Execute a series of Eshell commands in Mikiya> FILE, passing ARGS. Comments begin with '#'." Mikiya> (interactive "f") Mikiya> Mikiya> (defun eshell-lock-local-map (&optional arg) "Lock or Mikiya> unlock the current local keymap. Within a prefix Mikiya> arg, set the local keymap to its normal value, and Mikiya> lock it at that." (interactive "P") Mikiya> Mikiya> (defun eshell-delete-backward-char (n &optional Mikiya> killflag) "Delete the last character, unless it's Mikiya> part of the output." (interactive "P") Mikiya> Mikiya> (defun eshell-delchar-or-maybe-eof (arg) "Delete ARG Mikiya> characters forward or send an EOF to subprocess. Mikiya> Sends an EOF only if point is at the end of the Mikiya> buffer and there is no input." (interactive "p") Mikiya> Mikiya> (defun eshell-backward-matching-input (regexp arg) Mikiya> "Search backward through buffer for match for REGEXP. Mikiya> Matches are searched for on lines that match Mikiya> `eshell-prompt-regexp'. With prefix argument N, Mikiya> search for Nth previous match. If N is negative, Mikiya> find the next or Nth next match." (interactive Mikiya> (eshell-regexp-arg "Backward input matching (regexp): Mikiya> ")) Mikiya> Mikiya> (defun eshell-forward-matching-input (regexp arg) Mikiya> "Search forward through buffer for match for REGEXP. Mikiya> Matches are searched for on lines that match Mikiya> `eshell-prompt-regexp'. With prefix argument N, Mikiya> search for Nth following match. If N is negative, Mikiya> find the previous or Nth previous match." Mikiya> (interactive (eshell-regexp-arg "Forward input Mikiya> matching (regexp): ")) Mikiya> Mikiya> (defun eshell-next-prompt (n) "Move to end of Nth Mikiya> next prompt in the buffer. See Mikiya> `eshell-prompt-regexp'." (interactive "p") Mikiya> Mikiya> (defun eshell-previous-prompt (n) "Move to end of Nth Mikiya> previous prompt in the buffer. See Mikiya> `eshell-prompt-regexp'." (interactive "p") Mikiya> Mikiya> (defun eshell-display-predicate-help () (interactive) Mikiya> Mikiya> (defun eshell-display-modifier-help () (interactive) Mikiya> Mikiya> (defun eshell-list-history () "List in help buffer Mikiya> the buffer's input history." (interactive) Mikiya> Mikiya> (defun eshell-get-next-from-history () "After Mikiya> fetching a line from input history, this fetches the Mikiya> next. In other words, this recalls the input line Mikiya> after the line you recalled last. You can use this Mikiya> to repeat a sequence of input lines." (interactive) Mikiya> Mikiya> (defun eshell-previous-input (arg) "Cycle backwards Mikiya> through input history." (interactive "*p") Mikiya> Mikiya> (defun eshell-next-input (arg) "Cycle forwards Mikiya> through input history." (interactive "*p") Mikiya> Mikiya> (defun eshell-previous-matching-input (regexp arg) Mikiya> "Search backwards through input history for match for Mikiya> REGEXP. \(Previous history elements are earlier Mikiya> commands.) With prefix argument N, search for Nth Mikiya> previous match. If N is negative, find the next or Mikiya> Nth next match." (interactive (eshell-regexp-arg Mikiya> "Previous input matching (regexp): ")) Mikiya> Mikiya> (defun eshell-next-matching-input (regexp arg) Mikiya> "Search forwards through input history for match for Mikiya> REGEXP. \(Later history elements are more recent Mikiya> commands.) With prefix argument N, search for Nth Mikiya> following match. If N is negative, find the previous Mikiya> or Nth previous match." (interactive Mikiya> (eshell-regexp-arg "Next input matching (regexp): ")) Mikiya> Mikiya> (defun eshell-previous-matching-input-from-input Mikiya> (arg) "Search backwards through input history for Mikiya> match for current input. \(Previous history elements Mikiya> are earlier commands.) With prefix argument N, Mikiya> search for Nth previous match. If N is negative, Mikiya> search forwards for the -Nth following match." Mikiya> (interactive "p") Mikiya> Mikiya> (defun eshell-next-matching-input-from-input (arg) Mikiya> "Search forwards through input history for match for Mikiya> current input. \(Following history elements are more Mikiya> recent commands.) With prefix argument N, search for Mikiya> Nth following match. If N is negative, search Mikiya> backwards for the -Nth previous match." (interactive Mikiya> "p") Mikiya> Mikiya> (defun eshell-isearch-backward (&optional invert) "Do Mikiya> incremental regexp search backward through past Mikiya> commands." (interactive) Mikiya> Mikiya> (defun eshell-isearch-repeat-backward (&optional Mikiya> invert) "Do incremental regexp search backward Mikiya> through past commands." (interactive) Mikiya> Mikiya> (defun eshell-isearch-forward () "Do incremental Mikiya> regexp search backward through past commands." Mikiya> (interactive) Mikiya> Mikiya> (defun eshell-isearch-repeat-forward () "Do Mikiya> incremental regexp search backward through past Mikiya> commands." (interactive) Mikiya> Mikiya> (defun eshell-isearch-cancel () (interactive) Mikiya> Mikiya> (defun eshell-isearch-abort () (interactive) Mikiya> Mikiya> (defun eshell-isearch-delete-char () (interactive) Mikiya> Mikiya> (defun eshell-isearch-return () (interactive) Mikiya> Mikiya> (defun eshell-completion-help () (interactive) Mikiya> Mikiya> ------------------------------------------------------------------------. Mikiya> Mikiya> Mikiya> Mikiya> _______________________________________________ Mikiya> Emacs-devel mailing list Emacs-devel@gnu.org Mikiya> http://lists.gnu.org/mailman/listinfo/emacs-devel -- Best Regards, --raman Email: raman@users.sf.net WWW: http://emacspeak.sf.net/raman/ AIM: emacspeak GTalk: tv.raman.tv@gmail.com PGP: http://emacspeak.sf.net/raman/raman-almaden.asc Google: tv+raman IRC: irc://irc.freenode.net/#emacs