docs/docbook/manpages/smbsh.1.xml

   1 <?xml version="1.0" encoding="iso8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3                   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4
   5 <!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
   6 ]>
   7 <refentry id="smbsh.1">
   8
   9 <refmeta>
  10         <refentrytitle>smbsh</refentrytitle>
  11         <manvolnum>1</manvolnum>
  12 </refmeta>
  13
  14
  15 <refnamediv>
  16         <refname>smbsh</refname>
  17         <refpurpose>Allows access to Windows NT filesystem
  18         using UNIX commands</refpurpose>
  19 </refnamediv>
  20
  21 <refsynopsisdiv>
  22         <cmdsynopsis>
  23                 <command>smbsh</command>
  24                 <arg choice="opt">-W workgroup</arg>
  25                 <arg choice="opt">-U username</arg>
  26                 <arg choice="opt">-P prefix</arg>
  27                 <arg choice="opt">-R &lt;name resolve order&gt;</arg>
  28                 <arg choice="opt">-d &lt;debug level&gt;</arg>
  29                 <arg choice="opt">-l logfile</arg>
  30                 <arg choice="opt">-L libdir</arg>
  31         </cmdsynopsis>
  32 </refsynopsisdiv>
  33
  34 <refsect1>
  35         <title>DESCRIPTION</title>
  36
  37         <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
  38         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  39
  40         <para><command>smbsh</command> allows you to access an NT filesystem
  41         using UNIX commands such as <command>ls</command>, <command>
  42         egrep</command>, and <command>rcp</command>. You must use a
  43         shell that is dynamically linked in order for <command>smbsh</command>
  44         to work correctly.</para>
  45 </refsect1>
  46
  47 <refsect1>
  48         <title>OPTIONS</title>
  49
  50         <variablelist>
  51             <varlistentry>
  52                 <term>-W WORKGROUP</term>
  53                 <listitem><para>Override the default workgroup specified in the
  54                 workgroup parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
  55                 <manvolnum>5</manvolnum></citerefentry> file
  56                 for this session. This may be needed to connect to some
  57                 servers. </para></listitem>
  58             </varlistentry>
  59
  60             <varlistentry>
  61                 <term>-U username[%pass]</term>
  62                 <listitem><para>Sets the SMB username or username and password.
  63                 If this option is not specified, the user will be prompted for
  64                 both the username and the password.  If %pass is not specified,
  65                 the user will be prompted for the password.
  66                 </para></listitem>
  67             </varlistentry>
  68
  69             <varlistentry>
  70                 <term>-P prefix</term>
  71                 <listitem><para>This option allows
  72                 the user to set the directory prefix for SMB access. The
  73                 default value if this option is not specified is
  74                 <emphasis>smb</emphasis>.
  75                 </para></listitem>
  76             </varlistentry>
  77
  78                 &stdarg.configfile;
  79                 &stdarg.debug;
  80                 &stdarg.resolve.order;
  81
  82             <varlistentry>
  83                 <term>-L libdir</term>
  84                 <listitem><para>This parameter specifies the location of the
  85                 shared libraries used by <command>smbsh</command>. The default
  86                 value is specified at compile time.
  87                 </para></listitem>
  88             </varlistentry>
  89
  90         </variablelist>
  91 </refsect1>
  92
  93 <refsect1>
  94         <title>EXAMPLES</title>
  95
  96         <para>To use the <command>smbsh</command> command, execute <command>
  97         smbsh</command> from the prompt and enter the username and password
  98         that authenticates you to the machine running the Windows NT
  99         operating system.
 100 <programlisting>
 101 <prompt>system% </prompt><userinput>smbsh</userinput>
 102 <prompt>Username: </prompt><userinput>user</userinput>
 103 <prompt>Password: </prompt><userinput>XXXXXXX</userinput>
 104 </programlisting></para>
 105
 106
 107         <para>Any dynamically linked command you execute from
 108         this shell will access the <filename>/smb</filename> directory
 109         using the smb protocol. For example, the command <command>ls /smb
 110         </command> will show a list of workgroups. The command
 111         <command>ls /smb/MYGROUP </command> will show all the machines in
 112         the  workgroup MYGROUP. The command
 113         <command>ls /smb/MYGROUP/&lt;machine-name&gt;</command> will show the share
 114         names for that machine. You could then, for example, use the <command>
 115         cd</command> command to change directories, <command>vi</command> to
 116         edit files, and <command>rcp</command>  to copy files.</para>
 117 </refsect1>
 118
 119 <refsect1>
 120         <title>VERSION</title>
 121
 122         <para>This man page is correct for version 3.0 of the Samba suite.</para>
 123 </refsect1>
 124
 125 <refsect1>
 126         <title>BUGS</title>
 127
 128         <para><command>smbsh</command> works by intercepting the standard
 129         libc calls with the dynamically loaded versions in <filename>
 130         smbwrapper.o</filename>. Not all calls have been "wrapped", so
 131         some programs may not function correctly under <command>smbsh
 132         </command>.</para>
 133
 134         <para>Programs which are not dynamically linked cannot make
 135         use of <command>smbsh</command>'s functionality. Most versions
 136         of UNIX have a <command>file</command> command that will
 137         describe how a program was linked.</para>
 138 </refsect1>
 139
 140
 141 <refsect1>
 142         <title>SEE ALSO</title>
 143         <para><citerefentry><refentrytitle>smbd</refentrytitle>
 144         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle>
 145         <manvolnum>5</manvolnum></citerefentry></para>
 146 </refsect1>
 147
 148 <refsect1>
 149         <title>AUTHOR</title>
 150
 151         <para>The original Samba software and related utilities
 152         were created by Andrew Tridgell. Samba is now developed
 153         by the Samba Team as an Open Source project similar
 154         to the way the Linux kernel is developed.</para>
 155
 156         <para>The original Samba man pages were written by Karl Auer.
 157         The man page sources were converted to YODL format (another
 158         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 159         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 160         release by Jeremy Allison.  The conversion to DocBook for
 161         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
 162         for Samba 3.0 was done by Alexander Bokovoy.</para>
 163 </refsect1>
 164
 165 </refentry>