mirror of
https://github.com/samba-team/samba.git
synced 2025-01-26 10:04:02 +03:00
Commit some old stuff from my laptop; put in Docbook/XML version of mount.cifs manpage
(This used to be commit c442e52488c342ba20bda0ed821d607bdbec1ddb)
This commit is contained in:
Jelmer Vernooij
parent
17cad4ad25
commit
7e6ad82e54
@ -21,7 +21,8 @@ MANPAGES_NAMES=findsmb.1 smbclient.1 \
|
||||
smbcacls.1 smbsh.1 winbindd.8 \
|
||||
tdbbackup.8 vfstest.1 \
|
||||
profiles.1 smbtree.1 ntlm_auth.1 \
|
||||
editreg.1 smbcquotas.1 log2pcap.1
|
||||
editreg.1 smbcquotas.1 log2pcap.1 \
|
||||
mount.cifs.8
|
||||
|
||||
## This part contains only rules. You shouldn't need to change it
|
||||
## if you are adding docs
|
||||
|
||||
302
docs/docbook/manpages/mount.cifs.8.xml
Normal file
302
docs/docbook/manpages/mount.cifs.8.xml
Normal file
@ -0,0 +1,302 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
|
||||
|
||||
<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
|
||||
]>
|
||||
<refentry id="mount.cifs.8">
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>mount.cifs</refentrytitle>
|
||||
<manvolnum>8</manvolnum>
|
||||
</refmeta>
|
||||
|
||||
|
||||
<refnamediv>
|
||||
<refname>mount.cifs</refname>
|
||||
<refpurpose>mount using the Common Internet File System (CIFS)</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
|
||||
<command>mount.cifs</command>
|
||||
<arg choice="req">service</arg>
|
||||
<arg choice="req">mount-point</arg>
|
||||
<arg choice="opt">-o options</arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
|
||||
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
|
||||
<manvolnum>7</manvolnum></citerefentry> suite.</para>
|
||||
|
||||
<para>mount.cifs mounts a Linux CIFS filesystem. It
|
||||
is usually invoked indirectly by
|
||||
the <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> 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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The mount.cifs utility attaches the UNC name (exported network resource) to
|
||||
the local directory <emphasis>mount-point</emphasis>. 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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Options to <emphasis>mount.cifs</emphasis> 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.
|
||||
</para>
|
||||
|
||||
<para><emphasis>mount.cifs</emphasis> is a daemon. After mounting it keeps running until
|
||||
the mounted resource is unmounted (usually via the umount utility)
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>OPTIONS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term>username=<replaceable>arg</replaceable></term>
|
||||
|
||||
<listitem><para>specifies the username to connect as. If
|
||||
this is not given, then the environment variable <emphasis>USER</emphasis> 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.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry><term>password=<replaceable>arg</replaceable></term>
|
||||
|
||||
<listitem><para>specifies the CIFS password. If this
|
||||
option is not given then the environment variable
|
||||
<emphasis>PASSWD</emphasis> is used. If it can find
|
||||
no password <emphasis>mount.cifs</emphasis> will prompt
|
||||
for a passeword, unless the guest option is
|
||||
given.
|
||||
</para>
|
||||
|
||||
<para>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.
|
||||
</para>
|
||||
</listitem></varlistentry>
|
||||
|
||||
<varlistentry><term>credentials=<replaceable>filename</replaceable></term>
|
||||
|
||||
<listitem><para>
|
||||
specifies a file that contains a username
|
||||
and/or password. The format of the file is:
|
||||
</para>
|
||||
|
||||
<programlisting>
|
||||
.nf
|
||||
username = <replaceable>value</replaceable>
|
||||
password = <replaceable>value</replaceable>
|
||||
.fi
|
||||
</programlisting>
|
||||
|
||||
<para>
|
||||
This is preferred over having passwords in plaintext in a
|
||||
shared file, such as <filename>/etc/fstab</filename>. Be sure to protect any
|
||||
credentials file properly.
|
||||
</para>
|
||||
</listitem></varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>uid=<replaceable>arg</replaceable></term>
|
||||
|
||||
<listitem><para>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.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>gid=<replaceable>arg</replaceable></term>
|
||||
|
||||
<listitem><para>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.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>port=<replaceable>arg</replaceable></term>
|
||||
|
||||
<listitem><para>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.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>file_mode=<replaceable>arg</replaceable></term>
|
||||
|
||||
<listitem><para>If the server does not support the CIFS Unix extensions this
|
||||
overrides default file mode which will be used locally.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>dir_mode=<replaceable>arg</replaceable></term>
|
||||
|
||||
<listitem><para>If the server does not support the CIFS Unix extensions this
|
||||
overrides the default mode for directories. </para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>ip=<replaceable>arg</replaceable></term>
|
||||
|
||||
<listitem><para>sets the destination host or IP address.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>domain=<replaceable>arg</replaceable></term>
|
||||
|
||||
<listitem><para>sets the domain (workgroup) of the user </para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>guest</term>
|
||||
|
||||
<listitem><para>don't prompt for a password </para></listitem>
|
||||
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>ro</term>
|
||||
|
||||
<listitem><para>mount read-only</para></listitem>
|
||||
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>rw</term>
|
||||
<listitem><para>mount read-write</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>rsize</term>
|
||||
<listitem><para>default network read size</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>wsize</term>
|
||||
|
||||
<listitem><para>default network write size</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>ENVIRONMENT VARIABLES</title>
|
||||
|
||||
<para>
|
||||
The variable <emphasis>USER</emphasis> 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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The variable <emphasis>PASSWD</emphasis> 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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The variable <emphasis>PASSWD_FILE</emphasis> may contain the pathname
|
||||
of a file to read the password from. A single line of input is
|
||||
read and used as the password.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>NOTES</title>
|
||||
|
||||
<para>This command may be used only by root.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>CONFIGURATION</title>
|
||||
<para>
|
||||
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
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>BUGS</title>
|
||||
|
||||
<para>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.</para>
|
||||
|
||||
<para>The credentials file does not handle usernames or passwords with
|
||||
leading space.</para>
|
||||
|
||||
<para>
|
||||
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)
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>VERSION</title>
|
||||
|
||||
<para>This man page is correct for version 3.0 of
|
||||
the Samba suite.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>
|
||||
Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel
|
||||
source tree may contain additional options and information.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>AUTHOR</title>
|
||||
|
||||
<para>Steve French</para>
|
||||
|
||||
<para>The syntax and manpage were loosely based on that of smbmount. It
|
||||
was converted to Docbook/XML by Jelmer Vernooij.</para>
|
||||
|
||||
<para>The current maintainer of the Linux cifs vfs and the userspace
|
||||
tool <emphasis>mount.cifs</emphasis> is <ulink url="mailto:sfrench@samba.org">Steve French</ulink>.
|
||||
The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink>
|
||||
is the preferred place to ask questions regarding these programs.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
Loading…
x
Reference in New Issue
Block a user