cgit.sxemacs.org Git - gnus/blob - texi/gnusref.tex

   1 %% include file for the Gnus refcard and booklet
   2
   3 \def\progver{5.10}\def\refver{5.10-1} % program and refcard versions
   4 \def\date{Oct 13th, 2001}
   5 \def\author{Gnus Bugfixing Girls + Boys $<$bugs@gnus.org$>$}
   6
   7 %%
   8 \newlength{\keycolwidth}
   9 \newenvironment{keys}[1]% #1 is the widest key
  10 {\nopagebreak%\noindent%
  11   \settowidth{\keycolwidth}{#1}%
  12   \addtolength{\keycolwidth}{\tabcolsep}%
  13   \addtolength{\keycolwidth}{-\columnwidth}%
  14   \begin{supertabular}{@{}l@{\hspace{\tabcolsep}}p{-\keycolwidth}@{}}}%
  15   {\end{supertabular}\\}
  16
  17 %% uncomment the first definition if you do not want pagebreaks in maps
  18 %%\newcommand{\esamepage}{\samepage}
  19 \newcommand{\esamepage}{}
  20
  21 \newcommand*{\B}[1]{{\bf#1})}    % bold l)etter
  22
  23 \newcommand{\Title}{%
  24   \begin{center}
  25     {\bf\LARGE Gnus \progver\ Reference \Guide\\}
  26                                 %{\normalsize \Guide\ version \refver}
  27   \end{center}
  28   }
  29
  30 \newcommand*{\Logo}[1]{\centerline{%
  31     \makebox[\logoscale\logowidth][l]{\vbox to \logoscale\logoheight
  32       {\vfill\epsfig{figure=gnuslogo-#1}}\vspace{-\baselineskip}}}}
  33
  34 \newcommand{\Copyright}{%
  35   \begin{center}
  36     Copyright \copyright\ 1995 Free Software Foundation, Inc.\\*
  37     Copyright \copyright\ 1995 Vladimir Alexiev
  38     $<$vladimir@cs.ualberta.ca$>$.\\*
  39     Copyright \copyright\ 2000 Felix Natter $<$fnatter@gmx.net$>$.\\*
  40     Copyright \copyright\ 2001, 2002 \author.\\*
  41     Created from the Gnus manual Copyright \copyright\ 1994 Lars Magne
  42     Ingebrigtsen.\\*
  43     and the Emacs Help Bindings feature (C-h b).\\*
  44     Gnus logo copyright \copyright\ 1995 Luis Fernandes.\\*
  45   \end{center}
  46
  47   Permission is granted to make and distribute copies of this reference
  48   \guide{} provided the copyright notice and this permission are preserved on
  49   all copies.  Please send corrections, additions and suggestions to the
  50   current maintainer's email address. \Guide{} last edited on \date.
  51   }
  52
  53 \newcommand{\Notes}{%
  54   \subsection*{Notes}
  55   {\esamepage
  56     Gnus is complex. Currently it has some 346 interactive (user-callable)
  57     functions. Of these 279 are in the two major modes (Group and
  58     Summary/Article). Many of these functions have more than one binding, some
  59     have 3 or even 4 bindings. The total number of keybindings is 389. So in
  60     order to save 40\% space, every function is listed only once on this
  61     \guide, under the ``more logical'' binding. Alternative bindings are given
  62     in parentheses in the beginning of the description.
  63
  64     Many Gnus commands are affected by the numeric prefix. Normally you enter a
  65     prefix by holding the Meta key and typing a number, but in most Gnus modes
  66     you don't need to use Meta since the digits are not self-inserting. The
  67     prefixed behavior of commands is given in [brackets]. Often the prefix is
  68     used to specify:
  69
  70     \quad [distance] How many objects to move the point over.
  71
  72     \quad [scope] How many objects to operate on (including the current one).
  73
  74     \quad [p/p] The ``Process/Prefix Convention'': If a prefix is given then it
  75     determines how many objects to operate on. Else if there are some objects
  76     marked with the process mark \#, these are operated on. Else only the
  77     current object is affected.
  78
  79     \quad [level] A group subscribedness level. Only groups with a lower or
  80     equal level will be affected by the operation. If no prefix is given,
  81     `gnus-group-default-list-level' is used.  If
  82     `gnus-group-use-permanent-levels', then a prefix to the `g' and `l'
  83     commands will also set the default level.
  84
  85     \quad [score] An article score. If no prefix is given,
  86     `gnus-summary-default-score' is used. \\*[\baselineskip]
  87                                 % some keys
  88     Gnus startup-commands:
  89     \begin{keys}{M-x gnus-unplugged}
  90       M-x gnus           & start Gnus. \\
  91       M-x gnus-no-server & start Gnus without connecting to server
  92       (i.e. to read mail). \\
  93     \end{keys}
  94     Additionally, there are the two commands \texttt{gnus-plugged} and
  95     \texttt{gnus-unplugged}, which are only used if you want to download
  96     news and/or read previously downloaded news offline (see C-c C-i g Gnus
  97     Unplugged RET). Note: \texttt{gnus-no-server} ignores the stuff in
  98     \texttt{gnus-agent-directory}, and thus does not allow you to use Gnus
  99     Unplugged.
 100                                 %
 101     \begin{keys}{C-c C-i}
 102       C-c C-i & Go to the Gnus online {\bf info}.\\
 103       C-c C-b & Send a Gnus {\bf bug} report.\\
 104     \end{keys}
 105     }}
 106
 107 \newcommand{\GroupLevels}{%
 108   The table below assumes that you use the default Gnus levels.
 109   Fill your user-specific levels in the blank cells.\\[1\baselineskip]
 110   \begin{tabular}{|c|l|l|}
 111     \hline
 112     Level & Groups & Status \\
 113     \hline
 114     1 & draft/mail groups   &              \\
 115     2 & mail groups         &              \\
 116     3 &                     & subscribed   \\
 117     4 &                     &              \\
 118     5 & default list level  &              \\
 119     \hline
 120     6 &                     & unsubscribed \\
 121     7 &                     &              \\
 122     \hline
 123     8 &                     & zombies      \\
 124     \hline
 125     9 &                     & killed       \\
 126     \hline
 127   \end{tabular}}
 128
 129 \newcommand{\MarkCharacters}{%
 130   {\esamepage If a command directly sets a mark, it is shown in parentheses.\\*
 131     \newlength{\markcolwidth}
 132     \settowidth{\markcolwidth}{` '}% widest character
 133     \addtolength{\markcolwidth}{4\tabcolsep}
 134     \addtolength{\markcolwidth}{-\columnwidth}
 135     \newlength{\markdblcolwidth}
 136     \setlength{\markdblcolwidth}{\columnwidth}
 137     \addtolength{\markdblcolwidth}{-2\tabcolsep}
 138     \begin{tabular}{|c|p{-\markcolwidth}|}
 139       \hline
 140       \multicolumn{2}{|p{\markdblcolwidth}|}{{\bf ``Read'' Marks.}
 141         All these marks appear in the first column of the summary line, and so
 142         are mutually exclusive.}\\
 143       \hline
 144       ` ' & (M-u, M SPC, M c) Not read.\\
 145       !   & (!, M !, M t) Ticked (interesting).\\
 146       ?   & (?, M ?) Dormant (only followups are interesting).\\
 147       E   & (E, M e, M x) {\bf Expirable}. Only has effect in mail groups.\\
 148       G   & (C, B DEL) Canceled article (or deleted in mailgroups).\\
 149       \hline\hline
 150       \multicolumn{2}{|p{\markdblcolwidth}|}
 151       {The marks below mean that the article
 152         is read (killed, uninteresting), and have more or less the same effect.
 153         Some commands however explicitly differentiate between them (e.g.\ M
 154         M-C-r, adaptive scoring).}\\
 155       \hline
 156       r   & (d, M d, M r) Deleted (marked as {\bf read}).\\
 157       C   & (M C; M C-c; M H; c, Z c; Z n; Z C) Killed by {\bf catch-up}.\\
 158       F   & SOUPed article. See the manual.\\
 159       O   & {\bf Old} (read in a previous session).\\
 160       K   & (k, M k; C-k, M K) {\bf Killed}.\\
 161       M   & Article marked as read by duplicate suppression.\\
 162       Q   & Article is part of a sparse thread (see ``Threading''
 163       in the manual).\\
 164       R   & {\bf Read} (viewed in actuality).\\
 165       X   & Killed by a kill file.\\
 166       Y   & Killed due to low score.\\
 167       \hline\multicolumn{2}{c}{\vspace{1ex}}\\\hline
 168       \multicolumn{2}{|p{\markd