[Tracker] manual pages
As Jamie wants to release, I took a look at the man pages. Is there any policy on how they should be handled?! I now 'fixed' up the trackerd.1 manual, following the suggestions and guidelines of man-pages(7) - as this is the first time I write/fix a manual, please comment! Kind regards, Marcus diff --git a/docs/trackerd.1 b/docs/trackerd.1 index 816a86d..deae40d 100644 --- a/docs/trackerd.1 +++ b/docs/trackerd.1 @@ -1,47 +1,101 @@ -.TH trackerd 1 September 2006 Version 0.5 +.TH trackerd 1 July 2007 GNU User Commands + .SH NAME trackerd \- indexer daemon for tracker search tool + .SH SYNOPSIS .B trackerd [OPTIONS] + .SH DESCRIPTION -.B trackerd -porvides 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. By default, trackerd will index all files in a users home directory (with -the exception of hidden files). This can be overriden by specifying one or -more directories to be indexed instead in the config file -($HOME/.Tracker/tracker.cfg) and/or by using the --include-dir param to specify -other directories to be indexed. +.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. +.PP +By default, trackerd 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.cfg) and/or by using the --include-dir option to +specify other directories to be indexed. + .SH OPTIONS + +.TP +\-?, --help +A brief help message including some examples. + .TP \-e, --exclude-dir=/PATH/DIR -Specifies directories to be excluded from indexing +Specifies a directory to be excluded from indexing (including all +subdirectories). Can be repeated to exclude more than one directory. + .TP \-i, --include-dir=/PATH/DIR -Specifies directories to be included for indexing. All non-hidden sub directories 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 to this param) +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 -\--no-indexing -Disables indexing of any files +\-n, --no-indexing +Prevent .B trackerd from indexing and watching. Searching is still +possible. + .TP -\--verbosity=value -Value that controls the level of logging to both the log file and to stdout. Valid values are 0 (default minimal), 1 (detailed) and 2 (debug) +\-v, --verbosity=value +Makes trackerd 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 -\--throttle=value -Value to use for throttling indexing. Value must be in range 0-20 (default 0) with lower values increasing indexing speed +\-t, --throttle=value +Value to throttle indexing. Value must be in range 0-20 (default 0) +with lower values increasing indexing speed. .TP \-m, --low-memory - Minimises the use of memory but may slow indexing down +Minimise memory usage. Note that this may slow down indexing. + +.TP +\-s, --initial-sleep=value +Set the initial sleep time in seconds. This is the time .B trackerd +waits at startup before indexing. + .TP \-l, --language=value - Language to use for stemmer and stop words list (ISO 639-1 2 characters code) +Language to use for stemmer and stop words list (ISO 639-1 2 characters +code). + +.TP +\-R, --reindex +This forces trackerd to reindex 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. .SH FILES -.I $HOME/.Tracker/tracker.cfg +.I $HOME/.config/tracker.cfg .RS Trackerd user configuration file. See -.BR tracker.cfg(5) +.BR tracker.cfg (5) +and +.BR tracker-preferences (1) for further details. -.SH AUTHOR -Baptiste Mille-Mathias [EMAIL PROTECTED] -Jamie McCracken jamiemcc at gnome org + +.SH NOTES +.B Trackerd +needs a +.BR dbus-daemon(1) +to be running within your current session. + +.SH SEE ALSO +.BR tracker-search (1), +.BR tracker-tag (1), +.BR tracker-stats (1), +.BR tracer-query (1), +.BR tracker-meta-folder (1), +.BR tracker-files (1), +.BR tracker-preferences (1), +.BR beagle (1), +.BR dbus-daemon (1), +.BR dbus-launch (1) ___ tracker-list mailing list tracker-list@gnome.org http://mail.gnome.org/mailman/listinfo/tracker-list
Re: [Tracker] manual pages
2007/7/18, Marcus Fritzsch [EMAIL PROTECTED]: As Jamie wants to release, I took a look at the man pages. Is there any policy on how they should be handled?! I now 'fixed' up the trackerd.1 manual, following the suggestions and guidelines of man-pages(7) - as this is the first time I write/fix a manual, please comment! Most users that have tracker installed, won't have beagle on their system, so I wouldn't include beagle in the SEE ALSO list. Just seems a bit odd to include beagle there... I also wouldn't include dbus-daemon/dbus-launch in the SEE ALSO list (you already reference dbus-daemon in NOTES). dbus-launch is also not necessarily installed (e.g. if your dbus-daemon is autostarted by gnome-session) As a last point, tracker.cfg (5) is not (yet) written. So we should either write a tracker.cfg manpage or remove the tracker.cfg (5) reference from FILES. I of course would welcome the former ;-) Michael -- Why is it that all of the instruments seeking intelligent life in the universe are pointed away from Earth? ___ tracker-list mailing list tracker-list@gnome.org http://mail.gnome.org/mailman/listinfo/tracker-list
Re: [Tracker] manual pages
On Wed, 2007-07-18 at 14:39 +0200, Michael Biebl wrote: 2007/7/18, Marcus Fritzsch [EMAIL PROTECTED]: As Jamie wants to release, I took a look at the man pages. Is there any policy on how they should be handled?! I now 'fixed' up the trackerd.1 manual, following the suggestions and guidelines of man-pages(7) - as this is the first time I write/fix a manual, please comment! Most users that have tracker installed, won't have beagle on their system, so I wouldn't include beagle in the SEE ALSO list. Just seems a bit odd to include beagle there... I also wouldn't include dbus-daemon/dbus-launch in the SEE ALSO list (you already reference dbus-daemon in NOTES). dbus-launch is also not necessarily installed (e.g. if your dbus-daemon is autostarted by gnome-session) As a last point, tracker.cfg (5) is not (yet) written. So we should either write a tracker.cfg manpage or remove the tracker.cfg (5) reference from FILES. I of course would welcome the former ;-) yeah I have to agree ___ tracker-list mailing list tracker-list@gnome.org http://mail.gnome.org/mailman/listinfo/tracker-list
Re: [Tracker] manual pages
HI, On 7/18/07, Michael Biebl [EMAIL PROTECTED] wrote: 2007/7/18, Marcus Fritzsch [EMAIL PROTECTED]: As Jamie wants to release, I took a look at the man pages. Is there any policy on how they should be handled?! I now 'fixed' up the trackerd.1 manual, following the suggestions and guidelines of man-pages(7) - as this is the first time I write/fix a manual, please comment! Most users that have tracker installed, won't have beagle on their system, so I wouldn't include beagle in the SEE ALSO list. Just seems a bit odd to include beagle there... Yep ;) I thought of SEE ALSO being a selection of relating material, i.e. also those referenced in the text... Am I worng here? I also wouldn't include dbus-daemon/dbus-launch in the SEE ALSO list (you already reference dbus-daemon in NOTES). dbus-launch is also not necessarily installed (e.g. if your dbus-daemon is autostarted by gnome-session) Usually yes - ok. As a last point, tracker.cfg (5) is not (yet) written. So we should either write a tracker.cfg manpage or remove the tracker.cfg (5) reference from FILES. I of course would welcome the former ;-) Hehe, I know it's not there ;), but I thought that might change until release ;) Thanks, Marcus ___ tracker-list mailing list tracker-list@gnome.org http://mail.gnome.org/mailman/listinfo/tracker-list
Re: [Tracker] manual pages
On 7/18/07, Michael Biebl [EMAIL PROTECTED] wrote: 2007/7/18, Marcus Fritzsch [EMAIL PROTECTED]: HI, On 7/18/07, Michael Biebl [EMAIL PROTECTED] wrote: 2007/7/18, Marcus Fritzsch [EMAIL PROTECTED]: As Jamie wants to release, I took a look at the man pages. Is there any policy on how they should be handled?! I now 'fixed' up the trackerd.1 manual, following the suggestions and guidelines of man-pages(7) - as this is the first time I write/fix a manual, please comment! Most users that have tracker installed, won't have beagle on their system, so I wouldn't include beagle in the SEE ALSO list. Just seems a bit odd to include beagle there... Yep ;) I thought of SEE ALSO being a selection of relating material, i.e. also those referenced in the text... Am I worng here? Well, if you start adding beagle, you'd also have to add recoll, strigi, nepomuk, etc. I usually use SEE ALSO only for very closely related material. Tools from the same package or direct dependencies, i.e. I can count on the referenced man pages being installed. Well, good point, I'm with you then. As a last point, tracker.cfg (5) is not (yet) written. So we should either write a tracker.cfg manpage or remove the tracker.cfg (5) reference from FILES. I of course would welcome the former ;-) Hehe, I know it's not there ;), but I thought that might change until release ;) Does that mean, you'd write the man page? That would be great. Or did I misinterpret you ;-) I thought so - just did not wanted to let you know ;). Marcus ___ tracker-list mailing list tracker-list@gnome.org http://mail.gnome.org/mailman/listinfo/tracker-list
