1
0

aquarela 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  1. .TH AQUARELA 8
  2. .SH NAME
  3. aquarela \- CIFS server
  4. .SH SYNOPSIS
  5. .B aquarela
  6. [
  7. .B -np
  8. ] [
  9. .B -d
  10. .I debug
  11. ] [
  12. .B -u
  13. .I N
  14. ] [
  15. .B -w
  16. .I workgroup
  17. ]
  18. .SH DESCRIPTION
  19. .I Aquarela
  20. provides
  21. .SM CIFS
  22. (once known as
  23. .SM SMB\c
  24. )
  25. access to Plan 9 file servers.
  26. It announces and subsequently listens on
  27. .B tcp!*!445
  28. for connections to the file hierarchies called `shares' by
  29. .SM CIFS\c .
  30. Users are authenticated with their
  31. .SM APOP
  32. secret (see
  33. .IR auth (8)).
  34. Each session is managed by a process running as the authenticated user.
  35. Two persistent processes handle listening, session setup, and housekeeping.
  36. .PP
  37. An
  38. .I aquarela
  39. .SM CIFS
  40. share corresponds to a directory under
  41. .BR /n .
  42. A client request for a specific share, say,
  43. .BR share ,
  44. causes
  45. .I aquarela
  46. to attempt a
  47. .I 9fs
  48. (in
  49. .IR srv (4))
  50. connection to the file server
  51. .BR share .
  52. If connection succeeds, a file hierarchy rooted at
  53. .B /n/share
  54. is presented to the client.
  55. The client request fails otherwise.
  56. Requests for the protocol equivalent of
  57. .B /
  58. are satisfied with a directory containing only the default share,
  59. .BR local .
  60. .PP
  61. The options are:
  62. .TF "-u "
  63. .TP
  64. .B -n
  65. Enable limited
  66. .SM NETBIOS
  67. service.
  68. .I Aquarela
  69. will register with the `master browser' for
  70. .I workgroup
  71. and listen on
  72. .B tcp!*!139
  73. and
  74. .B udp!*!13[7-9]
  75. for
  76. .SM NETBIOS
  77. name resolution and session requests.
  78. This works in tandem with a complete
  79. .SM NETBIOS
  80. master name server, like that provided by Unix
  81. \fInmbd\fR(8).
  82. .SM NETBIOS
  83. is not required for
  84. .SM CIFS
  85. file service.
  86. .TP
  87. .BI -u " N
  88. Send Unicode.
  89. For
  90. .IR N ,
  91. .B 1
  92. enables,
  93. .B 0
  94. disables Unicoding of file names and metadata.
  95. There is no code page support, so
  96. .I aquarela
  97. emits
  98. .SM UTF
  99. if
  100. .I N
  101. is
  102. .BR 0 .
  103. .TP
  104. .BI -w " workgroup
  105. Set
  106. .I workgroup
  107. (or `primary domain') of server.
  108. Default
  109. .BR PLAN9 .
  110. .PD
  111. .SH EXAMPLE
  112. To start
  113. .SM CIFS
  114. service on system
  115. .BR plan9 :
  116. .IP
  117. .EX
  118. % aquarela -u 1 &
  119. .EE
  120. .PP
  121. To then make the
  122. .B dump
  123. filesystem available as drive
  124. .B Y:
  125. on a Windows machine:
  126. .IP
  127. .EX
  128. C:\\>net use Y: \\\\plan9.example.com\\dump
  129. .EE
  130. .SH FILES
  131. .TF /sys/log/aquarela
  132. .TP
  133. .B /n/local
  134. Default
  135. .SM CIFS
  136. share
  137. .TP
  138. .B /sys/log/aquarela
  139. Log file
  140. .PD
  141. .SH SOURCE
  142. .B /sys/src/cmd/aquarela
  143. .SH SEE ALSO
  144. .IR auth (8),
  145. .IR srv (4),
  146. .IR utf (6)
  147. .SH DIAGNOSTICS
  148. Log messages are appended to
  149. .B /sys/log/aquarela
  150. if it exists. The
  151. .B -p
  152. option prints them on standard output as well.
  153. The
  154. .B -d
  155. option adds verbose output about
  156. .I debug
  157. to the log messages, where
  158. .I debug
  159. is one of:
  160. .TF any-smb-name
  161. .TP
  162. .B allcmds
  163. All
  164. .SM CIFS
  165. requests and responses.
  166. .TP
  167. .B tids
  168. Connections and disconnections per-share.
  169. .TP
  170. .B sids
  171. Creation and deletion of search ids.
  172. .TP
  173. .B fids
  174. Creation and deletion of file ids.
  175. .TP
  176. .B rap2
  177. .SM RAP
  178. calls.
  179. .TP
  180. .B find
  181. Transaction2 find commands.
  182. .TP
  183. .B query
  184. Transaction2 query commands.
  185. .TP
  186. .B sharedfiles
  187. All files opened.
  188. .TP
  189. .B poolparanoia
  190. Draconian error checking in memory allocator.
  191. .TP
  192. .B sessions
  193. Connections and disconnections on server.
  194. .TP
  195. .B rep
  196. Regular expression conversions.
  197. .TP
  198. .B locks
  199. Locking activity.
  200. .TP
  201. .I any-smb-name
  202. Debug only
  203. .B SMB_
  204. requests or
  205. .B transaction2
  206. sub-requests
  207. (e.g.,
  208. .B SMB_COM_SESSION_SETUP_ANDX
  209. or
  210. .BR SMB_TRANS2_FIND_FIRST2 )
  211. matching symbolic name
  212. .I any-smb-name.
  213. .TP
  214. .BI 0x nn
  215. Debug only messages with hexadecimal id
  216. .BI 0x nn.
  217. .PD
  218. .SH BUGS
  219. The first connection attempt to a share sometimes fails erroneously - try again.
  220. The share disk space reported by some clients is inaccurate.
  221. Some clients can't rename directories.
  222. Write attempts without sufficient permissions fail (correctly), but appear on client to temporarily succeed.
  223. .PP
  224. This program should probably be named
  225. .IR cifsserver .