Added or corrected Commentary sections
[bpt/emacs.git] / lisp / lpr.el
1 ;;; lpr.el --- print Emacs buffer on line printer.
2
3 ;; Copyright (C) 1985, 1988, 1992 Free Software Foundation, Inc.
4
5 ;; Maintainer: FSF
6 ;; Keywords: unix
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23
24 ;;; Commentary:
25
26 ;; Commands to send the region or a buffer your printer. Entry points
27 ;; are `lpr-buffer', `print-buffer', lpr-region', or `print-region'; option
28 ;; variables include `lpr-switches' and `lpr-command'.
29
30 ;;; Code:
31
32 ;;;###autoload
33 (defvar lpr-switches nil
34 "*List of strings to pass as extra switch args to lpr when it is invoked.")
35
36 ;;;###autoload
37 (defvar lpr-command
38 (if (memq system-type '(usg-unix-v dgux-unix hpux silicon-graphics-unix))
39 "lp" "lpr")
40 "*Shell command for printing a file")
41
42 (defvar print-region-function nil
43 "Function to call to print the region on a printer.
44 See definition of `print-region-1' for calling conventions.")
45
46 ;;;###autoload
47 (defun lpr-buffer ()
48 "Print buffer contents as with Unix command `lpr'.
49 `lpr-switches' is a list of extra switches (strings) to pass to lpr."
50 (interactive)
51 (print-region-1 (point-min) (point-max) lpr-switches nil))
52
53 ;;;###autoload
54 (defun print-buffer ()
55 "Print buffer contents as with Unix command `lpr -p'.
56 `lpr-switches' is a list of extra switches (strings) to pass to lpr."
57 (interactive)
58 (print-region-1 (point-min) (point-max) lpr-switches t))
59
60 ;;;###autoload
61 (defun lpr-region (start end)
62 "Print region contents as with Unix command `lpr'.
63 `lpr-switches' is a list of extra switches (strings) to pass to lpr."
64 (interactive "r")
65 (print-region-1 start end lpr-switches nil))
66
67 ;;;###autoload
68 (defun print-region (start end)
69 "Print region contents as with Unix command `lpr -p'.
70 `lpr-switches' is a list of extra switches (strings) to pass to lpr."
71 (interactive "r")
72 (print-region-1 start end lpr-switches t))
73
74 (defun print-region-1 (start end switches page-headers)
75 (let ((name (concat (buffer-name) " Emacs buffer"))
76 (width tab-width))
77 (save-excursion
78 (message "Spooling...")
79 (if (/= tab-width 8)
80 (progn
81 (print-region-new-buffer start end)
82 (setq tab-width width)
83 (untabify (point-min) (point-max))))
84 (if page-headers
85 (if (eq system-type 'usg-unix-v)
86 (progn
87 (print-region-new-buffer start end)
88 (call-process-region start end "pr" t t nil))
89 ;; On BSD, use an option to get page headers.
90 (setq switches (cons "-p" switches))))
91 (apply (or print-region-function 'call-process-region)
92 (nconc (list start end lpr-command
93 nil nil nil)
94 (nconc (and (eq system-type 'berkeley-unix)
95 (list "-J" name "-T" name))
96 switches)))
97 (message "Spooling...done"))))
98
99 ;; This function copies the text between start and end
100 ;; into a new buffer, makes that buffer current,
101 ;; and sets start and end to the buffer bounds.
102 ;; start and end are used free.
103 (defun print-region-new-buffer (start end)
104 (or (string= (buffer-name) " *spool temp*")
105 (let ((oldbuf (current-buffer)))
106 (set-buffer (get-buffer-create " *spool temp*"))
107 (widen) (erase-buffer)
108 (insert-buffer-substring oldbuf start end)
109 (setq start (point-min) end (point-max)))))
110
111 ;;; lpr.el ends here