docs/132311: [patch] man5/nsmb.conf.5

[David Horn]

>Number:         132311
>Category:       docs
>Synopsis:       [patch] man5/nsmb.conf.5
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Mar 04 17:10:01 UTC 2009
>Closed-Date:
>Last-Modified:
>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 at 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:
>Unformatted: