first pass at updating head branch to be to be the same as the SAMBA_2_0 branch

[kai/samba-autobuild/.git] / docs / manpages / smbmount.8

diff --git a/docs/manpages/smbmount.8 b/docs/manpages/smbmount.8
index 4ac7267395b76dd4bfee231ed2b1d67cf41004a5..457a940ddba92889f861292e5271ab31014bf034 100644 (file)
--- a/docs/manpages/smbmount.8
+++ b/docs/manpages/smbmount.8
@@ -1,44 +1,87 @@
-.TH SMBMOUNT 8 "13 Nov 1998" "smbmount 2.0.0-beta1"
-.SH NAME
-smbmount \- mount smb file system
-.SH SYNOPSIS
-.B smbmount
-[
-.B options
-]
-
-.SH DESCRIPTION
-.B smbmount 
-is a stripped-down version of the 
-.BI smbclient (1)
-program used to mount smbfs shares. It implements only the mount command,
-which then calls the
-.BI smbmnt (8)
-program to do the actual mount.
-.B smbmount
-itself accepts most of the options that
-.B smbclient
-does. See the
-.BI smbclient (1)
-manpage for details.
-
-To mount an smb file system, I suggest using the option
-.B -c
-for smbmount to pass the mount command. For example, use
-
-smbmount '\\\\server\\tmp' -c 'mount /mnt -u 123 -g 456'
-
-to mount the tmp share of server on /mnt, giving it a local uid 123
-and a local gid 456.
-
-The arguments supplied to the mount command are passed directly to the
-.B smbmnt
-utility for processing.
-Refer to the
-.BI smbmnt (8)
-manpage for details.
-
-.SH SEE ALSO
-.BI smbmnt (8),
-.BI smbclient (1)
-
+.TH "smbmount " "1" "25 September 1999" "Samba" "SAMBA" 
+.PP 
+.SH "NAME" 
+smbmount \- mount an SMB filesystem
+.PP 
+.SH "SYNOPSIS" 
+\fBsmbmount\fP service mountpoint [ -o options ]
+.PP 
+.SH "DESCRIPTION" 
+.PP 
+smbmount mounts a SMB filesystem\&. It is usually invoked as mount\&.smb
+from the mount(8) command when using the "-t smb" option\&. The kernel
+must support the smbfs filesystem\&.
+.PP 
+Options to smbmount are specified as a comma separated list of
+key=value pairs\&. 
+.PP 
+NOTE: smbmount calls smbmnt to do the actual mount\&. You must make sure
+that smbmnt is in the path so that it can be found\&.
+.PP 
+.IP "\fBusername=<arg>\fP" 
+specifies the username to connect as\&. If this is
+not given then the environment variable USER is used\&. This option can
+also take the form user%password or user/workgroup or
+user/workgroup%password to allow the password and workgroup to be
+specified as part of the username\&.
+.IP 
+.IP "\fBpassword=<arg>\fP" 
+specifies the SMB password\&. If not given then
+smbmount will prompt for a passeword, unless the guest option is
+given\&.
+.IP 
+.IP "\fBnetbiosname=<arg>\fP" 
+sets the source NetBIOS name\&. It defaults to
+the local hostname\&.
+.IP 
+.IP "\fBuid=<arg>\fP" 
+sets the uid that files will be mounted as\&. It may be
+specified as either a username or a numeric uid\&.
+.IP 
+.IP "\fBgid=<arg>\fP" 
+sets the gid that files will be mounted as\&. It may be
+specified as either a groupname or a numeric gid\&.
+.IP 
+.IP "\fBport=<arg>\fP" 
+sets the remote SMB port number\&. The default is 139\&.
+.IP 
+.IP "\fBfmask=<arg>\fP" 
+sets the file mask\&. This deterines the permissions
+that remote files have in the local filesystem\&. The default is based
+on the current umask\&.
+.IP 
+.IP "\fBdmask=<arg>\fP" 
+sets the directory mask\&. This deterines the
+permissions that remote directories have in the local filesystem\&. The
+default is based on the current umask\&.
+.IP 
+.IP "\fBdebug=<arg>\fP" 
+sets the debug level\&. This is useful for tracking
+down SMB connection problems\&.
+.IP 
+.IP "\fBip=<arg>\fP" 
+sets the destination host or IP address\&.
+.IP 
+.IP "\fBworkgroup=<arg>\fP" 
+sets the workgroup on the destination
+.IP 
+.IP "\fBsockopt=<arg>\fP" 
+sets the TCP socket options\&. See the smb\&.conf
+"socket options" option\&.
+.IP 
+.IP "\fBscope=<arg>\fP" 
+sets the NetBIOS scope
+.IP 
+.IP "\fBguest\fP" 
+don\'t prompt for a password
+.IP 
+.IP "\fBro\fP" 
+mount read-only
+.IP 
+.IP "\fBrw\fP" 
+mount read-write
+.IP 
+.PP 
+.SH "AUTHOR" 
+The maintainer of smbfs, smbmnt and smbmount is Andrew Tridgell
+\fItridge@samba\&.org\fP