beagle r4820 - trunk/beagle/tools

[dbera svn gnome org]

Author: dbera
Date: Wed Jul  9 14:17:23 2008
New Revision: 4820
URL: http://svn.gnome.org/viewvc/beagle?rev=4820&view=rev

Log:
Update the man pages in tools/.


Added:
   trunk/beagle/tools/beagle-index-info.8
      - copied unchanged from r4817, /trunk/beagle/tools/beagle-index-info.1
Removed:
   trunk/beagle/tools/beagle-index-info.1
Modified:
   trunk/beagle/tools/Makefile.am
   trunk/beagle/tools/beagle-config.1
   trunk/beagle/tools/beagle-info.1
   trunk/beagle/tools/beagle-ping.1
   trunk/beagle/tools/beagle-query.1

Modified: trunk/beagle/tools/Makefile.am
==============================================================================
--- trunk/beagle/tools/Makefile.am	(original)
+++ trunk/beagle/tools/Makefile.am	Wed Jul  9 14:17:23 2008
@@ -198,10 +198,14 @@
 	$(CRAWL_WRAPPER)
 
 man_MANS = 			\
+	beagle-config.1		\
+	beagle-doc-extractor.8	\
+	beagle-index-info.8	\
+	beagle-info.1		\
+	beagle-ping.1		\
 	beagle-query.1		\
 	beagle-shutdown.1	\
-	beagle-status.1		\
-	beagle-config.1
+	beagle-status.1
 
 @INTLTOOL_DESKTOP_RULE@
 
@@ -211,6 +215,9 @@
 
 desktopdir = $(datadir)/applications
 desktop_DATA = $(desktop_files)
+
+man_MANS += beagle-settings.1
+
 endif
 
 all: $(TARGETS) $(WRAPPERS)

Modified: trunk/beagle/tools/beagle-config.1
==============================================================================
--- trunk/beagle/tools/beagle-config.1	(original)
+++ trunk/beagle/tools/beagle-config.1	Wed Jul  9 14:17:23 2008
@@ -1,10 +1,11 @@
 .\" beagle-config(1) manpage
 .\"
 .\" Copyright (C) 2005 Novell, Inc.
+.\" Copyright (C) 2008 D Bera <dbera web gmail com>
 .\"
-.TH BEAGLE-CONFIG "1" "May 2005" "beagle" "Linux User's Manual"
+.TH BEAGLE-CONFIG "1" "July 2008" "beagle" "Linux User's Manual"
 .SH NAME
-beagle-config \- command-line interface to the Beagle configuration file
+beagle-config \- command-line interface to Beagle configuration
 .SH SYNOPSIS
 .B beagle-config
 \fIoptions\fR
@@ -14,13 +15,16 @@
 .br
 .B beagle-config
 \fIsections\fR \fIsection-options\fR [\fIparams\fR]
+.br
+.B beagle-config
+\fIxml-options\fR
 .SH DESCRIPTION
 .BR beagle-config
 is a command line tool designed to manipulate the Beagle configuration.
 .PP
 The configuration is stored in a series of files usually located in the \fB~/.beagle/config\fR directory. The configuration is split up into \fIsections\fR, each section being represented by 1 file.
 .PP
-The format used is the result of serialized objects. Manually modifying the configuration files is not recommended, you should use this utility instead.
+The format used is the result of serialized objects. Manually modifying the configuration files is not recommended, you should use this utility instead. You can also the graphical interfaces beagle-settings (Gtk) or beagle-settings-qt (Qt4).
 .PP
 Each \fIsection\fR configures a different area of the Beagle system. Each section has a number of preset \fIsection-options\fR (commands) which you can perform on it via this command-line application.
 .PP
@@ -37,18 +41,52 @@
 .TP
 .B --list-sections
 Lists all of the available sections for use as the \fIsections\fR parameter.
+.TP
+.B --version
+Print version information.
 .SH SECTION OPTIONS
-Each section has its own unique set of options available. To see a list of supported options for a particular section, run \fBbeagle-config section-name\fR with no additional parameters.
+Each section has its own unique set of options available. To see a list of supported options for a particular section, run \fBbeagle-config section-name\fR with no additional parameters. Note that some of the options are strictly for internal usage by beagle and should not be modified by the user.
 .SH PARAMS
-Each option may take a number of parameters (or none). Please refer to online documentation if you require explanations of every available command.
+To read the value of section-option, you do not need to give any params. Of course you need to supply params if you want to set a section-option. There are 3 types of section options. The params depend on the type of the section-option.
+.TP
+.I boolean option
+PARAMS is "true" or "false"
+.TP
+.I string option
+PARAMS is the value of the section-option.
+.TP
+.I list option
+To add a list option, pass a comma separated list of options
+.I "value1,value2,...".
+Run \fBbeagle-config section-name section-option\fR for the number of items in the list and their explanations.
+.br
+To remove a list option, pass
+.I "- value1,value2,..."
+where value1,value2,... are the exact values of the option that you want to remove.
+.SH XML OPTIONS
+Non-C# programs who want to get/set configuration values can use these options. If an error occurs, the return value can be checked to determine the kind of the error. The return value is
+.TP
+1: Bad section name
+.TP
+2: Invalid XML
+.TP
+3: XML does not correspond to the section name
+.SS Options
+.TP
+.B --read-xml SECTION
+Reads the xml of a section from stdin. Suitable for setting options by other programs.
+.TP
+.B --write-xml SECTION
+Print the section in xml format. Suitable for parsing by other programs.
 .SH AUTHOR
 Originally written by Daniel Drake <dsd gentoo org>.
+Modified by D Bera <dbera web gmail com>
 .SH "REPORTING BUGS"
 Report bugs to <dashboard-hackers gnome org>.
 .SH COPYRIGHT
-Copyright \(co 2005 Novell, Inc.
+Copyright \(co 2005 Novell, Inc., \(co 2008 D Bera
 .sp
 This is free software; see the source for copying conditions.  There is NO
 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 .SH "SEE ALSO"
-.BR beagled (1),
+.BR beagled (1)

Modified: trunk/beagle/tools/beagle-info.1
==============================================================================
--- trunk/beagle/tools/beagle-info.1	(original)
+++ trunk/beagle/tools/beagle-info.1	Wed Jul  9 14:17:23 2008
@@ -1,6 +1,7 @@
 .\" beagle-info(1) manpage
 .\"
 .\" Copyright (C) 2004-2007 Novell, Inc.
+.\" Copyright (C) 2008 D Bera <dbera web gmail com>
 .\"
 .TH BEAGLE "1" "15 Mar 2007" "beagle-info" ""
 .SH NAME
@@ -11,9 +12,10 @@
 .SH DESCRIPTION
 .PP
 .BR beagle-info 
-displays information on the running Beagle daemon
-.PP
+displays information about Beagle
 .SH OPTIONS
+.SS Information about the currently running Beagle daemon.
+Beagle daemon should be running for these options.
 .BR beagle-info
 takes the following options:
 .TP
@@ -31,6 +33,8 @@
 .TP
 .B --all-info
 Display all of the above information.
+.SS Other information
+Beagle daemon need not be running for these options.
 .TP
 .B --list-backends
 List the currently available backends.
@@ -38,23 +42,23 @@
 .B  --list-filters
 List the currently available filters.
 .TP
-.B  --help
-Print a summary of command-line options.
-.TP
 .B  --list-static-indexes
 List the available static indexes.
+.TP
+.B  --help
+Print a summary of command-line options.
 .SH AUTHOR
 Novell, Inc.
 .SH "REPORTING BUGS"
 Report bugs to <dashboard-hackers gnome org>.
 .SH COPYRIGHT
-Copyright \(co 2004-2007 Novell, Inc.
+Copyright \(co 2004-2007 Novell, Inc., \(co 2008 D Bera.
 .sp
 This is free software; see the source for copying conditions.  There is NO
 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 .SH "SEE ALSO"
 .BR beagled (1),
-.BR beagle-index-info (1),
-.BR beagle-ping (8),
+.BR beagle-index-info (8),
+.BR beagle-ping (1),
 .BR beagle-status (1),
 .BR http://beagle-project.org

Modified: trunk/beagle/tools/beagle-ping.1
==============================================================================
--- trunk/beagle/tools/beagle-ping.1	(original)
+++ trunk/beagle/tools/beagle-ping.1	Wed Jul  9 14:17:23 2008
@@ -1,6 +1,6 @@
 .\" beagle-ping(1) manpage
 .\"
-.TH BEAGLE "14" "Mar 2007" "beagle-ping" ""
+.TH BEAGLE "1" "Mar 2007" "beagle-ping" ""
 .SH NAME
 beagle-ping
 .SH SYNOPSIS

Modified: trunk/beagle/tools/beagle-query.1
==============================================================================
--- trunk/beagle/tools/beagle-query.1	(original)
+++ trunk/beagle/tools/beagle-query.1	Wed Jul  9 14:17:23 2008
@@ -1,8 +1,9 @@
 .\" beagle-query(1) manpage
 .\"
 .\" Copyright (C) 2005 Novell, Inc.
+.\" Copyright (C) 2008 D Bera <dbera web gmail com>
 .\"
-.TH BEAGLE-QUERY "1" "November 2007" "beagle" "Linux User's Manual"
+.TH BEAGLE-QUERY "1" "July 2008" "beagle" "Linux User's Manual"
 .SH NAME
 beagle-query \- search your personal information space
 .SH SYNOPSIS
@@ -13,26 +14,52 @@
 is used to search your personal information space via Beagle, on the command
 line.  It is a command-line form of the beagle-search GNOME program.
 .SH OPTIONS
+.SS Search options
+.TP
+.B --max-hits
+Reduce the number of search results returned per backend. The default is 100.
+Increasing this will slow down overall search speed.
 .TP
 .B --verbose 
 Print detailed information about each hit.
 .TP
+.B --cache
+Show the entire cached text for each result. Only works with \fI--verbose\fR.
+.br
+Note that for large documents this will produce extremely large output,
+so use this with uri queries or queries returning only a few results
+Not recommended for live-queries or stats-only queries.
+.TP
 .B --live-query 
 Enable live queries. This argument keeps beagle-query running, continuously
 feeding new matching hits as the system gets aware of them.
 .TP
-.B --max-hits
-Reduce the number of search results returned per backend. The default is 100.
-Increasing this will slow down overall search speed.
 .B --stats-only
 Show only statistics on the number of search results and how long it took to
 get them, and not the results themselves.
+.SS Other options
+.TP
+.B --keywords
+Lists the keywords allowed in \fIquery\fR. Keyword queries can be specified as
+.I keywordname:value e.g. ext:jpg
+.TP
+.B --help
+Print the usage message.
+.TP
+.B --version
+Print the version information.
+.SH QUERY
+You can query for a word, several words or a quoted phrase. When several words
+are searched, only documents which contain all the words are matched. To specify
+a phrase, enclose it in shell-escaped quotes (\\"search term\\").
+.PP
+Besides these beagle supports an advanced query syntax. See http://beagle-project.org/Searching_Data#Search_Syntax for more information.
 .SH AUTHOR
 Novell, Inc.
 .SH "REPORTING BUGS"
 Report bugs to <dashboard-hackers gnome org>.
 .SH COPYRIGHT
-Copyright \(co 2005 Novell, Inc.
+Copyright \(co 2005 Novell, Inc., \(co 2008 D Bera
 .sp
 This is free software; see the source for copying conditions.  There is NO
 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.