lynx.hlp 49.1 KB
Newer Older
1
1 LYNX
2
2 Name
3 4
       lynx  - a general purpose distributed information browser for the World
       Wide Web
5 6

2 Synopsis
7
       lynx [options] [optional paths or URLs]
8

9 10 11 12 13 14 15 16 17
       lynx [options] [path or URL] -get_data
       data
       --

       lynx [options] [path or URL] -post_data
       data
       --

       Use "lynx -help" to display a complete list of current options.
18 19

2 Description
20 21
       Lynx is a fully-featured World Wide Web (WWW) client for users  running
       cursor-addressable,   character-cell   display   devices  (e.g.,  vt100
22 23 24 25 26 27 28 29 30 31 32 33
       terminals, vt100 emulators running on Windows 95/NT/XP/7/8 or any POSIX
       platform,  or  any  other  "curses-oriented" display).  It will display
       hypertext markup language (HTML) documents containing  links  to  files
       residing  on  the  local  system,  as  well as files residing on remote
       systems running Gopher, HTTP, FTP, WAIS,  and  NNTP  servers.   Current
       versions  of Lynx run on Unix, VMS, Windows 95/NT/XP/7/8, DOS DJGPP and
       OS/2.

       Lynx can be used to access information on the World  Wide  Web,  or  to
       build  information  systems  intended  primarily for local access.  For
       example, Lynx has been used to build several  Campus  Wide  Information
       Systems  (CWIS).   In  addition,  Lynx  can  be  used  to build systems
34
       isolated within a single LAN.
35 36

2 Options
37 38
       At start up, Lynx will load any local file or remote URL  specified  at
       the  command line.  For help with URLs, press "?"  or "H" while running
39 40
       Lynx.  Then follow the link titled, "Help on URLs."

41 42
       If more than one local file or remote URL  is  listed  on  the  command
       line,  Lynx  will  open  only the last interactively.  All of the names
43 44
       (local files and remote URLs) are added to the G)oto history.

45
       Lynx uses only long option names.  Option names can begin  with  double
46 47 48
       dash  "--"  as well, underscores and dashes can be intermixed in option
       names (in the reference below, options are  shown  with  one  dash  "-"
       before them, and with underscores "_").
49

50 51 52
       Lynx  provides many command-line options.  Some options require a value
       (string, number or keyword).  These are noted in the  reference  below.
       The  other  options set boolean values in the program.  There are three
53 54
       types of boolean options: set, unset and toggle.  If no option value is
       given, these have the obvious meaning: set (to true), unset (to false),
55
       or toggle (between true/false).  For any of these,  an  explicit  value
56 57
       can  be  given  in  different  forms  to  allow  for  operating  system
       constraints, e.g.,
58

59 60 61
           -center:off
           -center=off
           -center-
62

63 64
       Lynx recognizes "1", "+", "on" and "true" for  true  values,  and  "0",
       "-",  "off"  and  "false"  for  false  values.  Other option-values are
65 66
       ignored.

67 68 69 70 71
       The default boolean, number and string option values that are  compiled
       into  Lynx  are  displayed  in the help-message provided by lynx -help.
       Some of those may differ according to how Lynx was built; see the  help
       message  itself for these values.  The -help option is processed in the
       third pass of options-processing, so any option which sets a value,  as
72
       well as runtime configuration values are reflected in the help-message.
73

74
       -      If  the  argument  is only "-", then Lynx expects to receive the
75 76 77 78 79
              arguments from the standard input.  This is  to  allow  for  the
              potentially  very  long command line that can be associated with
              the -get_data or -post_data arguments (see below).  It can  also
              be  used  to  avoid having sensitive information in the invoking
              command line (which would be visible to other processes on  most
80
              systems), especially when the -auth or -pauth options are used.
81 82 83 84 85

       -accept_all_cookies
              accept all cookies.

       -anonymous
86
              apply    restrictions    for   anonymous   account,   see   also
87 88 89
              -restrictions.

       -assume_charset=MIMEname
90
              charset for documents that do not specify it.
91 92

       -assume_local_charset=MIMEname
93
              charset assumed for local files, i.e., files which Lynx  creates
94
              such as internal pages for the options menu.
95 96 97 98 99

       -assume_unrec_charset=MIMEname
              use this instead of unrecognized charsets.

       -auth=ID:PASSWD
100 101
              set  authorization  ID  and  password for protected documents at
              startup.  Be sure to protect any script  files  which  use  this
102
              switch.
103

104
       -base  prepend  a request URL comment and BASE tag to text/html outputs
105
              for -source dumps.
106

107
       -bibhost=URL
108
              specify a local bibp server (default http://bibhost/).
109

110 111 112
       -blink forces high intensity  background  colors  for  color  mode,  if
              available  and  supported  by the terminal.  This applies to the
              slang library (for a few terminal emulators),  or  to  OS/2  EMX
113
              with ncurses.
114

115 116
       -book  use  the bookmark page as the startfile.  The default or command
              line startfile is still set for the  Main  screen  command,  and
117
              will be used if the bookmark page is unavailable or blank.
118 119

       -buried_news
120 121 122
              toggles  scanning  of  news  articles for buried references, and
              converts them to news  links.   Not  recommended  because  email
              addresses  enclosed in angle brackets will be converted to false
123
              news links, and uuencoded messages can be trashed.
124 125

       -cache=NUMBER
126
              set the NUMBER of documents cached in memory.   The  default  is
127
              10.
128 129 130 131 132 133 134

       -case  enable case-sensitive string searching.

       -center
              Toggle center alignment in HTML TABLE.

       -cfg=FILENAME
135
              specifies  a  Lynx  configuration  file  other  than the default
136
              lynx.cfg.
137

138
       -child exit on left-arrow in startfile, and disable save  to  disk  and
139 140 141
              associated print/mail options.

       -child_relaxed
142
              exit  on  left-arrow  in  startfile,  but allow save to disk and
143
              associated print/mail options.
144 145

       -cmd_log=FILENAME
146
              write  keystroke  commands  and  related  information   to   the
147
              specified file.
148 149

       -cmd_script=FILENAME
150 151 152 153
              read  keystroke  commands  from the specified file.  You can use
              the data written using the -cmd_log option.   Lynx  will  ignore
              other  information which the command-logging may have written to
              the logfile.  Each line of the command script contains either  a
154 155
              comment beginning with "#", or a keyword:

156
              exit
157
                 causes   the   script  to  stop,  and  forces  Lynx  to  exit
158 159
                 immediately.

160
              key
161 162 163
                 the character value, in printable  form.   Cursor  and  other
                 special   keys  are  given  as  names,  e.g.,  "Down  Arrow".
                 Printable 7-bit ASCII codes are given as-is, and  hexadecimal
164 165
                 values represent other 8-bit codes.

166
              set
167 168
                 followed  by a "name=value" allows one to override values set
                 in the lynx.cfg or .lynxrc files.  Lynx  tries  the  cfg-file
169
                 setting first.
170

171 172 173
       -collapse_br_tags
              toggles collapsing of BR tags.

174 175 176 177
       -color forces  color  mode  on,  if  available.   Default color control
              sequences which work for many terminal types are assumed if  the
              terminal  capability  description does not specify how to handle
              color.  Lynx needs to be compiled with  the  slang  library  for
178
              this flag, it is equivalent to setting the COLORTERM environment
179 180 181 182 183 184
              variable.  (If color support is instead  provided  by  a  color-
              capable  curses  library like ncurses, Lynx relies completely on
              the terminal description to  determine  whether  color  mode  is
              possible,  and this flag is not needed and thus unavailable.)  A
              saved show_color=always setting  found  in  a  .lynxrc  file  at
              startup  has the same effect.  A saved show_color=never found in
185 186 187
              .lynxrc on startup is overridden by this flag.

       -connect_timeout=N
188
              Sets the connection timeout, where N is given in seconds.
189 190

       -cookie_file=FILENAME
191 192
              specifies a file to use to read cookies.  If none is  specified,
              the  default  value  is  ~/.lynx_cookies  for  most systems, but
193
              ~/cookies for MS-DOS.
194 195

       -cookie_save_file=FILENAME
196 197
              specifies a file to use to store cookies.  If none is specified,
              the value given by -cookie_file is used.
198 199 200 201

       -cookies
              toggles handling of Set-Cookie headers.

202 203
       -core  toggles forced core dumps on fatal errors.  Turn this option off
              to ask Lynx to force a core dump if a fatal error occurs.
204

205 206
       -crawl with -traversal, output each page to a file.  with -dump, format
              output as with -traversal, but to the standard output.
207 208

       -curses_pads
209 210 211 212
              toggles   the   use  of  curses  "pad"  feature  which  supports
              left/right scrolling of the display.  The  feature  is  normally
              available  for curses configurations, but inactive.  To activate
              it, use  the  "|"  character  or  the  LINEWRAP_TOGGLE  command.
213
              Toggling this option makes the feature altogether unavailable.
214 215

       -debug_partial
216
              separate incremental display stages with MessageSecs delay
217

218
       -default_colors
219
              toggles  the default-colors feature which is normally set in the
220 221
              lynx.cfg file.

222 223
       -delay add DebugSecs delay after each progress-message

224 225 226 227 228 229 230
       -display=DISPLAY
              set the display variable for X rexec-ed programs.

       -display_charset=MIMEname
              set the charset for the terminal output.

       -dont_wrap_pre
231
              inhibit wrapping of text when  -dump'ing  and  -crawl'ing,  mark
232
              wrapped lines of <pre> in interactive session.
233

234 235
       -dump  dumps  the  formatted  output  of  the default document or those
              specified on  the  command  line  to  standard  output.   Unlike
236 237
              interactive mode, all documents are processed.  This can be used
              in the following way:
238

239
                  lynx -dump http://www.subir.com/lynx.html
240

241 242 243
              Files specified on the command line are  formatted  as  HTML  if
              their  names  end  with one of the standard web suffixes such as
              ".htm" or ".html".  Use the -force_html option to  format  files
244 245
              whose names do not follow this convention.

246
       -editor=EDITOR
247
              enable  external  editing, using the specified EDITOR.  (vi, ed,
248
              emacs, etc.)
249 250 251 252 253

       -emacskeys
              enable emacs-like key movement.

       -enable_scrollback
254
              toggles compatibility with  communication  programs'  scrollback
255
              keys (may be incompatible with some curses packages).
256 257

       -error_file=FILE
258
              define a file where Lynx will report HTTP access codes.
259

260
       -exec  enable local program execution (normally not configured).
261 262

       -fileversions
263
              include all versions of files in local VMS directory listings.
264

265
       -find_leaks
266
              toggle memory leak-checking.  Normally this is not compiled-into
267
              your executable, but when it  is,  it  can  be  disabled  for  a
268
              session.
269

270
       -force_empty_hrefless_a
271
              force  HREF-less "A" elements to be empty (close them as soon as
272
              they are seen).
273 274

       -force_html
275 276 277 278 279 280 281
              forces the first document to be interpreted as HTML.

              This is most useful  when  processing  files  specified  on  the
              command line which have an unrecognized suffix (or the suffix is
              associated with a non-HTML type, such as ".txt" for  plain  text
              files).

282
              Lynx recognizes these file suffixes as HTML:
283

284 285 286 287 288 289 290 291 292 293
                  ".ht3",
                  ".htm",
                  ".html3",
                  ".html",
                  ".htmlx",
                  ".php3",
                  ".php",
                  ".phtml",
                  ".sht", and
                  ".shtml".
294 295 296 297 298

       -force_secure
              toggles forcing of the secure flag for SSL cookies.

       -forms_options
299
              toggles whether the Options Menu is key-based or form-based.
300 301 302 303 304 305

       -from  toggles transmissions of From headers.

       -ftp   disable ftp access.

       -get_data
306
              properly  formatted  data  for  a  get form are read in from the
307
              standard input and passed to the form.  Input is terminated by a
308
              line that starts with "---".
309

310
              Lynx  issues  an  HTTP  GET, sending the form to the path or URL
311
              given on the command-line and prints the response of the server.
312
              If  no  path  or URL is given, Lynx sends the form to the start-
313 314
              page.

315 316
       -head  send a HEAD request for the mime headers.

317
       -help  print the Lynx command syntax usage message, and exit.
318 319 320 321

       -hiddenlinks=[option]
              control the display of hidden links.

322
              merge
323
                 hidden links show up as bracketed numbers  and  are  numbered
324 325
                 together with other links in the sequence of their occurrence
                 in the document.
326

327
              listonly
328 329 330
                 hidden links are shown only on  L)ist  screens  and  listings
                 generated  by  -dump  or  from  the  P)rint  menu, but appear
                 separately at the end of those lists.  This  is  the  default
331
                 behavior.
332

333 334
              ignore
                 hidden links do not appear even in listings.
335 336

       -historical
337
              toggles use of ">" or "-->" as a terminator for comments.
338 339 340 341 342 343 344 345 346 347

       -homepage=URL
              set homepage separate from start page.

       -image_links
              toggles inclusion of links for all images.

       -index=URL
              set the default index file to the specified URL.

348
       -ismap toggles  inclusion  of  ISMAP  links  when  client-side MAPs are
349
              present.
350 351 352 353 354

       -justify
              do justification of text.

       -link=NUMBER
355 356
              starting count for lnk#.dat files produced by -crawl.

357 358 359
       -list_inline
              for -dump, show the links inline with the text.

360 361
       -listonly
              for -dump, show only the list of links.
362 363 364 365 366

       -localhost
              disable URLs that point to remote hosts.

       -locexec
367
              enable local program execution from local files  only  (if  Lynx
368
              was compiled with local execution enabled).
369 370

       -lss=FILENAME
371
              specify   filename   containing  color-style  information.   The
372
              default is lynx.lss.  If you give an empty filename, Lynx uses a
373
              built-in  monochrome  scheme  which imitates the non-color-style
374
              configuration.
375 376

       -mime_header
377
              prints the MIME header of a  fetched  document  along  with  its
378
              source.
379 380 381 382

       -minimal
              toggles minimal versus valid comment parsing.

383 384 385
       -nested_tables
              toggles nested-tables logic (for debugging).

386 387 388 389
       -newschunksize=NUMBER
              number of articles in chunked news listings.

       -newsmaxchunk=NUMBER
390
              maximum news articles in listings before chunking.
391 392 393 394 395 396 397

       -nobold
              disable bold video-attribute.

       -nobrowse
              disable directory browsing.

398
       -nocc  disable Cc: prompts for self copies of mailings.  Note that this
399
              does not disable any CCs which are incorporated within a  mailto
400
              URL or form ACTION.
401 402

       -nocolor
403
              force  color  mode off, overriding terminal capabilities and any
404
              -color flags, COLORTERM variable, and saved .lynxrc settings.
405 406

       -noexec
407
              disable local program execution.  (DEFAULT)
408 409

       -nofilereferer
410
              disable transmissions of Referer headers for file URLs.
411 412 413 414

       -nolist
              disable the link list feature in dumps.

415 416 417 418
       -nolog disable mailing of error messages to document owners.

       -nomargins
              disable left/right margins in the default style sheet.
419

420 421 422
       -nomore
              disable -more- string in statusline messages.

423
       -nonrestarting_sigwinch
424 425 426
              This flag is not available on all  systems,  Lynx  needs  to  be
              compiled  with  HAVE_SIGACTION defined.  If available, this flag
              may cause Lynx to react more immediately to window changes  when
427 428 429
              run within an xterm.

       -nonumbers
430
              disable    link-    and    field-numbering.     This   overrides
431
              -number_fields and -number_links.
432 433 434 435 436 437 438 439

       -nopause
              disable forced pauses for statusline messages.

       -noprint
              disable most print functions.

       -noredir
440
              prevents automatic redirection and prints a message with a  link
441
              to the new URL.
442 443 444 445 446 447 448 449 450 451 452 453 454

       -noreferer
              disable transmissions of Referer headers.

       -noreverse
              disable reverse video-attribute.

       -nosocks
              disable SOCKS proxy usage by a SOCKSified Lynx.

       -nostatus
              disable the retrieval status messages.

455 456 457
       -notitle
              disable title and blank line from top of page.

458 459 460 461
       -nounderline
              disable underline video-attribute.

       -number_fields
462
              force numbering of links as well as form input fields
463 464 465 466 467 468 469 470

       -number_links
              force numbering of links.

       -partial
              toggles display partial pages while loading.

       -partial_thres=NUMBER
471 472
              number  of  lines  to  render  before  repainting  display  with
              partial-display logic
473

474
       -passive_ftp
475 476
              toggles passive ftp connections.

477
       -pauth=ID:PASSWD
478 479
              set authorization ID and password for a protected  proxy  server
              at  startup.  Be sure to protect any script files which use this
480
              switch.
481

482
       -popup toggles handling  of  single-choice  SELECT  options  via  popup
483
              windows or as lists of radio buttons.
484 485

       -post_data
486
              properly  formatted  data  for  a post form are read in from the
487
              standard input and passed to the form.  Input is terminated by a
488
              line that starts with "---".
489

490
              Lynx  issues  an  HTTP POST, sending the form to the path or URL
491
              given on the command-line and prints the response of the server.
492
              If  no  path  or URL is given, Lynx sends the form to the start-
493 494
              page.

495
       -preparsed
496
              show HTML  source  preparsed  and  reformatted  when  used  with
497
              -source or in source view.
498 499

       -prettysrc
500
              show HTML source view with lexical elements and tags in color.
501

502
       -print enable print functions.  (default)
503 504

       -pseudo_inlines
505
              toggles pseudo-ALTs for inline images with no ALT string.
506

507
       -raw   toggles  default  setting of 8-bit character translations or CJK
508
              mode for the startup character set.
509 510 511

       -realm restricts access to URLs in the starting realm.

512 513 514
       -read_timeout=N
              Sets the read-timeout, where N is given in seconds.

515
       -reload
516
              flushes the cache on a proxy server  (only  the  first  document
517
              given on the command-line is affected).
518 519

       -restrictions=[option][,option][,option]...
520 521
              allows  a  list  of services to be disabled selectively.  Dashes
              and  underscores  in  option  names  can  be  intermixed.    The
522
              following list is printed if no options are specified.
523

524 525
              all
                 restricts all options listed below.
526

527 528
              bookmark
                 disallow changing the location of the bookmark file.
529

530 531
              bookmark_exec
                 disallow execution links via the bookmark file.
532

533
              change_exec_perms
534 535
                 disallow  changing the eXecute permission on files (but still
                 allow it for  directories)  when  local  file  management  is
536
                 enabled.
537

538
              default
539 540 541 542
                 same  as  command  line  option -anonymous.  Disables default
                 services for anonymous users.  Set to all restricted,  except
                 for:  inside_telnet, outside_telnet, inside_ftp, outside_ftp,
                 inside_rlogin,  outside_rlogin,  inside_news,   outside_news,
543
                 telnet_port, jump, mail, print, exec, and goto.  The settings
544 545
                 for these,  as  well  as  additional  goto  restrictions  for
                 specific  URL schemes that are also applied, are derived from
546
                 definitions within userdefs.h.
547

548 549
              dired_support
                 disallow local file management.
550

551 552
              disk_save
                 disallow saving to disk in the download and print menus.
553

554 555
              dotfiles
                 disallow access to, or creation of, hidden (dot) files.
556

557
              download
558
                 disallow some downloaders in  the  download  menu  (does  not
559
                 imply disk_save restriction).
560

561 562
              editor
                 disallow external editing.
563

564 565
              exec
                 disable execution scripts.
566

567 568
              exec_frozen
                 disallow the user from changing the local execution option.
569

570
              externals
571
                 disallow  some  "EXTERNAL" configuration lines if support for
572 573
                 passing  URLs  to  external  applications  (with  the  EXTERN
                 command) is compiled in.
574

575
              file_url
576
                 disallow  using  G)oto,  served  links or bookmarks for file:
577
                 URLs.
578

579
              goto
580
                 disable the "g" (goto) command.
581

582 583 584
              inside_ftp
                 disallow ftps for people coming from inside your domain (utmp
                 required for selectivity).
585

586
              inside_news
587
                 disallow  USENET  news  posting for people coming from inside
588
                 your domain (utmp required for selectivity).
589

590
              inside_rlogin
591
                 disallow rlogins for people coming from  inside  your  domain
592
                 (utmp required for selectivity).
593

594
              inside_telnet
595
                 disallow  telnets  for  people coming from inside your domain
596
                 (utmp required for selectivity).
597

598
              jump
599
                 disable the "j" (jump) command.
600

601 602
              multibook
                 disallow multiple bookmarks.
603

604 605
              mail
                 disallow mail.
606

607 608
              news_post
                 disallow USENET News posting.
609

610 611
              options_save
                 disallow saving options in .lynxrc.
612

613
              outside_ftp
614
                 disallow ftps for people  coming  from  outside  your  domain
615
                 (utmp required for selectivity).
616

617
              outside_news
618 619 620 621
                 disallow  USENET  news  reading and posting for people coming
                 from outside your domain  (utmp  required  for  selectivity).
                 This  restriction  applies to "news", "nntp", "newspost", and
                 "newsreply"  URLs,  but  not  to  "snews",  "snewspost",   or
622
                 "snewsreply" in case they are supported.
623

624
              outside_rlogin
625
                 disallow  rlogins  for people coming from outside your domain
626
                 (utmp required for selectivity).
627

628
              outside_telnet
629
                 disallow telnets for people coming from outside  your  domain
630
                 (utmp required for selectivity).
631

632 633
              print
                 disallow most print options.
634

635 636
              shell
                 disallow shell escapes and lynxexec or lynxprog G)oto's.
637

638 639
              suspend
                 disallow Unix Control-Z suspends with escape to shell.
640

641 642
              telnet_port
                 disallow specifying a port in telnet G)oto's.
643

644 645
              useragent
                 disallow modifications of the User-Agent header.
646 647

       -resubmit_posts
648 649
              toggles  forced  resubmissions  (no-cache)  of forms with method
              POST when the  documents  they  returned  are  sought  with  the
650
              PREV_DOC command or from the History List.
651 652 653 654 655 656 657 658 659 660 661 662 663

       -rlogin
              disable recognition of rlogin commands.

       -scrollbar
              toggles showing scrollbar.

       -scrollbar_arrow
              toggles showing arrows at ends of the scrollbar.

       -selective
              require .www_browsable files to browse directories.

664 665 666 667 668 669 670 671 672 673
       -session=FILENAME
              resumes from specified file on startup and saves session to that
              file on exit.

       -sessionin=FILENAME
              resumes session from specified file.

       -sessionout=FILENAME
              saves session to specified file.

674
       -short_url
675
              show very long URLs in the status line with "..."  to  represent
676 677
              the portion which cannot be displayed.  The beginning and end of
              the URL are displayed, rather than suppressing the end.
678

679 680 681 682
       -show_cfg
              Print the configuration settings, e.g., as read from "lynx.cfg",
              and exit.

683
       -show_cursor
684 685
              If  enabled  the  cursor  will  not  be hidden in the right hand
              corner but will instead  be  positioned  at  the  start  of  the
686
              currently selected link.  Show cursor is the default for systems
687 688
              without FANCY_CURSES capabilities.   The  default  configuration
              can  be  changed  in  userdefs.h  or lynx.cfg.  The command line
689
              switch toggles the default.
690 691

       -show_rate
692 693
              If enabled the transfer  rate  is  shown  in  bytes/second.   If
              disabled,  no  transfer  rate  is  shown.   Use  lynx.cfg or the
694
              options menu to select KB/second and/or ETA.
695 696

       -soft_dquotes
697 698
              toggles emulation of the  old  Netscape  and  Mosaic  bug  which
              treated ">" as a co-terminator for double-quotes and tags.
699 700

       -source
701
              works  the  same  as  dump  but  outputs  HTML source instead of
702 703
              formatted text.  For example

704
                  lynx -source . >foo.html
705

706 707 708
              generates  HTML  source  listing  the  files  in   the   current
              directory.   Each  file  is  marked  by  an HREF relative to the
              parent directory.  Add a  trailing  slash  to  make  the  HREF's
709 710
              relative to the current directory:

711
                  lynx -source ./ >foo.html
712 713 714 715 716

       -stack_dump
              disable SIGINT cleanup handler

       -startfile_ok
717
              allow non-http startfile and homepage with -validate.
718

719
       -stderr
720 721 722
              When  dumping  a  document using -dump or -source, Lynx normally
              does not display alert (error) messages  that  you  see  on  the
              screen  in the status line.  Use the -stderr option to tell Lynx
723 724
              to write these messages to the standard error.

725 726 727 728 729
       -stdin read the startfile from standard input (UNIX only).

       -syslog=text
              information for syslog call.

730
       -syslog_urls
731 732
              log requested URLs with syslog.

733
       -tagsoup
734
              initialize parser, using Tag Soup DTD rather than SortaSGML.
735 736 737 738 739

       -telnet
              disable recognition of telnet commands.

       -term=TERM
740 741 742
              tell Lynx what terminal type to assume it is talking to.   (This
              may  be  useful  for  remote  execution, when, for example, Lynx
              connects to a remote TCP/IP port that starts a script  that,  in
743 744 745
              turn, starts another Lynx process.)

       -timeout=N
746
              For  win32,  sets  the network read-timeout, where N is given in
747
              seconds.
748

749
       -tlog  toggles between using a Lynx Trace  Log  and  stderr  for  trace
750
              output from the session.
751 752 753

       -tna   turns on "Textfields Need Activation" mode.

754
       -trace turns  on  Lynx trace mode.  Destination of trace output depends
755
              on -tlog.
756 757

       -trace_mask=value
758
              turn on optional traces, which may result in  very  large  trace
759
              files.  Logically OR the values to combine options:
760 761 762 763 764 765 766

              1  SGML character parsing states

              2  color-style

              4  TRST (table layout)

767
              8  configuration  (lynx.cfg,  .lynxrc, .lynx-keymaps, mime.types
768 769 770 771 772 773 774 775 776 777 778 779 780
                 and mailcap contents)

              16 binary string copy/append, used in form data construction.

              32 cookies

              64 character sets

              128
                 GridText parsing

              256
                 timing
781 782

       -traversal
783 784 785 786 787
              traverse all http links derived from startfile.  When used  with
              -crawl,  each link that begins with the same string as startfile
              is output to a file, intended for indexing.

              See CRAWL.announce for more information.
788

789 790 791 792
       -trim_blank_lines
              toggles trimming of trailing blank lines as well as the  related
              trimming of blank lines while collapsing BR tags.

793
       -trim_input_fields
794 795
              trim input text/textarea fields in forms.

796 797 798
       -underline_links
              toggles use of underline/bold attribute for links.

799 800 801
       -underscore
              toggles use of _underline_ format in dumps.

802
       -unique_urls
803
              check  for duplicate link numbers in each page and corresponding
804 805
              lists, and reuse the original link number.

806
       -use_mouse
807 808 809 810 811 812 813 814
              turn on mouse support, if available.  Clicking  the  left  mouse
              button  on a link traverses it.  Clicking the right mouse button
              pops back.  Click on the top line to scroll up.   Click  on  the
              bottom  line to scroll down.  The first few positions in the top
              and bottom line may invoke additional functions.  Lynx  must  be
              compiled  with  ncurses  or  slang  to support this feature.  If
              ncurses is used, clicking the middle  mouse  button  pops  up  a
              simple  menu.  Mouse clicks may only work reliably while Lynx is
815 816 817 818 819 820
              idle waiting for input.

       -useragent=Name
              set alternate Lynx User-Agent header.

       -validate
821
              accept only  http  URLs  (for  validation).   Complete  security
822
              restrictions also are implemented.
823 824

       -verbose
825
              toggle  [LINK],  [IMAGE] and [INLINE] comments with filenames of
826
              these images.
827 828

       -version
829
              print version information, and exit.
830 831 832 833 834

       -vikeys
              enable vi-like key movement.

       -wdebug
835 836
              enable Waterloo tcp/ip packet debug (print to  watt  debugfile).
              This  applies  only  to  DOS  versions  compiled  with WATTCP or
837
              WATT-32.
838 839

       -width=NUMBER
840 841
              number of columns for formatting of dumps, default is 80.   This
              is  limited  by  the  number of columns that Lynx could display,
842
              typically 1024 (the MAX_LINE symbol).
843 844

       -with_backspaces
845
              emit backspaces in output if -dump'ing or -crawl'ing  (like  man
846
              does)
847

848
       -xhtml_parsing
849
              tells Lynx that it can ignore certain tags which have no content
850 851
              in an XHTML 1.0 document.  For example "<p/>" will be discarded.

852
2 Commands
853
       More than one key can be mapped to a given command.  Here are  some  of
854 855
       the most useful:

856
       *   Use Up arrow and Down arrow to scroll through hypertext links.
857

858
       *   Right arrow or Return will follow a highlighted hypertext link.
859

860
       *   Left Arrow or "u" will retreat from a link.
861

862 863
       *   Type "H", "?", or F1 for online help and descriptions of key-stroke
           commands.
864

865
       *   Type "k" or "K" for  a  list  of  the  current  key-stroke  command
866
           mappings.
867

868
           If  the same command is mapped to the same letter differing only by
869
           upper/lowercase only the lowercase mapping is shown.
870

871
       *   Type Delete to view history list.
872

873
2 Environment
874 875
       In addition to various "standard" environment variables such  as  HOME,
       PATH,  USER,  DISPLAY, TMPDIR, etc, Lynx utilizes several Lynx-specific
876
       environment variables, if they exist.
877

878
       Others may be created or modified by Lynx to pass data to  an  external
879
       program, or for other reasons.  These are listed separately below.
880

881
       See  also  the  sections  on  SIMULATED CGI SUPPORT and NATIVE LANGUAGE
882
       SUPPORT, below.
883

884 885
       Note:  Not all environment variables apply to all  types  of  platforms
       supported  by  Lynx, though most do.  Feedback on platform dependencies
886
       is solicited.
887 888 889

       Environment Variables Used By Lynx:

890
       COLORTERM           If set, color capability for the terminal is forced
891 892
                           on  at  startup time.  The actual value assigned to
                           the variable is ignored.   This  variable  is  only
893 894 895
                           meaningful  if  Lynx  was  built  using  the  slang
                           screen-handling library.

896 897 898
       LYNX_CFG            This variable, if set, will  override  the  default
                           location  and name of the global configuration file
                           (normally,  lynx.cfg)  that  was  defined  by   the
899
                           LYNX_CFG_FILE  constant  in  the  userdefs.h  file,
900 901 902
                           during installation.

                           See the userdefs.h file for more information.
903

904 905 906
       LYNX_CFG_PATH       If set, this  variable  overrides  the  compiled-in
                           search-list   of   directories  used  to  find  the
                           configuration files, e.g., lynx.cfg  and  lynx.lss.
907 908 909
                           The list is delimited with ":" (or ";" for Windows)
                           like the PATH environment variable.

910
       LYNX_HELPFILE       If set, this variable overrides the compiled-in URL
911
                           and configuration file URL for the Lynx help file.
912

913 914
       LYNX_LOCALEDIR      If  set,  this  variable  overrides the compiled-in
                           location of the  locale  directory  which  contains
915 916
                           native language (NLS) message text.

917 918 919
       LYNX_LSS            This  variable,  if  set, specifies the location of
                           the  default  Lynx  character  style  sheet   file.
                           [Currently  only meaningful if Lynx was built using
920
                           curses color style support.]
921

922
       LYNX_SAVE_SPACE     This variable, if set, will  override  the  default
923
                           path prefix for files saved to disk that is defined
924 925 926
                           in the lynx.cfg SAVE_SPACE: statement.

                           See the lynx.cfg file for more information.
927

928 929 930
       LYNX_TEMP_SPACE     This variable, if set, will  override  the  default
                           path  prefix  for  temporary files that was defined
                           during installation, as well as any value that  may
931 932 933
                           be assigned to the TMPDIR variable.

       MAIL                This variable specifies the default inbox Lynx will
934
                           check for new mail, if such checking is enabled  in
935 936
                           the lynx.cfg file.

937 938 939 940
       NEWS_ORGANIZATION   This  variable, if set, provides the string used in
                           the Organization: header of USENET  news  postings.
                           It  will  override  the setting of the ORGANIZATION
                           environment variable, if it is also  set  (and,  on
941 942 943
                           UNIX, the contents of an /etc/organization file, if
                           present).

944 945
       NNTPSERVER          If set, this variable specifies  the  default  NNTP
                           server  that  will  be used for USENET news reading
946 947
                           and posting with Lynx, via news: URL's.

948 949 950
       ORGANIZATION        This variable, if set, provides the string used  in
                           the  Organization:  header of USENET news postings.
                           On UNIX,  it  will  override  the  contents  of  an
951 952 953 954
                           /etc/organization file, if present.

       PROTOCOL_proxy      Lynx supports the use of proxy servers that can act
                           as firewall gateways and caching servers.  They are
955
                           preferable   to  the  older  gateway  servers  (see
956 957
                           WWW_access_GATEWAY, below).

958 959 960 961 962 963 964 965 966 967 968
                           Each protocol used by  Lynx,  (http,  ftp,  gopher,
                           etc),   can   be   mapped   separately  by  setting
                           environment variables of the  form  PROTOCOL_proxy.
                           Protocols are indicated in a URI by the name before
                           ":", e.g., "http" in "http://some.server.dom:port/"
                           for HTML.

                           Depending   on   your   system   configuration  and
                           supported  protocols,  the  environment   variables
                           recognized by lynx may include

969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
                               cso_proxy
                               finger_proxy
                               ftp_proxy
                               gopher_proxy
                               https_proxy
                               http_proxy
                               newspost_proxy
                               newsreply_proxy
                               news_proxy
                               nntp_proxy
                               no_proxy
                               snewspost_proxy
                               snewsreply_proxy
                               snews_proxy
                               wais_proxy
984 985 986 987 988

                           See  Lynx  Users  Guide  for additional details and
                           examples.

       SSL_CERT_DIR        Set   to   the   directory    containing    trusted
989 990
                           certificates.

991
       SSL_CERT_FILE       Set  to the full path and filename for your file of
992 993
                           trusted certificates.

994 995 996 997 998 999 1000 1001 1002 1003
       WWW_access_GATEWAY  Lynx still supports use of  gateway  servers,  with
                           the   servers  specified  via  "WWW_access_GATEWAY"
                           variables (where "access" is lower case and can  be
                           "http",  "ftp",  "gopher" or "wais").  However most
                           gateway servers have been discontinued.  Note  that
                           you do not include a terminal "/" for gateways, but
                           do  for   proxies   specified   by   PROTOCOL_proxy
                           environment variables.

                           See Lynx Users Guide for details.
1004

1005 1006
       WWW_HOME            This  variable,  if  set, will override the default
                           startup  URL  specified  in   any   of   the   Lynx
1007
                           configuration files.
1008 1009 1010

       Environment Variables Set or Modified By Lynx:

1011 1012
       LYNX_PRINT_DATE     This  variable is set by the Lynx p(rint) function,
                           to  the  Date:  string  seen  in   the   document's
1013 1014 1015 1016 1017
                           "Information  about"  page  (= cmd), if any.  It is
                           created for use by an external program, as  defined
                           in  a  lynx.cfg  PRINTER: definition statement.  If
                           the field does not  exist  for  the  document,  the
                           variable is set to a null string under UNIX, or "No
1018
                           Date" under VMS.
1019

1020 1021
       LYNX_PRINT_LASTMOD  This variable is set by the Lynx p(rint)  function,
                           to  the  Last  Mod:  string  seen in the document's
1022 1023 1024 1025 1026
                           "Information about" page (= cmd), if  any.   It  is
                           created  for use by an external program, as defined
                           in a lynx.cfg PRINTER:  definition  statement.   If
                           the  field  does  not  exist  for the document, the
                           variable is set to a null string under UNIX, or "No
1027
                           LastMod" under VMS.
1028

1029 1030
       LYNX_PRINT_TITLE    This  variable is set by the Lynx p(rint) function,
                           to the Linkname:  string  seen  in  the  document's
1031 1032 1033 1034 1035
                           "Information  about"  page  (= cmd), if any.  It is
                           created for use by an external program, as  defined
                           in  a  lynx.cfg  PRINTER: definition statement.  If
                           the field does not  exist  for  the  document,  the
                           variable is set to a null string under UNIX, or "No
1036 1037 1038 1039 1040 1041 1042 1043 1044
                           Title" under VMS.

       LYNX_PRINT_URL      This variable is set by the Lynx p(rint)  function,
                           to   the   URL:   string  seen  in  the  document's
                           "Information about" page (= cmd), if  any.   It  is
                           created  for use by an external program, as defined
                           in a lynx.cfg PRINTER:  definition  statement.   If
                           the  field  does  not  exist  for the document, the
                           variable is set to a null string under UNIX, or "No
1045 1046 1047 1048 1049 1050
                           URL" under VMS.

       LYNX_TRACE          If set, causes Lynx to write a trace file as if the
                           -trace option were supplied.

       LYNX_TRACE_FILE     If set, overrides the compiled-in name of the trace
1051 1052 1053
                           file,  which  is  either Lynx.trace or LY-TRACE.LOG
                           (the latter on  the  DOS/Windows  platforms).   The
                           trace  file  is in either case relative to the home
1054
                           directory.
1055

1056 1057
       LYNX_VERSION        This variable is always set by  Lynx,  and  may  be
                           used  by an external program to determine if it was
1058 1059 1060 1061
                           invoked by Lynx.

                           See also the comments in the distribution's  sample
                           mailcap file, for notes on usage in such a file.
1062

1063 1064
       TERM                Normally,   this   variable  is  used  by  Lynx  to
                           determine the terminal type being  used  to  invoke
1065
                           Lynx.  If, however, it is unset at startup time (or
1066 1067 1068 1069 1070 1071
                           has the value "unknown"), or if the -term  command-
                           line  option  is  used (see OPTIONS section above),
                           Lynx will set or  modify  its  value  to  the  user
                           specified  terminal  type  (for  the Lynx execution
                           environment).  Note: If set/modified by  Lynx,  the
                           values  of  the  LINES  and/or  COLUMNS environment
1072 1073 1074
                           variables may also be changed.

2 Simulated Cgi Support
1075 1076
       If built with the cgi-links option enabled, Lynx allows access to a cgi
       script directly without the need for an http daemon.
1077

1078
       When  executing  such  "lynxcgi  scripts"  (if  enabled), the following
1079
       variables may be set for simulating a CGI environment:
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106

       CONTENT_LENGTH

       CONTENT_TYPE

       DOCUMENT_ROOT

       HTTP_ACCEPT_CHARSET

       HTTP_ACCEPT_LANGUAGE

       HTTP_USER_AGENT

       PATH_INFO

       PATH_TRANSLATED

       QUERY_STRING

       REMOTE_ADDR

       REMOTE_HOST

       REQUEST_METHOD

       SERVER_SOFTWARE

1107 1108 1109
       Other environment variables are not inherited  by  the  script,  unless
       they   are   provided   via  a  LYNXCGI_ENVIRONMENT  statement  in  the
       configuration file.  See the lynx.cfg file, and  the  (draft)  CGI  1.1
1110
       Specification <http://Web.Golux.Com/coar/cgi/draft-coar-cgi-v11-00.txt>
1111 1112
       for the definition and usage of these variables.

1113
       The CGI Specification, and other associated  documentation,  should  be
1114
       consulted for general information on CGI script programming.
1115 1116

2 Native Language Support
1117
       If  configured  and  installed  with Native Language Support, Lynx will
1118
       display status and other messages in your local language.  See the file
1119
       ABOUT_NLS  in  the  source distribution, or at your local GNU site, for
1120 1121
       more information about internationalization.

1122
       The following environment  variables  may  be  used  to  alter  default
1123 1124
       settings:

1125
       LANG                This  variable,  if  set, will override the default
1126
                           message language.  It is an ISO 639 two-letter code
1127
                           identifying  the  language.  Language codes are NOT
1128 1129
                           the same as the country codes given in ISO 3166.

1130
       LANGUAGE            This variable, if set, will  override  the  default
1131
                           message language.  This is a GNU extension that has
1132
                           higher priority for  setting  the  message  catalog
1133
                           than LANG or LC_ALL.
1134 1135 1136

       LC_ALL              and

1137
       LC_MESSAGES         These  variables,  if  set,  specify  the notion of
1138 1139
                           native language formatting style.  They are POSIXly
                           correct.
1140

1141
       LINGUAS             This  variable,  if  set  prior  to  configuration,
1142 1143
                           limits the installed languages to specific  values.
                           It  is  a space-separated list of two-letter codes.
1144
                           Currently, it is hard-coded to a wish list.
1145

1146
       NLSPATH             This variable, if set, is used as the  path  prefix
1147
                           for message catalogs.
1148 1149

2 Notes
1150
       This is the Lynx v2.8.9 Release; development is in progress for 2.9.0.
1151

1152
       If you wish to contribute to the further development of Lynx, subscribe
1153
       to our mailing list.  Send email to <lynx-dev-request@nongnu.org>  with
1154
       "subscribe lynx-dev" as the only line in the body of your message.
1155

1156
       Send  bug reports, comments, suggestions to <lynx-dev@nongnu.org> after
1157
       subscribing.
1158

1159 1160
       Unsubscribe by  sending  email  to  <lynx-dev-request@nongnu.org>  with
       "unsubscribe  lynx-dev"  as  the only line in the body of your message.
1161
       Do not send the unsubscribe message to the lynx-dev list, itself.
1162 1163

2 See Also
1164 1165
       catgets(3), curses(3),  environ(7),  execve(2),  ftp(1),  gettext(GNU),
       localeconv(3),    ncurses(3),   setlocale(3),   slang(?),   termcap(5),
1166
       terminfo(5), wget(GNU)
1167

1168 1169
       Note that man page availability and section numbering is somewhat platform
       dependent, and may vary from the above references.
1170

1171
       A  section  shown as (GNU), is intended to denote that the topic may be
1172 1173
       available via an info page, instead of a man page (i.e., try "info subject",
       rather than "man subject").
1174

1175 1176 1177
       A  section shown as (?) denotes that documentation on the topic exists,
       but is not part of an established documentation retrieval  system  (see
       the  distribution files associated with the topic, or contact your System
1178
       Administrator for further information).
1179 1180

2 Acknowledgments
1181 1182 1183 1184 1185
       Lynx has incorporated code from a variety of  sources  along  the  way.
       The  earliest versions of Lynx included code from Earl Fogel of Comput-
       ing Services at the University of Saskatchewan, who implemented  HYPER-
       REZ  in the Unix environment.  HYPERREZ was developed by Niel Larson of
       Think.com and served as the model  for  the  early  versions  of  Lynx.
1186
       Those versions also incorporated libraries from the Unix Gopher clients
1187 1188 1189
       developed at the University of Minnesota, and  the  later  versions  of
       Lynx  rely  on the WWW client library code developed by Tim Berners-Lee
       and the WWW community.  Also a special thanks to  Foteos  Macrides  who
1190
       ported much of Lynx to VMS and did or organized most of its development
1191 1192 1193
       since the departures of Lou Montulli and Garrett Blythe from  the  Uni-
       versity  of Kansas in the summer of 1994 through the release of v2.7.2,
       and to everyone on the net who has contributed  to  Lynx's  development
1194 1195
       either directly (through patches, comments or bug reports) or indirect-
       ly (through inspiration and development of other systems).
1196 1197

2 Authors
1198
       Lou Montulli, Garrett Blythe, Craig Lavender,  Michael  Grobe,  Charles
1199
       Rezac
1200 1201 1202 1203 1204 1205 1206
       Academic Computing Services
       University of Kansas
       Lawrence, Kansas 66047

       Foteos Macrides
       Worcester Foundation for Biomedical Research
       Shrewsbury, Massachusetts 01545
1207 1208 1209

       Thomas E. Dickey
       <dickey@invisible-island.net>