docs-xml/manpages/mdsearch.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="mdsearch.1">
   4
   5   <refmeta>
   6     <refentrytitle>mdsearch</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>mdsearch</refname>
  15     <refpurpose>Run Spotlight searches against an SMB server</refpurpose>
  16   </refnamediv>
  17
  18   <refsynopsisdiv>
  19     <cmdsynopsis>
  20       <command>mdfine</command>
  21       <arg choice="req">server</arg>
  22       <arg choice="req">sharename</arg>
  23       <arg choice="req">query</arg>
  24       <arg choice="opt">-p, --path=STRING</arg>
  25       <arg choice="opt">-L, --live</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">--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     </cmdsynopsis>
  55   </refsynopsisdiv>
  56
  57   <refsect1>
  58     <title>DESCRIPTION</title>
  59
  60     <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  61     <manvolnum>1</manvolnum></citerefentry> suite.</para>
  62
  63     <para>mdsearch is a simple utility to run Spotlight searches against an SMB server
  64     that runs the Spotlight <emphasis>mdssvc</emphasis> RPC service.</para>
  65   </refsect1>
  66
  67   <refsect1>
  68     <title>OPTIONS</title>
  69
  70     <variablelist>
  71       <varlistentry>
  72         <term>server</term>
  73         <listitem>
  74           <para>The SMB server name or IP address to connect to.</para>
  75         </listitem>
  76       </varlistentry>
  77
  78       <varlistentry>
  79         <term>sharename</term>
  80         <listitem>
  81           <para>The name of a share on the server.</para>
  82         </listitem>
  83       </varlistentry>
  84
  85       <varlistentry>
  86         <term>query</term>
  87         <listitem>
  88           <para>The query expression syntax is a simplified form of filename
  89           globbing familiar to shell users. Queries have the following
  90           format:</para>
  91
  92           <para>attribute=="value"</para>
  93
  94           <para>For queries against a Samba server with Spotlight enabled using
  95           the Elasticsearch backend, the list of supported metadata attributes
  96           is given by the JSON attribute mapping file, typically installed at
  97           <filename>/usr/share/samba/mdssvc/elasticsearch_mappings.json</filename>
  98           </para>
  99         </listitem>
 100       </varlistentry>
 101
 102       <varlistentry>
 103         <term>-p PATH, --path=PATH</term>
 104         <listitem>
 105           <para>Server side path to search, defaults to
 106           <emphasis>"/"</emphasis></para>
 107         </listitem>
 108       </varlistentry>
 109
 110       <varlistentry>
 111         <term>-L, --live</term>
 112         <listitem><para>Query remains running.</para></listitem>
 113       </varlistentry>
 114
 115       &popt.autohelp;
 116       &cmdline.common.samba.client;
 117       &cmdline.common.credentials;
 118     </variablelist>
 119   </refsect1>
 120
 121   <refsect1>
 122     <title>EXAMPLES</title>
 123
 124     <para>Search all indexed metadata attributes, exact match:</para>
 125     <programlisting>
 126       '*=="Samba"'
 127     </programlisting>
 128
 129     <para>Search all indexed metadata attributes, prefix match:</para>
 130     <programlisting>
 131       '*=="Samba*"'
 132     </programlisting>
 133
 134     <para>Search by filename:</para>
 135     <programlisting>
 136       'kMDItemFSName=="Samba*"'
 137     </programlisting>
 138
 139     <para>Search by date:</para>
 140     <programlisting>
 141       'kMDItemFSContentChangeDate&lt;$time.iso(2018-10-01T10:00:00Z)'
 142     </programlisting>
 143
 144     <para>Search files's content:</para>
 145     <programlisting>
 146       'kMDItemTextContent=="Samba*"'
 147     </programlisting>
 148
 149     <para>Expressions:</para>
 150     <programlisting>
 151       kMDItemFSName=="Samba*"||kMDItemTextContent=="Tango*"'
 152     </programlisting>
 153   </refsect1>
 154
 155   <refsect1>
 156     <title>SEE ALSO</title>
 157
 158     <para>File Metadata Search Programming Guide
 159     <ulink url="https://developer.apple.com/library/archive/documentation/Carbon/Conceptual/SpotlightQuery/Concepts/Introduction.html">
 160     https://developer.apple.com/library/archive/documentation/Carbon/Conceptual/SpotlightQuery/Concepts/Introduction.html</ulink>
 161     </para>
 162   </refsect1>
 163
 164   <refsect1>
 165     <title>VERSION</title>
 166
 167     <para>This man page is part of version &doc.version; of the Samba suite.</para>
 168   </refsect1>
 169
 170   <refsect1>
 171     <title>AUTHOR</title>
 172
 173     <para>The original Samba software and related utilities were created by
 174     Andrew Tridgell. Samba is now developed by the Samba Team as an Open
 175     Source project similar to the way the Linux kernel is developed.</para>
 176
 177     <para>The mdsearch manpage was written by Ralph Boehme.</para>
 178   </refsect1>
 179 </refentry>