Intial commit
[profile/ivi/w3m.git] / doc / README
1         w3m: WWW wo Miru Tool  version 0.5.2    May 31, 2007
2                 (C) Copyright Akinori ITO
3                               Hironori SAKAMOTO
4                               Fumitoshi UKAI
5
6 1. Introduction
7
8      w3m is a pager with WWW capability. It IS a pager, but it can be
9 used as a text-mode WWW browser.
10
11      The features of w3m are as follows:
12
13 * When reading HTML document, you can follow links and view images
14   (using external image viewer).
15 * It has 'internet message mode', which determines the type of document
16   from header. If the Content-Type: field of the document is text/html,
17   that document is displayed as HTML document.
18 * You can change URL description like 'http://hogege.net' in plain text
19   into link to that URL.
20
21 Current problems are:
22
23 * Online manuals are poor.
24
25 w3m is known to work on these platforms.
26
27       SunOS 4.1.x
28       HP-UX 9.x, 10.x
29       Solaris 2.5.x, 2.6, 8, 9
30       Linux 2.0.*/2.2.*/2.4.*/2.6.*
31       FreeBSD 2.2.8, 3.1, 3.2, 4.6
32       NetBSD/macppc, m68k
33       EWS4800 Rel.12.2 Rev.A
34       Digital UNIX: v3.2D, v4.0D
35       IRIX 5.3, IRIX 6.5
36       OS/2 with emx
37       Windows 9x/NT with Cygwin b20.1, 1.1.x, 1.3.x
38       MS-DOS with DJGPP and WATT32 packet driver
39       MacOS X Server
40       MacOS X 10.1, 10.2, 10.3, 10.4
41
42 2. Installation
43
44 Follow these instructions to install w3m.  
45
46  - You need latest version of GC library (at least 6.1?).
47    You can get GC library from 
48    http://www.hpl.hp.com/personal/Hans_Boehm/gc/gc_source/
49
50    Note: if you're using GC library 6.1, you should install gc.h 
51    to PREFIX/include:
52         # cp gc-6.1/include/gc.h PREFIX/include
53
54  - Run configure.
55    % ./configure
56
57  - do make
58    % make
59
60  - do make install
61    # make install
62
63 MACHINE/OS specific notices:
64
65 HP-UX
66         If you want to use HP C compiler, answer
67
68                 Input your favorite C-compiler.
69                 (Default: cc) cc -Aa -D_HPUX_SOURCE
70
71         If you use just 'cc' without options, you can't compile w3m.
72         If you are using gcc, no option is needed. 
73
74 OS/2
75         You can compile w3m using emx. First you have to do
76         is to compile GC library with
77
78                 cd gc
79                 make -f EMX_MAKEFILE
80
81         then compile w3m. I heard that OS/2 console can't 
82         display color, you had better compile w3m without
83         color capability.
84
85 Windows
86         To compile w3m on MS-Windows, you have to use Cygwin with
87         development tools.
88         Read README.cygwin for more details.
89
90 3. Copyright
91
92   (C) Copyright 1994-2002 by Akinori Ito
93   (C) Copyright 2002-2007 by Akinori Ito, Hironori Sakamoto, Fumitoshi Ukai
94
95 4. License
96
97   Use, modification and redistribution of this software is hereby granted, 
98   provided that this entire copyright notice is included on any copies of 
99   this software and applications and derivations thereof.
100
101   This software is provided on an "as is" basis, without warranty of any
102   kind, either expressed or implied, as to any matter including, but not
103   limited to warranty of fitness of purpose, or merchantability, or
104   results obtained from use of this software.
105
106 5. Author
107
108 Initial author:
109         Akinori Ito
110         Faculty of Engineering, Tohoku University
111         aito@fw.ipsj.or.jp
112
113 Current Maintainer
114         Dai Sato
115         Tohoku University Hospital
116         satodai@w3m.jp
117
118 Feel free to send your opinion to the w3m mailing-lists.
119         w3m-dev@sic.med.tohoku.ac.jp (Japanese)
120         w3m-dev-en@sic.med.tohoku.ac.jp (English)
121         http://w3m.sourceforge.net/