* gnus.texi (Posting Styles): Add x-face-file to example.

[gnus] / texi / gnus-refcard.tex

\documentclass{article}

% Previously we had five input LaTeX files (booklet.tex bk-lt.tex bk-a4.tex
% refcard.tex gnusref.tex) and two logo files (gnuslogo-refcard.eps and
% gnuslogo-booklet.eps).
%
% From this LaTeX file (gnus-refcard.tex) plus a single logo (gnus-logo.eps),
% we can generate the refcard and the booklet version.  Appropriate Makefile
% rules were added.  This simplifies to distribute the refcard with Emacs.
%
% (Reiner Steib, March 2005)

\usepackage{ifthen}
\ifthenelse{\isundefined{\booklettrue}}{
  \typeout{Creating reference card...}
}{
  \typeout{Creating reference booklet...}}

\usepackage{supertabular}

\newlength{\logowidth}  \setlength{\logowidth} {6.861in}
\newlength{\logoheight} \setlength{\logoheight}{7.013in}

\usepackage{graphicx}

\usepackage{geometry}

\ifthenelse{\isundefined{\booklettrue}}{% ifcard %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  % Reference Card
  
  \def\Guide{Card}\def\guide{card}
  \def\logoscale{0.25}
  
  % Page setup for the refcard:
  
  % \setlength{\textwidth}{7.26in} \setlength{\textheight}{10in}
  % \setlength{\topmargin}{-1.0in}
  % % the same settings work for A4, although there is a bit of space at the
  % % top and bottom of the page. 
  % \setlength{\oddsidemargin}{-0.5in} \setlength{\evensidemargin}{-0.5in}

  \ifthenelse{\isundefined{\letterpapertrue}}{
    \geometry{a4paper,hmargin=10mm,tmargin=10mm,bmargin=35mm}
  }{
    \geometry{hmargin=20mm,tmargin=10mm,bmargin=12mm}
  }
  
}{ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  % Reference Booklet
  
  \def\Guide{Booklet}\def\guide{booklet}
  \def\logoscale{0.5}% FIXME: too large for 2up printing?  --rsteib
  
  % FIXME: Use geometry package.  --rsteib
%   \ifthenelse{\isundefined{\letterpapertrue}}{
%     \textwidth 4.9in \textheight 7.35in \topmargin -1.0in
%   }{
%     \textwidth 4.5in \textheight 7.5in \topmargin -1.0in
%   }
%   \oddsidemargin -0.5in \evensidemargin -0.5in
  \ifthenelse{\isundefined{\letterpapertrue}}{
    \geometry{a5paper,hmargin=10mm,tmargin=10mm,bmargin=4mm}
  }{
    % FIXME: Use geometry package.  --rsteib
    \geometry{a5paper,hmargin=20mm,tmargin=10mm,bmargin=4mm}
  }
  
  \def\sec{\section}
  \def\subsec{\subsection}
  \def\subsubsec{\subsubsection}
  \def\blankpage{\vspace*{\fill}\par
  %\centerline{(This page intentionally left blank.)}
  \par\vspace*{\fill}\pagebreak}
}%ifbooklet% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% \input{gnusref} % % % % % % % % % % % % % % % % % % % % % % % % % %  
%% include file for the Gnus refcard and booklet

\def\progver{5.10}\def\refver{5.10-2} % program and refcard versions
\def\date{Mar, 2005}
\def\author{Gnus Bugfixing Girls + Boys $<$bugs@gnus.org$>$}

%%
\newlength{\keycolwidth}
\newenvironment{keys}[1]% #1 is the widest key
{\nopagebreak%\noindent%
  \settowidth{\keycolwidth}{#1}%
  \addtolength{\keycolwidth}{\tabcolsep}%
  \addtolength{\keycolwidth}{-\columnwidth}%
  \begin{supertabular}{@{}l@{\hspace{\tabcolsep}}p{-\keycolwidth}@{}}}%
  {\end{supertabular}\\}

%% uncomment the first definition if you do not want pagebreaks in maps
%%\newcommand{\esamepage}{\samepage}
\newcommand{\esamepage}{}

\newcommand*{\B}[1]{{\bf#1})}    % bold l)etter

\newcommand{\Title}{%
  \begin{center}
    {\bf\LARGE Gnus \progver\ Reference \Guide\\}
                                %{\normalsize \Guide\ version \refver}
  \end{center}
  }

% \newcommand*{\LogoOLD}[1]{\centerline{%
%     \makebox[\logoscale\logowidth][l]{\vbox to \logoscale\logoheight
%       {\vfill\epsfig{figure=gnuslogo-#1}}\vspace{-\baselineskip}}}}

\newcommand*{\Logo}[1]{\centerline{%
    \includegraphics[width=\logoscale\logowidth]{gnus-logo}}}

\newcommand{\Copyright}{%
  \begin{center}
    Copyright \copyright\ 1995, 2002, 2003, 2004,
       2005, 2006 Free Software Foundation, Inc.\\*
    Copyright \copyright\ 1995 Vladimir Alexiev
    $<$vladimir@cs.ualberta.ca$>$.\\*
    Copyright \copyright\ 2000 Felix Natter $<$fnatter@gmx.net$>$.\\*
    Copyright \copyright\ 2001, 2002, 2003, 2004, 2005 \author.\\*
    Created from the Gnus manual Copyright \copyright\ 1994 Lars Magne
    Ingebrigtsen.\\*
    and the Emacs Help Bindings feature (C-h b).\\*
    Gnus logo copyright \copyright\ 1995 Luis Fernandes.\\*
  \end{center}

  Permission is granted to make and distribute copies of this reference
  \guide{} provided the copyright notice and this permission are preserved on
  all copies.  Please send corrections, additions and suggestions to the
  current maintainer's email address. \Guide{} last edited on \date.
  }

\newcommand{\Notes}{%
  \subsection*{Notes}
  {\esamepage
    Gnus is complex. Currently it has some 876 interactive (user-callable)
    functions. Of these 618 are in the two major modes (Group and
    Summary/Article). Many of these functions have more than one binding, some
    have 3 or even 4 bindings. The total number of keybindings is 677. So in
    order to save 40\% space, every function is listed only once on this
    \guide, 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 given 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. \\*[\baselineskip]
                                % some keys
    Gnus startup-commands:\\*
    \begin{keys}{M-x gnus-unplugged}
      M-x gnus           & start Gnus. \\
      M-x gnus-no-server & start Gnus without connecting to server
      (i.e. to read mail). \\
    \end{keys}
    Additionally, there are the two commands \texttt{gnus-plugged} and
    \texttt{gnus-unplugged}, which are only used if you want to download
    news and/or read previously downloaded news offline (see C-c C-i g Gnus
    Unplugged RET). Note: \texttt{gnus-no-server} ignores the stuff in
    \texttt{gnus-agent-directory}, and thus does not allow you to use Gnus
    Unplugged.
                                %
    \begin{keys}{C-c C-i}
      C-c C-i & Go to the Gnus online {\bf info}.\\
      C-c C-b & Send a Gnus {\bf bug} report.\\
    \end{keys}
    }}

\newcommand{\GroupLevels}{%
  The table below assumes that you use the default Gnus levels.
  Fill your user-specific levels in the blank cells.\\[1\baselineskip]
  \begin{tabular}{|c|l|l|}
    \hline
    Level & Groups & Status \\
    \hline
    1 & draft/mail groups   &              \\
    2 & mail groups         &              \\
    3 &                     & subscribed   \\
    4 &                     &              \\
    5 & default list level  &              \\
    \hline
    6 &                     & unsubscribed \\
    7 &                     &              \\
    \hline
    8 &                     & zombies      \\
    \hline
    9 &                     & killed       \\
    \hline
  \end{tabular}}

\newcommand{\MarkCharacters}{%
  {\esamepage If a command directly sets a mark, it is shown in parentheses.\\*
    \newlength{\markcolwidth}
    \settowidth{\markcolwidth}{` '}% widest character
    \addtolength{\markcolwidth}{4\tabcolsep}
    \addtolength{\markcolwidth}{-\columnwidth}
    \newlength{\markdblcolwidth}
    \setlength{\markdblcolwidth}{\columnwidth}
    \addtolength{\markdblcolwidth}{-2\tabcolsep}
    \begin{tabular}{|c|p{-\markcolwidth}|}
      \hline
      \multicolumn{2}{|p{\markdblcolwidth}|}{{\bf ``Read'' Marks.}
        All these marks appear in the first column of the summary line, and so
        are mutually exclusive.}\\ 
      \hline
      ` ' & (M-u, M SPC, M c) Not read.\\
      !   & (!, M !, M t) Ticked (interesting).\\
      ?   & (?, M ?) Dormant (only followups are interesting).\\
      E   & (E, M e, M x) {\bf Expirable}. Only has effect in mail groups.\\
      G   & (C, B DEL) Canceled article (or deleted in mailgroups).\\
      \$  & (M-d, M s x, S x).  Marked as spam.\\
      \hline\hline
      \multicolumn{2}{|p{\markdblcolwidth}|}
      {The marks below mean that the article
        is read (killed, uninteresting), and have more or less the same effect.
        Some commands however explicitly differentiate between them (e.g.\ M
        M-C-r, adaptive scoring).}\\
      \hline
      r   & (d, M d, M r) Deleted (marked as {\bf read}).\\
      C   & (M C; M C-c; M H; c, Z c; Z n; Z C) Killed by {\bf catch-up}.\\
      F   & SOUPed article. See the manual.\\
      O   & {\bf Old} (read in a previous session).\\
      K   & (k, M k; C-k, M K) {\bf Killed}.\\
      M   & Article marked as read by duplicate suppression.\\
      Q   & Article is part of a sparse thread (see ``Threading''
      in the manual).\\
      R   & {\bf Read} (viewed in actuality).\\
      X   & Killed by a kill file.\\
      Y   & Killed due to low score.\\
      \hline\multicolumn{2}{c}{\vspace{1ex}}\\\hline
      \multicolumn{2}{|p{\markdblcolwidth}|}
      {{\bf Marks not affecting visibility}}\\
      \hline
      \#  & (\#, M \#, M P p) Processable (will be affected by the next operation).
      [2]\\
      A   & {\bf Answered} (followed-up or replied). [2]\\
      F   & Forwarded. [2]\\
      $\ast$  & Cached. [2]\\
      S   & Saved. [2]\\
      N   & Recently arrived. [2]\\
      .   & Unseen. [2]\\
      +   & Over default score. [3]\\
      $-$ & Under default score. [3]\\
      $=$ & Has children (thread underneath it). Add `\%e' to
      `gnus-summary-line-format'. [3]\\
      \hline
    \end{tabular}
    }}

\newcommand{\GroupModeGeneral}{%
  \begin{keys}{C-c M-C-x}
    RET     & (=) Enter this group. [Prefix: how many (read) articles to fetch.
    Positive: newest articles, negative: oldest ones; non-numerical:
    view all articles, not just unread]\\
    M-RET   & Enter group quickly.\\
    M-SPC   & Same as RET but does not expunge and hide dormants.\\
    M-C-RET & Enter group without any processing, changes will not be permanent.\\
    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 lowest-level group with unread articles.\\
    .       & Jump to the first group with unread articles.\\
    \^{}      & Enter the Server buffer mode.\\
    a       & Post an {\bf article} to a group
              [Prefix: use group under point to find posting-style].\\
    b       & Find {\bf bogus} groups and delete them.\\
    c       & Mark all unticked articles in this group as read ({\bf catch-up}).
    [p/p]\\ 
    g       & Check the server for new articles ({\bf get}). [level]\\
    M-g     & Check the server for new articles in this group ({\bf get}). [p/p]\\
    j       & {\bf Jump} to a group.\\
    m       & {\bf Mail} a message to someone
              [Prefix: use group under point to find posting-style].\\
    n       & Go to the {\bf next} group with unread articles. [distance]\\
    M-n     & Go to the {\bf next} group on the same or lower level.
    [distance]\\ 
    p       & (DEL) Go to the {\bf previous} group with unread articles.
    [distance]\\ 
    M-p     & Go to the {\bf previous} group on the same or lower level. [distance]\\ 
    q       & {\bf Quit} Gnus.\\
    r       & Re-read the init file ({\bf reset}).\\
    s       & {\bf Save} the `.newsrc.eld' file (and `.newsrc' if
    `gnus-save-newsrc-file').\\ 
    z       & Suspend (kill all buffers of) Gnus.\\
    B       & {\bf Browse} a foreign server.\\
    C       & Mark all articles in this group as read ({\bf Catch-up}). [p/p]\\
    F       & {\bf Find} new groups and process them.\\
    N       & Go to the {\bf next} group. [distance]\\
    P       & Go to the {\bf previous} group. [distance]\\
    Q       & {\bf Quit} Gnus without saving any startup (.newsrc) files.\\
    R       & {\bf Restart} Gnus.\\
    Z       & Clear the dribble buffer.\\
    M-c     & Clear data from group (marks and list of read articles). \\
    C-c C-s & {\bf 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 {\bf expiry} 
    process.\\
    C-c M-C-x & Run all articles in all groups through the {\bf expiry} process.\\
    C-c M-g & Activate all {\bf groups}.\\
    C-c C-i & Gnus online-manual ({\bf info}).\\
    C-x C-t & {\bf Transpose} two groups.\\
    H f     & Fetch this group's {\bf FAQ} (using ange-ftp).\\
    H c     & Display this group's {\bf charter}. [Prefix: query for group]\\
    H C     & Display this group's {\bf control message} (using
    ange-ftp). [Prefix: query for group]\\
    H v     & (V) Display the Gnus {\bf version} number.\\
    H d     & (C-c C-d) Show the {\bf description} of this group
    [Prefix: re-read from server].\\ 
    M-d     & {\bf Describe} all groups. [Prefix: re-read from server]\\
    D g     & Regenerate a Sieve script from group parameters.\\
    D u     & Regenerate Sieve script and {\bf upload} to server.\\
  \end{keys}
  }

\newcommand{\ListGroups}{%
  {\esamepage
    \begin{keys}{A M}
      A d     & (C-c C-M-a) List all groups whose names or {\bf descriptions} match a regexp.\\ 
      A k     & (C-c C-l) List all {\bf killed} groups.
      [Prefix: look at active-file from server]\\
      A l     & List all groups on a specific level.
      [Prefix: also list groups with no unread articles]\\
      A a     & (C-c C-a) List all groups whose names match a regexp
      ({\bf apropos}).\\ 
      A A     & List the server's active-file.\\
      A M     & List groups that {\bf match} a regexp.\\
      A m     & List groups that {\bf match} a regexp and have unread articles. 
      [level]\\ 
      A s     & (l) List all {\bf subscribed} groups with unread articles.
      [level; 5 and lower is the default]\\
      A u     & (L) List all groups (including read and {\bf unsubscribed}).
      [level; 7 and lower is the default]\\
      A z     & List all {\bf zombie} groups.\\
      A c     & List all groups with cached articles. [level]\\
      A ?     & List all groups with dormant articles. [level]\\
    \end{keys}
  }
  
  \newcommand{\CreateEditGroups}{%
    {\esamepage
      The select methods are indicated in parentheses.\\*
      \begin{keys}{G DEL}
        G a     & Make the Gnus list {\bf archive} group. (nndir over ange-ftp)\\
        G c     & {\bf Customize} this group's parameters.\\
        G d     & Make a {\bf directory} group (every file must be a posting and files
        must have numeric names). (nndir)\\
        G D     & Enter a {\bf directory} as a (temporary) group.
        (nneething without recording articles read)\\
        G e     & (M-e) {\bf Edit} this group's select method.\\
        G E     & {\bf Edit} this group's info (select method, articles read, etc).\\
        G f     & Make a group based on a {\bf file}. (nndoc)\\
        G h     & Make the Gnus {\bf help} (documentation) group. (nndoc)\\
        G k     & Make a {\bf kiboze} group. (nnkiboze)\\
        G m     & {\bf Make} a new group.\\
        G p     & Edit this group's {\bf parameters}.\\
        G r     & Rename this group (does not work with read-only groups!).\\
        G u     & Create one of the groups mentioned in gnus-{\bf useful}-groups.\\
        G v     & Add this group to a {\bf virtual} group. [p/p]\\
        G V     & Make a new empty {\bf virtual} group. (nnvirtual)\\
        G w     & Create ephemeral group based on web-search. [Prefix: make solid group
        instead]\\
        G R     & Make an {\bf RSS} group.\\
        G DEL   & {\bf Delete} group [Prefix: delete all articles as well].\\
        G x     & Expunge all deleted articles in an nnimap mailbox.\\
        G l     & Edit ACL (Access Control {\bf List}) for an nnimap mailbox.\\
      \end{keys}
      You can also create mail-groups and read your mail with Gnus (very useful
      if you are subscribed to 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).
      }}

                                % TODO:
  \newcommand{\SoupCommands}{%
    \begin{keys}{G s w}
      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}}

  \newcommand{\MarkGroups}{%
    \begin{keys}{M m}
      M m     & (\#) Set the process {\bf mark} on this group. [scope]\\
      M r     & Mark all groups matching regular expression.\\
      M u     & (M-\#) Remove the process mark from this group ({\bf unmark}).
      [scope]\\ 
      M U     & Remove the process mark from all groups (\textbf{umark all}).\\
      M w     & Mark all groups in the current region. [prefix: unmark]\\
      M b     & Mark all groups in the {\bf buffer}. [prefix: unmark]\\
    \end{keys}}

  \newcommand{\GroupTopicsGeneral}{%
    {\esamepage
      Topics are ``categories'' for groups. Press t in the group-buffer to
      toggle gnus-topic-mode (C-c C-i g Group Topics RET).\\*
      \begin{keys}{C-c C-x}
        T n     & Prompt for topic {\bf name} and create it.\\
        T m     & {\bf Move} the current group to some other topic [p/p].\\
        T j     & {\bf Jump} to a topic.\\
        T c     & {\bf Copy} the current group to some other topic [p/p].\\
        T D     & Remove (not delete) the current group [p/p].\\
        T M     & {\bf Move} all groups matching a regexp to a topic.\\
        T C     & {\bf Copy} all groups matching a regexp to a topic.\\
        T H     & Toggle {\bf hiding} of empty topics.\\
        T r     & {\bf Rename} a topic.\\
        T DEL   & Delete an empty topic.\\
        T \#    & Mark all groups in the current topic with the process-mark.\\
        T M-\#  & Remove the process-mark from all groups in the current topic.\\
        T TAB   & (TAB) Indent current topic [Prefix: unindent].\\ 
        M-TAB   & Unindent the current topic.\\
        RET     & (SPC) Either unfold topic or enter group [level].\\
        T s     & {\bf Show} the current topic. [Prefix: show permanently]\\
        T h     & {\bf Hide} the current topic. [Prefix: hide permanently]\\
        C-c C-x & Expire all articles in current group or topic.\\
        C-k     & {\bf Kill} a group or topic.\\
        C-y     & {\bf Yank} a group or topic.\\
        A T     & List active-file using {\bf topics}.\\
        G p     & Edit topic-{\bf parameters}.\\
        T M-n   & Go to {\bf next} topic. [distance]\\
        T M-p   & Go to {\bf previous} topic. [distance]\\
      \end{keys}
      }
    }

  \newcommand{\TopicSorting}{%
    {\esamepage
      \begin{keys}{T S m}
        T S a  & Sort {\bf alphabetically}.\\
        T S u  & Sort by number of {\bf unread} articles.\\
        T S l  & Sort by group {\bf level}.\\
        T S v  & Sort by group score ({\bf value}).\\
        T S r  & Sort by group {\bf rank}.\\
        T S m  & Sort by {\bf method}.\\
        T S e  & Sort by {\bf server} name.\\
        T S s  & Sort according to `gnus-group-sort-function'.\\
      \end{keys}
      With a prefix these commands will sort in reverse order.
      }
    }

  \newcommand{\SubscribeKillYankGroups}{%
    {\esamepage
      \begin{keys}{S C-k}
        S k     & (C-k) {\bf Kill} this group.\\
        S l     & Set the {\bf level} of this group. [p/p]\\
        S s     & (U) Prompt for a group and toggle its {\bf subscription}.\\
        S t     & (u) {\bf Toggle} subscription to this group. [p/p]\\
        S w     & (C-w) Kill all groups in the region.\\
        S y     & (C-y) {\bf Yank} the last killed group.\\
        S z     & Kill all {\bf zombie} groups.\\
        S C-k   & Kill all groups on a certain level.\\
      \end{keys}
      }
    }

  \newcommand{\SummaryModeGeneral}{%
    {\esamepage
      \begin{keys}{M-RET}
        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     & (A RET) Scroll this article one line forward. [distance]\\
        M-RET   & (A M-RET) Scroll this article one line backward. [distance]\\
        =       & Expand the Summary window (fullsize).
        [Prefix: shrink to display article window]\\
                                %
        \&      & Execute a command on all articles whose header matches a regexp.
        [Prefix: move backwards]\\
        M-\&    & Execute a command on all articles having the process mark.\\
                                %
        M-n     & (G M-n) Go to the {\bf next} summary line of an unread article.
        [distance]\\ 
        M-p     & (G M-p) Go to the {\bf previous} summary line of an unread article. 
        [distance]\\ 
        M-s     & {\bf Search} through all subsequent articles for a regexp.\\
        M-r     & Search through all previous articles for a regexp.\\
                                %
        A P     & {\bf Postscript}-print current buffer.\\
                                %
        M-k     & Edit this group's {\bf kill} file.\\
        M-K     & Edit the general {\bf kill} file.\\
                                %
        C-t     & Toggle {\bf truncation} of summary lines.\\
        Y g     & Regenerate the summary-buffer.\\
        Y c     & Insert all cached articles into the summary-buffer.\\
                                %
        M-C-e   & {\bf Edit} the group-parameters.\\
        M-C-a   & Customize the group-parameters.\\
               &nb