aniani/elinks
1
0
Fork 0
mirror of https://github.com/rkd77/elinks.git synced 2024-12-04 14:46:47 -05:00
Code
e5722ad0d9
elinks/doc/elinks.conf.5.txt

72 lines
2.0 KiB
Plaintext
Raw Normal View History

Minor fixes
2006-01-12 05:08:18 -05:00
elinks.conf(5)
Make elinks.conf(5) also be build from .txt files This simplifies help2doc since it now just have to do one single thing with output of either --config-help or --long-help. The new manpage is not as fancy wrt. indentation and sub titles but it is more uniform and we get a HTML version. Generate options-{config,command}.txt with help2doc. Only conditionally check for API header files, to speed up execusion.
2006-01-12 02:33:50 -05:00
==============
Add description header to be used for the man hack
2006-01-12 04:30:25 -05:00
:Description: ELinks configuration file
Make elinks.conf(5) also be build from .txt files This simplifies help2doc since it now just have to do one single thing with output of either --config-help or --long-help. The new manpage is not as fancy wrt. indentation and sub titles but it is more uniform and we get a HTML version. Generate options-{config,command}.txt with help2doc. Only conditionally check for API header files, to speed up execusion.
2006-01-12 02:33:50 -05:00
NAME
----
elinks.conf - ELinks configuration file
SYNOPSIS
--------
[verse]
elinks.conf.5: quoting corrections In set and unset commands, the <option> must not be quoted. In the sample protocol.user.mailto.unix setting, the internal quotes were using some manpage syntax, resulting in incorrect HTML output.
2008-03-06 03:23:21 -05:00
set <option> = <value>
unset <option>
Make elinks.conf(5) also be build from .txt files This simplifies help2doc since it now just have to do one single thing with output of either --config-help or --long-help. The new manpage is not as fancy wrt. indentation and sub titles but it is more uniform and we get a HTML version. Generate options-{config,command}.txt with help2doc. Only conditionally check for API header files, to speed up execusion.
2006-01-12 02:33:50 -05:00
bind "<keymap>" "<key>" = "<action>"
include "<file>"
DESCRIPTION
-----------
The `elinks.conf` file contains configuration information for ELinks. It can
be used to configure the behaviour of ELinks in a wide variety of ways:
protocol behaviour, keybindings, colors used for rendering and for the user
interface.
It is read at startup and saved only when requested. All options described in
this document can be fully configured from within ELinks so no editing of
elinks.conf is needed.
Note that MIME-related options used for specifying handlers of various MIME
types are NOT described in this document. Documentation for these options can
be found at the ELinks homepage. Keybindings can also be specified in
Use man:[] macro for all manpage references
2006-01-12 05:34:56 -05:00
elinks.conf. This is described in man:elinkskeys[5].
Make elinks.conf(5) also be build from .txt files This simplifies help2doc since it now just have to do one single thing with output of either --config-help or --long-help. The new manpage is not as fancy wrt. indentation and sub titles but it is more uniform and we get a HTML version. Generate options-{config,command}.txt with help2doc. Only conditionally check for API header files, to speed up execusion.
2006-01-12 02:33:50 -05:00
SYNTAX
------
The syntax of the configuration file is very simple. The elinks.conf file is a
free-form ASCII text file. The file may contain extra tabs and newlines for
formatting purposes. Keywords in the file are case-sensitive. Comments may be
placed anywhere within the file (except within quotes). Comments begin with
the # character and end at the end of the line.
EXAMPLES
--------
Some sample settings:
# Use asynchronous DNS resolver?
set connection.async_dns = 1
# horizontal text margin.
set document.browse.margin_width = 3
# Default document codepage.
set document.codepage.assume = "ISO-8859-1"
# User defined protocol handlers
elinks.conf.5: quoting corrections In set and unset commands, the <option> must not be quoted. In the sample protocol.user.mailto.unix setting, the internal quotes were using some manpage syntax, resulting in incorrect HTML output.
2008-03-06 03:23:21 -05:00
set protocol.user.mailto.unix = "mutt %h -s \"%s\""
Make elinks.conf(5) also be build from .txt files This simplifies help2doc since it now just have to do one single thing with output of either --config-help or --long-help. The new manpage is not as fancy wrt. indentation and sub titles but it is more uniform and we get a HTML version. Generate options-{config,command}.txt with help2doc. Only conditionally check for API header files, to speed up execusion.
2006-01-12 02:33:50 -05:00
OPTIONS
-------
Generate DocBook and XHTML with help2xml. The older help2doc script is no longer used for anything. To make future cherry-picking easier, this commit does not include the resulting changes in generated files.
2008-05-03 11:30:26 -04:00
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
ifdef::backend-docbook[]
include1::{builddir}option-config.frag.xml[]
endif::backend-docbook[]
ifdef::backend-xhtml11[]
include1::{builddir}option-config.frag.xhtml[]
endif::backend-xhtml11[]
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Make elinks.conf(5) also be build from .txt files This simplifies help2doc since it now just have to do one single thing with output of either --config-help or --long-help. The new manpage is not as fancy wrt. indentation and sub titles but it is more uniform and we get a HTML version. Generate options-{config,command}.txt with help2doc. Only conditionally check for API header files, to speed up execusion.
2006-01-12 02:33:50 -05:00
SEE ALSO
--------
man:elinks[1], man:elinkskeys[5]
Copy Permalink