mirror of
https://github.com/samba-team/samba.git
synced 2025-01-29 21:47:30 +03:00
Checkin cifs vfs manpage
This commit is contained in:
Steve French
-
parent
343d361d4c
commit
ada291956a
170
docs/manpages/mount.cifs.8
Normal file
170
docs/manpages/mount.cifs.8
Normal file
@ -0,0 +1,170 @@
|
||||
.\" This manpage has been automatically generated by docbook2man
|
||||
.\" from a DocBook document. This tool can be found at:
|
||||
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
|
||||
.\" Please send any bug reports, improvements, comments, patches,
|
||||
.\" etc. to Steve Cheng <steve@ggi-project.org>.
|
||||
.TH "MOUNT.CIFS" "8" "03 August 2002" "" ""
|
||||
.SH NAME
|
||||
mount.cifs \- mount using the Common Internet File System (CIFS)
|
||||
.SH SYNOPSIS
|
||||
|
||||
\fBmount.cifs\fR \fBservice\fR \fBmount-point\fR [ \fB-o options\fR]
|
||||
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
\fBmount.cifs\fR mounts a Linux CIFS filesystem. It
|
||||
is usually invoked indirectly by
|
||||
the \fBmount(8)\fR command when using the
|
||||
"-t cifs" option. This command only works in Linux, and the kernel must
|
||||
support the cifs filesystem. The CIFS protocol is the successor to the
|
||||
SMB protocol and is supported by most Windows servers and many other
|
||||
commercial servers and Network Attached Storage appliances as well as
|
||||
by the popular Open Source server Samba.
|
||||
.PP
|
||||
The mount.cifs utility attaches the UNC name (exported network resource) to
|
||||
the local directory \fBmount-point\fR. It is possible to set the mode for mount.cifs to
|
||||
setuid root to allow non-root users to mount shares to directories for which they
|
||||
have write permission.
|
||||
.PP
|
||||
Options to \fBmount.cifs\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 cifs supports them. If
|
||||
you get mount failures, check your kernel log for errors on
|
||||
unknown options.
|
||||
.PP
|
||||
\fBmount.cifs\fR is a daemon. After mounting it keeps running until
|
||||
the mounted resource is unmounted (usually via the umount utility)
|
||||
.SH "OPTIONS"
|
||||
\fBusername=<arg>\fR
|
||||
specifies the username to connect as. If
|
||||
this is not given, then the environment variable \fB USER\fR 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.
|
||||
.TP
|
||||
\fBpassword=<arg>\fR
|
||||
specifies the CIFS password. If this
|
||||
option is not given then the environment variable
|
||||
\fBPASSWD\fR is used. If it can find
|
||||
no password \fBmount.cifs\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
|
||||
and/or password. The format of the file is:
|
||||
|
||||
|
||||
.nf
|
||||
username = <value>
|
||||
password = <value>
|
||||
|
||||
.fi
|
||||
|
||||
This is preferred over having passwords in plaintext in a
|
||||
shared file, such as \fI/etc/fstab\fR. Be sure to protect any
|
||||
credentials file properly.
|
||||
.TP
|
||||
\fBuid=<arg>\fR
|
||||
sets the uid that will own all files on
|
||||
the mounted filesystem.
|
||||
It may be specified as either a username or a numeric uid.
|
||||
This parameter is ignored when the target server supports
|
||||
the CIFS Unix extensions.
|
||||
.TP
|
||||
\fBgid=<arg>\fR
|
||||
sets the gid that will own all files on
|
||||
the mounted filesystem.
|
||||
It may be specified as either a groupname or a numeric
|
||||
gid. This parameter is ignored when the target server supports
|
||||
the CIFS Unix extensions.
|
||||
.TP
|
||||
\fBport=<arg>\fR
|
||||
sets the port number on the server to attempt to contact to negotiate
|
||||
CIFS support. If the CIFS server is not listening on this port or
|
||||
if it is not specified, the default ports will be tried i.e.
|
||||
port 445 is tried and if no response then port 139 is tried.
|
||||
.TP
|
||||
\fBfile_mode=<arg>\fR
|
||||
If the server does not support the CIFS Unix extensions this
|
||||
overrides default file mode which will be used locally.
|
||||
.TP
|
||||
\fBdir_mode=<arg>\fR
|
||||
If the server does not support the CIFS Unix extensions this
|
||||
overrides the default mode for directories.
|
||||
.TP
|
||||
\fBip=<arg>\fR
|
||||
sets the destination host or IP address.
|
||||
.TP
|
||||
\fBdomain=<arg>\fR
|
||||
sets the domain (workgroup) of the user
|
||||
.TP
|
||||
\fBguest\fR
|
||||
don't prompt for a password
|
||||
.TP
|
||||
\fBro\fR
|
||||
mount read-only
|
||||
.TP
|
||||
\fBrw\fR
|
||||
mount read-write
|
||||
.TP
|
||||
\fBrsize\fR
|
||||
default network read size
|
||||
.TP
|
||||
\fBwsize\fR
|
||||
default network write size
|
||||
.SH "ENVIRONMENT VARIABLES"
|
||||
.PP
|
||||
The variable \fBUSER\fR may contain the username of the
|
||||
person using the client. This information is used only if the
|
||||
protocol level is high enough to support session-level
|
||||
passwords. The variable can be used to set both username and
|
||||
password by using the format username%password.
|
||||
.PP
|
||||
The variable \fBPASSWD\fR may contain the password of the
|
||||
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 the password.
|
||||
.SH "CONFIGURATION"
|
||||
The primary mechanism for making configuration changes and for reading
|
||||
debug information for the cifs vfs is via the Linux /proc filesystem.
|
||||
In the directory /proc/fs/cifs are various configuration files and
|
||||
pseudo files which can display debug information. For more
|
||||
information see the kernel file fs/cifs/README
|
||||
.SH "BUGS"
|
||||
.PP
|
||||
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
|
||||
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)
|
||||
.SH "SEE ALSO"
|
||||
.PP
|
||||
Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel
|
||||
source tree may contain additional options and information.
|
||||
.SH "AUTHOR"
|
||||
.PP
|
||||
Steve French
|
||||
.PP
|
||||
The syntax and manpage were loosely based on that of smbmount.
|
||||
.PP
|
||||
The current maintainer of the Linux cifs vfs and the userspace
|
||||
tool \fBmount.cifs\fR is Steve French <URL:mailto:sfrench@samba.org>.
|
||||
The SAMBA Mailing list <URL:mailto:samba@samba.org>
|
||||
is the preferred place to ask questions regarding these programs.
|
||||
Loading…
x
Reference in New Issue
Block a user