import HEAD into svn+ssh://svn.samba.org/home/svn/samba/trunk
[metze/old/v3-2-winbind-ndr.git] / packaging / Mandrake / mount.cifs.8
1 .\" This manpage has been automatically generated by docbook2man 
2 .\" from a DocBook document.  This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "MOUNT.CIFS" "8" "03 August 2002" "" ""
7 .SH NAME
8 mount.cifs \- mount using the Common Internet File System (CIFS)
9 .SH SYNOPSIS
10
11 \fBmount.cifs\fR \fBservice\fR \fBmount-point\fR [ \fB-o options\fR] 
12
13 .SH "DESCRIPTION"
14 .PP
15 \fBmount.cifs\fR mounts a Linux CIFS filesystem. It 
16 is usually invoked as \fBmount.cifs\fR by
17 the \fBmount(8)\fR command when using the 
18 "-t cifs" option. This command only works in Linux, and the kernel must
19 support the cifs filesystem. The CIFS protocol is the successor to the 
20 SMB protocol and is supported by most Windows servers and many other
21 commercial servers and Network Attached Storage appliances as well as 
22 by the popular Open Source server Samba.
23 .PP
24 Options to \fBmount.cifs\fR are specified as a comma-separated
25 list of key=value pairs. It is possible to send options other
26 than those listed here, assuming that cifs supports them. If
27 you get mount failures, check your kernel log for errors on
28 unknown options.
29 .PP
30 \fBmount.cifs\fR is a daemon. After mounting it keeps running until
31 the mounted cifs is umounted. It will log things that happen
32 when in daemon mode using the "machine name" mount.cifs, so
33 typically this output will end up in 
34 \fIlog.mount.cifs\fR.
35 .SH "OPTIONS"
36 .TP
37 \fBusername=<arg>\fR
38 specifies the username to connect as. If
39 this is not given, then the environment variable \fB  USER\fR is used. This option can also take the
40 form "user%password" or "user/workgroup" or
41 "user/workgroup%password" to allow the password and workgroup
42 to be specified as part of the username.
43 .TP
44 \fBpassword=<arg>\fR
45 specifies the CIFS password. If this
46 option is not given then the environment variable
47 \fBPASSWD\fR is used. If it can find
48 no password \fBmount.cifs\fR will prompt
49 for a passeword, unless the guest option is
50 given. 
51
52 Note that password which contain the arguement delimiter
53 character (i.e. a comma ',') will failed to be parsed correctly
54 on the command line.  However, the same password defined
55 in the PASSWD environment variable or a credentials file (see
56 below) will be read correctly.
57 .TP
58 \fBcredentials=<filename>\fR
59 specifies a file that contains a username
60 and/or password. The format of the file is:
61
62
63 .nf
64                 username = <value>
65                 password = <value>
66                 
67 .fi
68
69 This is preferred over having passwords in plaintext in a
70 shared file, such as \fI/etc/fstab\fR. Be sure to protect any
71 credentials file properly.
72 .TP
73 \fBuid=<arg>\fR
74 sets the uid that will own all files on
75 the mounted filesystem.
76 It may be specified as either a username or a numeric uid.
77 .TP
78 \fBgid=<arg>\fR
79 sets the gid that will own all files on
80 the mounted filesystem.
81 It may be specified as either a groupname or a numeric 
82 gid. 
83 .TP
84 \fBport=<arg>\fR
85 sets the remote cifs port number. By default 
86 port 445 is tried then if no response port 139 is tried.
87 .TP
88 \fBfmask=<arg>\fR
89 sets the file mask. This determines the 
90 permissions that remote files have in the local filesystem. 
91 The default is based on the current umask. 
92 .TP
93 \fBdmask=<arg>\fR
94 sets the directory mask. This determines the 
95 permissions that remote directories have in the local filesystem. 
96 The default is based on the current umask. 
97 .TP
98 \fBdebug=<arg>\fR
99 sets the debug level. This is useful for 
100 tracking down cifs connection problems. A suggested value to
101 start with is 4. If set too high there will be a lot of
102 output, possibly hiding the useful output.
103 .TP
104 \fBip=<arg>\fR
105 sets the destination host or IP address.
106 .TP
107 \fBdomain=<arg>\fR
108 sets the domain (workgroup) of the user 
109 .TP
110 \fBguest\fR
111 don't prompt for a password 
112 .TP
113 \fBro\fR
114 mount read-only 
115 .TP
116 \fBrw\fR
117 mount read-write 
118 .TP
119 \fBiocharset=<arg>\fR
120 sets the charset used by the Linux side for codepage
121 to charset translations (NLS). Argument should be the
122 name of a charset, like iso8859-1. (Note: only kernel
123 2.4.0 or later)
124 .TP
125 \fBcodepage=<arg>\fR
126 sets the codepage the server uses. See the iocharset
127 option. Example value cp850. (Note: only kernel 2.4.0
128 or later)
129 .TP
130 \fBttl=<arg>\fR
131 how long a directory listing is cached in milliseconds
132 (also affects visibility of file size and date
133 changes). A higher value means that changes on the
134 server take longer to be noticed but it can give
135 better performance on large directories, especially
136 over long distances. Default is 1000ms but something
137 like 10000ms (10 seconds) is probably more reasonable
138 in many cases.
139 (Note: only kernel 2.4.2 or later)
140 .SH "ENVIRONMENT VARIABLES"
141 .PP
142 The variable \fBUSER\fR may contain the username of the
143 person using the client.  This information is used only if the
144 protocol level is high enough to support session-level
145 passwords. The variable can be used to set both username and
146 password by using the format username%password.
147 .PP
148 The variable \fBPASSWD\fR may contain the password of the
149 person using the client.  This information is used only if the
150 protocol level is high enough to support session-level
151 passwords.
152 .PP
153 The variable \fBPASSWD_FILE\fR may contain the pathname
154 of a file to read the password from. A single line of input is
155 read and used as the password.
156 .SH "BUGS"
157 .PP
158 Passwords and other options containing , can not be handled.
159 For passwords an alternative way of passing them is in a credentials
160 file or in the PASSWD environment.
161 .PP
162 The credentials file does not handle usernames or passwords with
163 leading space.
164 .PP
165 Note that the typical response to a bug report is suggestion
166 to try the latest version first. So please try doing that first,
167 and always include which versions you use of relevant software
168 when reporting bugs (minimum: samba, kernel, distribution)
169 .SH "SEE ALSO"
170 .PP
171 Documentation/filesystems/cifs.txt in the linux kernel
172 source tree may contain additional options and information.
173 .SH "AUTHOR"
174 .PP
175 Steve French   
176 The syntax and manpage were loosely based on that of smbmount.
177 .PP
178 The current maintainer of the Linux cifs vfs and the userspace
179 tool \fBmount.cifs\fR is Steve French <URL:mailto:sfrench@samba.org>.
180 The SAMBA Mailing list <URL:mailto:samba@samba.org>
181 is the preferred place to ask questions regarding these programs.