[gnus] / texi / refcard.tex

% Reference Card for (ding) Gnus 0.98
% by Vladimir Alexiev <vladimir@cs.ualberta.ca>, 26 July 1995.
% To be processed with latex 2.09
\documentstyle{article}
\textwidth 7.5in \textheight 10in \topmargin -1.0in
%\textwidth 7.27in \textheight 10.69in \topmargin -1.69in 
% use this alternative setting for A4 (or leave it alone if you don't mind
% a bit of space at the top and bottom of the page).
\oddsidemargin -0.5in \evensidemargin -0.5in
\begin{document}
\twocolumn\scriptsize\pagestyle{empty}
\raggedbottom\raggedright
\newlength{\mywidth}
\setlength{\mywidth}{0.5\textwidth}
\addtolength{\mywidth}{-0.75in}
\newenvironment{keys}
  {\nopagebreak[4]\begin{tabular}{@{}l@{\hspace{\tabcolsep}}p{\mywidth}@{}}}
  {\end{tabular}\\}
\catcode`\^=12 % allow ^ to be typed literally
\def\Bar{\rule[-0.3ex]{0.5pt}{2ex}\hspace{0.1em}} % the bar | symbol

\begin{center}
{\bf\LARGE (ding) Gnus Reference Card\\}
{\normalsize for version 0.98}
\end{center}

Gnus is complex. Currently it has some 346 interactive (user-callable)
functions. Of these 279 have keybindings in the two major modes (Group and
Summary/Article). Of these functions, 96 have more than one binding; some
have 3 or even 4 bindings. The total number of keybindings is 389. In order
to save 40\% space, every function is listed only once, under the ``more
logical'' binding. Alternative bindings are given in parentheses in the
beginning of the description.

Many Gnus commands are affected by the numeric prefix. Normally you enter a
prefix by holding the Meta key and typing a number, but in most Gnus modes
you don't need to use Meta since the digits are not self-inserting. The
prefixed behavior of commands is given in [brackets]. Often the prefix is
used to specify:

\quad [distance] How many objects to move the point over.

\quad [scope] How many objects to operate on (including the current one).

\quad [p/p] The ``Process/Prefix Convention'': If a prefix is specified
then it determines how many objects to operate on. Else if there are some
objects marked with the process mark \#, these are operated on. Else only
the current object is affected.

\quad [level] A group subscribedness level. Only groups with a lower or
equal level will be affected by the operation. If no prefix is given,
`gnus-group-default-list-level' is used.  If
`gnus-group-use-permanent-levels', then a prefix to the `g' and `l'
commands will also set the default level.

\quad [score] An article score. If no prefix is given,
`gnus-summary-default-score' is used.

Some functions were not yet documented at the time of creating this
reference card and are clearly indicated as such.

\begin{keys}
C-c C-i & Go to the Gnus info node.\\
C-c C-b & Send a Gnus bug report.\\
\end{keys}

\section*{Group Mode}
\begin{keys}
RET     & (=) Select this group. [Prefix: how many articles to fetch.
Positive: newest articles, negative: oldest ones.]\\
SPC     & Select this group and display the first unread article. [Same
prefix as above.]\\ 
?       & Give a very short help message.\\
$<$     & Go to the beginning of the Group buffer.\\
$>$     & Go to the end of the Group buffer.\\
,       & Jump to the unread group with the lowest level.\\
.       & Jump to the first group with unread articles.\\
^       & Enter the Server buffer mode.\\
a       & Post an article to a group.\\
b       & Find bogus groups and delete them.\\
c       & Mark all unticked articles in this group as read (catchup). [p/p]\\
g       & Check the server for new articles. [level]\\
j       & Jump to a group.\\
l       & List groups with unread articles. [level]\\
m       & Mail a message to someone.\\
n       & Go to the next group with unread articles. [distance]\\
p       & (DEL) Go to the previous group with unread articles. [distance]\\
q       & Quit Gnus.\\
r       & Read the init file.\\
s       & Save the `.newsrc.eld' file (and `.newsrc' if
`gnus-save-newsrc-file').\\ 
z       & Suspend (kill all buffers of) Gnus.\\
B       & Browse a foreign server.\\
C       & Mark all articles in this group as read (catchup). [p/p]\\
F       & Find new groups and process them.\\
L       & List all groups. [level]\\
N       & Go to the next group. [distance]\\
P       & Go to the previous group. [distance]\\
Q       & Quit Gnus without saving any startup files.\\
R       & Restart Gnus.\\
V       & Display the Gnus version number.\\
Z       & Clear the dribble buffer.\\
C-c C-d & Show the description of this group. [Prefix: re-read it from the
server.]\\ 
C-c C-s & Sort the groups by name, number of unread articles, or level
(depending on `gnus-group-sort-function').\\
C-c C-x & Run all expirable articles in this group through the expiry 
process.\\
C-c M-C-x & Run all articles in all groups through the expiry process.\\
C-x C-t & Transpose two groups.\\
M-d     & Describe ALL groups. [Prefix: re-read the description from the
server.]\\
M-f     & Fetch this group's FAQ (using ange-ftp).\\
M-g     & Check for new articles in this group. [p/p]\\
M-n     & Go to the previous unread group of the same or lower level. [distance]\\
M-p     & Go to the next unread group of the same or lower level. [distance]\\
\end{keys}

\subsection*{List Groups}
\begin{keys}
A a     & (C-c C-a) List all groups whose names match a regexp (apropos).\\
A d     & List all groups whose names or descriptions match a regexp.\\ 
A k     & (C-c C-l) List all killed groups.\\
A m     & List groups that match a regexp and have unread articles. [level]\\
A s     & (l) List groups with unread articles. [level]\\
A u     & (L) List all groups. [If no prefix is given, level 7 is the
default]\\ 
A z     & List all zombie groups.\\
A M     & List groups that match a regexp.\\
\end{keys}

\subsection*{Create/Edit Foreign Groups}
The select methods are indicated in parentheses.\\*
\begin{keys}
G a     & Make the Gnus list archive group. (nndir over ange-ftp)\\
G d     & Make a directory group (every file must be a posting and files
must have numeric names). (nndir)\\
G e     & (M-e) Edit this group's select method.\\
G f     & Make a group based on a file. (nndoc)\\
G h     & Make the (ding) Gnus help (documentation) group. (nndoc)\\
G k     & Make a kiboze group. (nnkiboze)\\
G m     & Make a new group.\\
G p     & Edit this group's parameters.\\
G v     & Add this group to a virtual group. [p/p]\\
G D     & Enter a directory as a (temporary) group. (nneething without
recording articles read.)\\
G E     & Edit this group's info (select method, articles read, etc).\\
G V     & Make a new empty virtual group. (nnvirtual)\\
\end{keys}
You can also create mail-groups and read your mail with Gnus (very useful
if you are subscribed to any mailing lists), using one of the methods
nnmbox, nnbabyl, nnml, nnmh, or nnfolder. Read about it in the online info
(C-c C-i g Reading Mail RET).

\subsubsection*{Soup Commands}
\begin{keys}
G s b   & gnus-group-brew-soup: not documented.\\
G s p   & gnus-soup-pack-packet: not documented.\\
G s r   & nnsoup-pack-replies: not documented.\\
G s s   & gnus-soup-send-replies: not documented.\\
G s w   & gnus-soup-save-areas: not documented.\\
\end{keys}

\subsection*{Mark Groups}
\begin{keys}
M m     & (\#) Set the process mark on this group. [scope]\\
M u     & (M-\#) Remove the process mark from this group. [scope]\\
M w     & Mark all groups in the current region.\\
\end{keys}

\subsection*{Unsubscribe, Kill and Yank Groups}
\begin{keys}
S k     & (C-k) Kill this group.\\
S l     & Set the level of this group. [p/p]\\
S s     & (U) Prompt for a group and toggle its subscription (Unsubscribe).\\
S t     & (u) Toggle subscription to this group (unsubscribe). [p/p]\\
S w     & (C-w) Kill all groups in the region.\\
S y     & (C-y) Yank the last killed group.\\
S z     & Kill all zombie groups.\\
\end{keys}

\subsection*{Group Subscribedness Levels}
\begin{tabular}{|r|c|l|}
\hline
1 & mail groups   &              \\
2 & mail groups   &              \\
3 &               & subscribed   \\
4 &               &              \\
5 & default list level &         \\
\hline
6 &               &              \\
7 &               & unsubscribed \\
\hline
8 &               & zombies      \\
\hline
9 &               & killed       \\
\hline
\end{tabular}

\pagebreak[4]

\section*{Summary and Article Modes}
\begin{keys}
SPC     & (A SPC, A n) Select an article, scroll it one page, move to the
next one.\\ 
DEL     & (A DEL, A p, b) Scroll this article one page back. [distance]\\
RET     & Scroll this article one line forward. [distance]\\
$<$     & (A $<$, A b) Scroll to the beginning of this article.\\
$>$     & (A $>$, A e) Scroll to the end of this article.\\
j       & (G g) Ask for an article number and then go to that summary line.\\
M-n     & (G M-n) Go to the next summary line of an unread article.
[distance]\\ 
M-p     & (G M-p) Go to the previous summary line of an unread article. 
[distance]\\ 
\end{keys}

\subsection*{Article Buffer Commands}
\begin{keys}
A c     & (C-c C-r) Do a Caesar rotate (rot13) on the article buffer.\\
A g     & (g) (Re)fetch this article. [Prefix: just show the article.]\\
A m     & Toggle MIME processing.\\
A r     & (^, A^) Go to the parent of this article (the References: header).\\
A s     & (s) Perform an isearch in the article buffer.\\
A t     & (t) Toggle the displaying of all headers.\\
A w     & (w) Remove page breaks (`^L') from this article.\\
\end{keys}

\subsection*{Mail-Group Commands}
These commands (except the first one) are only valid in a mail group.\\*
\begin{keys}
B DEL   & Delete the mail article from disk (!). [p/p]\\
B c     & Copy this article from any group to a mail group. [p/p]\\
B e     & Expire all expirable articles in this group. [p/p]\\
B i     & Import a random file into this group.\\
B m     & Move the article from one mail group to another. [p/p]\\
B q     & Where will the article go during fancy splitting?\\
B r     & Respool this mail article. [p/p]\\
B w     & (e) Edit this article.\\
B M-C-e & Expunge (delete from disk) all expirable articles in this group
(!). [p/p]\\ 
\end{keys}

\subsection*{Select Articles}
These commands select the target article. They do not understand the prefix.\\*
\begin{keys}
G b     & (,) Go to the best article (the one with the highest score).\\
G f     & (.) Go to the first unread article.\\
G l     & (l) Go to the last article read.\\
G n     & (n) Go to the next unread article.\\
p       & Go to the previous unread article.\\
G p     & Pop an article off the summary history and go to it.\\
G N     & (N) Go to the next article.\\
G P     & (P) Go to the previous article.\\
G C-n   & (M-C-n) Go to the next article with the same subject.\\
G C-p   & (M-C-p) Go to the previous article with the same subject.\\
\end{keys}

\subsection*{Help Commands}
\begin{keys}
H d     & (C-c C-d) Describe this group. [Prefix: re-read the description
from the server.]\\
H f     & Try to fetch the FAQ for this group using ange-ftp.\\
H h     & Give a very short help message.\\
H i     & (C-c C-i) Go to the Gnus info node.\\
H v     & Display the Gnus version number.\\
\end{keys}

\subsection*{Article Thread Commands}
\begin{keys}
T \#    & Mark this thread with the process mark.\\
T d     & Move to the next article in this thread (down). [distance]\\
T h     & Hide this (sub)thread.\\
T i     & Increase the score of this thread.\\
T k     & (M-C-k) Mark the current (sub)thread as read. [Negative prefix:
tick it, positive prefix: unmark it.]\\
T l     & (M-C-l) Lower the score of this thread.\\
T n     & Go to the next thread. [distance]\\
T p     & Go to the previous thread. [distance]\\
T s     & Expose the thread hidden under this article, if any.\\
T u     & Move to the previous article in this thread (up). [distance]\\
T H     & Hide all threads.\\
T S     & Expose all hidden threads.\\
T T     & (M-C-t) Toggle threading.\\
\end{keys}

\subsection*{Mark Articles}
\begin{keys}
d       & (M d, M r) Mark this article as read and move to the next one.
[scope]\\ 
D       & Mark this article as read and move to the previous one. [scope]\\
u       & (!, M !, M t) Mark this article as interesting (tick it) and move
to the next one. [scope]\\
U       & Mark this article as interesting and move to the previous one.
[scope]\\ 
M-u     & (M SPC, M c) Clear all marks from this article and move to the next
one. [scope]\\ 
M-U     & Clear all marks from this article and move to the previous one.
[scope]\\ 
M ?     & (?) Mark this article as dormant (only followups are
interesting). [scope]\\ 
M b     & Set a bookmark in this article.\\
M e     & (E, M x) Mark this article as expirable. [scope]\\
M k     & (k) Kill all articles with the same subject then select the next
one.\\ 
M B     & Remove the bookmark from this article.\\
M C     & Catchup the articles that are not marked as unread.\\
M D     & Show all dormant articles (normally they are hidden unless they
have any followups).\\
M H     & Catchup (mark read) this group to point.\\
M K     & (C-k) Kill all articles with the same subject as this one.\\
C-w     & Mark all articles between point and mark as read.\\
M S     & (C-c M-C-s) Show all expunged articles.\\
M C-c   & Catchup all articles in this group.\\
M M-r   & (x) Expunge all read (deleted) articles from the summary buffer.\\
M M-D   & Hide all dormant articles.\\
M M-C-r & Expunge all articles having a given mark.\\
\end{keys}

\subsubsection*{The Process Mark}
{\samepage These commands set and remove the process mark \#. You only need
to use it if the set of articles you want to operate on is
non-contiguous. Else use a numeric prefix.} \\* 
\begin{keys}
M p a   & Mark all articles (in series order).\\
M p p   & (\#, M \#) Mark this article.\\
M p r   & Mark all articles in the region.\\
M p s   & Mark all articles in the current series.\\
M p t   & Mark all articles in this (sub)thread.\\
M p u   & (M-\#, M M-\#) Unmark this article.\\
M p R   & Mark all articles matching a regexp.\\
M p S   & Mark all series that already contain a marked article.\\
M p U   & Unmark all articles.\\
\end{keys}

\subsubsection*{Mark Based on Score}
\begin{keys}
M s c   & Clear all marks from all high-scored articles. [score]\\
M s k   & Kill all low-scored articles. [score]\\
M s m   & Mark all high-scored articles with a given mark. [score]\\
M s u   & Mark all high-scored articles as interesting (tick them). [score]\\
\end{keys}

\subsection*{Output Articles}
\begin{keys}
O f     & Save this article in plain file format. [p/p]\\
O h     & Save this article in mh folder format. [p/p]\\
O m     & Save this article in mail format. [p/p]\\
O o     & (o) Save this article using the default article saver. [p/p]\\
O p     & (\Bar) Pipe this article to a shell command. [p/p]\\
O r     & Save this article in rmail format. [p/p]\\
O v     & Save this article in vm format. [p/p]\\
\end{keys}

\subsection*{Wash the Article Buffer}
\begin{keys}
W a     & Hide unwanted parts of the article. Calls W h, W C-c, W s.\\
W b     & Make external references in the article (Message-Ids and URLs) to
buttons.\\ 
W c     & Hide article citation.\\
W d     & Remove extra CRs from the article.\\
W f     & Look for and display any X-Face headers.\\
W h     & Hide article headers.\\
W o     & Treat overstrike or underline in the article.\\
W q     & Treat quoted-printable in the article.\\
W s     & Hide article signature.\\
W t     & Convert the article timestamp to UTC (GMT).\\
W w     & Do word wrap in the article.\\
W A     & Highlight this article. Calls W H, W C, W S, W b.\\
W C     & Highlight article citation.\\
W H     & Highlight article headers.\\
W S     & Highlight article signature.\\
W T     & Convert the article timestamp to time lapsed since it was sent.\\
W C-c   & Hide article citation using a more intelligent algorithm.\\
\end{keys}

\subsection*{Followup, Reply, Forward, Cancel}
\samepage{These commands put you in a separate post or mail buffer. After
editing the article, send it by pressing C-c C-c.  If you are in a
foreign group and want to post the article using the foreign server, give
a prefix to C-c C-c.} \\* 
\begin{keys}
S b     & Post a followup to this article and send a reply.\\
S c     & (C) Cancel this article (only works if it is your own).\\
S f     & (f) Post a followup to this article.\\
S m     & (m) Send a mail to some other person.\\
S o m   & (C-c C-f) Forward this article by mail to a person.\\
S o p   & Forward this article to a newsgroup.\\
S p     & (a) Post an article to this group.\\
S r     & (r) Mail a reply to the author of this article.\\
S s     & Supersede this article with a new one (only for own articles).\\
S u     & Uuencode a file and post it as a series.\\
S B     & Post a followup, send a reply, and include the original. [p/p]\\
S F     & (F) Post a followup and include the original. [p/p]\\
S O m   & Digest these series and forward by mail. [p/p]\\
S O p   & Digest these series and forward to a newsgroup.\\
S R     & (R) Mail a reply and include the original. [p/p]\\
\end{keys}
If you want to cancel or supersede an article you just posted (before it
has appeared on the server), go to the *post-news* buffer, change
`Message-ID' to `Cancel' or `Supersedes' and send it again with C-c C-c.

\subsection*{Extract Series (Uudecode etc)}
Gnus will recognize when the current article is part of a series (multipart
posting whose parts are identified by numbers in their subjects, e.g.\
1/10\dots10/10) and will process the series accordingly. You can mark more
than one series. If the posting contains any archives, they are expanded
and gathered in a new group.\\*
\begin{keys}
X b     & Un-{\bf b}inhex these series. [p/p]\\
X o     & Simply {\bf o}output these series (no decoding). [p/p]\\ 
X p     & Unpack these {\bf p}ostscript series. [p/p]\\
X s     & Un-{\bf s}har these series. [p/p]\\
X u     & {\bf U}udecode these series. [p/p]\\
\end{keys}

Each one of these commands has four variants:\\*
\begin{keys}
X   \bf z & Decode these series. [p/p]\\
X v \bf z & Decode and view these series. [p/p]\\
X   \bf Z & Decode and save these series. [p/p]\\
X v \bf Z & Decode, save and view these series. [p/p]\\
\end{keys}
where {\bf z} identifies the decoding method (b, o ,p ,s, u).

An alternative binding for the most-often used of these commands is\\*
\begin{keys}
C-c C-v C-v & (X v u) Uudecode and view these series. [p/p]\\
\end{keys}

\subsection*{Exit the Current Group}
\begin{keys}
Z c     & (c) Mark all unticked articles as read and exit.\\
Z n     & Mark all articles as read and go to the next group.\\
Z C     & Mark all articles as read and exit.\\
Z E     & (Q) Exit without updating the group information.\\
Z G     & (M-g) Check for new articles in this group.\\
Z N     & Exit and go to the next group.\\
Z P     & Exit and go to the previous group.\\
Z R     & Exit this group, and then enter it again. [Prefix: select all
articles, read and unread.]\\
Z Z     & (q, Z Q) Exit this group.\\
\end{keys}

\subsection*{Various Group Commands}
\begin{keys}
V \&    & (\&) Execute a command on all articles matching a regexp.
[Prefix: move backwards.]\\
V e     & (=) Expand the Summary window. [Prefix: shrink it to display the
Article window]\\
V k     & (M-k) Edit this group's kill file.\\
V r     & (M-^) Fetch the article with a given Message-ID.\\
V u     & Execute a command on all articles having the process mark.\\
V D     & Undigestify this article into a separate group.\\
V K     & (M-K) Edit the general kill file.\\
V T     & (C-t) Toggle truncation of summary lines.\\
V C-r   & Search through all previous articles for a regexp.\\
V C-s   & Search through all subsequent articles for a regexp.\\
\end{keys}

\subsubsection*{Sort the Summary Buffer}
\begin{keys}
V s a   & (C-c C-s C-a) Sort the summary by author.\\
V s d   & (C-c C-s C-d) Sort the summary by date.\\
V s i   & (C-c C-s C-i) Sort the summary by article score.\\
V s n   & (C-c C-s C-n) Sort the summary by article number.\\
V s s   & (C-c C-s C-s) Sort the summary by subject.\\
\end{keys}

\subsubsection*{Article Score Commands}
\newcommand{\B}[1]{{\bf#1})}    % bold l)etter
\begin{keys}
V S a   & Add a new score entry, specifying all elements.\\
V S c   & Specify a new score file as current.\\
V S e   & Edit the current score alist.\\
V S f   & Edit a score file and make it the current one.\\
V S m   & Mark all articles below a given score as read.\\
V S s   & Set the score of this article.\\
V S t   & Display all score rules applied to this article.\\
V S x   & Expunge all low-scored articles. [score]\\
V S C   & gnus-score-customize: not documented.\\
V S S   & Display the score of this article.\\
\bf A p m l& Make a scoring entry based on this article.\\
\end{keys}

{\samepage
The four letters stand for:\\*
\quad \B{A}ction: I)ncrease, L)ower;\\*
\quad \B{p}art: a)utor (from), s)ubject, x)refs (cross-posting), d)ate, l)ines,
message-i)d, t)references (parent), f)ollowup, b)ody, h)ead (all headers);\\*
\quad \B{m}atch type:\\*
\qquad string: s)ubstring, e)xact, r)egexp, f)uzzy,\\*
\qquad date: b)efore, a)t, n)this,\\*
\qquad number: $<$, =, $>$;\\*
\quad \B{l}ifetime: t)emporary, p)ermanent, i)mmediate.

If you type the second letter in uppercase, the remaining two are assumed
to be s)ubstring and t)emporary. 
If you type the third letter in uppercase, the last one is assumed to be 
t)emporary.

\quad Extra keys for manual editing of a score file:\\*
\begin{keys}
C-c C-c & Finish editing the score file.\\
C-c C-d & Insert the current date as number of days.\\
\end{keys}
}

\section*{Article Mode}
All keys for Summary mode also work in Article mode.
The normal navigation keys work in Article mode.
Some additional keys are:\\*
\begin{keys}
C-c ^   & Get the article with the Message-Id near point.\\
C-c C-m & Send reply to the address near point and include the original.\\
h       & Go to the header line of the article in the summary buffer.\\
\end{keys}

\section*{Server Mode}
To enter this mode, press `^' while in Group mode.\\*
\begin{keys}
SPC     & Browse this server.\\
q       & Return to the group buffer.\\
l       & List all servers.\\
k       & Kill this server. [scope]\\
y       & Yank the previously killed server.\\
c       & Copy this server.\\
a       & Add a new server.\\
e       & Edit a server.\\
\end{keys}

\section*{Browse Server Mode}
To enter this mode, press `B' while in Group mode.\\*
\begin{keys}
RET     & Enter the current group.\\
SPC     & Enter the current group and display the first article.\\
?       & Give a very short help message.\\
l       & Exit browse mode.\\
n       & Go to the next group. [distance]\\
p       & Go to the previous group. [distance]\\
q       & Exit browse mode.\\
u       & Subscribe to the current group. [scope]\\
\end{keys}

\begin{center}\samepage
Copyright \copyright\ 1987 Free Software Foundation, Inc.\\*
Copyright \copyright\ 1995 Vladimir Alexiev $<$vladimir@cs.ualberta.ca$>$.\\*
Created from the Gnus manual Copyright \copyright\ 1994 Lars Magne
Ingebrigtsen.\\*
and the Emacs Help Bindings feature (C-h b).\\*
\end{center}

Permission is granted to make and distribute copies of this reference card
provided the copyright notice and this permission are preserved on all
copies. 
Please send corrections, additions and suggestions to the above email
address. \hfill 26 July 1995
\end{document}