First Edition.
[bpt/emacs.git] / lisp / lpr.el
index 7027439..21a1ed2 100644 (file)
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
 
 ;;; Commentary:
 
 ;; Commands to send the region or a buffer your printer.  Entry points
 ;; are `lpr-buffer', `print-buffer', lpr-region', or `print-region'; option
-;; variables include `lpr-switches' and `lpr-command'.
+;; variables include `printer-name', `lpr-switches' and `lpr-command'.
 
 ;;; Code:
 
+(defgroup lpr nil
+  "Print Emacs buffer on line printer"
+  :group 'wp)
+
+;;;###autoload
+(defcustom printer-name
+  (if (memq system-type '(ms-dos windows-nt)) "PRN")
+  "*The name of a local printer to which data is sent for printing.
+\(Note that PostScript files are sent to `ps-printer-name', which see.\)
+
+On Unix-like systems, a string value should be a name understood by
+lpr's -P option; otherwise the value should be nil.
+
+On MS-DOS and MS-Windows systems, a string value is taken as the name of
+a printer device or port, provided `lpr-command' is set to \"\".
+Typical non-default settings would be \"LPT1\" to \"LPT3\" for parallel
+printers, or \"COM1\" to \"COM4\" or \"AUX\" for serial printers, or
+\"//hostname/printer\" for a shared network printer.  You can also set
+it to the name of a file, in which case the output gets appended to that
+file.  If you want to discard the printed output, set this to \"NUL\"."
+  :type '(choice ; could use string but then we lose completion for files.
+                (file :tag "Name")
+                (const :tag "Default" nil))
+  :group 'lpr)
+
 ;;;###autoload
-(defvar lpr-switches nil 
+(defcustom lpr-switches nil 
   "*List of strings to pass as extra options for the printer program.
-See `lpr-command'.")
+It is recommended to set `printer-name' instead of including an explicit
+switch on this list.
+See `lpr-command'."
+  :type '(repeat (string :tag "Argument"))
+  :group 'lpr)
 
-(defvar lpr-add-switches (eq system-type 'berkeley-unix)
+(defcustom lpr-add-switches (eq system-type 'berkeley-unix)
   "*Non-nil means construct -T and -J options for the printer program.
 These are made assuming that the program is `lpr';
 if you are using some other incompatible printer program,
-this variable should be nil.")
+this variable should be nil."
+  :type 'boolean
+  :group 'lpr)
 
 ;;;###autoload
-(defvar lpr-command
-  (if (memq system-type '(usg-unix-v dgux hpux irix))
-      "lp" "lpr")
-  "*Name of program for printing a file.")
+(defcustom lpr-command
+  (cond
+   ((memq system-type '(ms-dos windows-nt))
+    "")
+   ((memq system-type '(usg-unix-v dgux hpux irix))
+    "lp")
+   (t
+    "lpr"))
+  "*Name of program for printing a file.
+
+On MS-DOS and MS-Windows systems, if the value is an empty string then
+Emacs will write directly to the printer port named by `printer-name'.
+The programs `print' and `nprint' (the standard print programs on
+Windows NT and Novell Netware respectively) are handled specially, using
+`printer-name' as the destination for output; any other program is
+treated like `lpr' except that an explicit filename is given as the last
+argument."
+  :type 'string
+  :group 'lpr)
 
 ;; Default is nil, because that enables us to use pr -f
 ;; which is more reliable than pr with no args, which is what lpr -p does.
-(defvar lpr-headers-switches nil
-  "*List of strings to use as options for `lpr' to request page headings.
+(defcustom lpr-headers-switches nil
+  "*List of strings of options to request page headings in the printer program.
 If nil, we run `lpr-page-header-program' to make page headings
-and print the result.")
+and print the result."
+  :type '(repeat (string :tag "Argument"))
+  :group 'lpr)
 
-(defvar print-region-function nil
+(defcustom print-region-function nil
   "Function to call to print the region on a printer.
-See definition of `print-region-1' for calling conventions.")
+See definition of `print-region-1' for calling conventions."
+  :type 'function
+  :group 'lpr)
 
-(defvar lpr-page-header-program "pr"
-  "*Name of program for adding page headers to a file.")
+(defcustom lpr-page-header-program "pr"
+  "*Name of program for adding page headers to a file."
+  :type 'string
+  :group 'lpr)
 
-(defvar lpr-page-header-switches '("-f")
-  "*List of strings to use as options for `lpr-page-header-program'.")
+;; Berkeley systems support -F, and GNU pr supports both -f and -F,
+;; So it looks like -F is a better default.
+(defcustom lpr-page-header-switches '("-h" "-F")
+  "*List of strings to use as options for the page-header-generating program.
+The variable `lpr-page-header-program' specifies the program to use."
+  :type '(repeat string)
+  :group 'lpr)
 
 ;;;###autoload
 (defun lpr-buffer ()
-  "Print buffer contents as with Unix command `lpr'.
-`lpr-switches' is a list of extra switches (strings) to pass to lpr."
+  "Print buffer contents without pagination or page headers.
+See the variables `lpr-switches' and `lpr-command'
+for customization of the printer command."
   (interactive)
   (print-region-1 (point-min) (point-max) lpr-switches nil))
 
 ;;;###autoload
 (defun print-buffer ()
-  "Print buffer contents as with Unix command `lpr -p'.
-`lpr-switches' is a list of extra switches (strings) to pass to lpr."
+  "Paginate and print buffer contents.
+
+The variable `lpr-headers-switches' controls how to paginate.
+If it is nil (the default), we run the `pr' program (or whatever program
+`lpr-page-header-program' specifies) to paginate.
+`lpr-page-header-switches' specifies the switches for that program.
+
+Otherwise, the switches in `lpr-headers-switches' are used
+in the print command itself; we expect them to request pagination.
+See the variables `lpr-switches' and `lpr-command'
+for further customization of the printer command."
   (interactive)
   (print-region-1 (point-min) (point-max) lpr-switches t))
 
 ;;;###autoload
 (defun lpr-region (start end)
-  "Print region contents as with Unix command `lpr'.
-`lpr-switches' is a list of extra switches (strings) to pass to lpr."
+  "Print region contents without pagination or page headers.
+See the variables `lpr-switches' and `lpr-command'
+for customization of the printer command."
   (interactive "r")
   (print-region-1 start end lpr-switches nil))
 
 ;;;###autoload
 (defun print-region (start end)
-  "Print region contents as with Unix command `lpr -p'.
-`lpr-switches' is a list of extra switches (strings) to pass to lpr."
+  "Paginate and print the region contents.
+
+The variable `lpr-headers-switches' controls how to paginate.
+If it is nil (the default), we run the `pr' program (or whatever program
+`lpr-page-header-program' specifies) to paginate.
+`lpr-page-header-switches' specifies the switches for that program.
+
+Otherwise, the switches in `lpr-headers-switches' are used
+in the print command itself; we expect them to request pagination.
+See the variables `lpr-switches' and `lpr-command'
+for further customization of the printer command."
   (interactive "r")
   (print-region-1 start end lpr-switches t))
 
@@ -97,6 +177,12 @@ See definition of `print-region-1' for calling conventions.")
   ;; and it seems to annoying to do for that MIPS system.
   (let ((name (concat (buffer-name) " Emacs buffer"))
        (title (concat (buffer-name) " Emacs buffer"))
+       ;; Make pipes use the same coding system as
+       ;; writing the buffer to a file would.
+       (coding-system-for-write
+        (or coding-system-for-write buffer-file-coding-system))
+       (coding-system-for-read
+        (or coding-system-for-read buffer-file-coding-system))
        (width tab-width)
        switch-string)
     (save-excursion
@@ -130,19 +216,23 @@ See definition of `print-region-1' for calling conventions.")
              (setq start (car new-coords) end (cdr new-coords)))
            (apply 'call-process-region start end lpr-page-header-program
                                 t t nil
-                                (nconc (and lpr-add-switches
-                                            (list "-h" title))
-                                       lpr-page-header-switches))
+                                lpr-page-header-switches)
            (setq start (point-min) end (point-max))))
-      (apply (or print-region-function 'call-process-region)
-            (nconc (list start end lpr-command
-                         nil nil nil)
-                   (nconc (and lpr-add-switches
-                               (list "-J" name))
-                          ;; These belong in pr if we are using that.
-                          (and lpr-add-switches lpr-headers-switches
-                               (list "-T" title))
-                          switches)))
+      (let ((printer-name-switch (if (memq system-type
+                                          '(usg-unix-v dgux hpux irix))
+                                    "-d" "-P")))
+       (apply (or print-region-function 'call-process-region)
+              (nconc (list start end lpr-command
+                           nil nil nil)
+                     (nconc (and lpr-add-switches
+                                 (list "-J" name))
+                            ;; These belong in pr if we are using that.
+                            (and lpr-add-switches lpr-headers-switches
+                                 (list "-T" title))
+                            (and (stringp printer-name)
+                                 (list (concat printer-name-switch
+                                               printer-name)))
+                            switches))))
       (if (markerp end)
          (set-marker end nil))
       (message "Spooling%s...done" switch-string))))
@@ -162,9 +252,9 @@ See definition of `print-region-1' for calling conventions.")
       (cons (point-min) (point-max)))))
 
 (defun printify-region (begin end)
-  "Turn nonprinting characters (other than TAB, LF, SPC, RET, and FF)
-in the current buffer into printable representations as control or
-hexadecimal escapes."
+  "Replace nonprinting characters in region with printable representations.
+The printable representations use ^ (for ASCII control characters) or hex.
+The characters tab, linefeed, space, return and formfeed are not affected."
   (interactive "r")
   (save-excursion
     (goto-char begin)