Updated user guide.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37849 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-02 16:51:09 +00:00
parent 63245d99ea
commit 7bff797f8a
138 changed files with 2069 additions and 1733 deletions
@@ -4,7 +4,7 @@
 <head>
 <!-- 
 *
- * Copyright 2008, Haiku. All rights reserved.
+ * Copyright 2010, Haiku. All rights reserved.
 * Distributed under the terms of the MIT License.
 *
 * Authors:
@@ -50,17 +50,40 @@

 <h2><img src="../../images/apps-images/textsearch-icon_64.png" alt="textsearch-icon_64.png" width="64" height="64" />TextSearch</h2>
 <table summary="layout" border="0" cellspacing="0" cellpadding="2">
-<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>No entry, normally launched via <a href="../tracker-add-ons.html">Tracker Add-On</a></i></td></tr>
+<tr><td>Deskbar:</td><td style="width:15px;"></td><td><i>No entry, normally launched via Tracker Add-on</i></td></tr>
 <tr><td>Location:</td><td></td><td><span class="path">/boot/system/apps/TextSearch</span></td></tr>
 <tr><td>Settings:</td><td></td><td><span class="path">~/config/settings/TextSearch</span></td></tr>
 </table>
 <p><br /></p>
-<p>Documentation is still missing. If you want to work on it, please announce it on the <a href="http://www.freelists.org/list/haiku-doc">Documentation mailing list</a> to avoid duplication.</p>
+<p>TextSearch looks for a string in text files. Typically it is invoked from <a href="../tracker-add-ons.html">Tracker's Add-on</a> context menu on the selection of files or folders you want to search.</p>

+<img src="../images/apps-images/textsearch.png" alt="textsearch.png" />
+
+<p>You enter a search string in the text box on top and hit <span class="key">RETURN</span> or click <span class="button">Search</span> to start. If <span class="menu">Show lines</span> is checked, the hits are automatically expanded to show the lines of the file containing the search string.</p>
+
+<p>Only a few words on some of the otherwise self-explaining menu items:</p>
+<table summary="menus" border="0" cellpadding="2" cellspacing="0">
+<tr><td colspan="5"><h3>File menu</h3></td></tr>
+<tr><td class="onelinetop"><span class="menu">New window</span></td><td></td><td><span class="key">ALT</span> <span class="key">N</span></td><td> </td><td>Opens a new window where you can enter another string and search through the same files/folders.
+</td></tr>
+<tr><td><span class="menu">Set target...</span></td><td></td><td><span class="key">ALT</span> <span class="key">F</span></td><td></td><td>Lets you choose a new set of files and folders to search through.</td></tr>
+<tr><td colspan="5"><h3>Action menu</h3></td></tr>
+<tr><td><span class="menu">Trim selection</span></td><td></td><td><span class="key">ALT</span> <span class="key">T</span></td><td> </td><td>Removes all entries form the list that are not currently selected.</td></tr>
+<tr><td><span class="menu">Open selection</span></td><td></td><td><span class="key">ALT</span> <span class="key">O</span></td><td></td><td>Opens the currently selected files with their preferred application (same as a double-click). If it's a text editor supporting it (like Pe), you can jump to the exact line the search string was found.</td></tr>
+<tr><td><span class="menu">Open files in Tracker</span></td><td></td><td><span class="key">ALT</span> <span class="key">K</span></td><td></td><td>Opens the location of the currently selected files in Tracker.</td></tr>
+<tr><td class="onelinetop"><span class="menu">Copy text to clipboard</span></td><td></td><td><span class="key">ALT</span> <span class="key">C</span></td><td></td><td>Copies the current selection to the clipboard.</td></tr>
+<tr><td colspan="5"><h3>Settings menu</h3></td></tr>
+<tr><td colspan="3" class="onelinetop"><span class="menu">Skip folders starting with a dot</span></td><td> </td><td>This is useful when working in a "unixy" environment, where often administrative files are hidden inside "<tt>.folders/</tt>". Source versioning systems like SVN and CVS are examples of applications using this and are also widely used in Haiku.</td></tr>
+<tr><td colspan="3"><span class="menu">Escape search text</span></td><td> </td><td>TextSearch uses the command line command <span class="cli">grep</span>. For it, special characters like <tt>'"*\$?!</tt> and spaces have to be escaped with a <tt>\</tt>. Deactivating this setting means you have to do this yourself, but in exchange grants you the power of <a href="http://en.wikipedia.org/wiki/Regular_expression" class="external free" title="http://en.wikipedia.org/wiki/Regular expression" rel="nofollow">regular expressions</a>.</td></tr>
+<tr><td colspan="3"><span class="menu">Text files only</span></td><td> </td><td>TextSearch is currently only useful for finding strings in plain text files. Deactivating this setting will have it look through any kind of file anyway.</td></tr>
+<tr><td colspan="5"><h3>History menu</h3></td></tr>
+<tr><td colspan="4"></td><td>Contains recently used search strings.</td></tr>
+<tr><td colspan="5"><h3>Encoding menu</h3></td></tr>
+<tr><td colspan="4"></td><td>Lets you choose different character encodings if needed.</td></tr>
+</table>
 </div>
 </div>

-<!--
 <div class="nav">
 <div class="inner"><span>
  «  <a href="terminal.html">Terminal</a> 
@@ -68,6 +91,6 @@
 ::  <a href="tv.html">TV</a>  »
 </span></div>
 </div>
-->
+
 </body>
 </html>
@@ -125,7 +125,7 @@ Clara Botters : string : Whelton</pre>
    or: addattr [-f value-from-file] [-t type] attr file1 [file2...]
 
         Type is one of:
-                 string, mime, int, llong, float, double, bool, raw
+                 string, mime, int, llong, float, double, bool, icon, raw
                 or a numeric value (ie. 0x1234, 42, 'ABCD', ...)
         The default is "string"</pre>
 <p>So, say dear Clara took a job with the multi-national Barkelbaer Inc., you fill the formerly empty "Company" attribute with that data (which is of type "string"):</p>