#pragma section-numbers 2

<<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}}} on [[http://www.freenode.net|Freenode]])
 * [[MailingList|Mailing List]] - Our mailing list.
 * [[ConkerorBugs|Reporting Problems]] - How to report problems, like bugs.
 * [[FeatureRequests|Requesting Features]] - How to request features.
 * [[WikiAccess|Wiki Access]] - How to edit this wiki.
 * [[BreakingChanges|Breaking Changes]] - Changes that may affect your RC.
 * [[ExampleConfigs|Example Configs]] - Links to users' RC scripts.
 * [[Artwork]] - Icons and other Conkeror-inspired graphics.
 * Committees - [[CCABP]], [[CCOSX]]
 * [[Support]] - Supporting Conkeror.

= Documentation =

== Installation and Startup ==

 * [[XULRunner]] - How to install XULRunner.
 * Installation - How to install Conkeror.
  * [[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 startup.
 * [[Profiles]] - Multiple instances and multiple configurations.
 * [[MultipleXULRunners|Multiple XULRunners]] - How to install multiple XULRunner versions.
 * [[DefaultBrowser|Default Browser]] - Setting Conkeror as your default browser.
 * [[Troubleshooting]] - What to try when things don't work.

== Using Conkeror ==
=== Essentials ===

 * [[QuickStart|Quick Start]] - A brief tour of the keys.
 * [[FAQ]] - Frequently asked questions.
 * [[ConkerorRC|Rc File]] - Configuration file or files loaded at start-up.

=== UI ===

 * [[Hinting]] - Mastering the numbers.
 * [[History]] - Browsing URLs from your history.
 * [[Downloads]] - Working with downloads.
 * [[Targets]] - The Target System: controlling where urls are opened.
 * [[ExternalEditing|External Editing]] - Editing text form elements in an external program.
 * [[ModeLine|Mode Line]] - Customizing the mode-line.
 * [[Tabs|Tab Bar]] - Tab bar module.
 * [[Appearance]] - Changing appearance using styles and themes.
 * [[Favicons]] - Displaying Favicons in Conkeror.
 * [[KeyBindings|Key Bindings]] - Defining custom key sequences.
 * [[HideScrollbars|Hide Scrollbars]] - How to hide scrollbars.
 * [[Zoom]] - About zooming.
 * [[BufferOrder|Buffer Order]] - Controlling the spatial order of buffers.

=== Content ===

 * [[Webjumps|Webjumps]] - Working with webjumps - shortcuts to often-used pages.
 * [[ReadUrlHandlers|Read-Url Handlers]] - Defining syntax handlers for the url prompt.
 * [[PageModes|Page Modes]] - Special functionality for particular web sites.
 * [[ContentHandlers|Content Handlers]] - Configuring actions and external programs for specific MIME types.
 * [[ProtocolHandlers|Protocol Handlers]] - Configuring external handlers for protocols.
 * [[ContentPolicy|Content Policy]] - Filtering and monitoring content requests.
 * [[Focus]] - Dealing with web pages that steal focus.
 * [[KeyKill]] - Dealing with web pages that steal keys.
 * [[ClientRedirect|Client Redirect]] - Program your own redirects.
 * [[Formfill]] - About the completions popup in content input fields.

=== Environment ===

 * [[Keyboard|Keyboard]] - Keyboard configuration.
 * [[Proxy|Proxy Management]] - Working with with proxy settings.

=== Reference ===

 * [[UserVariables|User Variables]] - Configuration settings controlled by variables.
 * [[Modules]] - Optional functionality.
 * [[MozillaPreferences|Mozilla Preferences]] - Working with Mozilla preferences.
 * [[Extensions|Mozilla Extensions]] - Using Mozilla extensions.
 * [[Plugins|Mozilla Plugins]] - Using Mozilla plugins.
 * [[PasswordManagement|Password Management]] - Working with Mozilla's password manager.

=== Misc ===

 * [[Bookmarks]] - Bookmark management.
 * [[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.

== Programming Conkeror ==

 * [[Startup]] - What happens when, during startup.
 * [[Hooks]] - Working with hooks.
 * [[Keymaps]] - Working with key bindings.
 * [[Modes]] - Overview of mode types.
 * [[MinibufferRead|Minibuffer Read]] - How to take minibuffer input.
 * [[Coroutines]] - How Conkeror's `coroutine.js` works.
 * [[MinibufferReadWalkthrough|Minibuffer Read Walkthrough]] - A practical walkthrough of coroutine usage.
 * [[WritingWebjumps|Writing Webjumps]] - How to write webjumps.
 * [[WritingCommands|Writing Commands]] - Writing interactive commands.
 * [[WritingBrowserObjectCommands|Writing Browser Object Commands]] - The ''what'' and ''how'' of browser objects.
 * [[WritingBufferModes|Writing Buffer Modes]] - How to write modes that provide per-buffer features.
 * [[WritingPageModes|Writing Page Modes]] - Writing feature-suites for specific sites.
 * [[LoadSpec|Load Spec]] - The load_spec datatype.
 * [[ObjectOrientation|Object Orientation]] - Classical OO !JavaScript tutorial.
 * [[ExternalPrograms|External Programs]] - Interacting with other programs.

== 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.
 * [[Debugging]] - Running Conkeror in a debugger.
 * [[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]]
 * [[https://developer.mozilla.org/en/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]]