docs/manpages/smbmount.8

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