~ubuntu-branches/ubuntu/lucid/w3m/lucid-proposed

« back to all changes in this revision

Viewing changes to doc/README.img

  • Committer: Bazaar Package Importer
  • Author(s): Fumitoshi UKAI
  • Date: 2004-04-29 03:28:41 UTC
  • Revision ID: james.westby@ubuntu.com-20040429032841-uo4mu7a813aqrua8
Tags: upstream-0.5.1
ImportĀ upstreamĀ versionĀ 0.5.1

Show diffs side-by-side

added added

removed removed

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