1LIBSMBCLIENT(7) 7 LIBSMBCLIENT(7)
2
6 libsmbclient - An extension library for browsers and that can be used
7 as a generic browsing API.
8
10 Browser URL:
13 smb://[[[domain:]user[:password@]]server[/share[/path[/file]]]]
14 [?options]
15
17 This tool is part of the samba(7) suite.
18 libsmbclient is a library toolset that permits applications to
20 manipulate CIFS/SMB network resources using many of the standards POSIX
21 functions available for manipulating local UNIX/Linux files. It permits
22 much more than just browsing, files can be opened and read or written,
23 permissions changed, file times modified, attributes and ACL's can be
24 manipulated, and so on. Of course, its functionality includes all the
25 capabilities commonly called browsing.
26 libsmbclient can not be used directly from the command line, instead it
28 provides an extension of the capabilities of tools such as file
29 managers and browsers. This man page describes the configuration
30 options for this tool so that the user may obtain greatest utility of
31 use.
32
34 What the URLs mean:
35 smb://
37 Shows all workgroups or domains that are visible in the network.
38 The behavior matches that of the Microsoft Windows Explorer.
39 The method of locating the list of workgroups (domains also) varies
41 depending on the setting of the context variable
42 (context->options.browse_max_lmb_count). It is the responsibility
43 of the application that calls this library to set this to a
44 sensible value. This is a compile-time option. This value
45 determines the maximum number of local master browsers to query for
46 the list of workgroups. In order to ensure that the list is
47 complete for those present on the network, all master browsers must
48 be queried. If there are a large number of workgroups on the
49 network, the time spent querying will be significant. For small
50 networks (just a few workgroups), it is suggested to set this value
51 to 0, instructing libsmbclient to query all local master browsers.
52 In an environment that has many workgroups a more reasonable
53 setting may be around 3.
54 smb://name/
56 This command causes libsmbclient to perform a name look-up. If the
57 NAME<1D> or NAME<1B> exists (workgroup name), libsmbclient will
58 list all servers in the workgroup (or domain). Otherwise, a name
59 look-up for the NAME<20> (machine name) will be performed, and the
60 list of shared resources on the server will be displayed.
61 When libsmbclient is invoked by an application it searches for a
63 directory called .smb in the $HOME directory that is specified in the
64 users shell environment. It then searches for a file called smb.conf
65 which, if present, will fully over-ride the system /etc/samba/smb.conf
66 file. If instead libsmbclient finds a file called
67 ~/.smb/smb.conf.append, it will read the system /etc/samba/smb.conf and
68 then append the contents of the ~/.smb/smb.conf.append to it.
69 libsmbclient will check the users shell environment for the USER
71 parameter and will use its value when if the user parameter was not
72 included in the URL.
73
75 Watch this space for future updates.
76
78 This man page is part of version 4.12.2 of the Samba suite.
79
81 The original Samba software and related utilities were created by
82 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
83 Source project similar to the way the Linux kernel is developed.
84 The libsmbclient manpage page was written by John H Terpstra.
86Samba 4.12.2 04/28/2020 LIBSMBCLIENT(7)