File: xombrero.1

package info (click to toggle)
xombrero 2:1.6.4-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,860 kB
  • ctags: 2,631
  • sloc: ansic: 17,051; makefile: 465; perl: 387; sh: 120
file content (1709 lines) | stat: -rw-r--r-- 49,119 bytes parent folder | download
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
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
.\" Copyright (c) 2010, 2011, 2012 Marco Peereboom <marco@peereboom.us>
.\" Copyright (c) 2011 Jason McIntyre <jmc@openbsd.org>
.\" Copyright (c) 2012 Josh Rickmar <jrick@devio.us>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: August 23 2012 $
.Dt XOMBRERO 1
.Os
.Sh NAME
.Nm xombrero
.Nd lightweight web browser
.Sh SYNOPSIS
.Nm xombrero
.Bk -words
.Op Fl nSTtV
.Op Fl f Ar file
.Op Fl s Ar session_name
.Op Ar url ...
.Ek
.Sh DESCRIPTION
.Nm
is a minimalistic web browser that tries to stay out of the way so that
valuable screen real estate can be used for much more important stuff.
It has sane defaults and does not require one to learn a language to do any
configuration.
It was written by hackers for hackers
and it strives to be small, compact, and fast.
.Pp
.Nm
is very simple in its use.
Most actions are initiated via key or mouse bindings.
Key bindings are based on those of the
.Xr vi 1
text editor,
giving web browsing a similar feel to navigating a text document.
The
.Sx KEY BINDINGS
section below documents the various defaults and possible customizations.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl f Ar file
Specify an alternative configuration file.
.It Fl n
Open a new tab in a running
.Nm
for each specified URL.
This option requires
.Cm enable_socket
to be enabled.
.It Fl e Ar command
Execute arbitrary command (see the
.Sx COMMAND MODE
section below) in a running
.Nm
instance. This option requires
.Cm enable_socket
to be enabled. Example run: xombrero \-e "tabnew openbsd.org"; xombrero \-e
tabclose; xombrero \-e wq.
.It Fl S
Disable the toolbar.
.It Fl s Ar session_name
Open session that was saved with ":session save" command.
.It Fl T
Disable visualization of tabs.
.It Fl t
Disable tabs.
Pages that would open in tabs open in new windows instead.
.It Fl V
Display version and exit.
.El
.Sh FAST STARTUP
The following notation is used throughout this page:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Cm C-
Control
.It Cm S-
Shift
.It Cm M1-
Meta 1 (sometimes marked Alt)
.It Cm M2-
Meta 2
.It Cm M3-
Meta 3
.It Cm M4-
Meta 4 (sometimes marked Windows)
.It Cm M5-
Meta 2
.It Cm MB1
Mouse button 1
.El
.Pp
To browse to a specific address,
either use the mouse to click on the address bar
or press
.Cm F6
to shift the keyboard focus to the address bar.
The address is then entered manually.
.Pp
The mouse can be used to navigate the page in the traditional manner,
or the keyboard can be used instead.
For example,
.Cm PageUp
and
.Cm PageDown
will scroll up and down the page.
.Pp
To follow a link,
either click on it or use the
.Cm f
key and have
.Nm
assign numbers to each link on the page;
entering that number on the keyboard will prompt
.Nm
to follow the link.
.Sh KEY BINDINGS
.Nm
provides many actions accessed via key or mouse bindings.
Most can be reprogrammed using a
.Cm keybinding
entry in the configuration file.
Each keyboard shortcut requires exactly one entry in the configuration file.
A shortcut can have multiple entries in the configuration file.
The format of the keybinding entry is as follows:
.Pp
.D1 keybinding = (:)action,(!)keystroke(s)
.Pp
For example, "keybinding = tabnew,C-t" where
.Cm tabnew
is the action and
.Cm C-t
are
the keystrokes.
.Pp
Actions may be any xombrero command that can be run from the command
prompt.
There is one additional action,
.Cm unbind ,
which will unbind any previous actions to that keybinding.
.Pp
If the action begins with a colon, the action will be entered into the
command prompt instead of being executed.
For example, "keybinding = :session open ,M1-s" will open the command
prompt with ":open session " entered when using the M1-s keybinding.
.Pp
Keybindings which open the command prompt may also include the string
<uri>, which will be replaced by the current tab's URI.
For example, "keybinding = :open <uri>,F10" will open the command
prompt with <uri> replaced with the current URI.
.Pp
GTK has some default keybindings for manipulating text inside input
fields, such as the URI or search entry widget, for example
.Cm C-w
deletes a word. To override these defaults prefix your key with an
exclamation mark (!), like this: "keybinding = tabclose,!C-w".
The
.Cm clearall
key word is special and is meant to reset the key binding list to the GTK+
and WebKit defaults.
This keyword should be the first
.Cm keybinding
entry in the configuration file.
.Pp
Shift should be used sparingly since it gets in the way of non-USA keyboards.
See the accompanying configuration file for examples.
.Pp
The various bindings are documented below.
The relevant keybinding action is given afterwards, in parentheses.
.Ss Command mode
These commands are used to focus or unfocus input on the default input of a web
page.
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Cm ESC
Go to command mode; unfocus current entry on web page.
.Pq Cm command_mode
.It Cm i
Go to insert mode; focus on default entry on web page.
.Pq Cm insert_mode
.El
.Ss Search Commands
These commands are used to search for text strings within a web page.
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Cm /
Start a search
.Pq Cm search
.It Cm \&?
Start a backwards search
.Pq Cm searchb
.It Cm n
Next item matching search
.Pq Cm searchnext
.It Cm N
Previous item matching search
.Pq Cm searchprev
.El
.Ss Focus Commands
These commands are used to shift the focus of
.Nm
from one area to another.
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Cm F6
Focus on address bar
.Pq Cm focusaddress
.It Cm F7
Focus on search entry
.Pq Cm focussearch
.El
.Ss Command Aliases
These commands allow the user to map specific actions to specific keys.
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Cm F1
Alias for "help"
.It Cm F2
Alias for "proxy toggle"
.It Cm F4
Alias for "toplevel toggle"
.El
.Ss Prompt Aliases
These commands allow the user to open a prompt.
These can be useful when the
.Fl S
option is used.
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Cm F9
Alias for ":open "
.It Cm F10
Alias for ":open <uri>"
.It Cm F11
Alias for ":tabnew "
.It Cm F12
Alias for ":tabnew <uri>"
.El
.Ss Navigation Commands
These commands allow the user to navigate web pages and,
to some extent,
control the browser.
.Pp
.Bl -tag -width "Space, C-f, PageDownXXX" -offset indent -compact
.It Cm F5, C-r, C-l
Reload page
.Pq Cm reload
.It Cm BackSpace, M-Left
Previous page
.Pq Cm goback
.It Cm S-BackSpace, M-Right
Forward page
.Pq Cm goforward
.It Cm j, Down
Next line on page
.Pq Cm scrolldown
.It Cm k, Up
Previous line on page
.Pq Cm scrollup
.It Cm G, End
Bottom of page
.Pq Cm scrollbottom
.It Cm gg, Home
Top of page
.Pq Cm scrolltop
.It Cm Space, C-f, PageDown
Page down
.Pq Cm scrollpagedown
.It Cm C-b, PageUp
Page up
.Pq Cm scrollpageup
.It Cm l, Right
Page right
.Pq Cm scrollright
.It Cm h, Left
Page left
.Pq Cm scrollleft
.It Cm $
Page far right
.Pq Cm scrollfarright
.It Cm 0
Page far left
.Pq Cm scrollfarleft
.It Cm M-f
Favorites
.Pq Cm fav
.It Cm M-j
Cookie jar
.Pq Cm cookiejar
.It Cm M-d
Download manager
.Pq Cm dl
.It Cm C-p
Print page
.Pq Cm print
.It Cm M-h
Global history
.Pq Cm history
.It Cm C-j
Toggle JavaScript enabled for FQDN
.Pq Cm js
.It Cm C-s
Toggle source view
.Pq Cm togglesrc
.It Cm M-c
Toggle cookie enabled for FQDN
.Pq Cm cookie
.It Cm M-p
Toggle plugins enabled for FQDN
.Pq Cm plugin
.El
.Ss Tab Manipulation
.Nm
supports tabbed browsing.
That is, web pages may be opened in separate tabs,
allowing the user to quickly move from one page to another,
and back.
These commands then are used to create, destroy, and move between tabs.
.Pp
.Bl -tag -width "C-plus, C-equalXXX" -offset indent -compact
.It Cm C-MB1
Open new tab with the clicked link
.It Cm C-t
Create new tab with focus in URL entry
.Pq Cm tabnew
.It Cm C-T
Create new tab with focus in URL entry as the last tab in the browser
.Pq Cm 999tabnew
.It Cm C-w
Destroy current tab
.Pq Cm tabclose
.It Cm U
Undo close tab
.Pq Cm tabundoclose
.It Cm C-Left, C-PageUp
Go to the previous tab
.Pq Cm tabprevious
.It Cm C-Right, C-PageDown
Go to the next tab
.Pq Cm tabnext
.It Cm C-[1..9]
Jump to page
.Ar N
.Pq Cm tabnext [1..9]
.It Cm C-<
Jump to first page
.Pq Cm tabfirst
.It Cm C->
Jump to last page
.Pq Cm tablast
.It Cm C-minus
Zoom out by 4%
.Pq Cm focusout
.It Cm C-plus, C-equal
Zoom in by 4%
.Pq Cm focusin
.It Cm C-0
Set zoom level to 100%
.Pq Cm focusreset
.El
.Ss Yanking and pasting
These commands copy and paste text to and from the clipboard.
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Cm p
Paste the contents of the clipboard into the address bar
.Pq Cm pasteuricur
.It Cm P
Paste the contents of the clipboard into a new tab
.Pq Cm pasteurinew
.It Cm y
Yank the current URL into the clipboard
.Pq Cm yankuri
.El
.Ss Hyperlink Following
This allows the user to follow hyperlinks
without using a mouse.
Enter the corresponding number to follow the link.
Alternatively one can type the name of the link and when there are no more
possibilities
.Nm
will follow the link.
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Cm f, '.'
Highlight all links and prefix them with a number.
.Pq Cm hinting
.It Cm F, ','
Highlight all links and prefix them with a number but open in a new tab.
.Pq Cm hinting_newtab
.El
.Ss Exiting
Commands to exit the browser.
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Cm C-q
Quit
.Pq Cm quitall
.El
.Ss Low-Contrast Color Scheme
These commands toggle the page style between the default CSS and a
low-contrast color scheme with light grey text on a dark grey background.
If the
.Cm userstyle
setting is changed, that stylesheet will be used instead of the
low-contrast color scheme.
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Cm s
Toggle the current tab's style.
.Pq Cm userstyle
.It Cm S
Toggle the global page style mode.
Will also affect new tabs.
.Pq Cm userstyle_global
.El
.Ss Insert-mode commands
The following commands are only available when editing an input-field
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Cm C-i
Edit the contents of the currently active input-element in an external editor.
.Pq Cm editelement
.El
.Sh COMMAND MODE
Command mode works in a similar fashion to the
.Xr vi 1
editor;
it is entered by typing a colon and exited by pressing Esc.
The commands and their descriptions are listed below.
.Bl -tag -width Ds -offset indent
.It Cm about , version
Display the About page.
.It Cm buffers , ls , tabs
Display the currently opened tabs and let the user switch tabs by typing
the tab number or by using the mouse.
.It Cm ca
Display CA certificates.
.It Cm cert , cert show
Download and display certificates of the domain on current tab.
.It Cm cert save
Save certificate into a local store.
The next time the site is visited it is compared against the store.
If the certificate matches,
the address bar will be blue;
if it doesn't the bar will be red.
.It Cm cookie
The
.Cm cookie
command is used to manipulate the cookie whitelist.
Used by itself it expands to
.Cm cookie show all .
.It Cm cookiejar
Show cookie jar contents.
.It Cm cookie purge
Remove all cookies from the cookie jar.
.It Cm cookie save, cookie save fqdn
Save the current fully qualified domain name (FQDN)
to the persistent whitelist.
For example,
the www.peereboom.us domain would result in saving www.peereboom.us.
.It Cm cookie save domain
Save the top level domain name to the persistent whitelist.
For example,
the www.peereboom.us domain would result in saving .peereboom.us.
.Pp
This action enables cookies if it is currently disabled for this entry.
.It Cm cookie show all
Show all persistent and session entries in the cookie whitelist.
.It Cm cookie show persistent
Show all persistent entries in the cookie whitelist.
.It Cm cookie show session
Show all session entries in the cookie whitelist.
.It Cm cookie toggle domain
Toggle cookie support for the current top level domain.
.It Cm cookie toggle, cookie toggle fqdn
Toggle cookie support for the current FQDN.
.It Cm dl
Show download manager.
.It Cm encoding Op Ar encoding
Set the current tab's encoding to
.Ar encoding
and reload the tab.
If
.Ar encoding
is not provided, the current tab's encoding is displayed.
.It Cm editsrc
Open the source for the current tab in the editor specified by the
setting
.Cm external_editor
and then check for changes to the file opened. If it is changed, the
page will be updated.
.It Cm editelement
If a text-element is currently active (<input> or <textarea>), it's
contents will be opened in the same fashion as for the command
.Cm editsrc
above
.It Cm fav
Show favorites.
.It Cm favadd Op Ar title
Add the current page to favorites.
The title can be overridden by specifying
.Ar title .
.It Cm favedit
Show favorites list and links to remove entries.
.It Cm fullscreen , f
Toggle hiding tabs and url entry toolbar.
.It Cm h , hist , history
Show global history.
.It Cm help
Show help page.
.It Cm home
Go to home URL.
.It Cm https
The
.Cm https
command is used to manipulate the items in the HTTPS force list.
Used by itself it expands to
.Cm https show all .
.It Cm https save, save fqdn
Save the FQDN to the persistent force HTTPS list.
For example,
the www.peereboom.us domain would result in saving www.peereboom.us.
.It Cm https save domain
Save the top level domain name to the persistent whitelist.
For example,
the www.peereboom.us domain would result in saving .peereboom.us.
.It Cm https show all
Show all persistent and session entries in the HTTPS force list.
.It Cm https show persistent
Show all persistent entries in the HTTPS force list.
.It Cm https show session
Shows all session entries in the HTTPS force list.
.It Cm https toggle, https toggle fqdn
Toggle this FQDN in the HTTPS force list.
.It Cm https toggle domain
Toggle the top level domain in the HTTPS force list.
.It Cm js
The
.Cm js
command is used to manipulate the JavaScript whitelist.
Used by itself it expands to
.Cm js show all .
.It Cm js save, save fqdn
Save the FQDN to the persistent whitelist.
For example,
the www.peereboom.us domain would result in saving www.peereboom.us.
.It Cm js save domain
Save the top level domain name to the persistent whitelist.
For example,
the www.peereboom.us domain would result in saving .peereboom.us.
.Pp
This action enables JavaScript if it is currently disabled for this entry.
.It Cm js show all
Show all persistent and session entries in the JavaScript whitelist.
.It Cm js show persistent
Show all persistent entries in the JavaScript whitelist.
.It Cm js show session
Show all session entries in the JavaScript whitelist.
.It Cm js toggle, js toggle fqdn
Toggle JavaScript execution for the current FQDN.
.It Cm js toggle domain
Toggle JavaScript execution for the current top level domain.
.It Cm loadimages
If the setting
.Cm auto_load_images
is disabled, load all images for current site.
.It Cm open , op , o Ar URL
Open
.Ar URL .
.It Cm plugin
The
.Cm plugin
command is used to manipulate the plugin whitelist.
Used by itself it expands to
.Cm plugin show all .
.It Cm plugin save, save fqdn
Save the FQDN to the persistent whitelist.
For example,
the www.peereboom.us domain would result in saving www.peereboom.us.
.It Cm plugin save domain
Save the top level domain name to the persistent whitelist.
For example,
the www.peereboom.us domain would result in saving .peereboom.us.
.Pp
This action enables plugins if they are currently disabled for this entry.
.It Cm plugin show all
Show all persistent and session entries in the plugin whitelist.
.It Cm plugin show persistent
Show all persistent entries in the plugin whitelist.
.It Cm plugin show session
Show all session entries in the plugin whitelist.
.It Cm plugin toggle, plugin toggle fqdn
Toggle plugin execution for the current FQDN.
.It Cm plugin toggle domain
Toggle plugin execution for the current top level domain.
.It Cm print
Print page.
.It Cm proxy
The
.Cm proxy
command is used to manipulate the currently set proxy.
Used by itself it expands to
.Cm proxy show .
.It Cm proxy show
Display the current
.Cm http_proxy
setting.
.It Cm proxy toggle
Enable or disable the proxy for
.Nm .
Note that
.Cm http_proxy
must be set before it can be toggled.
.It Cm qa , qall , quitall
Quit
.Nm .
.It Cm quit , q
Close current tab and quit
.Nm
if it is the last tab.
.It Cm restart
Restart
.Nm
and reload all current tabs.
.It Cm run_script Op Ar path_to_script
Run the script
.Ar path_to_script
with the current uri as the argument.
If
.Ar path_to_script
is not provided, the script specified by the
.Cm default_script
setting is used instead.
.It Cm script Ar filename
Run an external JavaScript script file in the current tab context.
.It Cm session , Cm session show
Display the current session name.
By default the session name is
.Dq main_session .
To create a new session use the
.Cm session save
command.
A session is defined as the lifetime of the browser application.
.It Cm session delete Ar session_name
Delete session
.Ar session_name
from persistent storage.
If
.Ar session_name
is the current session then the session will revert to
.Dq main_session .
.It Cm session open Ar session_name
Close all tabs and open session
.Ar session_name .
Going forward this session is named
.Ar session_name .
.It Cm session save Ar session_name
Save current tabs to session
.Ar session_name .
This will close the current session and going forward this session is named
.Ar session_name .
.It Cm set
The
.Cm set
command is used to inspect, clear or change runtime options.
There are 3 methods to use
.Cm set .
When used by itself as
.Dq Cm :set
the command displays all options as currently set.
.Pp
To set a value use
.Dq Cm :set Ao Ar option Ac Ns = Ns Aq Ar value .
For example,
.Dq Cm :set http_proxy=http://127.0.0.1:8080 .
.Pp
To clear a value use
.Dq Cm :set Ao Ar option Ac Ns = .
For example,
.Dq Cm :set http_proxy= .
.Pp
Note, not all options can be set at runtime.
.It Cm stats
Show blocked cookie statistics.
These statistics vary based on settings and are not persistent.
.It Cm statustoggle , statust
Toggle status bar.
.It Cm stop
Stop loading the current web page.
.It Cm tabclose
Close current tab.
.It Cm tabhide
Hide tabs.
.It Cm tabnew , tabedit Op Ar URL
Create a new tab and optionally open provided
.Ar URL .
.It Cm tabnext
Go to the next tab.
.It Cm tabonly
Close all tabs except the currently focused one.
.It Cm tabprevious
Go to the previous tab.
.It Cm tabshow
Show tabs in GUI.
.It Cm toplevel , toplevel toggle
Toggle the top level domain name cookie and JS session whitelist.
This is to enable/disable short lived full site functionality without
permanently adding the top level domain to the persistent whitelist.
.It Cm urlhide , urlh
Hide url entry and toolbar.
.It Cm urlshow , urls
Show url entry and toolbar.
.It Cm userstyle Op Ar stylesheet
Toggle the current tab between using the custom stylesheet
.Ar stylesheet
and the page's default CSS.
If
.Ar stylesheet
is not provided, the stylesheet specified by the
.Cm userstyle
setting will be used.
This
.Cm userstyle
setting is set by default to a low-contrast color scheme.
.Pp
Additional stylesheets may be used in addition to that set by
.Cm userstyle
by specifying additional keybindings.
For example,
.Pp
.D1 keybinding = userstyle ~/style.css,v
.D1 keybinding = userstyle_global ~/style.css,V
.Pp
will map toggling between ~/style.css to the v and V keys while
keeping the stylesheet specified by
.Cm userstyle
mapped to the s and S keys.
.It Cm userstyle_global Op Ar stylesheet
Same as the
.Cm userstyle
command but affects all open tabs and newly created tabs will use
this style.
.It Cm w
Save open tabs to current session.
The tabs will be restored next time the session is opened.
See the session command for additional details.
.It Cm wq
Save open tabs and quit.
The tabs will be restored next time the session is opened.
See the
.Cm session
command for more details.
.El
.Sh BUFFER COMMANDS
In addition to shortcuts and commands
.Nm
provides buffer commands. Buffer commands are short, multi character
vi-like commands, often requiring an argument. Partial buffer commands
are
displayed in the buffer command statusbar element (see
.Cm statusbar_elems ) .
Pressing Esc or switching to another tab cancels a partially entered
buffer command. In the following list
.Cm arg
denotes the argument a buffer command accepts. Buffer commands are
defined as extended regular expressions.
Note that if a character is used as a shortcut it will not be interpreted
as the beginning of a buffer command. This is the case with
.Cm 0 .
.Pp
.Bl -tag -width "['][a-zA-Z0-9]XXX" -offset indent -compact
.It Cm gg
go to the top of the page
.It Cm gG
go to the bottom of the page
.It Cm [0-9]+%
go to the
.Cm arg
percent of the page
.It Cm zz
go to 50% of the page
.It Cm [0-9]*gu
go
.Cm arg
levels up. If
.Cm arg
is missing, 1 is assumed. Going a
level up means going to a URI obtained from the current one by removing
the last slash ('/') character and everything that follows it
.It Cm gU
go to the root level, i.e. going up as many levels as possible.
.It Cm gh
open the home page in the current tab
.It Cm m[a-zA-Z0-9]
set a mark denoted by
.Cm arg
at the current page position. These marks behave like those in vi or
less.
.It Cm ['][a-zA-Z0-9']
go to the position where mark
.Cm arg
was set. The special mark "'" points to the previous page position, after a
"gg", "gG", "zz", "%" or "'" buffer command.
.It Cm M[a-zA-Z0-9]
set the current uri as quickmark
.Cm arg
.It Cm go[a-zA-Z0-9]
open the uri marked as quickmark
.Cm arg
in the current tab
.It Cm gn[a-zA-Z0-9]
open the uri marked as quickmark
.Cm arg
in a new tab
.It Cm [0-9]+t
activate tab number
.It Cm g0
go to first tab
.It Cm g$
go to last tab
.It Cm [0-9]*gt
go to the
.Cm arg
next tab
.It Cm [0-9]*gT
go to the
.Cm arg
previous tab
.Cm arg
.It Cm ZZ
quit
.Nm
.It Cm ZR
restart
.Nm
.It Cm zi
zoom in by 4%
.It Cm zo
zoom out by 4%
.It Cm z0
set zoom level to 100%
.It Cm [0-9]+Z
set zoom level to
.Cm arg
%
.El
.Sh QUICKMARKS
Quickmarks are like bookmarks, except they are referred to by a single
character (a letter or a digit), instead of a longer name. See the
.Cm M[a-zA-Z0-9] ,
.Cm go[a-zA-Z0-9]
and
.Cm gn[a-zA-Z0-9]
buffer commands for usage. Quickmarks are stored in
.Pa ~/.xombrero/quickmarks
and are saved automatically after each
.Cm M[a-zA-Z0-9]
buffer command.
.Sh ABOUT SCREENS
The about screens are internally generated web pages by
.Nm
for user interaction.
These are entered in the address bar and the format is
.Cm about:screen
where screen is the desired screen to display.
For example about:favorites.
Any about screen can be used as the home page as specified by
.Cm home
in the configuration file.
.Pp
.Bl -tag -width "downloadsXXX" -offset indent -compact
.It Cm about
show the about screen
.It Cm blank
show a blank screen
.It Cm cookiewl
show the cookie whitelist screen
.It Cm cookiejar
show the cookiejar screen
.It Cm downloads
show the downloads screen
.It Cm favorites
show the favorites screen
.It Cm help
show the help web page
.It Cm history
show the history screen
.It Cm jswl
show the JavaScript whitelist screen
.It Cm plwl
show the plugin whitelist screen
.It Cm set
show the settings screen
.It Cm stats
show the statistics screen
.El
.Sh WHITELISTS
This section describes advanced usage settings.
Most users should use
.Cm browser_mode
instead to setup
.Nm
and skip over this section.
.Pp
.Nm
has a number of whitelists to control blocking cookies and JavaScript
execution for FQDNs or domains.
When properly enabled these whitelists require either the FQDN or top level
domain to exist in the whitelists in order to allow cookies to be stored or
JavaScript to execute.
Both JavaScript and cookies have two whitelists associated with them.
The whitelists are called session and persistent.
Items in the session whitelists are only allowed for the lifetime of the
.Nm
instance.
Items in the persistent whitelists are stored on disk and are restored
upon restarting.
.Pp
Setting up the whitelists is a little tricky due to intricacies of WebKit.
In fact the semantics are different for cookies and JavaScript.
.Pp
Cookie whitelist requires the following configuration to be set:
.Pp
.Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
.It Cm cookies_enabled
This is a WebKit setting and must be set to
.Pa 1
(ENABLED)
in order to be able to use a
cookie whitelist.
.It Cm enable_cookie_whitelist
This needs to be set to
.Pa 1
to enable the cookie whitelist functionality.
.It Cm cookie_wl
These entries in the configuration file are the actual domains names in the
cookie whitelist.
.El
.Pp
JavaScript whitelist requires the following configuration to be set:
.Pp
.Bl -tag -width "enable_js_whitelistXXX" -offset indent -compact
.It Cm enable_scripts
This is a WebKit setting and must be set to
.Pa 0
(DISABLED)
in order to be able to use a
JavaScript whitelist.
.It Cm enable_js_whitelist
This needs to be set to
.Pa 1
to enable the JavaScript whitelist functionality.
.It Cm js_wl
These entries in the configuration file are the actual domains names in the
JavaScript whitelist.
.El
.Pp
Plugin whitelist requires the following configuration to be set:
.Pp
.Bl -tag -width "enable_plugin_whitelistXXX" -offset indent -compact
.It Cm enable_plugins
This is a WebKit setting and must be set to
.Pa 1
(ENABLED)
in order to be able to use a
plugin whitelist.
.It Cm enable_plugin_whitelist
This needs to be set to
.Pa 1
to enable the plugin whitelist functionality.
.It Cm pl_wl
These entries in the configuration file are the actual domains names in the
plugin whitelist.
.El
.Pp
See the
.Pa FILES
section for additional configuration file entries and details
that alter runtime behavior.
.Sh FILES
.Bl -tag -width "/etc/xombrero.confXXX" -compact
.It Pa ~/.xombrero.conf
.Nm
user specific settings.
.It Pa ~/.xombrero
.Nm
scratch directory.
.El
.Pp
.Nm
tries to open the user specific file,
.Pa ~/.xombrero.conf .
If that file is unavailable,
it then uses built-in defaults.
Any settings saved at runtime will be saved to the file
.Pa ~/.xombrero/runtime
and will be loaded as well.
.Pp
The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
For example:
.Pp
.Dl http_proxy = http://127.0.0.1:8080
.Pp
Enabling or disabling an option is done by using 1 or 0 respectively.
.Pp
The file supports the following keywords:
.Pp
.Bl -tag -width "enable_cookie_whitelistXXX" -offset indent -compact
.It Cm alias
Defines an alias for a given URL, so that the URL is loaded when the alias is
entered in the address bar.
If the aliased URL includes a %s format specifier, then any argument given after
the alias on the address bar is substituted.
For example, if g,http://www.google.com/search?q=%s is defined as an alias,
then the URL http://www.google.com/search?q=foo is loaded when navigating to
"g foo".
.It Cm allow_insecure_content
If set, all content referenced by a page will be loaded.
If unset, encrypted pages will refuse to load content that is linked
from an insecure location.
.It Cm allow_insecure_scripts
If set, all scripts referenced by a page will be loaded and run using
the current javascript policy.
If unset, encrypted pages will refuse to run scripts that are linked
from an insecure location.
.It Cm allow_volatile_cookies
If set cookies are stored in the session cache but will be discarded once
.Nm
exits.
Unfortunately enabling this does allow for some limited tracking on the web.
.It Cm anonymize_headers
If set, HTTP headers taken from the
.Lk https://www.bitrig.org/ "Bitrig website"
will be used to feed additional values to the
.Nm xombrero
HTTP header settings.
Currently only the User-Agent and Http-Accept headers are modified,
corresponding to the
.Cm user_agent
and
.Cm http_accept
settings, respectively.
These headers are set after any header settings are read in from your
.Cm ~/.xombrero.conf .
Default is 0.
.It Cm append_next
When set a new tab is appended after the current tab instead of being appended
as the last tab.
.It Cm auto_load_images
If disabled, images will not be loaded automatically.
.It Cm autofocus_onload
When set a tab that is loaded will attempt to autofocus the default input
entry.
This is only done for tabs that are currently visible.
.It Cm browser_mode
The
.Nm
browser has 3 default operating modes:
.Pa normal
(the default),
.Pa whitelist
and
.Pa kiosk .
In the
.Pa normal
mode the browser allows all cookies, plugins and JavaScript as any other
browser would.
This means that all cookies are saved to persistent storage and that all
JavaScript and plugins run.
.Pp
On the other hand, using the
.Pa whitelist
mode enables whitelists.
This requires the user to add all the required
.Pa cookie_wl ,
.Pa js_wl
and
.Pa pl_wl
items.
If a domain does not appear in the whitelists
.Nm
disallows cookies, JavaScript and plugin execution.
If insecure web content or scripts are referenced by a secure website,
they will be blocked from loading or running.
.Pp
In
.Pa kiosk
mode the browse works just like
.Pa normal
mode however the toolbar only has the backward, forward and home button.
.Pp
This setting must be the first entry in
.Pa ~/.xombrero.conf
because it sets advanced settings that can be overridden later in the file.
See the default config file for more details.
.It Cm cmd_alias
This setting is used to define an alias for a command.
The syntax of this setting is
.Pa cmd_alias = alias,cmd .
For example, if you wanted to set an alias for the
.Pa tabnew
command to
.Pa tn ,
add the line
.Pa cmd_alias = tn,tabnew
to your
.Pa ~/.xombrero.conf .
This setting may not begin with a number.
.It Cm cmd_font
Set the command prompt font.
E.g.
.Pa cmd_font = monospace normal 9 .
.It Cm color_visited_uris
When enabled (the default)
.Nm
will color visited links. This is done while the web page loads using
JavaScript, rather than WebKit's (broken, see bug #51747) built-in
facility for coloring visited links. The JavaScript approach is
(probably) slower and is not consistent across tabs (unless the tabs are
reloaded), but has the advantage of not leaking history data to web
pages (see http://wtikay.com/docs/details.html).
.It Cm cookie_policy
This field delineates the cookie policy.
Possible values are: no3rdparty, reject 3rd party cookies.
accept, accept all cookies.
reject, reject all cookies.
.It Cm cookie_wl
This is a cookie whitelist item.
Use multiple times to add multiple entries.
Valid entries are for example *.moo.com and the equivalent .moo.com.
This matches both moo.com, as well as all subdomains.
A fully qualified host is also valid and is for example www.moo.com or
moo.com.
Fully qualified hosts do not modify whitelist settings for any
subdomains.
.Pp
Unix extended regular expressions may also be used to match any set of
FQDNs.
Regular expressions must begin with the prefix "re:".
As an example, the regular expression equivalent to moo.com would be
.Pa ^moo\.com$ ,
and the equivalent to .moo.com would be
.Pa ^(.*\.)*moo\.com$ .
If using regular expressions for whitelist items, be careful to not
accidentally match other domains;
you will almost always want to add the ^ and $ characters to the
beginning and end of the regex so that, for example,
.Pa moo\.com
would not match not-moo.com.
.It Cm cookies_enabled
Enable cookies.
.It Cm ctrl_click_focus
Give focus in newly created tab instead of opening it in the background.
.It Cm custom_uri
This setting provides the ability to run custom executables for
special URIs.
The syntax for this setting is
.Pa custom_uri\ =\ protocol,command .
The URI is passed as a single argument to
.Pa command
to be parsed and executed.
.Pp
For example, to add the ability to use custom
.Pa mailto
URIs, add the setting
.Pa custom_uri = mailto,command
where
.Pa command
is a program that will parse the
.Pa mailto
URI and open your mail client.
.It Cm default_script
Path to the script used as the default value for the run_script
command.
.It Cm default_zoom_level
Set the default browsing zoom level.
.It Cm do_not_track
Sets the HTTP Do Not Track header to tell sites that you wish to be
opted-out of 3rd-party tracking for the use of behavioral advertising.
Not all sites currently support this header, and this is only a
suggestion of a user preference.
Sites may still perform 3rd-party tracking even when this feature is
enabled.
.It Cm download_dir
Locations where files are downloaded to.
This directory must exist and
.Nm
validates that during startup.
.It Cm download_mode
Controls how downloads are handled.
Possible values are:
.Bd -literal -offset indent
start - automatically start download.
ask   - ask user for confirmation.
add   - add to downloadmanager, but
        do not start.
.Ed
The default is "start".
.It Cm download_notifications
When enabled a message is shown when downloads are finished.
Default is 0.
.It Cm enable_autoscroll
When enabled clicking MB3 will spawn the autoscroll ball, scrolling can
then proceed by dragging the mouse away from the ball.
.It Cm enable_cookie_whitelist
When enabled all cookies must be in the whitelist or they are rejected.
Additionally whitelisted cookies also enable HTML5 local storage for the
domain.
.It Cm enable_cache
When enabled (disabled by default), web content will be cached into
memory.
.It Cm enable_favicon_entry
When enabled (the default)
.Nm
displays the favicon of the web page at the URI entry. This setting
affects both
.Cm normal
and
.Cm compact
tabs.
.It Cm enable_favicon_tabs
When enabled (disabled by default)
.Nm
displays favicons at each tab. This setting only affects
.Cm compact
tabs.
.It Cm enable_js_autorun
Enables support for autorunning JavaScript after page loads.  When
enabled,
.Pa ~/.xombrero/js/
will be searched for
.Pa default.js
and
.Pa host.domain.js .
If
.Pa host.domain.js
does not exist,
.Pa domain.js
will be tried instead.  The content of the both default and
host/domain files are read and executed on each page load.
Default is 1.
.Pp
As an example, if you add the line
.Pa alert("Hello, world");
to your
.Pa default.js ,
a pop-up displaying "Hello, world" will be shown on every page reload.
While not useful, any javascript can be run through this mechanism,
making it useful for global or site-specific modifications.
.It Cm enable_js_whitelist
When enabled all domains must be in the js whitelist in order to run Java
Script.
NOTE: Make sure
.Cm enable_scripts
is set to 0.
.It Cm enable_plugin_whitelist
When enabled all domains must be in the plugin whitelist in order to run
plugins.
NOTE: Make sure
.Cm enable_plugins
is set to 0.
.It Cm enable_plugins
Enable external plugins such as Flash and Java.
.It Cm enable_strict_transport
Enable support for the Strict-Transport-Security HTTP-header.
When enabled, sites that set this flag will only be visited via HTTPS.
Default value is 1
.It Cm enable_scripts
Enable Java Script.
.It Cm enable_socket
When enabled the first instance of
.Nm
will create a socket in the
.Pa ~/.xombrero
directory.
Using the \-n url option on subsequent
.Nm
invocations will cause the specified URL to be loaded in a new tab.
Only a user with identical UID and GID can use this option.
.It Cm enable_localstorage
Enable html5 Local Storage.
.It Cm enable_spell_checking
Enables spell checking. Preferred languages can be set using
.Cm spell_check_languages
option.
.It Cm encoding
Set the default encoding.
E.g.
.Pa encoding = ISO-8859-1 .
.It Cm external_editor
Set which editor to use for external editing.
the string <file> will be replaced by the current filename.
E.g.
.Pa external_editor = gvim -f <file>
Note!
.Cm xombrero
relies on the editor
.Pa not forking
into the background.
.It Cm fancy_bar
Enables a backward, forward, and stop button to the toolbar.
Additionally if
.Cm search_string
is set it'll enable an entry box for searches.
.It Cm force_https
This setting is used to define the domains of sites that should be
only accessed over the HTTPS scheme.
Any requests to these domains over HTTP will be rewritten to use HTTPS
instead.
See
.Cm cookie_wl
for semantics.
.It Cm gnutls_priority_string
If set, this string sets the G_TLS_GNUTLS_PRIORITY environmental
variable to define the GnuTLS priority string that is used when
initializing the GnuTLS session.
This may be used to change the supported TLS/SSL versions and the
ciphers that are used when making HTTPS connections.
.Pp
Full details on how to modify this setting may be found in the GnuTLS
documentation, Section 8.9: Priority Strings.
For example, to disable the 128-bit RC4 cipher, change this setting to
.Pa NORMAL:!ARCFOUR-128 .
.Pp
If your glib-networking package is older than version 2.33.10, or if
the G_TLS_GNUTLS_PRIORITY environmental variable is already set, this
setting has no effect.
.It Cm guess_search
When enabled
.Nm
will try to guess if the string you entered, in the URI entry widget or
the command widget, is term you want to search for using search_string
(see above).
If the string does not contain a dot nor a slash, is not a
path to a local file and does not resolves to an IP then it is assumed
to be a search term.
.It Cm gui_mode
To simplify configuring
.Nm
allows you pick between two GUI modes:
.Pa classic
(the default) and
.Pa minimal .
In the
.Pa classic
mode the GUI looks similar to that of most mainstream browsers. While in
.Pa minimal
mode the GUI looks more vi-like. One can get a GUI between the two by
tweaking the low-level GUI settings found under the advanced GUI setting
section in the configuration file.
.It Cm history_autosave
When enabled
.Nm
will save all command and search history.
Upon restarting
.Nm
the saved command and search history will be restored.
.It Cm home
Homepage in URL format.
.It Cm http_proxy
Proxy server in URL format.
.Nm
overrides
.Cm http_proxy
if it is specified as an environment variable.
It must be noted that on older Webkit versions one MUST use an IP address and
not a FQDN.
This works as expected with Webkit 1.4.2.
.Pp
If using libsoup 2.42.2 or newer, one may use a socks proxy directly.
For example:
.Bd -literal -offset indent
http_proxy = socks5://127.0.0.1:9050
.Ed
Otherwise, an intermediary tool, such as polipo or tsocks, must be used.
.It Cm http_accept
If set, the HTTP Accept header will be modified for each text/html request.
If this setting is set multiple times, the Accept header will be changed
in a round-robin order for every text/html request on a tab.
Because this setting rotates through Accept headers on each text/html
request, a single page may rotate through more than one Accept header
if multiple text/html requests are made.
.Pp
Please be aware that not all websites report browser headers correctly.
Most notably, EFF's panopticlick service also reports the HTTP
Accept-Encoding headers on the same line as the Accept headers.
If you are trying to find the headers of another browser to model that
browser's fingerprint, it is recommended to not use panopticlick for
this reason.
.Pp
Note that this setting only rewrites the Accept header for text/html
requests.  Other requests will use WebKit's default  Accept header.
.It Cm http_proxy_starts_enabled
If set to 0, the http_proxy will be disabled at startup. The user can later
enable the proxy with the
.Cm proxy toggle
command or keybinding.
.It Cm icon_size
Permits icon sizes to be changed if
.Cm fancy_bar
is enabled.
Size 1 is small; 2 is normal; 3 through 6 are progressively larger.
.It Cm include_config
This must be a path to another configuration file.
Configuration files are usually read from top to bottom, however, if
this option is set,
.Nm
will begin reading the included file at this location and continue
reading the rest of the configuration after the included file has
finished being read.
.Pp
Any simple settings set before the include may
be overridden by settings in the included file, and any simple
settings set in the included file may be overridden later by settings
after the include or at runtime using the
.Cm :set
command.
However, database settings (for example,
.Cm cookie_wl , js_wl , pl_wl ,
and
.Cm keybinding )
are only ever added to the database, and so the order of an included
configuration file is not pertinent to these database settings.
.Pp
This feature is likely best used as the last item in
.Pa ~/.xombrero.conf .
.It Cm js_auto_open_windows
If enabled, javascripts will be allowed to automatically open windows
based on the current
.Cm browser_mode .
If disabled, it will never be allowed.  The default setting is 1 (enabled).
.It Cm js_wl
This is a JavaScript whitelist item.
See
.Cm cookie_wl
for semantics and more details.
.It Cm max_connections
The maximum number of connections that
.Nm
can open at once.
.It Cm max_host_connections
The maximum number of connections that
.Nm
can open at once to a given host.
.It Cm mime_type
Sets an action for a specific or default MIME type.
For example, to download and view a pdf using kpdf set
.Pa mime_type = application/pdf,kpdf .
To set a default value use *, for example,
.Pa mime_type = video/*,mplayer .
Note that the action is only passed the URL and not all applications are
capable of dealing with a URL and therefore one might have to create a wrapper
script to download the content first.  Alternatively one can add the
.Pa @
in front of the MIME type to indicate "download first".
For example,
.Pa mime_type = @application/pdf,xpdf .
When
.Pa @
is use the file will be downloaded to the
.Pa download_dir
before the MIME handler is called.
.Pp
The special binary name "donothing" may be used to ignore a MIME type
without displaying any warnings from being unable to execute the
binary.
.It Cm oops_font
Set the font used to display error messages.
E.g.
.Pa oops_font = monospace normal 9 .
.It Cm pl_wl
This is a plugin whitelist item.
See
.Cm cookie_wl
for semantics and more details.
.It Cm preload_strict_transport
If enabled, a preloaded list of sites which set the HTTP Strict
Transport Security header will be used to automatically set the
.Cm force_https
setting for these sites.
This is used to prevent SSL stripping attacks when first visiting
these sites, before they have been added to the strict-transport file.
This list is comprised of domains chosen by the
.Nm
authors, as well as domains included in Chromium's preloaded HSTS
list.
Default is 1.
.It Cm read_only_cookies
Mark cookies file read-only and discard all cookies once the session is
terminated.
.It Cm refresh_interval
Refresh interval while in the download manager.
The default is 10.
.It Cm referer
Control how
.Dq referer
is handled in http-requests.
.Bd -literal -offset indent
always      - always send referer
never       - never send referer
same-domain - only send referer if it's
              for the same public suffix - this means that
              it's OK for subdomains to refer to each other
same-fqdn   - only send referer if it's FQDN match
.Ed
Any other value that is also a valid URL will use this
custom value as referer. (E.g. you could set it to http://no-referer.com)
The default value is
.Dq always .
.It Cm resource_dir
Directory that contains various
.Nm
resources such as icons.
This is OS-specific and should be handled by the porter.
.It Cm save_global_history
If set the global history will be saved to
.Pa ~/.xombrero/history
when quitting
and restored at startup.
See the
.Sx KEY BINDINGS
section above for how the global history is accessed.
Global history is not saved to disk by default.
.It Cm save_rejected_cookies
Saves rejected cookies in cookie format in {work_dir}/rejected.txt.
All cookies are saved and unlike a cookie jar they are never replaced.
Make sure there is enough disk space to enable this feature.
.It Cm search_string
Default search engine string.
See the
.Pa xombrero.conf
file for details.
.It Cm session_autosave
Enable session auto-saving when changing state (e.g. adding or removing a tab).
The session name is what is currently in use and is described in the
.Cm session save
and
.Cm session open
commands.
.It Cm session_timeout
This value is the time that is added in seconds to a session cookie.
.It Cm show_tabs
Enable or disable showing tabs.
.It Cm show_url
Enable or disable showing the url and toolbar.
.It Cm show_scrollbars
Enable or disable the showing of the horizontal and vertical scrollbars.
Disabling this setting requires GTK3.
.It Cm show_statusbar
Enable or disable showing the status bar.
.It Cm single_instance
If set and
.Cm enable_socket
is enabled only one
.Nm
will be permitted to run.
If there is a URL specified it will be opened in a new tab in the already
running
.Nm
session.
.It Cm spell_check_languages
The languages to be used for spell checking, separated by commas. For example,
en_US.
.It Cm ssl_ca_file
If set to a valid PEM file
all server certificates will be validated against it.
The URL bar will be colored green (or blue when saved) when the certificate is
trusted and yellow when untrusted.
.Pp
If
.Cm ssl_ca_file
is not set, the URL bar will be colored red if the certificate has not
been saved, or blue if it has been saved.
.Pp
WebKit only supports a single PEM file.
Many OS' or distributions have many PEM files.
One can simply concatenate all separate files into one large one.
E.g.
.Cm for i in `ls`; do cat $i >> cert.pem; done
and use the resulting cert.pem file as the input to
.Cm ssl_ca_file .
It is advisable to periodically recreate the cert.pem file.
.It Cm ssl_strict_certs
If this value is set connections to untrusted sites will be aborted.
This value is only used if
.Cm ssl_ca_file
is set.
.It Cm statusbar_elems
Define the components of the status bar. The possible components are:
.Bd -literal -offset indent
| - separator
P - page progress percent
p - proxy enabled/disabled
B - buffer command
Z - page zoom level
T - current tab number
.Ed
The default is "BP".
These components show nothing if there is nothing worth showing, like
zoom amount 100%.
.It Cm statusbar_font
Set the status bar font.
E.g.
.Pa statusbar_font = monospace normal 9 .
.It Cm statusbar_style
Set the status bar style to either
.Cm url
- display the current url, or
.Cm title
- display the page title. The default is
.Cm url .
.It Cm tab_style
Set the tab style to either
.Cm normal
- the default gtk notebook tabs, or
.Cm compact
for an alternative.
You can switch the tab style with the
.Pa tabnextstyle
command.
.It Cm tabbar_font
Set the compact tab bar font.
E.g.
.Pa tabbar_font = monospace normal 9 .
.It Cm tabless
Disable tabs, and open new windows instead.
Note that this feature does not disable the display of tabs.
Change your
.Cm show_tabs
setting also if you wish to disable the display of tabs.
Default is 0.
.It Cm url_regex
This is the regular expression that is used to match what constitutes a valid
URL when using
.Pa guess_search .
.It Cm user_agent
Set to override the default
.Nm
user-agent string. May be specified several times for switching between
user-agents.
.It Cm userstyle
Set the stylesheet to be used as a default for the
.Cm userstyle
and
.Cm userstyle_global
commands when no extra parameters are given.
The default is a low-contrast stylesheet.
.It Cm userstyle_global
When enabled new tabs will automatically be displayed using the custom
stylesheet specified by the
.Cm userstyle
setting.
.It Cm warn_cert_changes
When enabled all SSL certificates from HTTPS websites will be
cached in the
.Cm ~/.xombrero/certs_cache/
directory.
On each page load, if the remote certificate differs from the cached
local version, a warning page with options of what to do next will be displayed
instead of the requested page.
This feature may be used in addition to the coloring of the URL bar and
can be used to help prevent against man-in-the-middle attacks, even if
the new remote certificate is signed by a trusted certificate
authority in
.Cm ssl_ca_file .
Default is 0.
.It Cm window_height
Set the default height of the browser window.
.It Cm window_width
Set the default width of the browser window.
.It Cm window_maximize
Maximize the browser window at startup.
.It Cm work_dir
Set the work directory where all
.Nm
scratch files are stored.
Default is
.Cm ~/.xombrero .
.El
.Sh HISTORY
.Nm
was inspired by vimprobable2 and the bloat in other
.Ux
web browsers.
.Sh AUTHORS
.An -nosplit
.Nm
was written by
.An Marco Peereboom Aq marco@peereboom.us ,
.An Stevan Andjelkovic Aq stevan@student.chalmers.se ,
.An Edd Barrett Aq vext01@gmail.com ,
.An Todd T. Fries Aq todd@fries.net ,
.An Raphael Graf Aq r@undefined.ch ,
.An Michal Mazurek Aq akfaew@jasminek.net ,
and
.An Josh Rickmar Aq jrick@devio.us .