Provided by: linkchecker_5.1-1ubuntu1_i386 bug

NAME

       linkcheckerrc - configuration file for LinkChecker

DESCRIPTION

       linkcheckerrc  is the default configuration file LinkChecker.  The file
       is written in an INI-style format.

SETTINGS

   [checking]
       threads=NUMBER
              Generate no more than  the  given  number  of  threads.  Default
              number  of  threads  is  10. To disable threading specify a non-
              positive number.
              Command line option: --threads

       timeout=NUMBER
              Set the timeout for connection attempts in seconds. The  default
              timeout is 60 seconds.
              Command line option: --timeout

       anchors=[0|1]
              Check  HTTP  anchor references. Default is not to check anchors.
              This option enables logging of the warning url-anchor-not-found.
              Command line option: --anchors

       recursionlevel=NUMBER
              Check recursively all links up to given depth.  A negative depth
              will enable infinite recursion.  Default depth is infinite.
              Command line option: --recursion-level

       warningregex==REGEX
              Define a regular expression which prints a warning if it matches
              any  content  of  the  checked link.  This applies only to valid
              pages, so we can get their content.
              Use this to check for pages that contain some form of error, for
              example  "This  page  has  moved"  or "Oracle Application Server
              error".
              Command line option: --warning-regex

       warnsizebytes=NUMBER
              Print a warning if content size info is  available  and  exceeds
              the given number of bytes.
              Command line option: --warning-size-bytes

       nntpserver=STRING
              Specify   an  NNTP  server  for  news:  links.  Default  is  the
              environment variable NNTP_SERVER. If no host is given, only  the
              syntax of the link is checked.
              Command line option: --nntp-server

       checkhtml=[0|1]
              Check syntax of HTML URLs with local library (HTML tidy).
              Command line option: --check-html

       checkhtmlw3=[0|1]
              Check syntax of HTML URLs with W3C online validator.
              Command line option: --check-html-w3

       checkcss=[0|1]
              Check syntax of CSS URLs with local library (cssutils).
              Command line option: --check-css

       checkcssw3=[0|1]
              Check syntax of CSS URLs with W3C online validator.
              Command line option: --check-css-w3

       scanvirus=[0|1]
              Scan content of URLs for viruses with ClamAV.
              Command line option: --scan-virus

       clamavconf=filename
              Filename of clamd.conf config file.
              Command line option: none

   [filtering]
       ignore=REGEX (MULTILINE)
              Only   check   syntax   of   URLs  matching  the  given  regular
              expressions.
              Command line option: --ignore-url

       nofollow=REGEX (MULTILINE)
              Check but do not recurse into URLs matching  the  given  regular
              expressions.
              Command line option: --no-follow-url

       noproxyfor=REGEX (MULTILINE)
              Contact  hosts that match the given regular expressions directly
              instead of going through a proxy.
              Command line option: --no-proxy-for

       ignorewarnings=NAME[,NAME...]
              Ignore the comma-separated list of warnings. See linkchecker  -h
              for the list of recognized warnings.
              Command line option: none

       internlinks=REGEX
              Regular  expression  to  add  more  URLs  recognized as internal
              links.  Default is that URLs  given  on  the  command  line  are
              internal.
              Command line option: none

   [authentication]
       entry=REGEX USER PASS (MULTILINE)
              Provide  different user/password pairs for different link types.
              Entries  are  a  triple  (link  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  and  -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.
              Command line option: -u, -p

   [output]
       interactive=[0|1]
              Ask for URL if none are given on the commandline.
              Command line option: --interactive

       debug=STRING[,STRING...]
              Print debugging output for the given loggers.  Available loggers
              are  cmdline,  checking,  cache,  gui,  dns,  thread  and   all.
              Specifying all is an alias for specifying all available loggers.
              Command line option: --debug

       status=[0|1]
              Control printing check status messages. Default is 1.
              Command line option: --no-status

       log=TYPE[/ENCODING]
              Specify output type as text, html, sql, csv, gml, dot, xml, none
              or  blacklist.   Default  type is text. The various output types
              are documented below.
              The ENCODING specifies the output encoding, the default is  that
              of    your    locale.    Valid    encodings    are   listed   at
              http://docs.python.org/lib/standard-encodings.html.
              Command line option: --output

       verbose=[0|1]
              If set log all checked URLs once. Default is to log only  errors
              and warnings.
              Command line option: --verbose

       complete=[0|1]
              If  set log all checked URLs, even duplicates. Default is to log
              duplicate URLs only once.
              Command line option: --complete

       warnings=[0|1]
              If set log warnings. Default is to log warnings.
              Command line option: --no-warnings

       quiet=[0|1]
              If set, operate quiet. An alias  for  log=none.   This  is  only
              useful with fileoutput.
              Command line option: --verbose

       fileoutput=TYPE[,TYPE...]
              Output        to       a       files       linkchecker-out.TYPE,
              $HOME/.linkchecker/blacklist for blacklist output.
              Valid file output types are text, html, sql, csv, gml, dot, xml,
              none  or blacklist Default is no file output. The various output
              types are documented below.  Note  that  you  can  suppress  all
              console output with output=none.
              Command line option: --file-output

   [text]
       filename=STRING
              Specify  output  filename  for text logging. Default filename is
              linkchecker-out.txt.
              Command line option: --file-output=

       parts=STRING
              Comma-separated list of parts  that  have  to  be  logged.   See
              LOGGER PARTS below.
              Command line option: none

       encoding=STRING
              Valid          encodings          are          listed         in
              http://docs.python.org/lib/node127.html.   Default  encoding  is
              iso-8859-15.

       color* Color  settings  for  the  various log parts, syntax is color or
              type;color. The type can be bold,  light,  blink,  invert.   The
              color  can  be default, black, red, green, yellow, blue, purple,
              cyan, white, Black, Red, Green, Yellow, Blue,  Purple,  Cyan  or
              White.
              Command line option: none

       colorparent=STRING
              Set parent color. Default is white.

       colorurl=STRING
              Set URL color. Default is default.

       colorname=STRING
              Set name color. Default is default.

       colorreal=STRING
              Set real URL color. Default is cyan.

       colorbase=STRING
              Set base URL color. Default is purple.

       colorvalid=STRING
              Set valid color. Default is bold;green.

       colorinvalid=STRING
              Set invalid color. Default is bold;red.

       colorinfo=STRING
              Set info color. Default is default.

       colorwarning=STRING
              Set warning color. Default is bold;yellow.

       colordltime=STRING
              Set download time color. Default is default.

       colorreset=STRING
              Set reset color. Default is deault.

   [gml]
       filename=STRING
              See [text] section above.

       parts=STRING
              See [text] section above.

       encoding=STRING
              See [text] section above.

   [dot]
       filename=STRING
              See [text] section above.

       parts=STRING
              See [text] section above.

       encoding=STRING
              See [text] section above.

   [csv]
       filename=STRING
              See [text] section above.

       parts=STRING
              See [text] section above.

       encoding=STRING
              See [text] section above.

       separator=CHAR
              Set CSV separator. Default is a comma (,).

       quotechar=CHAR
              Set CSV quote character. Default is a double quote (").

   [sql]
       filename=STRING
              See [text] section above.

       parts=STRING
              See [text] section above.

       encoding=STRING
              See [text] section above.

       dbname=STRING
              Set database name to store into. Default is linksdb.

       separator=CHAR
              Set SQL command separator character. Default is a semicolor (;).

   [html]
       filename=STRING
              See [text] section above.

       parts=STRING
              See [text] section above.

       encoding=STRING
              See [text] section above.

       colorbackground=COLOR
              Set HTML background color. Default is #fff7e5.

       colorurl=
              Set HTML URL color. Default is #dcd5cf.

       colorborder=
              Set HTML border color. Default is #000000.

       colorlink=
              Set HTML link color. Default is #191c83.

       colorwarning=
              Set HTML warning color. Default is #e0954e.

       colorerror=
              Set HTML error color. Default is #db4930.

       colorok=
              Set HTML valid color. Default is #3ba557.

   [blacklist]
       filename=STRING
              See [text] section above.

       encoding=STRING
              See [text] section above.

   [xml]
       filename=STRING
              See [text] section above.

       parts=STRING
              See [text] section above.

       encoding=STRING
              See [text] section above.

   [gxml]
       filename=STRING
              See [text] section above.

       parts=STRING
              See [text] section above.

       encoding=STRING
              See [text] section above.

LOGGER PARTS

        all       (for all parts)
        id        (a unique ID for each logentry)
        realurl   (the full url link)
        result    (valid or invalid, with messages)
        extern    (1 or 0, only in some logger types reported)
        base      (base href=...)
        name      (<a href=...>name</a> and <img alt="name">)
        parenturl (if any)
        info      (some additional info, e.g. FTP welcome messages)
        warning   (warnings)
        dltime    (download time)
        checktime (check time)
        url       (the original url name, can be relative)
        intro     (the blurb at the beginning, "starting at ...")
        outro     (the blurb at the end, "found x errors ...")

MULTILINE

       Some option values can  span  multiple  lines.  Each  line  has  to  be
       indented  for  that  to  work.  Lines  starting with a hash (#) will be
       ignored, though they must still be indented.

        ignore=
          lconline
          bookmark
          # a comment
          ^mailto:

EXAMPLE

        [output]
        log=html

        [checking]
        threads=5

        [filtering]
        ignorewarnings=anchor-not-found

SEE ALSO

       linkchecker(1)

AUTHOR

       Bastian Kleineidam <calvin@users.sourceforge.net>

COPYRIGHT

       Copyright © 2000-2009 Bastian Kleineidam