contrib/man/conkeror.1

   1 .\" -*- nroff -*-
   2 .TH CONKEROR 1 "June 4, 2008"
   3 .SH NAME
   4 conkeror \(hy a web browser modeled after Emacs
   5 .SH SYNOPSIS
   6 .B conkeror
   7 .RI [ options ]
   8 .RI [ url ]
   9 .RI ...
  10 .SH DESCRIPTION
  11 This manual page documents briefly
  12 .B conkeror
  13 .PP
  14 \fBconkeror\fP is a web browser based on xulrunner, the Mozilla
  15 application framework that also powers Mozilla Firefox. It can be
  16 controlled completely with the keyboard. The key bindings are very
  17 similar to those from Emacs, so Emacs users should immediately feel at
  18 home.
  19 .SH OPTIONS
  20 This program has the same options as all other xulrunner applications.
  21 A summary of more important options is included below. All options are
  22 listed by calling \fBconkeror \-\-help\fP.
  23 .TP
  24 .B \-h, \-\-help
  25 Show summary of options.
  26 .TP
  27 .B \-v, \-\-version
  28 Show version of program.
  29 .TP
  30 .B \-\-display=DISPLAY
  31 X display to use
  32 .TP
  33 .B \-P <profile>
  34 Start with profile <profile>
  35 .TP
  36 .B \-ProfileManager
  37 Start with ProfileManager.
  38 .TP
  39 .B \-no\-remote
  40 Open new instance, not a new window in running instance.
  41 .TP
  42 .B \-UILocale <locale>
  43 Start with <locale> resources as UI Locale.
  44 .TP
  45 .B \-safe\-mode
  46 Disables extensions and themes for this session.
  47 .TP
  48 .B \-jsconsole
  49 Open the Error console.
  50 .SH CONCEPTS
  51 Similar to Emacs conkeror works with windows and buffers instead of
  52 windows and tabs.
  53 .PP
  54 When changing buffers with \fBC\(hyx b\fP or killing buffers with \fBC\(hyx
  55 k\fP, you can cut down the list of buffers by typing a few characters
  56 which filters the list for buffers which match these characters and
  57 then choosing them from the matching list of buffers with cursor keys.
  58 .PP
  59 The same idea is present with bookmarks: Bookmarks are looked up by
  60 pressing \fBg\fP to go to a new page and then start typing parts of the
  61 bookmarks title or URL.
  62 .SH TIPS AND TRICKS
  63 If you want to bookmark a page with \fBb\fP and the page has frames or
  64 inline frames (e.g. advertisements) you will be asked which frame to
  65 bookmark. If you want to bookmark the whole page with all frames,
  66 press \fB0\fP.
  67 .PP
  68 If you want to copy the link of the current page, press \fBc\fP for
  69 copy link and then type \fB0\fP for the current page instead of a link
  70 on this page.
  71 .PP
  72 Instead of typing the link number when following or copying a link,
  73 you can also type a part of the linked text. If don't type a number
  74 and one links is already active (e.g. after going back one page in the
  75 history) that link will be selected.
  76 .SH KEYBINDINGS
  77 .PP
  78 When you start it up initially you see the help page with all
  79 information and a tutorial on how to use conkeror. You always come
  80 back there by typing \fBC\(hyh i\fP which means pressing and holding the
  81 Control key (on PCs this often is the Alt key) and then pressing
  82 "i". The tutorial can be reached by pressing \fBC\(hyh t\fP.
  83 .PP
  84 This is a short list of the most important key bindings:
  85 .TP
  86 .B C\(hyx C\(hyc
  87 Exit the program
  88 .TP
  89 .B C\(hyx C\(hyf
  90 Open an URL in a new buffer.
  91 .TP
  92 .B C\(hyx C\(hyv
  93 Open an URL in the current buffer by editing the current URL.
  94 .TP
  95 .B C\(hyx b
  96 Change buffer
  97 .TP
  98 .B C\(hyx k
  99 Kill (close) buffer
 100 .TP
 101 .B M\(hyp
 102 Change to previous buffer
 103 .TP
 104 .B M\(hyn
 105 Change to next buffer
 106 .TP
 107 .B g
 108 Go to another URL
 109 .TP
 110 .B r
 111 Reload page
 112 .TP
 113 .B f
 114 Follow a link
 115 .TP
 116 .B C\(hyu f
 117 Follow a link and open it in a new window
 118 .TP
 119 .B c
 120 Copy a link to clipboard
 121 .TP
 122 .B b
 123 Bookmark page
 124 .TP
 125 .B B
 126 Go to previous page (Backward) in page history
 127 .TP
 128 .B F
 129 Go to next page (Forward) in page history
 130 .TP
 131 .B [[
 132 Go to previous page (Backward) in site navigation (if present)
 133 .TP
 134 .B ]]
 135 Go to next page (Forward) in site navigation (if present)
 136 .TP
 137 .B C\(hyg
 138 Stop (loading a the page, incremental search, etc.)
 139 .TP
 140 .B C\(hys
 141 Incremental search forward
 142 .TP
 143 .B C\(hyr
 144 Incremental search backward
 145 .TP
 146 .B C\(hyw
 147 Cut
 148 .TP
 149 .B C\(hyy
 150 Paste
 151 .SH KNOWN BUGS
 152 conkeror (respectively xulrunner) sometimes hangs at \-\-help (and
 153 possibly other situations) if /dev/random does not provide enough
 154 entropy.
 155
 156 conkeror doesn't give feedback if a spawned external process crashes
 157 or exits unsuccessfully.
 158 .SH SEE ALSO
 159 .BR xulrunner\-1.9(1),
 160 .SH AUTHOR
 161 conkeror was written by Shawn Betts, John J. Foerch, Jeremy
 162 Maitin-Shepard and other. See /usr/share/doc/conkeror/CREDITS for a
 163 full list of contributors.
 164 .PP
 165 This manual page was written by Axel Beckert <abe@deuxchevaux.org>,
 166 for the Debian project (but may be used by others).