xref: /freebsd/share/man/man5/smbfs.5 (revision 069ac184)
1.\" Copyright (c) 2020 Gordon Bergling
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\"    notice, this list of conditions and the following disclaimer in the
10.\"    documentation and/or other materials provided with the distribution.
11.\"
12.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22.\" SUCH DAMAGE.
23.\"
24.Dd April 6, 2022
25.Dt SMBFS 5
26.Os
27.Sh NAME
28.Nm smbfs
29.Nd "SMB FS"
30.Sh SYNOPSIS
31To compile this driver into the kernel,
32place the following lines in your
33kernel configuration file:
34.Bd -ragged -offset indent
35.Cd "option NETSMB"
36.Ed
37.Pp
38Alternatively, to load the driver as a
39module at boot time, place the following line in
40.Xr loader.conf 5 :
41.Bd -literal -offset indent
42smbfs_load="YES"
43.Ed
44.Sh DESCRIPTION
45The SMB driver is an implementation of the CIFS (Common Internet Filesystem)
46network protocol.
47.Pp
48.Bf -symbolic
49The
50.Nm
51filesystem driver supports only the obsolete SMBv1 protocol.
52.Nm
53has known bugs and likely has security vulnerabilities.
54.Nm
55and userspace counterparts
56.Xr smbutil 1
57and
58.Xr mount_smbfs 8
59may be removed from a future version of
60.Fx .
61Users are advised to evaluate the
62.Pa sysutils/fusefs-smbnetfs
63port instead.
64.Ef
65.Sh SEE ALSO
66.Xr smbutil 1 ,
67.Xr mount_smbfs 8
68.Sh STANDARDS
69.Rs
70.%U https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-cifs/
71.%T Common Internet File System (CIFS) Protocol
72.%R MS-CIFS
73.%D December 2018
74.Re
75.Pp
76.Rs
77.%U https://tools.ietf.org/html/draft-heizer-cifs-v1-spec-00
78.%T Common Internet File System Protocol (CIFS/1.0)
79.%D June 13, 1996
80.%A I. Heizer
81.%A P. Leach
82.%A D. Perry
83.Re
84.Sh HISTORY
85The
86.Nm
87device driver first appeared in
88.Fx 4.4 .
89.Sh AUTHORS
90.An -nosplit
91The
92.Nm
93device driver was written by
94.An Boris Popov Aq Mt bp@FreeBSD.org .
95The manual page was contributed by
96.An Gordon Bergling Aq Mt gbe@FreeBSD.org .
97