home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1993 #2 / Image.iso / os2 / e17info.zip / EMACS / 19.17 / INFO / GNUS-2 (.txt) < prev    next >
GNU Info File  |  1993-07-17  |  44KB  |  833 lines
  1. This is Info file ../info/gnus, produced by Makeinfo-1.54 from the
  2. input file gnus.texi.
  3.    This file documents GNUS, the GNU Emacs newsreader.
  4.    Copyright (C) 1989, 1990, 1993 Free Software Foundation, Inc.
  5.    Permission is granted to make and distribute verbatim copies of this
  6. manual provided the copyright notice and this permission notice are
  7. preserved on all copies.
  8.    Permission is granted to copy and distribute modified versions of
  9. this manual under the conditions for verbatim copying, provided also
  10. that the entire resulting derived work is distributed under the terms
  11. of a permission notice identical to this one.
  12.    Permission is granted to copy and distribute translations of this
  13. manual into another language, under the above conditions for modified
  14. versions.
  15. File: gnus,  Node: Names of Kill Files,  Next: Background Kills,  Prev: Kill File Example,  Up: Kill File
  16. Names of Kill Files
  17. ===================
  18.    Kill files are kept in the directory specified by the variable
  19. `gnus-article-save-directory'; its default value is `~/News'.  The
  20. variable `gnus-kill-file-name' specifies the global kill file's name
  21. within that directory; the default is `KILL'.
  22.    The name of a local kill file is based on the newsgroup's name.  If
  23. the variable `gnus-use-long-file-name' is non-`nil', then the file name
  24. is `NEWSGROUP.KILL'.  Otherwise, it is `NEWS/GROUP/KILL', where the
  25. subdirectory name is made from the newsgroup name by changing all
  26. periods to slashes.
  27. File: gnus,  Node: Background Kills,  Next: Advanced Kills,  Prev: Names of Kill Files,  Up: Kill File
  28. Background Kill Processing
  29. ==========================
  30.    Kill processing can take a long time.  If you don't want to wait for
  31. it, try background kill processing using the following shell command:
  32.      emacs -batch -l gnus -f gnus-batch-kill NEWSGROUPS...
  33. where NEWSGROUPS are newsgroup names separated by whitespace.  `!'
  34. preceding a newsgroup name means negation, and `all' specifies all
  35. newsgroups not yet decided.  These interpretations are the same as the
  36. options line of the startup file (*note Startup File::.).
  37. File: gnus,  Node: Advanced Kills,  Prev: Background Kills,  Up: Kill File
  38. Advanced Kill Processing
  39. ========================
  40.    Internally, applying kills means to run the hook
  41. `gnus-apply-kill-hook'.  It is called after the Summary buffer is
  42. prepared for a selected newsgroup.  The default hook is the function
  43. `gnus-apply-kill-file' which loads a global kill file and a local kill
  44. file in this order.  A different style of the kill processing can be
  45. implemented by customizing this hook.
  46.    For example, if you don't have a global kill file, you can use the
  47. following hook which applies only a local kill file.  This change can
  48. save the time for checking the existence of a global kill file.
  49.      ;; Get rid of the default hook.
  50.      (setq gnus-apply-kill-hook nil)
  51.      (add-hook 'gnus-apply-kill-hook
  52.        '(lambda ()
  53.           ;; Apply a local kill file.
  54.           (load (gnus-newsgroup-kill-file gnus-newsgroup-name) t nil t)))
  55. (As usual, you can put as many functions as you wish into this hook.
  56. What is not usual is the fact that the hook is not initially empty.
  57. Therefore, if you don't want the default hook value, you must set the
  58. hook variable to `nil'.)
  59.    In contrast, the following example enables only a global kill file.
  60.      ;; Get rid of the default hook.
  61.      (setq gnus-apply-kill-hook nil)
  62.      (add-hook 'gnus-apply-kill-hook
  63.        '(lambda ()
  64.           ;; Apply a global kill file.
  65.           (load (gnus-newsgroup-kill-file nil) t nil t)))
  66.    Here is an advanced example that drastically reduces the time for
  67. applying kill files.  This hook does the kill processing directly
  68. without loading the kill files.
  69.      ;; Get rid of the default hook.
  70.      (setq gnus-apply-kill-hook nil)
  71.      (add-hook 'gnus-apply-kill-hook
  72.        '(lambda ()
  73.           ;; Apply to the newsgroup `control'
  74.           ;; if the NNTP server is flab.
  75.           (and (string-equal gnus-nntp-server "flab")
  76.                (string-equal gnus-newsgroup-name "control")
  77.                (progn
  78.                  (gnus-kill "Subject" "ihave flab\\|sendme")
  79.                  (gnus-kill "Subject" "cancel\\|newgroup\\|rmgroup" "d")
  80.                  (gnus-expunge "X")))))
  81. File: gnus,  Node: Customization,  Next: Reporting Bugs,  Prev: Troubleshooting,  Up: Top
  82. Customizing GNUS
  83. ****************
  84.    Appendix A describes the variables and hooks for simple customization
  85. and the variables for localization.
  86. * Menu:
  87. * Variables::           Variables for customizing GNUS.
  88. * NNTP Variables::      Variables for localizing NNTP environment.
  89. * Spool Variables::     Variables for localizing news spool environment.
  90. * Directory Variables:: Variables for localizing private directory environment.
  91. * Hooks::               Function hooks for customizing GNUS.
  92. File: gnus,  Node: Variables,  Next: NNTP Variables,  Up: Customization
  93. Common Variables
  94. ================
  95. `gnus-nntp-server'
  96.      Specifies the name of the host running the NNTP server.  The
  97.      variable is initialized from the `NNTPSERVER' environment
  98.      variable.  If the server name is preceded by a colon such as
  99.      `:Mail', the user's private directory `~/Mail' is used as a news
  100.      spool.  *Note Finding the News::, for more information.
  101. `gnus-nntp-service'
  102.      Specifies a service name of NNTP, usually a string `"nntp"'.  In a
  103.      few instances, it must be the number `119'.  To use a local news
  104.      spool of your machine rather than NNTP, set the variable to `nil'.
  105.      *Note Finding the News::, for more information.
  106. `gnus-local-domain'
  107.      Specifies the domain which is the domain part of your mail address
  108.      excluding the local host name of your machine.  The environment
  109.      variable `DOMAINNAME' is used instead if defined.  If the function
  110.      `system-name' returns the full Internet name, there is no need to
  111.      define the domain.
  112. `gnus-local-organization'
  113.      Specifies the organization you belong to.  The environment variable
  114.      `ORGANIZATION' is used instead if defined.  If the value begins
  115.      with a slash, it is taken as the name of a file whose contents are
  116.      read for the value.
  117. `gnus-local-timezone'
  118.      Specifies the local time zone you belong to.  The value can be
  119.      either a time zone name such as `"JST"' or a difference in hour
  120.      from GMT such as `+0900'.  If the variable is non-`nil', a general
  121.      time zone handling package `timezone.el' is used to generate a
  122.      valid date for `Date:' field in terms of RFC822.  Otherwise, if it
  123.      is nil, GNUS generate a date ignoring the local time zone.  If you
  124.      are using Bnews, it is okay since `inews' will rewrite the invalid
  125.      date.  However, if you are using Cnews or INN, you must set the
  126.      variable to the correct time zone or remove `Date' from the
  127.      variable `gnus-required-headers' since their `inews' do not
  128.      rewrite the wrong `Date:' field.
  129.      If you want to display the time of articles in your local time
  130.      zone, call the function `gnus-gmt-to-local' from the hook
  131.      `gnus-article-prepare-hook'.
  132. `gnus-local-distributions'
  133.      Specifies a list of distributions.  The head of the list is used as
  134.      default.  Each element of the list must be a string.  If
  135.      distributions file is available, its content is also used as
  136.      distributions.
  137. `gnus-use-generic-from'
  138.      Non-`nil' means the local host name of your machine will not appear
  139.      in the `From:' field of article headers.  If the variable is a
  140.      string, it is used as your domain instead of the definition by the
  141.      variable `gnus-local-domain' or the environment variable
  142.      `DOMAINNAME'.
  143. `gnus-use-generic-path'
  144.      Non-`nil' means the NNTP server name will not appear in the
  145.      `Path:' field of article headers.  If the variable is a string, it
  146.      is used in the `Path:' field as the NNTP server name instead of the
  147.      definition by the variable `gnus-nntp-server'.
  148. `gnus-ignored-newsgroups'
  149.      Specify a regular expression used to ignore uninterested
  150.      newsgroups in the active file.  Any lines in the active file
  151.      matching this regular expression are removed from the newsgroup
  152.      list before anything else is done to it, thus making them
  153.      effectively invisible.  There is no way to know what newsgroups
  154.      there are if they are ignored.
  155. `gnus-ignored-headers'
  156.      Specifies header fields which should be ignored in an article.
  157. `gnus-required-headers'
  158.      Specifies header fields which should be included in an article you
  159.      will post.  RFC977 and RFC1036 require From, Date, Newsgroups,
  160.      Subject, Message-ID and Path fields.  Organization, Distribution
  161.      and Lines are optional.  If you want GNUS not to generate some
  162.      fields, remove them from the variable.  If news system is Cnews,
  163.      you may have to remove Date and to add Lines.
  164. `gnus-startup-file'
  165.      Specifies a startup file of the Bnews system, usually `.newsrc'.
  166.      If there is a file named `.newsrc-SERVER', it is used instead when
  167.      talking to SERVER.  *Note Startup File::, for more information.
  168. `gnus-signature-file'
  169.      Specifies a signature file of the Bnews system, usually
  170.      `.signature'.  The signature file is processed by the function
  171.      `gnus-inews-insert-signature' called from the hook
  172.      `gnus-prepare-article-hook' by default.  If there is a file named
  173.      `.signature-DISTRIBUTION', it is used instead when the
  174.      distribution of the article is DISTRIBUTION.  Set the variable to
  175.      `nil' to prevent appending the signature file automatically.
  176. `gnus-use-cross-reference'
  177.      Specifies what to do with cross references (`Xref:' field).  If it
  178.      is `nil', cross references are ignored.  If it is `t', articles in
  179.      subscribed newsgroups are only marked as read.  Otherwise, if it
  180.      is not `nil' nor `t', articles in all newsgroups are marked as
  181.      read.
  182. `gnus-use-followup-to'
  183.      Specifies what to do with `Followup-To:' field.  If it is `nil',
  184.      its value is ignored.  If it is non-`nil', its value is used as
  185.      followup newsgroups.  Especially, if it is `t' and you are going
  186.      to followup to an article in which `poster' is specified, your
  187.      confirmation is required.
  188. `gnus-use-full-window'
  189.      Non-`nil' means to take up the entire screen of Emacs.  If the
  190.      variable is `nil', the windows used by GNUS will be restricted to
  191.      the bounds of the original window.  This is very useful if you
  192.      want to read articles while you do other work in other windows.
  193. `gnus-window-configuration'
  194.      Specifies the configuration of the Group Mode window, the Summary
  195.      Mode window, and the Article Mode window.  The window
  196.      configuration can be specified for each action of GNUS (e.g.
  197.      selecting a newsgroup or selecting an article).  This is quite
  198.      useful if you are using a slow terminal since the update of Emacs
  199.      windows can be minimized by displaying these three windows same
  200.      time.
  201.      The variable must be a list of `(ACTION (G S A))', where ACTION is
  202.      an action being performed, and G, S, and A are the relative
  203.      heights of the Group Mode window, the Summary Mode window, and the
  204.      Article Mode window, respectively.  ACTION is `summary',
  205.      `newsgroups', or `article'.
  206.      The following example is the default window configuration:
  207.           (setq gnus-window-configuration
  208.                 '((summary        (0 1 0))
  209.                   (newsgroups     (1 0 0))
  210.                   (article        (0 3 10))))
  211.      The following is an example of yet another two windows mode.
  212.      Article buffer is always displayed on a screen.  This is useful on
  213.      a slow terminal.
  214.           (setq gnus-window-configuration
  215.                 '((summary        (0 1 0))
  216.                   (newsgroups     (1 0 3))
  217.                   (article        (0 1 3))))
  218.      The following is an example of three windows mode.  Three buffers
  219.      are always displayed on a screen.  This is also useful on a slow
  220.      terminal.
  221.           (setq gnus-window-configuration
  222.                 '((summary        (1 4 0))
  223.                   (newsgroups     (1 1 3))
  224.                   (article        (1 1 3))))
  225. `gnus-large-newsgroup'
  226.      Specifies the number of the articles which indicates a large
  227.      newsgroup.  If the number of articles in a newsgroup is greater
  228.      than this value, the number of articles to be selected is asked
  229.      for.  If the given value N is positive, the last N articles are
  230.      selected.  If N is negative, the first N articles are selected.
  231.      An empty string means to select all articles.
  232. `gnus-author-copy'
  233.      Specifies a file name saving a copy of an article posted using
  234.      `FCC:' field.  The variable is initialized from the `AUTHORCOPY'
  235.      environment variable.  The specified file name is inserted in
  236.      `FCC:' field, so you have a chance to change the file name or
  237.      disable saving a copy by editing this field.
  238.      The `FCC:' field is processed by the function `gnus-inews-do-fcc'
  239.      called from the hook `gnus-inews-article-hook' by default.  Unless
  240.      the first character of the field is ``|'', the article is saved to
  241.      the specified file using the function specified by the variable
  242.      `gnus-author-copy-saver'.  The default function `rmail-output'
  243.      saves in Unix mailbox format.  Instead, if the first character is
  244.      ``|'', the contents of the article is send to a program specified
  245.      by the rest of the value.  For example, articles can be saved in
  246.      an MH folder by the following:
  247.           (setq gnus-author-copy
  248.                 "|/usr/local/lib/mh/rcvstore +Article")
  249. `gnus-author-copy-saver'
  250.      Specifies a function to save an author copy to.  The function is
  251.      called with a file name to save a copy to.  The default function
  252.      `rmail-output' saves in Unix mailbox format.
  253. `gnus-use-long-file-name'
  254.      Non-`nil' means that a newsgroup name is used as a default file
  255.      name to save articles to.  If it is `nil', the directory form of a
  256.      newsgroup name is used instead.  It is set to nil by default if the
  257.      variable `system-type' is either `usg-unix-v' or `xenix'.
  258. `gnus-mail-save-name'
  259. `gnus-rmail-save-name'
  260. `gnus-folder-save-name'
  261. `gnus-file-save-name'
  262.      Specifies a function generating a file name to save articles to.
  263.      The function is called with NEWSGROUP, HEADERS, and optional
  264.      LAST-NAME.  NEWSGROUP is a string representing the current
  265.      newsgroup name.  HEADERS is a vector containing headers of the
  266.      current article.  Macros and functions accessing contents of the
  267.      HEADERS are defined as `nntp-header-FIELD' and
  268.      `gnus-header-FIELD', respectively.  The following functions are
  269.      provided as file name generators by default:
  270.     `gnus-numeric-save-name'
  271.           Return a file name like `NEWS.GROUP/NUMBER' or
  272.           `NEWS/GROUP/NUMBER' according to the variable
  273.           `gnus-use-long-file-name'.
  274.     `gnus-Numeric-save-name'
  275.           Return a file name like `NEWS.GROUP/NUMBER' or
  276.           `NEWS/GROUP/NUMBER' according to the variable
  277.           `gnus-use-long-file-name'.
  278.     `gnus-plain-save-name'
  279.           Return a file name like `NEWS.GROUP' or `NEWS/GROUP/news'
  280.           according to the variable `gnus-use-long-file-name'.
  281.     `gnus-Plain-save-name'
  282.           Return a file name like `NEWS.GROUP' or `NEWS/GROUP/news'
  283.           according to the variable `gnus-use-long-file-name'.
  284.     `gnus-folder-save-name'
  285.           Return a folder name like `+NEWS.GROUP' or `+NEWS/GROUP'
  286.           according to the variable `gnus-use-long-file-name'.
  287.     `gnus-Folder-save-name'
  288.           Return a folder name like `+NEWS.GROUP' or `+NEWS/GROUP'
  289.           according to the variable `gnus-use-long-file-name'.
  290. `gnus-default-article-saver'
  291.      Specifies a function to save articles in your favorite format
  292.      using the command `gnus-summary-save-article'.  The function must
  293.      be interactively funcallable.  In other words, it must be an Emacs
  294.      command.  The functions currently provided are as follows:
  295.     `gnus-summary-save-in-mail'
  296.           Save articles in Unix mailbox format.
  297.     `gnus-summary-save-in-rmail'
  298.           Save articles in Rmail format.
  299.     `gnus-summary-save-in-folder'
  300.           Save articles in an MH folder.
  301.     `gnus-summary-save-in-file'
  302.           Save articles in article format.
  303. `gnus-article-save-directory'
  304.      Specifies a directory name to save articles in using the commands
  305.      `gnus-summary-save-in-mail', `gnus-summary-save-in-rmail', and
  306.      `gnus-summary-save-in-file'.  The variable is initialized from the
  307.      `SAVEDIR' environment variable.  Its default value is `~/News'.
  308. `gnus-kill-file-name'
  309.      Specifies a file name of kill file (*note Kill File::.).  Its
  310.      default value is `KILL'.
  311. `gnus-novice-user'
  312.      Non-`nil' means you are a novice to USENET.  If it is non-`nil',
  313.      verbose messages may be displayed or your confirmations may be
  314.      required.
  315. `gnus-interactive-catchup'
  316.      Non-`nil' means that your confirmation is required when catching up
  317.      a newsgroup in Group mode.
  318. `gnus-interactive-post'
  319.      Non-`nil' means that newsgroup, subject, and distribution are asked
  320.      for interactively when composing a new article.
  321. `gnus-interactive-exit'
  322.      Non-`nil' means that your confirmation is required when exiting
  323.      GNUS.
  324. `gnus-user-login-name'
  325.      Specifies your login name.  The login name is got from the `USER'
  326.      and `LOGNAME' environment variables and the function
  327.      `user-login-name', if undefined.
  328. `gnus-user-full-name'
  329.      Specifies your full name.  The full name is got from the `NAME'
  330.      environment variable and the function `user-full-name', if
  331.      undefined.
  332. `gnus-show-all-headers'
  333.      Non-`nil' means all headers of an article are shown.
  334. `gnus-save-all-headers'
  335.      Non-`nil' means all headers of an article are saved in a file.
  336. `gnus-show-mime'
  337.      Non-`nil' means process a MIME message.  The message is processed
  338.      by the function specified by the variable `gnus-show-mime-method'.
  339. `gnus-show-threads'
  340.      Non-`nil' means conversation threads are displayed in a tree
  341.      structured form according to references in Summary Mode.
  342. `gnus-thread-hide-subject'
  343.      Non-`nil' means subjects of lower level threads are hidden if the
  344.      thread-based reading is turned on.
  345. `gnus-thread-hide-subtree'
  346.      Non-`nil' means thread subtrees are hidden initially.  If thread
  347.      subtrees are hidden, you have to run the command
  348.      `gnus-summary-show-thread' by hand or by using
  349.      `gnus-select-article-hook' to show them.
  350. `gnus-thread-hide-killed'
  351.      Non-`nil' means killed thread subtrees are hidden automatically.
  352. `gnus-thread-ignore-subject'
  353.      Non-`nil' means subject differences are ignored but only references
  354.      are taken into account in constructing threads trees.  If it is
  355.      non-`nil' and thread subtrees are hidden, some commands that work
  356.      with subjects may not work properly.
  357. `gnus-thread-indent-level'
  358.      Specifies indentation level of thread subtrees.
  359. `gnus-auto-extend-newsgroup'
  360.      Non-`nil' means visible articles are automatically extended to
  361.      forward and backward if possible when the commands `N' and `P'
  362.      (`gnus-summary-next-article' and `gnus-summary-prev-article') are
  363.      executed in Summary Mode.
  364. `gnus-auto-select-first'
  365.      Non-`nil' means the first unread article is selected automatically
  366.      when a newsgroup is selected.  If you'd like to prevent automatic
  367.      selection of the first unread article in some newsgroups, set the
  368.      variable to `nil' in the hook `gnus-select-group-hook' or
  369.      `gnus-apply-kill-hook' (*note Hooks::.).
  370. `gnus-auto-select-next'
  371.      Non-`nil' means the next newsgroup is selected automatically at the
  372.      end of the newsgroup.  If the value is `t' and the next newsgroup
  373.      is empty (no unread articles), GNUS will exit Summary Mode and go
  374.      back to Group Mode.  If the value is neither `nil' nor `t', GNUS
  375.      won't exit Summary Mode but will select the following unread
  376.      newsgroup.  If the value is `quietly', the next unread newsgroup
  377.      will be selected without any confirmations.
  378. `gnus-auto-select-same'
  379.      Non-`nil' means an article with the same subject as the current
  380.      article is selected automatically like `rn -S'.
  381. `gnus-auto-center-summary'
  382.      Non-`nil' means that the cursor is always kept centered in the
  383.      Summary Mode window.
  384. `gnus-auto-mail-to-author'
  385.      Non-`nil' means that inserts `To:' field which is filled with the
  386.      author of the article when followuping.  Mail is sent using the
  387.      function specified by the variable `gnus-mail-send-method'.
  388. `gnus-break-pages'
  389.      Non-`nil' means an article is broken into pages at page delimiters.
  390.      The page delimiter is specified by the variable
  391.      `gnus-page-delimiter'.  This may not work with some versions of GNU
  392.      Emacs earlier than version 18.50.
  393. `gnus-page-delimiter'
  394.      Specifies regexp describing line-beginnings that separate pages of
  395.      articles.  Its default value is `"^\^L"'.
  396. `gnus-digest-show-summary'
  397.      Non-`nil' means that a summary of digest messages is shown when
  398.      reading a digest article using the command
  399.      `gnus-summary-rmail-digest'.
  400. `gnus-digest-separator'
  401.      Specifies a regexp which separates messages in a digest article.
  402.      Changes to this variable only affect the commands
  403.      `gnus-summary-next-digest' and `gnus-summary-prev-digest', but not
  404.      the command `gnus-summary-rmail-digest'.
  405. `gnus-optional-headers'
  406.      Specifies a function which generates an optional string displayed
  407.      in the Summary buffer.  The function is called with an article
  408.      HEADERS, and must return a string excluding `[' and `]'.  HEADERS
  409.      is a vector containing headers of the current article.  Macros and
  410.      functions accessing contents of the HEADERS are defined as
  411.      `nntp-header-FIELD' and `gnus-header-FIELD', respectively.
  412.      GNUS provides two functions as follows:
  413.     `gnus-optional-lines-and-from'
  414.           Return a string like "NNN:AUTHOR", where NNN is the number of
  415.           lines in an article and AUTHOR is the name of the author.
  416.     `gnus-optional-lines'
  417.           Return a string like "NNN", where NNN is the number of lines
  418.           in an article.
  419.      *Note Hooks::, to change optional headers according to selected
  420.      newsgroups.
  421. `gnus-show-mime-method'
  422.      Specifies a function to process a MIME message in current buffer.
  423.      The function `metamail-buffer' which process the buffer through
  424.      `metamail' is called by default.
  425. `gnus-mail-reply-method'
  426.      Specifies a function to begin composing reply mail messages.  The
  427.      function will be called with an optional argument which means yank
  428.      original article automatically if non-`nil'.  To use Mail Mode, set
  429.      the variable to `gnus-mail-reply-using-mail'.  To use mh-e letter
  430.      Mode, set the variable to `gnus-mail-reply-using-mhe'.
  431. `gnus-mail-forward-method'
  432.      Specifies a function to forward the current message to another
  433.      user.  To use Mail Mode, set the variable to
  434.      `gnus-mail-forward-using-mail'.  To use mh-e letter Mode, set the
  435.      variable to `gnus-mail-forward-using-mhe'.
  436. `gnus-mail-other-window-method'
  437.      Specifies a function to begin composing mail messages in other
  438.      window.  To use Mail Mode, set the variable to
  439.      `gnus-mail-other-window-using-mail'.  To use mh-e letter Mode, set
  440.      the variable to `gnus-mail-other-window-using-mhe'.
  441. `gnus-mail-send-method'
  442.      Specifies a function to mail a message too which is being posted
  443.      as an article.  The message must have `To:' or `Cc:' field.  The
  444.      value of the variable `send-mail-function' is the default function
  445.      which uses sendmail mail program.
  446. `gnus-subscribe-newsgroup-method'
  447.      Specifies a function called with a newsgroup name when a new
  448.      newsgroup is found.  GNUS provides the following three functions:
  449.     `gnus-subscribe-randomly'
  450.           Inserts a new newsgroup at the beginning of newsgroups.  Thus,
  451.           newsgroups are in random order.
  452.     `gnus-subscribe-alphabetically'
  453.           Inserts a new newsgroup in strict alphabetic order.
  454.     `gnus-subscribe-hierarchically'
  455.           Inserts a new newsgroup in hierarchical newsgroup order.
  456.     `gnus-subscribe-interactively'
  457.           Asks for your decision about a new newsgroup subscription,
  458.           and inserts it in hierarchical newsgroup order if it is
  459.           subscribed.  Unless, it is killed.
  460.      The following two definitions illustrate how to write your favorite
  461.      subscribing method.  The following definition (is the definition
  462.      of the function gnus-subscribe-randomly) adds new newsgroup at the
  463.      beginning of newsgroups:
  464.           (setq gnus-subscribe-newsgroup-method
  465.                 '(lambda (newsgroup)
  466.                    (gnus-subscribe-newsgroup newsgroup
  467.                                              (car (car gnus-newsrc-assoc)))))
  468.      Instead, if you want to add new newsgroup at the end of
  469.      newsgroups, use the following:
  470.           (setq gnus-subscribe-newsgroup-method
  471.                 '(lambda (newsgroup)
  472.                    (gnus-subscribe-newsgroup newsgroup nil)))
  473.      If you want to prevent adding new newsgroups automatically and
  474.      want to subscribe them later using the command `U'
  475.      (`gnus-group-unsubscribe-group') in the Newsgroup buffer, use the
  476.      following:
  477.           (setq gnus-subscribe-newsgroup-method
  478.                 '(lambda (newsgroup) nil))        ;Do nothing.
  479.      The following final example must be the most useful for you who
  480.      want not to add new newsgroups automatically.  This definition
  481.      subscribes a new newsgroup first, and then kills it.  The killed
  482.      newsgroups can be added to the subscription list interactively
  483.      using Browse-Killed Mode (*note Maintaining Subscriptions::.).
  484.           (setq gnus-subscribe-newsgroup-method
  485.                 '(lambda (newsgroup)
  486.                    (gnus-subscribe-newsgroup newsgroup)
  487.                    (gnus-kill-newsgroup newsgroup)))
  488. File: gnus,  Node: NNTP Variables,  Next: Spool Variables,  Prev: Variables,  Up: Customization
  489. NNTP Specific Variables
  490. =======================
  491. `nntp-buggy-select'
  492.      Non-`nil' means the select routine of your operating system is
  493.      buggy.  GNUS may hang up while waiting for NNTP server responses.
  494.      The problem may be solved by setting the variable to `t'.
  495. `nntp-maximum-request'
  496.      Specifies the maximum number of requests to be sent to the NNTP
  497.      server at one time.  GNUS may hang up while retrieving headers of
  498.      a large newsgroup because sending many requests to the NNTP server
  499.      without reading replies to them causes deadlock.  In this case,
  500.      set the variable to a lower number.
  501. `nntp-large-newsgroup'
  502.      Specifies the number of articles which indicates a large
  503.      newsgroup.  If the number of articles is greater than the value,
  504.      verbose messages will be shown to indicate the current status.
  505. `nntp-debug-read'
  506.      Non-`nil' means display dots "..." every 10000 bytes of a message
  507.      being received.  If it is a number, dots are displayed per the
  508.      number.  Set the variable to `nil' if you are annoyed about
  509.      verbose messages while reading news from slow terminal.
  510. `tcp-program-name'
  511.      This variable specifies the name of the program which establishes
  512.      communications between Emacs and the NNTP server.  Its default
  513.      value is `"tcp"'.  (the program `tcp' comes with GNU Emacs.)  This
  514.      variable is relevant only if you load the library `tcp.el', which
  515.      you should do only if your Emacs does not have the function
  516.      `open-network-stream'.
  517. File: gnus,  Node: Spool Variables,  Next: Directory Variables,  Prev: NNTP Variables,  Up: Customization
  518. Local News Spool Specific Variables
  519. ===================================
  520. `nnspool-inews-program'
  521.      Specifies a program to post news.  This is default to the variable
  522.      `news-inews-program' which is default to `inews'.
  523. `nnspool-inews-switches'
  524.      Specifies switches for the function `nnspool-request-post' to pass
  525.      to the command `inews' for posting news.  Its default value is
  526.      `("-h")'.
  527. `nnspool-spool-directory'
  528.      Specifies a directory of a local news spool.  This is default to
  529.      the variable `news-path' which is default to `/usr/spool/news'.
  530. `nnspool-active-file'
  531.      Specifies an active file of the system for a local news spool.  Its
  532.      default value is `/usr/lib/news/active'.
  533. `nnspool-newsgroups-file'
  534.      Specifies an newsgroups file of the system for a local news spool.
  535.      Its default value is `/usr/lib/news/newsgroups'.
  536. `nnspool-distributions-file'
  537.      Specifies an distributions file of the system for a local news
  538.      spool.  Its default value is `/usr/lib/news/distributions'.
  539. `nnspool-history-file'
  540.      Specifies a history file of the system for a local news spool.  Its
  541.      default value is `/usr/lib/news/history'.  Some machines may not
  542.      have this file.  In this case, commands to refer to articles by
  543.      Message-IDs will not work at all (*note Referencing Articles::.).
  544. File: gnus,  Node: Directory Variables,  Next: Hooks,  Prev: Spool Variables,  Up: Customization
  545. Private Directory Specific Variables
  546. ====================================
  547. `mhspool-list-folders-method'
  548.      Specifies a function to fill the current buffer with file and
  549.      directory names for a given directory name.  The output format
  550.      must be the same as that of the Unix command `ls -R1'.  Two
  551.      functions `mhspool-list-folders-using-ls' and
  552.      `mhspool-list-folders-using-sh' are provided now.
  553. `mhspool-list-directory-switches'
  554.      Specifies switches for the function `mhspool-list-folders-using-ls'
  555.      to pass to the command `ls' for getting file listings in a private
  556.      directory.  There should be one entry for each line.  Its default
  557.      value is `("-R")'.  Some machines may require the `("-R1")' switch.
  558. File: gnus,  Node: Hooks,  Prev: Directory Variables,  Up: Customization
  559. Function Hooks
  560. ==============
  561. `gnus-group-mode-hook'
  562.      Called with no arguments after initializing Group Mode if its
  563.      value is non-`nil'.  This hook is intended to customize Group Mode
  564.      only once.  It is possible to define or change the NNTP server as
  565.      you like in this hook since the hook is called before GNUS is
  566.      connected to an NNTP server.
  567. `gnus-summary-mode-hook'
  568.      Called with no arguments after initializing Summary Mode if its
  569.      value is non-`nil'.  This hook is intended to customize Summary
  570.      Mode only once.  All sorts of searches in Summary Mode normally
  571.      ignore the case of the text they are searching through.  If you do
  572.      not want to ignore the case, set the variable `case-fold-search'
  573.      to `nil' in this hook.
  574.      The following example shows how to assign the functions
  575.      `gnus-summary-next-group' and `gnus-summary-prev-group' to keys in
  576.      Summary Mode.
  577.           (setq gnus-summary-mode-hook
  578.                 '(lambda ()
  579.                    (local-set-key "\C-cn" 'gnus-summary-next-group)
  580.                    (local-set-key "\C-cp" 'gnus-summary-prev-group)))
  581. `gnus-article-mode-hook'
  582.      Called with no arguments after initializing Article Mode if its
  583.      value is non-`nil'.  This hook is intended to customize Article
  584.      Mode only once.
  585. `gnus-kill-file-mode-hook'
  586.      Called with no arguments after initializing Kill-File Mode if its
  587.      value is non-`nil'.
  588. `gnus-browse-killed-mode-hook'
  589.      Called with no arguments after initializing Browse-Killed Mode if
  590.      its value is non-`nil'.
  591. `gnus-open-server-hook'
  592.      Called with no arguments just before opening a connection to NNTP
  593.      server if its value is non-`nil'.
  594. `gnus-startup-hook'
  595.      Called with no arguments after an NNTP server is successfully
  596.      connected to if its value is non-`nil'.  It is possible to change
  597.      the behavior of GNUS according to the server.
  598. `gnus-group-prepare-hook'
  599.      Called with no arguments after a list of newsgroups is prepared in
  600.      the Newsgroup buffer.  This hook is intended to modify the buffer.
  601. `gnus-summary-prepare-hook'
  602.      Called with no arguments after list of subjects is prepared in the
  603.      Summary buffer.  This hook is intended to modify the buffer.
  604. `gnus-article-prepare-hook'
  605.      Called with no arguments after an article is prepared in the
  606.      Article buffer.  This hook is intended to modify the buffer.  For
  607.      example, kanji code conversion or un-ROT13/47-ing can be done in
  608.      this hook.
  609. `gnus-select-group-hook'
  610.      Called with no arguments when a newsgroup is selected.  This hook
  611.      is intended to change the behavior of GNUS according to the
  612.      selected newsgroup.
  613.      The following is an example of sorting the headers listed in the
  614.      Summary buffer by date and then by subject.  Preceding `Re:' of
  615.      subjects is ignored while comparing subjects.
  616.           (setq gnus-select-group-hook
  617.                 '(lambda ()
  618.                    ;; First of all, sort by date.
  619.                    (gnus-keysort-headers
  620.                     (function string-lessp)
  621.                     (function
  622.                      (lambda (a)
  623.                        (gnus-sortable-date (gnus-header-date a)))))
  624.                    ;; Then sort by subject ignoring `Re:'.
  625.                    (gnus-keysort-headers
  626.                     (function string-lessp)
  627.                     (function
  628.                      (lambda (a)
  629.                        (if case-fold-search
  630.                            (downcase (gnus-simplify-subject (gnus-header-subject a) t))
  631.                          (gnus-simplify-subject (gnus-header-subject a) t)))))
  632.                   ))
  633.      The following is an example of simplifying subjects like the
  634.      `gnus-summary-next-same-subject' command does:
  635.           (setq gnus-select-group-hook
  636.                 '(lambda ()
  637.                    (mapcar (function
  638.                             (lambda (header)
  639.                               (nntp-set-header-subject
  640.                                header
  641.                                (gnus-simplify-subject
  642.                                 (gnus-header-subject header) 're-only))))
  643.                            gnus-newsgroup-headers)))
  644.      In some newsgroups, author names are meaningless.  It is possible
  645.      to prevent listing author names in the Summary buffer as follows:
  646.           (setq gnus-select-group-hook
  647.                 '(lambda ()
  648.                    (cond ((string-equal "comp.sources.unix"
  649.                                         gnus-newsgroup-name)
  650.                           (setq gnus-optional-headers
  651.                                 (function gnus-optional-lines)))
  652.                          (t
  653.                           (setq gnus-optional-headers
  654.                                 (function
  655.                                    gnus-optional-lines-and-from))))))
  656. `gnus-select-article-hook'
  657.      Called with no arguments when an article is selected if its value
  658.      is non-`nil'.
  659.      The default hook definition shows conversation thread subtrees of
  660.      the selected article automatically as follows:
  661.           (setq gnus-select-article-hook
  662.                 '(lambda ()
  663.                    (gnus-summary-show-thread)))
  664.      It is possible to run Rmail on a digest article automatically as
  665.      follows:
  666.           (setq gnus-select-article-hook
  667.                 '(lambda ()
  668.                    (gnus-summary-show-thread)
  669.                    (cond ((string-equal "comp.sys.sun"
  670.                                         gnus-newsgroup-name)
  671.                           (gnus-summary-rmail-digest))
  672.                          ((and (string-equal "comp.text"
  673.                                              gnus-newsgroup-name)
  674.                                (string-match "^TeXhax Digest"
  675.                                              (gnus-header-subject
  676.                                                 gnus-current-headers)))
  677.                           (gnus-summary-rmail-digest)
  678.                           ))))
  679. `gnus-select-digest-hook'
  680.      Called with no arguments when reading digest messages using Rmail
  681.      if its value is non-`nil'.  This hook is intended to modify an
  682.      article so that Rmail can work with it.  *Note Digest Articles::,
  683.      for more information on digest articles.
  684.      The following example is the default hook definition to modify
  685.      incomplete digest articles:
  686.           (setq gnus-select-digest-hook
  687.                 '(lambda ()
  688.                    ;; Reply-To: is required by
  689.                    ;; `undigestify-rmail-message'.
  690.                    (or (mail-position-on-field "Reply-to" t)
  691.                        (progn
  692.                          (mail-position-on-field "Reply-to")
  693.                          (insert (gnus-fetch-field "From"))))))
  694. `gnus-rmail-digest-hook'
  695.      Called with no arguments when reading digest messages using Rmail
  696.      if its value is non-`nil'.  This hook is intended to customize
  697.      Rmail Mode for reading digest articles.
  698. `gnus-apply-kill-hook'
  699.      Called with no arguments when a newsgroup is selected and the
  700.      Summary buffer is prepared if its value is non-`nil'.  This hook
  701.      is intended to apply kill files to the selected newsgroup.  It is
  702.      set to the function `gnus-apply-kill-file' by default.
  703.      Since a general kill file is too heavy to use only for a few
  704.      newsgroups, a lighter hook function is recommended.  For example,
  705.      if you'd like to apply kills to articles which contain the string
  706.      `rmgroup' in subject in newsgroup `control', you can use the
  707.      following hook:
  708.           (setq gnus-apply-kill-hook
  709.                 '(lambda ()
  710.                    (cond ((string-match "control" gnus-newsgroup-name)
  711.                           (gnus-kill "Subject" "rmgroup")
  712.                           (gnus-expunge "X")))))
  713.      *Note Kill File::, for more information on kill files.
  714. `gnus-mark-article-hook'
  715.      Called with no arguments when an article is selected for the first
  716.      time if its value is non-`nil'.  The hook is intended to mark an
  717.      article as read (or saved) automatically when it is selected.
  718.      The following example is the default definition of the hook:
  719.           (setq gnus-mark-article-hook
  720.                 '(lambda ()
  721.                    ;; Mark the selected article as read.
  722.                    (or (memq gnus-current-article gnus-newsgroup-marked)
  723.                        (gnus-summary-mark-as-read gnus-current-article))
  724.                    ;; Put "+" on the current subject.
  725.                    (gnus-summary-set-current-mark "+")
  726.                    ))
  727.      It is possible to mark as saved (`-') instead when an article is
  728.      selected as follows:
  729.           (setq gnus-mark-article-hook
  730.                 '(lambda ()
  731.                    ;; Mark the selected article as saved.
  732.                    (gnus-summary-mark-as-unread gnus-current-article)
  733.                    ;; Put "+" on the current subject.
  734.                    (gnus-summary-set-current-mark "+")
  735.                    ))
  736. `gnus-prepare-article-hook'
  737.      Called with no arguments after preparing message body, but before
  738.      preparing header fields which is automatically generated if its
  739.      value is non-`nil'.  Text changes made by this hook does not
  740.      affect on the editing text.  The default hook inserts a signature
  741.      file by calling the function `gnus-inews-insert-signature'.
  742. `gnus-inews-article-hook'
  743.      Called with no arguments before posting an article if its value is
  744.      non-`nil'.  This hook is called just before sending an article to
  745.      the NNTP server or calling the `inews' program.  Text changes made
  746.      by this hook does not affect on the editing text.  It is no
  747.      recommended to alter the number of lines of the article since
  748.      `Lines:' field may be already there.  The default hook does FCC
  749.      (save an article to the specified file) by calling the function
  750.      `gnus-inews-do-fcc'.
  751. `gnus-exit-group-hook'
  752.      Called with no arguments when exiting the current newsgroup if its
  753.      value is non-`nil'.  If your machine is so slow that exiting from
  754.      Summary Mode takes a long time, you can inhibit marking articles
  755.      as read by using cross-reference information in the `Xref:' field
  756.      by setting the variable `gnus-newsgroup-headers' to `nil' in this
  757.      hook.
  758. `gnus-exit-gnus-hook'
  759.      Called with no arguments when exiting GNUS if its value is
  760.      non-`nil'.  If you want to clear out Emacs buffers which were
  761.      created by GNUS and remain afterwards, you can use this hook.
  762.      The following example shows how to kill a buffer which was used for
  763.      posting news.
  764.           (setq gnus-exit-gnus-hook
  765.                 '(lambda ()
  766.                    ;; Kill a buffer used for posting news.
  767.                    (and (get-buffer "*post-news*")
  768.                         (kill-buffer "*post-news*"))))
  769. `gnus-suspend-gnus-hook'
  770.      Called with no arguments when suspending GNUS if its value is
  771.      non-`nil'.  The purpose is the same as the hook
  772.      `gnus-exit-gnus-hook'.
  773. `gnus-save-newsrc-hook'
  774.      Called with no arguments before saving the startup file `.newsrc'
  775.      if its value is non-`nil'.  This hook is intended to change the way
  776.      of backing up the startup file.
  777. File: gnus,  Node: Troubleshooting,  Next: Customization,  Prev: Kill File,  Up: Top
  778. Troubleshooting GNUS
  779. ********************
  780.    Emacs may hang up while waiting for NNTP server responses.  This may
  781. be caused by a buggy select routine of your operating system.  If so,
  782. the problem may be solved by loading the source code for the library
  783. `nntp.el' instead of running the byte-compiled version.  If you still
  784. have problems with it, set the variable `nntp-buggy-select' to `t'.
  785.    Emacs may hang up while retrieving headers of a large newsgroup.  The
  786. reason is that too many requests have been sent to the NNTP server
  787. without reading replies to them.  This causes a deadlock of Emacs and
  788. the server.  In this case, the number of requests sent to the server at
  789. one time must be reduced.  Set the variable `nntp-maximum-request' to a
  790. lower value than the default.  The optimal value depends on your
  791. computing environment.
  792. File: gnus,  Node: Reporting Bugs,  Next: Index,  Prev: Customization,  Up: Top
  793. Reporting Bugs
  794. **************
  795. Mailing Lists and USENET Newsgroup
  796. ==================================
  797.    There are two mailing lists and one USENET newsgroup for discussing
  798. GNUS related topics.  These are intended for exchanging useful
  799. information about GNUS, such as bug reports, useful hooks, and
  800. extensions of GNUS.  If you have any questions or problems, feel free to
  801. ask about them.  Suggestions are also welcome.
  802. `gnu.emacs.gnus'
  803.      This is a USENET newsgroup under the gnu.all hierarchy which is
  804.      concerned with the GNU Project of the Free Software Foundation.
  805. `info-gnus-english@tut.cis.ohio-state.edu'
  806.      This is an Internet mailing list which is gated bi-directionally
  807.      with the gnu.emacs.gnus newsgroup.  English is the official
  808.      language of the list.  Please send subscription requests to:
  809.           info-gnus-english-request@tut.cis.ohio-state.edu
  810. `info-gnus@flab.Fujitsu.CO.JP'
  811.      This is a JUNET mailing list.  Messages of info-gnus-english and
  812.      gnu.emacs.gnus are forwarded to this list.  English and Japanese
  813.      are the official languages of the list.  Please send subscription
  814.      requests to:
  815.           info-gnus-request@flab.Fujitsu.CO.JP
  816.    The major difference between info-gnus-english/gnu.emacs.gnus and
  817. info-gnus is the official language.  There is no need to subscribe to
  818. info-gnus if you cannot read messages written in Japanese since most
  819. discussions and important announcements will be sent to
  820. info-gnus-english.
  821. How to Report a Bug
  822. ===================
  823.    If you find a bug, it is important to report it and to report it in a
  824. way which is useful.  If it is a bug of a lisp program, what is the most
  825. useful is an exact backtrace information of the lisp program together
  826. with the version number of GNUS that you are using.
  827.    To make the backtrace information, you must set the Emacs variable
  828. `debug-on-error' to `t' before the error happens.  A backtrace obtained
  829. from a byte-compiled lisp program is not usually understandable.  To
  830. make a human readable backtrace, load the source program which is not
  831. byte-compiled yet and then produce the error.
  832.    *note Reporting Bugs: (emacs)Bugs, for more information.
  833.