cvs commit: doc/en_US.ISO8859-1/books/handbook/security chapter.sgml

[Niclas Zeising]

Johann Kois wrote:
> On Sunday 12 November 2006 01:13 Giorgos Keramidas wrote:
>> keramida    2006-11-12 00:13:05 UTC
>>
>>   FreeBSD doc repository
>>
>>   Modified files:
>>     en_US.ISO8859-1/books/handbook/security chapter.sgml
>>   Log:
>>   Wording fixes and other minor nits to the 'Security' chapter.
>>
>>   Submitted by:   Niclas Zeising <lothrandil at n00b.apagnu.se>
>>   PR:             docs/105256
>>
>>   Revision  Changes    Path
>>   1.307     +26 -27   
>> doc/en_US.ISO8859-1/books/handbook/security/chapter.sgml
> 
> Hello,
> 
> just MFen'd this commit to the german handbook and now I have
> one question.  In my opinion the word "Ssh" looks very strange
> (even if it is the first word in the sentence) so I think it
> would be better to change it into something like the version
> in the following diff:
> 
> --- chapter.sgml Sun Nov 12 01:13:04 2006
> +++ chapter.sgml.new     Sun Nov 12 11:12:55 2006
> @@ -935,7 +935,7 @@
>          <option>-x</option> option.  <application>ssh</application>
>          encrypts everything by default.</para>
> 
> -      <para>Ssh works quite well in every
> +      <para><application>ssh</application> works quite well in every
>          respect except that it forwards encryption keys by default.  
> What
>          this means is that if you have a secure workstation holding 
> keys
>          that give you access to the rest of the system, and you
> 
> Additionally we now have six different versions of "ssh" in this
> document which I find a little bit confusing:
> 
> - Ssh
> - ssh
> - SSH
> - <application>Ssh</application>
> - <application>ssh</application>
> - <application>SSH</application>
> 
> Maybe a little cleanup is needed here?  Any thoughts?
> 
> 
> 
> J. Kois

The difference between ssh and <application>ssh</application> is that 
ssh can be both an application and a protocol, and we have to 
differentiate that. Apart from that, I find staring a sentence with a 
non-capitalized letter looks weird. Maybe we should use the 
all-capitalized version, at least when talking about the protocol.
//Niclas