GNOME.org
 

tracker r2308 - in trunk: . docs/manpages src/libtracker-common

Author: ifrade
Date: Fri Oct  3 16:35:25 2008
New Revision: 2308
URL: http://svn.gnome.org/viewvc/tracker?rev=2308&view=rev

Log:
Updated man pages

Added:
   trunk/docs/manpages/tracker-services.1
Removed:
   trunk/docs/manpages/tracker-services.7
Modified:
   trunk/ChangeLog
   trunk/docs/manpages/Makefile.am
   trunk/docs/manpages/tracker-extract.1
   trunk/docs/manpages/tracker-files.1
   trunk/docs/manpages/tracker-meta-folder.1
   trunk/docs/manpages/tracker-query.1
   trunk/docs/manpages/tracker-search-tool.1
   trunk/docs/manpages/tracker-search.1
   trunk/docs/manpages/tracker-stats.1
   trunk/docs/manpages/tracker-tag.1
   trunk/docs/manpages/tracker-thumbnailer.1
   trunk/docs/manpages/tracker.cfg.5
   trunk/docs/manpages/trackerd.1
   trunk/src/libtracker-common/tracker-config.c

Modified: trunk/docs/manpages/Makefile.am
==============================================================================
--- trunk/docs/manpages/Makefile.am	(original)
+++ trunk/docs/manpages/Makefile.am	Fri Oct  3 16:35:25 2008
@@ -24,7 +24,9 @@
 	tracker-tag.1		\
 	tracker-status.1	\
 	tracker.cfg.5		\
-	tracker-services.7	\
+	tracker-services.1	\
+	tracker-info.1		\
+	tracker-unique.1	\
 	$(tst)			\
 	$(ta)			\
 	$(tp)

Modified: trunk/docs/manpages/tracker-extract.1
==============================================================================
--- trunk/docs/manpages/tracker-extract.1	(original)
+++ trunk/docs/manpages/tracker-extract.1	Fri Oct  3 16:35:25 2008
@@ -5,12 +5,17 @@
 
 .SH SYNOPSYS
 .B tracker-extract
-.I file
 
 .SH DESCRIPTION
 .B tracker-extract
-read the file provided in paramater and extract the metadata from this
+read the file and mimetype provided in stdin and extract the metadata from this
 file; then it displays the metadata on the standard output.
 
+.SH EXAMPLES
+.TP
+Using tracker-extract from command line to extract metadata from one file:
+.BR
+$ echo -e "/x/y/z.mp3\\naudio/mpeg" | tracker-extract
+
 .SH SEE ALSO
 .BR trackerd (1)

Modified: trunk/docs/manpages/tracker-files.1
==============================================================================
--- trunk/docs/manpages/tracker-files.1	(original)
+++ trunk/docs/manpages/tracker-files.1	Fri Oct  3 16:35:25 2008
@@ -10,15 +10,14 @@
 
 .SH DESCRIPTION
 .B tracker-files
-returns files that match the ServiceType or the mime-type provided;
-you can
+returns files that match the ServiceType or the mime-type provided.
 
 .SH OPTIONS
 .TP
 \-s ServiceType
 Specify the kind of the files you want to find. For more information on
 valid ServiceType see
-.BR tracker-services (7).
+.BR tracker-services (1).
 
 .TP
 \-m MimeType
@@ -28,4 +27,4 @@
 
 .SH SEE ALSO
 .BR trackerd (1),
-.BR tracker-services (7).
+.BR tracker-services (1).

Modified: trunk/docs/manpages/tracker-meta-folder.1
==============================================================================
--- trunk/docs/manpages/tracker-meta-folder.1	(original)
+++ trunk/docs/manpages/tracker-meta-folder.1	Fri Oct  3 16:35:25 2008
@@ -1,15 +1,36 @@
 .TH tracker-meta-folder 1 "July, 2007" GNU "User Commands"
 
 .SH NAME
-tracker-meta-folder \- return list of files indexed by tracker for a folder
+tracker-meta-folder \- return list of files indexed by tracker for a
+folder with their value for the selected properties
 
 .SH SYNOPSIS
 .B tracker-meta-folder
-folder
+\-p FOLDER [Properties]
 
 .SH DESCRIPTION
 .B tracker-meta-folder
-returns the list of files indexed by tracker and stored under the folder provided as parameter.
+shows in stdout the list of files and their values for the selected
+properties indexed by tracker and stored under the
+folder provided as parameter. 
+
+.SH OPTIONS
+.TP
+\-p FOLDER
+The path you are asking for.
+
+.TP
+PROPERTIES
+A list of properties to show per file. For more information on valid
+properties see
+.BR tracker-services (1).
+
+.SH EXAMPLES
+.TP
+The mimetypes of all the files in the test/ folder:
+.BR
+$ tracker-meta-folder /x/y/test File:Mime
 
 .SH SEE ALSO
-.BR trackerd(1).
+.BR trackerd (1).
+.BR tracker-services (1)

Modified: trunk/docs/manpages/tracker-query.1
==============================================================================
--- trunk/docs/manpages/tracker-query.1	(original)
+++ trunk/docs/manpages/tracker-query.1	Fri Oct  3 16:35:25 2008
@@ -21,7 +21,7 @@
 \-s, --service=ServiceName
 Search for files from a specific service. ServiceName has to be one of
 trackers services.  For mor information on services, see
-.BR tracker-services (7).
+.BR tracker-services (1).
 
 .TP
 \-t, --search-term=SerchTerm
@@ -31,6 +31,6 @@
 \-k, --keyword=Keyword
 Adds a keyword filter to the query.
 
-.SH "SEE ALSO"
+.SH SEE ALSO
 .BR trackerd (1),
-.BR tracker-services (7).
+.BR tracker-services (1).

Modified: trunk/docs/manpages/tracker-search-tool.1
==============================================================================
--- trunk/docs/manpages/tracker-search-tool.1	(original)
+++ trunk/docs/manpages/tracker-search-tool.1	Fri Oct  3 16:35:25 2008
@@ -40,7 +40,7 @@
 .TP
 \fB\-s\fR, \fB\-\-service\fR=\fISERVICE\fR
 Search from a specific service. See
-.BR tracker-services (7)
+.BR tracker-services (1)
 for more information.
 .TP
 \fB\-\-display\fR=\fIDISPLAY\fR
@@ -49,7 +49,7 @@
 .SH SEE ALSO
 .BR tracker-search (1),
 .BR trackerd (1),
-.BR tracker-services (7).
+.BR tracker-services (1).
 
 .SH AUTHOR
 tracker-search-tool was written by Jamie McCracken <jamiemcc gnome org>.

Modified: trunk/docs/manpages/tracker-search.1
==============================================================================
--- trunk/docs/manpages/tracker-search.1	(original)
+++ trunk/docs/manpages/tracker-search.1	Fri Oct  3 16:35:25 2008
@@ -7,7 +7,7 @@
 .SH SYNOPSIS
 .B tracker-search
 [OPTIONS]
-.I expression
+.I EXPRESION
 
 .SH DESCRIPTION
 .B tracker-search
@@ -24,6 +24,10 @@
 Give a short help message.
 
 .TP
+\fIEXPRESSION\fR
+One or more terms to search. The default operation is a logical AND.
+
+.TP
 \-l, --limit=N
 Limit search to N results.
 
@@ -31,9 +35,9 @@
 \-s, --service=SERVICE
 Search by a specific service. For more information on tracker services,
 see
-.BR tracker-services (7).
+.BR tracker-services (1).
 
 .SH "SEE ALSO"
 .BR trackerd (1),
 .BR tracker-search-tool (1),
-.BR tracker-services (7).
+.BR tracker-services (1).

Added: trunk/docs/manpages/tracker-services.1
==============================================================================
--- (empty file)
+++ trunk/docs/manpages/tracker-services.1	Fri Oct  3 16:35:25 2008
@@ -0,0 +1,60 @@
+.TH tracker-services 7 "July 2007" GNU "Conventions"
+
+.SH NAME
+tracker-services \- service types of trackerd
+
+.SH INTRODUCTION
+Trackerd understands a number of different services which are used to
+group search results and documents together. All searches and queries can
+be refined by specifying a service to search from.
+.PP
+For example one could search for "Roses" in the service Conversations
+which would only return hits from chat conversations.
+
+.SH SERVICE TYPES
+.TP
+Files
+Search for files only. This does not include Emails or Conversations.
+.TP
+Folders
+Search for folders i.e. directories.
+.TP
+Documents
+Searches for general documents like word processing,
+spreadsheets or text files.
+.TP
+Emails
+Searches for Emails.
+.TP
+EmailAttachments
+Search es for Email attachments.
+.TP
+Music
+Search for music files.
+.TP
+Images
+Search for image files.
+.TP
+Videos
+Search for video files.
+.TP
+Text
+Search for text files, like word processing files, but e.g. not
+spreadsheets.
+.TP
+Development
+Search for development files. This includes make files,
+source code files and the like.
+.TP
+Other
+Search for documents which could not be put in one of the other services.
+.TP
+Applications
+Search for applications.
+
+.SH SEE ALSO
+.BR trackerd (1),
+.BR tracker-search (1),
+.BR tracker-search-tool (1),
+.BR tracker-query (1),
+.BR tracker-files (1).

Modified: trunk/docs/manpages/tracker-stats.1
==============================================================================
--- trunk/docs/manpages/tracker-stats.1	(original)
+++ trunk/docs/manpages/tracker-stats.1	Fri Oct  3 16:35:25 2008
@@ -18,7 +18,7 @@
 \-?, --help
 Show a brief help message.
 
-.SH "SEE ALSO"
+.SH SEE ALSO
 .BR trackerd (1),
 .BR tracker-status (1),
 .BR tracker-services (7).

Modified: trunk/docs/manpages/tracker-tag.1
==============================================================================
--- trunk/docs/manpages/tracker-tag.1	(original)
+++ trunk/docs/manpages/tracker-tag.1	Fri Oct  3 16:35:25 2008
@@ -1,4 +1,4 @@
-.TH tracker-tag 1 "July, 2007" GNU "User Commands"
+.TH tracker-tag 1 "July 2007" GNU "User Commands"
 
 .SH NAME
 tracker-tag \- command line tool for setting and searching tags/keywords

Modified: trunk/docs/manpages/tracker-thumbnailer.1
==============================================================================
--- trunk/docs/manpages/tracker-thumbnailer.1	(original)
+++ trunk/docs/manpages/tracker-thumbnailer.1	Fri Oct  3 16:35:25 2008
@@ -1,12 +1,22 @@
 .TH tracker-thumbnailer 1 "July, 2007" GNU "User Commands"
 
 .SH NAME
-tracker-thumbnailer \- create freedesktop.org compliant thumbnails
+tracker-thumbnailer \- create freedesktop.org compliant thumbnails (Deprecated)
 
 .SH SYNOPSIS
 \fBtracker-thumbnailer\fR \fIFILE\fR \fIMIMETYPE\fR \fIICONSIZE\fR 
 
 .SH DESCRIPTION
+.PP
+.B IMPORTANT NOTE:
+This program is 
+.B DEPRECATED,
+in favour of the new freedesktop
+standard to request the creation of thumbnails. If your programs or
+scripts are using this program, please port your code to the new
+specification as soon as possible. This program will not be available in
+future releases.
+.PP
 .B tracker-thumbnailer
 takes an image file as input and produces a thumbnail which is compliant
 to the freedesktop.org thumbnail specification.

Modified: trunk/docs/manpages/tracker.cfg.5
==============================================================================
--- trunk/docs/manpages/tracker.cfg.5	(original)
+++ trunk/docs/manpages/tracker.cfg.5	Fri Oct  3 16:35:25 2008
@@ -28,7 +28,7 @@
 .PP
 Verbosity=0
 .PP
-InitialSleep=50
+LowMemoryMode=false
 
 .SH Sections
 .SS General
@@ -59,6 +59,9 @@
 InitialSleep=VALUE
 Sets the initial sleep time for trackerd. This is a number of seconds
 that trackerd wait before indexing.
+.TP
+NFSLocking=BOOLEAN
+Set to TRUE when the home directory is in a NFS filesystem.
 
 .SS Watches
 .TP
@@ -92,6 +95,13 @@
 EnableThumbnails=BOOLEAN
 Enable or disable the generation of thumbnails.
 .TP
+DisabledModules=MODULENAME[;MORE;MODULENAMES]
+List of disable modules (The modules are kept in $prefix/lib/tracker/indexer-modules)
+Current supported modules: evolution, applications, files, gaim-conversations
+.TP
+FastMerges=BOOLEAN
+(Deprecated) 
+.TP
 NoIndexFileTypes=FILEGLOB[;MORE;FILEGLOBS...]
 List of partial file patterns (glob) separated by semicolons that specify
 files not to index. Only basic metadata (i.e. information retrieved by
@@ -156,18 +166,28 @@
 BatteryIndexInitial=BOOLEAN
 Enable or disable initial index sweep (i.e. the very first indexing)
 when on battery power.
+.TP
+IndexMountedDirectories=BOOLEAN
+Enable or disable traversing mounted directories on other file systems
+(this excludes removable devices)
+.TP
+IndexRemovableMedia=BOOLEAN
+Enable or disable traversing mounted directories for removable devices
 
 .SS Emails
-This section may contain Email specific options.
+(Deprecated) This section may contain Email specific options.
 .TP
 IndexEvolutionEmails=BOOLEAN
-Enable or disable indexing for Evolution emails.
+(Deprecated) Enable or disable indexing for Evolution emails. 
+Use DisableModules instead.
 .TP
 IndexModestEmails=BOOLEAN
-Enable or disable indexing for Modest emails.
+(Deprecated) Enable or disable indexing for Modest emails.
+Use DisableModules instead.
 .TP
 IndexThunderbirdEmails=BOOLEAN
-Enable or disable indexing for Thunderbird emails.
+(Deprecated) Enable or disable indexing for Thunderbird emails.
+Use DisableModules instead.
 
 .SS Performance
 Trackerd performance related options.
@@ -181,7 +201,7 @@
 Defaults to 10000.
 .TP
 OptimizationSweepCount=VALUE
-Specifies the no of entities to index before determining whether to
+(Deprecated) Specifies the no of entities to index before determining whether to
 perform index optimization. Default to 10000.
 .TP
 MaxBucketCount=VALUE
@@ -191,16 +211,22 @@
 Sets the minimum bucket count. Defaults to 65536
 .TP
 Divisions=VALUE
-Sets no. of divisions of the index file. Default to 4.
+(Deprecated) Sets no. of divisions of the index file. Default to 4.
 .TP
 BucketRatio=VALUE
-Selects the desired ratio of used records to buckets to be used when
+(Deprecated) Selects the desired ratio of used records to buckets to be used when
 optimizing index (should be a value between 0 and 4). Defaults to 1.
 .TP
 Padding=VALUE
-Alters how much padding is used to prevent index relocations. Higher
+(Deprecated) Alters how much padding is used to prevent index relocations. Higher
 values improve indexing speed but waste more disk space. Value should
 be in range (1..8). Defaults to 2.
 
+.SS Services
+Extra services supported in tracker
+.TP
+EnableXesam=BOOLEAN
+Enable or disable XESAM support in tracker (still under development)
+
 .SH SEE ALSO
 .BR tracker(1)

Modified: trunk/docs/manpages/trackerd.1
==============================================================================
--- trunk/docs/manpages/trackerd.1	(original)
+++ trunk/docs/manpages/trackerd.1	Fri Oct  3 16:35:25 2008
@@ -24,24 +24,25 @@
 A brief help message including some examples.
 
 .TP
-\-e, --exclude-dir=/PATH/DIR
+\-e, --monitors-exclude-dir=/PATH/DIR
 Specifies a directory to be excluded from indexing (including all
-subdirectories). Can be repeated to exclude more than one directory.
+subdirectories). Can be repeated (-e <path> -e <path>) to exclude 
+more than one directory.
 
 .TP
-\-i, --include-dir=/PATH/DIR
+\-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).
 
 .TP
-\-c, --crawl-dir=/PATH/DIR
+\-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.
 
 .TP
-\-n, --no-indexing
+\-n, --disable-indexing
 Prevent
 .B trackerd
 from indexing and watching. Searching is still
@@ -54,11 +55,6 @@
 3 - show debug output (don't do this, unless you know what you are doing).
 
 .TP
-\-t, --throttle=value
-Value to throttle indexing. Value must be in range 0-20, with lower
-values increasing indexing speed.
-
-.TP
 \-m, --low-memory
 Minimise memory usage. Note that this may slow down indexing.
 
@@ -74,11 +70,10 @@
 code).
 
 .TP
-\-R, --reindex
+\-R, --force-reindex
 This forces trackerd 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,
-see also --throttle.
+read and processed again, this may degrade the whole system performance.
 
 .TP
 \-f, --fatal-errors
@@ -109,4 +104,5 @@
 .BR tracer-query (1),
 .BR tracker-meta-folder (1),
 .BR tracker-files (1),
-.BR tracker-services (7).
+.BR tracker-services (1).
+.BR tracker-info (1)

Modified: trunk/src/libtracker-common/tracker-config.c
==============================================================================
--- trunk/src/libtracker-common/tracker-config.c	(original)
+++ trunk/src/libtracker-common/tracker-config.c	Fri Oct  3 16:35:25 2008
@@ -843,7 +843,7 @@
 				    empty_string_list, 0);
 	g_key_file_set_comment (key_file, GROUP_INDEXING, KEY_DISABLED_MODULES,
 				" List of disabled modules (separator=;)\n"
-				" The modules that are indexed are kept in $prefix/share/tracker/modules",
+				" The modules that are indexed are kept in $prefix/lib/tracker/indexer-modules",
 				NULL);
 	g_key_file_set_boolean (key_file, GROUP_INDEXING, KEY_FAST_MERGES, DEFAULT_FAST_MERGES);
 	g_key_file_set_comment (key_file, GROUP_INDEXING, KEY_FAST_MERGES,
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]