summaryrefslogtreecommitdiff
path: root/doc/index.docbook
blob: 16cdf2fc97b7510afd5ae24c1823ceb9e407e50b (plain)
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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY rekonq "<application>rekonq</application>">
  <!ENTITY kappname "&rekonq;">
  <!ENTITY Andrea.Diamantini "<personname>
                              <firstname>Andrea</firstname>
                              <surname>Diamantini</surname>
                              </personname>
                              ">
  <!ENTITY Rohan.Garg         "<personname>
                              <firstname>Rohan</firstname>
                              <surname>Garg</surname>
                              </personname>
                              ">
  <!ENTITY Jonathan.Kolberg   "<personname>
                              <firstname>Jonathan</firstname>
                              <surname>Kolberg</surname>
                              </personname>
                              ">
 <!ENTITY The.rekonq.Team "<personname>
                              <firstname>rekonq</firstname>
                              <surname>Team</surname>
                              </personname>
                              ">
  <!ENTITY Andrea.Diamantini.mail "<email>adjam7@gmail.com</email>">
  <!ENTITY Rohan.Garg.mail "<email>rohan16garg@gmail.com</email>">
  <!ENTITY Jonathan.Kolberg.mail "<email>bulldog98@kubuntu-de.org</email>">
  <!ENTITY The.rekonq.Team.mail "<email>rekonq@kde.org</email>">
  <!ENTITY package "playground-network">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE">
]>

<book lang="&language;">
<bookinfo>
<title>The &rekonq; Handbook</title>
<authorgroup>
<author>&Andrea.Diamantini; &Andrea.Diamantini.mail;</author>
<author>&Rohan.Garg; &Rohan.Garg.mail;</author>
<author>&Jonathan.Kolberg; &Jonathan.Kolberg.mail;</author>
<author>
<personname>
    <firstname>Part of this documentation was converted from the &kde; UserBase <ulink url="http://userbase.kde.org/Rekonq">Rekonq</ulink> page.</firstname>
<surname></surname>
</personname>
</author>
<author>
<personname>
    <firstname>Part of this documentation was converted from the &kde; UserBase <ulink url="http://userbase.kde.org/Rekonq/FAQs">Rekonq/FAQs</ulink> page.</firstname>
<surname></surname>
</personname>
    </author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
    </authorgroup>
<legalnotice>&FDLNotice;</legalnotice>
<date>2012-06-02</date>
    <releaseinfo>0.9.61 (&kde; SC 4.8)</releaseinfo>
<abstract>
<para></para>
    </abstract>
    <keywordset>
<keyword>KDE</keyword>
<keyword>browser</keyword>
<keyword>rekonq</keyword>
<keyword>webkit</keyword>
</keywordset>
</bookinfo>

<chapter id="introduction"><title>Introduction</title>
<para>Based initially on <emphasis>qtwebkit</emphasis> (and currently on <emphasis>kdewebkit</emphasis>), &rekonq; is a lightweight browser designed to use the <guilabel>WebKit</guilabel> rendering engine in combination with various &kde; technologies, allowing it to integrate seamlessly into the &kde; desktop. The name is a throwback to the venerable khtml-based <ulink url="help:/konqueror/index.html">&konqueror;</ulink> which is currently the default &kde; web browser.
</para>
<para>&rekonq; has already replaced &konqueror; as the default browser in Chakra and Kubuntu, with more distributions expressing similar intent for their future releases.
</para>
<important><para>Like all &kde; applications, &rekonq; is highly
        configurable. This document describes how &rekonq; behaves with the normal,
        default settings.
        </para>
        <para> A three button mouse can be useful when you are running
        &rekonq; or any other &kde; application. If your mouse only has two buttons
        then you should be able to set your system up so that you can simulate a middle mouse button by pressing both buttons at the same time.
        </para>
        <para>If you are used to having to double-click to perform an action,
        then take care, because in common with the rest of &kde;, &rekonq; defaults
        to single-clicking.
        </para>
</important>

<sect1 id="Starting">

<title>Starting &rekonq;</title>
<para>
&rekonq; can be started in the following ways
<itemizedlist>
  <listitem><para>From the application launcher select
    <menuchoice>
    <guimenuitem>Applications</guimenuitem>
    <guisubmenu>Internet</guisubmenu>
    <guimenuitem>rekonq</guimenuitem>
    </menuchoice>
  </para></listitem>
  <listitem><para><keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo> will open
        &krunner;, type <userinput>rekonq</userinput> (lower case) and press &Enter; to start &rekonq;</para></listitem>
</itemizedlist>
</para>
</sect1>
</chapter>
<chapter id="interface"><title>Interface</title>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-toolbar.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; main toolbar</phrase>
    </textobject>
    <caption>
      <para>&rekonq; main toolbar</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>By default, the &rekonq; window uses only one toolbar. This main toolbar consists of four navigation buttons (<guilabel>back</guilabel>, <guilabel>forward</guilabel>, <guilabel>reload/stop</guilabel>), the URL bar and a menu/button <guilabel>Tools</guilabel>. This minimalist approach to the main toolbar marks the most significant user-interface departure from the traditional multi-toolbar paradigm followed by most other browsers like &konqueror;.
</para>
<para>Further, the main toolbar offers only limited customization &ndash; <guilabel>orientation</guilabel> (locked at the top of the window, by default), <guilabel>icon size</guilabel> (medium, by default) and <guilabel>icon labels</guilabel> (not shown, by default). This helps keep the &rekonq; UI simple and puts the focus on the web page on display.
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-urlbar.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; URL bar</phrase>
    </textobject>
    <caption>
      <para>&rekonq; URL bar</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>&rekonq; introduces a vastly improved URL bar that offers access to search engines from the drop down completion list itself. The completion list is also populated by matching items from your history and bookmarks.
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-newtab.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; new tab page</phrase>
    </textobject>
    <caption>
      <para>&rekonq; new tab page</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>When started, &rekonq; displays the New Tab page, much of which is taken by a set of preview thumbnails of favorite webpages. These thumbnails offer a speedy way for the user to access their most frequently used webpages. There is also a pane at the top of this page allows the user to switch to previews of recently closed tabs and lists of bookmarked webpages, download and browsing histories.
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-panels.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; hidden UI elements</phrase>
    </textobject>
    <caption>
      <para>&rekonq; hidden UI elements</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>Further configuration options activate several other UI elements hidden by default. These include a toolbar for bookmarks, a panel (a panel, being a mini-window that can be resized, detached or re-docked in the main window) each for bookmarks and history and a web inspector panel (handy for web development).
</para>
</chapter>
<chapter id="features"><title>Features</title>
<para>Under its minimalist appearance, &rekonq; packs a full set of powerful features. Some of them are described below:
</para>
<sect1 id="kde-integration"><title>&kde; integration</title>
<para>&rekonq; is designed with the aim of being a &kde; browser. And it shows this.
</para>
<sect2 id="appearance"><title>Appearance</title>
<para>It obeys your themes, fonts, window decoration, menu highlighting, and many personalization options you set for your desktop.
</para>
</sect2>
<sect2 id="applications"><title>Applications</title>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-okularkpart.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; opens a PDF file in an &okular; <guilabel>kpart</guilabel></phrase>
    </textobject>
    <caption>
      <para>&rekonq; opens a PDF file in an &okular; <guilabel>kpart</guilabel></para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>&rekonq; plays well with other applications in the &kde; family. &rekonq; will always use your chosen default applications to handle file types. PDF files, for example will open in an embedded <ulink url="help:/okular/index.html">&okular;</ulink> <guilabel>kpart</guilabel> within &rekonq; itself. Media files will open in <ulink url="help:/dragonplayer/index.html">&dragon;</ulink> (or any other designated default application for that filetype).
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Bookmarkseditor.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; shares bookmarks &etc; with &konqueror;</phrase>
    </textobject>
    <caption>
      <para>&rekonq; shares bookmarks &etc; with &konqueror;</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>Bookmarks, web shortcuts (more on these later), cookies and authentication information are shared with &konqueror;. You will see the same set of bookmarks from either application and you can log onto a website in &konqueror; and carry on seamlessly if you decide to switch to &rekonq;. Your passwords are stored securely in <ulink url="help:/kwallet/index.html">KWallet</ulink> and can be used from either &konqueror; or &rekonq;.
</para>
<para>Your downloads can be optionally handled by <ulink url="help:/kget/index.html">KGet</ulink>. Feeds from websites can be saved to &akregator; (or <guilabel>Google Reader</guilabel>).
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-akregator.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; + &akregator;</phrase>
    </textobject>
    <caption>
      <para>&rekonq; + &akregator;</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-kget.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; + &kget;</phrase>
    </textobject>
    <caption>
      <para>&rekonq; + &kget;</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
</sect2>
</sect1>
<sect1 id="services"><title>Services</title>
<sect2 id="kio-support"><title>KIO support</title>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-ftp.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; browsing an &FTP; share</phrase>
    </textobject>
    <caption>
      <para>&rekonq; browsing an &FTP; share</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>&rekonq; supports KIO services, including cookies, cache, proxies and network settings. <emphasis>KIO-slaves</emphasis> like file:/, ftp:/, man:/, help:/, info:/ &etc; will work in &rekonq;, too.
</para>
</sect2>
<sect2 id="dialogs"><title>Dialogs</title>
<para>In addition to all this, &rekonq; uses &kde;'s own file dialog for opening/saving documents. This means, you have access to the <emphasis>Places</emphasis> navigation panel from &dolphin; while you open or save documents.
</para>
<para>Thus, &rekonq; looks, feels and behaves like a part of your &kde; desktop.
</para>
</sect2>
</sect1>
</chapter>
<chapter id="webkit-engine"><title>Webkit engine</title>
<para>&rekonq; uses the open source <guilabel>WebKit</guilabel> rendering engine which incidentally began life as a branch of the khtml/kjs libraries from the &kde; project. <guilabel>WebKit</guilabel> is fast, powerful and used by many other popular browsers today including <trademark class="registered">Google</trademark>'s <trademark class="registered">Chrome</trademark>, <trademark class="registered">Apple</trademark>'s <trademark class="registered">Safari</trademark> and others.
</para>
</chapter>
<chapter id="auto-load-click-to-load-plugins"><title>Auto-load/click-to-load plugins</title>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-manualplugins-youtube.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; demonstrating the click-to-load-plugins feature on youtube.com</phrase>
    </textobject>
    <caption>
      <para>&rekonq; demonstrating the click-to-load-plugins feature on youtube.com</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>One of the benefits of using the <guilabel>WebKit</guilabel> engine, is that plugins can be disabled from automatically loading. This comes in handy to surf websites fast, without being bogged down by <guilabel>flash</guilabel> plugins. In the so-called <emphasis>Click-to-load</emphasis> mode, you will instead see a button that you can click on to activate the plugin.
</para>
</chapter>
<chapter id="adblock-support"><title>Adblock support</title>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-adblock.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; blocking images on kde-apps.org</phrase>
    </textobject>
    <caption>
      <para>&rekonq; blocking images on kde-apps.org</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>&rekonq; comes with an automatic subscription to the Easylist filter, which is updated every week. Additionally, you can set up manual filters to block loading of elements from web pages that match your criteria. You can even download and import additional published filterlists or export your list for backup.
</para>
</chapter>
<chapter id="web-shortcuts-support"><title>Web shortcuts support</title>
<para>&rekonq; allows you to pick from an extensive list of web shortcuts &ndash; these are keywords that allow you to search the web quickly. For instance, entering <userinput>gg:&kde;</userinput> in the location bar will search <emphasis>Google</emphasis> for <quote>&kde;</quote>, while <userinput>wp:&kde;</userinput> will search <emphasis>Wikipedia</emphasis> for <quote>&kde;</quote>. There are dozens of these defined by default. You can edit these or even define custom shortcuts to search on your favorite websites.
</para>
</chapter>
<chapter id="privacy-and-security-features"><title>Privacy and security features</title>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-privatebrowsing.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; in private browsing mode</phrase>
    </textobject>
    <caption>
      <para>&rekonq; in private browsing mode</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>&rekonq; allows users to browse the web without retaining information about the visited pages in your history. Note that this feature does not necessarily make you anonymous on the Internet &ndash; it only prevents fresh information from being recorded on your computer. You can also delete your history, cookies and other private data anytime straight from the configuration menu button.
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-sslinfo.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; URL bar showing the SSL info icon</phrase>
    </textobject>
    <caption>
      <para>&rekonq; URL bar showing the SSL info icon</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>When viewing web pages over a secure connection, you can also view SSL information straight from the URL bar by clicking on the <guiicon>yellow lock</guiicon> icon.
</para>
</chapter>
<chapter id="advanced-tab-handling"><title>Advanced tab handling</title>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-tabpreview.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; showing a preview of a tab on hover</phrase>
    </textobject>
    <caption>
      <para>&rekonq; showing a preview of a tab on hover</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>&rekonq; allows you to rearrange your tabs on the fly. Just drag a tab to the left or to the right and the other tabs will move out of your way. You can also hover over a tab to see a live preview of the web page being displayed there.
</para>
<para>A <emphasis>context menu</emphasis> (right-click menu) gives access to more tab-related functions such as the ability to detach, clone, reload the tab.
</para>
</chapter>
<chapter id="session-restore-feature"><title>Session restore feature</title>
<para>If &rekonq; crashes, it will automatically attempt to restore your session, complete with all the tabs the next time you start it. If for some reason, the browser continues to crash upon restoring the session, &rekonq; will automatically start with a fresh session the second time.
</para>
</chapter>
<chapter id="full-screen-mode"><title>Full screen mode</title>
<para>&rekonq; supports full-screening the webpage straight from the configuration menu button or through a keyboard shortcut (<keycombo>&Ctrl;&Shift;<keycap>F</keycap></keycombo>, by default). In the full screen view, the main toolbar will auto-hide and the web page will be displayed over your entire screen.
</para>
</chapter>
<!--FIXME no slider any more
Git commit 288ace1df39dbea40cae66d0b04bfdefcd6cec70 by Andrea Diamantini.
Committed on 10/12/2012 at 02:09
D  +0    -210  src/zoombar.cpp
D  +0    -79   src/zoombar.h
Zoom... sets 100% now
<chapter id="zoom-slider"><title>Zoom slider</title>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-zoom.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; showing the zoom slider at the bottom of the window</phrase>
    </textobject>
    <caption>
      <para>&rekonq; showing the zoom slider at the bottom of the window</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>&rekonq; has a slider to adjust the zoom at the bottom of the window with a handy button to restore the zoom back to default. Of course, you can still use keyboard (<keycombo>&Ctrl;<keycap>+/-</keycap></keycombo>) or mouse (<keycombo>&Ctrl;<keycap> mouse scroll up/down</keycap></keycombo>) shortcuts just the same.
</para>
<para>The zoom slider can be enabled (or disabled) with <keycombo>&Ctrl;<keycap>Y</keycap></keycombo> or with <guimenuitem>Zoom...</guimenuitem> from <guilabel>Tools</guilabel> menu.
</para>
</chapter>
-->
<chapter id="Config-rekonq">
<title>Detailed &rekonq; configuration</title>

<sect1 id="General">

<title>Do the general settings of &rekonq;</title>

<para>
You want to configure the general behavior of &rekonq;? You found the right place to get it explained.
</para>

<para>
To open the general settings click on the <guiicon>Tools</guiicon> icon
and select <guisubmenu>Configure rekonq</guisubmenu>.
</para>

<para>
<screenshot>
<screeninfo>Now you should see this</screeninfo>
	<mediaobject>
	  <imageobject>
	    <imagedata fileref="general.png" format="PNG"/>
	  </imageobject>
	  <textobject>
	    <phrase>Screenshot</phrase>
	  </textobject>
	</mediaobject>
</screenshot>
</para>

<para>
Here a List of configurable points and explanation for it:

<variablelist>
  <varlistentry>
    <term><guilabel>When starting rekonq:</guilabel></term>
    <listitem> <para>You can configure what &rekonq; should do on startup.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Home page URL:</guilabel></term>
    <listitem><para>You can either set your home page directly through tipping the &URL; in.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Use the New Tab Page as home page</guilabel></term>
    <listitem><para>Enabling this option makes an empty new page the default home page of &rekonq;.</para> </listitem>
  </varlistentry>
  <varlistentry>
    <term><guibutton>Set to Current Page</guibutton></term>
    <listitem><para>Sets your home page to the one you are visiting at the moment.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Use KGet for downloading files</guilabel></term>
    <listitem><para>This activates the &kget; download integration. If this is active &rekonq; will download everything through &kget;</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>List links with KGet</guilabel></term>
    <listitem><para>If enabled, &rekonq; will display an additional context menu entry, which, when selected, lists all available links of the current website in &kget;.</para></listitem>
  </varlistentry>
</variablelist>

</para>

</sect1>

<sect1 id="Tabs">

<title>Configure the Tabs settings</title>

<para>Here you learn how to change the settings for tabs.</para>

<para>To come to the dialog click on the <guiicon>Tools</guiicon> icon and open
<menuchoice>
<guisubmenu>Configure rekonq</guisubmenu>
<guimenuitem>Tabs</guimenuitem>
</menuchoice>
</para>

<para>
<screenshot>
<screeninfo>Now this dialog should appear</screeninfo>
	<mediaobject>
	  <imageobject>
	    <imagedata fileref="tabs.png" format="PNG"/>
	  </imageobject>
	  <textobject>
	    <phrase>Screenshot</phrase>
	  </textobject>
	</mediaobject>
</screenshot>
</para>

<para>
Here a list of configurable points and explanation for it:

<variablelist>
  <varlistentry>
    <term><guilabel>New tab opens</guilabel></term>
    <listitem><para>Here you can choose the default behavior of &rekonq; when you open the new tab.</para></listitem>
  </varlistentry><varlistentry>
    <term><guilabel>New Tab Page starts with</guilabel></term>
    <listitem><para>Here you can choose the default contents for the new tabs.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Don't use tabs: open links in new window</guilabel></term>
    <listitem><para>This enables the default opening of links in new windows.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Always show tab bar</guilabel></term>
    <listitem> <para>This forces &rekonq; to show the tab bar even if there is only one tab.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Open new tabs in the background</guilabel></term>
    <listitem> <para>This makes &rekonq; not switching to new tabs.</para> </listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Open new tabs after currently active one</guilabel></term>
    <listitem> <para>This makes it to default that tabs are opened next to the currently active one.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Activate previously used tab when closing the current one</guilabel></term>
    <listitem> <para>This makes &rekonq; storing your last opened tab and if you close your current one it will reopen the old one. This also can be useful if you use many tabs.</para> </listitem>
  </varlistentry>
</variablelist>

</para>

</sect1>

<sect1 id="Appearance">

<title>Configure the Appearance settings</title>

<para>
<screenshot>
<screeninfo>Now you should see this</screeninfo>
	<mediaobject>
	  <imageobject>
	    <imagedata fileref="appearance.png" format="PNG"/>
	  </imageobject>
	  <textobject>
	    <phrase>Screenshot</phrase>
	  </textobject>
	</mediaobject>
</screenshot>
</para>

<para>
  Following will explain the configurable things and what they do on the <guilabel>Fonts</guilabel> pane.
</para>
<variablelist>
  <varlistentry>
    <term><guilabel>Standard font</guilabel></term>
    <listitem><para>Here you can set your default font. The first part is the name of the font followed by the size of the font.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Fixed font</guilabel></term>
    <listitem><para>Here you can set your font for &rekonq; labels. The same synopsis like <guilabel>Standard font</guilabel>.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Serif font</guilabel></term>
    <listitem><para>Here you can set your font for Serif labels. The same synopsis like <guilabel>Standard font</guilabel>.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Sans Serif font</guilabel></term>
    <listitem><para>Here you can set your font for Sans Serif labels. The same synopsis like <guilabel>Standard font</guilabel>.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Cursive font</guilabel></term>
    <listitem><para>Here you can set your font for Cursive labels. The same synopsis like <guilabel>Standard font</guilabel>.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Fantasy font</guilabel></term>
    <listitem><para>Here you can set your font for Fantasy labels. The same synopsis like <guilabel>Standard font</guilabel>.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Default font size:</guilabel></term>
    <listitem><para>To configure your preferred size of font.</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><guilabel>Minimal font size:</guilabel></term>
    <listitem><para>You can configure the minimal size of fonts in &rekonq;. Every smaller font will grow to that size.</para></listitem>
  </varlistentry>
</variablelist>

<para>On the <guilabel>Character Encoding</guilabel> pane:</para>

<variablelist>
  <varlistentry>
    <term><guilabel>Default character encoding:</guilabel></term>
    <listitem><para>Here you can explicitly set the encoding for the pages without prescribed encoding. Use the common encoding of your native language.</para></listitem>
  </varlistentry>
</variablelist>

<para>On the <guilabel>Custom Style Sheet</guilabel> pane:</para>

<variablelist>
  <varlistentry>
    <term><guilabel>Path to custom CSS file:</guilabel></term>
    <listitem><para>Here you can set the path to your CSS file used to format webpages.</para></listitem>
  </varlistentry>
</variablelist>
</sect1>

<sect1 id="Webkit">

<title>Configure the WebKit settings</title>

<para>
<screenshot>
<screeninfo>Now you should see this</screeninfo>
	<mediaobject>
	  <imageobject>
	    <imagedata fileref="webkit.png" format="PNG"/>
	  </imageobject>
	  <textobject>
	    <phrase>Screenshot</phrase>
	  </textobject>
	</mediaobject>
</screenshot>
</para>

</sect1>

<sect1 id="Privacy">

<title>Privacy configuration</title>

<para>
<screenshot>
<screeninfo>Now you should see this</screeninfo>
	<mediaobject>
	  <imageobject>
	    <imagedata fileref="privacy.png" format="PNG"/>
	  </imageobject>
	  <textobject>
	    <phrase>Screenshot</phrase>
	  </textobject>
	</mediaobject>
</screenshot>
</para>

<para>
  As you can see using this page you can control Javascript, tracking, history, passwords, <ulink url="help:kcontrol/cookies">cookies</ulink>, and <ulink url="help:kcontrol/cache">cache</ulink> settings of &rekonq;.
</para>

</sect1>

<sect1 id="Advanced">
<title>Advanced configuration</title>

<para>
<screenshot>
<screeninfo>Now you should see this</screeninfo>
	<mediaobject>
	  <imageobject>
	    <imagedata fileref="advanced.png" format="PNG"/>
	  </imageobject>
	  <textobject>
	    <phrase>Screenshot</phrase>
	  </textobject>
	</mediaobject>
</screenshot>
</para>

 <para>Using <guilabel>Proxy</guilabel> pane you can access the system wide proxy server settings. Just press <guibutton>Change them!</guibutton> to open the <ulink url="help:kcontrol/proxy">corresponding &systemsettings; module</ulink>.</para>

<para>On the <guilabel>Misc</guilabel> pane you can configure various aspects controlling the browser.</para>

<variablelist>
  <varlistentry>
    <term><guilabel>Enable smooth scrolling</guilabel></term>
    <listitem><para>If you enable this option &rekonq; will use smooth scrolling. Uncheck this option if the scrolling becomes choppy.</para></listitem>
  </varlistentry>
</variablelist>
</sect1>

<sect1 id="Shortcut">

<title>Configure the Shortcut settings</title>

 <!-- Add the link to KDE fundamentals on shortcuts configuration here later on! -->

<para>
<screenshot>
<screeninfo>Now you should see this</screeninfo>
	<mediaobject>
	  <imageobject>
	    <imagedata fileref="shortcuts.png" format="PNG"/>
	  </imageobject>
	  <textobject>
	    <phrase>Screenshot</phrase>
	  </textobject>
	</mediaobject>
</screenshot>
</para>

</sect1>

<sect1 id="WebShortcut">

<title>Configure Search Engines settings</title>

<para>
<screenshot>
<screeninfo>Now you should see this</screeninfo>
	<mediaobject>
	  <imageobject>
	    <imagedata fileref="webshortcuts.png" format="PNG"/>
	  </imageobject>
	  <textobject>
	    <phrase>Screenshot</phrase>
	  </textobject>
	</mediaobject>
</screenshot>
</para>

</sect1>

</chapter>

<chapter id="rekonq-faqs-tips-and-tricks"><title>rekonq FAQs, Tips and Tricks</title>
<sect1 id="how-do-i-set-rekonq-as-my-default-browser"><title>How do I set &rekonq; as my default browser?</title>
<para>Head to <menuchoice><guimenu>System Settings</guimenu><guimenuitem>Default Applications</guimenuitem></menuchoice>. Here, click on <guilabel>Web Browser</guilabel> to set your default browser. Select to open http and https URLs in the following browser and enter <userinput>rekonq %u</userinput> as the browser. Click <guilabel>Apply</guilabel>.
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Defaultwebbrowser.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>Setting &rekonq; as the default web browser</phrase>
    </textobject>
    <caption>
      <para>Setting &rekonq; as the default web browser</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
</sect1>
<sect1 id="how-do-i-load-flash-on-demand"><title>How do I load flash on demand?</title>
<para>Click on the <guilabel>Tools</guilabel> menu button, and open the <guilabel>Configure rekonq</guilabel> dialog. Click on <guilabel>WebKit</guilabel> and under <guilabel>Plugin settings</guilabel>, select to <guilabel>Manually Load Plugins</guilabel>. Click <guilabel>OK</guilabel>.
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-manualplugins.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>Setting &rekonq; to not automatically load plugins</phrase>
    </textobject>
    <caption>
      <para>Setting &rekonq; to not automatically load plugins</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
</sect1>
<sect1 id="how-do-i-make-rekonq-behave-like-chrome-chromium"><title>How do I make &rekonq; behave like chrome/chromium?</title>
<para>Using <ulink url="help:/kwin/index.html">KWin</ulink>'s window tabbing feature, we can make &rekonq; emulate the behavior of <guilabel>chromium</guilabel> by opening new windows instead of tabs within the same window. This will not however allow each window of &rekonq; to crash independently &ndash; all windows of &rekonq; crash as a single process. It merely emulates the look of <application>Chromium</application>, giving individual controls for each web page you load.
</para>
<para>Click on the <guilabel>Tools</guilabel> menu button and open the <guilabel>Configure rekonq</guilabel> dialog. Click on <guilabel>Tabs</guilabel>. Unselect all options to disable all tab handling in &rekonq;. Now, &rekonq; will always open new windows instead of tabs.
</para>
<para>Now, we'll set up <guilabel>KWin</guilabel> to automatically tab all &rekonq; windows together. Head to <menuchoice><guimenu>System Settings</guimenu><guimenuitem>Window Behavior</guimenuitem></menuchoice>. Select <guilabel>Window Behavior</guilabel> on the left and go to the <guilabel>Advanced</guilabel> tab. Here, under <guilabel>Window Tabbing</guilabel>, check <guilabel>Automatically group similar windows</guilabel>. Click <guilabel>Apply</guilabel>.
</para>
<para>Now, &rekonq; will open windows by default which will automatically get tabbed together.
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-notabs.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; configuration</phrase>
    </textobject>
    <caption>
      <para>&rekonq; configuration</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Systemsettings-enablewindowtabbing.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>System Settings configuration</phrase>
    </textobject>
    <caption>
      <para>System Settings configuration</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-windowtabbing.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>The result</phrase>
    </textobject>
    <caption>
      <para>The result</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
</sect1>
<sect1 id="how-do-i-enable-adblock"><title>How do I enable Adblock?</title>
<para>Adblocking should already be enabled for you using the <guilabel>Easylist</guilabel> adblock subscription. You can further configure it by clicking on the configuration menu button and choosing <menuchoice><guisubmenu>Tools</guisubmenu> <guimenuitem>Ad Block</guimenuitem> </menuchoice> to open <guilabel>Ad Block Settings</guilabel> dialog. Click on <guilabel>AdBlocK Filters</guilabel>. Here, you can add custom filters using wildcard strings (e.g. <command>http://www.site.com/ads/*</command>) or regular expressions within forward slashes (e.g. <userinput>//(ads|dclk)\./</userinput>).
</para>
<para>Clicking <guilabel>OK</guilabel> activates your adblock filters instantly.
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-adblockconfiguration.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; AdBlocK (automatic) configuration</phrase>
    </textobject>
    <caption>
      <para>&rekonq; AdBlocK (automatic) configuration</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="Rekonq-adblockconfiguration-manual.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase>&rekonq; AdBlocK (manual) configuration</phrase>
    </textobject>
    <caption>
      <para>&rekonq; AdBlocK (manual) configuration</para>
    </caption>
  </mediaobject>
</screenshot>
</para>
</sect1>
<sect1 id="i-have-more-questions"><title>I have more questions!</title>
<para>If you have &rekonq; installed, you can load up the <guilabel>Help</guilabel> document (just press <keycap>F1</keycap>) for more information.</para>

<!--A user-generated manual is also available <ulink url="http://userbase.kde.org/Special:myLanguage/Rekonq/Manual">here</ulink>.-->
<para><ulink url="http://forum.kde.org">&kde; Forums</ulink> is always a good place to ask user-specific questions.</para>

<para>The <ulink url="http://rekonq.kde.org/">&rekonq; website</ulink> has release announcements for the latest stable and unstable releases along with more helpful links. You can also contact the developers on the <ulink url="irc://freenode/#rekonq">#rekonq IRC channel</ulink> or the <ulink url="mailto:rekonq@kde.org">mailing list</ulink> with more questions.
</para>
</sect1>
<sect1 id="how-do-i-contribute"><title>How do I contribute?</title>
<para>See above for now. <inlinemediaobject>
<imageobject>
<imagedata fileref="Face-smile.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Smiley</phrase>
</textobject>
</inlinemediaobject>
</para>
</sect1>
</chapter>
<chapter id="credits">
<title>Credits and License</title>
<para>
&rekonq;
</para>

<para>
Program copyright: &underGPL;
</para>

<itemizedlist>
<title>Developers</title>
<listitem><para>&The.rekonq.Team; &The.rekonq.Team.mail;</para></listitem>
</itemizedlist>

<para>
Documentation copyright 2008 &Andrea.Diamantini; &Andrea.Diamantini.mail;
</para>
<para>
Documentation copyright 2009-2010 &Rohan.Garg; &Rohan.Garg.mail;
</para>
<para>
Documentation copyright 2010 &Jonathan.Kolberg; &Jonathan.Kolberg.mail;
</para>
    <para>
List of the UserBase contributors can be found on
    <ulink url="http://userbase.kde.org/index.php?title=Rekonq&amp;action=history">Rekonq</ulink> and <ulink url="http://userbase.kde.org/index.php?title=Rekonq/FAQs&amp;action=history">Rekonq/FAQs</ulink> page history.</para>
    <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
</chapter>
<appendix id="installation">
<title>Installation</title>

<sect1 id="getting-rekonq">
<title>How to obtain &rekonq;</title>
<para>Stable Packages of &rekonq; can be downloaded via standard repositories of your distribution</para>

<para>You also can compile &rekonq; yourself see <link linkend="compilation">Compilation and Installation</link> for that.</para>
</sect1>

<sect1 id="requirements">
<title>Requirements</title>

<para>In order to successfully use &rekonq;, you need at least &Qt; 4.8.x and &kde; 4.7.x.</para>
</sect1>

<sect1 id="compilation">
<title>Compilation and Installation</title>
<para>If you wish to compile &rekonq;, you have to install the headers of kdelibs and you need git and the build essentials installed.</para>

<para>Under Debian/&ubuntu; you get those through running</para>

<para>
  <userinput><command>sudo</command> <command>apt-get</command>
    <option>install</option> <parameter>build-essential kdelibs5-dev git-core</parameter>
  </userinput>
</para>

<para>Under OpenSuse you get those through running</para>
<para>
  <userinput><command>sudo</command> <command>zypper</command>
    <option>in</option> <parameter>libkde4-devel git-core gcc gcc-c++ make cmake</parameter>
  </userinput>
</para>

<para>
We will be using git, as the most recent code is available on the git repository. The &kde; Projects web page for &rekonq; can be found <ulink url="https://projects.kde.org/projects/extragear/network/rekonq">here</ulink>. Stable releases, can also be downloaded <ulink url="http://sourceforge.net/projects/rekonq/files/">here</ulink> in form of tarballs.
</para>

<para>
Now we need to checkout the latest code. To do so, in a terminal run:
</para>

<para>
  <userinput>
    <command>git</command> <option>clone</option> <parameter>git://git.kde.org/rekonq</parameter>
  </userinput>
</para>

<para>
To compile the code type in the following
</para>

<para>
  <userinput>
    <command>cd</command> <parameter>directory_where_rekonq_source_code_is</parameter>
  </userinput>
</para>

<para>
  <userinput>
    <command>mkdir</command> <parameter>build</parameter>
  </userinput>
</para>

<para>
  <userinput>
    <command>cd</command> <parameter>build</parameter>
  </userinput>
</para>

<para>
  <userinput>
    <command>cmake</command> <option>-DCMAKE_INSTALL_PREFIX=`<command>kde4-config</command> <option>--prefix</option>`</option> <parameter>..</parameter>
  </userinput>
</para>

<para>
  <userinput>
    <command>make</command>
  </userinput>
</para>

<para>
  <userinput>
    <command>sudo</command> <command>make</command> <parameter>install</parameter>
  </userinput>
</para>
</sect1>

</appendix>
&documentation.index;
</book>