git.maemo.org Git - samba/blob - 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 .ad l
  25 .hy 0
  26 .HP 9
  27 \fBsmbmount\fR {service} {mount\-point} [\-o\ options]
  28 .ad
  29 .hy
  30
  31 .SH "DESCRIPTION"
  32
  33 .PP
  34 \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\&.
  35
  36 .PP
  37 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\&.
  38
  39 .PP
  40 \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\&.
  41
  42 .RS
  43 .Sh "Note"
  44
  45 .PP
  46  \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\&.
  47
  48 .RE
  49
  50 .SH "OPTIONS"
  51
  52 .TP
  53 username=<arg>
  54 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\&.
  55
  56 .TP
  57 password=<arg>
  58 specifies the SMB password\&. If this option is not given then the environment variable PASSWD is used\&. If it can find no password\fBsmbmount\fR will prompt for a passeword, unless the guest option is given\&.
  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 .TP
  63 credentials=<filename>
  64 specifies a file that contains a username and/or password\&. The format of the file is:
  65 .nf
  66
  67 username = <value>
  68 password = <value>
  69 .fi
  70
  71
  72 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\&.
  73
  74 .TP
  75 krb
  76 Use kerberos (Active Directory)\&.
  77
  78 .TP
  79 netbiosname=<arg>
  80 sets the source NetBIOS name\&. It defaults to the local hostname\&.
  81
  82 .TP
  83 uid=<arg>
  84 sets the uid that will own all files on the mounted filesystem\&. It may be specified as either a username or a numeric uid\&.
  85
  86 .TP
  87 gid=<arg>
  88 sets the gid that will own all files on the mounted filesystem\&. It may be specified as either a groupname or a numeric gid\&.
  89
  90 .TP
  91 port=<arg>
  92 sets the remote SMB port number\&. The default is 445, fallback is 139\&.
  93
  94 .TP
  95 fmask=<arg>
  96 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\&.
  97
  98 .TP
  99 dmask=<arg>
 100 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\&.
 101
 102 .TP
 103 debug=<arg>
 104 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\&.
 105
 106 .TP
 107 ip=<arg>
 108 Sets the destination host or IP address\&.
 109
 110 .TP
 111 workgroup=<arg>
 112 Sets the workgroup on the destination
 113
 114 .TP
 115 sockopt=<arg>
 116 Sets the TCP socket options\&. See the \fBsmb\&.conf\fR(5)  \fIsocket options\fR option\&.
 117
 118 .TP
 119 scope=<arg>
 120 Sets the NetBIOS scope
 121
 122 .TP
 123 guest
 124 Don't prompt for a password
 125
 126 .TP
 127 ro
 128 mount read\-only
 129
 130 .TP
 131 rw
 132 mount read\-write
 133
 134 .TP
 135 iocharset=<arg>
 136 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)
 137
 138 .TP
 139 codepage=<arg>
 140 sets the codepage the server uses\&. See the iocharset option\&. Example value cp850\&. (Note: only kernel 2\&.4\&.0 or later)
 141
 142 .TP
 143 ttl=<arg>
 144 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)
 145
 146 .SH "ENVIRONMENT VARIABLES"
 147
 148 .PP
 149 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\&.
 150
 151 .PP
 152 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\&.
 153
 154 .PP
 155 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\&.
 156
 157 .SH "OTHER COMMANDS"
 158
 159 .PP
 160 File systems that have been mounted using the \fBsmbmount\fR can be unmounted using the \fBsmbumount\fR or the UNIX system\fBumount\fR command\&.
 161
 162 .SH "BUGS"
 163
 164 .PP
 165 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\&.
 166
 167 .PP
 168 The credentials file does not handle usernames or passwords with leading space\&.
 169
 170 .PP
 171 One smbfs bug is important enough to mention here, even if it is a bit misplaced:
 172
 173 .TP 3
 174 \(bu
 175 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\&.
 176 .LP
 177
 178 .PP
 179 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)
 180
 181 .SH "SEE ALSO"
 182
 183 .PP
 184 Documentation/filesystems/smbfs\&.txt in the linux kernel source tree may contain additional options and information\&.
 185
 186 .PP
 187 FreeBSD also has a smbfs, but it is not related to smbmount
 188
 189 .PP
 190 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\&.
 191
 192 .SH "AUTHOR"
 193
 194 .PP
 195 Volker Lendecke, Andrew Tridgell, Michael H\&. Warfield and others\&.
 196
 197 .PP
 198 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\&.
 199
 200 .PP
 201 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\&.
 202