Toile — Lightweight Web Browser for SliTaz GNU/Linux
=====================================================

Toile replaces TazWeb starting with SliTaz 6.0. It is built on GTK 3
and WebKitGTK 4.1, written in C99, and follows the suckless philosophy:
minimal, single binary, compile-time configuration.

"Toile" is French for "web" / "canvas".


BUILD DEPENDENCIES
------------------

  libgtk-3-dev
  libwebkit2gtk-4.1-dev

On Debian/Ubuntu/SliTaz:

  sudo apt-get install libgtk-3-dev libwebkit2gtk-4.1-dev

On SliTaz (tazpkg):

  tazpkg get-install gtk3-dev
  tazpkg get-install webkit2gtk-dev


BUILD
-----

  make          # builds ./toile
  make run      # builds and launches with default home URL
  make install  # installs to /usr/local/bin/toile
  make clean    # removes build artifacts

Change install prefix:

  make install PREFIX=/usr

Experimental Soie engine instead of WebKitGTK (soie-gtk from pkg-config,
or the Soie tree built with make in ../soie, see SOIE in config.mk; no
text selection or Web Workers yet):

  make clean && make ENGINE=soie


CONFIGURATION
-------------

Copy config.def.h to config.h and edit before building to change
compile-time defaults (home URL, window size):

  cp config.def.h config.h
  $EDITOR config.h
  make

Runtime configuration is read from ~/.config/toile/toilerc.
Create the file if it does not exist. Example:

  # ~/.config/toile/toilerc
  home_url = https://duckduckgo.com
  win_width = 1280
  win_height = 800

Lines starting with # are ignored.


KEYBOARD SHORTCUTS
------------------

  Ctrl+T            New tab
  Ctrl+W            Close current tab
  Ctrl+Tab          Next tab
  Ctrl+Shift+Tab    Previous tab
  Ctrl+L            Focus URL bar
  Ctrl+R / F5       Reload
  Ctrl+Left         Back
  Ctrl+Right        Forward
  Ctrl+D            Bookmark current page
  Ctrl+B            Show bookmarks
  Ctrl+H            Show history
  Ctrl+J            Toggle downloads panel
  Ctrl+F            Find in page
  Ctrl+G            Find next
  Ctrl+Shift+G      Find previous
  Escape            Close find bar
  Ctrl+=            Zoom in
  Ctrl+-            Zoom out
  Ctrl+0            Reset zoom
  Ctrl+Shift+D      Toggle dark/light theme


USAGE
-----

  toile                    # opens home URL
  toile https://slitaz.org # opens given URL


LICENSE
-------

GPL-3.0-or-later — see LICENSE file.
