README.img (7004B)
1 2 Inline image support of w3m 3 2002/02/04 4 H. Sakamoto 5 2002/10/16 6 H. Ito 7 8 Introduction 9 10 This is the extension for w3m to support inline image. 11 12 Support 13 14 * Display inline image (GIF,PNG,JPEG, etc.) on terminals 15 (xterm,rxvt, etc.) of X11, Linux framebuffer device or 16 terminals of Windows. 17 * Support inline image of <img> tag. 18 Support of attributes "width", "height", and "align". 19 * Direct display of image file which header is "Content-type: image/*" 20 * Support of <map> tag. 21 Support of attributes "shape" and "coords" of <area> tag. 22 * Support of an attribute "ismap" of <img> tag. 23 "w3m" adds coordinate of the cursor as ?<x>,<y> to url, and sends url. 24 * Support of an attribute "type=image" of <input> tag. 25 "w3m" sends coordinate of the cursor as <name>.x=<x>&<name>.y=<y>. 26 * Asynchronous loading of image files. 27 * Using cache of image file as pixmap. 28 * Support of GIF animation when use GdkPixbuf. 29 30 31 Key functions 32 33 DISPLAY_IMAGE 34 Restart loading and drawing of images. 35 STOP_IMAGE 36 Stop loading and drawing of images in the current buffer. 37 SET_OPTION display_image=toggle 38 Toggle loading and drawing of images. 39 40 These functions are not keybinded as default. 41 Specify the following keymaps in ~/.w3m/keymap. 42 keymap X DISPLAY_IMAGE 43 keymap C-c STOP_IMAGE 44 keyamp t SET_OPTION display_image=toggle 45 46 Commandline options 47 48 -ppc <pixel> 49 # of pixels per character. The default value is automatically 50 detected. Must fit the width of font of terminal. 51 -ppl <pixel> 52 # of pixels per character. The default value is automatically 53 detected. Must fit the height of font of terminal. 54 55 Option panel 56 57 pixel_per_char 58 # of pixels per character. The default value is automatically 59 detected. Must fit the width of font of terminal. 60 pixel_per_line 61 # of pixels per character. The default value is automatically 62 detected. Must fit the height of font of terminal. 63 display_image 64 Display of inline image. The default is ON. 65 auto_image 66 Automatic loading of inline image. The default is ON. 67 If it is OFF, loading starts with a command DISPLAY_IMAGE. 68 max_load_image 69 Maximum process for downloading of inline image. The default is 4. 70 1 to 8 can be set. 71 ext_image_viewer 72 Use external image viewer, when a command VIEW_IMAGE or 73 view of image file which header is "Content-type: image/*". 74 The default is ON. If it is OFF, the image is directly displayed. 75 image_scale 76 Scale of image (%). The default value is 100(%). 77 imgdisplay 78 External command to display image". The default value is "w3mimgdisplay". 79 See "Setting w3mimgdisplay". 80 81 Required programs 82 83 for X11 84 * GdkPixbuf-0.16 or later 85 86 or 87 88 * w3m-0.2.5+cvs-1.287 or later 89 http://w3m.sourceforge.net/ 90 http://sourceforge.net/projects/w3m/ 91 http://prdownloads.sourceforge.net/w3m/ 92 * Imlib-1.9.8 (1.9.10 is recommendable.) 93 libungif-4.1.0b1 is recommendable. 94 95 for Linux framebuffer device 96 * GdkPixbuf-0.16 or later 97 98 or 99 100 * Imlib2-1.0.6 or later 101 102 * Framebuffer device(packed pixels with 8 bpp pseudocolor 103 and 16/24/32 bpp truecolor/directcolor) 104 105 106 Setting w3mimgdisplay 107 108 "w3mimgdisplay" has the following options. Set options to fit terminal. 109 110 -x <offset_x> 111 The X origin of display of image on terminal. The default value 112 for X11 is 2. 113 If the terminal is "xterm", the width of scroll bar is added. 114 If the terminal is "Eterm", it may be better to specify 5. 115 The default value for Linux framebuffer device is 0. 116 -y <offset_y> 117 The Y origin of display of image on terminal. The default value 118 for X11 is 2. 119 If the terminal is "Eterm", it may be better to specify 5. 120 The default value for Linux framebuffer device is 0. 121 -bg <background> 122 Background color of terminal. The default value for X11 is 123 automatically detected. 124 The default value for Linux framebuffer device is #000000 (black). 125 When the color is specified as #RRGGBB, escape '#'. 126 -anim <n> 127 Maximum number of frames for animation. It means without limit 128 if the number is 0. Negative value count backward from the end 129 of the frames. The default value is 100. 130 -margin <n> 131 Margin of an area to clear an image. The default value is 0. 132 133 ex.) 134 w3m -o 'imgdisplay=w3mimgdisplay -x 5 -bg "#cccccc"' 135 136 Notice 137 If you want to see GIF animation, please hit a suitable key, such 138 as 'h', 'l', etc., repeatedly, because a frame is rewritten 139 according to the re-drawing demand from w3m. 140 141 Some code in w3mimg/fb/fb.c was originally written by Mr. Yamasaki. 142 http://www.sainet.or.jp/~yamasaki/download/fb-sample.tar.gz 143 144 On Windows, we check the behaver on standard console, Cygwin rxvt 145 and PuTTY. 146 147 148 Change log 149 150 2002/02/04 151 * Revised this document. 152 153 2002/02/01 w3m-0.2.5+cvs-1.287 154 * Merged in the CVS repository of the original w3m. 155 156 2002/01/31 w3m-0.2.4-img-2.2 157 * Based on w3m-0.2.4+cvs-1.278. 158 159 2002/01/29 w3m-0.2.4-img-2.1 160 * Based on w3m-0.2.4+cvs-1.268. 161 162 2002/01/28 w3m-0.2.4-img-2.0 163 * Based on w3m-0.2.4+cvs-1.265. 164 * pixel_per_char and pixel_per_line are automatically detected. 165 * The background color of terminal is automatically detected. 166 * The source code to display images is moved to image.c 167 168 2002/01/08 w3m-0.2.4-img-1.18 169 * Based on w3m-0.2.4 170 171 2001/12/29 w3m-0.2.3.2-img-1.17 172 * Based on w3m-0.2.3.2+cvs-1.196. 173 174 2001/12/25 w3m-0.2.3.2-img-1.16.1 175 * [w3m-dev 02698] Thanks > Kazuhiko-san 176 177 2001/12/22 w3m-0.2.3.2-img-1.16 178 * Based on w3m-0.2.3.2. 179 180 2001/12/20 w3m-0.2.3.1-img-1.15 181 * Based on w3m-0.2.3.1. 182 * Support display of image with Content-Transfer-Encoding. 183 184 2001/11/29 185 * Start merge against CVS source (ChangeLog 1.71) 186 187 2001/11/17 w3m-0.2.2-img-1.14 188 * Based on w3m-0.2.2. 189 190 2001/11/14 w3m-0.2.1-inu-1.6-img-1.13 191 * Based on w3m-0.2.1-inu-1.6. 192 193 2001/11/05 w3m-0.2.1-inu-1.5-img-1.12 194 * Based on w3m-0.2.1-inu-1.5. 195 * Fixed the bug for <area>, <map>. 196 * Fixed the problem with xwnmo on kterm. 197 198 2001/10/03 w3m-0.2.1-inu-1.4-img-1.11 199 * Based on w3m-0.2.1-inu-1.4. 200 * Fixed bug when reading from stdin. 201 * Fixed "configure". Thanks > Fukagawa-san. 202 203 2001/08/01 w3m-0.2.1-img-1.10 204 * Adjust image position. 205 * Fixed scaling image. 206 207 2001/07/31 w3m-0.2.1-img-1.9 208 * Fixed initImgdisplay(). Thanks > David. 209 210 2001/07/29 w3m-0.2.1-img-1.8 211 * Fixed "configure". 212 213 2001/07/28 w3m-0.2.1-img-1.7 214 * Sorry, w3m-0.2.1-img-1.6 is not complete. 215 * Added "configure" and "Makefile" to the patch. 216 217 2001/07/27 w3m-0.2.1-img-1.6 218 * Created doc/README.img. 219 220 ------------------------------------------- 221 Hironori Sakamoto <hsaka@mth.biglobe.ne.jp> 222 http://www2u.biglobe.ne.jp/~hsaka/