diff options
Diffstat (limited to 'doc/tdefilereplace/index.docbook')
| -rw-r--r-- | doc/tdefilereplace/index.docbook | 103 |
1 files changed, 35 insertions, 68 deletions
diff --git a/doc/tdefilereplace/index.docbook b/doc/tdefilereplace/index.docbook index 571b6ff..4db26f9 100644 --- a/doc/tdefilereplace/index.docbook +++ b/doc/tdefilereplace/index.docbook @@ -57,7 +57,7 @@ <chapter id="introduction"> <title>Introduction</title> - <para>&tdefilereplace; is an application used to search and replace a list of strings in a file tree. The strings may be literal or Qt-like regular expressions. There are also other options to tune your search. + <para>&tdefilereplace; is an application used to search and replace a list of strings in a file tree. The strings may be literal or TQt-like regular expressions. There are also other options to tune your search. </para> </chapter> @@ -69,7 +69,7 @@ <screeninfo>&tdefilereplace; in its standalone incarnation</screeninfo> <mediaobject> <imageobject> - <imagedata fileref="kfr_standalone_main_window_1.png" format="PNG"/> + <imagedata fileref="tfr_standalone_main_window_1.png" format="PNG"/> </imageobject> <textobject> <phrase>&tdefilereplace; in its standalone incarnation</phrase> @@ -89,9 +89,6 @@ <imageobject> <imagedata fileref="toolbar.png" format="PNG"/> </imageobject> - <imageobject> - <imagedata fileref="toolbar.eps" format="EPS"/> - </imageobject> <textobject> <phrase>&tdefilereplace;'s toolbar</phrase> </textobject> @@ -128,18 +125,6 @@ </varlistentry> <varlistentry> - <term> - <inlinemediaobject> - <imageobject> - <imagedata fileref="filereplace.png" format="PNG"/> - </imageobject> - </inlinemediaobject><guiicon>Replace</guiicon></term> - <listitem> - <para>This button starts a search&replace loop. When a string has been found, &tdefilereplace; replaces it with another string.</para> - </listitem> - </varlistentry> - - <varlistentry> <term> <inlinemediaobject> <imageobject> @@ -152,6 +137,18 @@ </varlistentry> <varlistentry> + <term> + <inlinemediaobject> + <imageobject> + <imagedata fileref="filereplace.png" format="PNG"/> + </imageobject> + </inlinemediaobject><guiicon>Replace</guiicon></term> + <listitem> + <para>This button starts a search&replace loop. When a string has been found, &tdefilereplace; replaces it with another string.</para> + </listitem> + </varlistentry> + + <varlistentry> <term> <inlinemediaobject> <imageobject> @@ -189,18 +186,6 @@ <varlistentry> <term> - <inlinemediaobject> - <imageobject> - <imagedata fileref="edit.png" format="PNG"/> - </imageobject> - </inlinemediaobject><guiicon>Edit Strings</guiicon></term> - <listitem> - <para>This button edits a selected string.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term> <inlinemediaobject> <imageobject> <imagedata fileref="eraser.png" format="PNG"/> @@ -251,18 +236,6 @@ <term> <inlinemediaobject> <imageobject> - <imagedata fileref="recursive_option.png" format="PNG"/> - </imageobject> - </inlinemediaobject><guiicon>Search in Subfolders</guiicon></term> - <listitem> - <para>This button allows you to search/replace recursively in the subfolders of your base directory.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <inlinemediaobject> - <imageobject> <imagedata fileref="backup_option.png" format="PNG"/> </imageobject> </inlinemediaobject><guiicon>Make Backup Files</guiicon></term> @@ -320,17 +293,14 @@ <imageobject> <imagedata fileref="results_view.png" format="PNG"/> </imageobject> - <imageobject> - <imagedata fileref="results_view.eps" format="EPS"/> - </imageobject> <textobject> <phrase>&tdefilereplace;'s Results view</phrase> </textobject> </mediaobject> </screenshot> - <para>The <guilabel>Results</guilabel> view shows the name of the files that contain the strings you have to retrieve (and replace), their path, their size, the number of strings found and the user id of the files. This view also provides the exact position of each match. The columns can be sorted either ascending or descending by clicking on the column headers.</para> + <para>The <guilabel>Results</guilabel> view shows the name of the files that contain the strings that match the search criterias, their path, their size, the number of strings found, the user and group of the files owner. This view also provides the exact position of each match. The columns can be sorted either ascending or descending by clicking on the column headers.</para> <para>You can open a file by clicking with the &RMB; on a list entry, by single/double clicking (depending on your mouse settings) on an entry or alternatively by selecting an item and pressing Enter.</para> - + <para>You can inspect the file properties using <guilabel>Properties</guilabel> from the &RMB; menu. You can also delete a file from the file system using <guilabel>Delete</guilabel> or simply remove the item from the results list using the <guilabel>Remove Entry</guilabel> command.</para> </sect1> <sect1 id="tdefilereplace-the-strings-view"> @@ -350,8 +320,7 @@ </screenshot> </para> - <para>The <guilabel>Strings</guilabel> view visualizes the list of strings you want search/replace. Please note that in search mode the <guilabel>Results</guilabel> view and the <guilabel>Strings</guilabel> view have a different layout.</para> - + <para>The <guilabel>Strings</guilabel> view visualizes the list of strings you want to search for and eventually replace with. Please note that the layout of both the <guilabel>Results</guilabel> view and the <guilabel>Strings</guilabel> view is different if you are only searching or if you are searching and replacing.</para> </sect1> <sect1 id="tdefilereplace-the-project-dialog"> @@ -373,7 +342,7 @@ </mediaobject> </screenshot> <para>When you want to begin a new session the first step is to click on the <link linkend="tdefilereplace-the-toolbar"><guiicon>Customize Search/Replace Session</guiicon> button</link>. Then you must enter the base path and a sequence of shell-like wildcards to use as filter.</para> - <para>Then you could set some useful options, like searching in all the subfolders, doing a case-sensitive search, enabling commands and/or regular expressions<footnote id="performancewarning"><para>Please note that regular expressions and commands could slow down the speed performances.</para></footnote>, doing a backup copy of each file before replacing.</para> + <para>Then you could set some useful options, like searching in all the subfolders including limiting the max depth of searching, doing a case-sensitive search, enabling commands and/or regular expressions<footnote id="performancewarning"><para>Please note that regular expressions and commands could slow down the speed performances.</para></footnote>, doing a backup copy of each file before replacing.</para> <para>If you want to start searching, you can put a string in the search box and press <guibutton>Search Now</guibutton>, otherwise leave the search box empty and press <guibutton>Search Later</guibutton>.</para> </sect2> @@ -390,7 +359,7 @@ </textobject> </mediaobject> </screenshot> - <para>The <guilabel>Advanced</guilabel> tab allows you to set up some useful options to restrict the search to a subset of your target file tree. If you want to run &tdefilereplace; only over files that have a size in the range of 10KB - 100KB, then you could use the size options. There is also a date option that restricts the search in a temporal range, and a last option that allows you to only search for files owned (or not owned) by a particular user (this may be more useful to the system administrators).</para> + <para>The <guilabel>Advanced</guilabel> tab allows you to set up some useful options to restrict the search to a subset of your target file tree. You can set restrictions on the size, access date and ownership of the files to be searched for.</para> </sect2> </sect1> @@ -400,7 +369,7 @@ </para> <sect2 id="tdefilereplace-the-options-dialog-general-page"> <title>General options</title> - <para>These options have been presented in the <link linkend="tdefilereplace-the-toolbar">Toolbar</link> section. + <para>These options have been presented in the <link linkend="tdefilereplace-the-toolbar">Toolbar</link> section. In addition to those, you can specify the default file encoding to use and the suffix for backing up files. <screenshot> <screeninfo>The General tab of the Options window</screeninfo> <mediaobject> @@ -429,11 +398,13 @@ </mediaobject> </screenshot> <segmentedlist> + <segtitle>Confirm before replace each string</segtitle> <segtitle>Do not show files if no strings are found or replaced</segtitle> <segtitle>When searching, stop on first string found</segtitle> <segtitle>Follow symbolic links</segtitle> <segtitle>Ignore hidden files and directories</segtitle> <seglistitem> + <seg>choose whether to confirm the replacement of each string or not.</seg> <seg>shows only the files that match some of your strings. This will speed up the search.</seg> <seg>&tdefilereplace; will stop when it finds a matching string, and will continue to search for other strings or, if you search for only one string, it will continue with the next file.</seg> <seg>if a file is a link to another one, then search in the real file.</seg> @@ -465,29 +436,26 @@ <para>This chapter provides informations about some useful capabilities of &tdefilereplace;.</para> <sect1 id="tdefilereplace-the-kfr-file"> <title>How to save your string list</title> - <para>When you want to reuse a list of strings you can save it in a <literal role="extension">xml</literal> file. To do this select from the menubar <menuchoice><guimenu>Search/Replace</guimenu><guisubmenu>Strings</guisubmenu><guimenuitem>Save Strings List to File</guimenuitem></menuchoice>. When you save a list, a simple <literal role="extension">xml</literal> file with extension <literal role="extension">kfr</literal> is created. To load a <literal role="extension">kfr</literal> file select from menubar <menuchoice><guimenu>Search/Replace</guimenu><guisubmenu>Strings</guisubmenu><guimenuitem>Load Strings List from File</guimenuitem></menuchoice>. The actual file looks like this:</para> + <para>When you want to reuse a list of strings you can save it in a <literal role="extension">xml</literal> file. To do this select from the menubar <menuchoice><guimenu>Search/Replace</guimenu><guisubmenu>Strings</guisubmenu><guimenuitem>Save Strings List to File...</guimenuitem></menuchoice>. When you save a list, a simple <literal role="extension">xml</literal> file with extension <literal role="extension">kfr</literal> is created. To load a <literal role="extension">kfr</literal> file select from menubar <menuchoice><guimenu>Search/Replace</guimenu><guisubmenu>Strings</guisubmenu><guimenuitem>Load Strings List from File...</guimenuitem></menuchoice>. The actual file looks like this:</para> <screen> <?xml version="1.0" ?> <kfr> <mode search="false"/> <replacement> - <oldstring><![CDATA[SEARCH_STRING_1]] ></oldstring> - <newstring><![CDATA[REPLACE_STRING_1]]></newstring> + <oldstring><SEARCH_STRING_1></oldstring> + <newstring><REPLACE_STRING_1></newstring> </replacement> <replacement> - <oldstring><![CDATA[SEARCH_STRING_2]]></oldstring> - <newstring><![CDATA[REPLACE_STRING_2]]></newstring> + <oldstring><SEARCH_STRING_2></oldstring> + <newstring><REPLACE_STRING_2></newstring> </replacement> - - + ... + ... <replacement> - <oldstring><![CDATA[SEARCH_STRING_N]]></oldstring> - <newstring><![CDATA[REPLACE_STRING_N]]></newstring> + <oldstring><SEARCH_STRING_N></oldstring> + <newstring><REPLACE_STRING_N></newstring> </replacement> - </kfr></screen> - - <para>If you are using a previous format, you can update by hand your file by simply modifying it according to the above scheme. Alternatively, you can load the file written in the old format and save it again with &tdefilereplace; in the way explained before.</para> </sect1> <sect1 id="tdefilereplace-the-report-file"> @@ -499,15 +467,13 @@ <imageobject> <imagedata fileref="report_example.png" format="PNG"/> </imageobject> - <imageobject> - <imagedata fileref="report_example.eps" format="EPS"/> - </imageobject> <textobject> <phrase>&tdefilereplace;'s Report feature</phrase> </textobject> </mediaobject> </screenshot> </para> + <para>You can also save and load the results list contents to/from file using the <menuchoice><guimenu>Search/Replace</guimenu><guisubmenu>Results</guisubmenu><guimenuitem>Save Results List to file...</guimenuitem></menuchoice> and <menuchoice><guimenu>Search/Replace</guimenu><guisubmenu>Results</guisubmenu><guimenuitem>Load Results List from file...</guimenuitem></menuchoice>. This is very useful if you are searching over a lot of files and for many strings, so you can save and resume your checks across multiple days.</para> </sect1> <sect1 id="tdefilereplace-QT-regexp"> @@ -524,7 +490,8 @@ <sect1 id="tdefilereplace-open-file"> <title>How to Open a File</title> - <para>If you want to open a file that matches some of your strings, you have to select a line in the result view and click on it with the &RMB;. A context menu will appear from which you can open the file. If you use &tdefilereplace; embedded in &quantaplus;, you can open the file directly in it at the specified line and column.</para> + <para>You can open a file by clicking with the &RMB; on a list entry, by single/double clicking (depending on your mouse settings) on an entry or alternatively by selecting an item and pressing Enter. If you use &tdefilereplace; embedded in &quantaplus;, you can open the file directly in it at the specified line and column.</para> + <para></para> </sect1> <sect1 id="tdefilereplace-commands"> @@ -589,7 +556,7 @@ Documentation Copyright © 2004 Emiliano Gulmini <email>emi_barbarossa@y <segtitle>[$random:$]</segtitle> <segtitle>[$mathexp:<replaceable>bc-expression</replaceable>$]</segtitle> <seglistitem> - <seg>this command return the current date and time in Qt ISO format.</seg> + <seg>this command return the current date and time in TQt ISO format.</seg> <seg>like above but in local format.</seg> <seg>return the UID of the current user.</seg> <seg>return the GID of the current user.</seg> |