[tracker/writeback-refactor-rebase: 57/65] tracker-writeback: Add man page



commit f5082db6e197fbb385b26270dd015ff8c736366b
Author: Martyn Russell <martyn lanedo com>
Date:   Tue Jul 26 16:33:09 2011 +0100

    tracker-writeback: Add man page
    
    Added information about supported types and also the new --disable-shutdown
    option

 docs/manpages/Makefile.am         |    3 +-
 docs/manpages/tracker-writeback.1 |   46 +++++++++++++++++++++++++++++++++++++
 2 files changed, 48 insertions(+), 1 deletions(-)
---
diff --git a/docs/manpages/Makefile.am b/docs/manpages/Makefile.am
index 454b9fa..0ab39c0 100644
--- a/docs/manpages/Makefile.am
+++ b/docs/manpages/Makefile.am
@@ -15,7 +15,8 @@ common = \
 	tracker-sparql.1 \
 	tracker-stats.1 \
 	tracker-store.1 \
-	tracker-tag.1
+	tracker-tag.1 \
+	tracker-writeback.1
 
 # Require only common and enabled manpages
 man_MANS = $(common)
diff --git a/docs/manpages/tracker-writeback.1 b/docs/manpages/tracker-writeback.1
new file mode 100644
index 0000000..5843414
--- /dev/null
+++ b/docs/manpages/tracker-writeback.1
@@ -0,0 +1,46 @@
+.TH tracker-writeback 1 "July 2011" GNU "User Commands"
+
+.SH NAME
+tracker-writeback \- Used to write metadata set in Tracker back to
+physical files.
+
+.SH SYNOPSIS
+\fBtracker-writeback\fR [\fIOPTION\fR...]
+
+.SH DESCRIPTION
+.B tracker-writeback
+is not supposed to be run by the user since it is started by
+its .desktop file when the user logs in. It can also be started
+manually of course for debugging purposes. You can not run more than
+one instance of this at the same time.
+
+.B tracker-writeback
+writes metadata from the Tracker database back into files only.
+Currently support is limited to XMP metadata (which covers PNG, JPEG,
+TIFF, MP4 and 3GPP formats), play lists (which covers MPEGURL, SCPLS
+and IRIVER formats) and taglib supported mime types (which covers MP3,
+MP4, OGG, WAV, FLAC and some Windows media formats).
+
+Data is only written back if write-back is enabled. This is configured
+in tracker-miner-fs.cfg, See the man page for tracker-miner-fs.cfg for
+more details.
+
+.SH OPTIONS
+.TP
+.B \-?, \-\-help
+Show summary of options.
+.TP
+.B \-V, \-\-version
+Returns the version of this binary.
+.TP
+.B \-v, \-\-verbosity={0|1|2|3}
+Sets the logging level, 0=errors, 1=minimal, 2=detailed, 3=debug.
+.TP
+.B \-d, \-\-disable-shutdown
+Disable shutting down after 30 seconds of inactivity.
+
+.SH SEE ALSO
+.BR tracker-store (1),
+.BR tracker-miner-fs (1).
+.BR tracker-miner-fs.cfg (5).
+.BR tracker-extract (1).



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