'man' page for 'mintty' for review

'man' page for 'mintty' for review

[Lee D.Rothstein]

[-- Attachment #1: Type: text/plain, Size: 327 bytes --]

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.

'man ./mintty.1.gz' will render the file (in the current directory)
without "installing" the page.

Thanks,

Lee Rothstein



[-- Attachment #2: mintty.1.gz --]
[-- Type: application/x-gzip, Size: 9259 bytes --]

[-- Attachment #3: Type: text/plain, Size: 218 bytes --]

--
Unsubscribe info:      http://cygwin.com/ml/#unsubscribe-simple
Problem reports:       http://cygwin.com/problems.html
Documentation:         http://cygwin.com/docs.html
FAQ:                   http://cygwin.com/faq/

Re: 'man' page for 'mintty' for review

[Peter Rosin]

Den 2009-02-05 20:47 skrev Lee D.Rothstein:
> 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.
> 
> 'man ./mintty.1.gz' will render the file (in the current directory)
> without "installing" the page.

"3.   Make sure that the Windows file spec for the folder that contains
       both cygwin1.dll and mintty.exe (typically, c:/Cygwin/usr/bin) are
       on the PATH variable, in the Windows System or User environment
       variables space."

I would say that the typical location is C:\Cygwin\bin.

Later in the document:

"First, PATH must include the Windows path of the /bin, where typically
  both mintty.exe and cygwin1.dll' will be found. Remember, this is a"

I would say the Window path of /usr/bin here, since that is where the
package is installed (but since /usr/bin is typically mirrored to /bin
so that's perhaps a minor point).

Haven't read much of the document though, just spotted these issues...

Cheers,
Peter

--
Unsubscribe info:      http://cygwin.com/ml/#unsubscribe-simple
Problem reports:       http://cygwin.com/problems.html
Documentation:         http://cygwin.com/docs.html
FAQ:                   http://cygwin.com/faq/

Re: 'man' page for 'mintty' for review

[Christopher Faylor]

On Fri, Feb 06, 2009 at 10:04:36AM +0100, Peter Rosin wrote:
> Den 2009-02-05 20:47 skrev Lee D.Rothstein:
>> 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.
>> 'man ./mintty.1.gz' will render the file (in the current directory)
>> without "installing" the page.
>
> "3.   Make sure that the Windows file spec for the folder that contains
>       both cygwin1.dll and mintty.exe (typically, c:/Cygwin/usr/bin) are
>       on the PATH variable, in the Windows System or User environment
>       variables space."
>
> I would say that the typical location is C:\Cygwin\bin.
>
> Later in the document:
>
> "First, PATH must include the Windows path of the /bin, where typically
>  both mintty.exe and cygwin1.dll' will be found. Remember, this is a"
>
> I would say the Window path of /usr/bin here, since that is where the
> package is installed (but since /usr/bin is typically mirrored to /bin
> so that's perhaps a minor point).

/usr/bin is not in any way a Windows path so I don't think there is any
reason to change this.

cgf

--
Unsubscribe info:      http://cygwin.com/ml/#unsubscribe-simple
Problem reports:       http://cygwin.com/problems.html
Documentation:         http://cygwin.com/docs.html
FAQ:                   http://cygwin.com/faq/

Re: 'man' page for 'mintty' for review

[Lee D.Rothstein]

Christopher Faylor wrote:

 > On Fri, Feb 06, 2009 at 10:04:36AM +0100, Peter Rosin wrote:

 >> On 2009-02-05 20:47 Lee D.Rothstein wrote:

 >>> 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.
 >>> 'man ./mintty.1.gz' will render the file (in the current directory)
 >>> without "installing" the page.
 >> "3.   Make sure that the Windows file spec for the folder that contains
 >>       both cygwin1.dll and mintty.exe (typically, c:/Cygwin/usr/bin) are

 >>       on the PATH variable, in the Windows System or User environment
 >>       variables space."I
 >>
 >> I would say that the typical location is C:\Cygwin\bin.
                                            ^^^^^^^^^^^^^
I have changed the text to 'C:\Cygwin\bin', correcting two errors by me:

   * path
   * path delimitor

Thanks, Peter.
  
BTB, the reason that I use the word "typically", is because Cygwin can be
installed in other directories (e.g., in my system, "root" is at 'c:\_r'),
not because I thought a different directory besides 'bin' would have the
executable.
  
 >> Later in the document:
 >>
 >> "First, PATH must include the Windows path of the /bin, where typically
 >>  both mintty.exe and cygwin1.dll' will be found. Remember, this is a"

Here, I think I have the path right, since, the Windows equivalent of '/bin'
is 'c:\Cygwin\bin', which means I don't understand the following comment
at all:

 >> I would say the Window path of /usr/bin here, since that is where the
 >> package is installed (but since /usr/bin is typically mirrored to /bin
 >> so that's perhaps a minor point).

In both cases, I'm talking about invoking 'mintty' from Windows, not Cygwin.

Windows can only "see" the excutables in /bin (through 'c:\Cygwin\bin' NOT
through 'c:\Cygwin\usr\bin'), however, and we're talking about what Windows
can "see" when you "fire up" the 'mintty' shortcut.

-- Peter?

 > /usr/bin is not in any way a Windows path so I don't think there is any
 > reason to change this.

Christopher? Did I create too much confusion by my other errors?

I doubt that any/all of the above are the only things wrong with the 
doc. ;-)

Thanks for the help.

Lee

--
Unsubscribe info:      http://cygwin.com/ml/#unsubscribe-simple
Problem reports:       http://cygwin.com/problems.html
Documentation:         http://cygwin.com/docs.html
FAQ:                   http://cygwin.com/faq/

RE: 'man' page for 'mintty' for review

[Phil Betts]

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.


Phil
-- 

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
Documentation:         http://cygwin.com/docs.html
FAQ:                   http://cygwin.com/faq/

Re: 'man' page for 'mintty' for review

[Lee D. Rothstein]

Phil Betts wrote:

...
<Lots of good comments on 'mintty' man page>
...

Thanks, Phil,

Lee


--
Unsubscribe info:      http://cygwin.com/ml/#unsubscribe-simple
Problem reports:       http://cygwin.com/problems.html
Documentation:         http://cygwin.com/docs.html
FAQ:                   http://cygwin.com/faq/