Conkeror User Manual

Introduction

Conkeror is being built to emulate Emacs as much as possible. You'll notice many of the key bindings are the same.

What's New?

See the NEWS file for user visible changes between versions. There is also a ChangeLog that tracks changes to source files.

Some common key bindings

I'm using the emacs style key notation. C means control, A means alt. As an example, holding down control and alt and then pressing the t key would be written C-M-t.

Browsing

gopen new URL
B, lGo Back
FGo Forward
RReload
C-gStop
cCopy current URL to the clipboard
M-SPCCopy the X11 cut buffer to mozilla's clipboard. This is a cheap hack because I can't figure out how to override the mozilla past function.
C-x r bjump to bookmark
C-x r llist all bookmarks
C-x r mbookmark current URL
C-h bList all key bindings
C-h iShow this page.
C-h tShow the Conkeror tutorial.

Movement

C-abeginning of line
C-eend of line
C-fForward a column
C-bbackward a column
C-nForward a line
C-pbackward a line
C-vPage down
M-vPage up
M-<Beginning of document
M->End of document
C-sOpen i-search forward
C-rOpen i-search backward
fcycle through the document's frames. The background will flash red to indicate the focused frame.

I-Search

C-ssearch forward
C-rsearch backward
C-gquit i-search (jump back to where i-search started)
backspaceundo search
any modifier plus a key, enter or tabclose i-search

Numbered Links

You will notice each href link and form input has a number (gray background) floating on top of it. if you type the number and press enter, the href will be followed, form button clicked, or form field focused. If you press M-RET, the link will be focused. C-RET and the link will be opened in a new buffer.

Often the floating numbers get in the way of the content, so they can be toggled with M-l. When invisible, either typing a number or pressing the 'n' key will show them for the duration of the command.

Numbered Images

To copy the location of an image, press 'i'. For each image, a number (pink background) will appear at its corner. Type the number and the image location will be copied to the clipboard.

Note the image numbers disappear after the command is finished. To toggle the image numbers, press C-M-l.

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:

googleSearch with google
imageSearch google images
wikipediaSearch wikipedia.org
slangSearch urbandictionary.com
dictionarySearch dictionary.reference.com
scholarsearch google scholar
clustysearch the internet with clusty
xulplanetsearch xulplanet.com
bugzillasearch the mozilla bug database
clhssearch the Common Lisp Hyper Spec
emacswikisearch the emacswiki
clikisearch the Common Lisp wiki
ratpoisonwikisearch the ratpoison wiki
stumpwmwikisearch the StumpWM wiki
savannahsearch savannah.gnu.org
sourceforgesearch sourceforge.net
freshmeatsearch freshmeat.net
slashdotsearch slashdot.com
kuro5hinsearch kuro5hin.com
adeliciousAdd a delicious bookmark. You must set delicious_username in your RC file for this to work.
deliciousView your delicious bookmarks
sdeliciousSearch your delicious bookmarks
sadeliciousSearch all delicious bookmarks
sheldonbrownSearch sheldonbrown.com

Vi Bindings

There are also Vi bindings available. enable them by putting

use_vi_keys();
in your .conkerorrc file. or use M-x use-vi-keys RET to enable them for the session. : use-emacs-keys RET switches back.

Buffer Management

C-u gOpen an URL in a new buffer
C-x bSelect a buffer based on it's name.
M-pprevious buffer
M-nNext bufer
C-x kkill buffer
C-x 5 C-f, C-u C-u gOpen an URL in a new frame
C-x 5 0Close the current frame (all buffers in the frame are lost, at this point)
C-x C-cQuit conkeror

Conkeror As the Default Chrome

Windows opened by web pages (popup, etc) will open as a Mozilla Navigator window, not Conkeror. This is generally a Bad Thing. Press the Set Chrome button to use Conkeror, instead.

Conkeror RC File

If you want to add a key binding, a new command, or some other customization then you need to create your rc file. The rc file is just a javascript file that will get evaluated on startup. Conkeror checks the "conkeror.rcfile" preference and if it exists, loads it and evaluates it. Use the following form to set your rc file. You'll have to restart conkeror to load the rc file.

Here are three common customizations:

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