From 15a185a498cf607a2ec6f72bdfdc2b46155c689f Mon Sep 17 00:00:00 2001 From: Bastian Kleineidam Date: Tue, 7 Dec 2010 21:49:28 +0100 Subject: [PATCH] Added option documentation. --- doc/Makefile | 10 ++------ doc/html/Makefile | 11 ++++++--- doc/html/html.footer | 1 + doc/html/index.html | 1 + doc/html/index.txt | 12 ++++------ doc/html/lcdoc.qhp | 5 +++- doc/html/options.html | 54 +++++++++++++++++++++++++++++++++++++++++++ doc/html/options.txt | 20 ++++++++++++++++ 8 files changed, 94 insertions(+), 20 deletions(-) create mode 100644 doc/html/options.html create mode 100644 doc/html/options.txt diff --git a/doc/Makefile b/doc/Makefile index bbdbe45f..15af9a0d 100644 --- a/doc/Makefile +++ b/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 diff --git a/doc/html/Makefile b/doc/html/Makefile index 40c92042..fe9b977e 100644 --- a/doc/html/Makefile +++ b/doc/html/Makefile @@ -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 diff --git a/doc/html/html.footer b/doc/html/html.footer index 887d08cc..f68cc09d 100644 --- a/doc/html/html.footer +++ b/doc/html/html.footer @@ -1,3 +1,4 @@ +
© Copyright 2010, Bastian Kleineidam.
diff --git a/doc/html/index.html b/doc/html/index.html index eca6fdee..a866a6f2 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -161,6 +161,7 @@ followed recursively. This is checked by searching for a

Note that the directory recursion reads all files in that directory, not just a subset like index.htm*.

+
© Copyright 2010, Bastian Kleineidam.
diff --git a/doc/html/index.txt b/doc/html/index.txt index 60455e51..ef3725ac 100644 --- a/doc/html/index.txt +++ b/doc/html/index.txt @@ -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: diff --git a/doc/html/lcdoc.qhp b/doc/html/lcdoc.qhp index 5f0d5504..3aef4684 100644 --- a/doc/html/lcdoc.qhp +++ b/doc/html/lcdoc.qhp @@ -4,10 +4,13 @@ doc -
+
+
+
index.html + options.html diff --git a/doc/html/options.html b/doc/html/options.html new file mode 100644 index 00000000..fcaf59af --- /dev/null +++ b/doc/html/options.html @@ -0,0 +1,54 @@ + + + + + + + Check websites for broken links + + + + + + +
+ + + +
LinkChecker

LinkChecker

+
+ +

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.

+
+
+ © Copyright 2010, Bastian Kleineidam. +
+ + diff --git a/doc/html/options.txt b/doc/html/options.txt new file mode 100644 index 00000000..5cd03431 --- /dev/null +++ b/doc/html/options.txt @@ -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. +