# The &klinkstatus; Handbook

## Introduction

&klinkstatus; is a link checker for &kde;. It allows you to search internal and external links in your entire web site, just a single page and choose the depth to search. You can also check local files, ftp, fish, &etc;, as &klinkstatus; uses KIO. For performance, links can be checked simultaneously.

Application capabilities can be extended with Kross scripting.

## Using &klinkstatus;

To check links on a web site or local file enter its address into the URL: field and hit &Enter;. You can also use folder icon to the right to navigate to the address needed using &GUI;.

Here's a screenshot of &klinkstatus; Screenshot

&klinkstatus; is checking links on KDevelop web site. Broken and malformed links are marked with red.

If access to the inspected data is restricted, please check the Login option. After hitting &Enter; in &URL; field or push Start Search button on the toolbar the following dialog will be shown to enter the credentials.

Credentials dialog of &klinkstatus; Credentials dialog of &klinkstatus;

&klinkstatus; is asking you to enter the credentials.

Enter the credentials and push OK button.

You can narrow down the range of the links to be checked by unchecking Check external links item (if external links need not to be checked) or entering regular expression into Do not check Regular Expression field.

Search results can be filtered using Search field or Status drop-down menu (All Links, Good Links, Broken Links, Malformed Links, or Undetermined Links).

From the context menu of each item in search results you can Recheck item, Edit Referrer in the default editor, Open URL, Open Referrer URL, Copy URL, Copy Referrer URL, or Copy Cell Text.

The check results can be saved as &XML; site map using File Create Site Map... menu item, or exported as &HTML; using File Export to HTML. You can choose to export All or just Broken links. An option Download New Stylesheets to use stylesheets from Get Hot New Stuff repository for export is also implemented.

## Configuring &klinkstatus;

Configuration options of &klinkstatus; can be accessed by opening the configuration dialog with selecting Settings Configure &klinkstatus;... from the menu.

Configure &klinkstatus; Dialog Check

In the Check page, you can change the default check parameters. This page is divided into three panes (Network, Input, and Quanta) with additional checkbox Remember settings when exit. If the latter is checked, &klinkstatus; remember configured settings when you exit &klinkstatus; and restore them during the next application run.

The Network pane can be used to choose the Number of simultaneous connections and Timeout in seconds.

You can change the Number of items in &URL; history (default is 50) and the Depth of check (can be overriden with &klinkstatus; main window, 0 for Unlimited). You can also decide if &klinkstatus; should Check parent folders and Check external links (can be overriden with &klinkstatus; main window).

The Quanta pane is used to control &quantaplus; integration of &klinkstatus;. Check Use preview prefix if you want to use &quantaplus;'s project preview prefix in the &URL; to check.

Configure &klinkstatus; Dialog Results

Using the Results page you can choose format of the check results list. Tree is the default tree view and Flat is the flat list (can be faster on low-end machines). You can also let &klinkstatus; Follow Last Link Checked and define Preferred Style Sheet for the check list. The new stylesheets can be downloaded from the Get Hot New Stuff repository using File Export to HTML Download New Stylesheets menu item.

Configure &klinkstatus; Dialog Identification

Using the Identification page you can configure the way &klinkstatus; reports itself to the server that stores the page checked. You can choose to Send Identification. Use Default button to set the default identification of &konqueror;. Identity pane can be used to choose your identity for authentication on the server.

Configure &klinkstatus; Dialog Mail Transport

Using the Mail Transport page, you can configure email account which receives &klinkstatus; scheduled check results.

## Credits and License

&klinkstatus;

Program copyright 2004 Paulo Moura Guedes pmg@netcabo.pt

Documentation copyright 2004 Paulo Moura Guedes pmg@netcabo.pt

&underFDL; &underGPL;

## Installation and Compilation

&install.intro.documentation; &install.compile.documentation;
&documentation.index;