1LYNX(1)                     General Commands Manual                    LYNX(1)
2
3
4

NAME

6       lynx  - a general purpose distributed information browser for the World
7       Wide Web
8

SYNOPSIS

10       lynx [options] [path or URL]
11
12       use "lynx -help" to display a complete list of current options.
13

DESCRIPTION

15       Lynx is a fully-featured World Wide Web (WWW) client for users  running
16       cursor-addressable,   character-cell   display   devices  (e.g.,  vt100
17       terminals, vt100 emulators running on Windows 95/NT or Macintoshes,  or
18       any other "curses-oriented" display).  It will display hypertext markup
19       language (HTML) documents containing links to  files  residing  on  the
20       local  system,  as  well  as  files  residing on remote systems running
21       Gopher, HTTP, FTP, WAIS, and NNTP servers.  Current  versions  of  Lynx
22       run on Unix, VMS, Windows 95/NT, 386DOS and OS/2 EMX.
23
24       Lynx  can  be  used  to access information on the World Wide Web, or to
25       build information systems intended primarily  for  local  access.   For
26       example,  Lynx  has  been used to build several Campus Wide Information
27       Systems (CWIS).  In  addition,  Lynx  can  be  used  to  build  systems
28       isolated within a single LAN.
29

OPTIONS

31       At  start  up, Lynx will load any local file or remote URL specified at
32       the command line.  For help with URLs, press "?"  or "H" while  running
33       Lynx.  Then follow the link titled, "Help on URLs."
34
35       If  more  than  one  local  file or remote URL is listed on the command
36       line, Lynx will open only the last interactively.   All  of  the  names
37       (local files and remote URLs) are added to the G)oto history.
38
39       Lynx  uses  only  long option names. Option names can begin with double
40       dash as well, underscores and dashes can be intermixed in option  names
41       (in  the reference below options are with one dash before them and with
42       underscores).
43
44       Lynx provides many command-line options.  Some options require a  value
45       (string,  number  or keyword).  These are noted in the reference below.
46       The other options set boolean values in the program.  There  are  three
47       types of boolean options: set, unset and toggle.  If no option value is
48       given, these have the obvious meaning: set (to true), unset (to false),
49       or  toggle  (between  true/false).  For any of these, an explicit value
50       can  be  given  in  different  forms  to  allow  for  operating  system
51       constraints, e.g.,
52              -center:off
53              -center=off
54              -center-
55       Lynx  recognizes  "1",  "+",  "on" and "true" for true values, and "0",
56       "-", "off" and "false"  for  false  values.   Other  option-values  are
57       ignored.
58
59       The  default boolean, number and string option values that are compiled
60       into Lynx are displayed in the help-message  provided  by  lynx  -help.
61       Some  of those may differ according to how Lynx was built; see the help
62       message itself for these values.  The -help option is processed in  the
63       third  pass of options-processing, so any option which sets a value, as
64       well as runtime configuration values are reflected in the help-message.
65
66       -      If the argument is only '-', then Lynx expects  to  receive  the
67              arguments  from  the  standard  input.  This is to allow for the
68              potentially very long command line that can be  associated  with
69              the  -get_data or -post_data arguments (see below).  It can also
70              be used to avoid having sensitive information  in  the  invoking
71              command  line (which would be visible to other processes on most
72              systems), especially when the -auth or -pauth options are used.
73
74       -accept_all_cookies
75              accept all cookies.
76
77       -anonymous
78              apply   restrictions   for   anonymous   account,    see    also
79              -restrictions.
80
81       -assume_charset=MIMEname
82              charset for documents that don't specify it.
83
84       -assume_local_charset=MIMEname
85              charset  assumed for local files, i.e., files which Lynx creates
86              such as internal pages for the options menu.
87
88       -assume_unrec_charset=MIMEname
89              use this instead of unrecognized charsets.
90
91       -auth=ID:PASSWD
92              set authorization ID and password  for  protected  documents  at
93              startup.   Be  sure  to  protect any script files which use this
94              switch.
95
96       -base  prepend a request URL comment and BASE tag to text/html  outputs
97              for -source dumps.
98
99       -bibp=URL
100              specify a local bibp server (default http://bibhost/).
101
102       -blink forces  high  intensity  background  colors  for  color mode, if
103              available and supported by the terminal.  This  applies  to  the
104              slang  library  (for  a  few terminal emulators), or to OS/2 EMX
105              with ncurses.
106
107       -book  use the bookmark page as the startfile.  The default or  command
108              line  startfile  is  still  set for the Main screen command, and
109              will be used if the bookmark page is unavailable or blank.
110
111       -buried_news
112              toggles scanning of news articles  for  buried  references,  and
113              converts  them  to  news  links.   Not recommended because email
114              addresses enclosed in angle brackets will be converted to  false
115              news links, and uuencoded messages can be trashed.
116
117       -cache=NUMBER
118              set  the  NUMBER  of documents cached in memory.  The default is
119              10.
120
121       -case  enable case-sensitive string searching.
122
123       -center
124              Toggle center alignment in HTML TABLE.
125
126       -cfg=FILENAME
127              specifies a Lynx  configuration  file  other  than  the  default
128              lynx.cfg.
129
130       -child exit  on  left-arrow  in startfile, and disable save to disk and
131              associated print/mail options.
132
133       -child_relaxed
134              exit on left-arrow in startfile, but  allow  save  to  disk  and
135              associated print/mail options.
136
137       -cmd_log=FILENAME
138              write   keystroke   commands  and  related  information  to  the
139              specified file.
140
141       -cmd_script=FILENAME
142              read keystroke commands from the specified file.   You  can  use
143              the  data  written  using the -cmd_log option.  Lynx will ignore
144              other information which the command-logging may have written  to
145              the  logfile.  Each line of the command script contains either a
146              comment beginning with "#", or a keyword:
147
148            exit causes  the  script  to  stop,  and  forces  Lynx   to   exit
149                 immediately.
150
151            key  the  character  value,  in  printable form.  Cursor and other
152                 special  keys  are  given  as  names,  e.g.,  "Down   Arrow".
153                 Printable  7-bit ASCII codes are given as-is, and hexadecimal
154                 values represent other 8-bit codes.
155
156            set  followed by a "name=value" allows one to override values  set
157                 in the lynx.cfg file.
158
159       -color forces  color  mode  on,  if  available.   Default color control
160              sequences which work for many terminal types are assumed if  the
161              terminal  capability  description does not specify how to handle
162              color.  Lynx needs to be compiled with  the  slang  library  for
163              this flag, it is equivalent to setting the COLORTERM environment
164              variable.  (If color support is instead  provided  by  a  color-
165              capable  curses  library like ncurses, Lynx relies completely on
166              the terminal description to  determine  whether  color  mode  is
167              possible,  and this flag is not needed and thus unavailable.)  A
168              saved show_color=always setting  found  in  a  .lynxrc  file  at
169              startup  has the same effect.  A saved show_color=never found in
170              .lynxrc on startup is overridden by this flag.
171
172       -connect_timeout=N
173              Sets the connection timeout, where N is given in seconds.
174
175       -cookie_file=FILENAME
176              specifies a file to use to read cookies.  If none is  specified,
177              the  default  value  is  ~/.lynx_cookies  for  most systems, but
178              ~/cookies for MS-DOS.
179
180       -cookie_save_file=FILENAME
181              specifies a file to use to store cookies.  If none is specified,
182              the value given by -cookie_file is used.
183
184       -cookies
185              toggles handling of Set-Cookie headers.
186
187       -core  toggles forced core dumps on fatal errors.  Turn this option off
188              to ask Lynx to force a core dump if a fatal error occurs.
189
190       -crawl with -traversal, output each page to a file.  with -dump, format
191              output as with -traversal, but to the standard output.
192
193       -curses_pads
194              toggles   the   use  of  curses  "pad"  feature  which  supports
195              left/right scrolling of the display.
196
197       -debug_partial
198              separate incremental display stages with MessageSecs delay
199
200       -delay add DebugSecs delay after each progress-message
201
202       -display=DISPLAY
203              set the display variable for X rexec-ed programs.
204
205       -display_charset=MIMEname
206              set the charset for the terminal output.
207
208       -dont_wrap_pre
209              inhibit wrapping of text in <pre> when -dump'ing and -crawl'ing,
210              mark wrapped lines in interactive session.
211
212       -dump  dumps  the  formatted  output  of  the default document or those
213              specified on  the  command  line  to  standard  output.   Unlike
214              interactive mode, all documents are processed.  This can be used
215              in the following way:
216
217              lynx -dump http://www.subir.com/lynx.html
218
219       -editor=EDITOR
220              enable external editing, using the specified  EDITOR.  (vi,  ed,
221              emacs, etc.)
222
223       -emacskeys
224              enable emacs-like key movement.
225
226       -enable_scrollback
227              toggles  compatibility  with  communication programs' scrollback
228              keys (may be incompatible with some curses packages).
229
230       -error_file=FILE
231              define a file where Lynx will report HTTP access codes.
232
233       -exec  enable local program execution (normally not configured).
234
235       -fileversions
236              include all versions of files in local VMS directory listings.
237
238       -find_leaks
239              toggle memory leak-checking.  Normally this is not compiled-into
240              your  executable,  but  when  it  is,  it  can be disabled for a
241              session.
242
243       -force_empty_hrefless_a
244              force HREF-less 'A' elements to be empty (close them as soon  as
245              they are seen).
246
247       -force_html
248              forces the first document to be interpreted as HTML.
249
250       -force_secure
251              toggles forcing of the secure flag for SSL cookies.
252
253       -forms_options
254              toggles whether the Options Menu is key-based or form-based.
255
256       -from  toggles transmissions of From headers.
257
258       -ftp   disable ftp access.
259
260       -get_data
261              properly  formatted  data  for  a  get form are read in from the
262              standard input and passed to the form.  Input is terminated by a
263              line that starts with '---'.
264
265       -head  send a HEAD request for the mime headers.
266
267       -help  print the Lynx command syntax usage message, and exit.
268
269       -hiddenlinks=[option]
270              control the display of hidden links.
271
272              merge hidden links show up as bracketed numbers and are numbered
273              together with other links in the sequence of their occurrence in
274              the document.
275
276              listonly  hidden  links  are  shown  only  on  L)ist screens and
277              listings generated by -dump or from the P)rint menu, but  appear
278              separately  at  the  end  of  those  lists.  This is the default
279              behavior.
280
281              ignore hidden links do not appear even in listings.
282
283       -historical
284              toggles use of '>' or '-->' as a terminator for comments.
285
286       -homepage=URL
287              set homepage separate from start page.
288
289       -image_links
290              toggles inclusion of links for all images.
291
292       -index=URL
293              set the default index file to the specified URL.
294
295       -ismap toggles inclusion of  ISMAP  links  when  client-side  MAPs  are
296              present.
297
298       -justify
299              do justification of text.
300
301       -link=NUMBER
302              starting count for lnk#.dat files produced by -crawl.
303
304       -listonly
305              for -dump, show only the list of links.
306
307       -localhost
308              disable URLs that point to remote hosts.
309
310       -locexec
311              enable  local  program  execution from local files only (if Lynx
312              was compiled with local execution enabled).
313
314       -lss=FILENAME
315              specify  filename  containing  color-style   information.    The
316              default is lynx.lss.  If you give an empty filename, lynx uses a
317              built-in monochrome scheme which  imitates  the  non-color-style
318              configuration.
319
320       -mime_header
321              prints  the  MIME  header  of  a fetched document along with its
322              source.
323
324       -minimal
325              toggles minimal versus valid comment parsing.
326
327       -nested_tables
328              toggles nested-tables logic (for debugging).
329
330       -newschunksize=NUMBER
331              number of articles in chunked news listings.
332
333       -newsmaxchunk=NUMBER
334              maximum news articles in listings before chunking.
335
336       -nobold
337              disable bold video-attribute.
338
339       -nobrowse
340              disable directory browsing.
341
342       -nocc  disable Cc: prompts for self copies of mailings.  Note that this
343              does  not disable any CCs which are incorporated within a mailto
344              URL or form ACTION.
345
346       -nocolor
347              force color mode off, overriding terminal capabilities  and  any
348              -color flags, COLORTERM variable, and saved .lynxrc settings.
349
350       -noexec
351              disable local program execution. (DEFAULT)
352
353       -nofilereferer
354              disable transmissions of Referer headers for file URLs.
355
356       -nolist
357              disable the link list feature in dumps.
358
359       -nolog disable mailing of error messages to document owners.
360
361       -nomargins
362              disable left/right margins in the default style sheet.
363
364       -nomore
365              disable -more- string in statusline messages.
366
367       -nonrestarting_sigwinch
368              This  flag  is  not  available  on all systems, Lynx needs to be
369              compiled with HAVE_SIGACTION defined.  If available,  this  flag
370              may  cause Lynx to react more immediately to window changes when
371              run within an xterm.
372
373       -nonumbers
374              disable   link-    and    field-numbering.     This    overrides
375              -number_fields and -number_links.
376
377       -nopause
378              disable forced pauses for statusline messages.
379
380       -noprint
381              disable most print functions.
382
383       -noredir
384              prevents  automatic redirection and prints a message with a link
385              to the new URL.
386
387       -noreferer
388              disable transmissions of Referer headers.
389
390       -noreverse
391              disable reverse video-attribute.
392
393       -nosocks
394              disable SOCKS proxy usage by a SOCKSified Lynx.
395
396       -nostatus
397              disable the retrieval status messages.
398
399       -notitle
400              disable title and blank line from top of page.
401
402       -nounderline
403              disable underline video-attribute.
404
405       -number_fields
406              force numbering of links as well as form input fields
407
408       -number_links
409              force numbering of links.
410
411       -partial
412              toggles display partial pages while loading.
413
414       -partial_thres=NUMBER
415              number  of  lines  to  render  before  repainting  display  with
416              partial-display logic
417
418       -passive-ftp
419              toggles passive ftp connections.
420
421       -pauth=ID:PASSWD
422              set  authorization  ID and password for a protected proxy server
423              at startup.  Be sure to protect any script files which use  this
424              switch.
425
426       -popup toggles  handling  of  single-choice  SELECT  options  via popup
427              windows or as lists of radio buttons.
428
429       -post_data
430              properly formatted data for a post form are  read  in  from  the
431              standard input and passed to the form.  Input is terminated by a
432              line that starts with '---'.
433
434       -preparsed
435              show HTML  source  preparsed  and  reformatted  when  used  with
436              -source or in source view.
437
438       -prettysrc
439              show HTML source view with lexical elements and tags in color.
440
441       -print enable print functions. (default)
442
443       -pseudo_inlines
444              toggles pseudo-ALTs for inline images with no ALT string.
445
446       -raw   toggles  default  setting of 8-bit character translations or CJK
447              mode for the startup character set.
448
449       -realm restricts access to URLs in the starting realm.
450
451       -read_timeout=N
452              Sets the read-timeout, where N is given in seconds.
453
454       -reload
455              flushes the cache on a proxy server  (only  the  first  document
456              affected).
457
458       -restrictions=[option][,option][,option]...
459              allows a list of services to be disabled selectively. Dashes and
460              underscores in option names can  be  intermixed.  The  following
461              list is printed if no options are specified.
462
463              all - restricts all options listed below.
464
465              bookmark - disallow changing the location of the bookmark file.
466
467              bookmark_exec - disallow execution links via the bookmark file.
468
469              change_exec_perms  - disallow changing the eXecute permission on
470              files (but still allow  it  for  directories)  when  local  file
471              management is enabled.
472
473              default  -  same  as  command  line option -anonymous.  Disables
474              default services for anonymous users.  Set  to  all  restricted,
475              except    for:    inside_telnet,   outside_telnet,   inside_ftp,
476              outside_ftp,   inside_rlogin,    outside_rlogin,    inside_news,
477              outside_news,  telnet_port,  jump,  mail, print, exec, and goto.
478              The settings for these, as well as additional goto  restrictions
479              for specific URL schemes that are also applied, are derived from
480              definitions within userdefs.h.
481
482              dired_support - disallow local file management.
483
484              disk_save - disallow saving to disk in the  download  and  print
485              menus.
486
487              dotfiles  -  disallow  access  to,  or creation of, hidden (dot)
488              files.
489
490              download - disallow some downloaders in the download menu  (does
491              not imply disk_save restriction).
492
493              editor - disallow external editing.
494
495              exec - disable execution scripts.
496
497              exec_frozen   -  disallow  the  user  from  changing  the  local
498              execution option.
499
500              externals - disallow  some  "EXTERNAL"  configuration  lines  if
501              support  for  passing  URLs  to  external applications (with the
502              EXTERN command) is compiled in.
503
504              file_url - disallow using G)oto, served links or  bookmarks  for
505              file: URLs.
506
507              goto - disable the 'g' (goto) command.
508
509              inside_ftp  -  disallow  ftps for people coming from inside your
510              domain (utmp required for selectivity).
511
512              inside_news - disallow USENET news  posting  for  people  coming
513              from inside your domain (utmp required for selectivity).
514
515              inside_rlogin  -  disallow rlogins for people coming from inside
516              your domain (utmp required for selectivity).
517
518              inside_telnet - disallow telnets for people coming  from  inside
519              your domain (utmp required for selectivity).
520
521              jump - disable the 'j' (jump) command.
522
523              multibook - disallow multiple bookmarks.
524
525              mail - disallow mail.
526
527              news_post - disallow USENET News posting.
528
529              options_save - disallow saving options in .lynxrc.
530
531              outside_ftp  - disallow ftps for people coming from outside your
532              domain (utmp required for selectivity).
533
534              outside_news - disallow USENET  news  reading  and  posting  for
535              people  coming  from  outside  your  domain  (utmp  required for
536              selectivity).   This  restriction  applies  to  "news",  "nntp",
537              "newspost",   and   "newsreply"   URLs,   but  not  to  "snews",
538              "snewspost", or "snewsreply" in case they are supported.
539
540              outside_rlogin - disallow rlogins for people coming from outside
541              your domain (utmp required for selectivity).
542
543              outside_telnet - disallow telnets for people coming from outside
544              your domain (utmp required for selectivity).
545
546              print - disallow most print options.
547
548              shell - disallow shell escapes and lynxexec or lynxprog G)oto's.
549
550              suspend - disallow Unix Control-Z suspends with escape to shell.
551
552              telnet_port - disallow specifying a port in telnet G)oto's.
553
554              useragent - disallow modifications of the User-Agent header.
555
556       -resubmit_posts
557              toggles forced resubmissions (no-cache)  of  forms  with  method
558              POST  when  the  documents  they  returned  are  sought with the
559              PREV_DOC command or from the History List.
560
561       -rlogin
562              disable recognition of rlogin commands.
563
564       -scrollbar
565              toggles showing scrollbar.
566
567       -scrollbar_arrow
568              toggles showing arrows at ends of the scrollbar.
569
570       -selective
571              require .www_browsable files to browse directories.
572
573       -session=FILENAME
574              resumes from specified file on startup and saves session to that
575              file on exit.
576
577       -sessionin=FILENAME
578              resumes session from specified file.
579
580       -sessionout=FILENAME
581              saves session to specified file.
582
583       -short_url
584              show  very  long URLs in the status line with "..." to represent
585              the portion which cannot be displayed.  The beginning and end of
586              the URL are displayed, rather than suppressing the end.
587
588       -show_cfg
589              Print the configuration settings, e.g., as read from "lynx.cfg",
590              and exit.
591
592       -show_cursor
593              If enabled the cursor will not  be  hidden  in  the  right  hand
594              corner  but  will  instead  be  positioned  at  the start of the
595              currently selected link.  Show cursor is the default for systems
596              without  FANCY_CURSES  capabilities.   The default configuration
597              can be changed in userdefs.h  or  lynx.cfg.   The  command  line
598              switch toggles the default.
599
600       -show_rate
601              If  enabled  the  transfer  rate  is  shown in bytes/second.  If
602              disabled, no transfer  rate  is  shown.   Use  lynx.cfg  or  the
603              options menu to select KB/second and/or ETA.
604
605       -soft_dquotes
606              toggles  emulation  of  the  old  Netscape  and Mosaic bug which
607              treated '>' as a co-terminator for double-quotes and tags.
608
609       -source
610              works the same as  dump  but  outputs  HTML  source  instead  of
611              formatted text.  For example
612
613              lynx -source . >foo.html
614
615              generates   HTML   source  listing  the  files  in  the  current
616              directory.  Each file is marked  by  an  HREF  relative  to  the
617              parent  directory.   Add  a  trailing  slash  to make the HREF's
618              relative to the current directory:
619
620              lynx -source ./ >foo.html
621
622       -stack_dump
623              disable SIGINT cleanup handler
624
625       -startfile_ok
626              allow non-http startfile and homepage with -validate.
627
628       -stderr
629              When dumping a document using -dump or  -source,  Lynx  normally
630              does  not  display  alert  (error)  messages that you see on the
631              screen in the status line.  Use the -stderr option to tell  Lynx
632              to write these messages to the standard error.
633
634       -stdin read the startfile from standard input (UNIX only).
635
636       -syslog=text
637              information for syslog call.
638
639       -syslog-urls
640              log requested URLs with syslog.
641
642       -tagsoup
643              initialize parser, using Tag Soup DTD rather than SortaSGML.
644
645       -telnet
646              disable recognition of telnet commands.
647
648       -term=TERM
649              tell  Lynx what terminal type to assume it is talking to.  (This
650              may be useful for remote  execution,  when,  for  example,  Lynx
651              connects  to  a remote TCP/IP port that starts a script that, in
652              turn, starts another Lynx process.)
653
654       -timeout=N
655              For win32, sets the network read-timeout, where N  is  given  in
656              seconds.
657
658       -tlog  toggles  between  using  a  Lynx  Trace Log and stderr for trace
659              output from the session.
660
661       -tna   turns on "Textfields Need Activation" mode.
662
663       -trace turns on Lynx trace mode.  Destination of trace  output  depends
664              on -tlog.
665
666       -trace_mask=value
667              turn  on  optional  traces, which may result in very large trace
668              files.  Logically OR the values to combine options:
669              1=SGML character parsing states
670              2=color-style
671              4=TRST (table layout)
672              8=config  (lynx.cfg,  .lynxrc,  .lynx-keymaps,  mime.types   and
673              mailcap contents)
674              16=binary string copy/append, used in form data construction.
675              32=cookies
676              64=character sets
677              128=GridText parsing
678              256=timing
679
680       -traversal
681              traverse  all http links derived from startfile.  When used with
682              -crawl, each link that begins with the same string as  startfile
683              is  output to a file, intended for indexing.  See CRAWL.announce
684              for more information.
685
686       -trim_input_fields
687              trim input text/textarea fields in forms.
688
689       -underline_links
690              toggles use of underline/bold attribute for links.
691
692       -underscore
693              toggles use of _underline_ format in dumps.
694
695       -use_mouse
696              turn on mouse support, if available.  Clicking  the  left  mouse
697              button  on a link traverses it.  Clicking the right mouse button
698              pops back.  Click on the top line to scroll up.   Click  on  the
699              bottom  line to scroll down.  The first few positions in the top
700              and bottom line may invoke additional functions.  Lynx  must  be
701              compiled  with  ncurses  or  slang  to support this feature.  If
702              ncurses is used, clicking the middle  mouse  button  pops  up  a
703              simple  menu.  Mouse clicks may only work reliably while Lynx is
704              idle waiting for input.
705
706       -useragent=Name
707              set alternate Lynx User-Agent header.
708
709       -validate
710              accept only  http  URLs  (for  validation).   Complete  security
711              restrictions also are implemented.
712
713       -verbose
714              toggle  [LINK],  [IMAGE] and [INLINE] comments with filenames of
715              these images.
716
717       -version
718              print version information, and exit.
719
720       -vikeys
721              enable vi-like key movement.
722
723       -wdebug
724              enable Waterloo tcp/ip packet debug (print to  watt  debugfile).
725              This  applies  only  to  DOS  versions  compiled  with WATTCP or
726              WATT-32.
727
728       -width=NUMBER
729              number of columns for formatting of dumps, default is 80.   This
730              is  limited  by  the  number of columns that Lynx could display,
731              typically 1024 (the MAX_LINE symbol).
732
733       -with_backspaces
734              emit backspaces in output if -dump'ing or -crawl'ing (like 'man'
735              does)
736
737       -xhtml_parsing
738              tells Lynx that it can ignore certain tags which have no content
739              in an XHTML 1.0 document.  For example "<p/>" will be discarded.
740

COMMANDS

742       o  Use Up arrow and Down arrow to scroll through hypertext links.
743
744       o  Right arrow or Return will follow a highlighted hypertext link.
745
746       o  Left Arrow will retreat from a link.
747
748       o  Type "H" or "?" for  online  help  and  descriptions  of  key-stroke
749          commands.
750
751       o  Type  "K"  for  a  complete  list  of the current key-stroke command
752          mappings.
753

ENVIRONMENT

755       In addition to various "standard" environment variables such  as  HOME,
756       PATH,  USER,  DISPLAY, TMPDIR, etc, Lynx utilizes several Lynx-specific
757       environment variables, if they exist.
758
759       Others may be created or modified by Lynx to pass data to  an  external
760       program, or for other reasons.  These are listed separately below.
761
762       See  also  the  sections  on  SIMULATED CGI SUPPORT and NATIVE LANGUAGE
763       SUPPORT, below.
764
765       Note:  Not all environment variables apply to all  types  of  platforms
766       supported  by  Lynx, though most do.  Feedback on platform dependencies
767       is solicited.
768
769       Environment Variables Used By Lynx:
770
771       COLORTERM           If set, color capability for the terminal is forced
772                           on  at  startup time.  The actual value assigned to
773                           the variable is ignored.   This  variable  is  only
774                           meaningful  if  Lynx  was  built  using  the  slang
775                           screen-handling library.
776
777       LYNX_CFG            This variable, if set, will  override  the  default
778                           location  and name of the global configuration file
779                           (normally,  lynx.cfg)  that  was  defined  by   the
780                           LYNX_CFG_FILE  constant  in  the  userdefs.h  file,
781                           during installation.  See the userdefs.h  file  for
782                           more information.
783
784       LYNX_HELPFILE       If set, this variable overrides the compiled-in URL
785                           and configuration file URL for the Lynx help file.
786
787       LYNX_LOCALEDIR      If set, this  variable  overrides  the  compiled-in
788                           location  of  the  locale  directory which contains
789                           native language (NLS) message text.
790
791       LYNX_LSS            This variable, if set, specifies  the  location  of
792                           the   default  Lynx  character  style  sheet  file.
793                           [Currently only meaningful if Lynx was built  using
794                           experimental color style support.]
795
796       LYNX_SAVE_SPACE     This  variable,  if  set, will override the default
797                           path prefix for files saved to disk that is defined
798                           in  the  lynx.cfg  SAVE_SPACE:  statement.  See the
799                           lynx.cfg file for more information.
800
801       LYNX_TEMP_SPACE     This variable, if set, will  override  the  default
802                           path  prefix  for  temporary files that was defined
803                           during installation, as well as any value that  may
804                           be assigned to the TMPDIR variable.
805
806       MAIL                This variable specifies the default inbox Lynx will
807                           check for new mail, if such checking is enabled  in
808                           the lynx.cfg file.
809
810       NEWS_ORGANIZATION   This  variable, if set, provides the string used in
811                           the Organization: header of USENET  news  postings.
812                           It  will  override  the setting of the ORGANIZATION
813                           environment variable, if it is also  set  (and,  on
814                           UNIX, the contents of an /etc/organization file, if
815                           present).
816
817       NNTPSERVER          If set, this variable specifies  the  default  NNTP
818                           server  that  will  be used for USENET news reading
819                           and posting with Lynx, via news: URL's.
820
821       ORGANIZATION        This variable, if set, provides the string used  in
822                           the  Organization:  header of USENET news postings.
823                           On UNIX,  it  will  override  the  contents  of  an
824                           /etc/organization file, if present.
825
826       PROTOCOL_proxy      Lynx supports the use of proxy servers that can act
827                           as firewall gateways and caching servers.  They are
828                           preferable   to  the  older  gateway  servers  (see
829                           WWW_access_GATEWAY, below).  Each protocol used  by
830                           Lynx,  (http,  ftp,  gopher,  etc),  can  be mapped
831                           separately by setting environment variables of  the
832                           form    PROTOCOL_proxy    (literally:   http_proxy,
833                           ftp_proxy,       gopher_proxy,       etc),       to
834                           "http://some.server.dom:port/".    See  Lynx  Users
835                           Guide for additional details and examples.
836
837       SSL_CERT_DIR        Set   to   the   directory    containing    trusted
838                           certificates.
839
840       SSL_CERT_FILE       Set  to the full path and filename for your file of
841                           trusted certificates.
842
843       WWW_access_GATEWAY  Lynx still supports use of  gateway  servers,  with
844                           the   servers  specified  via  "WWW_access_GATEWAY"
845                           variables (where "access" is lower case and can  be
846                           "http",  "ftp",  "gopher"  or "wais"), however most
847                           gateway servers have been discontinued.  Note  that
848                           you do not include a terminal '/' for gateways, but
849                           do  for   proxies   specified   by   PROTOCOL_proxy
850                           environment  variables.   See  Lynx Users Guide for
851                           details.
852
853       WWW_HOME            This variable, if set, will  override  the  default
854                           startup   URL   specified   in   any  of  the  Lynx
855                           configuration files.
856
857       Environment Variables Set or Modified By Lynx:
858
859       LYNX_PRINT_DATE     This variable is set by the Lynx p(rint)  function,
860                           to   the   Date:  string  seen  in  the  document's
861                           "Information about" page (= cmd), if  any.   It  is
862                           created  for use by an external program, as defined
863                           in a lynx.cfg PRINTER:  definition  statement.   If
864                           the  field  does  not  exist  for the document, the
865                           variable is set to a null string under UNIX, or "No
866                           Date" under VMS.
867
868       LYNX_PRINT_LASTMOD  This  variable is set by the Lynx p(rint) function,
869                           to the Last Mod:  string  seen  in  the  document's
870                           "Information  about"  page  (= cmd), if any.  It is
871                           created for use by an external program, as  defined
872                           in  a  lynx.cfg  PRINTER: definition statement.  If
873                           the field does not  exist  for  the  document,  the
874                           variable is set to a null string under UNIX, or "No
875                           LastMod" under VMS.
876
877       LYNX_PRINT_TITLE    This variable is set by the Lynx p(rint)  function,
878                           to  the  Linkname:  string  seen  in the document's
879                           "Information about" page (= cmd), if  any.   It  is
880                           created  for use by an external program, as defined
881                           in a lynx.cfg PRINTER:  definition  statement.   If
882                           the  field  does  not  exist  for the document, the
883                           variable is set to a null string under UNIX, or "No
884                           Title" under VMS.
885
886       LYNX_PRINT_URL      This  variable is set by the Lynx p(rint) function,
887                           to  the  URL:  string  seen   in   the   document's
888                           "Information  about"  page  (= cmd), if any.  It is
889                           created for use by an external program, as  defined
890                           in  a  lynx.cfg  PRINTER: definition statement.  If
891                           the field does not  exist  for  the  document,  the
892                           variable is set to a null string under UNIX, or "No
893                           URL" under VMS.
894
895       LYNX_TRACE          If set, causes Lynx to write a trace file as if the
896                           -trace option were supplied.
897
898       LYNX_TRACE_FILE     If set, overrides the compiled-in name of the trace
899                           file, which is either  Lynx.trace  or  LY-TRACE.LOG
900                           (the  latter  on the DOS platform).  The trace file
901                           is in either case relative to the home directory.
902
903       LYNX_VERSION        This variable is always set by  Lynx,  and  may  be
904                           used  by an external program to determine if it was
905                           invoked by Lynx.  See  also  the  comments  in  the
906                           distribution's  sample  mailcap  file, for notes on
907                           usage in such a file.
908
909       TERM                Normally,  this  variable  is  used  by   Lynx   to
910                           determine  the  terminal  type being used to invoke
911                           Lynx.  If, however, it is unset at startup time (or
912                           has  the value "unknown"), or if the -term command-
913                           line option is used (see  OPTIONS  section  above),
914                           Lynx  will  set  or  modify  its  value to the user
915                           specified terminal type  (for  the  Lynx  execution
916                           environment).   Note:  If set/modified by Lynx, the
917                           values of  the  LINES  and/or  COLUMNS  environment
918                           variables may also be changed.
919

SIMULATED CGI SUPPORT

921       If built with the cgi-links option enabled, Lynx allows access to a cgi
922       script directly without the need for an http daemon.
923
924       When executing such  "lynxcgi  scripts"  (if  enabled),  the  following
925       variables may be set for simulating a CGI environment:
926
927       CONTENT_LENGTH
928
929       CONTENT_TYPE
930
931       DOCUMENT_ROOT
932
933       HTTP_ACCEPT_CHARSET
934
935       HTTP_ACCEPT_LANGUAGE
936
937       HTTP_USER_AGENT
938
939       PATH_INFO
940
941       PATH_TRANSLATED
942
943       QUERY_STRING
944
945       REMOTE_ADDR
946
947       REMOTE_HOST
948
949       REQUEST_METHOD
950
951       SERVER_SOFTWARE
952
953       Other  environment  variables  are  not inherited by the script, unless
954       they  are  provided  via  a  LYNXCGI_ENVIRONMENT   statement   in   the
955       configuration  file.   See  the  lynx.cfg file, and the (draft) CGI 1.1
956       Specification <http://Web.Golux.Com/coar/cgi/draft-coar-cgi-v11-00.txt>
957       for the definition and usage of these variables.
958
959       The  CGI  Specification,  and other associated documentation, should be
960       consulted for general information on CGI script programming.
961

NATIVE LANGUAGE SUPPORT

963       If configured and installed with Native  Language  Support,  Lynx  will
964       display status and other messages in your local language.  See the file
965       ABOUT_NLS in the source distribution, or at your local  GNU  site,  for
966       more information about internationalization.
967
968       The  following  environment  variables  may  be  used  to alter default
969       settings:
970
971       LANG                This variable, if set, will  override  the  default
972                           message language.  It is an ISO 639 two-letter code
973                           identifying the language.  Language codes  are  NOT
974                           the same as the country codes given in ISO 3166.
975
976       LANGUAGE            This  variable,  if  set, will override the default
977                           message language.  This is a GNU extension that has
978                           higher  priority  for  setting  the message catalog
979                           than LANG or LC_ALL.
980
981       LC_ALL              and
982
983       LC_MESSAGES         These variables, if  set,  specify  the  notion  of
984                           native language formatting style.  They are POSIXly
985                           correct.
986
987       LINGUAS             This  variable,  if  set  prior  to  configuration,
988                           limits  the installed languages to specific values.
989                           It is a space-separated list of  two-letter  codes.
990                           Currently, it is hard-coded to a wish list.
991
992       NLSPATH             This  variable,  if set, is used as the path prefix
993                           for message catalogs.
994

NOTES

996       This is the Lynx v2.8.7 Release; development is in progress for 2.8.8.
997
998       If you wish to contribute to the further development of Lynx, subscribe
999       to  our mailing list.  Send email to <lynx-dev-request@nongnu.org> with
1000       "subscribe lynx-dev" as the only line in the body of your message.
1001
1002       Send bug reports, comments, suggestions to <lynx-dev@nongnu.org>  after
1003       subscribing.
1004
1005       Unsubscribe  by  sending  email  to  <lynx-dev-request@nongnu.org> with
1006       "unsubscribe lynx-dev" as the only line in the body  of  your  message.
1007       Do not send the unsubscribe message to the lynx-dev list, itself.
1008

SEE ALSO

1010       catgets(3),  curses(3),  environ(7),  execve(2),  ftp(1), gettext(GNU),
1011       localeconv(3),   ncurses(3),   setlocale(3),   slang(?),    termcap(5),
1012       terminfo(5), wget(GNU)
1013
1014       Note that man page availability and section numbering is somewhat plat‐
1015       form dependent, and may vary from the above references.
1016
1017       A section shown as (GNU), is intended to denote that the topic  may  be
1018       available via an info page, instead of a man page (i.e., try "info sub‐
1019       ject", rather than "man subject").
1020
1021       A section shown as (?) denotes that documentation on the topic  exists,
1022       but  is  not part of an established documentation retrieval system (see
1023       the distribution files associated with the topic, or contact your  Sys‐
1024       tem Administrator for further information).
1025

ACKNOWLEDGMENTS

1027       Lynx  has  incorporated  code  from a variety of sources along the way.
1028       The earliest versions of Lynx included code from Earl Fogel of  Comput‐
1029       ing  Services at the University of Saskatchewan, who implemented HYPER‐
1030       REZ in the Unix environment.  HYPERREZ was developed by Niel Larson  of
1031       Think.com  and  served  as  the  model  for the early versions of Lynx.
1032       Those versions also incorporated libraries from the Unix Gopher clients
1033       developed  at  the  University  of Minnesota, and the later versions of
1034       Lynx rely on the WWW client library code developed by  Tim  Berners-Lee
1035       and  the  WWW  community.  Also a special thanks to Foteos Macrides who
1036       ported much of Lynx to VMS and did or organized most of its development
1037       since  the  departures of Lou Montulli and Garrett Blythe from the Uni‐
1038       versity of Kansas in the summer of 1994 through the release of  v2.7.2,
1039       and  to  everyone  on the net who has contributed to Lynx's development
1040       either directly (through patches, comments or bug reports) or indirect‐
1041       ly (through inspiration and development of other systems).
1042

AUTHORS

1044       Lou  Montulli,  Garrett  Blythe, Craig Lavender, Michael Grobe, Charles
1045       Rezac
1046       Academic Computing Services
1047       University of Kansas
1048       Lawrence, Kansas 66047
1049
1050       Foteos Macrides
1051       Worcester Foundation for Biomedical Research
1052       Shrewsbury, Massachusetts 01545
1053
1054       Thomas E. Dickey
1055       <dickey@invisible-island.net>
1056
1057
1058
1059                                                                       LYNX(1)
Impressum