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 \-\-display=DISPLAY
  25 X display to use
  26 .TP
  27 .B \-h, \-\-help
  28 Show summary of options.
  29 .TP
  30 .B \-jsconsole
  31 Open the Error console.
  32 .TP
  33 .B \-no\-remote
  34 Open new instance, not a new window in running instance.
  35 .TP
  36 .B \-P <profile>
  37 Start with profile <profile>
  38 .TP
  39 .B \-ProfileManager
  40 Start with ProfileManager.
  41 .TP
  42 .B \-safe\-mode
  43 Disables extensions and themes for this session.
  44 .TP
  45 .B \-UILocale <locale>
  46 Start with <locale> resources as UI Locale.
  47 .TP
  48 .B \-v, \-\-version
  49 Show version of program.
  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 [[
  87 Go to previous page (Backward) in site navigation (if present)
  88 .TP
  89 .B ]]
  90 Go to next page (Forward) in site navigation (if present)
  91 .TP
  92 .B b
  93 Bookmark page
  94 .TP
  95 .B B
  96 Go to previous page (Backward) in page history
  97 .TP
  98 .B c
  99 Copy a link to clipboard
 100 .TP
 101 .B f
 102 Follow a link
 103 .TP
 104 .B C\(hyu f
 105 Follow a link and open it in a new window
 106 .TP
 107 .B F
 108 Go to next page (Forward) in page history
 109 .TP
 110 .B g
 111 Go to another URL
 112 .TP
 113 .B r
 114 Reload page
 115 .TP
 116 .B M\(hyn
 117 Change to next buffer
 118 .TP
 119 .B M\(hyp
 120 Change to previous buffer
 121 .TP
 122 .B C\(hyg
 123 Stop (loading a the page, incremental search, etc.)
 124 .TP
 125 .B C\(hyr
 126 Incremental search backward
 127 .TP
 128 .B C\(hys
 129 Incremental search forward
 130 .TP
 131 .B C\(hyw
 132 Cut
 133 .TP
 134 .B C\(hyy
 135 Paste
 136 .TP
 137 .B C\(hyx b
 138 Change buffer
 139 .TP
 140 .B C\(hyx k
 141 Kill (close) buffer
 142 .TP
 143 .B C\(hyx C\(hyc
 144 Exit the program
 145 .TP
 146 .B C\(hyx C\(hyf
 147 Open an URL in a new buffer.
 148 .TP
 149 .B C\(hyx C\(hyv
 150 Open an URL in the current buffer by editing the current URL.
 151 .SH KNOWN BUGS
 152 conkeror (respectively xulrunner) sometimes hangs at \-\-help (and
 153 possibly other situations) if \fI/dev/random\fP does not provide
 154 enough entropy.
 155
 156 conkeror doesn't give feedback if a spawned external process crashes
 157 or exits unsuccessfully.
 158 .SH FILES
 159 The default location of Conkeror's user configuration file is
 160 \fI$HOME/.conkerorrc\fP.
 161
 162 This can be changed by setting the preference
 163 \fBconkeror.rcfile\fP. The rc can be an ordinary file or a
 164 directory. If it is an ordinary file, Conkeror will evaluate that file
 165 as javascript. If it is a directory, Conkeror will evaluate all files
 166 in that directory that have the \fI.js\fP file extension.
 167
 168 See \fIhttp://conkeror.org/ConkerorRC\fP for the details.
 169 .SH SEE ALSO
 170 \fBxulrunner\-1.9(1)\fP, the Conkeror wiki at \fIhttp://conkeror.org/\fP
 171 .SH AUTHOR
 172 Conkeror was written by Shawn Betts, John J. Foerch, Jeremy
 173 Maitin-Shepard and other. See \fI/usr/share/doc/conkeror/CREDITS\fP
 174 for a full list of contributors.
 175 .PP
 176 This manual page was written by Axel Beckert <abe@deuxchevaux.org>,
 177 for the Debian project (but may be used by others).