svn commit: r214598 - stable/8/share/man/man5

[Benedict Reuschling]

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