mirror of
https://github.com/Hopiu/linkchecker.git
synced 2026-03-30 20:50:27 +00:00
Added option documentation.
This commit is contained in:
Bastian Kleineidam
parent
561b89de53
commit
15a185a498
8 changed files with 94 additions and 20 deletions
10
doc/Makefile
10
doc/Makefile
|
|
@ -2,18 +2,12 @@ HTMLDIR:=$(HOME)/public_html/linkchecker.sf.net/source
|
|||
|
||||
all:
|
||||
|
||||
test:
|
||||
xmllint --valid --noout *.html
|
||||
|
||||
po4a:
|
||||
po4a --localized-charset=UTF-8 po4a.conf
|
||||
|
||||
api:
|
||||
epydoc --html -o api --name "LinkChecker source documentation" --url ../index.html ../linkcheck/
|
||||
|
||||
homepage:
|
||||
man:
|
||||
man2html -r en/linkchecker.1 | tail -n +2 > $(HTMLDIR)/man1/linkchecker.1.html
|
||||
man2html -r en/linkcheckerrc.5 | tail -n +2 > $(HTMLDIR)/man5/linkcheckerrc.5.html
|
||||
man2html -r en/linkchecker-gui.1 | tail -n +2 > $(HTMLDIR)/man1/linkchecker-gui.1.html
|
||||
|
||||
.PHONY: po4a api test homepage
|
||||
.PHONY: po4a man
|
||||
|
|
|
|||
|
|
@ -1,15 +1,20 @@
|
|||
HELPFILES = lccollection.qhc
|
||||
HTMLFILES = index.html options.html
|
||||
|
||||
all: $(HELPFILES) index.html
|
||||
all: $(HELPFILES) $(HTMLFILES)
|
||||
|
||||
.PHONY: clean
|
||||
clean:
|
||||
-rm -f *.qhc *.qch
|
||||
|
||||
%.html: %.txt html.header html.footer
|
||||
(cat html.header; markdown2 $<; cat html.footer) > index.html
|
||||
(cat html.header; markdown2 $<; cat html.footer) > $@
|
||||
|
||||
%.qhc: %.qhcp lcdoc.qhp index.html
|
||||
.PHONY: clean
|
||||
test:
|
||||
xmllint --valid --noout $(HTMLFILES)
|
||||
|
||||
%.qhc: %.qhcp lcdoc.qhp $(HTMLFILES)
|
||||
qcollectiongenerator $< -o $@
|
||||
|
||||
favicon.ico: favicon32x32.png favicon16x16.png
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
<hr/>
|
||||
<div class="footer">
|
||||
© Copyright 2010, Bastian Kleineidam.
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -161,6 +161,7 @@ followed recursively. This is checked by searching for a
|
|||
|
||||
<p>Note that the directory recursion reads all files in that
|
||||
directory, not just a subset like <code>index.htm*</code>.</p>
|
||||
<hr/>
|
||||
<div class="footer">
|
||||
© Copyright 2010, Bastian Kleineidam.
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,6 @@
|
|||
Documentation
|
||||
=============
|
||||
# Documentation
|
||||
|
||||
Basic usage
|
||||
-----------
|
||||
## Basic usage
|
||||
|
||||
To check a URL like ``http://www.example.org/`` it is enough to
|
||||
type ``linkchecker www.example.org/`` on the command line or
|
||||
|
|
@ -10,8 +8,7 @@ type ``www.example.org`` in the GUI application. This will check the
|
|||
complete domain of ``http://www.example.org`` recursively. All links
|
||||
pointing outside of the domain are also checked for validity.
|
||||
|
||||
Performed checks
|
||||
----------------
|
||||
## Performed checks
|
||||
|
||||
All URLs have to pass a preliminary syntax test. Minor quoting
|
||||
mistakes will issue a warning, all other invalid syntax issues
|
||||
|
|
@ -117,8 +114,7 @@ checking. All connection check types are described below.
|
|||
- ``z39.50s:`` (Z39.50 Session)
|
||||
|
||||
|
||||
Recursion
|
||||
---------
|
||||
## Recursion
|
||||
|
||||
Before descending recursively into a URL, it has to fulfill several
|
||||
conditions. They are checked in this order:
|
||||
|
|
|
|||
|
|
@ -4,10 +4,13 @@
|
|||
<virtualFolder>doc</virtualFolder>
|
||||
<filterSection>
|
||||
<toc>
|
||||
<section title="LinkChecker Application Manual" ref="index.html" />
|
||||
<section title="LinkChecker application manual" ref="index.html">
|
||||
<section title="LinkChecker options" ref="options.html" />
|
||||
</section>
|
||||
</toc>
|
||||
<files>
|
||||
<file>index.html</file>
|
||||
<file>options.html</file>
|
||||
</files>
|
||||
</filterSection>
|
||||
</QtHelpProject>
|
||||
|
|
|
|||
54
doc/html/options.html
Normal file
54
doc/html/options.html
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Check websites for broken links</title>
|
||||
<link rel="stylesheet" href="sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="pygments.css" type="text/css" />
|
||||
<style type="text/css">
|
||||
img { border: 0; }
|
||||
</style>
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
|
||||
<table border="0"><tr>
|
||||
<td><img
|
||||
src="logo64x64.png" border="0" alt="LinkChecker"/></td>
|
||||
<td><h1>LinkChecker</h1></td>
|
||||
</tr></table>
|
||||
</div>
|
||||
|
||||
<h1>Options</h1>
|
||||
|
||||
<h2>GUI options</h2>
|
||||
|
||||
<p>The most common check options are configurable.
|
||||
They override any configuration file settings.</p>
|
||||
|
||||
<h3>Recursive depth</h3>
|
||||
|
||||
<p>Check recursively all links up to given depth.
|
||||
A negative depth will enable infinite recursion.</p>
|
||||
|
||||
<h3>Verbose output</h3>
|
||||
|
||||
<p>Log all checked URLs once. Default is to log only errors and warnings.</p>
|
||||
|
||||
<h3>Debug</h3>
|
||||
|
||||
<p>Log debugging output for each check.
|
||||
It can be displayed with Help->Show Debug</p>
|
||||
|
||||
<h2>Configuration files</h2>
|
||||
|
||||
<p>The configuration files can be edited with an integrated text editor.</p>
|
||||
<hr/>
|
||||
<div class="footer">
|
||||
© Copyright 2010, Bastian Kleineidam.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
20
doc/html/options.txt
Normal file
20
doc/html/options.txt
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
# Options
|
||||
|
||||
## GUI options
|
||||
The most common check options are configurable.
|
||||
They override any configuration file settings.
|
||||
|
||||
### Recursive depth
|
||||
Check recursively all links up to given depth.
|
||||
A negative depth will enable infinite recursion.
|
||||
|
||||
### Verbose output
|
||||
Log all checked URLs once. Default is to log only errors and warnings.
|
||||
|
||||
### Debug
|
||||
Log debugging output for each check.
|
||||
It can be displayed with Help->Show Debug
|
||||
|
||||
## Configuration files
|
||||
The configuration files can be edited with an integrated text editor.
|
||||
|
||||
Loading…
Reference in a new issue