Conkeror User Manual

Introduction

Conkeror is a Mozilla-based web browser whose design is inspired by GNU Emacs.

You can learn Conkeror's key bindings by reading the tutorial. The keyboard shortcut to visit the tutorial is Control-h t. That is, first press Control-h, then release those keys, and press t.

Overview of the Keys

Browsing

Movement

I-Search

Web Jump

In firefox this is the bookmark keyword feature. You type the keyword into the location followed by some text your browser jumps to the bookmark with the %s in the bookmark's URL substituted for this text.

Conkeror also has this feature, but it's seperate from bookmarks. Here are the built in web jumps:

delicious webjumps can be added by putting the following in your rc file:

add_delicious_webjumps ("myusername");

this will create the following webjumps:

Buffer Management

Conkeror RC File

You can customize Conkeror by creating an rc script or set of scripts, and using the form below to set the preference `conkeror.rcfile' to the path of your script. It can be set to the path of a single file or a directory. When conkeror.rcfile is a directory, all files with an extension of `.js' will be loaded from that directory (non-recursive). These scripts are plain javascript files. Conkeror loads them during startup into application scope (as opposed to loading them for each window).

Note, if you set conkeror.rcfile to a file, the path must be absolute. Conkeror will not expand ~ to your home directory. This is a current limitation, and we hope to fix it soon.

Here are three common customizations:

• To add a new web jump:

  add_webjump("keyword", "url");
  

• To add a new command:

  add_command("command-name", function_name, []);
  

  The 3rd argument is much like the interactive function in emacs. Currently only "p" and "P" work. See bindings.js in the source code for examples of how it works.
• To add a new key binding:

  define_key(ctrlx_kmap, kbd("c", MOD_META), "command-name");
  

  This binds C-x M-c to execute "command-name". Take a look at bindings.js for the builtin keymaps and key bindings.

Universal Argument

Conkeror support the universal argument, C-u. It's a prefix binding that changes how a command behaves. In Conkeror, C-u has two main effects. The first effect is that the command will be executed multiple times. For example, typing the following:

C-u C-n

will cause conkeror to scroll down 4 lines.

C-u 12 C-n

will cause conkeror to scroll down 12 lines.

The second effect is to open in a new buffer or a new window.

C-u g conkeror.mozdev.org RET

This opens the conkeror project web page in a new buffer.

C-u C-u n 12 RET

This opens link number 12 in a new window.

There are some commands where the effect is ambiguous. Does C-u B go back four pages in the history or does it go back one and open the result in a new buffer? I am working on adding a second universal argument that would allow you to do both.

toggle-eod-space

toggle-eod-space is a slightly ugly hack that should help you read articles more smoothly. Imagine you're reading an article. You start reading the beginning. Your eyes get to the bottom of the screen, so you press Space to page down. You continue until near the end of the article. You press Space to read the last part and your browser only scrolls down part of a page, leaving where you left off somwhere in the middle of the screen and not at the top where you expected it. You spend the next couple seconds searching for where you left off. toggle-eod-space adds 1 page of blank space to the end of the web page, so your last page down is a full one. Note, toggle-eod-space turns the feature on (or off) but the space won't be added to (or removed from) the current page. It affects the subsequently loaded pages.

Ad Blocking

Conkeror can block images, scripts, etc originating from servers that match one of conkeror's adblock patterns. To add a pattern use M-x adblock-add-pattern. The pattern is a regular expression.

Conkeror Resources

• Conkeror homepage