docs/manpages/smbmount.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 "SMBMOUNT" "8" "04 March 2003" "" ""
   7 .SH NAME
   8 smbmount \- mount an smbfs filesystem
   9 .SH SYNOPSIS
  10
  11 \fBsmbmount\fR \fBservice\fR \fBmount-point\fR [ \fB-o options\fR ]
  12
  13 .SH "DESCRIPTION"
  14 .PP
  15 \fBsmbmount\fR mounts a Linux SMB filesystem. It
  16 is usually invoked as \fBmount.smbfs\fR by
  17 the \fBmount(8)\fR command when using the
  18 "-t smbfs" option. This command only works in Linux, and the kernel must
  19 support the smbfs filesystem.
  20 .PP
  21 Options to \fBsmbmount\fR are specified as a comma-separated
  22 list of key=value pairs. It is possible to send options other
  23 than those listed here, assuming that smbfs supports them. If
  24 you get mount failures, check your kernel log for errors on
  25 unknown options.
  26 .PP
  27 \fBsmbmount\fR is a daemon. After mounting it keeps running until
  28 the mounted smbfs is umounted. It will log things that happen
  29 when in daemon mode using the "machine name" smbmount, so
  30 typically this output will end up in \fIlog.smbmount\fR. The
  31 \fBsmbmount\fR process may also be called mount.smbfs.
  32 .PP
  33 \fBNOTE:\fR \fBsmbmount\fR
  34 calls \fBsmbmnt(8)\fR to do the actual mount. You
  35 must make sure that \fBsmbmnt\fR is in the path so
  36 that it can be found.
  37 .SH "OPTIONS"
  38 .TP
  39 \fBusername=<arg>\fR
  40 specifies the username to connect as. If
  41 this is not given, then the environment variable \fB  USER\fR is used. This option can also take the
  42 form "user%password" or "user/workgroup" or
  43 "user/workgroup%password" to allow the password and workgroup
  44 to be specified as part of the username.
  45 .TP
  46 \fBpassword=<arg>\fR
  47 specifies the SMB password. If this
  48 option is not given then the environment variable
  49 \fBPASSWD\fR is used. If it can find
  50 no password \fBsmbmount\fR will prompt
  51 for a passeword, unless the guest option is
  52 given.
  53
  54 Note that passwords which contain the argument delimiter
  55 character (i.e. a comma ',') will failed to be parsed correctly
  56 on the command line.  However, the same password defined
  57 in the PASSWD environment variable or a credentials file (see
  58 below) will be read correctly.
  59 .TP
  60 \fBcredentials=<filename>\fR
  61 specifies a file that contains a username
  62 and/or password. The format of the file is:
  63
  64
  65 .nf
  66                 username = <value>
  67                 password = <value>
  68
  69 .fi
  70
  71 This is preferred over having passwords in plaintext in a
  72 shared file, such as \fI/etc/fstab\fR. Be sure to protect any
  73 credentials file properly.
  74 .TP
  75 \fBnetbiosname=<arg>\fR
  76 sets the source NetBIOS name. It defaults
  77 to the local hostname.
  78 .TP
  79 \fBuid=<arg>\fR
  80 sets the uid that will own all files on
  81 the mounted filesystem.
  82 It may be specified as either a username or a numeric uid.
  83 .TP
  84 \fBgid=<arg>\fR
  85 sets the gid that will own all files on
  86 the mounted filesystem.
  87 It may be specified as either a groupname or a numeric
  88 gid.
  89 .TP
  90 \fBport=<arg>\fR
  91 sets the remote SMB port number. The default
  92 is 139.
  93 .TP
  94 \fBfmask=<arg>\fR
  95 sets the file mask. This determines the
  96 permissions that remote files have in the local filesystem.
  97 The default is based on the current umask.
  98 .TP
  99 \fBdmask=<arg>\fR
 100 sets the directory mask. This determines the
 101 permissions that remote directories have in the local filesystem.
 102 The default is based on the current umask.
 103 .TP
 104 \fBdebug=<arg>\fR
 105 sets the debug level. This is useful for
 106 tracking down SMB connection problems. A suggested value to
 107 start with is 4. If set too high there will be a lot of
 108 output, possibly hiding the useful output.
 109 .TP
 110 \fBip=<arg>\fR
 111 sets the destination host or IP address.
 112 .TP
 113 \fBworkgroup=<arg>\fR
 114 sets the workgroup on the destination
 115 .TP
 116 \fBsockopt=<arg>\fR
 117 sets the TCP socket options. See the \fIsmb.conf
 118 \fR \fIsocket options\fR option.
 119 .TP
 120 \fBscope=<arg>\fR
 121 sets the NetBIOS scope
 122 .TP
 123 \fBguest\fR
 124 don't prompt for a password
 125 .TP
 126 \fBro\fR
 127 mount read-only
 128 .TP
 129 \fBrw\fR
 130 mount read-write
 131 .TP
 132 \fBiocharset=<arg>\fR
 133 sets the charset used by the Linux side for codepage
 134 to charset translations (NLS). Argument should be the
 135 name of a charset, like iso8859-1. (Note: only kernel
 136 2.4.0 or later)
 137 .TP
 138 \fBcodepage=<arg>\fR
 139 sets the codepage the server uses. See the iocharset
 140 option. Example value cp850. (Note: only kernel 2.4.0
 141 or later)
 142 .TP
 143 \fBttl=<arg>\fR
 144 sets how long a directory listing is cached in milliseconds
 145 (also affects visibility of file size and date
 146 changes). A higher value means that changes on the
 147 server take longer to be noticed but it can give
 148 better performance on large directories, especially
 149 over long distances. Default is 1000ms but something
 150 like 10000ms (10 seconds) is probably more reasonable
 151 in many cases.
 152 (Note: only kernel 2.4.2 or later)
 153 .SH "ENVIRONMENT VARIABLES"
 154 .PP
 155 The variable \fBUSER\fR may contain the username of the
 156 person using the client.  This information is used only if the
 157 protocol level is high enough to support session-level
 158 passwords. The variable can be used to set both username and
 159 password by using the format username%password.
 160 .PP
 161 The variable \fBPASSWD\fR may contain the password of the
 162 person using the client.  This information is used only if the
 163 protocol level is high enough to support session-level
 164 passwords.
 165 .PP
 166 The variable \fBPASSWD_FILE\fR may contain the pathname
 167 of a file to read the password from. A single line of input is
 168 read and used as the password.
 169 .SH "BUGS"
 170 .PP
 171 Passwords and other options containing , can not be handled.
 172 For passwords an alternative way of passing them is in a credentials
 173 file or in the PASSWD environment.
 174 .PP
 175 The credentials file does not handle usernames or passwords with
 176 leading space.
 177 .PP
 178 One smbfs bug is important enough to mention here, even if it
 179 is a bit misplaced:
 180 .TP 0.2i
 181 \(bu
 182 Mounts sometimes stop working. This is usually
 183 caused by smbmount terminating. Since smbfs needs smbmount to
 184 reconnect when the server disconnects, the mount will eventually go
 185 dead. An umount/mount normally fixes this. At least 2 ways to
 186 trigger this bug are known.
 187 .PP
 188 Note that the typical response to a bug report is suggestion
 189 to try the latest version first. So please try doing that first,
 190 and always include which versions you use of relevant software
 191 when reporting bugs (minimum: samba, kernel, distribution)
 192 .SH "SEE ALSO"
 193 .PP
 194 Documentation/filesystems/smbfs.txt in the linux kernel
 195 source tree may contain additional options and information.
 196 .PP
 197 FreeBSD also has a smbfs, but it is not related to smbmount
 198 .PP
 199 For Solaris, HP-UX and others you may want to look at
 200 \fBsmbsh(1)\fR or at other
 201 solutions, such as sharity or perhaps replacing the SMB server with
 202 a NFS server.
 203 .SH "AUTHOR"
 204 .PP
 205 Volker Lendecke, Andrew Tridgell, Michael H. Warfield
 206 and others.
 207 .PP
 208 The current maintainer of smbfs and the userspace
 209 tools \fBsmbmount\fR, \fBsmbumount\fR,
 210 and \fBsmbmnt\fR is Urban Widmark <URL:mailto:urban@teststation.com>.
 211 The SAMBA Mailing list <URL:mailto:samba@samba.org>
 212 is the preferred place to ask questions regarding these programs.
 213 .PP
 214 The conversion of this manpage for Samba 2.2 was performed
 215 by Gerald Carter