lynx.man 40.5 KB
Newer Older
1
.\" $LynxId: lynx.man,v 1.123 2018/07/08 10:54:20 tom Exp $
2 3 4 5 6 7 8 9
.\" **************************************************************************
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds AQ \(aq
.el       .ds AQ '
.ie \n(.g .ds `` \(lq
.el       .ds `` ``
.ie \n(.g .ds '' \(rq
.el       .ds '' ''
10
.de bP
11 12
.ie n  .IP \(bu 4
.el    .IP \(bu 2
13 14
..
.de NS
15
.ie n  .sp
16
.el    .sp .5
17
.ie n  .in +4
18 19 20 21 22 23 24
.el    .in +2
.nf
.ft C			\" Courier
..
.de NE
.fi
.ft R
25 26
.ie n  .in -4
.el    .in -2
27
..
28
.\" **************************************************************************
29
.TH LYNX 1
30 31 32
.SH NAME
lynx \- a general purpose distributed information browser for the World Wide Web
.SH SYNOPSIS
33
.B lynx \fI[options] [optional paths or URLs]
34
.sp
35
.B lynx \fI[options] [path or URL]\fP \fB\-get_data
36 37 38
.br
.I data
.br
39
.B \-\-
40
.sp
41
.B lynx \fI[options] [path or URL]\fP \fB\-post_data
42 43 44
.br
.I data
.br
45
.B \-\-
46
.PP
47
Use \*(``lynx \-help\*('' to display a complete list of current options.
48
.SH DESCRIPTION
49
.hy 0
50 51 52
.I
Lynx
is a fully-featured World Wide Web (WWW) client for users
53 54 55 56
running cursor-addressable, character-cell display devices
(e.g., vt100 terminals,
vt100 emulators running on Windows 95/NT/XP/7/8 or any POSIX platform,
or any other \*(``curses-oriented\*('' display).
57
It will display hypertext
58 59 60 61 62 63 64
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
65
Unix, VMS, Windows 95/NT/XP/7/8, DOS DJGPP and OS/2.
66 67 68 69 70 71 72 73 74
.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
75 76
Information Systems (CWIS).
In addition,
77 78 79 80 81 82
.I
Lynx
can be used to
build systems isolated within a single LAN.
.SH OPTIONS
At start up, \fILynx\fR will load any local
83 84 85 86
file or remote URL specified at the command line.
For help with URLs, press \*(``\fB?\fR\*(''
or \*(``\fBH\fR\*('' while running \fILynx\fR.
Then follow the link titled, \*(``Help on URLs.\*(''
87 88 89
.PP
If more than one local file or remote URL is listed on the command line,
\fILynx\fP will open only the last interactively.
90 91
All of the names (local files and remote URLs)
are added to the \fBG)oto\fP history.
92
.PP
93
\fILynx\fR uses only long option names.
94
Option names can begin with double dash \*(``\-\-\*('' as well,
95
underscores and dashes can be intermixed in
96 97 98 99
option names (in the reference below, options
are shown
with one dash \*(``\-\*('' before them, and
with underscores \*(``_\*('').
100
.PP
101 102 103 104 105 106 107 108 109 110
\fILynx\fR 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 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), or toggle (between true/false).
For any of these, an explicit value can be given in different
forms to allow for operating system constraints,
e.g.,
111
.NS
112 113 114
\fB\-center:off\fP
\fB\-center=off\fP
\fB\-center\-\fP
115 116
.NE
.PP
117
\fILynx\fR recognizes
118 119
\*(``1\*('', \*(``+\*('', \*(``on\*('' and \*(``true\*('' for true values, and
\*(``0\*('', \*(``\-\*('', \*(``off\*('' and \*(``false\*('' for false values.
120 121 122
Other option-values are ignored.
.PP
The default boolean, number and string option values that are compiled
123
into \fILynx\fP are displayed in the help-message provided by \fBlynx \-help\fP.
124
Some of those may differ according to how \fILynx\fP was built;
125
see the help message itself for these values.
126
The \fB\-help\fP option is processed in the third pass of options-processing,
127 128
so any option which sets a value,
as well as runtime configuration values are reflected in the help-message.
129
.TP 7
130
.B \-
131
If the argument is only \*(``\-\*('', then \fILynx\fP expects to receive
132 133
the arguments from the standard input.
This is to allow for the
134
potentially very long command line that can be associated
135
with the \fB\-get_data\fR or \fB\-post_data\fR arguments (see below).
136 137 138
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
139
the \fB\-auth\fR or \fB\-pauth\fR options are used.
140
.TP
141
.B \-accept_all_cookies
142 143
accept all cookies.
.TP
144 145
.B \-anonymous
apply restrictions for anonymous account, see also \fB\-restrictions\fR.
146
.TP
147
.B \-assume_charset\fR=\fIMIMEname
148
charset for documents that do not specify it.
149
.TP
150
.B \-assume_local_charset\fR=\fIMIMEname
151
charset assumed for local files,
152 153
i.e., files which \fILynx\fP creates such as
internal pages for the options menu.
154
.TP
155
.B \-assume_unrec_charset\fR=\fIMIMEname
156 157
use this instead of unrecognized charsets.
.TP
158
.B \-auth\fR=\fIID\fR:\fIPASSWD
159 160
set authorization ID and password for protected documents at startup.
Be sure to protect any script files which use
161 162
this switch.
.TP
163
.B \-base
164
prepend a request URL comment and BASE tag to text/html
165
outputs for \fB\-source\fR dumps.
166
.TP
167
.B \-bibhost\fR=\fIURL
168 169
specify a local bibp server (default http://bibhost/).
.TP
170
.B \-blink
171 172 173 174 175
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
176
.B \-book
177 178
use the bookmark page as the startfile.
The default or command
179 180 181
line startfile is still set for the Main screen command, and will
be used if the bookmark page is unavailable or blank.
.TP
182
.B \-buried_news
183
toggles scanning of news articles for buried references, and
184 185
converts them to news links.
Not recommended because email
186 187 188
addresses enclosed in angle brackets will be converted to
false news links, and uuencoded messages can be trashed.
.TP
189
.B \-cache\fR=\fINUMBER
190 191 192
set the NUMBER of documents cached in memory.
The default is 10.
.TP
193
.B \-case
194 195
enable case-sensitive string searching.
.TP
196
.B \-center
197 198
Toggle center alignment in HTML TABLE.
.TP
199
.B \-cfg\fR=\fIFILENAME
200
specifies a \fILynx\fP configuration file other than the default
201 202
lynx.cfg.
.TP
203
.B \-child
204 205 206 207 208 209
exit on left-arrow in startfile, and disable save to disk and associated
print/mail options.
.TP
.B \-child_relaxed
exit on left-arrow in startfile, but allow save to disk and associated
print/mail options.
210
.TP
211
.B \-cmd_log\fR=\fIFILENAME
212 213
write keystroke commands and related information to the specified file.
.TP
214
.B \-cmd_script\fR=\fIFILENAME
215 216
read keystroke commands from the specified file.
You can use the data written using the \fB\-cmd_log\fR option.
217
\fILynx\fP will ignore other information which the command-logging may have
218
written to the logfile.
219 220
Each line of the command script contains either
a comment beginning with \*(``#\*('',
221
or a keyword:
222 223 224
.RS
.TP 3
.B exit
225 226
causes the script to stop, and forces \fILynx\fP to exit immediately.
.TP
227
.B key
228
the character value, in printable form.
229
Cursor and other special keys are given as names, e.g., \*(``Down Arrow\*(''.
230 231
Printable 7-bit ASCII codes are given as-is,
and hexadecimal values represent other 8-bit codes.
232
.TP
233
.B set
234
followed by a \*(``name=value\*('' allows one to override values set in the
235
lynx.cfg or \&.lynxrc files.
236
\fILynx\fP tries the cfg-file setting first.
237 238
.RE
.TP
239 240 241
.B \-collapse_br_tags
toggles collapsing of BR tags.
.TP
242
.B \-color
243 244
forces color mode on, if available.
Default color control sequences
245 246
which work for many terminal types are assumed if the terminal
capability description does not specify how to handle color.
247
\fILynx\fP needs to be compiled with the \fBslang\fR library for this flag,
248 249
it is equivalent to setting the \fBCOLORTERM\fR environment variable.
(If color support is instead provided by a color-capable curses
250
library like \fBncurses\fR, \fILynx\fP relies completely on the terminal
251 252
description to determine whether color mode is possible, and
this flag is not needed and thus unavailable.)
253
A saved show_color=always setting found in a \&.lynxrc file at
254 255
startup has the same effect.
A saved show_color=never found
256
in \&.lynxrc on startup is overridden by this flag.
257
.TP
258
.B \-connect_timeout\fR=\fIN
259 260
Sets the connection timeout, where N is given in seconds.
.TP
261
.B \-cookie_file\fR=\fIFILENAME
262 263 264 265
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
266
.B \-cookie_save_file\fR=\fIFILENAME
267 268
specifies a file to use to store cookies.
If none is specified, the value given by
269
\fB\-cookie_file\fR is used.
270
.TP
271
.B \-cookies
272 273
toggles handling of Set-Cookie headers.
.TP
274
.B \-core
275
toggles forced core dumps on fatal errors.
276 277
Turn this option off to ask \fILynx\fP to force
a core dump if a fatal error occurs.
278
.TP
279 280
.B \-crawl
with \fB\-traversal,\fR output each page to a file.
281 282
with \fB\-dump\fR, format output as with \fB\-traversal\fR,
but to the standard output.
283
.TP
284
.B \-curses_pads
285
toggles the use of curses \*(``pad\*('' feature which supports
286
left/right scrolling of the display.
287 288
The feature is normally available for curses configurations,
but inactive.
289
To activate it, use the \*(``|\*('' character or the LINEWRAP_TOGGLE command.
290
Toggling this option makes the feature altogether unavailable.
291
.TP
292
.B \-debug_partial
293 294
separate incremental display stages with MessageSecs delay
.TP
295
.B \-default_colors
296 297
toggles the default-colors feature which is normally set in the lynx.cfg file.
.TP
298 299 300 301
.B \-delay
add DebugSecs delay after each progress-message
.TP
.B \-display\fR=\fIDISPLAY
302 303
set the display variable for X rexec-ed programs.
.TP
304
.B \-display_charset\fR=\fIMIMEname
305 306
set the charset for the terminal output.
.TP
307
.B \-dont_wrap_pre
308 309
inhibit wrapping of text when \fB\-dump\fR'ing and \fB\-crawl\fR'ing,
mark wrapped lines of <pre> in interactive session.
310
.TP
311
.B \-dump
312
dumps the formatted output of the default document or those
313
specified on the command line to standard output.
314
Unlike interactive mode, all documents are processed.
315
This can be used in the following way:
316
.NS
317
lynx \fB\-dump\fR http://www.subir.com/lynx.html
318
.NE
319 320 321 322 323 324
.IP
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 \fB\-force_html\fP option to format files whose names do not follow
this convention.
325
.TP
326
.B \-editor\fR=\fIEDITOR
327
enable external editing, using the specified
328 329
EDITOR.
(vi, ed, emacs, etc.)
330
.TP
331
.B \-emacskeys
332 333
enable emacs-like key movement.
.TP
334
.B \-enable_scrollback
335 336 337
toggles compatibility with communication programs' scrollback keys
(may be incompatible with some curses packages).
.TP
338
.B \-error_file\fR=\fIFILE
339
define a file where \fILynx\fP will report HTTP access codes.
340
.TP
341
.B \-exec
342 343
enable local program execution (normally not configured).
.TP
344
.B \-fileversions
345 346
include all versions of files in local VMS directory listings.
.TP
347 348 349 350 351 352 353
.B \-find_leaks
toggle memory leak-checking.
Normally this
is not compiled-into your executable, but when it is,
it can be disabled for a session.
.TP
.B \-force_empty_hrefless_a
354 355
force HREF-less \*(``A\*('' elements to be empty
(close them as soon as they are seen).
356
.TP
357
.B \-force_html
358
forces the first document to be interpreted as HTML.
359
.IP
360 361 362
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).
363
.IP
364
\fILynx\fP recognizes these file suffixes as HTML:
365
.NS
366 367 368 369 370 371 372 373 374 375
\*(``.ht3\*('',
\*(``.htm\*('',
\*(``.html3\*('',
\*(``.html\*('',
\*(``.htmlx\*('',
\*(``.php3\*('',
\*(``.php\*('',
\*(``.phtml\*('',
\*(``.sht\*('', and
\*(``.shtml\*(''.
376
.NE
377
.TP
378
.B \-force_secure
379 380
toggles forcing of the secure flag for SSL cookies.
.TP
381
.B \-forms_options
382 383
toggles whether the Options Menu is key-based or form-based.
.TP
384
.B \-from
385 386
toggles transmissions of From headers.
.TP
387
.B \-ftp
388 389
disable ftp access.
.TP
390
.B \-get_data
391
properly formatted data for a \fIget\fP form are read in from
392
the standard input and passed to the form.
393
Input is terminated by a line that starts with \*(``\-\-\-\*(''.
394 395 396 397 398
.IP
\fILynx\fP issues an HTTP \fBGET\fP,
sending the form to the path or URL given on the
command-line and prints the response of the server.
If no path or URL is given, \fILynx\fP sends the form to the start-page.
399
.TP
400
.B \-head
401 402
send a HEAD request for the mime headers.
.TP
403
.B \-help
404
print the \fILynx\fP command syntax usage message, and exit.
405
.TP
406
.B \-hiddenlinks=[option]
407
control the display of hidden links.
408 409 410
.RS
.TP 3
.B merge
411 412 413
hidden links show up as bracketed numbers
and are numbered together with other links in the sequence of their
occurrence in the document.
414 415
.TP
.B listonly
416
hidden links are shown only on \fBL)ist\fP screens and listings generated by
417
.B \-dump
418
or from the \fBP)rint\fP menu, but appear separately at the end of those lists.
419
This is the default behavior.
420 421
.TP
.B ignore
422
hidden links do not appear even in listings.
423
.RE
424
.TP
425
.B \-historical
426
toggles use of \*(``>\*('' or \*(``\-\->\*('' as a terminator for comments.
427
.TP
428
.B \-homepage\fR=\fIURL
429 430
set homepage separate from start page.
.TP
431
.B \-image_links
432 433
toggles inclusion of links for all images.
.TP
434
.B \-index\fR=\fIURL
435 436
set the default index file to the specified URL.
.TP
437
.B \-ismap
438 439 440
toggles inclusion of ISMAP links when client-side
MAPs are present.
.TP
441
.B \-justify
442 443
do justification of text.
.TP
444 445
.B \-link\fR=\fINUMBER
starting count for lnk#.dat files produced by \fB\-crawl\fR.
446
.TP
447 448 449
.B \-list_inline
for \fB\-dump\fR, show the links inline with the text.
.TP
450
.B \-listonly
451
for \fB\-dump\fR, show only the list of links.
452
.TP
453
.B \-localhost
454 455
disable URLs that point to remote hosts.
.TP
456
.B \-locexec
457
enable local program execution from local files only (if
458
\fILynx\fP was compiled with local execution enabled).
459
.TP
460
.B \-lss\fR=\fIFILENAME
461 462
specify filename containing color-style information.
The default is lynx.lss.
463
If you give an empty filename, \fILynx\fP uses a built-in monochrome
464
scheme which imitates the non-color-style configuration.
465
.TP
466
.B \-mime_header
467 468 469
prints the MIME header of a fetched document along with its
source.
.TP
470
.B \-minimal
471 472
toggles minimal versus valid comment parsing.
.TP
473 474 475 476
.B \-nested_tables
toggles nested-tables logic (for debugging).
.TP
.B \-newschunksize\fR=\fINUMBER
477 478
number of articles in chunked news listings.
.TP
479
.B \-newsmaxchunk\fR=\fINUMBER
480 481
maximum news articles in listings before chunking.
.TP
482
.B \-nobold
483 484
disable bold video-attribute.
.TP
485
.B \-nobrowse
486 487
disable directory browsing.
.TP
488
.B \-nocc
489 490
disable Cc: prompts for self copies of mailings.
Note that this does not disable any CCs which are incorporated
491 492
within a mailto URL or form ACTION.
.TP
493
.B \-nocolor
494
force color mode off, overriding terminal capabilities and any
495
\-color flags, COLORTERM variable, and saved \&.lynxrc settings.
496
.TP
497
.B \-noexec
498 499
disable local program execution.
(DEFAULT)
500
.TP
501
.B \-nofilereferer
502 503
disable transmissions of Referer headers for file URLs.
.TP
504
.B \-nolist
505 506
disable the link list feature in dumps.
.TP
507
.B \-nolog
508 509
disable mailing of error messages to document owners.
.TP
510 511 512
.B \-nomargins
disable left/right margins in the default style sheet.
.TP
513
.B \-nomore
514
disable \-more\- string in statusline messages.
515
.TP
516
.B \-nonrestarting_sigwinch
517
This flag is not available on all systems,
518 519
\fILynx\fP needs to be compiled with HAVE_SIGACTION defined.
If available, this flag \fImay\fR cause \fILynx\fP to react
520 521 522
more immediately to window changes when run within
an \fBxterm\fR.
.TP
523 524
.B \-nonumbers
disable link- and field-numbering.
525
This overrides \fB\-number_fields\fR and \fB\-number_links\fR.
526
.TP
527
.B \-nopause
528 529
disable forced pauses for statusline messages.
.TP
530
.B \-noprint
531 532
disable most print functions.
.TP
533
.B \-noredir
534 535 536
prevents automatic redirection and prints a message with a
link to the new URL.
.TP
537
.B \-noreferer
538 539
disable transmissions of Referer headers.
.TP
540
.B \-noreverse
541 542
disable reverse video-attribute.
.TP
543
.B \-nosocks
544
disable SOCKS proxy usage by a SOCKSified \fILynx\fP.
545
.TP
546
.B \-nostatus
547 548
disable the retrieval status messages.
.TP
549 550 551
.B \-notitle
disable title and blank line from top of page.
.TP
552
.B \-nounderline
553 554
disable underline video-attribute.
.TP
555
.B \-number_fields
556 557
force numbering of links as well as form input fields
.TP
558
.B \-number_links
559 560
force numbering of links.
.TP
561
.B \-partial
562 563
toggles display partial pages while loading.
.TP
564
.B \-partial_thres\fR=\fINUMBER
565 566 567
number of lines to render before repainting display
with partial-display logic
.TP
568
.B \-passive_ftp
569 570
toggles passive ftp connections.
.TP
571
.B \-pauth\fR=\fIID\fR:\fIPASSWD
572 573
set authorization ID and password for a protected proxy server at startup.
Be sure to protect any script files which use this switch.
574
.TP
575
.B \-popup
576 577 578
toggles handling of single-choice SELECT options via
popup windows or as lists of radio buttons.
.TP
579
.B \-post_data
580
properly formatted data for a \fIpost\fP form are read in from
581
the standard input and passed to the form.
582
Input is terminated by a line that starts with \*(``\-\-\-\*(''.
583 584 585 586 587
.IP
\fILynx\fP issues an HTTP \fBPOST\fP,
sending the form to the path or URL given on the
command-line and prints the response of the server.
If no path or URL is given, \fILynx\fP sends the form to the start-page.
588
.TP
589 590
.B \-preparsed
show HTML source preparsed and reformatted when used with \fB\-source\fR
591 592
or in source view.
.TP
593
.B \-prettysrc
594 595
show HTML source view with lexical elements and tags in color.
.TP
596
.B \-print
597 598
enable print functions.
(default)
599
.TP
600
.B \-pseudo_inlines
601
toggles pseudo-ALTs for inline images with no ALT string.
602
.TP
603
.B \-raw
604 605 606
toggles default setting of 8-bit character translations
or CJK mode for the startup character set.
.TP
607
.B \-realm
608 609
restricts access to URLs in the starting realm.
.TP
610 611 612
.B \-read_timeout\fR=\fIN
Sets the read-timeout, where N is given in seconds.
.TP
613
.B \-reload
614
flushes the cache on a proxy server
615
(only the first document given on the command-line is affected).
616
.TP
617
.B \-restrictions\fR=\fI[option][,option][,option]...
618 619 620
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.
621 622 623 624 625 626 627
.RS
.TP 3
.B all
restricts all options listed below.
.TP
.B bookmark
disallow changing the location of the bookmark
628
file.
629 630 631 632 633 634
.TP
.B bookmark_exec
disallow execution links via the bookmark file.
.TP
.B change_exec_perms
disallow changing the eXecute permission on files
635 636
(but still allow it for directories) when local file
management is enabled.
637 638 639
.TP
.B default
same as command line option \fB\-anonymous\fR.
640 641 642 643 644 645 646 647 648 649 650
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.
651 652 653 654 655 656
.TP
.B dired_support
disallow local file management.
.TP
.B disk_save
disallow saving to disk in the download and
657
print menus.
658 659 660 661 662 663
.TP
.B dotfiles
disallow access to, or creation of, hidden (dot) files.
.TP
.B download
disallow some downloaders in the download menu (does not
664
imply disk_save restriction).
665 666 667 668 669 670 671 672 673
.TP
.B editor
disallow external editing.
.TP
.B exec
disable execution scripts.
.TP
.B exec_frozen
disallow the user from changing the local
674
execution option.
675 676
.TP
.B externals
677
disallow some \*(``EXTERNAL\*('' configuration lines
678 679 680
if support for passing URLs to external
applications (with the EXTERN command) is
compiled in.
681 682
.TP
.B file_url
683
disallow using \fBG)oto\fP, served links or bookmarks for
684
file: URLs.
685 686
.TP
.B goto
687
disable the \*(``g\*('' (goto) command.
688 689 690
.TP
.B inside_ftp
disallow ftps for people coming from inside your
691
domain (utmp required for selectivity).
692 693 694
.TP
.B inside_news
disallow USENET news posting for people coming
695
from inside your domain (utmp required for selectivity).
696 697 698
.TP
.B inside_rlogin
disallow rlogins for people coming from inside
699
your domain (utmp required for selectivity).
700 701 702
.TP
.B inside_telnet
disallow telnets for people coming from inside
703
your domain (utmp required for selectivity).
704 705
.TP
.B jump
706
disable the \*(``j\*('' (jump) command.
707 708 709 710 711 712 713 714 715 716 717
.TP
.B multibook
disallow multiple bookmarks.
.TP
.B mail
disallow mail.
.TP
.B news_post
disallow USENET News posting.
.TP
.B options_save
718
disallow saving options in \&.lynxrc.
719 720 721
.TP
.B outside_ftp
disallow ftps for people coming from outside your
722
domain (utmp required for selectivity).
723 724 725
.TP
.B outside_news
disallow USENET news reading and posting for people coming
726
from outside your domain (utmp required for selectivity).
727 728 729 730 731 732
This restriction applies to
\*(``news\*('',
\*(``nntp\*('',
\*(``newspost\*('', and
\*(``newsreply\*('' URLs,
but not to \*(``snews\*('', \*(``snewspost\*('',
733
or \*(``snewsreply\*('' in case they are supported.
734 735 736
.TP
.B outside_rlogin
disallow rlogins for people coming from outside
737
your domain (utmp required for selectivity).
738 739 740
.TP
.B outside_telnet
disallow telnets for people coming from
741
outside your domain (utmp required for selectivity).
742 743 744 745 746
.TP
.B print
disallow most print options.
.TP
.B shell
747
disallow shell escapes and lynxexec or lynxprog \fBG)oto\fP's.
748 749 750 751 752
.TP
.B suspend
disallow Unix Control-Z suspends with escape to shell.
.TP
.B telnet_port
753
disallow specifying a port in telnet \fBG)oto\fP's.
754 755 756 757
.TP
.B useragent
disallow modifications of the User-Agent header.
.RE
758
.TP
759
.B \-resubmit_posts
760 761 762 763
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
764
.B \-rlogin
765 766
disable recognition of rlogin commands.
.TP
767
.B \-scrollbar
768 769
toggles showing scrollbar.
.TP
770
.B \-scrollbar_arrow
771 772
toggles showing arrows at ends of the scrollbar.
.TP
773
.B \-selective
774
require \&.www_browsable files to browse directories.
775
.TP
776 777 778 779 780 781 782 783 784
.B \-session\fR=\fIFILENAME
resumes from specified file on startup and saves session to that file on exit.
.TP
.B \-sessionin\fR=\fIFILENAME
resumes session from specified file.
.TP
.B \-sessionout\fR=\fIFILENAME
saves session to specified file.
.TP
785
.B \-short_url
786
show very long URLs in the status line with \*(``...\*('' to represent the
787 788 789
portion which cannot be displayed.
The beginning and end of the URL are displayed, rather than suppressing the end.
.TP
790
.B \-show_cfg
791 792
Print the configuration settings,
e.g., as read from \*(``lynx.cfg\*('', and exit.
793
.TP
794
.B \-show_cursor
795 796
If enabled the cursor will not be hidden in the right hand
corner but will instead be positioned at the start of the
797 798 799
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.
800 801
The command line switch toggles the default.
.TP
802
.B \-show_rate
803 804 805 806
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
807
.B \-soft_dquotes
808
toggles emulation of the old Netscape and Mosaic bug which
809
treated \*(``>\*('' as a co-terminator for double-quotes and tags.
810
.TP
811
.B \-source
812 813
works the same as dump but outputs HTML source instead of
formatted text.
814
For example
815
.NS
816
lynx \-source . >foo.html
817
.NE
818 819 820 821
.IP
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 relative to the current directory:
822
.NS
823
lynx \-source ./ >foo.html
824
.NE
825
.TP
826
.B \-stack_dump
827 828
disable SIGINT cleanup handler
.TP
829 830
.B \-startfile_ok
allow non-http startfile and homepage with \fB\-validate\fR.
831
.TP
832 833
.B \-stderr
When dumping a document using \fB\-dump\fR or \fB\-source\fR,
834
\fILynx\fP normally does not display alert (error)
835
messages that you see on the screen in the status line.
836
Use the \fB\-stderr\fR option to tell \fILynx\fP to write these messages
837 838
to the standard error.
.TP
839
.B \-stdin
840 841 842
read the startfile from standard input
(UNIX only).
.TP
843
.B \-syslog\fR=\fItext
844 845
information for syslog call.
.TP
846
.B \-syslog_urls
847 848
log requested URLs with syslog.
.TP
849
.B \-tagsoup
850 851
initialize parser, using Tag Soup DTD rather than SortaSGML.
.TP
852
.B \-telnet
853 854
disable recognition of telnet commands.
.TP
855
.B \-term\fR=\fITERM
856
tell \fILynx\fP what terminal type to assume it is talking to.
857
(This may be useful for remote execution, when, for example,
858 859
\fILynx\fP connects to a remote TCP/IP port that starts a script that,
in turn, starts another \fILynx\fP process.)
860
.TP
861
.B \-timeout\fR=\fIN
862 863
For win32, sets the network read-timeout, where N is given in seconds.
.TP
864
.B \-tlog
865
toggles between using a \fILynx\fP Trace Log and stderr for trace output
866 867
from the session.
.TP
868
.B \-tna
869
turns on \*(``Textfields Need Activation\*('' mode.
870
.TP
871
.B \-trace
872 873
turns on \fILynx\fP trace mode.
Destination of trace output depends
874
on \-tlog.
875
.TP
876
.B \-trace_mask\fR=\fIvalue
877 878
turn on optional traces, which may result in very large trace files.
Logically OR the values to combine options:
879 880 881 882 883 884 885 886 887 888 889 890
.RS
.TP 3
.B 1
SGML character parsing states
.TP
.B 2
color-style
.TP
.B 4
TRST (table layout)
.TP
.B 8
891 892 893 894 895 896
configuration
(lynx.cfg,
\&.lynxrc,
\&.lynx-keymaps,
mime.types and
mailcap contents)
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
.TP
.B 16
binary string copy/append, used in form data construction.
.TP
.B 32
cookies
.TP
.B 64
character sets
.TP
.B 128
GridText parsing
.TP
.B 256
timing
.RE
913
.TP
914
.B \-traversal
915 916 917 918
traverse all http links derived from startfile.
When used with
\fB\-crawl\fR, each link that begins with the same string as startfile
is output to a file, intended for indexing.
919
.IP
920
See CRAWL.announce for more information.
921
.TP
922 923 924 925
.B \-trim_blank_lines
toggles trimming of trailing blank lines as well as
the related trimming of blank lines while collapsing BR tags.
.TP
926
.B \-trim_input_fields
927 928
trim input text/textarea fields in forms.
.TP
929 930 931 932
.B \-underline_links
toggles use of underline/bold attribute for links.
.TP
.B \-underscore
933 934
toggles use of _underline_ format in dumps.
.TP
935 936 937 938 939
.B \-unique_urls
check for duplicate link numbers in
each page and corresponding lists,
and reuse the original link number.
.TP
940
.B \-use_mouse
941 942 943 944 945 946 947
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.
948 949
\fILynx\fP must be compiled with
\fBncurses\fR or \fBslang\fR to support this feature.
950
If \fBncurses\fR is used, clicking the middle mouse button pops up
951 952
a simple menu.
Mouse clicks may only work reliably while \fILynx\fP is
953 954
idle waiting for input.
.TP
955
.B \-useragent=Name
956
set alternate \fILynx\fP User-Agent header.
957
.TP
958
.B \-validate
959 960
accept only http URLs (for validation).
Complete security restrictions also are implemented.
961
.TP
962
.B \-verbose
963 964
toggle [LINK], [IMAGE] and [INLINE] comments with filenames of these images.
.TP
965
.B \-version
966
print version information, and exit.
967
.TP
968
.B \-vikeys
969 970
enable vi-like key movement.
.TP
971
.B \-wdebug
972 973 974
enable Waterloo tcp/ip packet debug (print to watt debugfile).
This applies only to DOS versions compiled with WATTCP or WATT-32.
.TP
975
.B \-width\fR=\fINUMBER
976
number of columns for formatting of dumps, default is 80.
977 978
This is limited by the number of columns that \fILynx\fP could display,
typically 1024 (the \fIMAX_LINE\fP symbol).
979
.TP
980
.B \-with_backspaces
981 982
emit backspaces in output if \fB\-dump\fR'ing or \fB\-crawl\fR'ing
(like \fBman\fP does)
983 984
.TP
.B \-xhtml_parsing
985
tells \fILynx\fP that it can ignore certain tags which have no content
986
in an XHTML 1.0 document.
987
For example \*(``<p/>\*('' will be discarded.
988
.SH COMMANDS
989 990 991
.PP
More than one key can be mapped to a given command.
Here are some of the most useful:
992
.bP
993
Use \fBUp arrow\fR and \fBDown arrow\fR to scroll through hypertext links.
994
.bP
995
\fBRight arrow\fR or \fBReturn\fR will follow a highlighted hypertext link.
996
.bP
997
\fBLeft Arrow\fR or \*(``\fBu\fR\*('' will retreat from a link.
998
.bP
999 1000
Type \*(``\fBH\fR\*('', \*(``\fB?\fR\*('', or \fBF1\fR
for online help and descriptions of key-stroke commands.
1001
.bP
1002
Type \*(``\fBk\fR\*('' or \*(``\fBK\fR\*('' for a list of the current key-stroke
1003
command mappings.
1004 1005 1006
.IP
If the same command is mapped to the same letter differing only
by upper/lowercase only the lowercase mapping is shown.
1007
.bP
1008
Type \fBDelete\fR to view history list.
1009
.SH ENVIRONMENT
1010
In addition to various \*(``standard\*('' environment variables such as
1011
\fBHOME\fR, \fBPATH\fR, \fBUSER\fR, \fBDISPLAY\fR, \fBTMPDIR\fR, \fBetc\fR,
1012
\fILynx\fR utilizes several \fILynx\fP-specific environment variables, if they
1013 1014 1015
exist.
.PP
Others may be created or modified by \fILynx\fR to pass data to an external
1016 1017
program, or for other reasons.
These are listed separately below.
1018 1019 1020 1021 1022
.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
1023 1024
supported by \fILynx\fR, though most do.
Feedback on platform dependencies is solicited.
1025 1026 1027 1028 1029
.PP
Environment Variables Used By \fILynx\fR:
.TP 20
.B COLORTERM
If set, color capability for the terminal is forced on at startup time.
1030 1031
The actual value assigned to the variable is ignored.
This variable is only meaningful if \fILynx\fR was built using the \fBslang\fR
1032
screen-handling library.
1033
.TP
1034 1035 1036 1037
.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.
1038
.IP
1039
See the userdefs.h file for more information.
1040
.TP
1041 1042 1043 1044 1045 1046
.B LYNX_CFG_PATH
If set, this variable overrides the compiled-in search-list of directories
used to find the configuration files, e.g., \fBlynx.cfg\fP and \fBlynx.lss\fP.
The list is delimited with ":" (or ";" for Windows) like the \fBPATH\fP
environment variable.
.TP
1047 1048
.B LYNX_HELPFILE
If set, this variable overrides the compiled-in URL and configuration
1049
file URL for the \fILynx\fP help file.
1050
.TP
1051 1052 1053
.B LYNX_LOCALEDIR
If set, this variable overrides the compiled-in location of the
locale directory which contains native language (NLS) message text.
1054
.TP
1055 1056
.B LYNX_LSS
This variable, if set, specifies the location of the default \fILynx\fR
1057 1058
character style sheet file.
[Currently only meaningful if \fILynx\fR was
1059
built using curses color style support.]
1060
.TP
1061 1062 1063
.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.
1064
.IP
1065
See the \fBlynx.cfg\fR file for more information.
1066
.TP
1067 1068 1069 1070
.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.
1071
.TP
1072 1073 1074
.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.
1075
.TP
1076 1077
.B NEWS_ORGANIZATION
This variable, if set, provides the string used in the \fBOrganization:\fR
1078 1079
header of \fBUSENET\fR news postings.
It will override the setting of the
1080 1081
ORGANIZATION environment variable, if it is also set (and, on \fBUNIX\fR,
the contents of an /etc/organization file, if present).
1082
.TP
1083 1084 1085
.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.
1086
.TP
1087 1088
.B ORGANIZATION
This variable, if set, provides the string used in the \fBOrganization:\fR
1089 1090
header of \fBUSENET\fR news postings.
On \fBUNIX\fR, it will override the
1091
contents of an /etc/organization file, if present.
1092
.TP
1093
.I PROTOCOL\fB_proxy\fR
1094
\fILynx\fR supports the use of proxy servers that can act as firewall
1095 1096 1097
gateways and caching servers.
They are preferable to the older gateway
servers (see WWW_access_GATEWAY, below).
1098
.IP
1099
Each protocol used by \fILynx\fR,
1100
(http, ftp, gopher, etc), can be mapped separately by setting environment
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
variables of the form \fIPROTOCOL\fP_proxy.
Protocols are indicated in a URI by the name before \*(``:\*('', e.g.,
\*(``http\*('' in 
\*(``http://some.server.dom:port/\*('' for HTML. 
.IP
Depending on your system configuration and supported protocols,
the environment variables recognized by \fIlynx\fP may include
.NS
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
.NE
.IP
1126
See \fBLynx Users Guide\fR for additional details and examples.
1127
.TP
1128 1129
.B SSL_CERT_DIR
Set to the directory containing trusted certificates.
1130
.TP
1131 1132
.B SSL_CERT_FILE
Set to the full path and filename for your file of trusted certificates.
1133
.TP
1134
.B WWW_\fIaccess\fB_GATEWAY
1135
\fILynx\fR still supports use of gateway servers, with the servers specified
1136 1137 1138 1139 1140 1141 1142
via \*(``WWW_\fIaccess\fP_GATEWAY\*('' variables
(where \*(``\fIaccess\fP\*('' 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 \fIPROTOCOL\fP_proxy environment variables.
.IP
1143
See \fBLynx Users Guide\fR for details.
1144
.TP
1145 1146 1147 1148 1149 1150 1151 1152 1153
.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
1154
string seen in the document's \*(``\fBInformation about\fR\*('' page (= cmd),
1155 1156 1157 1158
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
1159
null string under \fBUNIX\fR, or \*(``No Date\*('' under \fBVMS\fR.
1160
.TP
1161 1162 1163
.B LYNX_PRINT_LASTMOD
This variable is set by the \fILynx\fR p(rint) function, to the
\fBLast Mod:\fR
1164
string seen in the document's \*(``\fBInformation about\fR\*('' page (= cmd),
1165 1166 1167 1168
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
1169
null string under \fBUNIX\fR, or \*(``No LastMod\*('' under \fBVMS\fR.
1170
.TP
1171 1172 1173
.B LYNX_PRINT_TITLE
This variable is set by the \fILynx\fR p(rint) function, to the
\fBLinkname:\fR
1174
string seen in the document's \*(``\fBInformation about\fR\*('' page (= cmd),
1175 1176 1177 1178
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
1179
null string under \fBUNIX\fR, or \*(``No Title\*('' under \fBVMS\fR.
1180
.TP
1181 1182 1183
.B LYNX_PRINT_URL
This variable is set by the \fILynx\fR p(rint) function, to the
\fBURL:\fR
1184
string seen in the document's \*(``\fBInformation about\fR\*('' page (= cmd),
1185 1186 1187 1188
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
1189
null string under \fBUNIX\fR, or \*(``No URL\*('' under \fBVMS\fR.
1190
.TP
1191
.B LYNX_TRACE
1192
If set, causes \fILynx\fR to write a trace file as if the \fB\-trace\fR
1193 1194
option were supplied.
.TP
1195 1196
.B LYNX_TRACE_FILE
If set, overrides the compiled-in name of the trace file,
1197 1198
which is either \fBLynx.trace\fP or \fBLY\-TRACE.LOG\fP
(the latter on the DOS/Windows platforms).
1199
The trace file is in either case relative to the home directory.
1200
.TP
1201 1202
.B LYNX_VERSION
This variable is always set by \fILynx\fR, and may be used by an external
1203
program to determine if it was invoked by \fILynx\fR.
1204
.IP
1205
See also the comments
1206 1207
in the distribution's sample \fBmailcap\fR file, for notes on usage in such
a file.
1208
.TP
1209 1210
.B TERM
Normally, this variable is used by \fILynx\fR to determine the terminal type
1211 1212 1213 1214
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
1215 1216 1217 1218 1219 1220 1221 1222
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
1223