Mailing-List: contact cygwin-help AT cygwin DOT com; run by ezmlm
List-Subscribe: <mailto:cygwin-subscribe AT cygwin DOT com>
List-Archive: <http://sourceware.org/ml/cygwin/>
List-Post: <mailto:cygwin AT cygwin DOT com>
List-Help: <mailto:cygwin-help AT cygwin DOT com>, <http://sourceware.org/ml/#faqs>
Sender: cygwin-owner AT cygwin DOT com
Mail-Followup-To: cygwin AT cygwin DOT com
Delivered-To: mailing list cygwin AT cygwin DOT com
Date: Fri, 16 Jul 2004 11:36:31 +0200
From: Corinna Vinschen <corinna-cygwin AT cygwin DOT com>
To: cygwin AT cygwin DOT com
Subject: Re: ssmtp man page (Was: Re: sending email from Cygwin)
Message-ID: <20040716093631.GR1389@cygbert.vinschen.de>
Reply-To: cygwin AT cygwin DOT com
Mail-Followup-To: cygwin AT cygwin DOT com
References: <20040715081800 DOT GC19753 AT cygbert DOT vinschen DOT de> <20040716020103 DOT B6B8584C87 AT pessard DOT research DOT canon DOT com DOT au>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20040716020103.B6B8584C87@pessard.research.canon.com.au>
User-Agent: Mutt/1.4.2i

On Jul 16 12:01, luke DOT kendall AT cisra DOT canon DOT com DOT au wrote:
> On 15 Jul, Corinna Vinschen wrote:
> >  > Incidentally is it appropriate to include Cygwin-port-specific  
> >  > information in a man page? 
> >   
> >  Well, from a user perspective it might be cool, but IMHO the original 
> >  man page shouldn't be changed, unless it's a change which should be 
> >  send upstream anyway.  We have the Cygwin specific documentation in 
> >  /usr/share/doc/Cygwin (resp. /usr/doc/Cygwin in earlier releases) for 
> >  a long time now.  It should be not too hard to ask users to look there 
> >  for Cygwin specific docs. 
> >   
> >   
> >  Corinna 
> 
> Can you think of a way of incorporating the material in the man page
> that would be palatable upstream?  How do you think people would feel
> about a section "PORTABILITY" or "NOTES" or even "WINDOWS" or "CYGWIN"?

I have no idea.  That's something you would have to ask the upstream
maintainer.  But the first question is if the Cygwin maintainer likes
the idea.

> The above question is relevant to a patch for the ssmtp man page.  If
> ssmtp uses ssmtp-config on most platforms it works on, then I can just
> write a patch that includes both fixes.

ssmtp-config is a Cygwin specific script.

> This is a usability issue.  It's hard enough to teach people to type:
> 
> 	man <command-name>
> 
> teaching them to type:
> 
> 	more /usr/share/doc/Cygwin/ssmtp-0.x.y/README.ssmtp-0.x.y

Don't make it overly complicated.  `less /usr/share/doc/Cygwin/ssmtp*'
is enough.  And telling people that /usr/share/doc/Cygwin contains
Cygwin specific README files isn't that hard, really.


Corinna

-- 
Corinna Vinschen                  Please, send mails regarding Cygwin to
Cygwin Co-Project Leader          mailto:cygwin AT cygwin DOT com
Red Hat, Inc.

--
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/