Ignore:
Timestamp:
May 23, 2008, 6:56:41 AM (17 years ago)
Author:
Paul Smedley
Message:

Update source to 3.0.29

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/samba-3.0/docs/manpages/smbmount.8

    r44 r134  
    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 "" "" ""
     1.\"     Title: smbmount
     2.\"    Author:
     3.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
     4.\"      Date: 05/21/2008
     5.\"    Manual:
     6.\"    Source:
     7.\"
     8.TH "SMBMOUNT" "8" "05/21/2008" "" ""
     9.\" disable hyphenation
     10.nh
     11.\" disable justification (adjust text to left margin only)
     12.ad l
    2113.SH "NAME"
    2214smbmount - mount an smbfs filesystem
    2315.SH "SYNOPSIS"
    2416.HP 1
    25 smbmount {service} {mount-point} [-o options]
     17smbmount {service} {mount\-point} [\-o\ options]
    2618.SH "DESCRIPTION"
    2719.PP
    2820smbmount
    29 mounts a Linux SMB filesystem. It is usually invoked as
    30 mount.smbfs
     21mounts a Linux SMB filesystem\. It is usually invoked as
     22mount\.smbfs
    3123by the
    3224\fBmount\fR(8)
    33 command when using the "-t smbfs" option. This command only works in Linux, and the kernel must support the smbfs filesystem.
     25command when using the "\-t smbfs" option\. This command only works in Linux, and the kernel must support the smbfs filesystem\.
    3426.PP
    3527WARNING:
    3628smbmount
    37 is deprecated and not maintained any longer.
    38 mount.cifs
    39 (mount -t cifs) should be used instead of
    40 smbmount.
     29is deprecated and not maintained any longer\.
     30mount\.cifs
     31(mount \-t cifs) should be used instead of
     32smbmount\.
    4133.PP
    4234Options to
    4335smbmount
    44 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.
    45 .PP
    46 smbmount
    47 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
    48 \fIlog.smbmount\fR. The
    49 smbmount
    50 process may also be called mount.smbfs.
     36are 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\.
     37.PP
     38smbmount
     39is 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
     40\fIlog\.smbmount\fR\. The
     41smbmount
     42process may also be called mount\.smbfs\.
    5143.sp
    5244.it 1 an-trap
     
    5446.nr an-break-flag 1
    5547.br
    56 \fBNote\fR
     48Note
    5749.PP
    5850
     
    6052calls
    6153\fBsmbmnt\fR(8)
    62 to do the actual mount. You must make sure that
     54to do the actual mount\. You must make sure that
    6355smbmnt
    64 is in the path so that it can be found.
     56is in the path so that it can be found\.
    6557.SH "OPTIONS"
    6658.PP
    6759username=<arg>
    68 .RS 3n
    69 specifies the username to connect as. If this is not given, then the environment variable
     60.RS 4
     61specifies the username to connect as\. If this is not given, then the environment variable
    7062\fB USER\fR
    71 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.
     63is 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\.
    7264.RE
    7365.PP
    7466password=<arg>
    75 .RS 3n
    76 specifies the SMB password. If this option is not given then the environment variable
     67.RS 4
     68specifies the SMB password\. If this option is not given then the environment variable
    7769PASSWD
    78 is used. If it can find no password
    79 smbmount
    80 will prompt for a password, unless the guest option is given.
    81 .sp
    82 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.
     70is used\. If it can find no password
     71smbmount
     72will prompt for a password, unless the guest option is given\.
     73.sp
     74Note 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\.
    8375.RE
    8476.PP
    8577credentials=<filename>
    86 .RS 3n
    87 specifies a file that contains a username and/or password. The format of the file is:
    88 
    89 .sp
    90 
     78.RS 4
     79specifies a file that contains a username and/or password\. The format of the file is:
     80.sp
     81.RS 4
    9182.nf
    92 
    93 username = <value>
    94 password = <value>
    95 
     83username=value
     84password=value
    9685.fi
    97 
     86.RE
    9887.sp
    9988This is preferred over having passwords in plaintext in a shared file, such as
    100 \fI/etc/fstab\fR. Be sure to protect any credentials file properly.
     89\fI/etc/fstab\fR\. Be sure to protect any credentials file properly\.
    10190.RE
    10291.PP
    10392krb
    104 .RS 3n
    105 Use kerberos (Active Directory).
     93.RS 4
     94Use kerberos (Active Directory)\.
    10695.RE
    10796.PP
    10897netbiosname=<arg>
    109 .RS 3n
    110 sets the source NetBIOS name. It defaults to the local hostname.
     98.RS 4
     99sets the source NetBIOS name\. It defaults to the local hostname\.
    111100.RE
    112101.PP
    113102uid=<arg>
    114 .RS 3n
    115 sets the uid that will own all files on the mounted filesystem. It may be specified as either a username or a numeric uid.
     103.RS 4
     104sets the uid that will own all files on the mounted filesystem\. It may be specified as either a username or a numeric uid\.
    116105.RE
    117106.PP
    118107gid=<arg>
    119 .RS 3n
    120 sets the gid that will own all files on the mounted filesystem. It may be specified as either a groupname or a numeric gid.
     108.RS 4
     109sets the gid that will own all files on the mounted filesystem\. It may be specified as either a groupname or a numeric gid\.
    121110.RE
    122111.PP
    123112port=<arg>
    124 .RS 3n
    125 sets the remote SMB port number. The default is 445, fallback is 139.
     113.RS 4
     114sets the remote SMB port number\. The default is 445, fallback is 139\.
    126115.RE
    127116.PP
    128117fmask=<arg>
    129 .RS 3n
    130 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.
     118.RS 4
     119sets 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\.
    131120.RE
    132121.PP
    133122dmask=<arg>
    134 .RS 3n
    135 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.
     123.RS 4
     124Sets 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\.
    136125.RE
    137126.PP
    138127debug=<arg>
    139 .RS 3n
    140 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.
     128.RS 4
     129Sets 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\.
    141130.RE
    142131.PP
    143132ip=<arg>
    144 .RS 3n
    145 Sets the destination host or IP address.
     133.RS 4
     134Sets the destination host or IP address\.
    146135.RE
    147136.PP
    148137workgroup=<arg>
    149 .RS 3n
     138.RS 4
    150139Sets the workgroup on the destination
    151140.RE
    152141.PP
    153142sockopt=<arg>
    154 .RS 3n
    155 Sets the TCP socket options. See the
     143.RS 4
     144Sets the TCP socket options\. See the
    156145\fBsmb.conf\fR(5)
    157146\fIsocket options\fR
    158 option.
     147option\.
    159148.RE
    160149.PP
    161150scope=<arg>
    162 .RS 3n
     151.RS 4
    163152Sets the NetBIOS scope
    164153.RE
    165154.PP
    166155guest
    167 .RS 3n
    168 Don't prompt for a password
     156.RS 4
     157Don\'t prompt for a password
    169158.RE
    170159.PP
    171160ro
    172 .RS 3n
    173 mount read-only
     161.RS 4
     162mount read\-only
    174163.RE
    175164.PP
    176165rw
    177 .RS 3n
    178 mount read-write
     166.RS 4
     167mount read\-write
    179168.RE
    180169.PP
    181170iocharset=<arg>
    182 .RS 3n
    183 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)
     171.RS 4
     172sets 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)
    184173.RE
    185174.PP
    186175codepage=<arg>
    187 .RS 3n
    188 sets the codepage the server uses. See the iocharset option. Example value cp850. (Note: only kernel 2.4.0 or later)
     176.RS 4
     177sets the codepage the server uses\. See the iocharset option\. Example value cp850\. (Note: only kernel 2\.4\.0 or later)
    189178.RE
    190179.PP
    191180ttl=<arg>
    192 .RS 3n
    193 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)
     181.RS 4
     182sets 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)
    194183.RE
    195184.SH "ENVIRONMENT VARIABLES"
     
    197186The variable
    198187\fBUSER\fR
    199 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.
     188may 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\.
    200189.PP
    201190The variable
    202191\fBPASSWD\fR
    203 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.
     192may 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\.
    204193.PP
    205194The variable
    206195\fBPASSWD_FILE\fR
    207 may contain the pathname of a file to read the password from. A single line of input is read and used as the password.
     196may contain the pathname of a file to read the password from\. A single line of input is read and used as the password\.
    208197.SH "OTHER COMMANDS"
    209198.PP
     
    214203or the UNIX system
    215204umount
    216 command.
     205command\.
    217206.SH "BUGS"
    218207.PP
    219 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.
    220 .PP
    221 The credentials file does not handle usernames or passwords with leading space.
     208Passwords 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\.
     209.PP
     210The credentials file does not handle usernames or passwords with leading space\.
    222211.PP
    223212One smbfs bug is important enough to mention here, even if it is a bit misplaced:
    224 .TP 3n
    225 \(bu
    226 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.
    227 .PP
    228 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)
     213.sp
     214.RS 4
     215.ie n \{\
     216\h'-04'\(bu\h'+03'\c
     217.\}
     218.el \{\
     219.sp -1
     220.IP \(bu 2.3
     221.\}
     222Mounts 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\.
     223.sp
     224.RE
     225.PP
     226Note 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)
    229227.SH "SEE ALSO"
    230228.PP
    231 Documentation/filesystems/smbfs.txt in the linux kernel source tree may contain additional options and information.
     229Documentation/filesystems/smbfs\.txt in the linux kernel source tree may contain additional options and information\.
    232230.PP
    233231FreeBSD also has a smbfs, but it is not related to smbmount
    234232.PP
    235 For Solaris, HP-UX and others you may want to look at
     233For Solaris, HP\-UX and others you may want to look at
    236234\fBsmbsh\fR(1)
    237 or at other solutions, such as Sharity or perhaps replacing the SMB server with a NFS server.
     235or at other solutions, such as Sharity or perhaps replacing the SMB server with a NFS server\.
    238236.SH "AUTHOR"
    239237.PP
    240 Volker Lendecke, Andrew Tridgell, Michael H. Warfield and others.
     238Volker Lendecke, Andrew Tridgell, Michael H\. Warfield and others\.
    241239.PP
    242240The current maintainer of smbfs and the userspace tools
     
    245243smbmnt
    246244is
    247 Urban Widmark. The
     245Urban Widmark\. The
    248246SAMBA Mailing list
    249 is the preferred place to ask questions regarding these programs.
    250 .PP
    251 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.
    252 
     247is the preferred place to ask questions regarding these programs\.
     248.PP
     249The 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\.
Note: See TracChangeset for help on using the changeset viewer.