#pragma section-numbers on

<<TableOfContents(3)>>

= About Conkeror =

Conkeror is a keyboard-oriented, highly-customizable, highly-extensible web browser based on [[http://www.mozilla.org/|Mozilla]] [[http://developer.mozilla.org/en/docs/XULRunner|XULRunner]], written mainly in !JavaScript, and inspired by exceptional software such as [[http://en.wikipedia.org/wiki/Emacs|Emacs]] and [[http://en.wikipedia.org/wiki/Vi|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 [[ConkerorBugs|bug]] and [[FeatureRequests|feature request]] sections are generally up-to-date and tend to be very informative.

 * [[irc://irc.freenode.net/#conkeror|IRC Channel]] ({{{#conkeror}}} at [[http://www.freenode.net|Freenode]])
 * Mailing List ([[http://www.mozdev.org/mailman/listinfo/conkeror|Subscribe/Unsubscribe]], [[http://news.gmane.org/gmane.comp.mozilla.conkeror|Gmane Archives]])
 * [[ConkerorBugs|Bug/Issue Tracker]]
 * [[FeatureRequests|Feature Request Tracker]]
 * [[BreakingChanges|Breaking Changes]] - Breaking changes listed by date.
 * [[ExampleConfigs|Example Configs]] - Links to users' RC scripts.
 * [[Artwork]] - Icons and other Conkeror-inspired graphics.

= Documentation =

== Installation and Startup ==

 * Installation - [[InstallationUnix|Unix/Linux]], [[InstallationOSX|OS X]], [[InstallationDebian|Debian and derivatives]], [[InstallationWindows|Windows]]
 * [[ConkerorSpawnHelper|Spawn Helper]] - Installing the spawn helper.
 * [[Invocation|Starting Conkeror]] - Command-line arguments and the steps taken at start-up.
 * [[Profiles]] - Multiple instances and multiple configurations.
 * [[MultipleXULRunners|Multiple XULRunners]] - How to install multiple XULRunner versions.
 * [[DefaultBrowser|Default Browser]] - Setting Conkeror as your default browser.
 * [[ConkerorBugs|Reporting Problems]] - How to report problems, like bugs.
 * [[FeatureRequests|Requesting Features]] - How to request features.

== Using Conkeror ==

 * [[QuickStart|Quick Start]] - A brief tour of the keys.
 * [[FAQ]] - Frequently asked questions.
 * [[ConkerorRC|Rc File]] - Configuration file or files loaded at start-up.
 * [[UserVariables|User Variables]] - Configuration settings controlled by variables.
 * [[Modules]] - Optional functionality.
 * [[PageModes|Page Modes]] - Special functionality for particular web sites.
 * [[Keyboard|Keyboard]] - Keyboard configuration.
 * [[Downloads]] - Working with downloads.
 * [[Bookmarks]] - Bookmark management.
 * [[Tabs|Tab Bar]] - Tab bar module.
 * [[Targets]] - The Target System: controlling where urls are opened.
 * [[ExternalEditing|External Editing]] - Editing text form elements in an external program.
 * [[PasswordManagement|Password Management]] - Working with Mozilla's password manager.
 * [[Proxy|Proxy Management]] - Working with with proxy settings.
 * [[MozillaPreferences|Mozilla Preferences]] - Working with Mozilla preferences.
 * [[Webjumps|Webjumps]] - Working with webjumps - shortcuts to often-used pages.
 * [[DefaultWebjump|Default Webjump]] - Setting up a default webjump.
 * [[MimeTypeHandlers|External MIME Handlers]] - Handling MIME types with external programs. '''note: obsolete'''
 * [[ContentHandlers|Content Handlers]] - Configuring actions and external programs for specific MIME types.
 * [[Appearance]] - Changing appearance using styles and themes.
 * [[Extensions|Mozilla Extensions]] - Using Mozilla extensions.
 * [[Plugins|Mozilla Plugins]] - Using Mozilla plugins.
 * [[CommonProblems|Common Problems]] - Common problems with solutions.
 * [[Tips|Tips from Users]] - User-contributed tips and tricks.
 * [[WebDevelopment|Using Conkeror for Web Development]] - Specific web-development related tricks.
 * [[Focus]] - Dealing with web pages that steal focus.

== Programming Conkeror ==

 * [[Startup]] - What happens when, during startup.
 * [[Hooks]] - Working with hooks.
 * [[Keymaps]] - Working with key bindings.
 * [[Modes]] - Overview of mode types.
 * [[Coroutines]] - How Conkeror's `coroutine.js` works.
 * [[MinibufferReadWalkthrough]] - A practical walkthrough of coroutine usage.
 * [[WritingCommands|Writing Commands]] - Writing interactive commands.
 * [[WritingBrowserObjectCommands|Writing Browser Object Commands]] - The ''what'' and ''how'' of browser objects.
 * [[WritingPageModes|Writing Page Modes]] - Writing feature-suites for specific sites.
 * [[LoadSpec|Load Spec]] - The load_spec datatype.
 * [[ObjectOrientation|Object Orientation]] - Classical OO !JavaScript tutorial.

== Development Resources ==

 * [[Roadmap]] - Future of Conkeror
 * [[DevelopmentGuidelines|Development Guidelines]] - Development guidelines.
 * [[http://repo.or.cz/w/conkeror.git|Browse Code]] - Browse the git repository.
 * [[Testing|Unit Tests]] - Writing unit tests.
 * [[ConkerorBugs|Bugs in Conkeror]] - Best practices for reporting bugs.
 * [[UpstreamBugs|Upstream Bugs]] - Known bugs in Mozilla that impact Conkeror.
 * [[GitHelp|Git Help]] - Advice on developing with git.
 * [[ConkerorLicense|License]] - License agreement(s).

== Mozilla Development Resources ==

 * [[http://developer.mozilla.org/en/docs/JavaScript|JavaScript Language and API Reference]]
 * [[http://developer.mozilla.org/en/docs/XUL_Reference|XUL API Reference]]
 * [[http://developer.mozilla.org/en/docs/Code_snippets:File_I/O|File I/O Reference]]
 * [[http://developer.mozilla.org/en/docs/Gecko-Specific_DOM_Events|Gecko-Specific DOM Events]]
 * [[http://developer.mozilla.org/en/XULRunner|XULRunner Reference]]

== See Also ==

 * [[http://repo.or.cz|repo.or.cz]] - Fast, free git hosting. (Currently Conkeror's git host.)
 * [[http://zzo38computer.cjb.net/vonkeror/|Vonkeror]] - A vork of Conkeror vith many differences.
 * [[http://vimperator.org|Vimperator]] - Plug-in for Firefox to make it look and feel more like vim.
 * [[http://www.nongnu.org/espresso/|espresso-mode]] An emacs !JavaScript mode.
 * [[http://code.google.com/p/js2-mode/|js2-mode]] - An emacs !JavaScript mode.
 * [[http://www.nongnu.org/stumpwm/|StumpWM]] - A tiling, keyboard-driven X11 window manager inspired by Emacs and screen.
 * [[NameChange|Name change discussion]]

= Using This Wiki =

== Site Navigation ==

 * [[RecentChanges|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.

== How to Use This Site ==

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

 * To edit this site, first [[http://conkeror.org/UserGroup?action=newaccount|create an account]], then ask retroj, nicktastic, or jbms on #conkeror at irc.freenode.net for write access.
 * Edit any page by pressing '''<<GetText(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.