diff options
Diffstat (limited to 'docs/docbook/manpages/smbclient.1.sgml')
| -rw-r--r-- | docs/docbook/manpages/smbclient.1.sgml | 231 |
1 files changed, 182 insertions, 49 deletions
diff --git a/docs/docbook/manpages/smbclient.1.sgml b/docs/docbook/manpages/smbclient.1.sgml index cd513398b9..43994a4529 100644 --- a/docs/docbook/manpages/smbclient.1.sgml +++ b/docs/docbook/manpages/smbclient.1.sgml @@ -1,7 +1,5 @@ -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ -<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; -]> -<refentry id="smbclient.1"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="smbclient"> <refmeta> <refentrytitle>smbclient</refentrytitle> @@ -40,20 +38,18 @@ <arg choice="opt">-R <name resolve order></arg> <arg choice="opt">-s <smb config file></arg> <arg choice="opt">-T<c|x>IXFqgbNan</arg> - <arg choice="opt">-k</arg> </cmdsynopsis> </refsynopsisdiv> <refsect1> <title>DESCRIPTION</title> - <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> - <manvolnum>7</manvolnum></citerefentry> suite.</para> + <para>This tool is part of the <ulink url="samba.7.html"> + Samba</ulink> suite.</para> <para><command>smbclient</command> is a client that can 'talk' to an SMB/CIFS server. It offers an interface - similar to that of the ftp program (see <citerefentry><refentrytitle>ftp</refentrytitle> - <manvolnum>1</manvolnum></citerefentry>). + similar to that of the ftp program (see <command>ftp(1)</command>). Operations include things like getting files from the server to the local machine, putting files from the local machine to the server, retrieving directory information from the server @@ -85,9 +81,7 @@ <para>The server name is looked up according to either the <parameter>-R</parameter> parameter to <command>smbclient</command> or - using the name resolve order parameter in - the <citerefentry><refentrytitle>smb.conf</refentrytitle> - <manvolnum>5</manvolnum></citerefentry> file, + using the name resolve order parameter in the <filename>smb.conf</filename> file, allowing an administrator to change the order and methods by which server names are looked up. </para></listitem> </varlistentry> @@ -118,6 +112,21 @@ </varlistentry> <varlistentry> + <term>-s smb.conf</term> + <listitem><para>Specifies the location of the all important + <filename>smb.conf</filename> file. </para></listitem> + </varlistentry> + + <varlistentry> + <term>-O socket options</term> + <listitem><para>TCP socket options to set on the client + socket. See the socket options parameter in the <filename> + smb.conf (5)</filename> manpage for the list of valid + options. </para></listitem> + </varlistentry> + + + <varlistentry> <term>-R <name resolve order></term> <listitem><para>This option is used by the programs in the Samba suite to determine what naming services and in what order to resolve @@ -125,51 +134,44 @@ string of different name resolution options.</para> <para>The options are :"lmhosts", "host", "wins" and "bcast". They - cause names to be resolved as follows:</para> + cause names to be resolved as follows :</para> <itemizedlist> - <listitem><para><constant>lmhosts</constant>: Lookup an IP + <listitem><para><constant>lmhosts</constant> : Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has - no name type attached to the NetBIOS name (see - the <citerefentry><refentrytitle>lmhosts</refentrytitle> - <manvolnum>5</manvolnum></citerefentry> for details) then - any name type matches for lookup.</para> - </listitem> - - <listitem><para><constant>host</constant>: Do a standard host + no name type attached to the NetBIOS name (see the <ulink + url="lmhosts.5.html">lmhosts(5)</ulink> for details) then + any name type matches for lookup.</para></listitem> + + <listitem><para><constant>host</constant> : Do a standard host name to IP address resolution, using the system <filename>/etc/hosts </filename>, NIS, or DNS lookups. This method of name resolution is operating system dependent, for instance on IRIX or Solaris this may be controlled by the <filename>/etc/nsswitch.conf</filename> file). Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise - it is ignored.</para> - </listitem> - - <listitem><para><constant>wins</constant>: Query a name with + it is ignored.</para></listitem> + + <listitem><para><constant>wins</constant> : Query a name with the IP address listed in the <parameter>wins server</parameter> parameter. If no WINS server has - been specified this method will be ignored.</para> - </listitem> - - <listitem><para><constant>bcast</constant>: Do a broadcast on + been specified this method will be ignored.</para></listitem> + + <listitem><para><constant>bcast</constant> : Do a broadcast on each of the known local interfaces listed in the <parameter>interfaces</parameter> parameter. This is the least reliable of the name resolution methods as it depends on the target host being on a locally - connected subnet.</para> - </listitem> + connected subnet.</para></listitem> </itemizedlist> <para>If this parameter is not set then the name resolve order - defined in the <citerefentry><refentrytitle>smb.conf</refentrytitle> - <manvolnum>5</manvolnum></citerefentry> file parameter + defined in the <filename>smb.conf</filename> file parameter (name resolve order) will be used. </para> <para>The default order is lmhosts, host, wins, bcast and without this parameter or any entry in the <parameter>name resolve order - </parameter> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle> - <manvolnum>5</manvolnum></citerefentry> file the name resolution + </parameter> parameter of the <filename>smb.conf</filename> file the name resolution methods will be attempted in this order. </para></listitem> </varlistentry> @@ -200,8 +202,8 @@ <parameter>-I</parameter> options useful, as they allow you to control the FROM and TO parts of the message. </para> - <para>See the <parameter>message command</parameter> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle> - <manvolnum>5</manvolnum></citerefentry> for a description of how to handle incoming + <para>See the message command parameter in the <filename> + smb.conf(5)</filename> for a description of how to handle incoming WinPopup messages in Samba. </para> <para><emphasis>Note</emphasis>: Copy WinPopup into the startup group @@ -210,6 +212,70 @@ </varlistentry> <varlistentry> + <term>-i scope</term> + <listitem><para>This specifies a NetBIOS scope that smbclient will + use to communicate with when generating NetBIOS names. For details + on the use of NetBIOS scopes, see <filename>rfc1001.txt</filename> + and <filename>rfc1002.txt</filename>. + NetBIOS scopes are <emphasis>very</emphasis> rarely used, only set + this parameter if you are the system administrator in charge of all + the NetBIOS systems you communicate with. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-N</term> + <listitem><para>If specified, this parameter suppresses the normal + password prompt from the client to the user. This is useful when + accessing a service that does not require a password. </para> + + <para>Unless a password is specified on the command line or + this parameter is specified, the client will request a + password.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-n NetBIOS name</term> + <listitem><para>By default, the client will use the local + machine's hostname (in uppercase) as its NetBIOS name. This parameter + allows you to override the host name and use whatever NetBIOS + name you wish. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-d debuglevel</term> + <listitem><para><replaceable>debuglevel</replaceable> is an integer from 0 to 10, or + the letter 'A'. </para> + + <para>The default value if this parameter is not specified + is zero. </para> + + <para>The higher this value, the more detail will be logged to + the log files about the activities of the + client. At level 0, only critical errors and serious warnings will + be logged. Level 1 is a reasonable level for day to day running - + it generates a small amount of information about operations + carried out. </para> + + <para>Levels above 1 will generate considerable amounts of log + data, and should only be used when investigating a problem. + Levels above 3 are designed for use only by developers and + generate HUGE amounts of log data, most of which is extremely + cryptic. If <replaceable>debuglevel</replaceable> is set to the letter 'A', then <emphasis>all + </emphasis> debug messages will be printed. This setting + is for developers only (and people who <emphasis>really</emphasis> want + to know how the code works internally). </para> + + <para>Note that specifying this parameter here will override + the log level parameter in the <filename>smb.conf (5)</filename> + file. </para></listitem> + </varlistentry> + + + <varlistentry> <term>-p port</term> <listitem><para>This number is the TCP port number that will be used when making connections to the server. The standard (well-known) @@ -235,7 +301,13 @@ </varlistentry> - &stdarg.help; + + <varlistentry> + <term>-h</term><listitem> + <para>Print the usage message for the client. </para></listitem> + </varlistentry> + + <varlistentry> <term>-I IP-address</term> @@ -269,6 +341,59 @@ <varlistentry> + <term>-U username[%pass]</term> + <listitem><para>Sets the SMB username or username and password. + If %pass is not specified, The user will be prompted. The client + will first check the <envar>USER</envar> environment variable, then the + <envar>LOGNAME</envar> variable and if either exists, the + string is uppercased. Anything in these variables following a '%' + sign will be treated as the password. If these environment + variables are not found, the username <constant>GUEST</constant> + is used. </para> + + <para>If the password is not included in these environment + variables (using the %pass syntax), <command>smbclient</command> will look for + a <envar>PASSWD</envar> environment variable from which + to read the password. </para> + + <para>A third option is to use a credentials file which + contains the plaintext of the domain name, username and password. This + option is mainly provided for scripts where the admin doesn't + wish to pass the credentials on the command line or via environment + variables. If this method is used, make certain that the permissions + on the file restrict access from unwanted users. See the + <parameter>-A</parameter> for more details. </para> + + <para>Be cautious about including passwords in scripts or in + the <envar>PASSWD</envar> environment variable. Also, on + many systems the command line of a running process may be seen + via the <command>ps</command> command to be safe always allow + <command>smbclient</command> to prompt for a password and type + it in directly. </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-A filename</term><listitem><para>This option allows + you to specify a file from which to read the username, domain name, and + password used in the connection. The format of the file is + </para> + + <para><programlisting> +username = <value> +password = <value> +domain = <value> + </programlisting></para> + + + <para>If the domain parameter is missing the current workgroup name + is used instead. Make certain that the permissions on the file restrict + access from unwanted users. </para></listitem> + </varlistentry> + + + + <varlistentry> <term>-L</term> <listitem><para>This option allows you to look at what services are available on a server. You use it as <command>smbclient -L @@ -305,9 +430,16 @@ </para></listitem> </varlistentry> - &popt.common.samba; - &popt.common.credentials; - &popt.common.connection; + + + <varlistentry> + <term>-W WORKGROUP</term> + <listitem><para>Override the default workgroup (domain) specified + in the workgroup parameter of the <filename>smb.conf</filename> + file for this connection. This may be needed to connect to some + servers. </para></listitem> + </varlistentry> + <varlistentry> <term>-T tar options</term> @@ -387,7 +519,7 @@ <para><emphasis>Tar Filenames</emphasis></para> - <para>All file names can be given as DOS path names (with '\\' + <para>All file names can be given as DOS path names (with '\' as the component separator) or as UNIX path names (with '/' as the component separator). </para> @@ -455,7 +587,7 @@ <para><prompt>smb:\> </prompt></para> - <para>The backslash ("\\") indicates the current working directory + <para>The backslash ("\") indicates the current working directory on the server, and will change if the current working directory is changed. </para> @@ -908,8 +1040,8 @@ and writeable only by the user. </para> <para>To test the client, you will need to know the name of a - running SMB/CIFS server. It is possible to run <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> as an ordinary user - running that server as a daemon + running SMB/CIFS server. It is possible to run <command>smbd(8) + </command> as an ordinary user - running that server as a daemon on a user-accessible port (typically any port number over 1024) would provide a suitable test server. </para> </refsect1> @@ -931,7 +1063,8 @@ <refsect1> <title>VERSION</title> - <para>This man page is correct for version 2.2 of the Samba suite.</para> + <para>This man page is correct for version 2.2 of + the Samba suite.</para> </refsect1> @@ -945,11 +1078,11 @@ <para>The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + excellent piece of Open Source software, available at + <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 - was done by Alexander Bokovoy.</para> + Samba 2.2 was done by Gerald Carter</para> </refsect1> </refentry> |