About Conkeror

Conkeror is a keyboard-oriented, highly-customizable, highly-extensible web browser based on Mozilla XULRunner, written mainly in JavaScript, and inspired by exceptional software such as Emacs and vi. Conkeror features a sophisticated keyboard system, allowing users to run commands and interact with content in powerful and novel ways. It is self-documenting, featuring a powerful interactive help system.

Community

Most development talk takes place on the IRC channel, however the mailing list is active and developers notify it when important things happen or break. The issue tracker's bug and feature request sections are generally up-to-date and tend to be very informative.

• IRC Channel (#conkeror at Freenode)

• Mailing List (Subscribe/Unsubscribe, Gmane Archives)

• Bug/Issue Tracker

• Feature Request Tracker

• Breaking Changes - Breaking changes listed by date.

• Example Configs - Links to users' RC scripts.

• Artwork - Icons and other Conkeror-inspired graphics.

• Committees - CCABP, CCOSX

• Support - Supporting Conkeror

Documentation

1. Installation and Startup

• XULRunner - How to install XULRunner

• Installation - Unix/Linux, OS X, Debian and derivatives, Windows

• Spawn Helper - Installing the spawn helper.

• Starting Conkeror - Command-line arguments and the steps taken at startup.

• Profiles - Multiple instances and multiple configurations.

• Multiple XULRunners - How to install multiple XULRunner versions.

• Default Browser - Setting Conkeror as your default browser.

• Reporting Problems - How to report problems, like bugs.

• Requesting Features - How to request features.

2. Using Conkeror

2.1. Essentials

• Quick Start - A brief tour of the keys.

• FAQ - Frequently asked questions.

• Rc File - Configuration file or files loaded at start-up.

2.2. UI

• Hinting - Mastering the numbers.

• History - Browsing URLs from your history.

• Downloads - Working with downloads.

• Targets - The Target System: controlling where urls are opened.

• External Editing - Editing text form elements in an external program.

• Mode Line - Customizing the mode-line.

• Tab Bar - Tab bar module.

• Appearance - Changing appearance using styles and themes.

• Favicons - Displaying Favicons in Conkeror.

• Key Bindings - Defining custom key sequences.

• Hide Scrollbars - How to hide scrollbars.

• Zoom - About zooming.

• Buffer Order - Controlling the spatial order of buffers.

2.3. Content

• Webjumps - Working with webjumps - shortcuts to often-used pages.

• Default Webjump - Setting up a default webjump.

• Page Modes - Special functionality for particular web sites.

• Content Handlers - Configuring actions and external programs for specific MIME types.

• Protocol Handlers - Configuring external handlers for protocols.

• Content Policy - Filtering and monitoring content requests.

• Focus - Dealing with web pages that steal focus.

2.4. Environment

• Keyboard - Keyboard configuration.

• Proxy Management - Working with with proxy settings.

2.5. Reference

• User Variables - Configuration settings controlled by variables.

• Modules - Optional functionality.

• Mozilla Preferences - Working with Mozilla preferences.

• Mozilla Extensions - Using Mozilla extensions.

• Mozilla Plugins - Using Mozilla plugins.

• Password Management - Working with Mozilla's password manager.

2.6. Misc

• Bookmarks - Bookmark management.

• Common Problems - Common problems with solutions.

• Tips from Users - User-contributed tips and tricks.

• Using Conkeror for Web Development - Specific web-development related tricks.

3. Programming Conkeror

• Startup - What happens when, during startup.

• Hooks - Working with hooks.

• Keymaps - Working with key bindings.

• Modes - Overview of mode types.

• Minibuffer Read - How to take minibuffer input.

• Coroutines - How Conkeror's coroutine.js works.

• Minibuffer Read Walkthrough - A practical walkthrough of coroutine usage.

• Writing Webjumps - How to write webjumps.

• Writing Commands - Writing interactive commands.

• Writing Browser Object Commands - The what and how of browser objects.

• Writing Buffer Modes - How to write modes that provide per-buffer features.

• Writing Page Modes - Writing feature-suites for specific sites.

• Load Spec - The load_spec datatype.

• Object Orientation - Classical OO JavaScript tutorial.

• External Programs - Interacting with other programs.

4. Development Resources

• Roadmap - Future of Conkeror

• Development Guidelines - Development guidelines.

• Browse Code - Browse the git repository.

• Unit Tests - Writing unit tests.

• Debugging - Running Conkeror in a debugger.

• Bugs in Conkeror - Best practices for reporting bugs.

• Upstream Bugs - Known bugs in Mozilla that impact Conkeror.

• Git Help - Advice on developing with git.

• License - License agreement(s).

5. Mozilla Development Resources

• JavaScript Language and API Reference

• XUL API Reference

• File I/O Reference

• Gecko-Specific DOM Events

• XULRunner Reference

Using This Wiki

1. Site Navigation

• Recent Changes - See where people are currently working.

• WikiSandBox - Feel free to change this page and experiment with editing.

• FindPage - Search or browse the database in various ways.

• SyntaxReference - Quick access to wiki syntax.

• SiteNavigation - Get an overview over this site and what it contains.

2. How to Use This Site

A Wiki is a collaborative site, anyone can contribute and share:

• To edit this site, first create an account, then ask retroj, nicktastic, or jbms on #conkeror at irc.freenode.net for write access.

• Edit any page by pressing Edit at the top or the bottom of the page.

• Create a link to another page with joined capitalized words (like WikiSandBox) or with ["quoted words in brackets"].

• Search for page titles or text within pages using the search box at the top of any page.

• See HelpForBeginners to get you going, HelpContents for all help pages.