summaryrefslogtreecommitdiff
path: root/docs/manpages
diff options
context:
space:
mode:
authorMartyn Russell <martyn@lanedo.com>2014-10-01 12:38:45 +0100
committerMartyn Russell <martyn@lanedo.com>2014-12-10 15:51:35 +0000
commit25bb56cf04491573dc2320a959054ac4e374eeb7 (patch)
tree94d96ddd8ceef4c3c8944ad0346c07dd651ecd57 /docs/manpages
parentfe74c941d56b3b3bc7d29ef5be7605a56bb215f6 (diff)
downloadtracker-25bb56cf04491573dc2320a959054ac4e374eeb7.tar.gz
tracker: Merge tracker-control into a 'tracker' command
Diffstat (limited to 'docs/manpages')
-rw-r--r--docs/manpages/Makefile.am4
-rw-r--r--docs/manpages/tracker-daemon.1 (renamed from docs/manpages/tracker-control.1)60
-rw-r--r--docs/manpages/tracker-index.128
-rw-r--r--docs/manpages/tracker-reset.135
-rw-r--r--docs/manpages/tracker-search.110
-rw-r--r--docs/manpages/tracker-sparql.111
-rw-r--r--docs/manpages/tracker-stats.18
-rw-r--r--docs/manpages/tracker-tag.112
8 files changed, 80 insertions, 88 deletions
diff --git a/docs/manpages/Makefile.am b/docs/manpages/Makefile.am
index a3d76b06b..549546bf3 100644
--- a/docs/manpages/Makefile.am
+++ b/docs/manpages/Makefile.am
@@ -7,12 +7,14 @@ common = \
tracker-import.1 \
tracker-info.1 \
tracker-miner-fs.1 \
- tracker-control.1 \
+ tracker-daemon.1 \
tracker-search.1 \
tracker-sparql.1 \
tracker-stats.1 \
tracker-store.1 \
tracker-tag.1 \
+ tracker-reset.1 \
+ tracker-index.1 \
tracker-writeback.1
# Require only common and enabled manpages
diff --git a/docs/manpages/tracker-control.1 b/docs/manpages/tracker-daemon.1
index 76ea6398f..300f4e4ec 100644
--- a/docs/manpages/tracker-control.1
+++ b/docs/manpages/tracker-daemon.1
@@ -1,14 +1,13 @@
-.TH tracker-control 1 "September 2009" GNU "User Commands"
+.TH tracker-daemon 1 "September 2014" GNU "User Commands"
.SH NAME
-tracker-control \- Manage Tracker processes and data
+tracker-daemon \- Start, stop, restart and list daemons responsible for indexing content
.SH SYNOPSIS
-\fBtracker-control\fR [\fIOPTION\fR...]
+\fBtracker daemon\fR [\fIOPTION\fR...]
.SH DESCRIPTION
-.B tracker-control
-manages and checks status of all Tracker processes and data.
+.B Manages and checks status of all Tracker processes and data.
Controls Tracker both at process level, and at entity level (store, miners).
@@ -28,18 +27,7 @@ load from applications or miners). For a list of common statuses, see
The miners can be paused or resumed using this command and you can
also list miners running and available.
-.SH COMMON OPTIONS
-.TP
-.B \-?, \-\-help
-Show summary of options by group.
-.TP
-.B \-?, \-\-help-all
-Show all groups and options.
-.TP
-.B \-V, \-\-version
-Returns the version of this program.
-
-.SH GENERAL OPTIONS
+.SH OPTIONS
.TP
.B \-p, \-\-list\-processes
This lists all Tracker processes in the system.
@@ -60,27 +48,6 @@ parameter, if no extra parameter is passed,
will be assumed. This is recommended over \-\-kill because it gives
the processes time to shutdown cleanly.
.TP
-.B \-r, \-\-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.
-.TP
-.B \-e, \-\-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 \-c, \-\-remove-config
-This removes all config files in $HOME/.config/tracker. All files
-listed are files which were found and successfully removed.
-Restarting the respective processes re-creates the default
-configuration files.
-.TP
.B \-s, \-\-start
Starts all miners. This indirectly starts tracker-store too because it
is needed for miners to operate properly.
@@ -116,8 +83,6 @@ size of the databases on the disk, the configuration in use, states of
the index (e.g. last filesystem crawl, data set locale, etc.) and
finally statistics about the data in the database (e.g. how many
nfo:FileDataObject resources exist).
-
-.SH STATUS OPTIONS
.TP
.B \-S, \-\-status
Show the current status of all Tracker entities (store and all available
@@ -166,23 +131,10 @@ static and are subject to change at any point.
Additionally, these statuses are not the only ones which may be
reported by a miner. There may be other states pertaining to the
specific roles of the miner in question.
-
-.SH MINER OPTIONS
-.TP
-.B \-m, \-\-reindex-mime-type=MIME
-Re-index files which match the \fIMIME\fR type supplied. This is
-usually used when installing new extractors which support \fIMIME\fR
-types previously unsupported. This forces Tracker to re-index those
-files. You can use
-.B \-\-reindex-mime-type
-more than once per \fIMIME\fR type.
-.TP
-.B \-f, \-\-index-file=FILE
-(Re)index a file matching the \fIFILE\fR type supplied.
.TP
.B \-\-list-miners-running
This will list all miners which have responded to a D-Bus call.
-Sometimes it is helpfult to use this command with
+Sometimes it is helpful to use this command with
.B \-\-list-miners-available.
.TP
.B \-\-list-miners-available
diff --git a/docs/manpages/tracker-index.1 b/docs/manpages/tracker-index.1
new file mode 100644
index 000000000..d8f8718d6
--- /dev/null
+++ b/docs/manpages/tracker-index.1
@@ -0,0 +1,28 @@
+.TH tracker-control 1 "September 2009" GNU "User Commands"
+
+.SH NAME
+tracker-index \- List, pause, resume and command data miners indexing content
+
+.SH SYNOPSIS
+\fBtracker index\fR [\fIOPTION\fR...]
+
+.SH DESCRIPTION
+Control the indexing process with pausing and resuming and add content
+to be indexed. In addition it is possible to reindex entire MIME
+types, which may be useful in cases where a new extractor or GStreamer
+backend is available and providing support.
+.SH OPTIONS
+.TP
+.B \-m, \-\-reindex-mime-type=MIME
+Re-index files which match the \fIMIME\fR type supplied. This is
+usually used when installing new extractors which support \fIMIME\fR
+types previously unsupported. This forces Tracker to re-index those
+files. You can use
+.B \-\-reindex-mime-type
+more than once per \fIMIME\fR type.
+.TP
+.B \-f, \-\-index-file=FILE
+(Re)index a file matching the \fIFILE\fR type supplied.
+
+.SH SEE ALSO
+.BR tracker (1).
diff --git a/docs/manpages/tracker-reset.1 b/docs/manpages/tracker-reset.1
new file mode 100644
index 000000000..c1c5824cb
--- /dev/null
+++ b/docs/manpages/tracker-reset.1
@@ -0,0 +1,35 @@
+.TH tracker-reset 1 "September 2014" GNU "User Commands"
+
+.SH NAME
+tracker-reset \- Reset the index, configuration or replay journal
+
+.SH SYNOPSIS
+\fBtracker reset\fR [\fIOPTION\fR...]
+
+.SH DESCRIPTION
+
+.SH OPTIONS
+.TP
+.B \-r, \-\-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.
+.TP
+.B \-e, \-\-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 \-c, \-\-remove-config
+This removes all config files in $HOME/.config/tracker. All files
+listed are files which were found and successfully removed.
+Restarting the respective processes re-creates the default
+configuration files.
+
+.SH SEE ALSO
+.BR tracker (1).
diff --git a/docs/manpages/tracker-search.1 b/docs/manpages/tracker-search.1
index d0b660465..328786524 100644
--- a/docs/manpages/tracker-search.1
+++ b/docs/manpages/tracker-search.1
@@ -4,10 +4,10 @@
tracker-search \- Search all content for keywords
.SH SYNOPSIS
-\fBtracker-search\fR [\fIOPTION\fR...] \fIEXPRESSION\fR [\fIEXPRESSION\fR...]
+\fBtracker search\fR [\fIOPTION\fR...] \fIEXPRESSION\fR [\fIEXPRESSION\fR...]
.SH DESCRIPTION
-.B tracker-search
+.B tracker search
searches all indexed content for \fIEXPRESSION\fR. The resource in
which \fIEXPRESSION\fR matches must exist (see
.B \-\-all
@@ -22,9 +22,6 @@ For logical OR operations, see -r.
.SH OPTIONS
.TP
-.B \-?, \-\-help-all
-Display all help options available.
-.TP
.B \-l, \-\-limit=N
Limit search to N results. The default is 10 or 512 with \-\-disable\-snippets.
.TP
@@ -115,9 +112,6 @@ of those found.
.B \-b, \-\-bookmarks
Search through bookmarks matching \fIEXPRESSION\fR (optional). Returns a list
titles and links for each bookmark found.
-.TP
-.B \-V, \-\-version
-Print version.
.SH ENVIRONMENT
.TP
diff --git a/docs/manpages/tracker-sparql.1 b/docs/manpages/tracker-sparql.1
index cd505258d..9435928c1 100644
--- a/docs/manpages/tracker-sparql.1
+++ b/docs/manpages/tracker-sparql.1
@@ -4,10 +4,10 @@
tracker-sparql \- Use SparQL to query the Tracker databases.
.SH SYNOPSIS
-\fBtracker-sparql\fR [\fIOPTION\fR...] [-q \fIQUERY\fR] | [-f \fIFILE\fR]
+\fBtracker sparql\fR [\fIOPTION\fR...] [-q \fIQUERY\fR] | [-f \fIFILE\fR]
.SH DESCRIPTION
-.B tracker-sparql
+.B tracker sparql
allows the caller to run an RDF query on the database. This can be
done two ways. Either by providing a \fIFILE\fR with the query or by
providing a string with the \fIQUERY\fR string.
@@ -17,9 +17,6 @@ does not have to be an absolute path.
.SH OPTIONS
.TP
-.B \-?, \-\-help
-Show summary of options.
-.TP
.B \-f, \-\-file=FILE
Use a \fIFILE\fR with SPARQL content to query or update.
.TP
@@ -220,10 +217,6 @@ $ tracker-sparql --get-longhand nmm:MusicPiece
http://www.tracker-project.org/temp/nmm#MusicPiece
.fi
-.TP
-.B \-V, \-\-version
-Print version.
-
.SH ENVIRONMENT
.TP
.B TRACKER_SPARQL_BACKEND
diff --git a/docs/manpages/tracker-stats.1 b/docs/manpages/tracker-stats.1
index a3ace1642..26bf9181e 100644
--- a/docs/manpages/tracker-stats.1
+++ b/docs/manpages/tracker-stats.1
@@ -4,7 +4,7 @@
tracker-stats \- Provides statistics on the data indexed
.SH SYNOPSIS
-\fBtracker-stats\fR [\fIOPTION\fR...] [[\fIEXPRESSION\fR...] [\fIEXPRESSION\fR...]]
+\fBtracker stats\fR [\fIOPTION\fR...] [[\fIEXPRESSION\fR...] [\fIEXPRESSION\fR...]]
.SH DESCRIPTION
Display statistics about RDF classes in and how many of each exist for
@@ -29,9 +29,6 @@ with
.SH OPTIONS
.TP
-.B \-h, \-\-help
-Show a brief help message.
-.TP
.B \-a, \-\-all
Display statistics about ALL RDF classes that exist in the database.
Without this option only the common RDF classes will be shown, for
@@ -39,9 +36,6 @@ example nfo:Document and nfo:FileDataObject.
This option is implied if search terms are provided to filter ALL
possible statistics.
-.TP
-.B \-V, \-\-version
-Print version.
.SH SEE ALSO
.BR tracker-store (1),
diff --git a/docs/manpages/tracker-tag.1 b/docs/manpages/tracker-tag.1
index 8b7b8d39e..9e85f1698 100644
--- a/docs/manpages/tracker-tag.1
+++ b/docs/manpages/tracker-tag.1
@@ -4,13 +4,13 @@
tracker-tag \- Add, remove and list tags.
.SH SYNOPSIS
-\fBtracker-tag\fR [\fIOPTION...\fR] FILE [\fIFILE...\fR]
+\fBtracker tag\fR [\fIOPTION...\fR] FILE [\fIFILE...\fR]
.nf
-\fBtracker-tag\fR [\fIOPTION...\fR] -t [[\fITAG\fR] [\fITAG\fR] ...\fR]
+\fBtracker tag\fR [\fIOPTION...\fR] -t [[\fITAG\fR] [\fITAG\fR] ...\fR]
.fi
.SH DESCRIPTION
-.B tracker-tag
+.B tracker tag
allows the caller add tags, remove tags and list tags by URN or to
list all tags and the files associated with them.
@@ -19,9 +19,6 @@ does not have to be an absolute path.
.SH OPTIONS
.TP
-.B \-?, \-\-help
-Show summary of options.
-.TP
.B \-l, \-\-limit=N
Limit search to N results. The default is 512.
.TP
@@ -80,9 +77,6 @@ This option ONLY applies when using
.B \-\-add
and provides a description to go with the tag label according to
\fISTRING\fR.
-.TP
-.B \-V, \-\-version
-Print version.
.SH ENVIRONMENT
.TP