← Back to branch summary

~ubuntu-branches/ubuntu/maverick/samba/maverick-security

« back to all changes in this revision

Viewing changes to docs/manpages/libsmbclient.7

  • Committer: Bazaar Package Importer
  • Author(s): Chuck Short
  • Date: 2010-01-29 06:16:15 UTC
  • mfrom: (0.27.9 upstream) (0.34.4 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100129061615-37hs6xqpsdhjq3ld
Tags: 2:3.4.5~dfsg-1ubuntu1
https://launchpad.net/bugs/462169
https://launchpad.net/bugs/493565
* Merge from debian testing.  Remaining changes:
  + debian/patches/VERSION.patch:
    - set SAMBA_VERSION_SUFFIX to Ubuntu.
  + debian/smb.conf:
    - Add "(Samba, Ubuntu)" to server string.
    - Comment out the default [homes] share, and add a comment about "valid users = %s"
      to show users how to restrict access to \\server\username to only username.
    - Set 'usershare allow guests', so that usershare admins are allowed to create
      public shares in additon to authenticated ones.
    - add map to guest = Bad user, maps bad username to gues access.
  + debian/samba-common.conf:
    - Do not change priority to high if dhclient3 is installed.
    - Use priority medium instead of high for the workgroup question.
  + debian/mksambapasswd.awk:
    - Do not add user with UID less than 1000 to smbpasswd.
  + debian/control: 
    - Make libswbclient0 replace/conflict with hardy's likewise-open.
    - Don't build against ctdb, since its not in main yet.
  + debian/rules:
    - Enable "native" PIE hardening.
    - Add BIND_NOW to maximize benefit of RELRO hardening.
  + Add ufw integration:
    - Created debian/samba.ufw.profile.
    - debian/rules, debian/samba.dirs, debian/samba.files: install
  + Add apoort hook:
    - Created debian/source_samba.py.
    - debian/rules, debian/samba.dirs, debian/samba-common-bin.files: install
  + debian/rules, debian/samba.if-up: allow "NetworkManager" as a recognized address
    family... it's obviously /not/ an address family, but it's what gets
    sent when using NM, so we'll cope for now.  (LP: #462169). Taken from karmic-proposed.
  + debian/control: Recommend keyutils for smbfs (LP: #493565)
  + Dropped patches:
    - debian/patches/security-CVE-2009-3297.patch: No longer needed
    - debian/patches/fix-too-many-open-files.patch: No longer needed

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/manpages/libsmbclient.7
 
1
'\" t
1
2
.\"     Title: libsmbclient
2
3
.\"    Author: [see the "AUTHOR" section]
3
 
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4
 
.\"      Date: 10/29/2009
 
4
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
 
5
.\"      Date: 01/18/2010
5
6
.\"    Manual: 7
6
7
.\"    Source: Samba 3.4
7
8
.\"  Language: English
8
9
.\"
9
 
.TH "LIBSMBCLIENT" "7" "10/29/2009" "Samba 3\&.4" "7"
10
 
.\" -----------------------------------------------------------------
11
 
.\" * (re)Define some macros
12
 
.\" -----------------------------------------------------------------
13
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14
 
.\" toupper - uppercase a string (locale-aware)
15
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16
 
.de toupper
17
 
.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18
 
\\$*
19
 
.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20
 
..
21
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22
 
.\" SH-xref - format a cross-reference to an SH section
23
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24
 
.de SH-xref
25
 
.ie n \{\
26
 
.\}
27
 
.toupper \\$*
28
 
.el \{\
29
 
\\$*
30
 
.\}
31
 
..
32
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33
 
.\" SH - level-one heading that works better for non-TTY output
34
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35
 
.de1 SH
36
 
.if t \{\
37
 
.sp 1
38
 
.\}
39
 
.sp \\n[PD]u
40
 
.nr an-level 1
41
 
.set-an-margin
42
 
.nr an-prevailing-indent \\n[IN]
43
 
.fi
44
 
.in \\n[an-margin]u
45
 
.ti 0
46
 
.HTML-TAG ".NH \\n[an-level]"
47
 
.it 1 an-trap
48
 
.nr an-no-space-flag 1
49
 
.nr an-break-flag 1
50
 
.ps +3
51
 
.ft B
52
 
.ne (2v + 1u)
53
 
.ie n \{\
54
 
.\" if n (TTY output), use uppercase
55
 
.toupper \\$*
56
 
.\}
57
 
.el \{\
58
 
.nr an-break-flag 0
59
 
.\" if not n (not TTY), use normal case (not uppercase)
60
 
\\$1
61
 
.in \\n[an-margin]u
62
 
.ti 0
63
 
.\" if not n (not TTY), put a border/line under subheading
64
 
.sp -.6
65
 
\l'\n(.lu'
66
 
.\}
67
 
..
68
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
69
 
.\" SS - level-two heading that works better for non-TTY output
70
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71
 
.de1 SS
72
 
.sp \\n[PD]u
73
 
.nr an-level 1
74
 
.set-an-margin
75
 
.nr an-prevailing-indent \\n[IN]
76
 
.fi
77
 
.in \\n[IN]u
78
 
.ti \\n[SN]u
79
 
.it 1 an-trap
80
 
.nr an-no-space-flag 1
81
 
.nr an-break-flag 1
82
 
.ps \\n[PS-SS]u
83
 
.ps +2
84
 
.ft B
85
 
.ne (2v + 1u)
86
 
.if \\n[.$] \&\\$*
87
 
..
88
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
89
 
.\" BB/BE - put background/screen (filled box) around block of text
90
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
91
 
.de BB
92
 
.if t \{\
93
 
.sp -.5
94
 
.br
95
 
.in +2n
96
 
.ll -2n
97
 
.gcolor red
98
 
.di BX
99
 
.\}
100
 
..
101
 
.de EB
102
 
.if t \{\
103
 
.if "\\$2"adjust-for-leading-newline" \{\
104
 
.sp -1
105
 
.\}
106
 
.br
107
 
.di
108
 
.in
109
 
.ll
110
 
.gcolor
111
 
.nr BW \\n(.lu-\\n(.i
112
 
.nr BH \\n(dn+.5v
113
 
.ne \\n(BHu+.5v
114
 
.ie "\\$2"adjust-for-leading-newline" \{\
115
 
\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
116
 
.\}
117
 
.el \{\
118
 
\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119
 
.\}
120
 
.in 0
121
 
.sp -.5v
122
 
.nf
123
 
.BX
124
 
.in
125
 
.sp .5v
126
 
.fi
127
 
.\}
128
 
..
129
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
130
 
.\" BM/EM - put colored marker in margin next to block of text
131
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
132
 
.de BM
133
 
.if t \{\
134
 
.br
135
 
.ll -2n
136
 
.gcolor red
137
 
.di BX
138
 
.\}
139
 
..
140
 
.de EM
141
 
.if t \{\
142
 
.br
143
 
.di
144
 
.ll
145
 
.gcolor
146
 
.nr BH \\n(dn
147
 
.ne \\n(BHu
148
 
\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
149
 
.in 0
150
 
.nf
151
 
.BX
152
 
.in
153
 
.fi
154
 
.\}
155
 
..
 
10
.TH "LIBSMBCLIENT" "7" "01/18/2010" "Samba 3\&.4" "7"
156
11
.\" -----------------------------------------------------------------
157
12
.\" * set default formatting
158
13
.\" -----------------------------------------------------------------
163
18
.\" -----------------------------------------------------------------
164
19
.\" * MAIN CONTENT STARTS HERE *
165
20
.\" -----------------------------------------------------------------
166
 
.SH "Name"
 
21
.SH "NAME"
167
22
libsmbclient \- An extension library for browsers and that can be used as a generic browsing API\&.
168
 
.SH "Synopsis"
169
 
.fam C
 
23
.SH "SYNOPSIS"
170
24
.HP \w'\ 'u
171
25
.PP
172
26
Browser URL:
173
 
\FCsmb://[[[domain:]user[:password@]]server[/share[/path[/file]]]] [?options] \F[]
174
 
.fam
 
27
smb://[[[domain:]user[:password@]]server[/share[/path[/file]]]] [?options]
175
28
.SH "DESCRIPTION"
176
29
.PP
177
30
This tool is part of the
179
32
suite\&.
180
33
.PP
181
34
 
182
 
\FClibsmbclient\F[]
 
35
libsmbclient
183
36
is a library toolset that permits applications to manipulate CIFS/SMB network resources using many of the standards POSIX functions available for manipulating local UNIX/Linux files\&. It permits much more than just browsing, files can be opened and read or written, permissions changed, file times modified, attributes and ACL\'s can be manipulated, and so on\&. Of course, its functionality includes all the capabilities commonly called browsing\&.
184
37
.PP
185
38
 
186
 
\FClibsmbclient\F[]
 
39
libsmbclient
187
40
can not be used directly from the command line, instead it provides an extension of the capabilities of tools such as file managers and browsers\&. This man page describes the configuration options for this tool so that the user may obtain greatest utility of use\&.
188
41
.SH "OPTIONS"
189
42
.PP
194
47
Shows all workgroups or domains that are visible in the network\&. The behavior matches that of the Microsoft Windows Explorer\&.
195
48
.sp
196
49
The method of locating the list of workgroups (domains also) varies depending on the setting of the context variable
197
 
\FC(context\->options\&.browse_max_lmb_count)\F[]\&. It is the responsibility of the application that calls this library to set this to a sensible value\&. This is a compile\-time option\&. This value determines the maximum number of local master browsers to query for the list of workgroups\&. In order to ensure that the list is complete for those present on the network, all master browsers must be querried\&. If there are a large number of workgroups on the network, the time spent querying will be significant\&. For small networks (just a few workgroups), it is suggested to set this value to 0, instructing libsmbclient to query all local master browsers\&. In an environment that has many workgroups a more reasonable setting may be around 3\&.
 
50
(context\->options\&.browse_max_lmb_count)\&. It is the responsibility of the application that calls this library to set this to a sensible value\&. This is a compile\-time option\&. This value determines the maximum number of local master browsers to query for the list of workgroups\&. In order to ensure that the list is complete for those present on the network, all master browsers must be querried\&. If there are a large number of workgroups on the network, the time spent querying will be significant\&. For small networks (just a few workgroups), it is suggested to set this value to 0, instructing libsmbclient to query all local master browsers\&. In an environment that has many workgroups a more reasonable setting may be around 3\&.
198
51
.RE
199
52
.PP
200
53
smb://name/
203
56
.RE
204
57
.PP
205
58
When libsmbclient is invoked by an application it searches for a directory called
206
 
\FC\&.smb\F[]
 
59
\&.smb
207
60
in the $HOME directory that is specified in the users shell environment\&. It then searches for a file called
208
 
\FCsmb\&.conf\F[]
 
61
smb\&.conf
209
62
which, if present, will fully over\-ride the system
210
 
\FC/etc/samba/smb\&.conf\F[]
 
63
/etc/samba/smb\&.conf
211
64
file\&. If instead libsmbclient finds a file called
212
 
\FC~/\&.smb/smb\&.conf\&.append\F[], it will read the system
213
 
\FC/etc/samba/smb\&.conf\F[]
 
65
~/\&.smb/smb\&.conf\&.append, it will read the system
 
66
/etc/samba/smb\&.conf
214
67
and then append the contents of the
215
 
\FC~/\&.smb/smb\&.conf\&.append\F[]
 
68
~/\&.smb/smb\&.conf\&.append
216
69
to it\&.
217
70
.PP
218
71
 
219
 
\FClibsmbclient\F[]
 
72
libsmbclient
220
73
will check the users shell environment for the
221
 
\FCUSER\F[]
 
74
USER
222
75
parameter and will use its value when if the
223
 
\FCuser\F[]
 
76
user
224
77
parameter was not included in the URL\&.
225
78
.SH "PROGRAMMERS GUIDE"
226
79
.PP