Files
httrack/html/index.html
Xavier Roche 6b9740dbc2 The documentation index is a 1998 bullet list, and the overview is one paragraph (#878)
The documentation index is the page WinHTTrack opens for generic Help and the one httrack.com links as "Documentation", and it presented twenty destinations as a flat bullet list with nothing to say which one a newcomer wants. It is now a task-grouped hub in the interface guide's idiom, with overview.html folded in as the lede and refreshed for 3.50, and Fred Cohen's guide under an Archive heading labelled as written for 3.10, keeping its URL.

The chrome the hub needs is split out of guide.css into doc.css; guide.css keeps the platform switcher, tab strip and option entries. guide.html renders pixel-identically before and after the split at 1100px and 390px, in light and dark.

overview.html, start.html and cmddoc.html become meta-refresh stubs, like the retired step pages. start.html was a window.open popup launcher and cmddoc.html has 404ed since #661 deleted it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Signed-off-by: Xavier Roche <roche@httrack.com>
2026-07-30 07:23:05 +00:00

112 lines
4.0 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Documentation for HTTrack Website Copier: the interface guide for Windows, Linux and Android, the command-line guide and option reference, filter syntax, the FAQ, and the developer documentation.">
<meta name="keywords" content="httrack, WinHTTrack, WebHTTrack, HTTrack Android, documentation, offline browser, website mirroring, web mirror utility, FAQ, command line, options, filters">
<title>HTTrack documentation</title>
<link rel="stylesheet" href="doc.css">
</head>
<body>
<a class="skip" href="#main">Skip to content</a>
<header class="masthead">
<img src="images/header_title_4.gif" width="400" height="34" alt="HTTrack Website Copier">
<div class="tagline">Open Source offline browser</div>
</header>
<div class="wrap solo">
<main id="main">
<h1>HTTrack documentation</h1>
<p class="lede">HTTrack copies a website to your disk, rewriting its links so the local copy
browses like the original. It can resume an interrupted download, update a mirror it made
earlier, mirror over HTTPS and through a proxy, save the crawl as a WARC archive, and report
what changed since last time. There is a Windows interface (WinHTTrack), one for Linux and
Unix (WebHTTrack), an Android app, and a command-line program on every platform.</p>
<ul class="hub">
<li>
<h2>Start here</h2>
<dl>
<dt><a href="guide.html">The HTTrack interface, step by step</a></dt>
<dd>A walkthrough of a first mirror, then every option panel, for WinHTTrack,
WebHTTrack and the Android app.</dd>
<dt><a href="faq.html">FAQ and troubleshooting</a></dt>
<dd>Why a site did not copy the way you expected, and what to do about it.</dd>
<dt><a href="abuse.html">Using HTTrack responsibly</a></dt>
<dd>How not to flood a server, and what webmasters can do about crawlers that do.</dd>
</dl>
</li>
<li>
<h2>Command line</h2>
<dl>
<dt><a href="cmdguide.html">Command-line guide</a></dt>
<dd>Organised by task: scope, filters, limits, logins, proxies, updates, plus
recipes you can copy.</dd>
<dt><a href="httrack.man.html">Option reference</a></dt>
<dd>The manual page, generated from the program itself, so it lists every option
the version you have really accepts.</dd>
<dt><a href="filters.html">Filter syntax</a></dt>
<dd>The rules behind <code>+*.gif</code> and friends, including the size and
MIME-type forms.</dd>
</dl>
</li>
<li>
<h2>For developers</h2>
<dl>
<dt><a href="dev.html">Programming with HTTrack</a></dt>
<dd>Driving the engine from a script, the callbacks, and the libhttrack API.</dd>
<dt><a href="cache.html">Cache format</a></dt>
<dd>What HTTrack stores in <code>hts-cache</code>, and how to read it.</dd>
<dt><a href="changes.html">Change report format</a></dt>
<dd>The machine-readable report <code>--changes</code> writes after an update.</dd>
</dl>
</li>
<li>
<h2>Archive</h2>
<dl>
<dt><a href="fcguide.html">HTTrack Users Guide</a>, by Fred Cohen
<span class="dated">(written for 3.10)</span></dt>
<dd>A tutorial covering the command line at length. It was written for release 3.10,
so the option list and the defaults it quotes have moved on: check anything specific
against the <a href="httrack.man.html">option reference</a>. Kept because it is still
a good long read, and because plenty of forum answers link to it.</dd>
</dl>
</li>
</ul>
<h2>About this program</h2>
<p><a href="contact.html">Contact and credits</a> &middot;
<a href="../history.txt">Release notes</a> &middot;
<a href="../license.txt">Licence</a> &middot;
<a href="../greetings.txt">Acknowledgements</a></p>
<p>HTTrack is free software released under the GNU General Public License, version 3 or
later. It comes with no warranty, and copying a website is your responsibility: read
<a href="abuse.html">Using HTTrack responsibly</a> before pointing it at a server you do
not own.</p>
</main>
</div>
<footer>&copy; 1998-2026 Xavier Roche &amp; other contributors - Web Design: Leto Kauler.</footer>
</body>
</html>