path: root/README

surf - simple webkit-based browser
==================================
surf is a simple Web browser based on WebKit/GTK+.

surf runs as a native Wayland client, it does not build or run on X11.

Requirements
------------
In order to build surf you need GTK+ and Webkit/GTK+ header files.

In order to use the functionality of the url-bar, also install dmenu[0].

Installation
------------
Edit config.mk to match your local setup (surf is installed into
the /usr/local namespace by default).

Afterwards enter the following command to build and install surf (if
necessary as root):

    make clean install

Running surf
------------
run
	surf [URI]

See the manpage for further options.

Controlling a running surf
--------------------------
Every surf window creates a control fifo in $XDG_RUNTIME_DIR/surf. Writing a
line to it makes that window load a URI or search the page:

	printf 'uri %s\n' https://suckless.org >"$XDG_RUNTIME_DIR"/surf/*

See the CONTROL FIFO section of the manpage. The included script

	surf-open.sh [URI]

uses this to hand the URI to an already running surf, and only starts a new
one if there is none.

[0] http://tools.suckless.org/dmenu