xref: /freebsd/share/man/man5/nsmb.conf.5 (revision 9336e0699bda8a301cd2bfa37106b6ec5e32012e)
1.\" Copyright (c) 2003
2.\" Originally written by Sergey A. Osokin
3.\" Rewritten by Tom Rhodes
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd June 30, 2003
29.Dt NSMB.CONF 5
30.Os
31.Sh NAME
32.Nm nsmb.conf
33.Nd configuration file for
34.Tn SMB
35requests
36.Sh DESCRIPTION
37The
38.Nm
39file contains information about the computers, users, and shares
40or mount points for the
41.Tn SMB
42network protocol.
43.Pp
44The configuration hierarchy is made up of several sections,
45each section containing a few or several lines of parameters
46and their assigned values.
47Each of these sections must begin with a section name enclosed within
48square brackets, similar to:
49.Pp
50.D1 Bq Ar section_name
51.Pp
52The end of each section is marked by either the start of a new section,
53or by the abrupt ending of the file, commonly referred to as the
54.Tn EOF .
55Each section may contain zero or more parameters such as:
56.Pp
57.D1 Bq Ar section_name
58.D1 Ar key Ns = Ns Ar value
59.Pp
60where
61.Ar key
62represents a parameter name, and
63.Ar value
64would be the parameter's assigned value.
65.Pp
66The
67.Tn SMB
68library uses the following information for section names:
69.Pp
70.Bl -tag -width indent -compact
71.It Ic A)
72.Bq Li default
73.It Ic B)
74.Bq Ar SERVER
75.It Ic C)
76.Bq Ar SERVER : Ns Ar USER
77.It Ic D)
78.Op Ar SERVER : Ns Ar USER : Ns Ar SHARE
79.El
80.Pp
81Possible keywords may include:
82.Bl -column ".Va retry_count" ".Sy Section"
83.It Sy "Keyword	Section	Comment"
84.It Sy "	A B C D"
85.It Va addr        Ta "- + - -" Ta "IP or IPX address of SMB server"
86.It Va charsets    Ta "- + + +" Ta "local:remote charset pair"
87.It Va nbns        Ta "+ + - -" Ta "address of NetBIOS name server (WINS)"
88.It Va nbscope     Ta "+ + - -" Ta "NetBIOS scope"
89.It Va nbtimeout   Ta "+ + - -" Ta "timeout for NetBIOS name servers"
90.It Va password    Ta "- - + +" Ta "plain text password used to access the given share"
91.It Va retry_count Ta "+ + - -" Ta "number of retries before connection is marked as broken"
92.It Va timeout     Ta "+ + - -" Ta "SMB request timeout"
93.It Va workgroup   Ta "+ + + +" Ta "workgroup name"
94.El
95.Sh FILES
96.Bl -tag -width ".Pa /etc/nsmb.conf"
97.It Pa /etc/nsmb.conf
98The default remote mount-point configuration file.
99.El
100.Sh EXAMPLES
101What follows is a sample configuration file which may,
102or may not match your environment:
103.Bd -literal -offset indent
104# Configuration file for example.com
105[default]
106workgroup=SALES
107# The 'FSERVER' is an NT server.
108[FSERVER]
109charsets=koi8-r:cp866
110addr=fserv.example.com
111.Ed
112.Pp
113All lines which begin with the
114.Ql #
115character are comments and will not be parsed.
116The
117.Dq Li default
118section describes the default workgroup or domain, in this case
119.Dq Li SALES .
120The next section depicted here as
121.Dq Li FSERVER ,
122defines a server section and then assigns it a charset which is only
123required when Cyrillic characters are not used.
124The hostname value,
125.Dq Li fserv.example.com ,
126is also assigned in this section.
127.Sh COMPATIBILITY
128At the time of this writing, the
129.Tn IPX
130protocol remains unsupported.
131Future
132.Fx
133releases are expected to support this.
134.Sh SEE ALSO
135.Xr smbutil 1 ,
136.Xr mount_smbfs 8
137.Sh AUTHORS
138This manual page was written by
139.An -nosplit
140.An Sergey Osokin Aq osa@FreeBSD.org
141and
142.An Tom Rhodes Aq trhodes@FreeBSD.org .
143