cgit.sxemacs.org Git - gnus/blob - lisp/nntp.el

   1 ;;; nntp.el --- nntp access for Gnus
   2
   3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1992, 1993, 1994, 1995, 1996,
   4 ;;   1997, 1998, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
   5 ;;   2009, 2010  Free Software Foundation, Inc.
   6
   7 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   8 ;; Keywords: news
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 ;; For Emacs <22.2 and XEmacs.
  30 (eval-and-compile
  31   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
  32
  33 (require 'nnheader)
  34 (require 'nnoo)
  35 (require 'gnus-util)
  36 (require 'gnus)
  37 (require 'gnus-group) ;; gnus-group-name-charset
  38
  39 (nnoo-declare nntp)
  40
  41 (eval-when-compile (require 'cl))
  42
  43 (autoload 'auth-source-user-or-password "auth-source")
  44
  45 (defgroup nntp nil
  46   "NNTP access for Gnus."
  47   :group 'gnus)
  48
  49 (defvoo nntp-address nil
  50   "Address of the physical nntp server.")
  51
  52 (defvoo nntp-port-number "nntp"
  53   "Port number on the physical nntp server.")
  54
  55 (defvoo nntp-server-opened-hook '(nntp-send-mode-reader)
  56   "*Hook used for sending commands to the server at startup.
  57 The default value is `nntp-send-mode-reader', which makes an innd
  58 server spawn an nnrpd server.")
  59
  60 (defvoo nntp-authinfo-function 'nntp-send-authinfo
  61   "Function used to send AUTHINFO to the server.
  62 It is called with no parameters.")
  63
  64 (defvoo nntp-server-action-alist
  65     '(("nntpd 1\\.5\\.11t"
  66        (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader))
  67       ("NNRP server Netscape"
  68        (setq nntp-server-list-active-group nil)))
  69   "Alist of regexps to match on server types and actions to be taken.
  70 For instance, if you want Gnus to beep every time you connect
  71 to innd, you could say something like:
  72
  73 \(setq nntp-server-action-alist
  74        '((\"innd\" (ding))))
  75
  76 You probably don't want to do that, though.")
  77
  78 (defvoo nntp-open-connection-function 'nntp-open-network-stream
  79   "*Function used for connecting to a remote system.
  80 It will be called with the buffer to output in as argument.
  81
  82 Currently, five such functions are provided (please refer to their
  83 respective doc string for more information), three of them establishing
  84 direct connections to the nntp server, and two of them using an indirect
  85 host.
  86
  87 Direct connections:
  88 - `nntp-open-network-stream' (the default),
  89 - `nntp-open-ssl-stream',
  90 - `nntp-open-tls-stream',
  91 - `nntp-open-netcat-stream'.
  92 - `nntp-open-telnet-stream'.
  93
  94 Indirect connections:
  95 - `nntp-open-via-rlogin-and-netcat',
  96 - `nntp-open-via-rlogin-and-telnet',
  97 - `nntp-open-via-telnet-and-telnet'.")
  98
  99 (defvoo nntp-never-echoes-commands nil
 100   "*Non-nil means the nntp server never echoes commands.
 101 It is reported that some nntps server doesn't echo commands.  So, you
 102 may want to set this to non-nil in the method for such a server setting
 103 `nntp-open-connection-function' to `nntp-open-ssl-stream' for example.
 104 Note that the `nntp-open-connection-functions-never-echo-commands'
 105 variable overrides the nil value of this variable.")
 106
 107 (defvoo nntp-open-connection-functions-never-echo-commands
 108     '(nntp-open-network-stream)
 109   "*List of functions that never echo commands.
 110 Add or set a function which you set to `nntp-open-connection-function'
 111 to this list if it does not echo commands.  Note that a non-nil value
 112 of the `nntp-never-echoes-commands' variable overrides this variable.")
 113
 114 (defvoo nntp-pre-command nil
 115   "*Pre-command to use with the various nntp-open-via-* methods.
 116 This is where you would put \"runsocks\" or stuff like that.")
 117
 118 (defvoo nntp-telnet-command "telnet"
 119   "*Telnet command used to connect to the nntp server.
 120 This command is used by the methods `nntp-open-telnet-stream',
 121 `nntp-open-via-rlogin-and-telnet' and `nntp-open-via-telnet-and-telnet'.")
 122
 123 (defvoo nntp-telnet-switches '("-8")
 124   "*Switches given to the telnet command `nntp-telnet-command'.")
 125
 126 (defvoo nntp-end-of-line "\r\n"
 127   "*String to use on the end of lines when talking to the NNTP server.
 128 This is \"\\r\\n\" by default, but should be \"\\n\" when using an indirect
 129 connection method (nntp-open-via-*).")