Improved configuration documentation.

This commit is contained in:
Bastian Kleineidam 2010-10-25 21:42:11 +02:00
parent 860db4050b
commit a254e1dce0

View file

@ -63,7 +63,7 @@
[gml]
#filename=linkchecker-out.gml
#parts=all
# valid encodings are listed in http://docs.python.org/lib/node127.html
# valid encodings are listed in http://docs.python.org/library/codecs.html#standard-encodings
# default encoding is iso-8859-15
#encoding=utf_16
@ -71,7 +71,6 @@
[dot]
#filename=linkchecker-out.dot
#parts=all
# valid encodings are listed in http://docs.python.org/lib/node127.html
# default encoding is ascii since the original DOT format does not
# support other charsets
#encoding=iso-8859-15
@ -156,8 +155,8 @@
# do not recurse into the following URLs
#nofollow=
# just a homepage
# http://justahomepage/bla
# just an example
# http://www\.example\.com/bla
# Ignore specified warnings (see linkchecker -h for the list of
# recognized warnings). Add a comma-separated list of warnings here
@ -167,19 +166,21 @@
# Regular expression to add more URLs recognized as internal links.
# Default is that URLs given on the command line are internal.
#internlinks=^http://www\.my(other)?domain\.net/
#internlinks=^http://www\.example\.net/
[authentication]
# You can provide different user/password pairs for different link types.
# Entries are a triple (link regular expression, username, password),
# You can provide different user/password pairs for different URLs.
# Entries are a triple (URL regular expression, username, password),
# separated by whitespace.
# If the regular expression matches, the given user/password pair is used
# for authentication. The commandline options -u,-p match every link
# and therefore override the entries given here. The first match wins.
# At the moment, authentication is used/needed for http[s] and ftp links.
# At the moment, authentication is used for http[s] and ftp links.
#entry=
# ^http://treasure\.calvinsplayground\.de/~calvin/isnichmehr/ lebowski lebowski
# ^ftp://void.cs.uni-sb.de calvin hutzli
# Note that passwords are optional. If you type any passwords here, please
# make this file not readable by other users.
# ^https?://www\.example\.com/~calvin/ lebowski lebowski
# ^ftp://www\.example\.com/secret/ calvin
# if the website requires a login the URL and optionally the user and
# password CGI fieldnames can be provided.