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">--uninstall</arg>
  23                 <arg choice="opt">--reinstall</arg>
  24                 <arg choice="opt">--runas [DOMAIN/]USERNAME[%PASSWORD]</arg>
  25                 <arg choice="opt">--runas-file FILE</arg>
  26                 <arg choice="opt">--interactive [0|1]</arg>
  27                 <arg choice="opt">--ostype [0|1]</arg>
  28                 <arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
  29                 <arg choice="opt">--debug-stdout</arg>
  30                 <arg choice="opt">--configfile=CONFIGFILE</arg>
  31                 <arg choice="opt">--option=name=value</arg>
  32                 <arg choice="opt">-l|--log-basename=LOGFILEBASE</arg>
  33                 <arg choice="opt">--leak-report</arg>
  34                 <arg choice="opt">--leak-report-full</arg>
  35                 <arg choice="opt">-R|--name-resolve=NAME-RESOLVE-ORDER</arg>
  36                 <arg choice="opt">-O|--socket-options=SOCKETOPTIONS</arg>
  37                 <arg choice="opt">-m|--max-protocol=MAXPROTOCOL</arg>
  38                 <arg choice="opt">-n|--netbiosname=NETBIOSNAME</arg>
  39                 <arg choice="opt">--netbios-scope=SCOPE</arg>
  40                 <arg choice="opt">-W|--workgroup=WORKGROUP</arg>
  41                 <arg choice="opt">--realm=REALM</arg>
  42                 <arg choice="opt">-U|--user=[DOMAIN/]USERNAME%[PASSWORD]</arg>
  43                 <arg choice="opt">-N|--no-pass</arg>
  44                 <arg choice="opt">--password=STRING</arg>
  45                 <arg choice="opt">--pw-nt-hash</arg>
  46                 <arg choice="opt">-A|--authentication-file=FILE</arg>
  47                 <arg choice="opt">-P|--machine-pass</arg>
  48                 <arg choice="opt">--simple-bind-dn=DN</arg>
  49                 <arg choice="opt">--use-kerberos=desired|required|off</arg>
  50                 <arg choice="opt">--use-krb5-ccache=CCACHE</arg>
  51                 <arg choice="opt">--use-winbind-ccache</arg>
  52                 <arg choice="opt">--client-protection=sign|encrypt|off</arg>
  53                 <arg choice="opt">-V|--version</arg>
  54                 <arg choice="opt">-?|--help</arg>
  55                 <arg choice="opt">--usage</arg>
  56         </cmdsynopsis>
  57 </refsynopsisdiv>
  58
  59 <refsect1>
  60         <title>DESCRIPTION</title>
  61
  62         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  63         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  64
  65         <para>The <command>winexe</command> allows remote command execution on native
  66         Windows operating systems.</para>
  67 </refsect1>
  68
  69 <refsect1>
  70         <title>OPTIONS</title>
  71
  72         <variablelist>
  73                 <varlistentry>
  74                 <term>--uninstall</term>
  75                 <listitem>
  76                         <para>
  77                                 Uninstall winexe service after remote execution.
  78                         </para>
  79                 </listitem>
  80                 </varlistentry>
  81
  82                 <varlistentry>
  83                 <term>--reinstall</term>
  84                 <listitem>
  85                         <para>
  86                                 Reinstall winexe service before remote execution.
  87                         </para>
  88                 </listitem>
  89                 </varlistentry>
  90
  91                 <varlistentry>
  92                 <term>--runas <replaceable>[DOMAIN/]USERNAME[%PASSWORD]]</replaceable></term>
  93                 <listitem>
  94                         <para>
  95                                 Run as the given user (BEWARE: this password is sent in cleartext over the network!)
  96                         </para>
  97                 </listitem>
  98                 </varlistentry>
  99
 100                 <varlistentry>
 101                 <term>--runas-file <replaceable>FILE</replaceable></term>
 102                 <listitem>
 103                         <para>
 104                                 Run as user options defined in a file.
 105                         </para>
 106                 </listitem>
 107                 </varlistentry>
 108
 109                 <varlistentry>
 110                 <term>--interactive <replaceable>[0|1]</replaceable></term>
 111                 <listitem>
 112                 <para>
 113                         Desktop interaction.
 114                 </para>
 115
 116                         <para>There are two options:</para>
 117                         <itemizedlist>
 118                                 <listitem>
 119                                 <para>
 120                                         0 - disallow
 121                                 </para>
 122                                 </listitem>
 123
 124                                 <listitem>
 125                                 <para>
 126                                         1 - allow. If allow, also use the --system switch (Windows requirement). Vista does not support this option.
 127                                 </para>
 128                                 </listitem>
 129                         </itemizedlist>
 130                 </listitem>
 131                 </varlistentry>
 132
 133                 <varlistentry>
 134                         <term>--ostype <replaceable>[0|1|2]</replaceable></term>
 135                         <listitem>
 136                         <para>
 137                                 Determines which version (32-bit or 64-bit) of service will be installed.
 138                         </para>
 139
 140                         <para>There are three options:</para>
 141                         <itemizedlist>
 142                                 <listitem>
 143                                 <para>
 144                                         0 - 32-bit
 145                                 </para>
 146                                 </listitem>
 147
 148                                 <listitem>
 149                                 <para>
 150                                         1 - 64-bit
 151                                 </para>
 152                                 </listitem>
 153
 154                                 <listitem>
 155                                 <para>
 156                                         2 - winexe will decide
 157                                 </para>
 158                                 </listitem>
 159                         </itemizedlist>
 160                 </listitem>
 161                 </varlistentry>
 162
 163                 &cmdline.common.samba.client;
 164                 &cmdline.common.connection;
 165                 &cmdline.common.credentials;
 166                 &popt.autohelp;
 167         </variablelist>
 168 </refsect1>
 169
 170
 171 <refsect1>
 172         <title>EXIT STATUS</title>
 173
 174         <para>The winexe program returns 0 if the operation
 175         succeeded, or 1 if the operation failed. </para>
 176 </refsect1>
 177
 178
 179 <refsect1>
 180         <title>VERSION</title>
 181
 182         <para>This man page is part of version &doc.version; of
 183         the Samba suite.</para>
 184 </refsect1>
 185
 186 <refsect1>
 187         <title>AUTHOR</title>
 188
 189         <para>The original Samba software and related utilities
 190         were created by Andrew Tridgell. Samba is now developed
 191         by the Samba Team as an Open Source project similar
 192         to the way the Linux kernel is developed.</para>
 193
 194         <para>The <command>winexe</command> and it's native Windows counterpart were written by Andrzej Hajda.
 195         The Samba client tool winexe was later rewritten by Volker Lendecke.</para>
 196
 197         <para>This manpage was written by Guenther Deschner.</para>
 198 </refsect1>
 199
 200 </refentry>