[tracker] Updated man pages

From: Martyn James Russell <mr src gnome org>
To: svn-commits-list gnome org
Cc:
Subject: [tracker] Updated man pages
Date: Fri, 25 Sep 2009 09:18:36 +0000 (UTC)
commit ae0d2a714cb38fb842154fa1143ef979db2e5158
Author: Martyn Russell <martyn lanedo com>
Date:   Fri Sep 25 10:13:52 2009 +0100

    Updated man pages
    
    Added man pages for:
    
      tracker-processes
      tracker-search-bar
    
    Updated some old texts left in others.

 docs/manpages/tracker-extract.1     |    5 +-
 docs/manpages/tracker-info.1        |    3 +-
 docs/manpages/tracker-miner-fs.1    |    6 +-
 docs/manpages/tracker-preferences.1 |    9 ++-
 docs/manpages/tracker-processes.1   |   48 +++++++++++++
 docs/manpages/tracker-search-bar.1  |   23 ++++++
 docs/manpages/tracker-search.1      |   30 ++++----
 docs/manpages/tracker-sparql.1      |    3 +-
 docs/manpages/tracker-stats.1       |    4 +-
 docs/manpages/tracker-status-icon.1 |   28 ++++++--
 docs/manpages/tracker-store.1       |  129 ++++++++++++++--------------------
 11 files changed, 176 insertions(+), 112 deletions(-)
---
diff --git a/docs/manpages/tracker-extract.1 b/docs/manpages/tracker-extract.1
index acdd9bc..a908ff5 100644
--- a/docs/manpages/tracker-extract.1
+++ b/docs/manpages/tracker-extract.1
@@ -4,7 +4,7 @@
 tracker-extract \- Extract metadata from a file.
 
 .SH SYNOPSYS
-\fBtracker-extract\fR [\fIOPTIONS\fR] \fIFILE\fR...
+\fBtracker-extract\fR [\fIOPTION\fR...] \fIFILE\fR...
 
 .SH DESCRIPTION
 .B tracker-extract
@@ -46,6 +46,9 @@ Using tracker-extract from command line to extract metadata from one file:
 .BR
 $ echo -e "/x/y/z.mp3\\naudio/mpeg" | tracker-extract
 
+.SH FILES
+.I $HOME/.config/tracker/tracker-extract.cfg
+
 .SH SEE ALSO
 .BR tracker-store (1),
 .BR tracker-sparql (1),
diff --git a/docs/manpages/tracker-info.1 b/docs/manpages/tracker-info.1
index c7b822b..9eb831c 100644
--- a/docs/manpages/tracker-info.1
+++ b/docs/manpages/tracker-info.1
@@ -4,8 +4,7 @@
 tracker-info \- Retrieve all information available for a certain file.
 
 .SH SYNOPSIS
-\fBtracker-info\fR 
-\fIFILE\fR
+\fBtracker-info\fR [\fIOPTION\fR...] \fIFILE\fR...
 
 .SH DESCRIPTION
 .B tracker-info
diff --git a/docs/manpages/tracker-miner-fs.1 b/docs/manpages/tracker-miner-fs.1
index 9037beb..fffe428 100644
--- a/docs/manpages/tracker-miner-fs.1
+++ b/docs/manpages/tracker-miner-fs.1
@@ -4,8 +4,7 @@
 tracker-miner-fs \- Used to crawl the file system to mine data.
 
 .SH SYNOPSIS
-\fBtracker-miner-fs\fR 
-[-v \fIVERBOSITY\fR] [-s \fISLEEP\fR]
+\fBtracker-miner-fs\fR [\fIOPTION\fR...]
 
 .SH DESCRIPTION
 .B tracker-miner-fs
@@ -31,6 +30,9 @@ Sets the logging level, 0=errors, 1=minimal, 2=detailed, 3=debug.
 .B \-s, \-\-initial-sleep=SECONDS
 Sets the initial sleep time before crawling the file system is started.
 
+.SH FILES
+.I $HOME/.config/tracker/tracker-miner-fs.cfg
+
 .SH SEE ALSO
 .BR tracker-store (1),
 .BR tracker-info (1).
diff --git a/docs/manpages/tracker-preferences.1 b/docs/manpages/tracker-preferences.1
index 29e7180..2ae200a 100644
--- a/docs/manpages/tracker-preferences.1
+++ b/docs/manpages/tracker-preferences.1
@@ -1,7 +1,7 @@
-.TH tracker-preferences 1 "November, 2007" GNU "User Commands"
+.TH tracker-preferences 1 "September 2009" GNU "User Commands"
 
 .SH NAME
-tracker-preferences \- Preferences editor for tracker-store
+tracker-preferences \- Preferences editor for tracker-miner-fs
 
 .SH SYNOPSIS
 .B tracker-preferences
@@ -9,8 +9,9 @@ tracker-preferences \- Preferences editor for tracker-store
 .SH DESCRIPTION
 .B tracker-preferences
 is a graphical configuration front end for the
-.BR tracker-store (1)
-indexer and search daemon.
+.BR tracker-miner-fs (1)
+which crawls and mines data from the filesystem to be stored in the
+Tracker databases.
 
 .SH SEE ALSO
 .BR tracker-search-tool (1),
diff --git a/docs/manpages/tracker-processes.1 b/docs/manpages/tracker-processes.1
new file mode 100644
index 0000000..bf5201d
--- /dev/null
+++ b/docs/manpages/tracker-processes.1
@@ -0,0 +1,48 @@
+.TH tracker-processes 1 "September 2009" GNU "User Commands"
+
+.SH NAME
+tracker-processes \- Manage Tracker processes and data
+
+.SH SYNOPSIS
+\fBtracker-processes\fR [\fIOPTION\fR...]
+
+.SH DESCRIPTION
+.B tracker-processes
+lists all tracker related processes when no
+\fIOPTION\fRs are specified.
+
+.SH OPTIONS
+.TP
+.B \-?, \-\-help
+Show summary of options.
+.TP
+.B \-k, \-\-kill
+This uses SIGKILL to stop all Tracker processes found. This is not
+advised unless you are having problems stopping Tracker in the first
+place. This 
+.B GUARANTEES
+death.
+.TP
+.B \-t, \-\-terminate
+This uses SIGTERM to stop all Tracker processes found. This is
+recommended over \-\-kill because it gives the processes time to
+shutdown cleanly.
+.TP
+.B \-s, \-\-soft-reset
+A soft reset works exactly the same way that 
+.B \-\-hard-reset 
+does, with the exception that the backup and journal are not removed.
+These are restored when 
+.B tracker-store
+is restarted.
+
+.TP
+.B \-h, \-\-hard-reset
+This kills all processes in the same way that 
+.B \-\-kill
+does but it also removes all databases. Restarting 
+.B tracker-store
+re-creates the databases.
+
+.SH SEE ALSO
+.BR tracker-store (1).
diff --git a/docs/manpages/tracker-search-bar.1 b/docs/manpages/tracker-search-bar.1
new file mode 100644
index 0000000..49dc71b
--- /dev/null
+++ b/docs/manpages/tracker-search-bar.1
@@ -0,0 +1,23 @@
+.TH tracker-search-bar 1 "September 2009" GNU "User Commands"
+
+.SH NAME
+tracker-search-bar \- Search applet for the GNOME panel
+
+.SH SYNOPSIS
+.B tracker-search-bar
+
+.SH DESCRIPTION
+.B tracker-search-bar
+is a graphical front end applet for the GNOME panel which allows basic
+searching of common categories using Full Text Searching (FTS). This
+means, that searching for \fIcar\fR will find files like
+\fIcarlos.png\fR, \fIcar-tax.pdf\fR, etc. 
+
+.B tracker-search-bar
+currently extends to images, videos, music, folders and documents. The 
+applet is meant to quickly be able to access the top hits associated
+with your search terms from the desktop at any time.
+
+.SH SEE ALSO
+.BR tracker-search-tool (1),
+.BR tracker-status-icon (1).
diff --git a/docs/manpages/tracker-search.1 b/docs/manpages/tracker-search.1
index 8f62592..93537e9 100644
--- a/docs/manpages/tracker-search.1
+++ b/docs/manpages/tracker-search.1
@@ -4,9 +4,7 @@
 tracker-search \- Search all content for keywords
 
 .SH SYNOPSIS
-.B tracker-search 
-[OPTIONS]
-.I EXPRESSION
+\fBtracker-search\fR [\fIOPTION\fR...] \fIEXPRESSION\fR [\fIEXPRESSION\fR...]
 
 .SH DESCRIPTION
 .B tracker-search
@@ -29,45 +27,45 @@ and
 
 .SH OPTIONS
 .TP
-\-?, \-\-help
+.B \-?, \-\-help
 Give a short help message.
 .TP
-\-l, \-\-limit=N
+.B \-l, \-\-limit=N
 Limit search to N results. The default is 512.
 .TP
-\-o, \-\-offset=N
+.B \-o, \-\-offset=N
 Offset the search results by N. For example, start at item number 10
 in the results. The default is 0.
 .TP
-\-r, \-\-or-operator
+.B \-r, \-\-or-operator
 Use OR for search terms instead of AND (the default)
 .TP
-\-d, \-\-detailed
+.B \-d, \-\-detailed
 Show more detailed results (only applies to general search)
 .TP
-\-f, \-\-files
+.B \-f, \-\-files
 Search for files in ascending order.
 .TP
-\-e, \-\-folders
+.B \-e, \-\-folders
 Search for folders in ascending order.
 .TP
-\-a, \-\-music-albums
+.B \-a, \-\-music-albums
 Search for music albums. This also lists the song count and the sum of
 the duration of all songs associated with each album.
 .TP
-\-s, \-\-music-artists
+.B \-s, \-\-music-artists
 Search for music artists.
 .TP
-\-u, \-\-music
+.B \-u, \-\-music
 Search for music in ascending order. This returns a list of files.
 .TP
-\-l, \-\-images
+.B \-l, \-\-images
 Search for images in ascending order. This returns a list of files.
 .TP
-\-v, \-\-videos
+.B \-v, \-\-videos
 Search for videos in ascending order. This returns a list of files.
 .TP
-\-u, \-\-documents
+.B \-u, \-\-documents
 Search for documents in ascending order. This returns a list of files.
 
 .SH SEE ALSO
diff --git a/docs/manpages/tracker-sparql.1 b/docs/manpages/tracker-sparql.1
index fd2f96c..5f22d80 100644
--- a/docs/manpages/tracker-sparql.1
+++ b/docs/manpages/tracker-sparql.1
@@ -4,8 +4,7 @@
 tracker-sparql \- Use SparQL to query the Tracker databases.
 
 .SH SYNOPSIS
-\fBtracker-sparql\fR 
-[-p \fIFILE\fR | -q \fIQUERY\fR]
+\fBtracker-sparql\fR [\fIOPTION\fR...] [-q \fIQUERY\fR] | [-p \fIFILE\fR]
 
 .SH DESCRIPTION
 .B tracker-sparql
diff --git a/docs/manpages/tracker-stats.1 b/docs/manpages/tracker-stats.1
index ac6101c..5a692ec 100644
--- a/docs/manpages/tracker-stats.1
+++ b/docs/manpages/tracker-stats.1
@@ -4,7 +4,7 @@
 tracker-stats \- Provides statistics on the data available for querying
 
 .SH SYNOPSIS
-\fBtracker-stats\fR 
+\fBtracker-stats\fR [\fIOPTION\fR...]
 
 .SH DESCRIPTION
 .B tracker-stats
@@ -19,7 +19,7 @@ with
 
 .SH OPTIONS
 .TP
-\-?, --help
+.B \-?, \-\-help
 Show a brief help message.
 
 .SH SEE ALSO
diff --git a/docs/manpages/tracker-status-icon.1 b/docs/manpages/tracker-status-icon.1
index 48ff92e..f0f5bbc 100644
--- a/docs/manpages/tracker-status-icon.1
+++ b/docs/manpages/tracker-status-icon.1
@@ -1,7 +1,7 @@
-.TH tracker-applet 1 "November, 2007" GNU "User Commands"
+.TH tracker-status-icon 1 "September 2009" GNU "User Commands"
 
 .SH NAME
-tracker-status-icon \- The tracker tray-icon and on-click-search-entry
+tracker-status-icon \- Miner status and control notification area icon
 
 .SH SYNOPSIS
 .B tracker-status-icon
@@ -10,12 +10,26 @@ tracker-status-icon \- The tracker tray-icon and on-click-search-entry
 .B tracker-status-icon
 is a
 .BR tracker-store (1)
-system tray icon, meant to provide a fast way of accessing tracker's
-database, configuring tracker through
-.BR tracker-preferences
-and displaying information, by means of popups and icon changes to the
-user.
+notification area icon meant to provide a fast way to check the
+status of Tracker's data miner and to be able to control those miners
+with simple commands like pause and resume.
+
+When clicking on the icon, a list of data miners is presented. In this
+list there is an image to the left which indicates the paused or
+non-paused state. There is also a progress bar which indicates how far
+through the work load the data miner is.
+
+Each miner can be paused/resumed by clicking on it in the menu.
+
+From the context menu,
+.B tracker-status-icon 
+allows the user to configure the preferences of 
+.B tracker-miner-fs
+using the
+.B tracker-preferences
+application.
 
 .SH SEE ALSO
 .BR tracker-search-tool (1),
+.BR tracker-preferences (1),
 .BR tracker-store (1).
diff --git a/docs/manpages/tracker-store.1 b/docs/manpages/tracker-store.1
index 58ac93c..31ce83b 100644
--- a/docs/manpages/tracker-store.1
+++ b/docs/manpages/tracker-store.1
@@ -1,85 +1,58 @@
-.TH tracker-store 1 "Jan 2008" GNU "User Commands"
+.TH tracker-store 1 "September 2009" GNU "User Commands"
 
 .SH NAME
-tracker-store \- indexer daemon for tracker search tool
+tracker-store \- database indexer and query daemon
 
 .SH SYNOPSIS
-.B tracker-store [OPTIONS]
+\fBtracker-store\fR [\fIOPTION\fR...]
 
 .SH DESCRIPTION
-.B Trackerd
-provides both a powerful indexer and an extensible metadata database. It
-indexes files including the text contents and any available metadata to
-provide fast search services.
+.B tracker-store
+provides both a powerful database daemon which allows clients to query
+or update their data using the highly descriptive 
+.B SPARQL
+language.
+.PP
+.B tracker-store
+does not do any file crawling or any mining of data itself, instead
+other processes do that and serves as a daemon waiting for such
+requests from application miners like 
+.B tracker-miner-fs.
 .PP
-By default, tracker-store will index all files in a user's home directory (with
-the exception of hidden files). This can be overridden by specifying
-one or more directories to be indexed instead in the configuration file
-($HOME/.config/tracker/tracker.cfg) and/or by using the --include-dir
-option to specify other directories to be indexed.
+For help on how to configure this daemon, see the man page for
+.B tracker-store.cfg.
 
 .SH OPTIONS
 .TP
-\-?, --help
+.B \-?, \-\-help
 A brief help message including some examples.
-
 .TP
-\-e, --monitors-exclude-dir=/PATH/DIR
-Specifies a directory to be excluded from indexing (including all
-subdirectories). Can be repeated (-e <path> -e <path>) to exclude 
-more than one directory.
-
+.B \-V, \-\-version
+Returns the version of this binary.
 .TP
-\-i, --monitors-include-dir=/PATH/DIR
-Specifies a directory to be included for indexing. All non-hidden
-subdirectories of the specified directory will also be indexed. If this
-param is set then the user's home directory is no longer indexed by
-default (you can still add the home directory with this option).
-
+.B \-v, \-\-verbosity={0|1|2|3}
+Sets the logging level, 0=errors, 1=minimal, 2=detailed, 3=debug.
 .TP
-\-c, --crawler-include-dirs=/PATH/DIR
-Specify directories to crawl. Crawling of directories means index every
-indexable content but do not watch for directory or file changes.
-
+.B \-r, \-\-force-reindex
+This forces tracker-store to remove databases and to recreate fresh
+databases ready for data insertion from the miners. For more
+information about the miners, see 
+.B tracker-miner-fs.
 .TP
-\-n, --disable-indexing
-Prevent
+.B \-m, \-\-low-memory
+This changes the behavior of the database manager and some other
+parts of
 .B tracker-store
-from indexing and watching. Searching is still
-possible.
-
-.TP
-\-v, --verbosity=value
-Makes tracker-store log/print more information. Value can be one of 0 - show
-only errors, 1 - show only minimal output, 2 - show detailed output and
-3 - show debug output (don't do this, unless you know what you are doing).
-
-.TP
-\-m, --low-memory
-Minimise memory usage. Note that this may slow down indexing.
-
+to be optimized for lower memory systems by lowering database
+connection cache sizes and page sizes for example. This may slow down
+indexing performance.
 .TP
-\-s, --initial-sleep=value
-Set the initial sleep time in seconds. This is the time
+.B \-n, \-\-readonly-mode
+This starts 
 .B tracker-store
-waits at startup before indexing.
-
-.TP
-\-l, --language=value
-Language to use for stemmer and stop words list (ISO 639-1 2 characters
-code).
-
-.TP
-\-R, --force-reindex
-This forces tracker-store to re-index all watched files and directories.
-Since every watched directory and any previously indexed file has to be
-read and processed again, this may degrade the whole system performance.
-
-.TP
-\-f, --fatal-errors
-Makes any errors fatal, i.e. forces abortion of
-.B tracker-store.
-This switch is only useful for debugging.
+in a mode which disables writing to the database. Only 
+.B SPARQL
+read requests can be serviced if this option is used.
 
 .SH ENVIRONMENT
 .TP
@@ -96,19 +69,16 @@ from. If unset it will default to the correct place. This is used
 mainly for testing purposes.
 
 .SH FILES
-.I $HOME/.config/tracker/tracker.cfg
-.RS
-Trackerd user configuration file. See
-.BR tracker.cfg (5)
-and
-.BR tracker-preferences (1)
-for further details.
+.I $HOME/.config/tracker/tracker-store.cfg
+.I $HOME/.config/tracker/tracker-fts.cfg
 
 .SH NOTES
-.B Trackerd
-needs a
+.B tracker-store
+is highly bound to the D-Bus freedesktop project. A D-Bus session is
+needed for all Tracker processes to communicate between each other.
+D-Bus is our acting IPC. See
 .BR dbus-daemon(1)
-to be running within your current session.
+for more information.
 
 .SH SEE ALSO
 .BR tracker-applet (1),
@@ -119,5 +89,12 @@ to be running within your current session.
 .BR tracker-services (1),
 .BR tracker-info (1),
 .BR tracker-status (1).
-.TP
-.BR tracker-store.cfg (5).
+
+.BR tracker-store.cfg (5),
+.BR tracker-fts.cfg (5).
+
+.BR http://www.w3.org/TR/rdf-sparql-query/
+
+.BR dbus-daemon (1),
+
+.BR http://www.freedesktop.org/wiki/Software/dbus
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]