1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
(C) Copyright 2004-2006 Shawn Betts
(C) Copyright 2007-2008 John J. Foerch
Use, modification, and distribution are subject to the terms specified in the
COPYING file.
-->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Conkeror User Manual</title>
<script type="text/javascript">
<!-- <![CDATA[
var gPrefService = Components.classes["@mozilla.org/preferences-service;1"]
.getService(Components.interfaces.nsIPrefBranch);
function set_pref()
{
var val = document.getElementById("pref").value;
if (val == '') {
if (gPrefService.prefHasUserValue ("conkeror.rcfile")) {
gPrefService.clearUserPref("conkeror.rcfile");
}
window.alert("preference `conkeror.rcfile' cleared.")
} else {
gPrefService.setCharPref("conkeror.rcfile", val);
window.alert("preference `conkeror.rcfile' Set.");
}
}
function fill_rc_pref_box () {
var pref;
if (!gPrefService.prefHasUserValue("conkeror.rcfile")) {
pref = "";
} else {
pref = gPrefService.getCharPref("conkeror.rcfile");
}
var el = document.getElementById ("pref");
el.value = pref;
}
// ]]> -->
</script>
</head>
<body onload="fill_rc_pref_box()">
<h1>Conkeror User Manual</h1>
<h2>Introduction</h2>
<p>
Conkeror is a Mozilla-based web browser whose design is inspired by
<a href="http://www.gnu.org/software/emacs">GNU Emacs</a>.
</p>
<p>
You can learn Conkeror's key bindings by <a
href="chrome://conkeror/content/tutorial.html">reading the
tutorial</a>. The keyboard shortcut to visit the tutorial is
<code>Control-h t</code>. That is, first press Control-h, then
release those keys, and press t.
</p>
<h2>Overview of the Keys</h2>
<h3>Browsing</h3>
<table border="1">
<tr>
<td><b>key</b></td>
<td><b>M-x command</b></td>
<td><b>meaning</b></td>
</tr>
<tr>
<td>g</td>
<td>find-url</td>
<td>open new URL</td>
</tr>
<tr>
<td>B</td>
<td>go-back</td>
<td> </td>
</tr>
<tr>
<td>F</td>
<td>go-forward</td>
<td> </td>
</tr>
<tr>
<td>r</td>
<td>revert-buffer</td>
<td>reload</td>
</tr>
<tr>
<td>C-g</td>
<td>abort</td>
<td>stop</td>
</tr>
<tr>
<td>C-h i</td>
<td>help-page</td>
<td>Show this page.</td>
</tr>
<tr>
<td>C-h t</td>
<td>tutorial</td>
<td>Show the Conkeror tutorial.</td>
</tr>
</table>
<h3>Movement</h3>
<table border="1">
<tr><td>C-a</td><td>beginning of line</td></tr>
<tr><td>C-e</td><td>end of line</td></tr>
<tr><td>C-f</td><td>Forward a column</td></tr>
<tr><td>C-b</td><td>backward a column</td></tr>
<tr><td>C-n</td><td>Forward a line</td></tr>
<tr><td>C-p</td><td>backward a line</td></tr>
<tr><td>C-v</td><td>Page down</td></tr>
<tr><td>M-v</td><td>Page up</td></tr>
<tr><td>M-<</td><td>Beginning of document</td></tr>
<tr><td>M-></td><td>End of document</td></tr>
<tr><td>C-s</td><td>Open i-search forward</td></tr>
<tr><td>C-r</td><td>Open i-search backward</td></tr>
</table>
<h3>I-Search</h3>
<table border="1">
<tr><td>C-s</td><td>search forward</td></tr>
<tr><td>C-r</td><td>search backward</td></tr>
<tr><td>C-g</td><td>quit i-search (jump back to where i-search started)</td></tr>
<tr><td>backspace</td><td>undo search</td></tr>
<tr><td>any modifier plus a key, enter or tab</td><td>close i-search</td></tr>
</table>
<h3>Web Jump</h3>
<p> In firefox this is the bookmark keyword feature. You type the
keyword into the location followed by some text your browser jumps to
the bookmark with the %s in the bookmark's URL substituted for this
text.</p>
<p>Conkeror also has this feature, but it's seperate from
bookmarks. Here are the built in web jumps:</p>
<table border="1">
<tr><td>google</td><td>Search with google</td></tr>
<tr><td>image</td><td>Search google images</td></tr>
<tr><td>wikipedia</td><td>Search wikipedia.org</td></tr>
<tr><td>slang</td><td>Search urbandictionary.com</td></tr>
<tr><td>dictionary</td><td>Search dictionary.reference.com</td></tr>
<tr><td>scholar</td><td>search google scholar</td></tr>
<tr><td>clusty</td><td>search the internet with clusty</td></tr>
<tr><td>xulplanet</td><td>search xulplanet.com</td></tr>
<tr><td>bugzilla</td><td>search the mozilla bug database</td></tr>
<tr><td>clhs</td><td>search the Common Lisp Hyper Spec</td></tr>
<tr><td>emacswiki</td><td>search the emacswiki</td></tr>
<tr><td>cliki</td><td>search the Common Lisp wiki</td></tr>
<tr><td>ratpoisonwiki</td><td>search the ratpoison wiki</td></tr>
<tr><td>stumpwmwiki</td><td>search the StumpWM wiki</td></tr>
<tr><td>savannah</td><td>search savannah.gnu.org</td></tr>
<tr><td>sourceforge</td><td>search sourceforge.net</td></tr>
<tr><td>freshmeat</td><td>search freshmeat.net</td></tr>
<tr><td>slashdot</td><td>search slashdot.com</td></tr>
<tr><td>kuro5hin</td><td>search kuro5hin.com</td></tr>
<tr><td>sheldonbrown</td><td>Search sheldonbrown.com</td></tr>
</table>
<p>
delicious webjumps can be added by putting the following in your rc file:
</p>
<pre>
add_delicious_webjumps ("myusername");
</pre>
<p>
this will create the following webjumps:
</p>
<table border="1">
<tr><td>adelicious</td><td>Add a delicious bookmark.</td></tr>
<tr><td>delicious</td><td>View your delicious bookmarks</td></tr>
<tr><td>sdelicious</td><td>Search your delicious bookmarks</td></tr>
<tr><td>sadelicious</td><td>Search all delicious bookmarks</td></tr>
</table>
<h3>Buffer Management</h3>
<table border="1">
<tr><td>C-u g</td><td>Open an URL in a new buffer</td></tr>
<tr><td>C-x b</td><td>Select a buffer based on it's name.</td></tr>
<tr><td>M-p</td><td>previous buffer</td></tr>
<tr><td>M-n</td><td>Next bufer</td></tr>
<tr><td>C-x k</td><td>kill buffer</td></tr>
<tr><td>C-x 5 C-f, C-u C-u g</td><td>Open an URL in a new frame</td></tr>
<tr><td>C-x 5 0</td><td>Close the current frame (all buffers in the
frame are lost, at this point)</td></tr>
<tr><td>C-x C-c</td><td>Quit conkeror</td></tr>
</table>
<h2>Conkeror RC File</h2>
<p>
You can customize Conkeror by creating an rc script or set of
scripts, and using the form below to set the preference
`conkeror.rcfile' to the path of your script. It can be set to the
path of a single file or a directory. When conkeror.rcfile is a
directory, all files with an extension of `.js' will be loaded from
that directory (non-recursive). These scripts are plain javascript
files. Conkeror loads them during startup into application scope
(as opposed to loading them for each window).
</p>
<p>
Note, if you set conkeror.rcfile to a file, the path must be
absolute. Conkeror will not expand ~ to your home directory. This
is a current limitation, and we hope to fix it soon.
</p>
<form action="get">
<p>
<input id="pref" value="" />
<input type="button" value="Set RC File" onclick="set_pref();" />
</p>
</form>
<p>Here are three common customizations:</p>
<ul>
<li>To add a new web jump:
<pre>
add_webjump("keyword", "url");
</pre></li>
<li>To add a new command:
<pre>
add_command("command-name", function_name, []);
</pre>
The 3rd argument is much like the interactive function in
emacs. Currently only "p" and "P" work. See bindings.js in the source
code for examples of how it works.
</li>
<li>To add a new key binding:
<pre>
define_key(ctrlx_kmap, kbd("c", MOD_META), "command-name");
</pre>
This binds C-x M-c to execute "command-name". Take a look at
bindings.js for the builtin keymaps and key bindings.
</li>
</ul>
<h2>Universal Argument</h2>
<p>
Conkeror support the universal argument, C-u. It's a prefix binding
that changes how a command behaves. In Conkeror, C-u has two main
effects. The first effect is that the command will be executed
multiple times. For example, typing the following:
</p>
<pre>
C-u C-n
</pre>
<p>
will cause conkeror to scroll down 4 lines.
</p>
<pre>
C-u 12 C-n
</pre>
<p>
will cause conkeror to scroll down 12 lines.
</p>
<p>
The second effect is to open in a new buffer or a new window.
</p>
<pre>
C-u g conkeror.mozdev.org RET
</pre>
<p>
This opens the conkeror project web page in a new buffer.
</p>
<pre>
C-u C-u n 12 RET
</pre>
<p>
This opens link number 12 in a new window.
</p>
<p>
There are some commands where the effect is ambiguous. Does
<code>C-u B</code> go back four pages in the history or does it go
back one and open the result in a new buffer? I am working on adding
a second universal argument that would allow you to do both.
</p>
<h2>toggle-eod-space</h2>
<p>
<code>toggle-eod-space</code> is a slightly ugly hack that should
help you read articles more smoothly. Imagine you're reading an
article. You start reading the beginning. Your eyes get to the
bottom of the screen, so you press Space to page down. You continue
until near the end of the article. You press Space to read the last
part and your browser only scrolls down part of a page, leaving
where you left off somwhere in the middle of the screen and not at
the top where you expected it. You spend the next couple seconds
searching for where you left off. <code>toggle-eod-space</code> adds
1 page of blank space to the end of the web page, so your last page
down is a full one. Note, <code>toggle-eod-space</code> turns the
feature on (or off) but the space won't be added to (or removed
from) the current page. It affects the subsequently loaded pages.
</p>
<h2>Ad Blocking</h2>
<p>
Conkeror can block images, scripts, etc originating from servers
that match one of conkeror's adblock patterns. To add a pattern use
<code>M-x adblock-add-pattern</code>. The pattern is a regular
expression.
</p>
<h2>Conkeror Resources</h2>
<ul>
<li><a href="http://conkeror.mozdev.org">Conkeror homepage</a></li>
</ul>
</body>
</html>
|
