diff options
Diffstat (limited to 'docs/docbook/manpages/smbclient.1.sgml')
| -rw-r--r-- | docs/docbook/manpages/smbclient.1.sgml | 104 |
1 files changed, 55 insertions, 49 deletions
diff --git a/docs/docbook/manpages/smbclient.1.sgml b/docs/docbook/manpages/smbclient.1.sgml index f82d59d29c..6cc7be654a 100644 --- a/docs/docbook/manpages/smbclient.1.sgml +++ b/docs/docbook/manpages/smbclient.1.sgml @@ -21,7 +21,6 @@ <arg choice="opt">-b <buffer size></arg> <arg choice="opt">-d debuglevel</arg> <arg choice="opt">-D Directory</arg> - <arg choice="opt">-S server</arg> <arg choice="opt">-U username</arg> <arg choice="opt">-W workgroup</arg> <arg choice="opt">-M <netbios name></arg> @@ -81,8 +80,8 @@ </para> <para>The server name is looked up according to either - the <parameter>-R</parameter> parameter to smbclient or - using the name resolve order parameter in the smb.conf file, + the <parameter>-R</parameter> parameter to <command>smbclient</command> or + 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> @@ -131,7 +130,7 @@ <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 - host names to IP addresses. The option takes a space separated + host names to IP addresses. The option takes a space-separated string of different name resolution options.</para> <para>The options are :"lmhosts", "host", "wins" and "bcast". They @@ -147,7 +146,7 @@ <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 depended for instance on IRIX or Solaris this + 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 @@ -172,7 +171,7 @@ <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 smb.conf 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> @@ -216,7 +215,8 @@ <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 rfc1001.txt and rfc1002.txt. + 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> @@ -247,7 +247,7 @@ <varlistentry> <term>-d debuglevel</term> - <listitem><para>debuglevel is an integer from 0 to 10, or + <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 @@ -264,13 +264,13 @@ 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 debuglevel is set to the letter 'A', then <emphasis>all + 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 <command>smb.conf (5)</command> + the log level parameter in the <filename>smb.conf (5)</filename> file. </para></listitem> </varlistentry> @@ -286,7 +286,7 @@ <varlistentry> <term>-l logfilename</term> - <listitem><para>If specified, logfilename specifies a base filename + <listitem><para>If specified, <replaceable>logfilename</replaceable> specifies a base filename into which operational data from the running client will be logged. </para> @@ -311,7 +311,7 @@ <varlistentry> <term>-I IP-address</term> - <listitem><para>IP address is the address of the server to connect to. + <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to. It should be specified in standard "a.b.c.d" notation. </para> <para>Normally the client would attempt to locate a named @@ -344,31 +344,31 @@ <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 USER environment variable, then the - <parameter>$LOGNAME</parameter> variable and if either exist, the + 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 environmental + 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), rpcclient will look for - a <parameter>$PASSWD</parameter> environment variable from which + <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 username and password. This option is mainly provided for scripts where the admin doesn't - desire to pass the credentials on the command line or via environment + 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 <parameter>$PASSWD</parameter> environment variable. Also, on + 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>rpcclient</command> to prompt for a password and type + <command>smbclient</command> to prompt for a password and type it in directly. </para></listitem> </varlistentry> @@ -397,14 +397,14 @@ password = <value> are available on a server. You use it as <command>smbclient -L host</command> and a list should appear. The <parameter>-I </parameter> option may be useful if your NetBIOS names don't - match your tcp/ip dns host names or if you are trying to reach a + match your TCP/IP DNS host names or if you are trying to reach a host on another network. </para></listitem> </varlistentry> <varlistentry> <term>-t terminal code</term> - <listitem><para>This option tells smbclient how to interpret + <listitem><para>This option tells <command>smbclient</command> how to interpret filenames coming from the remote server. Usually Asian language multibyte UNIX implementations use different character sets than SMB/CIFS servers (<emphasis>EUC</emphasis> instead of <emphasis> @@ -488,7 +488,7 @@ password = <value> </para></listitem> <listitem><para><parameter>r</parameter> - Regular expression include - or exclude. Uses regular regular expression matching for + or exclude. Uses regular expression matching for excluding or excluding files if compiled with HAVE_REGEX_H. However this mode can be very slow. If not compiled with HAVE_REGEX_H, does a limited wildcard match on '*' and '?'. @@ -511,7 +511,7 @@ password = <value> <para><command>smbclient</command>'s tar option now supports long file names both on backup and restore. However, the full path name of the file must be less than 1024 bytes. Also, when - a tar archive is created, smbclient's tar option places all + a tar archive is created, <command>smbclient</command>'s tar option places all files in the archive with relative names, not absolute names. </para> @@ -523,10 +523,10 @@ password = <value> <para><emphasis>Examples</emphasis></para> - <para>Restore from tar file backup.tar into myshare on mypc + <para>Restore from tar file <filename>backup.tar</filename> into myshare on mypc (no password on share). </para> - <para><command>smbclient //mypc/myshare "" -N -Tx backup.tar + <para><command>smbclient //mypc/yshare "" -N -Tx backup.tar </command></para> <para>Restore everything except <filename>users/docs</filename> @@ -566,7 +566,7 @@ password = <value> <varlistentry> <term>-c command string</term> - <listitem><para>command string is a semicolon separated list of + <listitem><para>command string is a semicolon-separated list of commands to be executed instead of prompting from stdin. <parameter> -N</parameter> is implied by <parameter>-c</parameter>.</para> @@ -616,7 +616,7 @@ password = <value> <variablelist> <varlistentry> <term>? [command]</term> - <listitem><para>If "command" is specified, the ? command will display + <listitem><para>If <replaceable>command</replaceable> is specified, the ? command will display a brief informative message about the specified command. If no command is specified, a list of available commands will be displayed. </para></listitem> @@ -625,7 +625,7 @@ password = <value> <varlistentry> <term>! [shell command]</term> - <listitem><para>If "shell command" is specified, the ! + <listitem><para>If <replaceable>shell command</replaceable> is specified, the ! command will execute a shell locally and run the specified shell command. If no command is specified, a local shell will be run. </para></listitem> @@ -648,14 +648,14 @@ password = <value> <varlistentry> <term>del <mask></term> <listitem><para>The client will request that the server attempt - to delete all files matching "mask" from the current working + to delete all files matching <replaceable>mask</replaceable> from the current working directory on the server. </para></listitem> </varlistentry> <varlistentry> <term>dir <mask></term> - <listitem><para>A list of the files matching "mask" in the current + <listitem><para>A list of the files matching <replaceable>mask</replaceable> in the current working directory on the server will be retrieved from the server and displayed. </para></listitem> </varlistentry> @@ -670,9 +670,9 @@ password = <value> <varlistentry> <term>get <remote file name> [local file name]</term> - <listitem><para>Copy the file called "remote file name" from + <listitem><para>Copy the file called <filename>remote file name</filename> from the server to the machine running the client. If specified, name - the local copy "local file name". Note that all transfers in + the local copy <filename>local file name</filename>. Note that all transfers in <command>smbclient</command> are binary. See also the lowercase command. </para></listitem> </varlistentry> @@ -687,7 +687,7 @@ password = <value> <varlistentry> <term>lcd [directory name]</term> - <listitem><para>If "directory name" is specified, the current + <listitem><para>If <replaceable>directory name</replaceable> is specified, the current working directory on the local machine will be changed to the directory specified. This operation will fail if for any reason the specified directory is inaccessible. </para> @@ -751,13 +751,13 @@ password = <value> <varlistentry> <term>mget <mask></term> - <listitem><para>Copy all files matching mask from the server to + <listitem><para>Copy all files matching <replaceable>mask</replaceable> from the server to the machine running the client. </para> - <para>Note that mask is interpreted differently during recursive + <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive operation and non-recursive operation - refer to the recurse and mask commands for more information. Note that all transfers in - smbclient are binary. See also the lowercase command. </para></listitem> + <command>smbclient</command> are binary. See also the lowercase command. </para></listitem> </varlistentry> @@ -770,13 +770,13 @@ password = <value> <varlistentry> <term>mput <mask></term> - <listitem><para>Copy all files matching mask in the current working + <listitem><para>Copy all files matching <replaceable>mask</replaceable> in the current working directory on the local machine to the current working directory on the server. </para> - <para>Note that mask is interpreted differently during recursive + <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive operation and non-recursive operation - refer to the recurse and mask - commands for more information. Note that all transfers in smbclient + commands for more information. Note that all transfers in <command>smbclient</command> are binary. </para></listitem> </varlistentry> @@ -813,10 +813,10 @@ password = <value> <varlistentry> <term>put <local file name> [remote file name]</term> - <listitem><para>Copy the file called "local file name" from the + <listitem><para>Copy the file called <filename>local file name</filename> from the machine running the client to the server. If specified, - name the remote copy "remote file name". Note that all transfers - in smbclient are binary. See also the lowercase command. + name the remote copy <filename>remote file name</filename>. Note that all transfers + in <command>smbclient</command> are binary. See also the lowercase command. </para></listitem> </varlistentry> @@ -863,7 +863,7 @@ password = <value> <varlistentry> <term>rm <mask></term> - <listitem><para>Remove all files matching mask from the current + <listitem><para>Remove all files matching <replaceable>mask</replaceable> from the current working directory on the server. </para></listitem> </varlistentry> @@ -890,7 +890,7 @@ password = <value> <term>blocksize <blocksize></term> <listitem><para>Blocksize. Must be followed by a valid (greater than zero) blocksize. Causes tar file to be written out in - blocksize*TBLOCK (usually 512 byte) blocks. </para></listitem> + <replaceable>blocksize</replaceable>*TBLOCK (usually 512 byte) blocks. </para></listitem> </varlistentry> @@ -938,16 +938,22 @@ password = <value> <refsect1> <title>ENVIRONMENT VARIABLES</title> - <para>The variable <parameter>$USER</parameter> may contain the + <para>The variable <envar>USER</envar> may contain the username of the person using the client. This information is used only if the protocol level is high enough to support session-level passwords.</para> - <para>The variable <parameter>$PASSWD</parameter> may contain + <para>The variable <envar>PASSWD</envar> may contain the password of the person using the client. This information is used only if the protocol level is high enough to support session-level passwords. </para> + + <para>The variable <envar>LIBSMB_PROG</envar> may contain + the path, executed with system(), which the client should connect + to instead of connecting to a server. This functionality is primarily + intended as a development aid, and works best when using a LMHOSTS + file</para> </refsect1> @@ -970,7 +976,7 @@ password = <value> <para>To test the client, you will need to know the name of a running SMB/CIFS server. It is possible to run <command>smbd(8) - </command> an ordinary user - running that server as a daemon + </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> |