help/help.html

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