docs-xml/manpages/winexe.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="winexe.1">
   4
   5 <refmeta>
   6         <refentrytitle>winexe</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">User Commands</refmiscinfo>
  10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>winexe</refname>
  16         <refpurpose>Winexe is a Remote Windows-command executor</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>winexe</command>
  22                 <arg choice="opt">-h</arg>
  23                 <arg choice="opt">-V</arg>
  24                 <arg choice="opt">-U [DOMAIN/]USERNAME[%PASSWORD]</arg>
  25                 <arg choice="opt">-A FILE</arg>
  26                 <arg choice="opt">-N</arg>
  27                 <arg choice="opt">-k</arg>
  28                 <arg choice="opt">-d DEBUGLEVEL</arg>
  29                 <arg choice="opt">--uninstall</arg>
  30                 <arg choice="opt">--reinstall</arg>
  31                 <arg choice="opt">--runas [DOMAIN/]USERNAME[%PASSWORD]</arg>
  32                 <arg choice="opt">--runas-file FILE</arg>
  33                 <arg choice="opt">--interactive [0|1]</arg>
  34                 <arg choice="opt">--ostype [0|1]</arg>
  35         </cmdsynopsis>
  36 </refsynopsisdiv>
  37
  38 <refsect1>
  39         <title>DESCRIPTION</title>
  40
  41         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  42         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  43
  44         <para>The <command>winexe</command> allows remote command execution on native
  45         Windows operating systems.</para>
  46 </refsect1>
  47
  48 <refsect1>
  49         <title>OPTIONS</title>
  50
  51         <variablelist>
  52
  53                 &stdarg.help;
  54                 &stdarg.version;
  55                 &stdarg.username;
  56                 &stdarg.authfile;
  57                 &stdarg.nopass;
  58                 &stdarg.kerberos;
  59                 &stdarg.client.debug;
  60
  61                 <varlistentry>
  62                 <term>--uninstall</term>
  63                 <listitem>
  64                         <para>
  65                                 Uninstall winexe service after remote execution.
  66                         </para>
  67                 </listitem>
  68                 </varlistentry>
  69
  70                 <varlistentry>
  71                 <term>--reinstall</term>
  72                 <listitem>
  73                         <para>
  74                                 Reinstall winexe service before remote execution.
  75                         </para>
  76                 </listitem>
  77                 </varlistentry>
  78
  79                 <varlistentry>
  80                 <term>--runas <replaceable>[DOMAIN/]USERNAME[%PASSWORD]]</replaceable></term>
  81                 <listitem>
  82                         <para>
  83                                 Run as the given user (BEWARE: this password is sent in cleartext over the network!)
  84                         </para>
  85                 </listitem>
  86                 </varlistentry>
  87
  88                 <varlistentry>
  89                 <term>--runas-file <replaceable>FILE</replaceable></term>
  90                 <listitem>
  91                         <para>
  92                                 Run as user options defined in a file.
  93                         </para>
  94                 </listitem>
  95                 </varlistentry>
  96
  97                 <varlistentry>
  98                 <term>--interactive <replaceable>[0|1]</replaceable></term>
  99                 <listitem>
 100                 <para>
 101                         Desktop interaction.
 102                 </para>
 103
 104                         <para>There are two options:</para>
 105                         <itemizedlist>
 106                                 <listitem>
 107                                 <para>
 108                                         0 - disallow
 109                                 </para>
 110                                 </listitem>
 111
 112                                 <listitem>
 113                                 <para>
 114                                         1 - allow. If allow, also use the --system switch (Windows requirement). Vista does not support this optoin.
 115                                 </para>
 116                                 </listitem>
 117                         </itemizedlist>
 118                 </listitem>
 119                 </varlistentry>
 120
 121                 <varlistentry>
 122                         <term>--ostype <replaceable>[0|1|2]</replaceable></term>
 123                         <listitem>
 124                         <para>
 125                                 Determines which version (32-bit or 64-bit) of service will be installed.
 126                         </para>
 127
 128                         <para>There are three options:</para>
 129                         <itemizedlist>
 130                                 <listitem>
 131                                 <para>
 132                                         0 - 32-bit
 133                                 </para>
 134                                 </listitem>
 135
 136                                 <listitem>
 137                                 <para>
 138                                         1 - 64-bit
 139                                 </para>
 140                                 </listitem>
 141
 142                                 <listitem>
 143                                 <para>
 144                                         2 - winexe will decide
 145                                 </para>
 146                                 </listitem>
 147                         </itemizedlist>
 148                 </listitem>
 149                 </varlistentry>
 150
 151         </variablelist>
 152 </refsect1>
 153
 154
 155 <refsect1>
 156         <title>EXIT STATUS</title>
 157
 158         <para>The winexe program returns 0 if the operation
 159         succeeded, or 1 if the operation failed. </para>
 160 </refsect1>
 161
 162
 163 <refsect1>
 164         <title>VERSION</title>
 165
 166         <para>This man page is part of version &doc.version; of
 167         the Samba suite.</para>
 168 </refsect1>
 169
 170 <refsect1>
 171         <title>AUTHOR</title>
 172
 173         <para>The original Samba software and related utilities
 174         were created by Andrew Tridgell. Samba is now developed
 175         by the Samba Team as an Open Source project similar
 176         to the way the Linux kernel is developed.</para>
 177
 178         <para>The <command>winexe</command> and it's native Windows counterpart were written by Andrzej Hajda.
 179         The Samba client tool winexe was later rewritten by Volker Lendecke.</para>
 180
 181         <para>This manpage was written by Guenther Deschner.</para>
 182 </refsect1>
 183
 184 </refentry>