content/help.html

   1 <!DOCTYPE html
   2   PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4 <!--
   5 (C) Copyright 2004-2006 Shawn Betts
   6 (C) Copyright 2007-2008 John J. Foerch
   7
   8 Use, modification, and distribution are subject to the terms specified in the
   9 COPYING file.
  10 -->
  11
  12 <html xmlns="http://www.w3.org/1999/xhtml">
  13 <head>
  14 <title>Conkeror User Manual</title>
  15 </head>
  16 <body>
  17 <h1>Conkeror User Manual</h1>
  18
  19 <h2>Introduction</h2>
  20
  21 <p>
  22   Conkeror is a Mozilla-based web browser whose design is inspired by
  23   <a href="http://www.gnu.org/software/emacs">GNU Emacs</a>.
  24 </p>
  25
  26
  27 <p>
  28   You can learn Conkeror's key bindings by <a
  29   href="chrome://conkeror/content/tutorial.html">reading the
  30   tutorial</a>.  The keyboard shortcut to visit the tutorial is
  31   <code>Control-h t</code>.  That is, first press Control-h, then
  32   release those keys, and press t.
  33 </p>
  34
  35
  36 <h2>Overview of the Keys</h2>
  37
  38
  39 <h3>Browsing</h3>
  40 <table border="1">
  41   <tr>
  42     <td><b>key</b></td>
  43     <td><b>M-x command</b></td>
  44     <td><b>meaning</b></td>
  45   </tr>
  46   <tr>
  47     <td>g</td>
  48     <td>find-url</td>
  49     <td>open new URL</td>
  50   </tr>
  51   <tr>
  52     <td>B</td>
  53     <td>go-back</td>
  54     <td>&nbsp;</td>
  55   </tr>
  56   <tr>
  57     <td>F</td>
  58     <td>go-forward</td>
  59     <td>&nbsp;</td>
  60   </tr>
  61   <tr>
  62     <td>r</td>
  63     <td>revert-buffer</td>
  64     <td>reload</td>
  65   </tr>
  66   <tr>
  67     <td>C-g</td>
  68     <td>abort</td>
  69     <td>stop</td>
  70   </tr>
  71   <tr>
  72     <td>C-h i</td>
  73     <td>help-page</td>
  74     <td>Show this page.</td>
  75   </tr>
  76   <tr>
  77     <td>C-h t</td>
  78     <td>tutorial</td>
  79     <td>Show the Conkeror tutorial.</td>
  80   </tr>
  81 </table>
  82
  83 <h3>Movement</h3>
  84 <table border="1">
  85 <tr><td>C-a</td><td>beginning of line</td></tr>
  86 <tr><td>C-e</td><td>end of line</td></tr>
  87 <tr><td>C-f</td><td>Forward a column</td></tr>
  88 <tr><td>C-b</td><td>backward a column</td></tr>
  89 <tr><td>C-n</td><td>Forward a line</td></tr>
  90 <tr><td>C-p</td><td>backward a line</td></tr>
  91 <tr><td>C-v</td><td>Page down</td></tr>
  92 <tr><td>M-v</td><td>Page up</td></tr>
  93 <tr><td>M-&lt;</td><td>Beginning of document</td></tr>
  94 <tr><td>M-&gt;</td><td>End of document</td></tr>
  95 <tr><td>C-s</td><td>Open i-search forward</td></tr>
  96 <tr><td>C-r</td><td>Open i-search backward</td></tr>
  97 </table>
  98
  99 <h3>I-Search</h3>
 100 <table border="1">
 101 <tr><td>C-s</td><td>search forward</td></tr>
 102 <tr><td>C-r</td><td>search backward</td></tr>
 103 <tr><td>C-g</td><td>quit i-search (jump back to where i-search started)</td></tr>
 104 <tr><td>backspace</td><td>undo search</td></tr>
 105 <tr><td>any modifier plus a key, enter or tab</td><td>close i-search</td></tr>
 106 </table>
 107
 108
 109 <h3>Webjumps</h3>
 110 <p>
 111 Webjumps are similar to, but potentially more powerful than Firefox's
 112 bookmark keywords.  You type a webjump name into the location prompt,
 113 followed by one or more search terms.  Conkeror substitutes your
 114 search terms into an url associated with the webjump.
 115 </p>
 116
 117 <p>
 118 Conkeror has a few webjumps already, but you can find many more, and
 119 share your own at <a href="http://conkeror.org/Webjumps">the webjumps
 120 page of the conkeror wiki</a>.
 121 </p>
 122
 123 <table border="1">
 124 <tr><td>google</td><td>Search with google</td></tr>
 125 <tr><td>image</td><td>Search google images</td></tr>
 126 <tr><td>wikipedia</td><td>Search wikipedia.org</td></tr>
 127 <tr><td>slang</td><td>Search urbandictionary.com</td></tr>
 128 <tr><td>dictionary</td><td>Search dictionary.reference.com</td></tr>
 129 <tr><td>scholar</td><td>search google scholar</td></tr>
 130 <tr><td>clusty</td><td>search the internet with clusty</td></tr>
 131 <tr><td>xulplanet</td><td>search xulplanet.com</td></tr>
 132 <tr><td>bugzilla</td><td>search the mozilla bug database</td></tr>
 133 <tr><td>clhs</td><td>search the Common Lisp Hyper Spec</td></tr>
 134 <tr><td>emacswiki</td><td>search the emacswiki</td></tr>
 135 <tr><td>cliki</td><td>search the Common Lisp wiki</td></tr>
 136 <tr><td>ratpoisonwiki</td><td>search the ratpoison wiki</td></tr>
 137 <tr><td>stumpwmwiki</td><td>search the StumpWM wiki</td></tr>
 138 <tr><td>savannah</td><td>search savannah.gnu.org</td></tr>
 139 <tr><td>sourceforge</td><td>search sourceforge.net</td></tr>
 140 <tr><td>freshmeat</td><td>search freshmeat.net</td></tr>
 141 <tr><td>slashdot</td><td>search slashdot.com</td></tr>
 142 <tr><td>kuro5hin</td><td>search kuro5hin.com</td></tr>
 143 <tr><td>sheldonbrown</td><td>Search sheldonbrown.com</td></tr>
 144 </table>
 145
 146 <p>
 147   delicious webjumps can be added by putting the following in your rc file:
 148 </p>
 149
 150 <pre>
 151 add_delicious_webjumps ("myusername");
 152 </pre>
 153
 154 <p>
 155   this will create the following webjumps:
 156 </p>
 157
 158 <table border="1">
 159 <tr><td>adelicious</td><td>Add a delicious bookmark.</td></tr>
 160 <tr><td>delicious</td><td>View your delicious bookmarks</td></tr>
 161 <tr><td>sdelicious</td><td>Search your delicious bookmarks</td></tr>
 162 <tr><td>sadelicious</td><td>Search all delicious bookmarks</td></tr>
 163 </table>
 164
 165
 166 <h3>Buffer Management</h3>
 167 <table border="1">
 168 <tr><td>C-u g</td><td>Open an URL in a new buffer</td></tr>
 169 <tr><td>C-x b</td><td>Select a buffer based on it's name.</td></tr>
 170 <tr><td>M-p</td><td>previous buffer</td></tr>
 171 <tr><td>M-n</td><td>Next bufer</td></tr>
 172 <tr><td>C-x k</td><td>kill buffer</td></tr>
 173 <tr><td>C-x 5 C-f, C-u C-u g</td><td>Open an URL in a new frame</td></tr>
 174 <tr><td>C-x 5 0</td><td>Close the current frame (all buffers in the
 175 frame are lost, at this point)</td></tr>
 176 <tr><td>C-x C-c</td><td>Quit conkeror</td></tr>
 177 </table>
 178
 179
 180 <h2>Universal Argument</h2>
 181
 182 <p>
 183   Conkeror support the universal argument, C-u. It's a prefix binding
 184   that changes how a command behaves. In Conkeror, C-u has two main
 185   effects. The first effect is that the command will be executed
 186   multiple times. For example, typing the following:
 187 </p>
 188 <pre>
 189 C-u C-n
 190 </pre>
 191 <p>
 192   will cause conkeror to scroll down 4 lines.
 193 </p>
 194 <pre>
 195 C-u 12 C-n
 196 </pre>
 197 <p>
 198   will cause conkeror to scroll down 12 lines.
 199 </p>
 200
 201 <p>
 202   The second effect is to open in a new buffer or a new window.
 203 </p>
 204 <pre>
 205 C-u g conkeror.org RET
 206 </pre>
 207 <p>
 208   This opens the conkeror project web page in a new buffer.
 209 </p>
 210 <pre>
 211 C-u C-u n 12 RET
 212 </pre>
 213 <p>
 214   This opens link number 12 in a new window.
 215 </p>
 216
 217 <p>
 218   There are some commands where the effect is ambiguous. Does
 219   <code>C-u B</code> go back four pages in the history or does it go
 220   back one and open the result in a new buffer? I am working on adding
 221   a second universal argument that would allow you to do both.
 222 </p>
 223
 224 <h2>toggle-eod-space</h2>
 225
 226 <p>
 227   <code>toggle-eod-space</code> is a slightly ugly hack that should
 228   help you read articles more smoothly. Imagine you're reading an
 229   article. You start reading the beginning. Your eyes get to the
 230   bottom of the screen, so you press Space to page down. You continue
 231   until near the end of the article. You press Space to read the last
 232   part and your browser only scrolls down part of a page, leaving
 233   where you left off somwhere in the middle of the screen and not at
 234   the top where you expected it. You spend the next couple seconds
 235   searching for where you left off. <code>toggle-eod-space</code> adds
 236   1 page of blank space to the end of the web page, so your last page
 237   down is a full one. Note, <code>toggle-eod-space</code> turns the
 238   feature on (or off) but the space won't be added to (or removed
 239   from) the current page. It affects the subsequently loaded pages.
 240 </p>
 241
 242
 243 <h2>Conkeror Resources</h2>
 244 <ul>
 245 <li><a href="http://conkeror.org">Conkeror homepage</a></li>
 246 </ul>
 247
 248 </body>
 249 </html>