svn commit: r358917 - stable/12/contrib/smbfs/mount_smbfs

Mateusz Piotrowski 0mp at FreeBSD.org
Thu Mar 12 19:00:28 UTC 2020 

Author: 0mp (doc,ports committer)
Date: Thu Mar 12 19:00:28 2020
New Revision: 358917
URL: https://svnweb.freebsd.org/changeset/base/358917

Log:
  MFC r339990:
  
  mount_smbfs(8): Add the STANDARDS and HISTORY sections
  
  - Document that mount_smbfs(8) only supports SMB1 and that SMB2 and SMB3
    are not supported at the moment. Suggest users to browse ports for
    software compatible with newer versions of the protocol.
  - Copy supported servers list from README.
  - Add a SEE ALSO section and reference the chapter about Samba in the
    FreeBSD Handbook.
  - Add a HISTORY section.
  - Style changes:
    - Use Dq instead of Em in the EXAMPLES section.
    - Mark command modifiers with Cm.
  
  Reviewed by:    bcr
  Approved by:    bcr (mentor)
  Approved by:    krion (mentor, implicit), mat (mentor, implicit)
  Sponsored by:   Bally Wulff Games & Entertainment GmbH
  Differential Revision:  https://reviews.freebsd.org/D17798

Modified:
  stable/12/contrib/smbfs/mount_smbfs/mount_smbfs.8
Directory Properties:
  stable/12/   (props changed)

Modified: stable/12/contrib/smbfs/mount_smbfs/mount_smbfs.8
==============================================================================
--- stable/12/contrib/smbfs/mount_smbfs/mount_smbfs.8	Thu Mar 12 18:28:23 2020	(r358916)
+++ stable/12/contrib/smbfs/mount_smbfs/mount_smbfs.8	Thu Mar 12 19:00:28 2020	(r358917)
@@ -1,6 +1,6 @@
 .\" $Id: mount_smbfs.8,v 1.10 2002/04/16 02:47:41 bp Exp $
 .\" $FreeBSD$
-.Dd September 17, 2011
+.Dd November 1, 2018
 .Dt MOUNT_SMBFS 8
 .Os
 .Sh NAME
@@ -8,12 +8,12 @@
 .Nd "mount a shared resource from an SMB file server"
 .Sh SYNOPSIS
 .Nm
-.Op Fl E Ar cs1 : Ns Ar cs2
+.Op Fl E Ar cs1 Ns Cm \&: Ns Ar cs2
 .Op Fl I Ar host
 .Op Fl L Ar locale
-.Op Fl M Ar crights : Ns Ar srights
+.Op Fl M Ar crights Ns Cm \&: Ns Ar srights
 .Op Fl N
-.Op Fl O Ar cowner : Ns Ar cgroup Ns / Ns Ar sowner : Ns Ar sgroup
+.Op Fl O Ar cowner Ns Cm \&: Ns Ar cgroup Ns Cm \&/ Ns Ar sowner Ns Cm \&: Ns Ar sgroup
 .Op Fl R Ar retrycount
 .Op Fl T Ar timeout
 .Op Fl U Ar username
@@ -25,9 +25,9 @@
 .Op Fl n Ar opt
 .Op Fl u Ar uid
 .Sm off
-.No // Ar user No @ Ar server
-.Op Ar :port1 Op Ar :port2
-.No / Ar share
+.Cm \&// Ns Ar user Cm \&@ Ar server
+.Op Cm \&: Ar port1 Op Cm \&: Ar port2
+.Cm \&/ Ar share
 .Sm on
 .Ar node
 .Sh DESCRIPTION
@@ -37,7 +37,7 @@ command mounts a share from a remote server using SMB/
 .Pp
 The options are as follows:
 .Bl -tag -width indent
-.It Fl E Ar cs1 : Ns Ar cs2
+.It Fl E Ar cs1 Ns Cm \&: Ns Ar cs2
 Specifies local
 .Pq Ar cs1
 and server's
@@ -57,7 +57,7 @@ By default,
 tries to use an environment variable
 .Ev LC_*
 to determine it.
-.It Fl M Ar crights : Ns Ar srights
+.It Fl M Ar crights Ns Cm \&: Ns Ar srights
 Assign access rights to the newly created connection.
 .It Fl N
 Do not ask for a password.
@@ -69,7 +69,7 @@ file for additional configuration parameters and a pas
 If no password is found,
 .Nm
 prompts for it.
-.It Fl O Ar cowner : Ns Ar cgroup Ns / Ns Ar sowner : Ns Ar sgroup
+.It Fl O Ar cowner Ns Cm \&: Ns Ar cgroup Ns Cm \&/ Ns Ar sowner Ns Cm \&: Ns Ar sgroup
 Assign owner/group attributes to the newly created connection.
 .It Fl R Ar retrycount
 How many retries should be done before the SMB requester decides to drop
@@ -111,7 +111,7 @@ server.
 User ID and group ID assigned to files.
 The default are owner and group IDs from
 the directory where the volume is mounted.
-.It No // Ns Ar user Ns @ Ns Ar server Ns Oo Ar :port1 Ns Oo Ar :port2 Oc Oc Ns No / Ns Ar share
+.It Cm \&// Ns Ar user Ns Cm \&@ Ns Ar server Ns Oo Cm \&: Ns Ar port1 Ns Oo Cm \&: Ns Ar port2 Oc Oc Ns Cm \&/ Ns Ar share
 The
 .Nm
 command will use
@@ -145,13 +145,13 @@ for details.
 .El
 .Sh EXAMPLES
 The following example illustrates how to connect to SMB server
-.Em SAMBA
+.Dq SAMBA
 as user
-.Em GUEST ,
+.Dq GUEST ,
 and mount shares
-.Em PUBLIC
+.Dq PUBLIC
 and
-.Em TMP :
+.Dq TMP :
 .Bd -literal -offset indent
 mount_smbfs -I samba.mydomain.com //guest at samba/public /smb/public
 mount_smbfs -I 192.168.20.3 -E koi8-r:cp866 //guest at samba/tmp /smb/tmp
@@ -159,9 +159,39 @@ mount_smbfs -I 192.168.20.3 -E koi8-r:cp866 //guest at sa
 .Pp
 It is also possible to use
 .Xr fstab 5
-for smbfs mounts (the example below doesn't prompt for a password):
+for smbfs mounts (the example below does not prompt for a password):
 .Pp
 .Dl "//guest at samba/public    /smb/public     smbfs  rw,noauto,-N 0   0"
+.Sh SEE ALSO
+.Bl -dash
+.It
+Chapter dedicated to Samba configuration in the
+.Fx
+Handbook:
+.Lk "https://www.freebsd.org/doc/handbook/network-samba.html"
+.El
+.Sh STANDARDS
+.Nm
+offers support for SMB/CIFS/SMB1.
+It does not support newer versions of the protocol like SMB2 and SMB3.
+SMB2 and SMB3 are supported by software available in the
+.Xr ports 7
+collection.
+.Pp
+The list of supported SMB servers includes:
+.Bl -dash -compact
+.It
+Samba
+.It
+Windows 95/98/ME/2000/NT4.0 (SPs 4, 5, 6)
+.It
+IBM LanManager
+.It
+NetApp
+.El
+.Sh HISTORY
+SMB/CIFS protocol and SMB/CIFS file system implementation first appeared in
+.Fx 4.5 .
 .Sh AUTHORS
 .An Boris Popov Aq bp at butya.kz ,
 .Aq bp at FreeBSD.org

More information about the svn-src-all mailing list