1
0
mirror of https://git.tartarus.org/simon/putty.git synced 2025-01-09 17:38:00 +00:00
Commit Graph

34 Commits

Author SHA1 Message Date
Simon Tatham
147adf4e76 Move PPK format documentation into a manual appendix.
Somebody on comp.security.ssh asked about it recently, and I decided
that storing it in a comment in the key file was not really good
enough. Also, that comment was incomplete (it listed the private key
formats for RSA and DSA but not any of the newer ECC key types, simple
as their private-key formats may be).
2021-02-15 18:48:34 +00:00
Simon Tatham
e617a5b768 Rename manpage sources in the doc subdirectory.
When I added the psusan man page, I noticed that they've all got
impenetrable names like 'man-pl.but' to fit within 8.3 naming. But
this source base hasn't had to worry about 8.3 naming conventions in a
long time, so I think I can safely rename all those files to ones
whose purpose is more obvious.
2020-12-13 12:36:38 +00:00
Simon Tatham
9ee03e5adb psusan: write a man page.
I've been collecting actual examples of things I've used psusan for,
and now I think I have enough of them to make some kind of case for
why it's a useful tool. So I've written a man page, and dumped all my
collected examples in there.
2020-12-13 12:36:38 +00:00
Jacob Nevins
a8d3008143 Stop shipping old WinHelp (.HLP) file.
The executables were already ignoring it.

This is a minimal change; PUTTY.HLP can still be built, and there's
still all the context IDs lying around.

Buildscr changes are untested.
2019-03-16 12:25:23 +00:00
Simon Tatham
93931b0a56 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 18:51:10 +01:00
Simon Tatham
774d37a0dc 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 13:33:42 +00:00
Simon Tatham
5ea2f3065e Unix Pageant: man page and online help.
I think Unix Pageant is now more or less usable, though of course I
wouldn't blame anyone for sticking with other SSH agent solutions.
2015-05-19 18:24:04 +01:00
Simon Tatham
4d8782e74f Rework versioning system to not depend on Subversion.
I've shifted away from using the SVN revision number as a monotonic
version identifier (replacing it in the Windows version resource with
a count of days since an arbitrary epoch), and I've removed all uses
of SVN keyword expansion (replacing them with version information
written out by Buildscr).

While I'm at it, I've done a major rewrite of the affected code which
centralises all the computation of the assorted version numbers and
strings into Buildscr, so that they're all more or less alongside each
other rather than scattered across multiple source files.

I've also retired the MD5-based manifest file system. A long time ago,
it seemed like a good idea to arrange that binaries of PuTTY would
automatically cease to identify themselves as a particular upstream
version number if any changes were made to the source code, so that if
someone made a local tweak and distributed the result then I wouldn't
get blamed for the results. Since then I've decided the whole idea is
more trouble than it's worth, so now distribution tarballs will have
version information baked in and people can just cope with that.

[originally from svn r10262]
2014-09-24 10:33:13 +00:00
Jacob Nevins
886e806690 Use printf rather than echo to generate \versionid.
(Sacrificing the ability to build PuTTY docs from Halibut source on SunOS 4,
apparently, but I expect we'll live.)

[originally from svn r10102]
2013-12-01 18:02:56 +00:00
Ben Harris
17bc691cc2 Now that PuTTY is actually using names "@putty.projects.tartarus.org", it
seems like a good idea to document them.

[originally from svn r7747]
2007-09-29 14:20:55 +00:00
Simon Tatham
29ba6a6b87 Build script for PuTTY using bob.
[originally from svn r7205]
2007-02-04 11:17:45 +00:00
Simon Tatham
7e4786355d `make mostlyclean', to remove everything directly Halibut-generated
but not the CHM. It'll come in useful during the release process.

[originally from svn r7027]
2006-12-28 10:38:46 +00:00
Simon Tatham
1dac1bc911 Initial support for HTML Help. All the ad-hoc help-file finding code
and various calls to WinHelp() have been centralised into a new file
winhelp.c, which in turn has been modified to detect a .CHM file as
well as .HLP and select between them as appropriate. It explicitly
tries to load HHCTRL.OCX and use GetProcAddress, meaning that it
_should_ still work correctly on pre-HTML-Help platforms, falling
gracefully back to WinHelp, but although I tested this by
temporarily renaming my own HHCTRL.OCX I haven't yet been able to
test it on a real HTML-Help-free platform.

Also in this checkin: a new .but file and docs makefile changes to
make it convenient to build the sources for a .CHM. As yet, owing to
limitations of Halibut's CHM support, I'm not able to write a .CHM
directly, more's the pity.

[originally from svn r7000]
2006-12-17 11:16:07 +00:00
Jacob Nevins
fb6092291a 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
Jacob Nevins
36fc6c0a76 Try to make our PGP signing more useful:
* All the PuTTY tools for Windows and Unix now contain the fingerprints of
   the Master Keys. The method for accessing them is crude but universal:
   a new "-pgpfp" command-line option. (Except Unix PuTTYgen, which takes
   "--pgpfp" just to be awkward.)

 * Move the key policy discussion from putty-website/keys.html to
   putty/doc/pgpkeys.but, and autogenerate the former from the latter.
   Also tweak the text somewhat and include the fingerprints of the
   Master Keys themselves.
   (I've merged the existing autogeneration scripts into a single new
   one; I've left the old scripts and keys.html around until such time
   as the webmonster reviews the changes and plumbs in the new script;
   he should remove the old files then.)

[originally from svn r5524]
[this svn revision also touched putty-website]
2005-03-19 02:26:58 +00:00
Simon Tatham
d387cda9b0 It's probably about time I took my private path to the Halibut
binary out of the PuTTY docs Makefile. Instead, I expect to find
Halibut as simply `halibut' on the PATH, and anyone who doesn't have
it there can always do `make HALIBUT=/path/to/halibut'.

[originally from svn r4895]
2004-11-24 11:35:27 +00:00
Simon Tatham
da948bc151 Add an extra appendix to the manual containing PuTTY's (hitherto)
unwritten design principles, so would-be contributors won't have to
either read our minds or pay _very_ close attention to the code.

[originally from svn r4815]
2004-11-18 15:16:18 +00:00
Simon Tatham
7418a9a37f mkunxarc.sh was still including (mostly empty) .svn directories, and
that in turn was confusing the new doc/Makefile mechanism. Fixed the
former, and also put an additional safeguard in the latter in a
belt-and-braces sort of fashion.

[originally from svn r4806]
2004-11-17 18:27:04 +00:00
Simon Tatham
5d32d4af14 Now we use Subversion, it seems excessive to have an individual $Id$
line for every single .but file at the bottom of each page of the
HTML PuTTY docs. However, we can't _always_ replace that with a
single SVN revision, because there isn't always one available (SVN
still allows mixed working copies in which some files are
deliberately checked out against a different revision).

Hence, here's a mechanism for doing better. It uses `svnversion .'
to determine _whether_ a single revision number adequately describes
the current directory, and replaces all the version IDs with that if
so. If it can't do that, it uses the version IDs as before.

Also, this allows an explicit version string to be passed on the
make command line which will override _both_ these possibilities, so
that release documentation can be clearly labelled with the release
version number.

[originally from svn r4804]
2004-11-17 18:16:59 +00:00
Jacob Nevins
327c2c4496 Add index.but to build.
[originally from svn r4283]
2004-06-15 10:38:04 +00:00
Simon Tatham
7843ab696a 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
Jacob Nevins
42ba47fdca Reasonably grotty hacks so that the droppings left by the man page
generation don't interfere with the main HTML doc generation.

[originally from svn r4006]
2004-03-30 21:35:56 +00:00
Jacob Nevins
66d149d618 Use $(HALIBUT) variable consistently.
[originally from svn r3970]
2004-03-24 20:03:30 +00:00
Simon Tatham
ff6e3bc94d Now that Halibut is capable of generating man pages better than I
can do it by hand, I've converted the man page set from Unix PuTTY
into Halibut format, and enhanced the Makefile so it will build
them. At some future point this will also allow me to include the
man pages as an appendix in the main manual (once I _have_ a main
manual for Unix PuTTY).

[originally from svn r3966]
2004-03-24 19:36:04 +00:00
Simon Tatham
f9abc2b092 Move the reference to sitestyle.css out into a separate .but file
which is only included if you explicitly tell the docs Makefile to
do so. Also make it a relative reference, while we're at it.

[originally from svn r3524]
2003-10-30 10:30:23 +00:00
Simon Tatham
be71ff5568 Add a chapter explaining common error messages
[originally from svn r1984]
2002-10-01 16:27:36 +00:00
Simon Tatham
af2c66be95 Buttress is now Halibut: change the docs makefile.
[originally from svn r1802]
2002-08-05 10:35:35 +00:00
Simon Tatham
20e588c35e 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
Simon Tatham
9f3b49f3ba Add a chapter to the manual describing PSFTP.
[originally from svn r1485]
2001-12-14 12:15:43 +00:00
Simon Tatham
bf6cfd2b01 Sort out the silly filenames.
[originally from svn r1459]
2001-12-06 18:18:46 +00:00
Simon Tatham
fe943dcd68 Add a new chapter full of intermediate-useful-things, somewhere
between `Getting Started' (things we can barely believe you don't
know) and the Configuration reference chapter (things you already
knew and had just forgotten). Only half-written at the moment.

[originally from svn r1423]
2001-11-25 18:59:12 +00:00
Simon Tatham
b55b94e069 Add the new-look PuTTY FAQ
[originally from svn r1317]
2001-10-24 18:56:28 +00:00
Simon Tatham
83370ae6e5 Add "make clean" target
[originally from svn r931]
2001-02-19 10:54:05 +00:00
Simon Tatham
54a4337c6a Initial checkin of an outline for the PuTTY user manual.
[originally from svn r865]
2001-01-17 10:11:16 +00:00