| 1 | '\" t
|
|---|
| 2 | .\" Title: libsmbclient
|
|---|
| 3 | .\" Author: [see the "AUTHOR" section]
|
|---|
| 4 | .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
|
|---|
| 5 | .\" Date: 10/25/2016
|
|---|
| 6 | .\" Manual: 7
|
|---|
| 7 | .\" Source: Samba 4.4
|
|---|
| 8 | .\" Language: English
|
|---|
| 9 | .\"
|
|---|
| 10 | .TH "LIBSMBCLIENT" "7" "10/25/2016" "Samba 4\&.4" "7"
|
|---|
| 11 | .\" -----------------------------------------------------------------
|
|---|
| 12 | .\" * Define some portability stuff
|
|---|
| 13 | .\" -----------------------------------------------------------------
|
|---|
| 14 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 15 | .\" http://bugs.debian.org/507673
|
|---|
| 16 | .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|---|
| 17 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 18 | .ie \n(.g .ds Aq \(aq
|
|---|
| 19 | .el .ds Aq '
|
|---|
| 20 | .\" -----------------------------------------------------------------
|
|---|
| 21 | .\" * set default formatting
|
|---|
| 22 | .\" -----------------------------------------------------------------
|
|---|
| 23 | .\" disable hyphenation
|
|---|
| 24 | .nh
|
|---|
| 25 | .\" disable justification (adjust text to left margin only)
|
|---|
| 26 | .ad l
|
|---|
| 27 | .\" -----------------------------------------------------------------
|
|---|
| 28 | .\" * MAIN CONTENT STARTS HERE *
|
|---|
| 29 | .\" -----------------------------------------------------------------
|
|---|
| 30 | .SH "NAME"
|
|---|
| 31 | libsmbclient \- An extension library for browsers and that can be used as a generic browsing API\&.
|
|---|
| 32 | .SH "SYNOPSIS"
|
|---|
| 33 | .HP \w'\ 'u
|
|---|
| 34 | .PP
|
|---|
| 35 | Browser URL:
|
|---|
| 36 | smb://[[[domain:]user[:password@]]server[/share[/path[/file]]]] [?options]
|
|---|
| 37 | .SH "DESCRIPTION"
|
|---|
| 38 | .PP
|
|---|
| 39 | This tool is part of the
|
|---|
| 40 | \fBsamba\fR(7)
|
|---|
| 41 | suite\&.
|
|---|
| 42 | .PP
|
|---|
| 43 | libsmbclient
|
|---|
| 44 | 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\*(Aqs can be manipulated, and so on\&. Of course, its functionality includes all the capabilities commonly called browsing\&.
|
|---|
| 45 | .PP
|
|---|
| 46 | libsmbclient
|
|---|
| 47 | 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\&.
|
|---|
| 48 | .SH "OPTIONS"
|
|---|
| 49 | .PP
|
|---|
| 50 | What the URLs mean:
|
|---|
| 51 | .PP
|
|---|
| 52 | smb://
|
|---|
| 53 | .RS 4
|
|---|
| 54 | Shows all workgroups or domains that are visible in the network\&. The behavior matches that of the Microsoft Windows Explorer\&.
|
|---|
| 55 | .sp
|
|---|
| 56 | The method of locating the list of workgroups (domains also) varies depending on the setting of the context variable
|
|---|
| 57 | (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 queried\&. 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\&.
|
|---|
| 58 | .RE
|
|---|
| 59 | .PP
|
|---|
| 60 | smb://name/
|
|---|
| 61 | .RS 4
|
|---|
| 62 | This command causes libsmbclient to perform a name look\-up\&. If the NAME<1D> or NAME<1B> exists (workgroup name), libsmbclient will list all servers in the workgroup (or domain)\&. Otherwise, a name look\-up for the NAME<20> (machine name) will be performed, and the list of shared resources on the server will be displayed\&.
|
|---|
| 63 | .RE
|
|---|
| 64 | .PP
|
|---|
| 65 | When libsmbclient is invoked by an application it searches for a directory called
|
|---|
| 66 | \&.smb
|
|---|
| 67 | in the $HOME directory that is specified in the users shell environment\&. It then searches for a file called
|
|---|
| 68 | smb\&.conf
|
|---|
| 69 | which, if present, will fully over\-ride the system
|
|---|
| 70 | /etc/samba/smb\&.conf
|
|---|
| 71 | file\&. If instead libsmbclient finds a file called
|
|---|
| 72 | ~/\&.smb/smb\&.conf\&.append, it will read the system
|
|---|
| 73 | /etc/samba/smb\&.conf
|
|---|
| 74 | and then append the contents of the
|
|---|
| 75 | ~/\&.smb/smb\&.conf\&.append
|
|---|
| 76 | to it\&.
|
|---|
| 77 | .PP
|
|---|
| 78 | libsmbclient
|
|---|
| 79 | will check the users shell environment for the
|
|---|
| 80 | USER
|
|---|
| 81 | parameter and will use its value when if the
|
|---|
| 82 | user
|
|---|
| 83 | parameter was not included in the URL\&.
|
|---|
| 84 | .SH "PROGRAMMERS GUIDE"
|
|---|
| 85 | .PP
|
|---|
| 86 | Watch this space for future updates\&.
|
|---|
| 87 | .SH "VERSION"
|
|---|
| 88 | .PP
|
|---|
| 89 | This man page is correct for version 3 of the Samba suite\&.
|
|---|
| 90 | .SH "AUTHOR"
|
|---|
| 91 | .PP
|
|---|
| 92 | The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
|
|---|
| 93 | .PP
|
|---|
| 94 | The libsmbclient manpage page was written by John H Terpstra\&.
|
|---|
