docs-xml/manpages/wspsearch.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="wspsearch.1">
   4
   5   <refmeta>
   6     <refentrytitle>wspsearch</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   <refnamediv>
  14     <refname>wspsearch</refname>
  15     <refpurpose>Run Windows Search Protocol searches against a SMB server</refpurpose>
  16   </refnamediv>
  17
  18   <refsynopsisdiv>
  19     <cmdsynopsis>
  20       <command>wspsearch</command>
  21       <arg choice="req">//server/share</arg>
  22       <arg choice="opt">--limit=results</arg>
  23       <arg choice="opt">--search=phrase</arg>
  24       <arg choice="opt">--kind=KIND</arg>
  25       <arg choice="opt">--query=QUERY</arg>
  26       <arg choice="opt">-?|--help</arg>
  27       <arg choice="opt">--usage</arg>
  28       <arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
  29       <arg choice="opt">--debug-stdout</arg>
  30       <arg choice="opt">-s|--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     </cmdsynopsis>
  54   </refsynopsisdiv>
  55
  56   <refsect1>
  57     <title>DESCRIPTION</title>
  58
  59     <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  60     <manvolnum>1</manvolnum></citerefentry> suite.</para>
  61
  62     <para>wspsearch is a simple utility to run Windows Search Protocol searches against a SMB server that has the WSP service enabled.</para>
  63   </refsect1>
  64
  65   <refsect1>
  66     <title>OPTIONS</title>
  67
  68     <variablelist>
  69       <varlistentry>
  70         <term>server</term>
  71         <listitem>
  72           <para>The SMB server name or IP address to connect to.</para>
  73         </listitem>
  74       </varlistentry>
  75
  76       <varlistentry>
  77         <term>sharename</term>
  78         <listitem>
  79           <para>The name of a share on the server.</para>
  80         </listitem>
  81       </varlistentry>
  82
  83       <varlistentry>
  84         <term>--query</term>
  85         <listitem><para>A query specified in simplified AQS-like (Advanced query syntax).</para>
  86         <para>Basic (AQS) syntax is supported (See <emphasis>SEE ALSO</emphasis>).
  87         A query consists of a sequence of queries connected by AND, OR
  88         and NOT boolean operators. The query elements are essentially
  89         restrictions defined by a property. There are some limitations on the
  90         operators supported and some types of properties like enumerated
  91         ranges are not supported at all. Additionally syntactically
  92         range values are not delimited as specified by AQS (ranges are
  93         instead specified as value-value). Some special cases that you see in
  94         the windows search UI (for example sizes like 'tiny', 'small',
  95         'large' etc.) are exceptions which are handled more or less
  96         as keywords. See <emphasis>EXAMPLES</emphasis>.</para>
  97         </listitem>
  98       </varlistentry>
  99
 100       <varlistentry>
 101         <term>--search=phrase</term>
 102         <listitem>
 103           <para>A simple phrase that is searched across the index
 104           </para>
 105         </listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term>--kind=KIND</term>
 110         <listitem>
 111           <para>kind one of;
 112           <itemizedlist>
 113                   <listitem><para><emphasis>Calendar</emphasis> </para> </listitem>
 114                   <listitem><para><emphasis>Communication</emphasis> </para> </listitem>
 115                   <listitem><para><emphasis>Contact</emphasis> </para> </listitem>
 116                   <listitem><para><emphasis>Document</emphasis> </para> </listitem>
 117                   <listitem><para><emphasis>Email</emphasis> </para> </listitem>
 118                   <listitem><para><emphasis>Feed</emphasis> </para> </listitem>
 119                   <listitem><para><emphasis>Folder</emphasis> </para> </listitem>
 120                   <listitem><para><emphasis>Game</emphasis> </para> </listitem>
 121                   <listitem><para><emphasis>InstantMessage</emphasis> </para> </listitem>
 122                   <listitem><para><emphasis>Journal</emphasis> </para> </listitem>
 123                   <listitem><para><emphasis>Movie</emphasis> </para> </listitem>
 124                   <listitem><para><emphasis>Music</emphasis> </para> </listitem>
 125                   <listitem><para><emphasis>Link</emphasis> </para> </listitem>
 126                   <listitem><para><emphasis>Note</emphasis> </para> </listitem>
 127                   <listitem><para><emphasis>Picture</emphasis> </para> </listitem>
 128                   <listitem><para><emphasis>Program</emphasis> </para> </listitem>
 129                   <listitem><para><emphasis>RecordedTV</emphasis> </para> </listitem>
 130                   <listitem><para><emphasis>SearchFolder</emphasis> </para> </listitem>
 131                   <listitem><para><emphasis>Task</emphasis> </para> </listitem>
 132                   <listitem><para><emphasis>Video</emphasis> </para> </listitem>
 133                   <listitem><para><emphasis>WebHistory</emphasis> </para> </listitem>
 134           </itemizedlist>
 135           </para>
 136         </listitem>
 137       </varlistentry>
 138
 139       <varlistentry>
 140         <term>--limit</term>
 141         <listitem><para>A limit on the number of results returned, by default
 142         there is a limit of 500 results, a limit of 0 indicates no limit and
 143         all results will be returned.</para></listitem>
 144       </varlistentry>
 145
 146       &popt.autohelp;
 147       &cmdline.common.samba.client;
 148       &cmdline.common.credentials;
 149     </variablelist>
 150   </refsect1>
 151
 152   <refsect1>
 153     <title>EXAMPLES</title>
 154
 155     <para>Search using a basic phrase:</para>
 156     <programlisting>
 157         'wspsearch -Usomeuser%password //server/share --phrase="cats"'
 158     </programlisting>
 159
 160     <para>Search using an AQS like query for a picture whose name starts with p403 or p404:</para>
 161     <programlisting>
 162         'wspsearch -Usomeuser%password //server/share --query="ALL:$&lt;p403 OR ALL:$&lt;p404 AND System.Kind:picture"'
 163     </programlisting>
 164
 165   </refsect1>
 166
 167   <refsect1>
 168     <title>SEE ALSO</title>
 169     <para>Adanced Query Syntax
 170     <ulink url="https://learn.microsoft.com/en-gb/windows/win32/search/-search-3x-advancedquerysyntax">
 171     https://learn.microsoft.com/en-gb/windows/win32/search/-search-3x-advancedquerysyntax </ulink>
 172     </para>
 173   </refsect1>
 174
 175   <refsect1>
 176     <title>VERSION</title>
 177
 178     <para>This man page is part of version &doc.version; of the Samba suite.</para>
 179   </refsect1>
 180
 181   <refsect1>
 182     <title>AUTHOR</title>
 183
 184     <para>The original Samba software and related utilities were created by
 185     Andrew Tridgell. Samba is now developed by the Samba Team as an Open
 186     Source project similar to the way the Linux kernel is developed.</para>
 187
 188     <para>The wspsearch manpage was written by Noel Power.</para>
 189   </refsect1>
 190 </refentry>