doc/w3m.1

   1 .nr N -1
   2 .nr D 5
   3 .TH W3M 1 Local
   4 .UC 4
   5 .SH NAME
   6 w3m \- a text based Web browser and pager
   7 .SH SYNOPSIS
   8 .B w3m
   9 [options] [URL or filename]
  10 .PP
  11 Use "w3m -h" to display a complete list of current options.
  12 .SH DESCRIPTION
  13 .\" This defines appropriate quote strings for nroff and troff
  14 .ds lq \&"
  15 .ds rq \&"
  16 .if t .ds lq ``
  17 .if t .ds rq ''
  18 .\" Just in case these number registers aren't set yet...
  19 .if \nN==0 .nr N 10
  20 .if \nD==0 .nr D 5
  21 .I
  22 w3m
  23 is a World Wide Web (WWW) text based client. It has English and
  24 Japanese help files and an option menu and can be configured to
  25 use either language. It will display hypertext markup language
  26 (HTML) documents containing links to files residing on the local
  27 system, as well as files residing on remote systems. It can
  28 display HTML tables and frames.
  29 In addition, it can be used as a "pager" in much the same manner
  30 as "more" or "less".
  31 Current versions of
  32 .I
  33 w3m
  34 run on
  35 Unix (Solaris, SunOS, HP-UX, Linux, FreeBSD, and EWS4800)
  36 and on
  37 Microsoft Windows 9x/NT.
  38 .PP
  39 .SH OPTIONS
  40 At start up, \fIw3m\fR will load any local
  41 file or remote URL specified at the command
  42 line.  For help with runtime options, press \fB"H"\fR
  43 while running \fIw3m\fR.
  44 Command line options are:
  45 .PP
  46 .TP
  47 .B -t tab
  48 set tab width
  49 .TP
  50 .B -r
  51 ignore backspace effect
  52 .TP
  53 .B -l line
  54 # of preserved line (default 10000)
  55 .TP
  56 .B -B
  57 load bookmark
  58 .TP
  59 .B -bookmark file
  60 specify bookmark file
  61 .TP
  62 .B -T type
  63 specify content-type
  64 .TP
  65 .B -m
  66 internet message mode
  67 .TP
  68 .B -v
  69 visual startup mode
  70 .TP
  71 .B -M
  72 monochrome display
  73 .TP
  74 .B -F
  75 automatically render frame
  76 .TP
  77 .B -dump
  78 dump formatted page into stdout
  79 .TP
  80 .B -cols width
  81 specify column width (used with -dump)
  82 .TP
  83 .B -ppc count
  84 specify the number of pixels per character (default 8.0)
  85 Larger values will make tables narrower.
  86 .TP
  87 .B -dump_source
  88 dump page source into stdout
  89 .TP
  90 .B -dump_head
  91 dump response of HEAD request into stdout
  92 .TP
  93 .B -dump_both
  94 dump HEAD and source into stdout
  95 .TP
  96 .B -dump_extra
  97 dump HEAD, source, and extra information into stdout
  98 .TP
  99 .B -post file
 100 use POST method with file content
 101 .TP
 102 .B -header string
 103 insert string as a header
 104 .TP
 105 .B +<num>
 106 goto <num> line
 107 .TP
 108 .B -num
 109 show line number
 110 .TP
 111 .B -no-proxy
 112 don't use proxy
 113 .TP
 114 .B -no-mouse
 115 don't use mouse
 116 .TP
 117 .B -cookie
 118 use cookie.
 119 .TP
 120 .B -no-cookie
 121 don't use cookie
 122 .TP
 123 .B -pauth user:pass
 124 proxy authentication
 125 .TP
 126 .B -S
 127 squeeze multiple blank lines
 128 .TP
 129 .B -W
 130 toggle wrap search mode
 131 .TP
 132 .B -X
 133 don't use termcap init/deinit
 134 .TP
 135 .B -title [=TERM]
 136 set buffer name to termianl title string.
 137 If TERM is specified, use the TERM style title configuration.
 138 .TP
 139 .B -o opt=value
 140 assign value to config option
 141 .TP
 142 .B -show-option
 143 show all available config option
 144 .TP
 145 .B -config file
 146 specify config file
 147 .TP
 148 .B -help
 149 show usage
 150 .TP
 151 .B -version
 152 show w3m version
 153 .TP
 154 .B -debug
 155 DO NOT USE
 156 .SH EXAMPLES
 157 .TP
 158 To use w3m as a pager:
 159 .br
 160 $ ls | w3m
 161 .br
 162 .TP
 163 To use w3m to translate HTML files:
 164 .br
 165 $ cat foo.html | w3m -T text/html
 166 .TP
 167 or
 168 .br
 169 $ cat foo.html | w3m -dump -T text/html >foo.txt
 170 .SH NOTES
 171 This is the
 172 .I
 173 w3m
 174 0.2.1 Release.
 175 .PP
 176 Additional information about
 177 .I
 178 w3m
 179 may be found on its Japanese language Web site located at:
 180   http://w3m.sourceforge.net/index.ja.html
 181 .br
 182 or on its English version of the site at:
 183   http://w3m.sourceforge.net/index.en.html
 184 .SH ACKNOWLEDGMENTS
 185 .I
 186 w3m
 187 has incorporated code from several sources.
 188 Hans J. Boehm, Alan J. Demers, Xerox Corp. and Silicon Graphics
 189 have the copyright of the GC library comes with w3m package.
 190 Users have contributed patches and suggestions over time.
 191 .SH AUTHOR
 192 Akinori ITO <aito@fw.ipsj.or.jp>