mirror of
https://git.tartarus.org/simon/putty.git
synced 2025-01-09 01:18:00 +00:00
31f496b59c
The standalone separate doc/Makefile is gone, replaced by a CMakeLists.txt that makes 'doc' function as a subdirectory of the main CMake build system. This auto-detects Halibut, and if it's present, uses it to build the man pages and the various forms of the main manual, including the Windows CHM help file in particular. One awkward thing I had to do was to move just one config directive in blurb.but into its own file: the one that cites a relative path to the stylesheet file to put into the CHM. CMake builds often like to be out-of-tree, so there's no longer a fixed relative path between the build directory and chm.css. And Halibut has no concept of an include path to search for files cited by other files, so I can't fix that with an -I option on the Halibut command line. So I moved that single config directive into its own file, and had CMake write out a custom version of that file in the build directory citing the right path. (Perhaps in the longer term I should fix that omission in Halibut; out-of-tree friendliness seems like a useful feature. But even if I do, I still need this build to work now.)
42 lines
1.5 KiB
Plaintext
42 lines
1.5 KiB
Plaintext
\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.
|