From nobody@FreeBSD.org  Wed Mar  4 17:02:46 2009
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 65A3E106566B
	for <freebsd-gnats-submit@FreeBSD.org>; Wed,  4 Mar 2009 17:02:46 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21])
	by mx1.freebsd.org (Postfix) with ESMTP id 3864D8FC2E
	for <freebsd-gnats-submit@FreeBSD.org>; Wed,  4 Mar 2009 17:02:46 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.14.3/8.14.3) with ESMTP id n24H2kBG041873
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 4 Mar 2009 17:02:46 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.14.3/8.14.3/Submit) id n24H2jEd041872;
	Wed, 4 Mar 2009 17:02:45 GMT
	(envelope-from nobody)
Message-Id: <200903041702.n24H2jEd041872@www.freebsd.org>
Date: Wed, 4 Mar 2009 17:02:45 GMT
From: David Horn <dhorn2000@gmail.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [patch] man5/nsmb.conf.5
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         132311
>Category:       docs
>Synopsis:       [patch] man5/nsmb.conf.5
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    bcr
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Mar 04 17:10:01 UTC 2009
>Closed-Date:    Sun Oct 31 12:19:24 UTC 2010
>Last-Modified:  Sun Oct 31 12:19:24 UTC 2010
>Originator:     David Horn
>Release:        7.0
>Organization:
>Environment:
FreeBSD dhorn-bsd 7.0-RELEASE-p7 FreeBSD 7.0-RELEASE-p7 #0: Sun Dec 21 12:33:45 UTC 2008     root@i386-builder.daemonology.net:/usr/obj/usr/src/sys/GENERIC  i386
>Description:
Add some missing documentation to the man page for nsmb.conf.
/usr/src/share/man/man5/nsmb.conf.5

- FILES section ref: ~/nsmb.conf
- use of password in examples section
- use of simple encryption for password in examples section

This is a fairly trivial change, but also very useful information.

nsmb.conf on HEAD also has same issue
>How-To-Repeat:
man 5 nsmb.conf
>Fix:
unified diff attached for man5/nsmb.conf.5

Patch attached with submission follows:

--- nsmb.conf.5.original	2009-03-04 11:10:51.000000000 -0500
+++ nsmb.conf.5	2009-03-04 11:47:26.000000000 -0500
@@ -87,7 +87,7 @@
 .It Va nbns        Ta "+ + - -" Ta "address of NetBIOS name server (WINS)"
 .It Va nbscope     Ta "+ + - -" Ta "NetBIOS scope"
 .It Va nbtimeout   Ta "+ + - -" Ta "timeout for NetBIOS name servers"
-.It Va password    Ta "- - + +" Ta "plain text password used to access the given share"
+.It Va password    Ta "- - + +" Ta "plain text or simple encrypted password used to access the given share"
 .It Va retry_count Ta "+ + - -" Ta "number of retries before connection is marked as broken"
 .It Va timeout     Ta "+ + - -" Ta "SMB request timeout"
 .It Va workgroup   Ta "+ + + +" Ta "workgroup name"
@@ -96,6 +96,9 @@
 .Bl -tag -width ".Pa /etc/nsmb.conf"
 .It Pa /etc/nsmb.conf
 The default remote mount-point configuration file.
+.Pa ~/nsmb.conf"
+.It Pa ~/nsmb.conf
+The user specific remote mount-point configuration file.
 .El
 .Sh EXAMPLES
 What follows is a sample configuration file which may,
@@ -108,6 +111,9 @@
 [FSERVER]
 charsets=koi8-r:cp866
 addr=fserv.example.com
+# User specific data for FSERVER
+[FSERVER:MYUSER]
+password=$$16144562c293a0314e6e1
 .Ed
 .Pp
 All lines which begin with the
@@ -124,6 +130,18 @@
 The hostname value,
 .Dq Li fserv.example.com ,
 is also assigned in this section.
+.Dq Li FSERVER:USER ,
+defines the user specific settings, and is useful for saving the password
+for a specific connection.  The password may be plaintext or obfuscated
+using simple encryption.  
+The simple encrypted password starts with the `$$1' symbols.  Warning: the
+encryption function is very weak and intended only to hide clear
+text password.
+If you wish to use simple encryption, you can 
+generate this using the following command:
+.Bd -literal -offset indent
+smbutil crypt
+.Ed 
 .Sh COMPATIBILITY
 At the time of this writing, the
 .Tn IPX


>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->bcr 
Responsible-Changed-By: bcr 
Responsible-Changed-When: Mon Oct 18 07:22:32 UTC 2010 
Responsible-Changed-Why:  
I will work on it. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=132311 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/132311: commit references a PR
Date: Tue, 26 Oct 2010 18:32:58 +0000 (UTC)

 Author: bcr (doc committer)
 Date: Tue Oct 26 18:32:51 2010
 New Revision: 214387
 URL: http://svn.freebsd.org/changeset/base/214387
 
 Log:
   Add some missing documentation to the man page:
   
   - FILES section ref: ~/nsmb.conf
   - use of password in examples section
   - use of simple encryption for password in examples section
   
   PR:                 docs/132311
   Submitted by:       David Horn (dhorn2000 at gmail dot com)
   Patch corrected by: trhodes
   Approved by:        trhodes
   MFC after:          5 days
 
 Modified:
   head/share/man/man5/nsmb.conf.5
 
 Modified: head/share/man/man5/nsmb.conf.5
 ==============================================================================
 --- head/share/man/man5/nsmb.conf.5	Tue Oct 26 18:01:28 2010	(r214386)
 +++ head/share/man/man5/nsmb.conf.5	Tue Oct 26 18:32:51 2010	(r214387)
 @@ -25,7 +25,7 @@
  .\"
  .\" $FreeBSD$
  .\"
 -.Dd June 30, 2003
 +.Dd October 19, 2010
  .Dt NSMB.CONF 5
  .Os
  .Sh NAME
 @@ -87,7 +87,7 @@ Possible keywords may include:
  .It Va nbns        Ta "+ + - -" Ta "address of NetBIOS name server (WINS)"
  .It Va nbscope     Ta "+ + - -" Ta "NetBIOS scope"
  .It Va nbtimeout   Ta "+ + - -" Ta "timeout for NetBIOS name servers"
 -.It Va password    Ta "- - + +" Ta "plain text password used to access the given share"
 +.It Va password    Ta "- - + +" Ta "plain text or simple encrypted password used to access the given share"
  .It Va retry_count Ta "+ + - -" Ta "number of retries before connection is marked as broken"
  .It Va timeout     Ta "+ + - -" Ta "SMB request timeout"
  .It Va workgroup   Ta "+ + + +" Ta "workgroup name"
 @@ -96,6 +96,9 @@ Possible keywords may include:
  .Bl -tag -width ".Pa /etc/nsmb.conf"
  .It Pa /etc/nsmb.conf
  The default remote mount-point configuration file.
 +.Pa "~/nsmb.conf"
 +.It Pa ~/nsmb.conf
 +The user specific remote mount-point configuration file.
  .El
  .Sh EXAMPLES
  What follows is a sample configuration file which may,
 @@ -108,6 +111,9 @@ workgroup=SALES
  [FSERVER]
  charsets=koi8-r:cp866
  addr=fserv.example.com
 +# User specific data for FSERVER
 +[FSERVER:MYUSER]
 +password=$$16144562c293a0314e6e1
  .Ed
  .Pp
  All lines which begin with the
 @@ -124,6 +130,18 @@ required when Cyrillic characters are no
  The hostname value,
  .Dq Li fserv.example.com ,
  is also assigned in this section.
 +.Dq Li FSERVER:USER ,
 +defines the user settings and is useful for saving the password used
 +during a specific connection.
 +The password may be plaintext or obfuscated using simple encryption.  
 +The simple encrypted password starts with the `$$1' symbols.
 +Warning: the encryption function is very weak and intended only to hide
 +clear text passwords.
 +If the use of simple encryption is desired, the following command may be
 +used on a password:
 +.Bd -literal -offset indent
 +smbutil crypt
 +.Ed 
  .Sh COMPATIBILITY
  At the time of this writing, the
  .Tn IPX
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: open->patched 
State-Changed-By: bcr 
State-Changed-When: Tue Oct 26 18:41:57 UTC 2010 
State-Changed-Why:  
A modified version of the patch was committed to HEAD. 
Until the MFC is done, leave the PR in patched state. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=132311 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/132311: commit references a PR
Date: Sun, 31 Oct 2010 12:05:45 +0000 (UTC)

 Author: bcr (doc committer)
 Date: Sun Oct 31 12:05:37 2010
 New Revision: 214598
 URL: http://svn.freebsd.org/changeset/base/214598
 
 Log:
   MFC r214387:
   
   Add some missing documentation to the man page:
   
   - FILES section ref: ~/nsmb.conf
   - use of password in examples section
   - use of simple encryption for password in examples section
   
   PR:                 docs/132311
   Submitted by:       David Horn (dhorn2000 at gmail dot com)
   Patch corrected by: trhodes
   Approved by:        trhodes
 
 Modified:
   stable/8/share/man/man5/nsmb.conf.5
 Directory Properties:
   stable/8/share/man/man5/   (props changed)
 
 Modified: stable/8/share/man/man5/nsmb.conf.5
 ==============================================================================
 --- stable/8/share/man/man5/nsmb.conf.5	Sun Oct 31 11:44:41 2010	(r214597)
 +++ stable/8/share/man/man5/nsmb.conf.5	Sun Oct 31 12:05:37 2010	(r214598)
 @@ -25,7 +25,7 @@
  .\"
  .\" $FreeBSD$
  .\"
 -.Dd June 30, 2003
 +.Dd October 19, 2010
  .Dt NSMB.CONF 5
  .Os
  .Sh NAME
 @@ -87,7 +87,7 @@ Possible keywords may include:
  .It Va nbns        Ta "+ + - -" Ta "address of NetBIOS name server (WINS)"
  .It Va nbscope     Ta "+ + - -" Ta "NetBIOS scope"
  .It Va nbtimeout   Ta "+ + - -" Ta "timeout for NetBIOS name servers"
 -.It Va password    Ta "- - + +" Ta "plain text password used to access the given share"
 +.It Va password    Ta "- - + +" Ta "plain text or simple encrypted password used to access the given share"
  .It Va retry_count Ta "+ + - -" Ta "number of retries before connection is marked as broken"
  .It Va timeout     Ta "+ + - -" Ta "SMB request timeout"
  .It Va workgroup   Ta "+ + + +" Ta "workgroup name"
 @@ -96,6 +96,9 @@ Possible keywords may include:
  .Bl -tag -width ".Pa /etc/nsmb.conf"
  .It Pa /etc/nsmb.conf
  The default remote mount-point configuration file.
 +.Pa "~/nsmb.conf"
 +.It Pa ~/nsmb.conf
 +The user specific remote mount-point configuration file.
  .El
  .Sh EXAMPLES
  What follows is a sample configuration file which may,
 @@ -108,6 +111,9 @@ workgroup=SALES
  [FSERVER]
  charsets=koi8-r:cp866
  addr=fserv.example.com
 +# User specific data for FSERVER
 +[FSERVER:MYUSER]
 +password=$$16144562c293a0314e6e1
  .Ed
  .Pp
  All lines which begin with the
 @@ -124,6 +130,18 @@ required when Cyrillic characters are no
  The hostname value,
  .Dq Li fserv.example.com ,
  is also assigned in this section.
 +.Dq Li FSERVER:USER ,
 +defines the user settings and is useful for saving the password used
 +during a specific connection.
 +The password may be plaintext or obfuscated using simple encryption.  
 +The simple encrypted password starts with the `$$1' symbols.
 +Warning: the encryption function is very weak and intended only to hide
 +clear text passwords.
 +If the use of simple encryption is desired, the following command may be
 +used on a password:
 +.Bd -literal -offset indent
 +smbutil crypt
 +.Ed 
  .Sh COMPATIBILITY
  At the time of this writing, the
  .Tn IPX
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: patched->closed 
State-Changed-By: bcr 
State-Changed-When: Sun Oct 31 12:18:36 UTC 2010 
State-Changed-Why:  
MFC is done, PR closed. Thanks for sending the patch! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=132311 
>Unformatted:
