X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=doc%2Fmanual%2Fconfiguration.xml;h=941ecec322734283fe146d251d25a699679e2e2f;hb=22fc09809589e0dff0d9b1e1ff1647206f052fad;hp=36e9dad3d8701ea8e7e5a834c6f28f7132514974;hpb=3a16f6dfaf832c1e50086579bc7c4f774ed686a9;p=netatalk.git
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
- Spotlight
-
-
- 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
-
-
-
-
-
CNIDCNID
@@ -1956,6 +1517,487 @@ aclmode = passthrough
+
+ Spotlight
+ Spotlight
+
+
+ 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
+
+
+
+