haiku/docs/welcome/index.html

117 lines
3.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>The Index</TITLE>
<META NAME="CREATED" CONTENT="0;0">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<META NAME="CHANGED" CONTENT="20080926;15151900">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<STYLE TYPE="text/css">
</STYLE>
</HEAD>
<BODY LANG="en-US">
<TABLE WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0>
<COL WIDTH=256*>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#326496">
<P STYLE="background: #326496"><a href="welcome.html"><img src="welcome-images/shijin-logo.png" alt="Logo" border="0"></a></p>
</TD>
</TR>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#204f7e">
<P STYLE="background: #204f7e"><img src="welcome-images/dummy.png" alt="dummy"></p>
</TD>
</TR>
<TR><TD WIDTH=100% VALIGN=TOP>
<br>
<h2>The Index</h2>
<p>
<a href="attributes.html">Attributes</a> and <a href="queries.html">Queries</a> are key features of Haiku. While attributes are useful on their own, to display additional information on a file, for a query on them, they need to be indexed. It puts them into a lookup table, which in turn makes queries lightning fast.<br>
The index is part of the filesystem and is kept for every volume/partition separately.
</p>
<br>
<h3>Indexing commands in Terminal</h3>
<p>There are several commands to manage the index:
<ul>
<li><b>lsindex</b> - Displays the indexed attributes on the current volume/partition.
<p>These are the attributes that are indexed by default:<br>
<pre>58 ~ -&gt;lsindex
BEOS:APP_SIG
MAIL:account
MAIL:cc
MAIL:chain
MAIL:draft
MAIL:flags
MAIL:from
MAIL:name
MAIL:pending_chain
MAIL:priority
MAIL:reply
MAIL:status
MAIL:subject
MAIL:thread
MAIL:to
MAIL:when
META:address
META:city
META:company
META:country
META:email
META:fax
META:group
META:hphone
META:name
META:nickname
META:state
META:url
META:wphone
META:zip
_signature
_status
_trk/qrylastchange
_trk/recentQuery
be:deskbar_item_status
last_modified
name
size
</pre></p></li>
<li><b>mkindex</b> - Adds an attribute to the index of a volume/partition.
<pre>Usage: mkindex [options] &lt;attribute&gt;
Creates a new index for the specified attribute.
-d, --volume=PATH a path on the volume to which the index will be added,
defaults to current volume.
-t, --type=TYPE the type of the attribute being indexed. One of &quot;int&quot;,
&quot;llong&quot;, &quot;string&quot;, &quot;float&quot;, or &quot;double&quot;.
Defaults to &quot;string&quot;.
--copy-from path to volume to copy the indexes from.
-v, --verbose print information about the index being created
</pre>
<p><i><b>Note:</b> Only <b>new</b> files with that attribute come automatically into the index!</i><br>
Existing files have to be added manually by copying them and deleting the originals after that. Alternatively you can use the tool <a href="http://www.bebits.com/app/2033" rel="nofollow">reindex</a>.
</p>
</li>
<li><b>rmindex</b> - Removes an attribute from the index of a volume/partition.
<pre>Usage: rmindex [OPTION]... INDEX_NAME
Removes the index named INDEX_NAME from a disk volume. Once this has been
done, it will no longer be possible to use the query system to search for
files with the INDEX_NAME attribute.
-d, --volume=PATH a path on the volume from which the index will be
removed
-h, --help display this help and exit
-p, --pattern INDEX_NAME is a pattern
-v, --verbose print information about the index being removed
INDEX_NAME is the name of a file attribute.
If no volume is specified, the volume of the current directory is assumed.</pre>
</ul>
</TD></TR>
</TABLE>
</BODY>
</HTML>