summaryrefslogtreecommitdiff
path: root/docs/htmldocs/smbclient.1.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/htmldocs/smbclient.1.html')
-rw-r--r--docs/htmldocs/smbclient.1.html463
1 files changed, 237 insertions, 226 deletions
diff --git a/docs/htmldocs/smbclient.1.html b/docs/htmldocs/smbclient.1.html
index 4a287acf1d..9ea84de950 100644
--- a/docs/htmldocs/smbclient.1.html
+++ b/docs/htmldocs/smbclient.1.html
@@ -172,34 +172,6 @@ CLASS="PARAMETER"
</P
></DD
><DT
->-s smb.conf</DT
-><DD
-><P
->Specifies the location of the all
- important <SPAN
-CLASS="CITEREFENTRY"
-><SPAN
-CLASS="REFENTRYTITLE"
->smb.conf</SPAN
->(5)</SPAN
-> file. </P
-></DD
-><DT
->-O socket options</DT
-><DD
-><P
->TCP socket options to set on the client
- socket. See the socket options parameter in
- the <SPAN
-CLASS="CITEREFENTRY"
-><SPAN
-CLASS="REFENTRYTITLE"
->smb.conf</SPAN
->(5)</SPAN
-> manual page for the list of valid
- options. </P
-></DD
-><DT
>-R &#60;name resolve order&#62;</DT
><DD
><P
@@ -369,102 +341,6 @@ CLASS="EMPHASIS"
messages. </P
></DD
><DT
->-i scope</DT
-><DD
-><P
->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 <TT
-CLASS="FILENAME"
->rfc1001.txt</TT
->
- and <TT
-CLASS="FILENAME"
->rfc1002.txt</TT
->.
- NetBIOS scopes are <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->very</I
-></SPAN
-> rarely used, only set
- this parameter if you are the system administrator in charge of all
- the NetBIOS systems you communicate with. </P
-></DD
-><DT
->-N</DT
-><DD
-><P
->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. </P
-><P
->Unless a password is specified on the command line or
- this parameter is specified, the client will request a
- password.</P
-></DD
-><DT
->-n NetBIOS name</DT
-><DD
-><P
->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. </P
-></DD
-><DT
->-d debuglevel</DT
-><DD
-><P
-><VAR
-CLASS="REPLACEABLE"
->debuglevel</VAR
-> is an integer from 0 to 10, or
- the letter 'A'. </P
-><P
->The default value if this parameter is not specified
- is zero. </P
-><P
->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. </P
-><P
->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 <VAR
-CLASS="REPLACEABLE"
->debuglevel</VAR
-> is set to the letter 'A', then <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->all
- </I
-></SPAN
-> debug messages will be printed. This setting
- is for developers only (and people who <SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->really</I
-></SPAN
-> want
- to know how the code works internally). </P
-><P
->Note that specifying this parameter here will override
- the log level parameter in the <TT
-CLASS="FILENAME"
->smb.conf (5)</TT
->
- file. </P
-></DD
-><DT
>-p port</DT
><DD
><P
@@ -497,10 +373,10 @@ CLASS="FILENAME"
</P
></DD
><DT
->-h</DT
+>-h|--help</DT
><DD
><P
->Print the usage message for the client. </P
+>Print a summary of command line options.</P
></DD
><DT
>-I IP-address</DT
@@ -539,86 +415,6 @@ CLASS="PARAMETER"
- typically the user's tty. </P
></DD
><DT
->-U username[%pass]</DT
-><DD
-><P
->Sets the SMB username or username and password.
- If %pass is not specified, The user will be prompted. The client
- will first check the <VAR
-CLASS="ENVAR"
->USER</VAR
-> environment variable, then the
- <VAR
-CLASS="ENVAR"
->LOGNAME</VAR
-> 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 <CODE
-CLASS="CONSTANT"
->GUEST</CODE
->
- is used. </P
-><P
->If the password is not included in these environment
- variables (using the %pass syntax), <B
-CLASS="COMMAND"
->smbclient</B
-> will look for
- a <VAR
-CLASS="ENVAR"
->PASSWD</VAR
-> environment variable from which
- to read the password. </P
-><P
->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
- <VAR
-CLASS="PARAMETER"
->-A</VAR
-> for more details. </P
-><P
->Be cautious about including passwords in scripts or in
- the <VAR
-CLASS="ENVAR"
->PASSWD</VAR
-> environment variable. Also, on
- many systems the command line of a running process may be seen
- via the <B
-CLASS="COMMAND"
->ps</B
-> command to be safe always allow
- <B
-CLASS="COMMAND"
->smbclient</B
-> to prompt for a password and type
- it in directly. </P
-></DD
-><DT
->-A filename</DT
-><DD
-><P
->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
- </P
-><P
-><PRE
-CLASS="PROGRAMLISTING"
->username = &#60;value&#62;
-password = &#60;value&#62;
-domain = &#60;value&#62;</PRE
-></P
-><P
->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. </P
-></DD
-><DT
>-L</DT
><DD
><P
@@ -680,18 +476,241 @@ CLASS="COMMAND"
</P
></DD
><DT
->-W WORKGROUP</DT
+>-V</DT
+><DD
+><P
+>Prints the version number for
+<B
+CLASS="COMMAND"
+>smbd</B
+>.</P
+></DD
+><DT
+>-s &#60;configuration file&#62;</DT
+><DD
+><P
+>The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See <A
+HREF="smb.conf.5.html"
+TARGET="_top"
+><TT
+CLASS="FILENAME"
+>smb.conf(5)</TT
+></A
+> for more information.
+The default configuration file name is determined at
+compile time.</P
+></DD
+><DT
+>-d|--debug=debuglevel</DT
+><DD
+><P
+><VAR
+CLASS="REPLACEABLE"
+>debuglevel</VAR
+> is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.</P
+><P
+>The higher this value, the more detail will be
+logged to the log files about the activities of the
+server. 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.</P
+><P
+>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.</P
+><P
+>Note that specifying this parameter here will
+override the <A
+HREF="smb.conf.5.html#loglevel"
+TARGET="_top"
+>log
+level</A
+> parameter in the <A
+HREF="smb.conf.5.html"
+TARGET="_top"
+><TT
+CLASS="FILENAME"
+>smb.conf(5)</TT
+></A
+> file.</P
+></DD
+><DT
+>-l|--logfile=logbasename</DT
+><DD
+><P
+>File name for log/debug files. The extension
+<CODE
+CLASS="CONSTANT"
+>".client"</CODE
+> will be appended. The log file is
+never removed by the client.</P
+></DD
+><DT
+>-N</DT
+><DD
+><P
+>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. </P
+><P
+>Unless a password is specified on the command line or
+this parameter is specified, the client will request a
+password.</P
+></DD
+><DT
+>-k</DT
+><DD
+><P
+>Try to authenticate with kerberos. Only useful in
+an Active Directory environment.</P
+></DD
+><DT
+>-A|--authfile=filename</DT
><DD
><P
->Override the default workgroup (domain) specified
- in the workgroup parameter of the <SPAN
+>This option allows
+you to specify a file from which to read the username and
+password used in the connection. The format of the file is</P
+><P
+><PRE
+CLASS="PROGRAMLISTING"
+>username = &#60;value&#62;
+password = &#60;value&#62;
+domain = &#60;value&#62;</PRE
+></P
+><P
+>Make certain that the permissions on the file restrict
+access from unwanted users. </P
+></DD
+><DT
+>-U|--user=username[%password]</DT
+><DD
+><P
+>Sets the SMB username or username and password. </P
+><P
+>If %password is not specified, the user will be prompted. The
+client will first check the <VAR
+CLASS="ENVAR"
+>USER</VAR
+> environment variable, then the
+<VAR
+CLASS="ENVAR"
+>LOGNAME</VAR
+> variable and if either exists, the
+string is uppercased. If these environmental variables are not
+found, the username <CODE
+CLASS="CONSTANT"
+>GUEST</CODE
+> is used. </P
+><P
+>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 does not
+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
+<VAR
+CLASS="PARAMETER"
+>-A</VAR
+> for more details. </P
+><P
+>Be cautious about including passwords in scripts. Also, on
+many systems the command line of a running process may be seen
+via the <B
+CLASS="COMMAND"
+>ps</B
+> command. To be safe always allow
+<B
+CLASS="COMMAND"
+>rpcclient</B
+> to prompt for a password and type
+it in directly. </P
+></DD
+><DT
+>-n &#60;primary NetBIOS name&#62;</DT
+><DD
+><P
+>This option allows you to override
+the NetBIOS name that Samba uses for itself. This is identical
+to setting the <A
+HREF="smb.conf.5.html#netbiosname"
+TARGET="_top"
+><VAR
+CLASS="PARAMETER"
+>NetBIOS
+name</VAR
+></A
+> parameter in the <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>smb.conf</SPAN
>(5)</SPAN
-> file for this connection. This may be
- needed to connect to some servers. </P
+> file. However, a command
+line setting will take precedence over settings in
+<SPAN
+CLASS="CITEREFENTRY"
+><SPAN
+CLASS="REFENTRYTITLE"
+>smb.conf</SPAN
+>(5)</SPAN
+>.</P
+></DD
+><DT
+>-i &#60;scope&#62;</DT
+><DD
+><P
+>This specifies a NetBIOS scope that
+<B
+CLASS="COMMAND"
+>nmblookup</B
+> will use to communicate with when
+generating NetBIOS names. For details on the use of NetBIOS
+scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
+<SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>very</I
+></SPAN
+> rarely used, only set this parameter
+if you are the system administrator in charge of all the
+NetBIOS systems you communicate with.</P
+></DD
+><DT
+>-W|--workgroup=domain</DT
+><DD
+><P
+>Set the SMB domain of the username. This
+overrides the default domain which is the domain defined in
+smb.conf. If the domain specified is the same as the servers
+NetBIOS name, it causes the client to log on using the servers local
+SAM (as opposed to the Domain SAM). </P
+></DD
+><DT
+>-O socket options</DT
+><DD
+><P
+>TCP socket options to set on the client
+socket. See the socket options parameter in
+the <SPAN
+CLASS="CITEREFENTRY"
+><SPAN
+CLASS="REFENTRYTITLE"
+>smb.conf</SPAN
+>(5)</SPAN
+> manual page for the list of valid
+options. </P
></DD
><DT
>-T tar options</DT
@@ -958,21 +977,13 @@ CLASS="COMMAND"
>-c 'print -'</B
>. </P
></DD
-><DT
->-k</DT
-><DD
-><P
-> Try to authenticate with kerberos. Only useful in
- an Active Directory environment.
- </P
-></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN336"
+NAME="AEN344"
></A
><H2
>OPERATIONS</H2
@@ -1438,7 +1449,7 @@ CLASS="REPLACEABLE"
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN527"
+NAME="AEN535"
></A
><H2
>NOTES</H2
@@ -1459,7 +1470,7 @@ NAME="AEN527"
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN532"
+NAME="AEN540"
></A
><H2
>ENVIRONMENT VARIABLES</H2
@@ -1492,7 +1503,7 @@ CLASS="ENVAR"
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN540"
+NAME="AEN548"
></A
><H2
>INSTALLATION</H2
@@ -1536,7 +1547,7 @@ CLASS="REFENTRYTITLE"
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN552"
+NAME="AEN560"
></A
><H2
>DIAGNOSTICS</H2
@@ -1552,7 +1563,7 @@ NAME="AEN552"
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN556"
+NAME="AEN564"
></A
><H2
>VERSION</H2
@@ -1562,7 +1573,7 @@ NAME="AEN556"
><DIV
CLASS="REFSECT1"
><A
-NAME="AEN559"
+NAME="AEN567"
></A
><H2
>AUTHOR</H2