home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / elisp / functions / dired-man.el < prev    next >
Encoding:
Text File  |  1991-06-03  |  3.9 KB  |  101 lines
  1. ; Path: dg-rtp!rock.concert.net!mcnc!stanford.edu!hsdndev!wuarchive!cs.utexas.edu!cse!evax!lindahl
  2. ; From: lindahl@arrisun3.uta.edu (Charlie S. Lindahl)
  3. ; Newsgroups: gnu.emacs.sources
  4. ; Subject: Revised DIRED-MAN.EL
  5. ; Date: 1 Jun 91 18:22:37 GMT
  6. ; Organization: Automation and Robotics Research Institute, U Texas @ Arlington
  7. ; 
  8. ; All: 
  9. ; 
  10. ; Here's a new version of DIRED-MAN.EL, a short function which adds
  11. ; the capability to invoke MAN on files from within DIRED. My original
  12. ; description appears below. 
  13. ; 
  14. ; Thanx to Steinar Bang (steinarb@idt.unit.no) for noticing that I used a 
  15. ; function ("dired-run-shell-command") in the original version, which is
  16. ; only defined by the advanced DIRED I use (TREE-DIRED, in the archives). I 
  17. ; have called the standard "shell-run-command" function, instead. 
  18. ; 
  19. ; Please send me EMAIL if you use this little utility; I am curious as 
  20. ; to how many other folks wanted/needed this functionality. 
  21. ; 
  22. ; Charlie S. Lindahl
  23. ; Automation and Robotics Research Institute
  24. ; University of Texas at Arlington
  25. ; Internet EMAIL: lindahl@cse.uta.edu
  26. ; ------------------------------------------------------------------------
  27. ;; MAN command invocation from within DIRED
  28. ;; Copyright (C) 1989 Free Software Foundation, Inc.
  29.  
  30. ;; This file is not officially part of GNU Emacs, but is being donated
  31. ;; to the Free Software Foundation.
  32.  
  33. ;; GNU Emacs is distributed in the hope that it will be useful,
  34. ;; but WITHOUT ANY WARRANTY.  No author or distributor
  35. ;; accepts responsibility to anyone for the consequences of using it
  36. ;; or for whether it serves any particular purpose or works at all,
  37. ;; unless he says so in writing.  Refer to the GNU Emacs General Public
  38. ;; License for full details.
  39.  
  40. ;; Everyone is granted permission to copy, modify and redistribute
  41. ;; GNU Emacs, but only under the conditions described in the
  42. ;; GNU Emacs General Public License.   A copy of this license is
  43. ;; supposed to have been given to you along with GNU Emacs so you
  44. ;; can know your rights and responsibilities.  It should be in a
  45. ;; file named COPYING.  Among other things, the copyright notice
  46. ;; and this notice must be preserved on all copies.
  47.  
  48. ;; Created by: Charlie Lindahl, lindahl@cse.uta.edu
  49. ;; Purpose: Add MAN invocation from within DIRED (particularly handy
  50. ;;          for X man pages!) when files have not yet been installed
  51. ;;          in the usual MAN places.
  52. ;;
  53. ;; Change log: 
  54. ;;    6/01/91 : Modified to use "shell-command" function (built-in
  55. ;;              GNU EMACS function) instead of "dired-run-shell-command"
  56. ;;          used in original version. Thanx to steinar@idt.unit.no
  57. ;;          for the suggestion/feedback (Steinar Bang)
  58. ;;     5/15/91 : Original 
  59. ;;
  60. ;;
  61.  
  62. ;; The idea for this function & binding came from the fact that I am
  63. ;; constantly downloading new X stuff (most of which contain a ".man"
  64. ;; file); I wanted to be able to look at the ".man" files without
  65. ;; explicitly having to copy them into /usr/man (or wherever your
  66. ;; man pages live). 
  67. ;;
  68. ;; Since the DIRED buffer is read-only, "CONTROL-M" was bound to 
  69. ;; "newline" but disabled due to the read-only status; therefore I felt
  70. ;; free to replace the binding.
  71. ;;
  72. (define-key dired-mode-map "\C-m" 'dired-do-man)
  73.  
  74. (defun dired-do-man (&optional arg)
  75.   (interactive "P")
  76.   (let* (buffer-read-only 
  77.      (from-file (dired-get-filename))
  78.      (nroff-command-to-run      
  79.       (concat "nroff" " -man " " -h " from-file)))
  80.     (message (format "Expanding MAN page for %s..." from-file))
  81.     (shell-command nroff-command-to-run)
  82.     (save-excursion 
  83.       (set-buffer "*Shell Command Output*")
  84.       (rename-buffer (format "*Manual Entry %s*" 
  85.                  (file-name-nondirectory from-file)))
  86.       (message 
  87.        (concat "Cleaning manual entry in buffer " (buffer-name)))
  88.     (nuke-nroff-bs)
  89.     (set-buffer-modified-p nil)
  90.     )
  91.     (message "")
  92.   ))
  93.  
  94. --
  95. Charlie S. Lindahl
  96. Automation and Robotics Research Institute
  97. University of Texas at Arlington
  98. Internet EMAIL: lindahl@cse.uta.edu
  99.  
  100. Standard disclaimer: Ain't no opinion but my own.
  101.