aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAraki Ken <arakiken@users.sf.net>2014-11-15 19:07:05 +0000
committerTatsuya Kinoshita <tats@debian.org>2014-12-06 11:47:05 +0000
commit2e8def7ab6eb7ca9bb5160071a041cc25c919928 (patch)
tree111159e37d76413735cec946208c685e7b3de6ad /doc
parent* Add n_terminal_image argument to put_image_{sixel|osc5379}(). * Use struct ... (diff)
downloadw3m-2e8def7ab6eb7ca9bb5160071a041cc25c919928.tar.gz
w3m-2e8def7ab6eb7ca9bb5160071a041cc25c919928.zip
Add README.sixel. W3M_IMG2SIXEL environmental variable enables to specify options of img2sixel.
Diffstat (limited to '')
-rw-r--r--doc/README.sixel27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/README.sixel b/doc/README.sixel
new file mode 100644
index 0000000..588afc4
--- /dev/null
+++ b/doc/README.sixel
@@ -0,0 +1,27 @@
+Sixel support of w3m
+ 2014/11/05
+ K. Araki
+
+Introduction
+
+ This is the extension for w3m to show inline images by sixel graphics.
+
+Requirements
+
+ Install 'img2sixel' command provided by libsixel project.
+ (https://github.com/saitoha/libsixel)
+
+Build
+
+ $ ./configure --enable-image ...
+ $ make
+ $ make install
+
+Usage
+
+ $ w3m -sixel http://...
+
+ You can specify options of 'img2sixel' command by "W3M_IMG2SIXEL"
+ environmental variable.
+
+ $ W3M_IMG2SIXEL="img2sixel -d atkinson" w3m -sixel http://...