From 7e6ad82e549b472a070a55c078450711c04c6da9 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Thu, 28 Aug 2003 22:00:41 +0000 Subject: Commit some old stuff from my laptop; put in Docbook/XML version of mount.cifs manpage (This used to be commit c442e52488c342ba20bda0ed821d607bdbec1ddb) --- docs/docbook/Makefile.in | 3 +- docs/docbook/manpages/mount.cifs.8.xml | 302 +++++++++++++++++++++++++++++++++ 2 files changed, 304 insertions(+), 1 deletion(-) create mode 100644 docs/docbook/manpages/mount.cifs.8.xml diff --git a/docs/docbook/Makefile.in b/docs/docbook/Makefile.in index 14f9a7dfcb..7169cc90c4 100644 --- a/docs/docbook/Makefile.in +++ b/docs/docbook/Makefile.in @@ -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 diff --git a/docs/docbook/manpages/mount.cifs.8.xml b/docs/docbook/manpages/mount.cifs.8.xml new file mode 100644 index 0000000000..99bd6b23d5 --- /dev/null +++ b/docs/docbook/manpages/mount.cifs.8.xml @@ -0,0 +1,302 @@ + + %globalentities; +]> + + + + mount.cifs + 8 + + + + + mount.cifs + mount using the Common Internet File System (CIFS) + + + + + + mount.cifs + service + mount-point + -o options + + + + + DESCRIPTION + + This tool is part of the Samba + 7 suite. + + mount.cifs mounts a Linux CIFS filesystem. It +is usually invoked indirectly by +the mount8 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. + + + + The mount.cifs utility attaches the UNC name (exported network resource) to + the local directory mount-point. 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. + + + + Options to mount.cifs 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. + + + mount.cifs is a daemon. After mounting it keeps running until + the mounted resource is unmounted (usually via the umount utility) + + + + + + OPTIONS + + username=arg + + 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. + + + + password=arg + + specifies the CIFS password. If this +option is not given then the environment variable +PASSWD is used. If it can find +no password mount.cifs 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. + + + + credentials=filename + + + 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 /etc/fstab. Be sure to protect any +credentials file properly. + + + + + uid=arg + + 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. + + + + gid=arg + + 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. + + + + + port=arg + + 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. + + + + + file_mode=arg + + If the server does not support the CIFS Unix extensions this + overrides default file mode which will be used locally. + + + + dir_mode=arg + + If the server does not support the CIFS Unix extensions this + overrides the default mode for directories. + + + + ip=arg + + sets the destination host or IP address. + + + + domain=arg + + sets the domain (workgroup) of the user + + + + guest + + don't prompt for a password + + + + + ro + + mount read-only + + + + + rw + mount read-write + + + + rsize + default network read size + + + + wsize + + default network write size + + + + + + + ENVIRONMENT VARIABLES + + + The variable USER 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. + + + + The variable PASSWD 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. + + + + The variable PASSWD_FILE may contain the pathname +of a file to read the password from. A single line of input is +read and used as the password. + + + + + + NOTES + + This command may be used only by root. + + + + 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 + + + + + BUGS + + 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. + + The credentials file does not handle usernames or passwords with + leading space. + + +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) + + + + + + + VERSION + + This man page is correct for version 3.0 of + the Samba suite. + + + + SEE ALSO + + Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel + source tree may contain additional options and information. + + + + + AUTHOR + + Steve French + + The syntax and manpage were loosely based on that of smbmount. It + was converted to Docbook/XML by Jelmer Vernooij. + + The current maintainer of the Linux cifs vfs and the userspace + tool mount.cifs is Steve French. + The SAMBA Mailing list + is the preferred place to ask questions regarding these programs. + + + + + -- cgit