share/man/man5/smbfs.5

   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
  31 To compile this driver into the kernel,
  32 place the following lines in your
  33 kernel configuration file:
  34 .Bd -ragged -offset indent
  35 .Cd "option NETSMB"
  36 .Ed
  37 .Pp
  38 Alternatively, to load the driver as a
  39 module at boot time, place the following line in
  40 .Xr loader.conf 5 :
  41 .Bd -literal -offset indent
  42 smbfs_load="YES"
  43 .Ed
  44 .Sh DESCRIPTION
  45 The SMB driver is an implementation of the CIFS (Common Internet Filesystem)
  46 network protocol.
  47 .Pp
  48 .Bf -symbolic
  49 The
  50 .Nm
  51 filesystem driver supports only the obsolete SMBv1 protocol.
  52 .Nm
  53 has known bugs and likely has security vulnerabilities.
  54 .Nm
  55 and userspace counterparts
  56 .Xr smbutil 1
  57 and
  58 .Xr mount_smbfs 8
  59 may be removed from a future version of
  60 .Fx .
  61 Users are advised to evaluate the
  62 .Pa sysutils/fusefs-smbnetfs
  63 port 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
  85 The
  86 .Nm
  87 device driver first appeared in
  88 .Fx 4.4 .
  89 .Sh AUTHORS
  90 .An -nosplit
  91 The
  92 .Nm
  93 device driver was written by
  94 .An Boris Popov Aq Mt bp@FreeBSD.org .
  95 The manual page was contributed by
  96 .An Gordon Bergling Aq Mt gbe@FreeBSD.org .