lynx - a general purpose distributed information browser for the World Wide Web
2. SYNOPSIS ▲
lynx \fP[options] [path or URL]
lynx [options] [path or URL] \fB-get_data
lynx [options] [path or URL] \fB-post_data
Use "lynx -help" to display a complete list of current options.
3. DESCRIPTION ▲
.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.
.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.
4. OPTIONS ▲
At start up, Lynx will load any local file or remote URL specified at the command line. For help with URLs, press "?" or "H" while running Lynx. Then follow the link titled, "Help on URLs."
If more than one local file or remote URL is listed on the command line, Lynx will open only the last interactively. All of the names (local files and remote URLs) are added to the G)oto history.
Lynx 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).
Lynx provides many command-line options. Some options require a value (string, number or keyword). These are noted in the reference below. The other options set boolean values in the program. There are three 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.,
Lynx recognizes "1", "+", "on" and "true" for true values, and "0", "-", "off" and "false" for false values. Other option-values are ignored.
The default boolean, number and string option values that are compiled into Lynx are displayed in the help-message provided by lynx -help. Some of those may differ according to how Lynx was built; see the help message itself for these values. The -help option is processed in the third pass of options-processing, so any option which sets a value, as well as runtime configuration values are reflected in the help-message.
If the argument is only '-', then Lynx expects to receive the arguments from the standard input. This is to allow for the potentially very long command line that can be associated with the -get_data or -post_data arguments (see below). It can also be used to avoid having sensitive information in the invoking command line (which would be visible to other processes on most systems), especially when the -auth or -pauth options are used.
accept all cookies.
apply restrictions for anonymous account, see also -restrictions.
charset for documents that don't specify it.
charset assumed for local files, i.e., files which Lynx creates such as internal pages for the options menu.
use this instead of unrecognized charsets.
set authorization ID and password for protected documents at startup. Be sure to protect any script files which use this switch.
prepend a request URL comment and BASE tag to text/html outputs for -source dumps.
specify a local bibp server (default http://bibhost/).
forces high intensity background colors for color mode, if available and supported by the terminal. This applies to the slang library (for a few terminal emulators), or to OS/2 EMX with ncurses.
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.
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.
set the NUMBER of documents cached in memory. The default is 10.
enable case-sensitive string searching.
Toggle center alignment in HTML TABLE.
specifies a Lynx configuration file other than the default lynx.cfg.
exit on left-arrow in startfile, and disable save to disk and associated print/mail options.
exit on left-arrow in startfile, but allow save to disk and associated print/mail options.
write keystroke commands and related information to the specified file.
read keystroke commands from the specified file. You can use the data written using the -cmd_log option. Lynx will ignore other information which the command-logging may have written to the logfile. Each line of the command script contains either a comment beginning with "#", or a keyword:
causes the script to stop, and forces Lynx to exit immediately.
the character value, in printable form. Cursor and other special keys are given as names, e.g., "Down Arrow". Printable 7-bit ASCII codes are given as-is, and hexadecimal values represent other 8-bit codes.
followed by a "name=value" allows one to override values set in the lynx.cfg file.
forces color mode on, if available. Default color control sequences which work for many terminal types are assumed if the terminal capability description does not specify how to handle color. Lynx needs to be compiled with the slang library for this flag, it is equivalent to setting the COLORTERM environment variable. (If color support is instead provided by a color-capable curses library like ncurses, Lynx relies completely on the terminal description to determine whether color mode is possible, and this flag is not needed and thus unavailable.) A saved show_color=always setting found in a .lynxrc file at startup has the same effect. A saved show_color=never found in .lynxrc on startup is overridden by this flag.
Sets the connection timeout, where N is given in seconds.
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.
specifies a file to use to store cookies. If none is specified, the value given by -cookie_file is used.
toggles handling of Set-Cookie headers.
toggles forced core dumps on fatal errors. Turn this option off to ask Lynx to force a core dump if a fatal error occurs.
with -traversal, output each page to a file. with -dump, format output as with -traversal, but to the standard output.
toggles the use of curses "pad" feature which supports left/right scrolling of the display.
separate incremental display stages with MessageSecs delay
add DebugSecs delay after each progress-message
set the display variable for X rexec-ed programs.
set the charset for the terminal output.
inhibit wrapping of text in <pre> when -dump'ing and -crawl'ing, mark wrapped lines in interactive session.
dumps the formatted output of the default document or those specified on the command line to standard output. Unlike interactive mode, all documents are processed. This can be used in the following way:
lynx -dump http://www.subir.com/lynx.html
enable external editing, using the specified EDITOR. (vi, ed, emacs, etc.)
enable emacs-like key movement.
toggles compatibility with communication programs' scrollback keys (may be incompatible with some curses packages).
define a file where Lynx will report HTTP access codes.
enable local program execution (normally not configured).
include all versions of files in local VMS directory listings.
toggle memory leak-checking. Normally this is not compiled-into your executable, but when it is, it can be disabled for a session.
force HREF-less 'A' elements to be empty (close them as soon as they are seen).
forces the first document to be interpreted as HTML.
toggles forcing of the secure flag for SSL cookies.
toggles whether the Options Menu is key-based or form-based.
toggles transmissions of From headers.
disable ftp access.
properly formatted data for a get form are read in from the standard input and passed to the form. Input is terminated by a line that starts with '---'.
send a HEAD request for the mime headers.
print the Lynx command syntax usage message, and exit.
control the display of hidden links.
hidden links show up as bracketed numbers and are numbered together with other links in the sequence of their occurrence in the document.
hidden links are shown only on L)ist screens and listings generated by
-dump or from the P)rint menu, but appear separately at the end of those lists. This is the default behavior.
hidden links do not appear even in listings.
toggles use of '>' or '-->' as a terminator for comments.
set homepage separate from start page.
toggles inclusion of links for all images.
set the default index file to the specified URL.
toggles inclusion of ISMAP links when client-side MAPs are present.
do justification of text.
starting count for lnk#.dat files produced by -crawl.
for -dump, show only the list of links.
disable URLs that point to remote hosts.
enable local program execution from local files only (if Lynx was compiled with local execution enabled).
specify filename containing color-style information. The default is lynx.lss. If you give an empty filename, lynx uses a built-in monochrome scheme which imitates the non-color-style configuration.
prints the MIME header of a fetched document along with its source.
toggles minimal versus valid comment parsing.
toggles nested-tables logic (for debugging).
number of articles in chunked news listings.
maximum news articles in listings before chunking.
disable bold video-attribute.
disable directory browsing.
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.
force color mode off, overriding terminal capabilities and any -color flags, COLORTERM variable, and saved .lynxrc settings.
disable local program execution. (DEFAULT)
disable transmissions of Referer headers for file URLs.
disable the link list feature in dumps.
disable mailing of error messages to document owners.
disable left/right margins in the default style sheet.
disable -more- string in statusline messages.
This flag is not available on all systems, Lynx needs to be compiled with HAVE_SIGACTION defined. If available, this flag may\fR cause \fILynx to react more immediately to window changes when run within an xterm.
disable link- and field-numbering. This overrides -number_fields and -number_links.
disable forced pauses for statusline messages.
disable most print functions.
prevents automatic redirection and prints a message with a link to the new URL.
disable transmissions of Referer headers.
disable reverse video-attribute.
disable SOCKS proxy usage by a SOCKSified Lynx.
disable the retrieval status messages.
disable title and blank line from top of page.
disable underline video-attribute.
force numbering of links as well as form input fields
force numbering of links.
toggles display partial pages while loading.
number of lines to render before repainting display with partial-display logic
toggles passive ftp connections.
set authorization ID and password for a protected proxy server at startup. Be sure to protect any script files which use this switch.
toggles handling of single-choice SELECT options via popup windows or as lists of radio buttons.
properly formatted data for a post form are read in from the standard input and passed to the form. Input is terminated by a line that starts with '---'.
show HTML source preparsed and reformatted when used with -source or in source view.
show HTML source view with lexical elements and tags in color.
enable print functions. (default)
toggles pseudo-ALTs for inline images with no ALT string.
toggles default setting of 8-bit character translations or CJK mode for the startup character set.
restricts access to URLs in the starting realm.
Sets the read-timeout, where N is given in seconds.
flushes the cache on a proxy server (only the first document affected).
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.
restricts all options listed below.
disallow changing the location of the bookmark file.
disallow execution links via the bookmark file.
disallow changing the eXecute permission on files (but still allow it for directories) when local file management is enabled.
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.
disallow local file management.
disallow saving to disk in the download and print menus.
disallow access to, or creation of, hidden (dot) files.
disallow some downloaders in the download menu (does not imply disk_save restriction).
disallow external editing.
disable execution scripts.
disallow the user from changing the local execution option.
disallow some "EXTERNAL" configuration lines if support for passing URLs to external applications (with the EXTERN command) is compiled in.
disallow using G)oto, served links or bookmarks for file: URLs.
disable the 'g' (goto) command.
disallow ftps for people coming from inside your domain (utmp required for selectivity).
disallow USENET news posting for people coming from inside your domain (utmp required for selectivity).
disallow rlogins for people coming from inside your domain (utmp required for selectivity).
disallow telnets for people coming from inside your domain (utmp required for selectivity).
disable the 'j' (jump) command.
disallow multiple bookmarks.
disallow USENET News posting.
disallow saving options in .lynxrc.
disallow ftps for people coming from outside your domain (utmp required for selectivity).
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.
disallow rlogins for people coming from outside your domain (utmp required for selectivity).
disallow telnets for people coming from outside your domain (utmp required for selectivity).
disallow most print options.
disallow shell escapes and lynxexec or lynxprog G)oto's.
disallow Unix Control-Z suspends with escape to shell.
disallow specifying a port in telnet G)oto's.
disallow modifications of the User-Agent header.
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.
disable recognition of rlogin commands.
toggles showing scrollbar.
toggles showing arrows at ends of the scrollbar.
require .www_browsable files to browse directories.
resumes from specified file on startup and saves session to that file on exit.
resumes session from specified file.
saves session to specified file.
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.
Print the configuration settings, e.g., as read from "lynx.cfg", and exit.
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.
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.
toggles emulation of the old Netscape and Mosaic bug which treated '>' as a co-terminator for double-quotes and tags.
works the same as dump but outputs HTML source instead of formatted text. For example
lynx -source . >foo.html
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:
lynx -source ./ >foo.html
disable SIGINT cleanup handler
allow non-http startfile and homepage with -validate.
When dumping a document using -dump or -source, Lynx normally does not display alert (error) messages that you see on the screen in the status line. Use the -stderr option to tell Lynx to write these messages to the standard error.
read the startfile from standard input (UNIX only).
information for syslog call.
log requested URLs with syslog.
initialize parser, using Tag Soup DTD rather than SortaSGML.
disable recognition of telnet commands.
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.)
For win32, sets the network read-timeout, where N is given in seconds.
toggles between using a Lynx Trace Log and stderr for trace output from the session.
turns on "Textfields Need Activation" mode.
turns on Lynx trace mode. Destination of trace output depends on -tlog.
turn on optional traces, which may result in very large trace files. Logically OR the values to combine options:
SGML character parsing states
TRST (table layout)
configuration (lynx.cfg, .lynxrc, .lynx-keymaps, mime.types and mailcap contents)
binary string copy/append, used in form data construction.
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.
trim input text/textarea fields in forms.
toggles use of underline/bold attribute for links.
toggles use of _underline_ format in dumps.
turn on mouse support, if available. Clicking the left mouse button on a link traverses it. Clicking the right mouse button pops back. Click on the top line to scroll up. Click on the bottom line to scroll down. The first few positions in the top and bottom line may invoke additional functions. Lynx must be compiled with ncurses or slang to support this feature. If ncurses is used, clicking the middle mouse button pops up a simple menu. Mouse clicks may only work reliably while Lynx is idle waiting for input.
set alternate Lynx User-Agent header.
accept only http URLs (for validation). Complete security restrictions also are implemented.
toggle [LINK], [IMAGE] and [INLINE] comments with filenames of these images.
print version information, and exit.
enable vi-like key movement.
enable Waterloo tcp/ip packet debug (print to watt debugfile). This applies only to DOS versions compiled with WATTCP or WATT-32.
number of columns for formatting of dumps, default is 80. This is limited by the number of columns that Lynx could display, typically 1024 (the MAX_LINE symbol).
emit backspaces in output if -dump'ing or -crawl'ing (like 'man' does)
tells Lynx that it can ignore certain tags which have no content in an XHTML 1.0 document. For example "<p/>" will be discarded.
5. COMMANDS ▲
Use Up arrow and Down arrow to scroll through hypertext links.
Right arrow or Return will follow a highlighted hypertext link.
Left Arrow will retreat from a link.
Type "H" or "?" for online help and descriptions of key-stroke commands.
Type "K" for a complete list of the current key-stroke command mappings.
6. ENVIRONMENT ▲
In addition to various "standard" environment variables such as HOME, PATH, USER, DISPLAY, TMPDIR, etc, Lynx\fR utilizes several \fILynx-specific environment variables, if they exist.
Others may be created or modified by Lynx to pass data to an external program, or for other reasons. These are listed separately below.
See also the sections on SIMULATED CGI SUPPORT and NATIVE LANGUAGE SUPPORT, below.
Note: Not all environment variables apply to all types of platforms supported by Lynx, though most do. Feedback on platform dependencies is solicited.
Environment Variables Used By Lynx:
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 Lynx was built using the slang screen-handling library.
This variable, if set, will override the default location and name of the global configuration file (normally, lynx.cfg) that was defined by the LYNX_CFG_FILE constant in the userdefs.h file, during installation. See the userdefs.h file for more information.
If set, this variable overrides the compiled-in URL and configuration file URL for the Lynx help file.
If set, this variable overrides the compiled-in location of the locale directory which contains native language (NLS) message text.
This variable, if set, specifies the location of the default Lynx character style sheet file. [Currently only meaningful if Lynx was built using experimental color style support.]
This variable, if set, will override the default path prefix for files saved to disk that is defined in the lynx.cfg SAVE_SPACE: statement. See the lynx.cfg file for more information.
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 TMPDIR variable.
This variable specifies the default inbox Lynx will check for new mail, if such checking is enabled in the lynx.cfg file.
This variable, if set, provides the string used in the Organization: header of USENET news postings. It will override the setting of the ORGANIZATION environment variable, if it is also set (and, on UNIX, the contents of an /etc/organization file, if present).
If set, this variable specifies the default NNTP server that will be used for USENET news reading and posting with Lynx, via news: URL's.
This variable, if set, provides the string used in the Organization: header of USENET news postings. On UNIX, it will override the contents of an /etc/organization file, if present.
Lynx 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 Lynx, (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 Lynx Users Guide for additional details and examples.
Set to the directory containing trusted certificates.
Set to the full path and filename for your file of trusted certificates.
Lynx still supports use of gateway servers, with the servers specified via "WWW_access_GATEWAY" variables (where "access" is lower case and can be "http", "ftp", "gopher" or "wais"), however most gateway servers have been discontinued. Note that you do not include a terminal '/' for gateways, but do for proxies specified by PROTOCOL_proxy environment variables. See Lynx Users Guide for details.
This variable, if set, will override the default startup URL specified in any of the Lynx configuration files.
Environment Variables Set or Modified By Lynx:
This variable is set by the Lynx p(rint) function, to the Date: string seen in the document's "Information about" page (= cmd), if any. It is created for use by an external program, as defined in a lynx.cfg PRINTER: definition statement. If the field does not exist for the document, the variable is set to a null string under UNIX, or "No Date" under VMS.
This variable is set by the Lynx p(rint) function, to the Last Mod: string seen in the document's "Information about" page (= cmd), if any. It is created for use by an external program, as defined in a lynx.cfg PRINTER: definition statement. If the field does not exist for the document, the variable is set to a null string under UNIX, or "No LastMod" under VMS.
This variable is set by the Lynx p(rint) function, to the Linkname: string seen in the document's "Information about" page (= cmd), if any. It is created for use by an external program, as defined in a lynx.cfg PRINTER: definition statement. If the field does not exist for the document, the variable is set to a null string under UNIX, or "No Title" under VMS.
This variable is set by the Lynx p(rint) function, to the URL: string seen in the document's "Information about" page (= cmd), if any. It is created for use by an external program, as defined in a lynx.cfg PRINTER: definition statement. If the field does not exist for the document, the variable is set to a null string under UNIX, or "No URL" under VMS.
If set, causes Lynx to write a trace file as if the -trace option were supplied.
If set, overrides the compiled-in name of the trace file, which is either Lynx.trace or LY-TRACE.LOG (the latter on the DOS platform). The trace file is in either case relative to the home directory.
This variable is always set by Lynx, and may be used by an external program to determine if it was invoked by Lynx. See also the comments in the distribution's sample mailcap file, for notes on usage in such a file.
Normally, this variable is used by Lynx to determine the terminal type being used to invoke Lynx. If, however, it is unset at startup time (or has the value "unknown"), or if the -term command-line option is used (see OPTIONS section above), Lynx will set or modify its value to the user specified terminal type (for the Lynx execution environment). Note: If set/modified by Lynx, the values of the LINES and/or COLUMNS environment variables may also be changed.
7. SIMULATED CGI SUPPORT ▲
If built with the cgi-links option enabled, Lynx allows access to a cgi script directly without the need for an http daemon.
When executing such "lynxcgi scripts" (if enabled), the following variables may be set for simulating a CGI environment:
Other environment variables are not inherited by the script, unless they are provided via a LYNXCGI_ENVIRONMENT statement in the configuration file. See the lynx.cfg file, and the (draft) CGI 1.1 Specification <http://Web.Golux.Com/coar/cgi/draft-coar-cgi-v11-00.txt> for the definition and usage of these variables.
The CGI Specification, and other associated documentation, should be consulted for general information on CGI script programming.
8. NATIVE LANGUAGE SUPPORT ▲
If configured and installed with Native Language Support, Lynx will display status and other messages in your local language. See the file ABOUT_NLS in the source distribution, or at your local GNU site, for more information about internationalization.
The following environment variables may be used to alter default settings:
This variable, if set, will override the default message language. It is an ISO 639 two-letter code identifying the language. Language codes are NOT the same as the country codes given in ISO 3166.
This variable, if set, will override the default message language. This is a GNU extension that has higher priority for setting the message catalog than LANG or LC_ALL.
These variables, if set, specify the notion of native language formatting style. They are POSIXly correct.
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.
This variable, if set, is used as the path prefix for message catalogs.
9. NOTES ▲
This is the Lynx v2.8.7 Release; development is in progress for 2.8.8.
If you wish to contribute to the further development of Lynx, subscribe to our mailing list. Send email to < > with "subscribe lynx-dev" as the only line in the body of your message.
Send bug reports, comments, suggestions to < > after subscribing.
Unsubscribe by sending email to < > 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.
10. SEE ALSO ▲
catgets(3), curses(3), environ(7), execve(2), ftp(1), gettext(GNU), localeconv(3), ncurses(3), setlocale(3), slang(?), termcap(5), terminfo(5), wget(GNU)
Note that man page availability and section numbering is somewhat platform dependent, and may vary from the above references.
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").
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).
11. 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).
12. AUTHORS ▲
Lou Montulli, Garrett Blythe, Craig Lavender, Michael Grobe, Charles Rezac
Academic Computing Services
University of Kansas
Lawrence, Kansas 66047
Worcester Foundation for Biomedical Research
Shrewsbury, Massachusetts 01545
Thomas E. Dickey