This is the mail archive of the
mailing list for the Cygwin project.
RE: 'man' page for 'mintty' for review
- From: "Phil Betts" <Phil dot Betts at ascribe dot com>
- To: <cygwin at cygwin dot com>
- Date: Mon, 9 Feb 2009 08:13:33 -0000
- Subject: RE: 'man' page for 'mintty' for review
- References: <498B4263.email@example.com>
- Reply-to: <cygwin at cygwin dot com>
On Thursday, February 05, 2009 7:48 PM Lee D.Rothstein wrote:
> MinTTY users,
> Please, if you would, review the attached 'man' page -- 'mintty.1'.
> Andy Koppe intends to fold it into the 0.3.6 MinTTY release.
> Comments, corrections, addtitions to this list, please.
I haven't checked all the details, but most of it seems OK to me.
There are a few points that you may want to consider.
I don't think the man page should contain installation instructions.
If you're reading the man page, mintty is already installed, so the
instructions just get in the way of the more useful information. They
should instead be put in a plain text file in the root of the source
package (and perhaps also in a README in /usr/share/doc/Cygwin).
The reference to the cygwin home directory in the description of the
--config option is potentially confusing (presumably why ('~') is
added). A novice cygwin user might think "cygwin home" referred to
/home rather than /home/user or wherever $HOME point. I think it
would be better to refer to "the user's home directory", which would
be more consistent with the other references. Also, the reference to
~ is only applicable within a cygwin shell, so anyone trying to find
~/.minttyrc using cmd.exe is liable to be confused.
I think you should change this:
| There is also a discussion forum available at this site.
which is misleading, to something like this:
| There is also a mailing list for discussing Cygwin related issues.
| See http://cygwin.com/cygwin/lists.html for details. Please read
| the advice at http://cygwin.com/problems.html before posting a
| problem report.
This email has been scanned by Ascribe PLC using Microsoft Antigen for Exchange.
Unsubscribe info: http://cygwin.com/ml/#unsubscribe-simple
Problem reports: http://cygwin.com/problems.html