putty-source/doc/blurb.but

\define{dash} \u2013{-}

\title PuTTY User Manual

\cfg{xhtml-leaf-level}{1}
\cfg{xhtml-leaf-smallest-contents}{2}
\cfg{xhtml-leaf-contains-contents}{true}
\cfg{xhtml-body-end}{<p>If you want to provide feedback on this manual
or on the PuTTY tools themselves, see the
<a href="https://www.chiark.greenend.org.uk/~sgtatham/putty/feedback.html">Feedback
page</a>.</p>}

\cfg{html-template-fragment}{%k}{%b}

\cfg{info-max-file-size}{0}

\cfg{chm-contents-filename}{index.html}
\cfg{chm-template-filename}{%k.html}
\cfg{chm-head-end}{<link rel="stylesheet" type="text/css" href="chm.css">}

\cfg{xhtml-contents-filename}{index.html}
\cfg{text-filename}{puttydoc.txt}
\cfg{winhelp-filename}{putty.hlp}
\cfg{info-filename}{putty.info}
\cfg{chm-filename}{putty.chm}

PuTTY is a free (MIT-licensed) Windows Telnet and SSH client. This
manual documents PuTTY, and its companion utilities PSCP, PSFTP,
Plink, Pageant and PuTTYgen.

\e{Note to Unix users:} this manual currently primarily documents the
Windows versions of the PuTTY utilities. Some options are therefore
mentioned that are absent from the \i{Unix version}; the Unix version has
features not described here; and the \i\cw{pterm} and command-line
\cw{puttygen} and \cw{pageant} utilities are not described at all. The
only Unix-specific documentation that currently exists is the
\I{man pages for PuTTY tools}man pages.

\copyright This manual is copyright \shortcopyrightdetails. All
rights reserved. You may distribute this documentation under the MIT
licence. See \k{licence} for the licence text in full.
Add a missing \define I accidentally assumed was there in r9592. [originally from svn r9593] [r9592 == 71f0c7546dfa8930277c895b88f57585fd8ef854] 2012-07-29 13:38:31 +00:00			`\define{dash} \u2013{-}`

Initial checkin of an outline for the PuTTY user manual. [originally from svn r865] 2001-01-17 10:11:16 +00:00			`\title PuTTY User Manual`

Condense the docs into fewer HTML files. Particularly useful since the new-look FAQ is now one file. [originally from svn r1319] 2001-10-24 19:05:36 +00:00			`\cfg{xhtml-leaf-level}{1}`
Initial checkin of an outline for the PuTTY user manual. [originally from svn r865] 2001-01-17 10:11:16 +00:00			`\cfg{xhtml-leaf-smallest-contents}{2}`
			`\cfg{xhtml-leaf-contains-contents}{true}`
Remove the email address from the footer of the HTML manual, and replace it with a link to the Feedback page, as we have long since done everywhere else on the PuTTY website. [originally from svn r4438] 2004-08-10 17:12:31 +00:00			`\cfg{xhtml-body-end}{<p>If you want to provide feedback on this manual`
			`or on the PuTTY tools themselves, see the`
Switch chiark URLs to https. 2017-05-07 15:29:01 +00:00			`<a href="https://www.chiark.greenend.org.uk/~sgtatham/putty/feedback.html">Feedback`
Remove the email address from the footer of the HTML manual, and replace it with a link to the Feedback page, as we have long since done everywhere else on the PuTTY website. [originally from svn r4438] 2004-08-10 17:12:31 +00:00			`page</a>.</p>}`
Use the PuTTY site's CSS stylesheet. Add Contact mail address to the page footer. [originally from svn r906] 2001-01-28 14:00:54 +00:00
Support multiple anchor name types now that Jacob has enhanced Halibut to be able to do so. [originally from svn r5479] 2005-03-10 16:18:51 +00:00			`\cfg{html-template-fragment}{%k}{%b}`

Add target to build `info' file. We probably already require a new enough version of Halibut that this isn't a problem; nevertheless, I've put it in a separate target for now. [originally from svn r5595] 2005-04-05 18:11:31 +00:00			`\cfg{info-max-file-size}{0}`

Switch to using Halibut's new direct .CHM generation. This allows me to remove HTML Help Workshop completely from my build dependencies, and good riddance! 2017-05-13 16:10:36 +00:00			`\cfg{chm-contents-filename}{index.html}`
			`\cfg{chm-template-filename}{%k.html}`
			`\cfg{chm-head-end}{<link rel="stylesheet" type="text/css" href="chm.css">}`

Clean up Makefile now that Halibut's new command-line options make life easier. [originally from svn r4022] 2004-04-01 17:34:18 +00:00			`\cfg{xhtml-contents-filename}{index.html}`
			`\cfg{text-filename}{puttydoc.txt}`
			`\cfg{winhelp-filename}{putty.hlp}`
Add target to build `info' file. We probably already require a new enough version of Halibut that this isn't a problem; nevertheless, I've put it in a separate target for now. [originally from svn r5595] 2005-04-05 18:11:31 +00:00			`\cfg{info-filename}{putty.info}`
Switch to using Halibut's new direct .CHM generation. This allows me to remove HTML Help Workshop completely from my build dependencies, and good riddance! 2017-05-13 16:10:36 +00:00			`\cfg{chm-filename}{putty.chm}`
Clean up Makefile now that Halibut's new command-line options make life easier. [originally from svn r4022] 2004-04-01 17:34:18 +00:00
Remove references to "Win32" and "32-bit Windows". They were there mainly to distinguish from 16-bit Windows, which hasn't been a thing since before a noticeable fraction of the userbase were born, probably. These days the obvious comparison is with 64-bit Windows. Also tweak some wording to reflect that official PuTTY executables are not necessarily 32-bit any more, and add some XXX-REVIEW-BEFORE-RELEASE in the same vein. 2017-02-15 23:58:25 +00:00			`PuTTY is a free (MIT-licensed) Windows Telnet and SSH client. This`
Add a note about documentation of the Unix port (i.e., we don't, specifically). This is mainly intended to make the documentation suitable for including in distributions such as the Debian package, but won't be amiss on the web site docs. It will look a bit out of place in the .HLP, but never mind. [originally from svn r4690] 2004-10-24 22:57:36 +00:00			`manual documents PuTTY, and its companion utilities PSCP, PSFTP,`
			`Plink, Pageant and PuTTYgen.`

			`\e{Note to Unix users:} this manual currently primarily documents the`
			`Windows versions of the PuTTY utilities. Some options are therefore`
Index the complete PuTTY manual. This was a bit rushed, and could doubtless be improved. Also fix a couple of things I noted on the way, including: - "pscp -ls" wasn't documented - Windows XP wasn't mentioned enough [originally from svn r5593] 2005-04-05 18:01:32 +00:00			`mentioned that are absent from the \i{Unix version}; the Unix version has`
			`features not described here; and the \i\cw{pterm} and command-line`
Acknowledge Unix pageant. 2019-03-18 23:09:24 +00:00			`\cw{puttygen} and \cw{pageant} utilities are not described at all. The`
			`only Unix-specific documentation that currently exists is the`
Index the complete PuTTY manual. This was a bit rushed, and could doubtless be improved. Also fix a couple of things I noted on the way, including: - "pscp -ls" wasn't documented - Windows XP wasn't mentioned enough [originally from svn r5593] 2005-04-05 18:01:32 +00:00			`\I{man pages for PuTTY tools}man pages.`
Initial checkin of an outline for the PuTTY user manual. [originally from svn r865] 2001-01-17 10:11:16 +00:00
Autogenerate licence text in doc subdir from LICENCE. Now we have licence.pl, it seems to me to make very good sense to have it generate the Halibut form(s) of the licence and copyright year as well as the source-code forms. As a result, I believe _no_ copies of the licence text or copyright date exist any more except for the master one in LICENCE - so I can completely remove the checklist section about all the places to update it, because there's only one. Hooray! 2015-12-22 11:18:48 +00:00			`\copyright This manual is copyright \shortcopyrightdetails. All`
It's 2002. Update copyright statements :-) [originally from svn r1559] 2002-02-24 15:17:10 +00:00			`rights reserved. You may distribute this documentation under the MIT`
Add two extra appendices giving the licence text and details of how to give feedback. (I think the latter has suddenly become worthwhile now we have the ability to distribute a help file; so people won't have to come to the website for the feedback information.) [originally from svn r1502] 2001-12-16 14:56:02 +00:00			`licence. See \k{licence} for the licence text in full.`