README.md
1# Vimb - the Vim-like browser
2
3[](https://travis-ci.com/fanglingsu/vimb)
4[](https://www.gnu.org/licenses/gpl-3.0)
5[](https://github.com/fanglingsu/vimb/releases/latest)
6
7Vimb is a Vim-like web browser that is inspired by Pentadactyl and Vimprobable.
8The goal of Vimb is to build a completely keyboard-driven, efficient and
9pleasurable browsing-experience with low memory and CPU usage that is
10intuitive to use for Vim users.
11
12More information and some screenshots of Vimb browser in action can be found on
13the project page of [Vimb][].
14
15## Features
16
17- it's modal like Vim
18- Vim like keybindings - assignable for each browser mode
19- nearly every configuration can be changed at runtime with Vim like set syntax
20- history for `ex` commands, search queries, URLs
21- completions for: commands, URLs, bookmarked URLs, variable names of settings, search-queries
22- hinting - marks links, form fields and other clickable elements to
23 be clicked, opened or inspected
24- SSL validation against ca-certificate file
25- user defined URL-shortcuts with placeholders
26- read it later queue to collect URIs for later use
27- multiple yank/paste registers
28- Vim like autocmd - execute commands automatically after an event on specific URIs
29
30## Packages
31
32- Arch Linux: [aur/vimb][], [aur/vimb-git][]
33- Gentoo: [gentoo-git][], [gentoo][]
34- openSUSE: [network/vimb][]
35- pkgsrc: [pkgsrc/www/vimb][], [pkgsrc/wip/vimb-git][]
36- Slackware: [slackbuild/vimb][]
37
38## dependencies
39
40- gtk+-3.0
41- webkit2gtk-4.0 >= 2.20.x
42
43## Install
44
45Edit `config.mk` to match your local setup.
46
47Edit `src/config.h` to match your personal preferences.
48
49The default `Makefile` will not overwrite your customised `config.h` with the
50contents of `config.def.h`, even if it was updated in the latest git pull.
51Therefore, you should always compare your customised `config.h` with
52`config.def.h` and make sure you include any changes to the latter in your
53`config.h`.
54
55Run the following commands to compile and install Vimb (if necessary, the last one as
56root). If you want to change the `PREFIX`, note that it's required to give it on both stages, build and install.
57
58 make PREFIX=/usr
59 make PREFIX=/usr install
60
61To run vimb without installation for testing it out use the 'runsandbox' make
62target.
63
64 make runsandbox
65
66## Mailing list
67
68- feature requests, issues and patches can be discussed on the [mailing list][mail] ([list archive][mail-archive])
69
70## Similar projects
71
72- [luakit](https://luakit.github.io/)
73- [qutebrowser](https://www.qutebrowser.org/)
74- [surf](https://surf.suckless.org/)
75- [uzbl](https://www.uzbl.org/)
76
77## license
78
79Information about the license are found in the file LICENSE.
80
81## about
82
83- https://en.wikipedia.org/wiki/Vimb
84- http://thedarnedestthing.com/vimb
85- https://blog.jeaye.com/2015/08/23/vimb/
86
87[aur/vimb-git]: https://aur.archlinux.org/packages/vimb-git
88[aur/vimb]: https://aur.archlinux.org/packages/vimb
89[gentoo-git]: https://github.com/tharvik/overlay/tree/master/www-client/vimb
90[gentoo]: https://github.com/hsoft/portage-overlay/tree/master/www-client/vimb
91[mail-archive]: https://sourceforge.net/p/vimb/vimb/vimb-users/ "vimb - mailing list archive"
92[mail]: https://lists.sourceforge.net/lists/listinfo/vimb-users "vimb - mailing list"
93[network/vimb]: https://build.opensuse.org/package/show/network/vimb
94[pkgsrc/wip/vimb-git]: http://pkgsrc.se/wip/vimb-git
95[pkgsrc/www/vimb]: http://pkgsrc.se/www/vimb
96[slackbuild/vimb]: https://slackbuilds.org/repository/14.2/network/vimb/
97[vimb]: https://fanglingsu.github.io/vimb/ "Vimb - Vim like browser project page"
98
){kind=link}
){kind=link}
){kind=link}