man pages: Move 'smbsh' man page to the examples directory.
authorKarolin Seeger <kseeger@samba.org>
Tue, 17 Jun 2008 11:18:17 +0000 (13:18 +0200)
committerKarolin Seeger <kseeger@samba.org>
Tue, 17 Jun 2008 11:32:01 +0000 (13:32 +0200)
smbsh.c is located in the examples directory. It does not make sense
to install a man page without installing the tool itself.

This fixes bug #4724.

Karolin
(cherry picked from commit 797ed744b15c94fa4831d9796b40bb0ab5df55b7)
(cherry picked from commit 23981be7a009dc9e056ba2e12c5df6e3a13ab193)

examples/libsmbclient/smbwrapper/smbsh.1 [new file with mode: 0644]
examples/libsmbclient/smbwrapper/smbsh.1.html [new file with mode: 0644]
examples/libsmbclient/smbwrapper/smbsh.1.xml [moved from docs-xml/manpages-3/smbsh.1.xml with 100% similarity]

diff --git a/examples/libsmbclient/smbwrapper/smbsh.1 b/examples/libsmbclient/smbwrapper/smbsh.1
new file mode 100644 (file)
index 0000000..368a245
--- /dev/null
@@ -0,0 +1,203 @@
+.\"     Title: smbsh
+.\"    Author:
+.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
+.\"      Date: 06/12/2008
+.\"    Manual: User Commands
+.\"    Source: Samba 3.2
+.\"
+.TH "SMBSH" "1" "06/12/2008" "Samba 3\.2" "User Commands"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+smbsh - Allows access to remote SMB shares using UNIX commands
+.SH "SYNOPSIS"
+.HP 1
+smbsh [\-W\ workgroup] [\-U\ username] [\-P\ prefix] [\-R\ <name\ resolve\ order>] [\-d\ <debug\ level>] [\-l\ logdir] [\-L\ libdir]
+.SH "DESCRIPTION"
+.PP
+This tool is part of the
+\fBsamba\fR(7)
+suite\.
+.PP
+smbsh
+allows you to access an NT filesystem using UNIX commands such as
+ls,
+egrep, and
+rcp\. You must use a shell that is dynamically linked in order for
+smbsh
+to work correctly\.
+.SH "OPTIONS"
+.PP
+\-W WORKGROUP
+.RS 4
+Override the default workgroup specified in the workgroup parameter of the
+\fBsmb.conf\fR(5)
+file for this session\. This may be needed to connect to some servers\.
+.RE
+.PP
+\-U username[%pass]
+.RS 4
+Sets the SMB username or username and password\. If this option is not specified, the user will be prompted for both the username and the password\. If %pass is not specified, the user will be prompted for the password\.
+.RE
+.PP
+\-P prefix
+.RS 4
+This option allows the user to set the directory prefix for SMB access\. The default value if this option is not specified is
+\fIsmb\fR\.
+.RE
+.PP
+\-s <configuration file>
+.RS 4
+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
+\fIsmb\.conf\fR
+for more information\. The default configuration file name is determined at compile time\.
+.RE
+.PP
+\-d|\-\-debuglevel=level
+.RS 4
+\fIlevel\fR
+is an integer from 0 to 10\. The default value if this parameter is not specified is 0\.
+.sp
+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\.
+.sp
+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\.
+.sp
+Note that specifying this parameter here will override the
+\fIlog level\fR
+parameter in the
+\fIsmb\.conf\fR
+file\.
+.RE
+.PP
+\-R <name resolve order>
+.RS 4
+This option is used to determine what naming services and in what order to resolve host names to IP addresses\. The option takes a space\-separated string of different name resolution options\.
+.sp
+The options are: "lmhosts", "host", "wins" and "bcast"\. They cause names to be resolved as follows :
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBlmhosts\fR: 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
+\fBlmhosts\fR(5)
+for details) then any name type matches for lookup\.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBhost\fR: Do a standard host name to IP address resolution, using the system
+\fI/etc/hosts\fR, 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
+\fI/etc/nsswitch\.conf \fR
+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\.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBwins\fR: Query a name with the IP address listed in the
+\fIwins server\fR
+parameter\. If no WINS server has been specified this method will be ignored\.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fBbcast\fR: Do a broadcast on each of the known local interfaces listed in the
+\fIinterfaces\fR
+parameter\. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\.
+.sp
+.RE
+If this parameter is not set then the name resolve order defined in the
+\fIsmb\.conf\fR
+file parameter (\fIname resolve order\fR) will be used\.
+.sp
+The default order is lmhosts, host, wins, bcast\. Without this parameter or any entry in the
+\fIname resolve order\fR
+parameter of the
+\fIsmb\.conf\fR
+file, the name resolution methods will be attempted in this order\.
+.RE
+.PP
+\-L libdir
+.RS 4
+This parameter specifies the location of the shared libraries used by
+smbsh\. The default value is specified at compile time\.
+.RE
+.SH "EXAMPLES"
+.PP
+To use the
+smbsh
+command, execute
+smbsh
+from the prompt and enter the username and password that authenticates you to the machine running the Windows NT operating system\.
+.sp
+.RS 4
+.nf
+system% \fBsmbsh\fR
+Username: \fBuser\fR
+Password: \fBXXXXXXX\fR
+.fi
+.RE
+.PP
+Any dynamically linked command you execute from this shell will access the
+\fI/smb\fR
+directory using the smb protocol\. For example, the command
+ls /smb
+will show a list of workgroups\. The command
+ls /smb/MYGROUP
+will show all the machines in the workgroup MYGROUP\. The command
+ls /smb/MYGROUP/<machine\-name>
+will show the share names for that machine\. You could then, for example, use the
+cd
+command to change directories,
+vi
+to edit files, and
+rcp
+to copy files\.
+.SH "VERSION"
+.PP
+This man page is correct for version 3 of the Samba suite\.
+.SH "BUGS"
+.PP
+smbsh
+works by intercepting the standard libc calls with the dynamically loaded versions in
+\fI smbwrapper\.o\fR\. Not all calls have been "wrapped", so some programs may not function correctly under
+smbsh\.
+.PP
+Programs which are not dynamically linked cannot make use of
+smbsh\'s functionality\. Most versions of UNIX have a
+file
+command that will describe how a program was linked\.
+.SH "SEE ALSO"
+.PP
+\fBsmbd\fR(8),
+\fBsmb.conf\fR(5)
+.SH "AUTHOR"
+.PP
+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\.
+.PP
+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
+ftp://ftp\.icce\.rug\.nl/pub/unix/) 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\.
diff --git a/examples/libsmbclient/smbwrapper/smbsh.1.html b/examples/libsmbclient/smbwrapper/smbsh.1.html
new file mode 100644 (file)
index 0000000..a134511
--- /dev/null
@@ -0,0 +1,108 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbsh</title><link rel="stylesheet" href="../samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbsh.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbsh &#8212; Allows access to remote SMB shares
+       using UNIX commands</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbsh</code> [-W workgroup] [-U username] [-P prefix] [-R &lt;name resolve order&gt;] [-d &lt;debug level&gt;] [-l logdir] [-L libdir]</p></div></div><div class="refsect1" lang="en"><a name="id2507195"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">smbsh</code> allows you to access an NT filesystem
+       using UNIX commands such as <code class="literal">ls</code>, <code class="literal">
+       egrep</code>, and <code class="literal">rcp</code>. You must use a
+       shell that is dynamically linked in order for <code class="literal">smbsh</code>
+       to work correctly.</p></div><div class="refsect1" lang="en"><a name="id2507248"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-W WORKGROUP</span></dt><dd><p>Override the default workgroup specified in the
+               workgroup parameter of the <a class="citerefentry" href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file
+               for this session. This may be needed to connect to some
+               servers. </p></dd><dt><span class="term">-U username[%pass]</span></dt><dd><p>Sets the SMB username or username and password.
+               If this option is not specified, the user will be prompted for
+               both the username and the password.  If %pass is not specified,
+               the user will be prompted for the password.
+               </p></dd><dt><span class="term">-P prefix</span></dt><dd><p>This option allows
+               the user to set the directory prefix for SMB access. The
+               default value if this option is not specified is
+               <span class="emphasis"><em>smb</em></span>.
+               </p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></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 <code class="filename">smb.conf</code> for more information.
+The default configuration file name is determined at
+compile time.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer
+from 0 to 10. The default value if this parameter is
+not specified is 0.</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 class="link" href="smb.conf.5.html#LOGLEVEL">log level</a> parameter
+in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-R &lt;name resolve order&gt;</span></dt><dd><p>This option is used to determine what naming
+services and in what order to resolve
+host names to IP addresses. The option takes a space-separated
+string of different name resolution options.</p><p>The options are: "lmhosts", "host", "wins" and "bcast".
+They cause names to be resolved as follows :</p><div class="itemizedlist"><ul type="disc"><li><p><code class="constant">lmhosts</code>:
+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 <a class="citerefentry" href="lmhosts.5.html"><span class="citerefentry"><span class="refentrytitle">lmhosts</span>(5)</span></a>     for details)
+then any name type matches for lookup.
+</p></li><li><p><code class="constant">host</code>:
+Do a standard host name to IP address resolution, using
+the system <code class="filename">/etc/hosts</code>, 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 <code class="filename">/etc/nsswitch.conf
+</code> 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.
+</p></li><li><p><code class="constant">wins</code>:
+Query a name with the IP address listed in the
+<em class="parameter"><code>wins server</code></em> parameter.  If no
+WINS server has been specified this method will be
+ignored.
+</p></li><li><p><code class="constant">bcast</code>:
+Do a broadcast on each of the known local interfaces
+listed in the <em class="parameter"><code>interfaces</code></em>
+parameter. This is the least reliable of the name
+resolution methods as it depends on the target host
+being on a locally connected subnet.
+</p></li></ul></div><p>If this parameter is not set then the name resolve order
+defined in the <code class="filename">smb.conf</code> file parameter
+(<a class="link" href="smb.conf.5.html#NAMERESOLVEORDER">name resolve order</a>) will be used.
+</p><p>The default order is lmhosts, host, wins, bcast. Without
+this parameter or any entry in the <a class="link" href="smb.conf.5.html#NAMERESOLVEORDER">name resolve order</a> parameter of the <code class="filename">smb.conf</code> file, the name
+resolution methods will be attempted in this order. </p></dd><dt><span class="term">-L libdir</span></dt><dd><p>This parameter specifies the location of the
+               shared libraries used by <code class="literal">smbsh</code>. The default
+               value is specified at compile time.
+               </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2506378"></a><h2>EXAMPLES</h2><p>To use the <code class="literal">smbsh</code> command, execute <code class="literal">
+       smbsh</code> from the prompt and enter the username and password
+       that authenticates you to the machine running the Windows NT
+       operating system.
+</p><pre class="programlisting">
+<code class="prompt">system% </code><strong class="userinput"><code>smbsh</code></strong>
+<code class="prompt">Username: </code><strong class="userinput"><code>user</code></strong>
+<code class="prompt">Password: </code><strong class="userinput"><code>XXXXXXX</code></strong>
+</pre><p>Any dynamically linked command you execute from
+       this shell will access the <code class="filename">/smb</code> directory
+       using the smb protocol. For example, the command <code class="literal">ls /smb
+       </code> will show a list of workgroups. The command
+       <code class="literal">ls /smb/MYGROUP </code> will show all the machines in
+       the  workgroup MYGROUP. The command
+       <code class="literal">ls /smb/MYGROUP/&lt;machine-name&gt;</code> will show the share
+       names for that machine. You could then, for example, use the <code class="literal">
+       cd</code> command to change directories, <code class="literal">vi</code> to
+       edit files, and <code class="literal">rcp</code>  to copy files.</p></div><div class="refsect1" lang="en"><a name="id2506489"></a><h2>VERSION</h2><p>This man page is correct for version 3 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id2506500"></a><h2>BUGS</h2><p><code class="literal">smbsh</code> works by intercepting the standard
+       libc calls with the dynamically loaded versions in <code class="filename">
+       smbwrapper.o</code>. Not all calls have been "wrapped", so
+       some programs may not function correctly under <code class="literal">smbsh
+       </code>.</p><p>Programs which are not dynamically linked cannot make
+       use of <code class="literal">smbsh</code>'s functionality. Most versions
+       of UNIX have a <code class="literal">file</code> command that will
+       describe how a program was linked.</p></div><div class="refsect1" lang="en"><a name="id2506547"></a><h2>SEE ALSO</h2><p><a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, <a class="citerefentry" href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a></p></div><div class="refsect1" lang="en"><a name="id2506570"></a><h2>AUTHOR</h2><p>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.</p><p>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 <a class="ulink" href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">
+       ftp://ftp.icce.rug.nl/pub/unix/</a>) 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.</p></div></div></body></html>