* elmo-map.el (elmo-folder-pack-numbers): Rewrite.
[elisp/wanderlust.git] / doc / wl-refcard.tex
1 % Reference Card for Wanderlust
2 % The format of this file is adapted from the GNU Emacs reference card
3 %
4 % You can compile with:
5 % tex wl-refcard.tex
6 % dvips wl-refcard.dvi -t landscape -o wl-refcard.ps
7 % pstops '2:0U(21cm,29.7cm),1' wl-refcard.ps wl-refcard-b.ps
8
9 % Reference Card for GNU Emacs version 20 on Unix systems
10 %**start of header
11 \newcount\columnsperpage
12
13 % This file can be printed with 1, 2, or 3 columns per page (see below).
14 % Specify how many you want here.  Nothing else needs to be changed.
15
16 \columnsperpage=3
17
18 % Copyright (c) 1987, 1993, 1996, 1997 Free Software Foundation, Inc.
19
20 % This file is part of GNU Emacs.
21
22 % GNU Emacs is free software; you can redistribute it and/or modify
23 % it under the terms of the GNU General Public License as published by
24 % the Free Software Foundation; either version 2, or (at your option)
25 % any later version.
26
27 % GNU Emacs is distributed in the hope that it will be useful,
28 % but WITHOUT ANY WARRANTY; without even the implied warranty of
29 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30 % GNU General Public License for more details.
31
32 % You should have received a copy of the GNU General Public License
33 % along with GNU Emacs; see the file COPYING.  If not, write to
34 % the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
35 % Boston, MA 02111-1307, USA.
36
37 % This file is intended to be processed by plain TeX (TeX82).
38 %
39 % The final reference card has six columns, three on each side.
40 % This file can be used to produce it in any of three ways:
41 % 1 column per page
42 %    produces six separate pages, each of which needs to be reduced to 80%.
43 %    This gives the best resolution.
44 % 2 columns per page
45 %    produces three already-reduced pages.
46 %    You will still need to cut and paste.
47 % 3 columns per page
48 %    produces two pages which must be printed sideways to make a
49 %    ready-to-use 8.5 x 11 inch reference card.
50 %    For this you need a dvi device driver that can print sideways.
51 % Which mode to use is controlled by setting \columnsperpage above.
52 %
53 % Author:
54 %  Stephen Gildea
55 %  Internet: gildea@stop.mail-abuse.org
56 %
57 % Thanks to Paul Rubin, Bob Chassell, Len Tower, and Richard Mlynarik
58 % for their many good ideas.
59
60 % If there were room, it would be nice to see a section on Dired.
61
62 \input version.tex
63 \def\year{2001}
64
65 \def\shortcopyrightnotice{\vskip 1ex plus 2 fill
66   \centerline{\small \copyright\ \year\ Yuuichi Teranishi
67   Permissions on back.}}
68
69 \def\copyrightnotice{
70 \vskip 1ex plus 2 fill\begingroup\small
71 \centerline{Copyright \copyright\ \year\  Yuuichi Teranishi}
72 \centerline{for Wanderlust \versionnumber}
73
74 Permission is granted to make and distribute copies of
75 this card provided the copyright notice and this permission notice
76 are preserved on all copies.
77
78 \endgroup}
79
80 % make \bye not \outer so that the \def\bye in the \else clause below
81 % can be scanned without complaint.
82 \def\bye{\par\vfill\supereject\end}
83
84 \newdimen\intercolumnskip       %horizontal space between columns
85 \newbox\columna                 %boxes to hold columns already built
86 \newbox\columnb
87
88 \def\ncolumns{\the\columnsperpage}
89
90 \message{[\ncolumns\space 
91   column\if 1\ncolumns\else s\fi\space per page]}
92
93 \def\scaledmag#1{ scaled \magstep #1}
94
95 % This multi-way format was designed by Stephen Gildea October 1986.
96 % Note that the 1-column format is fontfamily-independent.
97 \if 1\ncolumns                  %one-column format uses normal size
98   \hsize 4in
99   \vsize 10in
100   \voffset -.7in
101   \font\titlefont=\fontname\tenbf \scaledmag3
102   \font\headingfont=\fontname\tenbf \scaledmag2
103   \font\smallfont=\fontname\sevenrm
104   \font\smallsy=\fontname\sevensy
105
106   \footline{\hss\folio}
107   \def\makefootline{\baselineskip10pt\hsize6.5in\line{\the\footline}}
108 \else                           %2 or 3 columns uses prereduced size
109   \hsize 3.2in
110   \vsize 7.95in
111   \hoffset -.75in
112   \voffset -.745in
113   \font\titlefont=cmbx10 \scaledmag2
114   \font\headingfont=cmbx10 \scaledmag1
115   \font\smallfont=cmr6
116   \font\smallsy=cmsy6
117   \font\eightrm=cmr8
118   \font\eightbf=cmbx8
119   \font\eightit=cmti8
120   \font\eighttt=cmtt8
121   \font\eightmi=cmmi8
122   \font\eightsy=cmsy8
123   \textfont0=\eightrm
124   \textfont1=\eightmi
125   \textfont2=\eightsy
126   \def\rm{\eightrm}
127   \def\bf{\eightbf}
128   \def\it{\eightit}
129   \def\tt{\eighttt}
130   \normalbaselineskip=.8\normalbaselineskip
131   \normallineskip=.8\normallineskip
132   \normallineskiplimit=.8\normallineskiplimit
133   \normalbaselines\rm           %make definitions take effect
134
135   \if 2\ncolumns
136     \let\maxcolumn=b
137     \footline{\hss\rm\folio\hss}
138     \def\makefootline{\vskip 2in \hsize=6.86in\line{\the\footline}}
139   \else \if 3\ncolumns
140     \let\maxcolumn=c
141     \nopagenumbers
142   \else
143     \errhelp{You must set \columnsperpage equal to 1, 2, or 3.}
144     \errmessage{Illegal number of columns per page}
145   \fi\fi
146
147   \intercolumnskip=.46in
148   \def\abc{a}
149   \output={%                    %see The TeXbook page 257
150       % This next line is useful when designing the layout.
151       %\immediate\write16{Column \folio\abc\space starts with \firstmark}
152       \if \maxcolumn\abc \multicolumnformat \global\def\abc{a}
153       \else\if a\abc
154         \global\setbox\columna\columnbox \global\def\abc{b}
155         %% in case we never use \columnb (two-column mode)
156         \global\setbox\columnb\hbox to -\intercolumnskip{}
157       \else
158         \global\setbox\columnb\columnbox \global\def\abc{c}\fi\fi}
159   \def\multicolumnformat{\shipout\vbox{\makeheadline
160       \hbox{\box\columna\hskip\intercolumnskip
161         \box\columnb\hskip\intercolumnskip\columnbox}
162       \makefootline}\advancepageno}
163   \def\columnbox{\leftline{\pagebody}}
164
165   \def\bye{\par\vfill\supereject
166     \if a\abc \else\null\vfill\eject\fi
167     \if a\abc \else\null\vfill\eject\fi
168     \end}  
169 \fi
170
171 % we won't be using math mode much, so redefine some of the characters
172 % we might want to talk about
173 \catcode`\^=12
174 \catcode`\_=12
175
176 \chardef\\=`\\
177 \chardef\{=`\{
178 \chardef\}=`\}
179
180 \hyphenation{mini-buf-fer}
181
182 \parindent 0pt
183 \parskip 1ex plus .5ex minus .5ex
184
185 \def\small{\smallfont\textfont2=\smallsy\baselineskip=.8\baselineskip}
186
187 % newcolumn - force a new column.  Use sparingly, probably only for
188 % the first column of a page, which should have a title anyway.
189 \outer\def\newcolumn{\vfill\eject}
190
191 % title - page title.  Argument is title text.
192 \outer\def\title#1{{\titlefont\centerline{#1}}\vskip 1ex plus .5ex}
193
194 % section - new major section.  Argument is section name.
195 \outer\def\section#1{\par\filbreak
196   \vskip 3ex plus 2ex minus 2ex {\headingfont #1}\mark{#1}%
197   \vskip 2ex plus 1ex minus 1.5ex}
198
199 \newdimen\keyindent
200
201 % beginindentedkeys...endindentedkeys - key definitions will be
202 % indented, but running text, typically used as headings to group
203 % definitions, will not.
204 \def\beginindentedkeys{\keyindent=1em}
205 \def\endindentedkeys{\keyindent=0em}
206 \endindentedkeys
207
208 % paralign - begin paragraph containing an alignment.
209 % If an \halign is entered while in vertical mode, a parskip is never
210 % inserted.  Using \paralign instead of \halign solves this problem.
211 \def\paralign{\vskip\parskip\halign}
212
213 % \<...> - surrounds a variable name in a code example
214 \def\<#1>{{\it #1\/}}
215
216 % kbd - argument is characters typed literally.  Like the Texinfo command.
217 \def\kbd#1{{\tt#1}\null}        %\null so not an abbrev even if period follows
218
219 % beginexample...endexample - surrounds literal text, such a code example.
220 % typeset in a typewriter font with line breaks preserved
221 \def\beginexample{\par\leavevmode\begingroup
222   \obeylines\obeyspaces\parskip0pt\tt}
223 {\obeyspaces\global\let =\ }
224 \def\endexample{\endgroup}
225
226 % key - definition of a key.
227 % \key{description of key}{key-name}
228 % prints the description left-justified, and the key-name in a \kbd
229 % form near the right margin.
230 \def\key#1#2{\leavevmode\hbox to \hsize{\vtop
231   {\hsize=.75\hsize\rightskip=1em
232   \hskip\keyindent\relax#1}\kbd{#2}\hfil}}
233
234 \newbox\metaxbox
235 \setbox\metaxbox\hbox{\kbd{M-x }}
236 \newdimen\metaxwidth
237 \metaxwidth=\wd\metaxbox
238
239 % metax - definition of a M-x command.
240 % \metax{description of command}{M-x command-name}
241 % Tries to justify the beginning of the command name at the same place
242 % as \key starts the key name.  (The "M-x " sticks out to the left.)
243 \def\metax#1#2{\leavevmode\hbox to \hsize{\hbox to .75\hsize
244   {\hskip\keyindent\relax#1\hfil}%
245   \hskip -\metaxwidth minus 1fil
246   \kbd{#2}\hfil}}
247
248 % threecol - like "key" but with two key names.
249 % for example, one for doing the action backward, and one for forward.
250 \def\threecol#1#2#3{\hskip\keyindent\relax#1\hfil&\kbd{#2}\hfil\quad
251   &\kbd{#3}\hfil\quad\cr}
252
253 %**end of header
254 \f
255
256 \title{Wanderlust Reference Card}
257
258 \centerline{(for version \versionnumber)}
259
260 \section{Starting Wanderlust}
261
262 \key{Start Wanderlust}{M-x wl}
263 \key{Start composition}{M-x wl-draft}
264
265 \section{Folder Mode}
266
267 \key{Quit Wanderlust}{q}
268 \key{Move to next entity}{n}
269 \key{Move to previous entity}{p}
270 \key{Move to next unread entity}{N}
271 \key{Move to previous unread entity}{P}
272 \key{Go to specified folder}{g}
273 \key{Go into current folder}{SPC}
274 \key{Open/Close current group}{SPC}
275 \key{Rescan folders in current access group}{C-u SPC}
276 \key{Check new messages for current entity}{s}
277 \key{Synchronize current entity}{S}
278 \key{Prefetch for current folder/group}{I}
279 \key{Set as read all messages in current entity}{c}
280 \key{Expire current entity}{e}
281 \key{Compose message}{w}
282 \key{Compose message for current folder}{W}
283 \key{Reload address book}{Z}
284 \key{Empty trash folder}{E}
285
286 \section{folder management}
287
288 \key{Cut current entity}{C-k}
289 \key{Cut region}{C-w}
290 \key{Yank}{C-y}
291 \key{Add folder}{m a}
292 \key{Add group}{m g}
293 \key{Add access group}{m A}
294
295 \section{access group}
296
297 \key{Display unsubscribed folders}{L}
298 \key{Hide unsubscribed folders}{l}
299 \key{Unsubscribe current entity}{u}
300 \key{Unsubscribe region}{U}
301
302 \newcolumn
303 \section{Summary Mode}
304
305 \key{Go back to folder mode}{q}
306 \key{Go to specified folder}{g}
307 \key{Next message}{n}
308 \key{Previous message}{p}
309 \key{Next unread message}{N}
310 \key{Previous unread message}{P}
311 \key{First message}{<}
312 \key{Last message}{>}
313 \key{Jump to previously shown message}{TAB}
314 \key{View current message}{SPC}
315 \key{Force reloading current message}{C-u .}
316 \key{Toggle display of message}{v}
317 \key{Compose message}{w}
318 \key{Compose message for current folder}{W}
319 \key{Compose reply message}{a}
320 \key{Compose reply message with citation}{A}
321 \key{Forward current message}{f}
322 \key{(Re-)Edit current message}{E}
323 \key{Print current message}{\#}
324 \key{Jump to message buffer}{j}
325 \key{Reload address book}{Z}
326
327 \section{mark command}
328
329 \key{Mark for disposal}{d}
330 \key{Mark for deletion}{D}
331 \key{Mark for refiling}{o}
332 \key{Mark for copying}{O}
333 \key{Mark for prefetching}{i}
334 \key{Mark for resending}{\~{}}
335 \key{Mark as important}{\$}
336 \key{Mark as target}{*}
337 \key{Mark all messages as target}{m a}
338 \key{Mark current thread as target}{m t}
339 \key{Pick messages and mark}{?}
340 \key{Pick messages from marked ones}{m *}
341 \key{Mark target messages for refiling}{m o}
342 \key{Mark target messages for deleting}{m d}
343 \key{Print target messages}{m \#}
344 \key{Send each target message to a pipe}{m |}
345 \key{Execute action for each temp marks}{x}
346
347 \section{prefix arguments for marking}
348
349 \key{Apply command for marked messages}{m}
350 \key{Apply command for thread after cursor point}{t}
351 \key{Apply command for region}{r}
352
353 \newcolumn
354 \section{sticky summary}
355
356 \key{Stick current summary}{M-s}
357 \key{Open summary and stick}{G}
358 \key{Display next summary}{C-c C-n}
359 \key{Display previous summary}{C-c C-p}
360 \key{Discard current summary}{C-u q}
361
362 \section{Message Mode}
363
364 \key{Go back to summary buffer}{q}
365 \key{Scroll up or move to next content}{SPC}
366 \key{Scroll down or move to previous content}{DEL}
367 \key{Move to next content}{n}
368 \key{Move to previous content}{p}
369 \key{Decode current content as `play mode'}{v}
370 \key{Decode current content as `extract mode'}{e}
371 \key{Show current content}{C-c C-v C-c}
372 \key{Hide current content}{C-c C-d C-c}
373 \key{View help of MIME-View}{?}
374
375 \section{Draft Mode}
376
377 \key{Insert message to cite}{C-c C-y}
378 \key{Insert template}{C-c C-j}
379 \key{Insert signature}{C-c C-w}
380 \key{Elide the region}{C-c C-d}
381 \key{Preview current draft}{C-c C-p}
382 \key{Send current draft}{C-c C-c}
383 \key{Save current draft}{C-c C-z}
384 \key{Discard current draft}{C-c C-k}
385 \key{Jump to another draft}{C-c C-o}
386 \key{Attach some file}{C-c C-x TAB}
387 %\key{Insert a reference to external body}{C-c C-x C-e}
388 \key{Insert a new MIME tag}{C-c C-x t}
389 %\key{Insert a text message}{C-c C-x C-t}
390 \key{Encrypt the message}{C-c C-x e}
391 \key{Sign the message}{C-c C-x s}
392 \key{View help of MIME-Edit}{C-c C-x ?}
393
394 \shortcopyrightnotice
395
396 \newcolumn
397 \section{Plugged Status}
398
399 \key{Toggle plugged status}{M-t}
400 \key{Enter/Exit plugged mode}{C-t}
401 \key{Toggle plugged state for current entity}{SPC}
402
403 \section{Address Book Management}
404
405 \key{Enter address book manager}{C-c C-a}
406 \key{Exit address book manager}{q}
407 \key{Set as {\tt To:}}{t}
408 \key{Set as {\tt Cc:}}{c}
409 \key{Set as {\tt Bcc:}}{b}
410 \key{Unset}{u}
411 \key{Compose message with current mark}{x}
412 \key{Add new entry}{a}
413 \key{Edit current entry}{e}
414 \key{Delete current entry}{d}
415
416 \copyrightnotice
417
418 \bye
419 \f
420 % Local variables:
421 % compile-command: "tex refcard"
422 % End: