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