Originally written by Sergey A. Osokin
Rewritten by Tom Rhodes
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
$FreeBSD: releng/10.2/share/man/man5/nsmb.conf.5 235337 2012-05-12 15:08:22Z gjb $
.Dd October 19, 2010 .Dt NSMB.CONF 5 .Os .Sh NAME .Nm nsmb.conf .Nd configuration file for .Tn SMB requests .Sh DESCRIPTION The .Nm file contains information about the computers, users, and shares or mount points for the .Tn SMB network protocol.
p The configuration hierarchy is made up of several sections, each section containing a few or several lines of parameters and their assigned values. Each of these sections must begin with a section name enclosed within square brackets, similar to:
p .D1 Bq Ar section_name
p The end of each section is marked by either the start of a new section, or by the abrupt ending of the file, commonly referred to as the .Tn EOF . Each section may contain zero or more parameters such as:
p .D1 Bq Ar section_name .D1 Ar key Ns = Ns Ar value
p where .Ar key represents a parameter name, and .Ar value would be the parameter's assigned value.
p The .Tn SMB library uses the following information for section names:
p l -tag -width indent -compact t Ic A) q Li default t Ic B) q Ar SERVER t Ic C) q Ar SERVER : Ns Ar USER t Ic D) .Op Ar SERVER : Ns Ar USER : Ns Ar SHARE .El
p Possible keywords may include: l -column ".Va retry_count" ".Sy Section" t Sy "Keyword Section Comment" t Sy " A B C D" t Va addr Ta "- + - -" Ta "IP or IPX address of SMB server" t Va charsets Ta "- + + +" Ta "local:remote charset pair" t Va nbns Ta "+ + - -" Ta "address of NetBIOS name server (WINS)" t Va nbscope Ta "+ + - -" Ta "NetBIOS scope" t Va nbtimeout Ta "+ + - -" Ta "timeout for NetBIOS name servers" t Va password Ta "- - + +" Ta "plain text or simple encrypted password used to access the given share" t Va retry_count Ta "+ + - -" Ta "number of retries before connection is marked as broken" t Va timeout Ta "+ + - -" Ta "SMB request timeout" t Va workgroup Ta "+ + + +" Ta "workgroup name" .El .Sh FILES l -tag -width ".Pa /etc/nsmb.conf" t Pa /etc/nsmb.conf The default remote mount-point configuration file. t Pa ~/nsmb.conf The user specific remote mount-point configuration file. .El .Sh EXAMPLES What follows is a sample configuration file which may, or may not match your environment: d -literal -offset indent # Configuration file for example.com [default] workgroup=SALES # The 'FSERVER' is an NT server. [FSERVER] charsets=koi8-r:cp866 addr=fserv.example.com # User specific data for FSERVER [FSERVER:MYUSER] password=$$16144562c293a0314e6e1 .Ed
p All lines which begin with the .Ql # character are comments and will not be parsed. The .Dq Li default section describes the default workgroup or domain, in this case .Dq Li SALES . The next section depicted here as .Dq Li FSERVER , defines a server section and then assigns it a charset which is only required when Cyrillic characters are not used. 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: d -literal -offset indent smbutil crypt .Ed .Sh COMPATIBILITY At the time of this writing, the .Tn IPX protocol remains unsupported. Future .Fx releases are expected to support this. .Sh SEE ALSO .Xr smbutil 1 , .Xr mount_smbfs 8 .Sh AUTHORS This manual page was written by .An -nosplit .An Sergey Osokin Aq osa@FreeBSD.org and .An Tom Rhodes Aq trhodes@FreeBSD.org .