summaryrefslogtreecommitdiff
path: root/gnu/usr.bin/lynx/lynx.man
blob: 04bfe6dc4342c902ed8ff09238c6d9224c604a16 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
.nr N -1
.nr D 5
.TH LYNX 1 Local
.UC 4
.SH NAME
lynx \- a general purpose distributed information browser for the World Wide Web
.SH SYNOPSIS
.B lynx
[options] [path or URL]
.PP
use "lynx -help" to display a complete list of current options.
.SH DESCRIPTION
.\" This defines appropriate quote strings for nroff and troff
.ds lq \&"
.ds rq \&"
.if t .ds lq ``
.if t .ds rq ''
.\" Just in case these number registers aren't set yet...
.if \nN==0 .nr N 10
.if \nD==0 .nr D 5
.I
Lynx
is a fully-featured World Wide Web (WWW) client for users
running cursor-addressable, character-cell display devices (e.g.,
vt100 terminals, vt100 emulators running on Windows 95/NT or Macintoshes, 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
.I
Lynx
run on
Unix, VMS, Windows 95/NT, 386DOS and OS/2 EMX.
.PP
.I
Lynx
can be used to access information on the World Wide Web, or
to build information systems intended primarily for local access.
For example,
.I
Lynx
has been used to build several Campus Wide
Information Systems (CWIS).  In addition,
.I
Lynx
can be used to
build systems isolated within a single LAN.
.SH OPTIONS
At start up, \fILynx\fR will load any local
file or remote URL specified at the command
line.  For help with URLs, press \fB"?"\fR
or \fB"H"\fR while running \fILynx\fR.
Then follow the link titled, "Help on URLs."

\fILynx\fR uses only long option names. Option
names can begin with double dash as well,
underscores and dashes can be intermixed in
option names (in the reference below options
are with one dash before them and with underscores).
.PP
.TP
.B -
If the argument is only '-', then Lynx expects to receive
the arguments from stdin.  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 systems), especially when
the -auth or -pauth options are used.
.TP
.B -accept_all_cookies
accept all cookies.
.TP
.B -anonymous
apply restrictions for anonymous account, see also -restrictions.
.TP
.B -assume_charset\fR=\fIMIMEname
charset for documents that don't specify it.
.TP
.B -assume_local_charset\fR=\fIMIMEname
charset assumed for local files.
.TP
.B -assume_unrec_charset\fR=\fIMIMEname
use this instead of unrecognized charsets.
.TP
.B -auth\fR=\fIID\fR:\fIPASSWD
set authorization ID and password for protected documents
at startup.  Be sure to protect any script files which use
this switch.
.TP
.B -base
prepend a request URL comment and BASE tag to text/html
outputs for -source dumps.
.TP
.B -bibp\fR=\fIURL
specify a local bibp server (default http://bibhost/).
.TP
.B -blink
forces high intensity background colors for color mode, if available
and supported by the terminal.
This applies to the \fBslang\fR library (for a few terminal emulators),
or to OS/2 EMX with \fBncurses\fR.
.TP
.B -book
use the bookmark page as the startfile.  The default or command
line startfile is still set for the Main screen command, and will
be used if the bookmark page is unavailable or blank.
.TP
.B -buried_news
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 news links, and uuencoded messages can be trashed.
.TP
.B -cache\fR=\fINUMBER
set the NUMBER of documents cached in memory.
The default is 10.
.TP
.B -case
enable case-sensitive string searching.
.TP
.B -center
Toggle center alignment in HTML TABLE.
.TP
.B -cfg\fR=\fIFILENAME
specifies a Lynx configuration file other than the default
lynx.cfg.
.TP
.B -child
exit on left-arrow in startfile, and disable save to disk.
.TP
.B -cmd_log\fR=\fIFILENAME
write keystroke commands and related information to the specified file.
.TP
.B -cmd_script\fR=\fIFILENAME
read keystroke commands from the specified file.
You can use the data written using the \fB\-cmd_log\fR option.
Lynx will ignore other information which the command-logging may have
written to the logfile.
.TP
.B -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 \fBslang\fR library for this flag,
it is equivalent to setting the \fBCOLORTERM\fR environment variable.
(If color support is instead provided by a color-capable curses
library like \fBncurses\fR, 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 .lynxrc on startup is overridden by this flag.
.TP
.B -connect_timeout\fR=\fIN
Sets the connection timeout, where N is given in seconds.
This is not available under DOS (use the sockdelay
parameter of WATTCP under DOS).
.TP
.B -cookie_file\fR=\fIFILENAME
specifies a file to use to read cookies.
If none is specified, the default value is ~/.lynx_cookies
for most systems, but ~/cookies for MS-DOS.
.TP
.B -cookie_save_file\fR=\fIFILENAME
specifies a file to use to store cookies.
If none is specified, the value given by
\fB-cookie_file\fR is used.
.TP
.B -cookies
toggles handling of Set-Cookie headers.
.TP
.B -core
toggles forced core dumps on fatal errors.
.TP
.B -crawl
with -traversal, output each page to a file.
with -dump, format output as with -traversal, but to stdout.
.TP
.B -curses_pads
toggles the use of curses "pad" feature which supports
left/right scrolling of the display.
.TP
.B -debug_partial
separate incremental display stages with MessageSecs delay
.TP
.B -display\fR=\fIDISPLAY
set the display variable for X rexec-ed programs.
.TP
.B -display_charset\fR=\fIMIMEname
set the charset for the terminal output.
.TP
.B -dont_wrap_pre
inhibit wrapping of text in <pre> when -dump'ing and -crawl'ing, mark
wrapped lines in interactive session.
.TP
.B -dump
dumps the formatted output of the default document or one
specified on the command line to standard output.
This can be used in the following way:
.sp
lynx -dump http://www.trill-home.com/lynx.html
.TP
.B -editor\fR=\fIEDITOR
enable external editing, using the specified
EDITOR. (vi, ed, emacs, etc.)
.TP
.B -emacskeys
enable emacs-like key movement.
.TP
.B -enable_scrollback
toggles compatibility with communication programs' scrollback keys
(may be incompatible with some curses packages).
.TP
.B -error_file\fR=\fIFILE
define a file where Lynx will report HTTP access codes.
.TP
.B -exec
enable local program execution (normally not configured).
.TP
.B -fileversions
include all versions of files in local VMS directory listings.
.TP
.B -force_empty_hrefless_a
force HREF-less 'A' elements to be empty (close them as soon as they are seen).
.TP
.B -force_html
forces the first document to be interpreted as HTML.
.TP
.B -force_secure
toggles forcing of the secure flag for SSL cookies.
.TP
.B -forms_options
toggles whether the Options Menu is key-based or form-based.
.TP
.B -from
toggles transmissions of From headers.
.TP
.B -ftp
disable ftp access.
.TP
.B -get_data
properly formatted data for a get form are read in from
stdin and passed to the form.
Input is terminated by a line that starts with '---'.
.TP
.B -head
send a HEAD request for the mime headers.
.TP
.B -help
print the Lynx command syntax usage message.
.TP
.B -hiddenlinks=[option]
control the display of hidden links.

.I merge
hidden links show up as bracketed numbers
and are numbered together with other links in the sequence of their
occurrence in the document.

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

.I ignore
hidden links do not appear even in listings.
.TP
.B -historical
toggles use of '>' or '-->' as a terminator for comments.
.TP
.B -homepage\fR=\fIURL
set homepage separate from start page.
.TP
.B -image_links
toggles inclusion of links for all images.
.TP
.B -index\fR=\fIURL
set the default index file to the specified URL.
.TP
.B -ismap
toggles inclusion of ISMAP links when client-side
MAPs are present.
.TP
.B -justify
do justification of text.
.TP
.B -link\fR=\fINUMBER
starting count for lnk#.dat files produced by -crawl.
.TP
.B -localhost
disable URLs that point to remote hosts.
.TP
.B -locexec
enable local program execution from local files only (if
Lynx was compiled with local execution enabled).
.TP
.B -lss\fR=\fIFILENAME
specify filename containing color-style information.
The default is lynx.lss.
.TP
.B -mime_header
prints the MIME header of a fetched document along with its
source.
.TP
.B -minimal
toggles minimal versus valid comment parsing.
.TP
.B -newschunksize\fR=\fINUMBER
number of articles in chunked news listings.
.TP
.B -newsmaxchunk\fR=\fINUMBER
maximum news articles in listings before chunking.
.TP
.B -nobold
disable bold video-attribute.
.TP
.B -nobrowse
disable directory browsing.
.TP
.B -nocc
disable Cc: prompts for self copies of mailings.  Note
that this does not disable any CCs which are incorporated
within a mailto URL or form ACTION.
.TP
.B -nocolor
force color mode off, overriding terminal capabilities and any
-color flags, COLORTERM variable, and saved .lynxrc settings.
.TP
.B -noexec
disable local program execution. (DEFAULT)
.TP
.B -nofilereferer
disable transmissions of Referer headers for file URLs.
.TP
.B -nolist
disable the link list feature in dumps.
.TP
.B -nolog
disable mailing of error messages to document owners.
.TP
.B -nonrestarting_sigwinch
This flag is not available on all systems,
Lynx needs to be compiled with HAVE_SIGACTION defined.
If available, this flag \fImay\fR cause Lynx to react
more immediately to window changes when run within
an \fBxterm\fR.
.TP
.B -nopause
disable forced pauses for statusline messages.
.TP
.B -noprint
disable most print functions.
.TP
.B -noredir
prevents automatic redirection and prints a message with a
link to the new URL.
.TP
.B -noreferer
disable transmissions of Referer headers.
.TP
.B -noreverse
disable reverse video-attribute.
.TP
.B -nosocks
disable SOCKS proxy usage by a SOCKSified Lynx.
.TP
.B -nostatus
disable the retrieval status messages.
.TP
.B -nounderline
disable underline video-attribute.
.TP
.B -number_fields
force numbering of links as well as form input fields
.TP
.B -number_links
force numbering of links.
.TP
.B -partial
toggles display partial pages while loading.
.TP
.B -partial_thres\fR=\fINUMBER
number of lines to render before repainting display
with partial-display logic
.TP
.B -pauth\fR=\fIID\fR:\fIPASSWD
set authorization ID and password for a protected proxy
server at startup.  Be sure to protect any script files
which use this switch.
.TP
.B -popup
toggles handling of single-choice SELECT options via
popup windows or as lists of radio buttons.
.TP
.B -post_data
properly formatted data for a post form are read in from 
stdin and passed to the form.
Input is terminated by a line that starts with '---'. 
.TP
.B -preparsed
show HTML source preparsed and reformatted when used with -source
or in source view.
.TP
.B -prettysrc
show HTML source view with lexical elements and tags in color.
.TP
.B -print
enable print functions. (default)
.TP
.B -pseudo_inlines
toggles pseudo-ALTs for inlines with no ALT string.
.TP
.B -raw
toggles default setting of 8-bit character translations
or CJK mode for the startup character set.
.TP
.B -realm
restricts access to URLs in the starting realm.
.TP
.B -reload
flushes the cache on a proxy server
(only the first document affected).
.TP
.B -restrictions\fR=\fI[option][,option][,option]...
allows a list of services to be disabled
selectively. Dashes and underscores in option names
can be intermixed. The following list is printed
if no options are specified.

.I all
- restricts all options listed below.

.I bookmark
- disallow changing the location of the bookmark
file.

.I bookmark_exec
- disallow execution links via the bookmark file.

.I change_exec_perms
- disallow changing the eXecute permission on files
(but still allow it for directories) when local file
management is enabled.

.I default
- 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, telnet_port,
jump, mail, print, exec, and goto.
The settings for these,
as well as additional goto restrictions for
specific URL schemes that are also applied,
are derived from definitions within userdefs.h.

.I dired_support
- disallow local file management.

.I disk_save
- disallow saving to disk in the download and
print menus.

.I dotfiles
- disallow access to, or creation of, hidden (dot) files.

.I download
- disallow some downloaders in the download menu (does not
imply disk_save restriction).

.I editor
- disallow external editing.

.I exec
- disable execution scripts.

.I exec_frozen
- disallow the user from changing the local
execution option.

.I externals
- disallow some "EXTERNAL" configuration lines
if support for passing URLs to external
applications (with the EXTERN command) is
compiled in.

.I file_url
- disallow using G)oto, served links or bookmarks for
file: URLs.

.I goto
- disable the 'g' (goto) command.

.I inside_ftp
- disallow ftps for people coming from inside your
domain (utmp required for selectivity).

.I inside_news
- disallow USENET news posting for people coming
from inside your domain (utmp required for selectivity).

.I inside_rlogin
- disallow rlogins for people coming from inside
your domain (utmp required for selectivity).

.I inside_telnet
- disallow telnets for people coming from inside
your domain (utmp required for selectivity).

.I jump
- disable the 'j' (jump) command.

.I multibook
- disallow multiple bookmarks.

.I mail
- disallow mail.

.I news_post
- disallow USENET News posting.

.I options_save
- disallow saving options in .lynxrc.

.I outside_ftp
- disallow ftps for people coming from outside your
domain (utmp required for selectivity).

.I outside_news
- 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 "snewsreply" in case they are supported.

.I outside_rlogin
- disallow rlogins for people coming from outside
your domain (utmp required for selectivity).

.I outside_telnet
- disallow telnets for people coming from
outside your domain (utmp required for selectivity).

.I print
- disallow most print options.

.I shell
- disallow shell escapes and lynxexec or lynxprog G)oto's.

.I suspend
- disallow Unix Control-Z suspends with escape to shell.

.I telnet_port
- disallow specifying a port in telnet G)oto's.

.I useragent
- disallow modifications of the User-Agent header.

.TP
.B -resubmit_posts
toggles forced resubmissions (no-cache) of forms with
method POST when the documents they returned are sought
with the PREV_DOC command or from the History List.
.TP
.B -rlogin
disable recognition of rlogin commands.
.TP
.B -scrollbar
toggles showing scrollbar.
.TP
.B -scrollbar_arrow
toggles showing arrows at ends of the scrollbar.
.TP
.B -selective
require .www_browsable files to browse directories.
.TP
.B -short_url
show very long URLs in the status line with "..." to represent the
portion which cannot be displayed.
The beginning and end of the URL are displayed, rather than suppressing the end.
.TP
.B -show_cursor
If enabled the cursor will not be hidden in the right hand
corner but will instead be positioned at the start of the
currently selected link.  Show cursor is the default for
systems without FANCY_CURSES capabilities.  The default
configuration can be changed in userdefs.h or lynx.cfg.
The command line switch toggles the default.
.TP
.B -show_rate
If enabled the transfer rate is shown in bytes/second.
If disabled, no transfer rate is shown.
Use lynx.cfg or the options menu to select KB/second and/or ETA.
.TP
.B -soft_dquotes
toggles emulation of the old Netscape and Mosaic bug which
treated '>' as a co-terminator for double-quotes and tags.
.TP
.B -source
works the same as dump but outputs HTML source instead of
formatted text.
.TP
.B -stack_dump
disable SIGINT cleanup handler
.TP
.B -startfile_ok
allow non-http startfile and homepage with -validate.
.TP
.B -stdin
read the startfile from standard input
(UNIX only).
.TP
.B -syslog\fR=\fItext
information for syslog call.
.TP
.B -tagsoup
initialize parser, using Tag Soup DTD rather than SortaSGML.
.TP
.B -telnet
disable recognition of telnet commands.
.TP
.B -term\fR=\fITERM
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 turn, starts another Lynx process.)
.TP
.B -timeout\fR=\fIN
For win32, sets the network read-timeout, where N is given in seconds.
.TP
.B -tlog
toggles between using a Lynx Trace Log and stderr for trace output
from the session.
.TP
.B -tna
turns on "Textfields Need Activation" mode.
.TP
.B -trace
turns on Lynx trace mode.  Destination of trace output depends
on -tlog.
.TP
.B -trace_mask\fR=\fIvalue
turn on optional traces, which may result in very large trace files.
Logically OR the values to combine options:
.br
1=SGML character parsing states
.br
2=color-style
.br
4=TRST (table layout)
.TP
.B -traversal
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.
.TP
.B trim_input_fields
trim input text/textarea fields in forms.
.TP
.B -underscore
toggles use of _underline_ format in dumps.
.TP
.B -use_mouse
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 \fBncurses\fR or \fBslang\fR to support this feature.
If \fBncurses\fR is used, clicking the middle mouse button pops up
a simple menu.  Mouse clicks may only work reliably while Lynx is
idle waiting for input.
.TP
.B -useragent=Name
set alternate Lynx User-Agent header.
.TP
.B -validate
accept only http URLs (for validation).  Complete security
restrictions also are implemented.
.TP
.B -verbose
toggle [LINK], [IMAGE] and [INLINE] comments with filenames of these images.
.TP
.B -version
print version information.
.TP
.B -vikeys
enable vi-like key movement.
.TP
.B -wdebug
enable Waterloo tcp/ip packet debug (print to watt debugfile).
This applies only to DOS versions compiled with WATTCP or WATT-32.
.TP
.B -width\fR=\fINUMBER
number of columns for formatting of dumps, default is 80.
.TP
.B -with_backspaces
emit backspaces in output if -dumping or -crawling (like 'man' does)
.SH COMMANDS
o Use \fBUp arrow\fR and \fBDown arrow\fR to scroll through hypertext links.
.br
o \fBRight arrow\fR or \fBReturn\fR will follow a highlighted hypertext link.
.br
o \fBLeft Arrow\fR will retreat from a link.
.br
o Type \fB"H"\fR or \fB"?"\fR for online help and descriptions
of key-stroke commands.
.br
o Type \fB"K"\fR for a complete list of the current key-stroke
command mappings.
.SH ENVIRONMENT
In addition to various "standard" environment variables such as
\fBHOME\fR, \fBPATH\fR, \fBUSER\fR, \fBDISPLAY\fR, \fBTMPDIR\fR, \fBetc\fR,
\fILynx\fR utilizes several Lynx-specific environment variables, if they
exist.
.PP
Others may be created or modified by \fILynx\fR to pass data to an external
program, or for other reasons.  These are listed separately below.
.PP
See also the sections on \fBSIMULATED CGI SUPPORT\fR and
\fBNATIVE LANGUAGE SUPPORT\fR, below.
.PP
Note:  Not all environment variables apply to all types of platforms
supported by \fILynx\fR, though most do.  Feedback on platform
dependencies is solicited.
.PP
Environment Variables Used By \fILynx\fR:
.TP 20
.B COLORTERM
If set, color capability for the terminal is forced on at startup time.
The actual value assigned to the variable is ignored.  This variable is
only meaningful if \fILynx\fR was built using the \fBslang\fR
screen-handling library.
.TP 20
.B LYNX_CFG
This variable, if set, will override the default location and name of
the global configuration file (normally, \fBlynx.cfg\fR) that was defined
by the LYNX_CFG_FILE constant in the userdefs.h file, during installation.
See the userdefs.h file for more information.
.TP 20
.B LYNX_LSS
This variable, if set, specifies the location of the default \fILynx\fR
character style sheet file.  [Currently only meaningful if \fILynx\fR was
built using experimental color style support.]
.TP 20
.B LYNX_SAVE_SPACE
This variable, if set, will override the default path prefix for files
saved to disk that is defined in the \fBlynx.cfg SAVE_SPACE:\fR statement.
See the \fBlynx.cfg\fR file for more information.
.TP 20
.B 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
be assigned to the \fBTMPDIR\fR variable.
.TP 20
.B MAIL
This variable specifies the default inbox \fILynx\fR will check for new
mail, if such checking is enabled in the \fBlynx.cfg\fR file.
.TP 20
.B NEWS_ORGANIZATION
This variable, if set, provides the string used in the \fBOrganization:\fR
header of \fBUSENET\fR news postings.  It will override the setting of the
ORGANIZATION environment variable, if it is also set (and, on \fBUNIX\fR,
the contents of an /etc/organization file, if present).
.TP 20
.B NNTPSERVER
If set, this variable specifies the default NNTP server that will be used
for \fBUSENET\fR news reading and posting with \fILynx\fR, via news: URL's.
.TP 20
.B ORGANIZATION
This variable, if set, provides the string used in the \fBOrganization:\fR
header of \fBUSENET\fR news postings.  On \fBUNIX\fR, it will override the
contents of an /etc/organization file, if present.
.TP 20
.B PROTOCOL_proxy
\fILynx\fR supports the use of proxy servers that can act as firewall
gateways and caching servers.  They are preferable to the older gateway
servers (see WWW_access_GATEWAY, below).  Each protocol used by \fILynx\fR,
(http, ftp, gopher, etc), can be mapped separately by setting environment
variables of the form PROTOCOL_proxy (literally: http_proxy, ftp_proxy,
gopher_proxy, etc), to "http://some.server.dom:port/".
See \fBLynx Users Guide\fR for additional details and examples.
.TP 20
.B WWW_access_GATEWAY
\fILynx\fR 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 \fBLynx Users Guide\fR for details.
.TP 20
.B WWW_HOME
This variable, if set, will override the default startup URL specified
in any of the \fILynx\fR configuration files.
.PP
Environment Variables \fBSet\fR or \fBModified\fR By \fILynx\fR:
.TP 20
.B LYNX_PRINT_DATE
This variable is set by the \fILynx\fR p(rint) function, to the
\fBDate:\fR
string seen in the document's "\fBInformation about\fR" page (= cmd),
if any.
It is created for use by an external program, as defined in a
\fBlynx.cfg PRINTER:\fR definition statement.
If the field does not exist for the document, the variable is set to a
null string under \fBUNIX\fR, or "No Date" under \fBVMS\fR.
.TP 20
.B LYNX_PRINT_LASTMOD
This variable is set by the \fILynx\fR p(rint) function, to the
\fBLast Mod:\fR
string seen in the document's "\fBInformation about\fR" page (= cmd),
if any.
It is created for use by an external program, as defined in a
\fBlynx.cfg PRINTER:\fR definition statement.
If the field does not exist for the document, the variable is set to a
null string under \fBUNIX\fR, or "No LastMod" under \fBVMS\fR.
.TP 20
.B LYNX_PRINT_TITLE
This variable is set by the \fILynx\fR p(rint) function, to the
\fBLinkname:\fR
string seen in the document's "\fBInformation about\fR" page (= cmd),
if any.
It is created for use by an external program, as defined in a
\fBlynx.cfg PRINTER:\fR definition statement.
If the field does not exist for the document, the variable is set to a
null string under \fBUNIX\fR, or "No Title" under \fBVMS\fR.
.TP 20
.B LYNX_PRINT_URL
This variable is set by the \fILynx\fR p(rint) function, to the
\fBURL:\fR
string seen in the document's "\fBInformation about\fR" page (= cmd),
if any.
It is created for use by an external program, as defined in a
\fBlynx.cfg PRINTER:\fR definition statement.
If the field does not exist for the document, the variable is set to a
null string under \fBUNIX\fR, or "No URL" under \fBVMS\fR.
.TP 20
.B LYNX_TRACE
If set, causes \fILynx\fR to write a trace file as if the \fB-trace\fR
option were supplied. 
.TP 20
.B LYNX_VERSION
This variable is always set by \fILynx\fR, and may be used by an external
program to determine if it was invoked by \fILynx\fR.  See also the comments
in the distribution's sample \fBmailcap\fR file, for notes on usage in such
a file.
.TP 20
.B TERM
Normally, this variable is used by \fILynx\fR to determine the terminal type
being used to invoke \fILynx\fR.  If, however, it is unset at startup time
(or has the value "unknown"),
or if the \fB-term\fR command-line option is used (see \fBOPTIONS\fR section
above), \fILynx\fR will set or modify its value to the user specified
terminal type (for the \fILynx\fR execution environment).
Note: If set/modified by \fILynx\fR, the values of the \fBLINES\fR and/or
\fBCOLUMNS\fR environment variables may also be changed.
.SH SIMULATED CGI SUPPORT
If built with the \fBcgi-links\fR option enabled, \fILynx\fR allows access
to a cgi script directly without the need for an http daemon.
.PP
When executing such "lynxcgi scripts" (if enabled), the following variables
may be set for simulating a CGI environment:
.PP
.B CONTENT_LENGTH
.PP
.B CONTENT_TYPE
.PP
.B DOCUMENT_ROOT
.PP
.B HTTP_ACCEPT_CHARSET
.PP
.B HTTP_ACCEPT_LANGUAGE
.PP
.B HTTP_USER_AGENT
.PP
.B PATH_INFO
.PP
.B PATH_TRANSLATED
.PP
.B QUERY_STRING
.PP
.B REMOTE_ADDR
.PP
.B REMOTE_HOST
.PP
.B REQUEST_METHOD
.PP
.B SERVER_SOFTWARE
.PP
Other environment variables are not inherited by the script, unless they
are provided via a LYNXCGI_ENVIRONMENT statement in the configuration file.
See the \fBlynx.cfg\fR file, and the (draft) CGI 1.1 Specification
<http://Web.Golux.Com/coar/cgi/draft-coar-cgi-v11-00.txt> for the
definition and usage of these variables.
.PP
The CGI Specification, and other associated documentation, should be consulted
for general information on CGI script programming.
.SH NATIVE LANGUAGE SUPPORT
If configured and installed with \fBNative Language Support\fR, \fILynx\fR
will display status and other messages in your local language.  See the
file \fBABOUT_NLS\fR in the source distribution, or at your local \fBGNU\fR
site, for more information about internationalization.
.PP
The following environment variables may be used to alter default settings:
.TP 20
.B LANG
This variable, if set, will override the default message language.  It
is an \fBISO 639\fR two-letter code identifying the language.  Language
codes are \fBNOT\fR the same as the country codes given in \fBISO 3166\fR.
.TP 20
.B LANGUAGE
This variable, if set, will override the default message language.
This is a \fBGNU\fR extension that has higher priority for setting
the message catalog than \fBLANG\fR or \fBLC_ALL\fR.
.TP 20
.B LC_ALL
and
.TP 20
.B LC_MESSAGES
These variables, if set, specify the notion of native language
formatting style.  They are \fBPOSIXly\fR correct.
.TP 20
.B LINGUAS
This variable, if set prior to configuration, limits the installed
languages to specific values.  It is a space-separated list of two-letter
codes.  Currently, it is hard-coded to a wish list.
.TP 20
.B NLSPATH
This variable, if set, is used as the path prefix for message catalogs.
.SH NOTES
This is the Lynx v2.8.4 Release
.PP
If you wish to contribute to the further development
of \fILynx\fR, subscribe to our mailing list.  Send email to
<majordomo@sig.net> with "subscribe lynx-dev" as the only line
in the body of your message.
.PP
Send bug reports, comments, suggestions to <lynx-dev@sig.net>
after subscribing.
.PP
Unsubscribe by sending email to <majordomo@sig.net> with
"unsubscribe lynx-dev" as the only line in the body of your message.
Do not send the unsubscribe message to the lynx-dev list, itself.
.SH SEE ALSO
.hy 0
\fIcatgets\fR(3),
\fIcurses\fR(3),
\fIenviron\fR(7),
\fIexecve\fR(2),
\fIftp\fR(1),
\fIgettext\fR(GNU),
\fIlocaleconv\fR(3),
\fIncurses\fR(3),
\fIsetlocale\fR(3),
\fIslang\fR(?),
\fItermcap\fR(5),
\fIterminfo\fR(5),
\fIwget\fR(GNU)
.hy 1
.PP
Note that man page availability and section numbering is somewhat
platform dependent, and may vary from the above references.
.PP
A section shown as (GNU), is intended to denote that the topic
may be available via an info page, instead of a man page (i.e., try
"info subject", rather than "man subject").
.PP
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 Administrator for further information).
.SH ACKNOWLEDGMENTS
Lynx has incorporated code from a variety of sources along the way.
The earliest versions of Lynx included code from Earl Fogel of Computing
Services at the University of Saskatchewan, who implemented HYPERREZ
in the Unix environment.  HYPERREZ was developed by Niel Larson of
Think.com and served as the model for the early versions of Lynx.
Those versions also incorporated libraries from the Unix Gopher clients
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 ported
much of Lynx to VMS and did or organized most of its development since the
departures of Lou Montulli and Garrett Blythe from the University 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 either directly (through
patches, comments or bug reports) or indirectly (through inspiration and
development of other systems).
.SH AUTHORS
Lou Montulli, Garrett Blythe, Craig Lavender, Michael Grobe, Charles Rezac
.br
Academic Computing Services
.br
University of Kansas
.br
Lawrence, Kansas 66047
.PP
Foteos Macrides
.br
Worcester Foundation for Biomedical Research
.br
Shrewsbury, Massachusetts 01545