Initial revision

4 files changed, 248 insertions, 0 deletions

diff --git a/doc/README b/doc/README
new file mode 100644
index 0000000..72246d1
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,106 @@
+	w3m: WWW wo Miru Tool  version beta-990323
+		(C) Copyright by Akinori ITO	March 23, 1999
+
+1. Introduction
+
+     w3m is a pager with WWW capability. It IS a pager, but it can be
+used as a text-mode WWW browser.
+
+     The features of w3m are as follows:
+
+* When reading HTML document, you can follow links and view images
+  (using external image viewer).
+* It has 'internet message mode', which determines the type of document
+  from header. If the Content-Type: field of the document is text/html,
+  that document is displayed as HTML document.
+* You can change URL description like 'http://hogege.net' in plain text
+  into link to that URL.
+
+Current problems are:
+
+* Resize behaviour is imcomplete.
+* It can't show images inline. (It seems to be impossible as far as using
+  xterm)
+* It doesn't decode MIME-body of the document.
+* Online manuals are poor.
+
+w3m is known to work on these platforms.
+
+      SunOS4.1.x
+      HP-UX 9.x, 10.x
+      Solaris2.5.x
+      Linux 2.0.30
+      FreeBSD 2.2.8, 3.1, 3.2
+      NetBSD/macppc, m68k
+      EWS4800 Rel.12.2 Rev.A
+      Digital UNIX: v3.2D, v4.0D
+      IRIX 5.3, IRIX 6.5
+      OS/2 with emx
+      Windows 9x/NT with Cygwin32 b20.1
+      MS-DOS with DJGPP and WATT32 packet driver
+      MacOS X Server
+
+2. Installation
+
+Follow these instructions to install w3m.
+
+2.1 Run configure. The script will ask you a few questions. Answer them.
+2.2 do make
+2.3 do make install
+
+MACHINE/OS specific notices:
+
+HP-UX
+	If you want to use HP C compiler, answer
+
+		Input your favorite C-compiler.
+		(Default: cc) cc -Aa -D_HPUX_SOURCE
+
+	If you use just 'cc' without options, you can't compile w3m.
+	If you are using gcc, no option is needed. 
+
+OS/2
+	You can compile w3m using emx. First you have to do
+	is to compile GC library with
+
+		cd gc
+		make -f EMX_MAKEFILE
+
+	then compile w3m. I heard that OS/2 console can't 
+	display color, you had better compile w3m without
+	color capability.
+
+Windows
+	See README.cygwin.
+
+MS-DOS
+	See README.dj.
+
+
+3. Copyright
+
+  (C) Copyright 1994-1999 by Akinori Ito.
+
+  Hans J. Boehm, Alan J. Demers, Xerox Corp. and Silicon Graphics
+  have the copyright of the GC library comes with w3m package.
+
+4. License
+
+  Use, modification and redistribution of this software is hereby granted, 
+  provided that this entire copyright notice is included on any copies of 
+  this software and applications and derivations thereof.
+
+  This software is provided on an "as is" basis, without warranty of any
+  kind, either expressed or implied, as to any matter including, but not
+  limited to warranty of fitness of purpose, or merchantability, or
+  results obtained from use of this software.
+
+
+5. Author
+
+Feel free to send your opinion to the author.
+
+	Akinori Ito
+	Faculty of Engineering, Yamagata University
+	aito@ei5sun.yz.yamagata-u.ac.jp
+	http://ei5nazha.yz.yamagata-u.ac.jp/
diff --git a/doc/README.cygwin b/doc/README.cygwin
new file mode 100644
index 0000000..b00545c
--- /dev/null
+++ b/doc/README.cygwin
@@ -0,0 +1,18 @@
+***How to compile w3m on Windows***
+
+To compile w3m on MS-Windows, you have to use Cygwin32 with development
+tools. You can get it from http://sourceware.cygnus.com/cygwin/ .
+
+After installing Cygwin32, what you have to do first is
+
+  TERM=ansi; export TERM
+  sh configure
+
+and
+
+  make
+
+
+Known Bugs:
+
+Local file with drive letter (//C/zonk.html) can't be handled correctly.
diff --git a/doc/README.dict b/doc/README.dict
new file mode 100644
index 0000000..63fd4a2
--- /dev/null
+++ b/doc/README.dict
@@ -0,0 +1,39 @@
+Dictionary look-up hack for w3m
+
+1. INTRODUCTION
+
+If you have dictionary look-up command (like 'webster'), you can
+look a word in a document using w3m. This dictionary-lookup code
+was contributed by `Rubikitch' (rubikitch@ruby-lang.org).
+
+2. INSTALL
+
+To make use of dictionary look-up, you have to change compile 
+option by hand. After running configure, edit config.h and
+change
+
+#undef DICT
+
+into
+
+#define DICT
+
+and recompile w3m. (You have to recompile dict.c and keybind.c.)
+
+Then prepare a command named 'w3mdict.' For example, if you want
+to use 'webster' command, do the following:
+
+% cd /usr/local/bin
+% ln -s `which webster` w3mdict
+
+In general, w3mdict can be any command that takes a word as an
+argument and outputs something onto stdout.
+
+3. USAGE
+
+You can use the following two commands.
+
+ESC w    Input a word and look it up using w3mdict command.
+
+ESC W    look up the current word in the buffer.
+
diff --git a/doc/README.func b/doc/README.func
new file mode 100644
index 0000000..7b2bc6b
--- /dev/null
+++ b/doc/README.func
@@ -0,0 +1,85 @@
+ABORT		Quit w3m without confirmation
+ADD_BOOKMARK	Add current page to bookmark
+BACK		Back to previous buffer
+BEGIN		Go to the first line
+BOOKMARK	Read bookmark
+CENTER_H	Move to the center line
+CENTER_V	Move to the center column
+COOKIE		View cookie list
+DELETE_PREVBUF  Delete previous buffer
+DICT_WORD	Execute dictionary command (see README.dict)
+DOWN		Scroll down one line
+DOWN_LOAD	Save HTML source
+EDIT		Edit current document
+EDIT_SCREEN	Edit currently rendered document
+END		Go to the last line
+EXEC_SHELL	Execute shell command
+EXIT		Quit w3m without confirmation
+EXTERN		Execute external browser
+EXTERN_LINK	View current link using external browser
+FRAME		Render frame
+GOTO		Go to URL
+GOTO_LINE	Go to specified line
+GOTO_LINK	Go to current link
+HELP		View help
+HISTORY		View history of URL
+INFO		View info of current document
+INTERRUPT	Stop loading document
+INIT_MAILCAP    Reread mailcap
+LEFT		Shift screen one column
+LINE_BEGIN	Go to the beginning of line
+LINE_END	Go to the end of line
+LINE_INFO	Show current line number
+LOAD		Load local file
+MAIN_MENU	Popup menu
+MARK		Set/unset mark
+MARK_MID	Mark Message-ID-like strings as anchors
+MARK_URL	Mark URL-like strings as anchors
+MENU		Popup menu
+MOVE_DOWN	Move cursor down
+MOVE_LEFT	Move cursor left
+MOVE_RIGHT	Move cursor right
+MOVE_UP		Move cursor up
+NEXT_LINK	Move to next link
+NEXT_MARK	Move to next word
+NEXT_PAGE	Move to next page
+NEXT_WORD	Move to next word
+NOTHING		Do nothing
+NULL		Do nothing
+OPTIONS		Option setting panel
+PEEK		Peek current URL
+PEEK_LINK	Peek link URL
+PEEK_IMG	Peek image URL 
+PIPE_SHELL	Execute shell command and browse
+PREV_LINK	Move to previous link
+PREV_MARK	Move to previous mark
+PREV_PAGE	Move to previous page
+PREV_WORD	Move to previous word
+PRINT		Save buffer to file
+QUIT		Quit w3m
+READ_SHELL	Execute shell command and load
+REDRAW		Redraw screen
+REG_MARK	Set mark using regexp
+RELOAD		Reload buffer
+RIGHT		Shift screen one column right
+SAVE		Save HTML source to file
+SAVE_IMAGE	Save image to file
+SAVE_LINK	Save link to file
+SAVE_SCREEN	Save rendered document to file
+SEARCH		Search forward
+SEARCH_BACK	Search backward
+SEARCH_FORE	Search forward
+SEARCH_NEXT	Search next regexp
+SEARCH_PREV	Search previous regexp
+SELECT		Go to buffer selection panel
+SHELL		Execute shell command
+SHIFT_LEFT	Shift screen left
+SHIFT_RIGHT	Shift screen right
+SOURCE		View HTML source
+SUSPEND		Stop loading document
+UP		Scroll up one line
+VIEW		View HTML source
+VIEW_BOOKMARK	View bookmark
+VIEW_IMAGE	View image
+WHEREIS		Search forward
+WRAP_TOGGLE   Toggle wrap search mode