1LIBSMBCLIENT(7)                                                LIBSMBCLIENT(7)
2
3
4

NAME

6       libsmbclient  -  An extension library for browsers and that can be used
7       as a generic browsing API.
8

SYNOPSIS

10       Browser              URL:.PP               smb://[[[domain:]user[:pass‐
11        word@]]server[/share[/path[/file]]]] [?options]
12
13

DESCRIPTION

15       This tool is part of the samba(7) suite.
16
17       libsmbclient  is a library toolset that permits applications to manipu‐
18       late CIFS/SMB network resources using many of the standards POSIX func‐
19       tions  available  for  manipulating  local UNIX/Linux files. It permits
20       much more than just browsing, files can be opened and read or  written,
21       permissions  changed,  file times modified, attributes and ACL's can be
22       manipulated, and so on. Of course, its functionality includes  all  the
23       capabilities commonly called browsing.
24
25       libsmbclient can not be used directly from the command line, instead it
26       provides an extension of the capabilities of tools such  as  file  man‐
27       agers  and  browsers. This man page describes the configuration options
28       for this tool so that the user may obtain greatest utility of use.
29

OPTIONS

31       What the URLs mean:
32
33       smb://
34          Shows all workgroups or domains that are visible in the network. The
35          behavior matches that of the Microsoft Windows Explorer.
36
37          The  method of locating the list of workgroups (domains also) varies
38          depending  on  the   setting   of   the   context   variable   (con‐
39          text->options.browse_max_lmb_count). It is the responsibility of the
40          application that calls this library to set this to a sensible value.
41          This  is  a  compile-time  option. This value determines the maximum
42          number of local master browsers to query for the list of workgroups.
43          In  order  to  ensure that the list is complete for those present on
44          the network, all master browsers must be querried. If  there  are  a
45          large  number  of workgroups on the network, the time spent querying
46          will be significant. For small networks (just a few workgroups),  it
47          is  suggested  to  set  this value to 0, instructing libsmbclient to
48          query all local master browsers. In an  environment  that  has  many
49          workgroups a more reasonable setting may be around 3.
50
51       smb://name/
52          This  command  causes libsmbclient to perform a name look-up. If the
53          NAME<1D> or NAME<1B> exists (workgroup name), libsmbclient will list
54          all  servers in the workgroup (or domain). Otherwise, a name look-up
55          for the NAME<20> (machine name) will be performed, and the  list  of
56          shared resources on the server will be displayed.
57
58       When libsmbclient is invoked by an application it searches for a direc‐
59       tory called .smb in the $HOME directory that is specified in the  users
60       shell  environment.  It then searches for a file called smb.conf which,
61       if present, will fully over-ride the system  /etc/samba/smb.conf  file.
62       If  instead libsmbclient finds a file called ~/.smb/smb.conf.append, it
63       will read the system /etc/samba/smb.conf and then append  the  contents
64       of the ~/.smb/smb.conf.append to it.
65
66       libsmbclient will check the users shell environment for the USER param‐
67       eter and will use its value when if the user parameter was not included
68       in the URL.
69

PROGRAMMERS GUIDE

71       Watch this space for future updates.
72

VERSION

74       This man page is correct for version 3.0 of the Samba suite.
75

AUTHOR

77       The  original  Samba  software  and  related  utilities were created by
78       Andrew Tridgell. Samba is now developed by the Samba Team  as  an  Open
79       Source project similar to the way the Linux kernel is developed.
80
81       The libsmbclient manpage page was written by John H Terpstra.
82
83
84
85
86                                                               LIBSMBCLIENT(7)
Impressum