summaryrefslogtreecommitdiff
path: root/docs/manpages/smbmount.8
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manpages/smbmount.8')
-rw-r--r--docs/manpages/smbmount.867
1 files changed, 45 insertions, 22 deletions
diff --git a/docs/manpages/smbmount.8 b/docs/manpages/smbmount.8
index ba57926fc7..f5b3141611 100644
--- a/docs/manpages/smbmount.8
+++ b/docs/manpages/smbmount.8
@@ -3,7 +3,7 @@
.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "SMBMOUNT" "8" "24 April 2001" "" ""
+.TH "SMBMOUNT" "8" "10 October 2001" "" ""
.SH NAME
smbmount \- mount an smbfs filesystem
.SH SYNOPSIS
@@ -11,22 +11,23 @@ smbmount \- mount an smbfs filesystem
\fBsmbumount\fR \fBservice\fR \fBmount-point\fR [ \fB-o options\fR ]
.SH "DESCRIPTION"
.PP
-\fBsmbmount\fR mounts a SMB filesystem. It
-is usually invoked as \fBmount.smb\fR from
+\fBsmbmount\fR mounts a Linux SMB filesystem. It
+is usually invoked as \fBmount.smbfs\fR by
the \fBmount(8)\fR command when using the
-"-t smb" option. The kernel must support the smbfs filesystem.
+"-t smbfs" option. This command only works in Linux, and the kernel must
+support the smbfs filesystem.
.PP
-Options to smbmount are specified as a comma separated
+Options to \fBsmbmount\fR are specified as a comma-separated
list of key=value pairs. It is possible to send options other
than those listed here, assuming that smbfs supports them. If
you get mount failures, check your kernel log for errors on
unknown options.
.PP
-smbmount is a daemon. After mounting it keeps running until
+\fBsmbmount\fR is a daemon. After mounting it keeps running until
the mounted smbfs is umounted. It will log things that happen
when in daemon mode using the "machine name" smbmount, so
-typically this output will end up in log.smbmount. The
-smbmount process may also be called mount.smbfs.
+typically this output will end up in \fIlog.smbmount\fR. The
+\fBsmbmount\fR process may also be called mount.smbfs.
.PP
\fBNOTE:\fR \fBsmbmount\fR
calls \fBsmbmnt(8)\fR to do the actual mount. You
@@ -48,6 +49,12 @@ option is not given then the environment variable
no password \fBsmbmount\fR will prompt
for a passeword, unless the guest option is
given.
+
+Note that password which contain the arguement delimiter
+character (i.e. a comma ',') will failed to be parsed correctly
+on the command line. However, the same password defined
+in the PASSWD environment variable or a credentials file (see
+below) will be read correctly.
.TP
\fBcredentials=<filename>\fR
specifies a file that contains a username
@@ -62,7 +69,7 @@ and/or password. The format of the file is:
.fi
This is preferred over having passwords in plaintext in a
-shared file, such as /etc/fstab. Be sure to protect any
+shared file, such as \fI/etc/fstab\fR. Be sure to protect any
credentials file properly.
.TP
\fBnetbiosname=<arg>\fR
@@ -90,13 +97,15 @@ permissions that remote files have in the local filesystem.
The default is based on the current umask.
.TP
\fBdmask=<arg>\fR
-sets the directory mask. This deterines the
+sets the directory mask. This determines the
permissions that remote directories have in the local filesystem.
The default is based on the current umask.
.TP
\fBdebug=<arg>\fR
sets the debug level. This is useful for
-tracking down SMB connection problems.
+tracking down SMB connection problems. A suggested value to
+start with is 4. If set too high there will be a lot of
+output, possibly hiding the useful output.
.TP
\fBip=<arg>\fR
sets the destination host or IP address.
@@ -121,7 +130,7 @@ mount read-only
mount read-write
.TP
\fBiocharset=<arg>\fR
-sets the charset used by the linux side for codepage
+sets the charset used by the Linux side for codepage
to charset translations (NLS). Argument should be the
name of a charset, like iso8859-1. (Note: only kernel
2.4.0 or later)
@@ -154,30 +163,44 @@ person using the client. This information is used only if the
protocol level is high enough to support session-level
passwords.
.PP
-The variable \fBPASSWD_FILE\fR may contain the pathname of
-a file to read the password from. A single line of input is
-read and used as password.
+The variable \fBPASSWD_FILE\fR may contain the pathname
+of a file to read the password from. A single line of input is
+read and used as the password.
.SH "BUGS"
.PP
-Not many known smbmount bugs. But one smbfs bug is
-important enough to mention here anyway:
+Passwords and other options containing , can not be handled.
+For passwords an alternative way of passing them is in a credentials
+file or in the PASSWD environment.
+.PP
+The credentials file does not handle usernames or passwords with
+leading space.
+.PP
+One smbfs bug is important enough to mention here, even if it
+is a bit misplaced:
.TP 0.2i
\(bu
Mounts sometimes stop working. This is usually
caused by smbmount terminating. Since smbfs needs smbmount to
-reconnect when the server disconnects, the mount will go
-dead. A re-mount normally fixes this. At least 2 ways to
+reconnect when the server disconnects, the mount will eventually go
+dead. An umount/mount normally fixes this. At least 2 ways to
trigger this bug are known.
.PP
-Note that the typical response to a bugreport is suggestion
+Note that the typical response to a bug report is suggestion
to try the latest version first. So please try doing that first,
and always include which versions you use of relevant software
when reporting bugs (minimum: samba, kernel, distribution)
.PP
.SH "SEE ALSO"
.PP
-Documentation/filesystems/smbfs.txt in the kernel source tree
-may contain additional options and information.
+Documentation/filesystems/smbfs.txt in the linux kernel
+source tree may contain additional options and information.
+.PP
+FreeBSD also has a smbfs, but it is not related to smbmount
+.PP
+For Solaris, HP-UX and others you may want to look at
+\fBsmbsh(1)\fRor at other
+solutions, such as sharity or perhaps replacing the SMB server with
+a NFS server.
.SH "AUTHOR"
.PP
Volker Lendecke, Andrew Tridgell, Michael H. Warfield