aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: 77ff1eda7b9cb273d697847f00a67bc1491e6c71 (plain) (blame)
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
#+title: luwak: a text-only Emacs web browser based on lynx -dump

* Install and use

Luwak mode is a simple Emacs GET-only and text-only web browser, based
on ~lynx -dump~.

To use, clone this repo, add to ~load-path~ and ~require~.  Make sure
you have lynx installed in your system (~apt install lynx~, ~pacman -S
lynx~ etc.).  By default the browser uses torsocks, which can be
disabled with a prefix arg.

#+begin_src elisp
(add-to-list 'load-path "~/.emacs.d/luwak")
(require 'luwak)
#+end_src

There are two entry points:

- ~luwak-open~: open a url
- ~luwak-search~: search a query (default to ddg html)

* Naming

lynx dump -> feline excretion -> Kopi Luwak

* Contact and Copyright

luwak is maintained by Yuchen Pei (id@ypei.org).  It is covered by [[https://www.gnu.org/licenses/agpl-3.0.en.html][GNU
AGPLv3+]].  You may find the license text in a file named COPYING.agpl3
in the project tree.