From: Ralph Boehme Date: Sun, 4 Aug 2013 17:07:50 +0000 (+0200) Subject: Rewrite Spotlight documentation, remove references to RDF X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=netatalk.git;a=commitdiff_plain;h=22fc09809589e0dff0d9b1e1ff1647206f052fad Rewrite Spotlight documentation, remove references to RDF --- diff --git a/doc/manpages/man5/afp.conf.5.xml b/doc/manpages/man5/afp.conf.5.xml index 681e7da9..f346e371 100644 --- a/doc/manpages/man5/afp.conf.5.xml +++ b/doc/manpages/man5/afp.conf.5.xml @@ -875,7 +875,7 @@ Speficy a set of file and directory attributes that shall - be ignored by the server, all includes all + be ignored by the server, includes all the other options. In OS X when the Finder sets a lock on a file/directory or you set the BSD uchg flag in the Terminal, all three attributes are @@ -1132,7 +1132,7 @@ mode. You can adjust this behaviour with the configuration option : - + map acls = none|rights|mode (G) diff --git a/doc/manual/configuration.xml b/doc/manual/configuration.xml index 36e9dad3..941ecec3 100644 --- a/doc/manual/configuration.xml +++ b/doc/manual/configuration.xml @@ -31,6 +31,12 @@ configuration file is afp.conf. It uses a ini style configuration syntax. + Support for Spotlight + Spotlight + has been added in Netatalk 3.1. See this section for information on how to + compile Netatalk with Spotlight support. + Mac OS X 10.5 (Leopard) added support for Time Machine backups over AFP. Two new functions ensure that backups are written to spinning disk, not just in the server's cache. Different host operating systems @@ -47,11 +53,6 @@ completely up to the client to resolve them, resulting in links that point somewhere inside the clients filesystem view. - Support for Spotlight has been - added in Netatalk 3.1. See this section for information on how to - compile Netatalk with Spotlight support. - afp.conf @@ -122,446 +123,6 @@ basedir regex = /usr/home - - Spotlight<indexterm> - <primary>Spotlight</primary> - </indexterm> - - Netatalk uses Tracker as the metadata backend. Recent Linux - distributions will provide the libtracker-sparql library which is - available since Tracker version 0.7. This version is referred to as - Tracker SPARQL. - - Other system like FreeBSD, Solaris and systems derived from - Solaris will only ship Tracker version 0.6 which only offers a much more - restrcited feature set. We refer to this version as Tracker RDF. Solaris - users are advised to install Tracker from OpenCSW as this is at least - version 0.15 and thus supports SPARQL - - You can enable Spotlight and indexing either globally or on a per - volume basis using the option. - - For Solaris with Tracker from OpenCSW also add: - dbus daemon = /opt/csw/bin/dbus-daemon - - - Once Spotlight is enable for a single volume, all other volumes - for which spotlight is disabled won't be searchable at all. - - - - Tracker RDF - - Add all volume paths that should be searchable to - $sysconfdir/tracker/tracker.cfg:... -[Watches] -# List of directory roots to index and watch (separator=;) -WatchDirectoryRoots=/foo/bar;/another/volume -... - - - - Limitations and notes - - - - Large filesystems - - Tracker on Linux uses the inotify Kernel filesystem change - event API for tracking filesystem changes. On large filesystems - this may be problematic since the inotify API doesn't offer - recursive directory watches but instead requires that for every - subdirectoy watches must be added individually. - - On Solaris the FEN file event notification system is used. - It is unkown which limitations and ressource consumption this - Solaris subsystem has, - - - - Tracker RDF - - The mapping of certain simple and of complex Spotlight to - Tracker RDF queries is imperfect. Also, Tracker RDF filename - searches are case sensitive! As a result there are two noticable - restrictions: - - - - On a Mac, a query entered in the Spotlight search menu - or in a Finder search toolbar is meant to express "search any - metadata field, file name or content for this string". With - Netatalk and Tracker RDF only filenames will be - searched. - - - - Searching files content must be done through explicitly - adding a "Contents contains ..." - filter. - - - - - Case sensivity - - - - - - - - - - Searching metadata - - - - - - - - - - - - - Supported metadata attributes - - The following list is the complete set of supported metadata - attributes in Tracker SPARQL search queries - - - Tracker SPARQL - - - - - Description - - Spotlight Key - - - - - - Name - - kMDItemDisplayName, kMDItemFSName - - - - Document content (full text search) - - kMDItemTextContent - - - - File type - - _kMDItemGroupId, kMDItemContentTypeTree - - - - File modification date - - kMDItemFSContentChangeDate, - kMDItemContentModificationDate, - kMDItemAttributeChangeDate - - - - Content Creation date - - kMDItemContentCreationDate - - - - The author, or authors, of the contents of the - file - - kMDItemAuthors, kMDItemCreator - - - - The name of the country where the item was - created - - kMDItemCountry - - - - Duration - - kMDItemDurationSeconds - - - - Number of pages - - kMDItemNumberOfPages - - - - Document title - - kMDItemTitle - - - - The width, in pixels, of the contents. For example, the - image width or the video frame width - - kMDItemPixelWidth - - - - The height, in pixels, of the contents. For example, - the image height or the video frame height - - kMDItemPixelHeight - - - - The color space model used by the document - contents - - kMDItemColorSpace - - - - The number of bits per sample - - kMDItemBitsPerSample - - - - Focal length of the lens, in millimeters - - kMDItemFocalLength - - - - ISO speed - - kMDItemISOSpeed - - - - Orientation of the document. Possible values are 0 - (landscape) and 1 (portrait) - - kMDItemOrientation - - - - Resolution width, in DPI - - kMDItemResolutionWidthDPI - - - - Resolution height, in DPI - - kMDItemResolutionHeightDPI - - - - Exposure time, in seconds - - kMDItemExposureTimeSeconds - - - - The composer of the music contained in the audio - file - - kMDItemComposer - - - - The musical genre of the song or composition - - kMDItemMusicalGenre - - - -
- - The following list is the complete set of supported metadata - attributes in Tracker RDF search queries: - Tracker RDF - - - - - Description - - Spotlight Key - - - - - - Name - - kMDItemDisplayName, kMDItemFSName - - - - Document content (full text search) - - kMDItemTextContent - - - - File type - - _kMDItemGroupId, kMDItemContentTypeTree - - - - File modification date - - kMDItemFSContentChangeDate, - kMDItemContentModificationDate, - kMDItemAttributeChangeDate - - - - Content Creation date - - kMDItemContentCreationDate - - - - The author, or authors, of the contents of the - file - - kMDItemAuthors, kMDItemCreator - - - - The name of the country where the item was - created - - kMDItemCountry - - - - Duration - - kMDItemDurationSeconds - - - - Number of pages - - kMDItemNumberOfPages - - - - Document title - - kMDItemTitle - - - - The width, in pixels, of the contents. For example, - the image width or the video frame width - - kMDItemPixelWidth - - - - The height, in pixels, of the contents. For example, - the image height or the video frame height - - kMDItemPixelHeight - - - - Focal length of the lens, in millimeters - - kMDItemFocalLength - - - - ISO speed - - kMDItemISOSpeed - - - - Orientation of the document. Possible values are 0 - (landscape) and 1 (portrait) - - kMDItemOrientation - - - - Exposure time, in seconds - - kMDItemExposureTimeSeconds - - - - The musical genre of the song or composition - - kMDItemMusicalGenre - - - -
- - - - Using Tracker commandline tools on the server - - Netatalk must be running and the commands must be executed - as root:$ su -# export DBUS_SESSION_BUS_ADDRESS="unix:path=/tmp/spotlight.ipc" - - When using Tracker from OpenCSW you must also update - your PATH:# export PATH=/opt/csw/bin:$PATH - - Tracker SPARQL:# tracker-search QUERY -... -# tracker-info PATH -... - - Tracker RDF# cat file.rdf -<rdfq:Condition> - <rdfq:and> - <rdfq:contains> - <rdfq:Property name="File:Name" /> - <rdf:String>SEARCHSTRING</rdf:String> - </rdfq:contains> - </rdfq:and> -</rdfq:Condition> -# tracker-query -p file.rdf File:Name -... -# tracker-info -m File:Mime PATH -... - - - - References - - - - MDItem - - - - Tracker - - - - - CNID<indexterm> <primary>CNID</primary> @@ -1956,6 +1517,487 @@ aclmode = passthrough</screen> </sect2> </sect1> + <sect1> + <title id="spotlight">Spotlight<indexterm> + <primary>Spotlight</primary> + </indexterm> + + Starting with version 3.1 Netatalk supports Spotlight searching. + Netatalk uses Gnome Tracker as metadata store, + indexer and search engine. + + + Configuration + + You can enable Spotlight and indexing either globally or on a per + volume basis with the option. + + + Once Spotlight is enable for a single volume, all other volumes + for which spotlight is disabled won't be searchable at all. + + + In case the dbus-daemon binary is not installed + at the path /bin/dbus-daemon, you must use the + global option to point to the path, eg for + Solaris with Tracker from OpenCSW: dbus daemon = /opt/csw/bin/dbus-daemon + + + + Limitations and notes + + + + Large filesystems + + Tracker on Linux uses the inotify Kernel filesystem change + event API for tracking filesystem changes. On large filesystems this + may be problematic since the inotify API doesn't offer recursive + directory watches but instead requires that for every subdirectoy + watches must be added individually. + + On Solaris the FEN file event notification system is used. It + is unkown which limitations and ressource consumption this Solaris + subsystem may have. + + We therefor recommend to disable live filesystem monitoring + and let Tracker periodically scan filesystems for changes instead, + see the Tracker configuration options enable-monitors and crawling-interval below. + + + + + + Using Tracker commandline tools on the server + + Netatalk must be running and the commands must be executed as + root:$ su +# export DBUS_SESSION_BUS_ADDRESS="unix:path=/tmp/spotlight.ipc" + + When using Tracker from OpenCSW you must also update your + PATH:# export PATH=/opt/csw/bin:$PATH + + + Starting and stopping Tracker + + + + Querying Tracker status + + + # tracker-control -S + + + + + Stop Tracker + + + # tracker-control -t + + + + + Start Tracker status + + + # tracker-control -s + + + + + + + Reindex directory + + # tracker-control -f PATH + + + + Query Tracker for information about a file or directory + + # tracker-info PATH + + + + Search Tracker + + # tracker-search QUERY + + + + + Advanced Tracker command line configuration + + Tracker stores its configuration via Gnome dconf backend which can + be modified with the command gsettings. + + Gnome dconf settings are per-user settings, so, as Netatalk runs + the Tracker processes as root, the settings are stored in the root user + context and reading or changing these settings must be perfomed as root. + Netatalk must alo be running:$ su +# export DBUS_SESSION_BUS_ADDRESS="unix:path=/tmp/spotlight.ipc" + + When using Tracker from OpenCSW you must also update your + PATH:# export PATH=/opt/csw/bin:$PATH + + # gsettings list-recursively | grep Tracker +org.freedesktop.Tracker.Writeback verbosity 'debug' +... + + The following list describes some important Tracker options and + their default settings. + + + + org.freedesktop.Tracker.Miner.Files + index-recursive-directories + + + This option controls which directories Tracker will index. + Don't change this option manually as it is automatically set by + Netatalk reflecting the setting of the + option of Netatalk volumes. + + + + + org.freedesktop.Tracker.Miner.Files + enable-monitors true + + + The value controls whether Tracker watches all configured + paths for modification. Depending on the filesystem modification + backend (FAM on Linux, FEN on Solaris), this feature may not work + as reliable as one might wish, so it may be safer to disable it + and instead rely on periodic crawling of Tracker itself. See aslo + the option . + + + + + org.freedesktop.Tracker.Miner.Files + crawling-interval -1 + + + Interval in days to check the filesystem is up to date in + the database, maximum is 365, default is -1. -2 = crawling is + disabled entirely, -1 = crawling *may* occur on startup (if not + cleanly shutdown), 0 = crawling is forced + + + + + + + Supported metadata attributes + + The following list is the complete set of supported metadata + attributes in Tracker SPARQL search queries + + + Tracker SPARQL + + + + + Description + + Spotlight Key + + + + + + Name + + kMDItemDisplayName, kMDItemFSName + + + + Document content (full text search) + + kMDItemTextContent + + + + File type + + _kMDItemGroupId, kMDItemContentTypeTree + + + + File modification date + + kMDItemFSContentChangeDate, + kMDItemContentModificationDate, + kMDItemAttributeChangeDate + + + + Content Creation date + + kMDItemContentCreationDate + + + + The author, or authors, of the contents of the + file + + kMDItemAuthors, kMDItemCreator + + + + The name of the country where the item was + created + + kMDItemCountry + + + + Duration + + kMDItemDurationSeconds + + + + Number of pages + + kMDItemNumberOfPages + + + + Document title + + kMDItemTitle + + + + The width, in pixels, of the contents. For example, the + image width or the video frame width + + kMDItemPixelWidth + + + + The height, in pixels, of the contents. For example, the + image height or the video frame height + + kMDItemPixelHeight + + + + The color space model used by the document + contents + + kMDItemColorSpace + + + + The number of bits per sample + + kMDItemBitsPerSample + + + + Focal length of the lens, in millimeters + + kMDItemFocalLength + + + + ISO speed + + kMDItemISOSpeed + + + + Orientation of the document. Possible values are 0 + (landscape) and 1 (portrait) + + kMDItemOrientation + + + + Resolution width, in DPI + + kMDItemResolutionWidthDPI + + + + Resolution height, in DPI + + kMDItemResolutionHeightDPI + + + + Exposure time, in seconds + + kMDItemExposureTimeSeconds + + + + The composer of the music contained in the audio + file + + kMDItemComposer + + + + The musical genre of the song or composition + + kMDItemMusicalGenre + + + +
+ + The following list is the complete set of supported metadata + attributes in Tracker RDF search queries: + Tracker RDF + + + + + Description + + Spotlight Key + + + + + + Name + + kMDItemDisplayName, kMDItemFSName + + + + Document content (full text search) + + kMDItemTextContent + + + + File type + + _kMDItemGroupId, kMDItemContentTypeTree + + + + File modification date + + kMDItemFSContentChangeDate, + kMDItemContentModificationDate, + kMDItemAttributeChangeDate + + + + Content Creation date + + kMDItemContentCreationDate + + + + The author, or authors, of the contents of the + file + + kMDItemAuthors, kMDItemCreator + + + + The name of the country where the item was + created + + kMDItemCountry + + + + Duration + + kMDItemDurationSeconds + + + + Number of pages + + kMDItemNumberOfPages + + + + Document title + + kMDItemTitle + + + + The width, in pixels, of the contents. For example, the + image width or the video frame width + + kMDItemPixelWidth + + + + The height, in pixels, of the contents. For example, + the image height or the video frame height + + kMDItemPixelHeight + + + + Focal length of the lens, in millimeters + + kMDItemFocalLength + + + + ISO speed + + kMDItemISOSpeed + + + + Orientation of the document. Possible values are 0 + (landscape) and 1 (portrait) + + kMDItemOrientation + + + + Exposure time, in seconds + + kMDItemExposureTimeSeconds + + + + The musical genre of the song or composition + + kMDItemMusicalGenre + + + +
+ + + + References + + + + MDItem + + + + Tracker + + + + + Starting and stopping Netatalk diff --git a/doc/manual/install.xml b/doc/manual/install.xml index d51378d4..9b9d8f37 100644 --- a/doc/manual/install.xml +++ b/doc/manual/install.xml @@ -1,7 +1,7 @@ - 4.6.2013 + 4.8.2013 Installation @@ -158,28 +158,9 @@ remote: Counting objects: 2503, done. Berkeley DB BDB - Berkeley DB . - - At the time of writing, the following versions are - supported: - - - - minimum 4.6.x - - - - In case Berkeley DB is not installed on your system, please - download it from: - - - http://www.oracle.com/technetwork/products/berkeleydb/downloads/index.html - - and follow the installation - instructions. + At the time of writing you need at least version 4.6. @@ -211,14 +192,7 @@ remote: Counting objects: 2503, done. url="http://projects.gnome.org/tracker/">Tracker as the metadata backend. Recent Linux distributions will provide the libtracker-sparql library which is available since Tracker version - 0.7. This version is referred to as Tracker SPARQL. - - Other system like FreeBSD, Solaris and systems derived from - Solaris will only ship an older Tracker version 0.6 which only - offers a much more restrcited feature set. We refer to this - version and its featureset by Tracker RDF. Solaris users are - advised to install Tracker from OpenCSW as this is at least - version 0.15 and thus supports SPARQL. + 0.7. @@ -319,14 +293,19 @@ remote: Counting objects: 2503, done. Netatalk Makefiles have been created with. - + Spotlight<indexterm> <primary>Spotlight</primary> </indexterm> - If not already installed, install the following additional - packages: tracker and tracker-devel, on Solaris install OpenCSW and - Tracker packages from OpenCSW unstable repository. + Netatalk uses Gnome Tracker as the + metadata backend. The minimum required version is 0.7 as that's the + first version to support SPARQL. + + If not already installed, install the packages + tracker and tracker-devel, + on Solaris install OpenCSW and then install + the Tracker package from the OpenCSW unstable repository. The tracker packages are found via pkg-config, you may have to pass the version suffix as you may have a newer version installed then @@ -343,7 +322,8 @@ tracker-miner-0.16 tracker-miner - A library to develop tracker data minersIf you're using Solaris and Tracker from OpenCSW, then you need to set the PKG_CONFIG_PATH environment variable, add the - --with-tracker-prefix configure option and add LDFLAGS="-R/opt/csw/lib" + --with-tracker-prefix configure option and add + LDFLAGS="-R/opt/csw/lib" PKG_CONFIG_PATH=/opt/csw/lib/pkgconfig LDFLAGS="-R/opt/csw/lib" ./configure --with-tracker-prefix=/opt/csw --with-tracker-pkgconfig-version=0.16 ... diff --git a/man/man5/afp.conf.5.in b/man/man5/afp.conf.5.in index ab380e89..f8ade925 100644 --- a/man/man5/afp.conf.5.in +++ b/man/man5/afp.conf.5.in @@ -571,7 +571,7 @@ and should be quoted\&. Extended characters are allowed\&. ignored attributes = \fIall | nowrite | nodelete | norename\fR \fB(G)/(V)\fR .RS 4 Speficy a set of file and directory attributes that shall be ignored by the server, -all +\fBall\fR includes all the other options\&. .sp In OS X when the Finder sets a lock on a file/directory or you set the BSD uchg flag in the Terminal, all three attributes are used\&. Thus in order to ignore the Finder lock/BSD uchg flag, add set