[tracker] Updated man pages for .cfg files



commit 62a1f7c6dc210a0fb79cbd3b1b76a9d272746889
Author: Martyn Russell <martyn lanedo com>
Date:   Mon Sep 7 12:05:19 2009 +0100

    Updated man pages for .cfg files
    
    Added
      tracker-extract.cfg.5
      tracker-fts.cfg.5
      tracker-miner-fs.cfg.5
      tracker-store.cfg.5
    
    Removed
      tracker.cfg.5
    
    Updated other binary docs to include SEE ALSO links for .cfg files

 docs/manpages/Makefile.am            |    5 +-
 docs/manpages/tracker-extract.1      |    3 +
 docs/manpages/tracker-extract.cfg.5  |   25 ++++
 docs/manpages/tracker-fts.cfg.5      |   32 +++++
 docs/manpages/tracker-miner-fs.1     |    4 +-
 docs/manpages/tracker-miner-fs.cfg.5 |   94 ++++++++++++++
 docs/manpages/tracker-store.1        |   10 +-
 docs/manpages/tracker-store.cfg.5    |   29 +++++
 docs/manpages/tracker.cfg.5          |  226 ----------------------------------
 9 files changed, 195 insertions(+), 233 deletions(-)
---
diff --git a/docs/manpages/Makefile.am b/docs/manpages/Makefile.am
index 7aa3b14..4401925 100644
--- a/docs/manpages/Makefile.am
+++ b/docs/manpages/Makefile.am
@@ -14,16 +14,19 @@ endif
 
 man_MANS = 			\
 	tracker-extract.1	\
+	tracker-extract.cfg.5	\
+	tracker-fts.cfg.5	\
 	tracker-import.1	\
 	tracker-info.1		\
 	tracker-miner-fs.1	\
+	tracker-miner-fs.cfg.5	\
 	tracker-search.1	\
 	tracker-sparql.1	\
 	tracker-stats.1		\
 	tracker-status.1	\
 	tracker-store.1		\
+	tracker-store.cfg.5	\
 	tracker-tag.1		\
-	tracker.cfg.5		\
 	$(tst)			\
 	$(ta)			\
 	$(tp)
diff --git a/docs/manpages/tracker-extract.1 b/docs/manpages/tracker-extract.1
index 49d7350..417be80 100644
--- a/docs/manpages/tracker-extract.1
+++ b/docs/manpages/tracker-extract.1
@@ -51,3 +51,6 @@ $ echo -e "/x/y/z.mp3\\naudio/mpeg" | tracker-extract
 .BR tracker-sparql (1),
 .BR tracker-stats (1),
 .BR tracker-info (1).
+
+.TR
+.BR tracker-extract.cfg (5).
diff --git a/docs/manpages/tracker-extract.cfg.5 b/docs/manpages/tracker-extract.cfg.5
new file mode 100644
index 0000000..4d344db
--- /dev/null
+++ b/docs/manpages/tracker-extract.cfg.5
@@ -0,0 +1,25 @@
+.TH tracker-extract.cfg 5 "September 2009" GNU "Configuration Files"
+
+.SH NAME
+tracker-extract.cfg \- Configuration file for tracker-extract
+
+.SH DESCRIPTION
+This file resides in $HOME/.config/tracker/ and uses the common .ini format, i.e.
+
+.PP
+  [Group]
+  # Comment
+  Key=Value
+
+.SH SECTIONS
+
+.SS [General]
+.TP
+.B Verbosity
+Log verbosity, 0=errors, 1=minimal, 2=detailed, 3=debug.
+
+.SH SEE ALSO
+.BR tracker-extract (1),
+.BR tracker-fts.cfg (5),
+.BR tracker-miner-fs.cfg (5),
+.BR tracker-store.cfg (5).
\ No newline at end of file
diff --git a/docs/manpages/tracker-fts.cfg.5 b/docs/manpages/tracker-fts.cfg.5
new file mode 100644
index 0000000..96dc11a
--- /dev/null
+++ b/docs/manpages/tracker-fts.cfg.5
@@ -0,0 +1,32 @@
+.TH tracker-fts.cfg 5 "September 2009" GNU "Configuration Files"
+
+.SH NAME
+tracker-fts.cfg \- Configuration file for tracker-fts.so SQLite module
+
+.SH DESCRIPTION
+This file resides in $HOME/.config/tracker/ and uses the common .ini format, i.e.
+
+.PP
+  [Group]
+  # Comment
+  Key=Value
+
+.SH SECTIONS
+
+.SS [Indexing]
+.TP
+.B MinWordLength=3
+Set the minimum length of words to index (0->30).
+
+.TP
+.B MaxWordLength=30
+Set the maximum length of words to index (0->200).
+
+.TP
+.B MaxWordsToIndex=10000
+Maximum unique words to index from a file's content.
+
+.SH SEE ALSO
+.BR tracker-extract.cfg (5),
+.BR tracker-miner-fs.cfg (5),
+.BR tracker-store.cfg (5).
\ No newline at end of file
diff --git a/docs/manpages/tracker-miner-fs.1 b/docs/manpages/tracker-miner-fs.1
index 8af4ca2..eee8ff3 100644
--- a/docs/manpages/tracker-miner-fs.1
+++ b/docs/manpages/tracker-miner-fs.1
@@ -34,4 +34,6 @@ Sets the initial sleep time before crawling the file system is started.
 .SH SEE ALSO
 .BR tracker-store (1),
 .BR tracker-info (1).
-.BR tracker.cfg (5).
+
+.TR
+.BR tracker-miner-fs.cfg (5).
diff --git a/docs/manpages/tracker-miner-fs.cfg.5 b/docs/manpages/tracker-miner-fs.cfg.5
new file mode 100644
index 0000000..dd5797d
--- /dev/null
+++ b/docs/manpages/tracker-miner-fs.cfg.5
@@ -0,0 +1,94 @@
+.TH tracker-miner-fs.cfg 5 "September 2009" GNU "Configuration Files"
+
+.SH NAME
+tracker-miner-fs.cfg \- Configuration file for tracker-miner-fs
+
+.SH DESCRIPTION
+This file resides in $HOME/.config/tracker/ and uses the common .ini format, i.e.
+
+.PP
+  [Group]
+  # Comment
+  Key=Value
+
+.SH SECTIONS
+
+.SS [General]
+.TP
+.B Verbosity
+Log verbosity, 0=errors, 1=minimal, 2=detailed, 3=debug.
+
+.TP
+.B InitialSleep=15
+Time in seconds before crawling filesystem (0->1000).
+
+.SS [Monitors]
+.TP
+.B EnableMonitors=true
+Set to false to completely disable any monitoring.
+
+.TP
+.B ScanTimeout=0
+Time in seconds between same events to prevent flooding (0->1000).
+
+.TP
+.B CacheTimeout=60
+Time in seconds for events to be cached (0->1000).
+
+.SS [Indexing]
+.TP
+.B Throttle=0
+Sets the indexing speed (0->20, where 20=slowest speed).
+
+.TP
+.B EnableThumbnails=true
+Set to false to completely disable thumbnail generation.
+
+.TP
+.B IndexOnBattery=false
+Set to true to index while running on battery.
+
+.TP
+.B IndexOnBatteryFirstTime=true
+Set to true to index while running on battery for the first time only.
+
+.TP
+.B IndexMountedDirectories=true
+Set to true to enable traversing mounted directories on other file
+systems (this excludes removable devices).
+
+.TP
+.B IndexRemovableMedia=true
+Set to true to enable traversing mounted directories for removable
+devices.
+
+.TP
+.B LowDiskSpaceLimit=1
+Pause indexer when disk space is <= this value (0->100, value is in %
+of $HOME file system, -1=disable pausing).
+
+.TP
+.B IndexRecursiveDirectories=$HOME;
+List of directories to crawl recursively for indexing (separator=;).
+
+.TP
+.B IndexSingleDirectories=
+List of directories to index but not sub-directories for changes (separator=;).
+
+.TP
+.B IgnoredDirectories=po;CVS;.svn;.git;core-dumps;
+List of directories to NOT crawl for indexing (separator=;).
+
+.TP
+.B IgnoredDirectoriesWithContent=backup.metadata;
+List of directories to NOT crawl for indexing based on child files (separator=;).
+
+.TP
+.B IgnoredFiles=*~;*.o;
+List of files to NOT index (separator=;).
+
+.SH SEE ALSO
+.BR tracker-miner-fs (1),
+.BR tracker-extract.cfg (5),
+.BR tracker-fts.cfg (5),
+.BR tracker-store.cfg (5).
\ No newline at end of file
diff --git a/docs/manpages/tracker-store.1 b/docs/manpages/tracker-store.1
index 9abe23e..26c8ff4 100644
--- a/docs/manpages/tracker-store.1
+++ b/docs/manpages/tracker-store.1
@@ -111,15 +111,15 @@ needs a
 to be running within your current session.
 
 .SH SEE ALSO
+.TR
 .BR tracker-applet (1),
 .BR tracker-search-tool (1),
 .BR tracker-search (1),
 .BR tracker-tag (1),
 .BR tracker-stats (1),
-.BR tracker-query (1),
-.BR tracker-meta-folder (1),
-.BR tracker-files (1),
 .BR tracker-services (1),
 .BR tracker-info (1),
-.BR tracker-status (1),
-.BR tracker-services (1)
+.BR tracker-status (1).
+
+.TR
+.BR tracker-store.cfg (5).
diff --git a/docs/manpages/tracker-store.cfg.5 b/docs/manpages/tracker-store.cfg.5
new file mode 100644
index 0000000..3a68166
--- /dev/null
+++ b/docs/manpages/tracker-store.cfg.5
@@ -0,0 +1,29 @@
+.TH tracker-store.cfg 5 "September 2009" GNU "Configuration Files"
+
+.SH NAME
+tracker-store.cfg \- Configuration file for tracker-store
+
+.SH DESCRIPTION
+This file resides in $HOME/.config/tracker/ and uses the common .ini format, i.e.
+
+.PP
+  [Group]
+  # Comment
+  Key=Value
+
+.SH SECTIONS
+
+.SS [General]
+.TP
+.B Verbosity
+Log verbosity, 0=errors, 1=minimal, 2=detailed, 3=debug.
+
+.TP
+.B LowMemoryMode=false
+Minimizes memory use at the expense of indexing speed.
+
+.SH SEE ALSO
+.BR tracker-store (1),
+.BR tracker-extract.cfg (5),
+.BR tracker-fts.cfg (5),
+.BR tracker-miner-fs.cfg (5).



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]