summaryrefslogtreecommitdiff
path: root/docs/docbook/manpages/smbsh.1.sgml
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2003-05-01 14:00:10 +0000
committerJelmer Vernooij <jelmer@samba.org>2003-05-01 14:00:10 +0000
commitdbd241f3421731692cbeae96db9d3bd11bc4f602 (patch)
treec9a7fabb8502c567f8f336efce103926d0326b4f /docs/docbook/manpages/smbsh.1.sgml
parent5e887315cffee97cba366e304ce85458c5fea6aa (diff)
downloadsamba-dbd241f3421731692cbeae96db9d3bd11bc4f602.tar.gz
samba-dbd241f3421731692cbeae96db9d3bd11bc4f602.tar.bz2
samba-dbd241f3421731692cbeae96db9d3bd11bc4f602.zip
Merge over Alexanders' conversion to Docbook XML
(This used to be commit b0e3fa7a3657a82a208fdee6cb587705db2b5ac4)
Diffstat (limited to 'docs/docbook/manpages/smbsh.1.sgml')
-rw-r--r--docs/docbook/manpages/smbsh.1.sgml235
1 files changed, 0 insertions, 235 deletions
diff --git a/docs/docbook/manpages/smbsh.1.sgml b/docs/docbook/manpages/smbsh.1.sgml
deleted file mode 100644
index c40609be4f..0000000000
--- a/docs/docbook/manpages/smbsh.1.sgml
+++ /dev/null
@@ -1,235 +0,0 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
-<refentry id="smbsh">
-
-<refmeta>
- <refentrytitle>smbsh</refentrytitle>
- <manvolnum>1</manvolnum>
-</refmeta>
-
-
-<refnamediv>
- <refname>smbsh</refname>
- <refpurpose>Allows access to Windows NT filesystem
- using UNIX commands</refpurpose>
-</refnamediv>
-
-<refsynopsisdiv>
- <cmdsynopsis>
- <command>smbsh</command>
- <arg choice="opt">-W workgroup</arg>
- <arg choice="opt">-U username</arg>
- <arg choice="opt">-P prefix</arg>
- <arg choice="opt">-R &lt;name resolve order&gt;</arg>
- <arg choice="opt">-d &lt;debug level&gt;</arg>
- <arg choice="opt">-l logfile</arg>
- <arg choice="opt">-L libdir</arg>
- </cmdsynopsis>
-</refsynopsisdiv>
-
-<refsect1>
- <title>DESCRIPTION</title>
-
- <para>This tool is part of the <ulink url="samba.7.html">
- Samba</ulink> suite.</para>
-
- <para><command>smbsh</command> allows you to access an NT filesystem
- using UNIX commands such as <command>ls</command>, <command>
- egrep</command>, and <command>rcp</command>. You must use a
- shell that is dynamically linked in order for <command>smbsh</command>
- to work correctly.</para>
-</refsect1>
-
-<refsect1>
- <title>OPTIONS</title>
-
- <variablelist>
- <varlistentry>
- <term>-W WORKGROUP</term>
- <listitem><para>Override the default workgroup specified in the
- workgroup parameter of the <filename>smb.conf</filename> file
- for this session. This may be needed to connect to some
- servers. </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-U username[%pass]</term>
- <listitem><para>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.
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-P prefix</term><listitem><para>This option allows
- the user to set the directory prefix for SMB access. The
- default value if this option is not specified is
- <emphasis>smb</emphasis>.
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-R &lt;name resolve order&gt;</term>
- <listitem><para>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.</para>
-
- <para>The options are :"lmhosts", "host", "wins" and "bcast".
- They cause names to be resolved as follows :</para>
-
- <itemizedlist>
- <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 <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 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 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>
- </itemizedlist>
-
- <para>If this parameter is not set then the name resolve order
- 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. Without
- this parameter or any entry in the <parameter>name resolve order
- </parameter> parameter of the <filename>smb.conf</filename>
- file, the name resolution methods will be attempted in this
- order. </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-d &lt;debug level&gt;</term>
- <listitem><para>debug level is an integer from 0 to 10.</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
- about the activities of <command>nmblookup</command>. At level
- 0, only critical errors and serious warnings will be logged.
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-l logfilename</term>
- <listitem><para>If specified causes all debug messages to be
- written to the file specified by <replaceable>logfilename
- </replaceable>. If not specified then all messages will be
- written to<replaceable>stderr</replaceable>.
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-L libdir</term>
- <listitem><para>This parameter specifies the location of the
- shared libraries used by <command>smbsh</command>. The default
- value is specified at compile time.
- </para></listitem>
- </varlistentry>
-
- </variablelist>
-</refsect1>
-
-<refsect1>
- <title>EXAMPLES</title>
-
- <para>To use the <command>smbsh</command> command, execute <command>
- smbsh</command> from the prompt and enter the username and password
- that authenticates you to the machine running the Windows NT
- operating system.</para>
-
- <para><programlisting>
- <prompt>system% </prompt><userinput>smbsh</userinput>
- <prompt>Username: </prompt><userinput>user</userinput>
- <prompt>Password: </prompt><userinput>XXXXXXX</userinput>
- </programlisting></para>
-
-
- <para>Any dynamically linked command you execute from
- this shell will access the <filename>/smb</filename> directory
- using the smb protocol. For example, the command <command>ls /smb
- </command> will show a list of workgroups. The command
- <command>ls /smb/MYGROUP </command> will show all the machines in
- the workgroup MYGROUP. The command
- <command>ls /smb/MYGROUP/&lt;machine-name&gt;</command> will show the share
- names for that machine. You could then, for example, use the <command>
- cd</command> command to change directories, <command>vi</command> to
- edit files, and <command>rcp</command> to copy files.</para>
-</refsect1>
-
-<refsect1>
- <title>VERSION</title>
-
- <para>This man page is correct for version 3.0 of
- the Samba suite.</para>
-</refsect1>
-
-<refsect1>
- <title>BUGS</title>
-
- <para><command>smbsh</command> works by intercepting the standard
- libc calls with the dynamically loaded versions in <filename>
- smbwrapper.o</filename>. Not all calls have been "wrapped", so
- some programs may not function correctly under <command>smbsh
- </command>.</para>
-
- <para>Programs which are not dynamically linked cannot make
- use of <command>smbsh</command>'s functionality. Most versions
- of UNIX have a <command>file</command> command that will
- describe how a program was linked.</para>
-</refsect1>
-
-
-<refsect1>
- <title>SEE ALSO</title>
- <para><ulink url="smbd.8.html"><command>smbd(8)</command></ulink>,
- <ulink url="smb.conf.5.html">smb.conf(5)</ulink>
- </para>
-</refsect1>
-
-<refsect1>
- <title>AUTHOR</title>
-
- <para>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.</para>
-
- <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/">
- 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</para>
-</refsect1>
-
-</refentry>