OSDN Git Service

Modify features and documents for 1.98b the urgent security release.
[ffftp/ffftp.git] / contrib / putty / DOC / FEEDBACK.BUT
diff --git a/contrib/putty/DOC/FEEDBACK.BUT b/contrib/putty/DOC/FEEDBACK.BUT
deleted file mode 100644 (file)
index 0f9f494..0000000
+++ /dev/null
@@ -1,423 +0,0 @@
-\define{versionidfeedback} \versionid $Id: feedback.but 7824 2007-12-20 11:03:45Z simon $\r
-\r
-\A{feedback} \ii{Feedback} and \i{bug reporting}\r
-\r
-This is a guide to providing feedback to the PuTTY development team.\r
-It is provided as both a web page on the PuTTY site, and an appendix\r
-in the PuTTY manual.\r
-\r
-\K{feedback-general} gives some general guidelines for sending any\r
-kind of e-mail to the development team. Following sections give more\r
-specific guidelines for particular types of e-mail, such as bug\r
-reports and feature requests.\r
-\r
-\H{feedback-general} General guidelines\r
-\r
-The PuTTY development team gets a \e{lot} of mail. If you can\r
-possibly solve your own problem by reading the manual, reading the\r
-FAQ, reading the web site, asking a fellow user, perhaps posting to a\r
-newsgroup (see \k{feedback-other-fora}), or some other means, then it\r
-would make our lives much easier.\r
-\r
-We get so much e-mail that we literally do not have time to answer\r
-it all. We regret this, but there's nothing we can do about it. So\r
-if you can \e{possibly} avoid sending mail to the PuTTY team, we\r
-recommend you do so. In particular, support requests\r
-(\k{feedback-support}) are probably better sent to newsgroups, or\r
-passed to a local expert if possible.\r
-\r
-The PuTTY contact email address is a private \i{mailing list} containing\r
-four or five core developers. Don't be put off by it being a mailing\r
-list: if you need to send confidential data as part of a bug report,\r
-you can trust the people on the list to respect that confidence.\r
-Also, the archives aren't publicly available, so you shouldn't be\r
-letting yourself in for any spam by sending us mail.\r
-\r
-Please use a meaningful subject line on your message.  We get a lot of\r
-mail, and it's hard to find the message we're looking for if they all\r
-have subject lines like \q{PuTTY bug}.\r
-\r
-\S{feedback-largefiles} Sending large attachments\r
-\r
-Since the PuTTY contact address is a mailing list, e-mails larger\r
-than 40Kb will be held for inspection by the list administrator, and\r
-will not be allowed through unless they really appear to be worth\r
-their large size.\r
-\r
-If you are considering sending any kind of large data file to the\r
-PuTTY team, it's almost always a bad idea, or at the very least it\r
-would be better to ask us first whether we actually need the file.\r
-Alternatively, you could put the file on a web site and just send us\r
-the URL; that way, we don't have to download it unless we decide we\r
-actually need it, and only one of us needs to download it instead of\r
-it being automatically copied to all the developers.\r
-\r
-Some people like to send mail in MS Word format. Please \e{don't}\r
-send us bug reports, or any other mail, as a Word document. Word\r
-documents are roughly fifty times larger than writing the same\r
-report in plain text. In addition, most of the PuTTY team read their\r
-e-mail on Unix machines, so copying the file to a Windows box to run\r
-Word is very inconvenient. Not only that, but several of us don't\r
-even \e{have} a copy of Word!\r
-\r
-Some people like to send us screen shots when demonstrating a\r
-problem. Please don't do this without checking with us first - we\r
-almost never actually need the information in the screen shot.\r
-Sending a screen shot of an error box is almost certainly\r
-unnecessary when you could just tell us in plain text what the error\r
-was. (On some versions of Windows, pressing Ctrl-C when the error\r
-box is displayed will copy the text of the message to the clipboard.)\r
-Sending a full-screen shot is \e{occasionally} useful, but it's\r
-probably still wise to check whether we need it before sending it.\r
-\r
-If you \e{must} mail a screen shot, don't send it as a \cw{.BMP}\r
-file. \cw{BMP}s have no compression and they are \e{much} larger\r
-than other image formats such as PNG, TIFF and GIF. Convert the file\r
-to a properly compressed image format before sending it.\r
-\r
-Please don't mail us executables, at all. Our mail server blocks all\r
-incoming e-mail containing executables, as a defence against the\r
-vast numbers of e-mail viruses we receive every day. If you mail us\r
-an executable, it will just bounce.\r
-\r
-If you have made a tiny modification to the PuTTY code, please send\r
-us a \e{patch} to the source code if possible, rather than sending\r
-us a huge \cw{.ZIP} file containing the complete sources plus your\r
-modification. If you've only changed 10 lines, we'd prefer to\r
-receive a mail that's 30 lines long than one containing multiple\r
-megabytes of data we already have.\r
-\r
-\S{feedback-other-fora} Other places to ask for help\r
-\r
-There are two Usenet newsgroups that are particularly relevant to the\r
-PuTTY tools:\r
-\r
-\b \W{news:comp.security.ssh}\c{comp.security.ssh}, for questions\r
-specific to using the SSH protocol;\r
-\r
-\b \W{news:comp.terminals}\c{comp.terminals}, for issues relating to\r
-terminal emulation (for instance, keyboard problems).\r
-\r
-Please use the newsgroup most appropriate to your query, and remember\r
-that these are general newsgroups, not specifically about PuTTY.\r
-\r
-If you don't have direct access to Usenet, you can access these\r
-newsgroups through Google Groups\r
-(\W{http://groups.google.com/}\cw{groups.google.com}).\r
-\r
-\H{feedback-bugs} Reporting bugs\r
-\r
-If you think you have found a bug in PuTTY, your first steps should\r
-be:\r
-\r
-\b Check the\r
-\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/wishlist/}{Wishlist\r
-page} on the PuTTY website, and see if we already know about the\r
-problem. If we do, it is almost certainly not necessary to mail us\r
-about it, unless you think you have extra information that might be\r
-helpful to us in fixing it. (Of course, if we actually \e{need}\r
-specific extra information about a particular bug, the Wishlist page\r
-will say so.)\r
-\r
-\b Check the\r
-\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/changes.html}{Change\r
-Log} on the PuTTY website, and see if we have already fixed the bug\r
-in the \i{development snapshots}.\r
-\r
-\b Check the\r
-\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/faq.html}{FAQ}\r
-on the PuTTY website (also provided as \k{faq} in the manual), and\r
-see if it answers your question. The FAQ lists the most common\r
-things which people think are bugs, but which aren't bugs.\r
-\r
-\b Download the latest development snapshot and see if the problem\r
-still happens with that. This really is worth doing. As a general\r
-rule we aren't very interested in bugs that appear in the release\r
-version but not in the development version, because that usually\r
-means they are bugs we have \e{already fixed}. On the other hand, if\r
-you can find a bug in the development version that doesn't appear in\r
-the release, that's likely to be a new bug we've introduced since\r
-the release and we're definitely interested in it.\r
-\r
-If none of those options solved your problem, and you still need to\r
-report a bug to us, it is useful if you include some general\r
-information:\r
-\r
-\b Tell us what \i{version of PuTTY} you are running. To find this out,\r
-use the \q{About PuTTY} option from the System menu. Please \e{do\r
-not} just tell us \q{I'm running the latest version}; e-mail can be\r
-delayed and it may not be obvious which version was the latest at\r
-the time you sent the message. \r
-\r
-\b PuTTY is a multi-platform application; tell us what version of what\r
-OS you are running PuTTY on. (If you're running on Unix, or Windows\r
-for Alpha, tell us, or we'll assume you're running on Windows for\r
-Intel as this is overwhelmingly the case.)\r
-\r
-\b Tell us what protocol you are connecting with: SSH, Telnet,\r
-Rlogin or Raw mode.\r
-\r
-\b Tell us what kind of server you are connecting to; what OS, and\r
-if possible what SSH server (if you're using SSH). You can get some\r
-of this information from the PuTTY Event Log (see \k{using-eventlog}\r
-in the manual).\r
-\r
-\b Send us the contents of the PuTTY Event Log, unless you\r
-have a specific reason not to (for example, if it contains\r
-confidential information that you think we should be able to solve\r
-your problem without needing to know).\r
-\r
-\b Try to give us as much information as you can to help us\r
-see the problem for ourselves. If possible, give us a step-by-step\r
-sequence of \e{precise} instructions for reproducing the fault.\r
-\r
-\b Don't just tell us that PuTTY \q{does the wrong thing}; tell us\r
-exactly and precisely what it did, and also tell us exactly and\r
-precisely what you think it should have done instead. Some people\r
-tell us PuTTY does the wrong thing, and it turns out that it was\r
-doing the right thing and their expectations were wrong. Help to\r
-avoid this problem by telling us exactly what you think it should\r
-have done, and exactly what it did do.\r
-\r
-\b If you think you can, you're welcome to try to fix the problem\r
-yourself. A \i{patch} to the code which fixes a bug is an excellent\r
-addition to a bug report. However, a patch is never a \e{substitute}\r
-for a good bug report; if your patch is wrong or inappropriate, and\r
-you haven't supplied us with full information about the actual bug,\r
-then we won't be able to find a better solution.\r
-\r
-\b\r
-\W{http://www.chiark.greenend.org.uk/~sgtatham/bugs.html}\cw{http://www.chiark.greenend.org.uk/~sgtatham/bugs.html}\r
-is an article on how to report bugs effectively in general. If your\r
-bug report is \e{particularly} unclear, we may ask you to go away,\r
-read this article, and then report the bug again.\r
-\r
-It is reasonable to report bugs in PuTTY's documentation, if you\r
-think the documentation is unclear or unhelpful. But we do need to\r
-be given exact details of \e{what} you think the documentation has\r
-failed to tell you, or \e{how} you think it could be made clearer.\r
-If your problem is simply that you don't \e{understand} the\r
-documentation, we suggest posting to a newsgroup (see\r
-\k{feedback-other-fora}) and seeing if someone\r
-will explain what you need to know. \e{Then}, if you think the\r
-documentation could usefully have told you that, send us a bug\r
-report and explain how you think we should change it.\r
-\r
-\H{feedback-features} Requesting extra features \r
-\r
-If you want to request a new feature in PuTTY, the very first things\r
-you should do are:\r
-\r
-\b Check the\r
-\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/wishlist/}{Wishlist\r
-page} on the PuTTY website, and see if your feature is already on\r
-the list. If it is, it probably won't achieve very much to repeat\r
-the request. (But see \k{feedback-feature-priority} if you want to\r
-persuade us to give your particular feature higher priority.)\r
-\r
-\b Check the Wishlist and\r
-\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/changes.html}{Change\r
-Log} on the PuTTY website, and see if we have already added your\r
-feature in the development snapshots. If it isn't clear, download\r
-the latest development snapshot and see if the feature is present.\r
-If it is, then it will also be in the next release and there is no\r
-need to mail us at all.\r
-\r
-If you can't find your feature in either the development snapshots\r
-\e{or} the Wishlist, then you probably do need to submit a feature\r
-request. Since the PuTTY authors are very busy, it helps if you try\r
-to do some of the work for us:\r
-\r
-\b Do as much of the design as you can. Think about \q{corner\r
-cases}; think about how your feature interacts with other existing\r
-features. Think about the user interface; if you can't come up with\r
-a simple and intuitive interface to your feature, you shouldn't be\r
-surprised if we can't either. Always imagine whether it's possible\r
-for there to be more than one, or less than one, of something you'd\r
-assumed there would be one of. (For example, if you were to want\r
-PuTTY to put an icon in the System tray rather than the Taskbar, you\r
-should think about what happens if there's more than one PuTTY\r
-active; how would the user tell which was which?)\r
-\r
-\b If you can program, it may be worth offering to write the feature\r
-yourself and send us a patch. However, it is likely to be helpful\r
-if you confer with us first; there may be design issues you haven't\r
-thought of, or we may be about to make big changes to the code which\r
-your patch would clash with, or something. If you check with the\r
-maintainers first, there is a better chance of your code actually\r
-being usable. Also, read the design principles listed in \k{udp}: if\r
-you do not conform to them, we will probably not be able to accept\r
-your patch.\r
-\r
-\H{feedback-feature-priority} Requesting features that have already\r
-been requested\r
-\r
-If a feature is already listed on the Wishlist, then it usually\r
-means we would like to add it to PuTTY at some point. However, this\r
-may not be in the near future. If there's a feature on the Wishlist\r
-which you would like to see in the \e{near} future, there are\r
-several things you can do to try to increase its priority level:\r
-\r
-\b Mail us and vote for it. (Be sure to mention that you've seen it\r
-on the Wishlist, or we might think you haven't even \e{read} the\r
-Wishlist). This probably won't have very \e{much} effect; if a huge\r
-number of people vote for something then it may make a difference,\r
-but one or two extra votes for a particular feature are unlikely to\r
-change our priority list immediately. Offering a new and compelling\r
-justification might help. Also, don't expect a reply.\r
-\r
-\b Offer us money if we do the work sooner rather than later. This\r
-sometimes works, but not always. The PuTTY team all have full-time\r
-jobs and we're doing all of this work in our free time; we may\r
-sometimes be willing to give up some more of our free time in\r
-exchange for some money, but if you try to bribe us for a \e{big}\r
-feature it's entirely possible that we simply won't have the time to\r
-spare - whether you pay us or not. (Also, we don't accept bribes to\r
-add \e{bad} features to the Wishlist, because our desire to provide\r
-high-quality software to the users comes first.)\r
-\r
-\b Offer to help us write the code. This is probably the \e{only}\r
-way to get a feature implemented quickly, if it's a big one that we\r
-don't have time to do ourselves.\r
-\r
-\H{feedback-support} \ii{Support requests}\r
-\r
-If you're trying to make PuTTY do something for you and it isn't\r
-working, but you're not sure whether it's a bug or not, then\r
-\e{please} consider looking for help somewhere else. This is one of\r
-the most common types of mail the PuTTY team receives, and we simply\r
-don't have time to answer all the questions. Questions of this type\r
-include:\r
-\r
-\b If you want to do something with PuTTY but have no idea where to\r
-start, and reading the manual hasn't helped, try posting to a\r
-newsgroup (see \k{feedback-other-fora}) and see if someone can explain\r
-it to you.\r
-\r
-\b If you have tried to do something with PuTTY but it hasn't\r
-worked, and you aren't sure whether it's a bug in PuTTY or a bug in\r
-your SSH server or simply that you're not doing it right, then try\r
-posting to a newsgroup (see \k{feedback-other-fora}) and see\r
-if someone can solve your problem. Or try doing the same thing with\r
-a different SSH client and see if it works with that. Please do not\r
-report it as a PuTTY bug unless you are really sure it \e{is} a bug\r
-in PuTTY.\r
-\r
-\b If someone else installed PuTTY for you, or you're using PuTTY on\r
-someone else's computer, try asking them for help first.  They're more\r
-likely to understand how they installed it and what they expected you\r
-to use it for than we are.\r
-\r
-\b If you have successfully made a connection to your server and now\r
-need to know what to type at the server's command prompt, or other\r
-details of how to use the server-end software, talk to your server's\r
-system administrator. This is not the PuTTY team's problem. PuTTY is\r
-only a communications tool, like a telephone; if you can't speak the\r
-same language as the person at the other end of the phone, it isn't\r
-the telephone company's job to teach it to you.\r
-\r
-If you absolutely cannot get a support question answered any other\r
-way, you can try mailing it to us, but we can't guarantee to have\r
-time to answer it.\r
-\r
-\H{feedback-webadmin} Web server administration\r
-\r
-If the PuTTY \i{web site} is down (Connection Timed Out), please don't\r
-bother mailing us to tell us about it. Most of us read our e-mail on\r
-the same machines that host the web site, so if those machines are\r
-down then we will notice \e{before} we read our e-mail. So there's\r
-no point telling us our servers are down.\r
-\r
-Of course, if the web site has some other error (Connection Refused,\r
-404 Not Found, 403 Forbidden, or something else) then we might\r
-\e{not} have noticed and it might still be worth telling us about it.\r
-\r
-If you want to report a problem with our web site, check that you're\r
-looking at our \e{real} web site and not a mirror. The real web site\r
-is at\r
-\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\c{http://www.chiark.greenend.org.uk/~sgtatham/putty/};\r
-if that's not where you're reading this, then don't report the\r
-problem to us until you've checked that it's really a problem with\r
-the main site. If it's only a problem with the mirror, you should\r
-try to contact the administrator of that mirror site first, and only\r
-contact us if that doesn't solve the problem (in case we need to\r
-remove the mirror from our list).\r
-\r
-\H{feedback-permission} Asking permission for things\r
-\r
-PuTTY is distributed under the MIT Licence (see \k{licence} for\r
-details). This means you can do almost \e{anything} you like with\r
-our software, our source code, and our documentation. The only\r
-things you aren't allowed to do are to remove our copyright notices\r
-or the licence text itself, or to hold us legally responsible if\r
-something goes wrong.\r
-\r
-So if you want permission to include PuTTY on a magazine cover disk,\r
-or as part of a collection of useful software on a CD or a web site,\r
-then \e{permission is already granted}. You don't have to mail us\r
-and ask. Just go ahead and do it. We don't mind.\r
-\r
-(If you want to distribute PuTTY alongside your own application for\r
-use with that application, or if you want to distribute PuTTY within\r
-your own organisation, then we recommend, but do not insist, that\r
-you offer your own first-line technical support, to answer questions\r
-about the interaction of PuTTY with your environment. If your users\r
-mail us directly, we won't be able to tell them anything useful about\r
-your specific setup.)\r
-\r
-If you want to use parts of the PuTTY source code in another\r
-program, then it might be worth mailing us to talk about technical\r
-details, but if all you want is to ask permission then you don't\r
-need to bother. You already have permission.\r
-\r
-If you just want to link to our web site, just go ahead. (It's not\r
-clear that we \e{could} stop you doing this, even if we wanted to!)\r
-\r
-\H{feedback-mirrors} Mirroring the PuTTY web site\r
-\r
-\# the next two paragraphs also on the Mirrors page itself, with\r
-\# minor context changes\r
-\r
-If you want to set up a mirror of the PuTTY website, go ahead and\r
-set one up. Please don't bother asking us for permission before\r
-setting up a mirror. You already have permission.\r
-\r
-If the mirror is in a country where we don't already have plenty of\r
-mirrors, we may be willing to add it to the list on our\r
-\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/mirrors.html}{mirrors\r
-page}. Read the guidelines on that page, make sure your mirror\r
-works, and email us the information listed at the bottom of the\r
-page.\r
-\r
-Note that we do not \e{promise} to list your mirror: we get a lot of\r
-mirror notifications and yours may not happen to find its way to the\r
-top of the list.\r
-\r
-Also note that we link to all our mirror sites using the\r
-\c{rel="nofollow"} attribute. Running a PuTTY mirror is not intended\r
-to be a cheap way to gain search rankings.\r
-\r
-If you have technical questions about the process of mirroring, then\r
-you might want to mail us before setting up the mirror (see also the\r
-\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/mirrors.html#guidelines}{guidelines on the Mirrors page});\r
-but if you just want to ask for permission, you don't need to. You\r
-already have permission.\r
-\r
-\H{feedback-compliments} Praise and compliments\r
-\r
-One of the most rewarding things about maintaining free software is\r
-getting e-mails that just say \q{thanks}. We are always happy to\r
-receive e-mails of this type.\r
-\r
-Regrettably we don't have time to answer them all in person. If you\r
-mail us a compliment and don't receive a reply, \e{please} don't\r
-think we've ignored you. We did receive it and we were happy about\r
-it; we just didn't have time to tell you so personally.\r
-\r
-To everyone who's ever sent us praise and compliments, in the past\r
-and the future: \e{you're welcome}!\r
-\r
-\H{feedback-address} E-mail address\r
-\r
-The actual address to mail is\r
-\cw{<\W{mailto:putty@projects.tartarus.org}{putty@projects.tartarus.org}>}.\r