docs/manpages/smbmount.8

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "SMBMOUNT" 8 "" "" ""
  21 .SH NAME
  22 smbmount \- mount an smbfs filesystem
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 \fBsmbmount\fR {service} {mount-point} [-o options]
  27 .fi
  28
  29 .SH "DESCRIPTION"
  30
  31 .PP
  32 \fBsmbmount\fR mounts a Linux SMB filesystem\&. It is usually invoked as \fBmount.smbfs\fR by the \fBmount\fR(8) command when using the "-t smbfs" option\&. This command only works in Linux, and the kernel must support the smbfs filesystem\&.
  33
  34 .PP
  35 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\&.
  36
  37 .PP
  38 \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 \fIlog\&.smbmount\fR\&. The \fB smbmount\fR process may also be called mount\&.smbfs\&.
  39
  40 .RS
  41 .Sh "Note"
  42
  43 .PP
  44  \fBsmbmount\fR calls \fBsmbmnt\fR(8) to do the actual mount\&. You must make sure that \fBsmbmnt\fR is in the path so that it can be found\&.
  45
  46 .RE
  47
  48 .SH "OPTIONS"
  49
  50 .TP
  51 username=<arg>
  52 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\&.
  53
  54
  55 .TP
  56 password=<arg>
  57 specifies the SMB password\&. If this option is not given then the environment variable \fBPASSWD\fR is used\&. If it can find no password \fBsmbmount\fR will prompt for a passeword, unless the guest option is given\&.
  58
  59
  60 Note that passwords which contain the argument 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\&.
  61
  62
  63 .TP
  64 credentials=<filename>
  65 specifies a file that contains a username and/or password\&.
  66 The format of the file is:
  67 .nf
  68
  69 username = <value>
  70 password = <value>
  71 .fi
  72
  73
  74 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\&.
  75
  76
  77 .TP
  78 krb
  79 Use kerberos (Active Directory)\&.
  80
  81
  82 .TP
  83 netbiosname=<arg>
  84 sets the source NetBIOS name\&. It defaults to the local hostname\&.
  85
  86
  87 .TP
  88 uid=<arg>
  89 sets the uid that will own all files on the mounted filesystem\&. It may be specified as either a username or a numeric uid\&.
  90
  91
  92 .TP
  93 gid=<arg>
  94 sets the gid that will own all files on the mounted filesystem\&. It may be specified as either a groupname or a numeric gid\&.
  95
  96
  97 .TP
  98 port=<arg>
  99 sets the remote SMB port number\&. The default is 139\&.
 100
 101
 102 .TP
 103 fmask=<arg>
 104 sets the file mask\&. This determines the permissions that remote files have in the local filesystem\&. This is not a umask, but the actual permissions for the files\&. The default is based on the current umask\&.
 105
 106
 107 .TP
 108 dmask=<arg>
 109 Sets the directory mask\&. This determines the permissions that remote directories have in the local filesystem\&. This is not a umask, but the actual permissions for the directories\&. The default is based on the current umask\&.
 110
 111
 112 .TP
 113 debug=<arg>
 114 Sets the debug level\&. This is useful for 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\&.
 115
 116
 117 .TP
 118 ip=<arg>
 119 Sets the destination host or IP address\&.
 120
 121
 122 .TP
 123 workgroup=<arg>
 124 Sets the workgroup on the destination
 125
 126
 127 .TP
 128 sockopt=<arg>
 129 Sets the TCP socket options\&. See the \fBsmb.conf\fR(5) \fIsocket options\fR option\&.
 130
 131
 132 .TP
 133 scope=<arg>
 134 Sets the NetBIOS scope
 135
 136
 137 .TP
 138 guest
 139 Don't prompt for a password
 140
 141
 142 .TP
 143 ro
 144 mount read-only
 145
 146
 147 .TP
 148 rw
 149 mount read-write
 150
 151
 152 .TP
 153 iocharset=<arg>
 154 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)
 155
 156
 157 .TP
 158 codepage=<arg>
 159 sets the codepage the server uses\&. See the iocharset option\&. Example value cp850\&. (Note: only kernel 2\&.4\&.0 or later)
 160
 161
 162 .TP
 163 ttl=<arg>
 164 sets how long a directory listing is cached in milliseconds (also affects visibility of file size and date changes)\&. A higher value means that changes on the server take longer to be noticed but it can give better performance on large directories, especially over long distances\&. Default is 1000ms but something like 10000ms (10 seconds) is probably more reasonable in many cases\&. (Note: only kernel 2\&.4\&.2 or later)
 165
 166
 167 .SH "ENVIRONMENT VARIABLES"
 168
 169 .PP
 170 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\&.
 171
 172 .PP
 173 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\&.
 174
 175 .PP
 176 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\&.
 177
 178 .SH "BUGS"
 179
 180 .PP
 181 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\&.
 182
 183 .PP
 184 The credentials file does not handle usernames or passwords with leading space\&.
 185
 186 .PP
 187 One smbfs bug is important enough to mention here, even if it is a bit misplaced:
 188
 189 .TP 3
 190 \(bu
 191 Mounts sometimes stop working\&. This is usually caused by smbmount terminating\&. Since smbfs needs smbmount 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\&.
 192
 193 .LP
 194
 195 .PP
 196 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)
 197
 198 .SH "SEE ALSO"
 199
 200 .PP
 201 Documentation/filesystems/smbfs\&.txt in the linux kernel source tree may contain additional options and information\&.
 202
 203 .PP
 204 FreeBSD also has a smbfs, but it is not related to smbmount
 205
 206 .PP
 207 For Solaris, HP-UX and others you may want to look at \fBsmbsh\fR(1) or at other solutions, such as Sharity or perhaps replacing the SMB server with a NFS server\&.
 208
 209 .SH "AUTHOR"
 210
 211 .PP
 212 Volker Lendecke, Andrew Tridgell, Michael H\&. Warfield and others\&.
 213
 214 .PP
 215 The current maintainer of smbfs and the userspace tools \fBsmbmount\fR, \fBsmbumount\fR, and \fBsmbmnt\fR is Urban Widmark\&. The SAMBA Mailing list is the preferred place to ask questions regarding these programs\&.
 216
 217 .PP
 218 The conversion of this manpage for Samba 2\&.2 was performed by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
 219