sys/man/4/cifs

   1 .TH CIFS 4
   2 .SH NAME
   3 cifs - Microsoft™ Windows network filesystem client
   4 .SH SYNOPSIS
   5 .B cifs
   6 [
   7 .B -bdDiv
   8 ] [
   9 .B -a
  10 .I auth-method
  11 ] [
  12 .B -s
  13 .I srvname
  14 ] [
  15 .B -n
  16 .I called-name
  17 ] [
  18 .B -k
  19 .I keyparam
  20 ] [
  21 .B -m
  22 .I mntpnt
  23 ]
  24 .I host
  25 [
  26 .I share ...
  27 ]
  28 .SH DESCRIPTION
  29 .I Cifs
  30 translates between Microsoft's file-sharing protocol
  31 (a.k.a. CIFS or SMB) and 9P, allowing Plan9 clients to mount file systems
  32 (shares or trees in MS terminology) published by such servers.
  33 .PP
  34 The root of the mounted directory contains one subdirectory per share,
  35 always named in lower case, and a few virtual files of mixed case which
  36 give additional server, session, share, and user information.
  37 The arguments are:
  38 .TF "-a\fI auth-method"
  39 .PD
  40 .TP
  41 .BI -a " auth-method"
  42 .I Cifs
  43 authenticates using
  44 .L BNTLM
  45 by default, but alternative strategies may be
  46 selected using this option.
  47 .I Cifs
  48 eschews cleartext authentication, however
  49 it may be enabled with the
  50 .L plain
  51 auth method.
  52 The list of currently-supported methods is printed
  53 if no method name is supplied.
  54 .IP
  55 .I "Windows server 2003"
  56 requires the
  57 .B BNTLMv2
  58 method by default, though it can be configured to be more flexible.
  59 .TP
  60 .B -b
  61 Enable file ownership resolution in
  62 .IR stat (2)
  63 calls.
  64 This requires an open and close per file and thus will slow
  65 .I cifs
  66 considerably; its use is not recommended.
  67 .TP
  68 .B -d
  69 CIFS packet debug.
  70 .TP
  71 .B -D
  72 9P request debug.
  73 .TP
  74 .BI -k " keyparam"
  75 lists extra parameters which will be passed to
  76 .IR factotum (4)
  77 to select a specific key.
  78 The remote servers's domain is always included in the keyspec,
  79 under the assumption
  80 that all servers in a Windows domain share an authentication domain;
  81 thus
  82 .I cifs
  83 expects keys in
  84 .I factotum
  85 of the form:
  86 .RS
  87 .IP
  88 .EX
  89 key proto=pass dom=THEIR-DOMAIN service=cifs
  90         user=MY-USERNAME !password=XYZZY
  91 .EE
  92 .RE
  93 .TP
  94 .BI -m " mntpnt"
  95 set the mount point for the remote filesystem;
  96 the default is
  97 .BI /n/ host.
  98 .TP
  99 .BI -n " called-name"
 100 The CIFS protocol requires clients to know the NetBios name of the
 101 server they are attaching to, the
 102 .IR Icalled-name .
 103 If this is not specified on the command line,
 104 .I cifs
 105 attempts to discover this name from the remote server.
 106 If this fails it will then try
 107 .IR host ,
 108 and finally it will try the name
 109 .LR *SMBSERVER .
 110 .TP
 111 .BI -s " srvname"
 112 post the service as
 113 .BI /srv/ srvname.
 114 .TP
 115 .I host
 116 The address of the remote server to connect to.
 117 .TP
 118 .I share
 119 A list of share names to attach on the remote server; if none is given,
 120 .I cifs
 121 will attempt to attach all shares published by the remote host.
 122 .SS "Synthetic Files"
 123 Several synthetic files appear in the root of the mounted filesystem:
 124 .TF Workstations
 125 .PD
 126 .TP
 127 .B Shares
 128 Contains a list of the currently attached shares,
 129 with fields giving the share name,  disk free space / capacity, the share type,
 130 and a descriptive comment from the server.
 131 .TP
 132 .B Connection
 133 Contains the username used for authentication,
 134 server's called name, server's domain,
 135 server's OS, the time slip between the local host and the server,
 136 the Maximum Transfer Unit (MTU) the server requested, and optionally a flag
 137 indicating only guest access has been granted.
 138 The second line contains a list of capabilities offered by the server which is
 139 mainly of use for debugging
 140 .IR cifs .
 141 .TP
 142 .B Users
 143 Each line contains a user's name, the user's full name,
 144 and a descriptive comment.
 145 .TP
 146 .B Groups
 147 Each line gives a group's name, and a list of the names of the users who
 148 are members of that group.
 149 .TP
 150 .B Sessions
 151 Lists the users authenticated, the client machine's NetBios name or IP address,
 152 the time since the connection was established,
 153 and the time for which the connection has been idle.
 154 .TP
 155 .B Domains
 156 One line per domain giving the domain name and a descriptive comment.
 157 .TP
 158 .B Workstations
 159 One line per domain giving the domain name and a descriptive comment,
 160 the version number of the OS it is running, and comma-separated list of flags
 161 giving the features of that OS.
 162 .TP
 163 .B Dfsroot
 164 Top level DFS routing giving the DFS link type, time to live of the data,
 165 proximity of the server, the Netbios or DNS name and
 166 a physical path or a machine that this maps to.
 167 .IP
 168 DNS paths are usually assigned dynamicially as a form of load balancing.
 169 .SH SOURCE
 170 .B /sys/src/cmd/cifs
 171 .SH SEE ALSO
 172 .IR factotum (4),
 173 .IR cifsd (8)
 174 .SH BUGS
 175 NetApp Filer compatibility has not yet been tested; there may not be any.
 176 .PP
 177 DFS support is unfinished.
 178 .PP
 179 Kerberos authentication is unfinished.
 180 .PP
 181 NetBios name resolution is not supported, though it is now rarely used.
 182 .PP
 183 .I Cifs
 184 has only been tested against
 185 aquarela, Windows 95, NT4.0sp6,
 186 Windows server 2003, WinXP pro, Samba 3.0, and Samba 2.0 (Pluto VideoSpace).
 187 No support is attempted for servers predating NT 4.0.