new documentation look

svn path=/trunk/kdebase/doc/kfind/; revision=4322
This commit is contained in:
Kalle Dalheimer 1998-01-16 22:11:56 +00:00
parent a39a37fee3
commit cd252ee1c1
7 changed files with 237 additions and 156 deletions

View file

@ -1,6 +1,6 @@
data_DATA = index.html index-1.html index-2.html \
index-3.html index-4.html index.sgml
index-3.html index-4.html index.sgml logotp3.gif
datadir = $(kde_htmldir)/en/kfind

View file

@ -1,30 +1,47 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<TITLE> The KFind Documentation: Introduction</TITLE>
<META HTTP-EQUIV="content-type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="keywords" CONTENT="kfind finfd">
<META NAME="description" CONTENT="Documentation for kfind">
</HEAD>
<BODY>
Previous
<BODY BGCOLOR="#ffffff" LINK="#aa0000" TEXT="#000000" >
<FONT FACE="Helvetica">
<A HREF="http://www.kde.org/"><IMG SRC="logotp3.gif" BORDER="0" ALT="The K Desktop Environment"></A>
<HR WIDTH="100%" SIZE=2 ALIGN="CENTER" NOSHADE>
<P ALIGN="RIGHT">
<A HREF="index-2.html">Next</A>
<A HREF="index.html#toc1">Table of Contents</A>
<HR>
<H2><A NAME="s1">1. Introduction</A></H2>
Previous<A HREF="index.html#toc1">Table of Contents</A>
</P>
<H3><A NAME="s1">1. Introduction</A></H3>
<P><B>Kfind</B> is designed to help find files within a directory hierarchy.
i.e if you know that a file is 'out there somewhere' but don't know exactly
where it is, then <B>kfind</B> is the tool for you. Having found the
required file(s), you can save, delete, change file properties, store them
to archives and/ or open the directory containing the file in the file
manager (<B>Kfm</B>)</P>
manager (<B>Kfm</B>)
<P>
<P>I hope you will find this program somehow useful and I would
appreciate any suggestions and comments.</P>
appreciate any suggestions and comments.
<P><CODE>Miroslav Flídr</CODE>
<A HREF="mailto:flidr@kky.zcu.cz">flidr@kky.zcu.cz</A>.</P>
<A HREF="mailto:flidr@kky.zcu.cz">flidr@kky.zcu.cz</A>.
<P>
<P>
<P ALIGN="RIGHT">
<HR>
Previous
<A HREF="index-2.html">Next</A>
<A HREF="index.html#toc1">Table of Contents</A>
Previous<A HREF="index.html#toc1">Table of Contents</A>
</P>
<CENTER>
<HR WIDTH="100%" SIZE=3 ALIGN=CENTER NOSHADE>
</CENTER>
</FONT>
</BODY>
</HTML>

View file

@ -1,37 +1,49 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<TITLE> The KFind Documentation: Installation</TITLE>
<META HTTP-EQUIV="content-type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="keywords" CONTENT="kfind finfd">
<META NAME="description" CONTENT="Documentation for kfind">
</HEAD>
<BODY>
<A HREF="index-1.html">Previous</A>
<BODY BGCOLOR="#ffffff" LINK="#aa0000" TEXT="#000000" >
<FONT FACE="Helvetica">
<A HREF="http://www.kde.org/"><IMG SRC="logotp3.gif" BORDER="0" ALT="The K Desktop Environment"></A>
<HR WIDTH="100%" SIZE=2 ALIGN="CENTER" NOSHADE>
<P ALIGN="RIGHT">
<A HREF="index-3.html">Next</A>
<A HREF="index-1.html">Previous</A>
<A HREF="index.html#toc2">Table of Contents</A>
<HR>
<H2><A NAME="s2">2. Installation</A></H2>
</P>
<H3><A NAME="s2">2. Installation</A></H3>
<H2><A NAME="ss2.1">2.1 How to obtain KFind</A></H2>
<P>
<P>
<H3><A NAME="ss2.1">2.1 How to obtain KFind</A>
</H3>
<P>KFind is a core application of the KDE project
<A HREF="http://www.kde.org">http://www.kde.org</A>. KFind can be found on
<A HREF="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</A>, the main ftp site of the KDE
project.</P>
<H2><A NAME="ss2.2">2.2 Requirements</A></H2>
project.
<P>
<H3><A NAME="ss2.2">2.2 Requirements</A>
</H3>
<P>In order to successfully compile KFind, you need the latest versions
of <CODE> libkdecore</CODE> and <CODE> libkfm</CODE>. All required libraries
as well as KFind itself can be found on
<A HREF="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</A>.</P>
<H2><A NAME="ss2.3">2.3 Compilation and installation</A></H2>
<A HREF="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</A>.
<P>
<H3><A NAME="ss2.3">2.3 Compilation and installation</A>
</H3>
<P><B>Kfind</B> is normally an integrated part of a KDE release and therefore
will be automatically installed with other KDE applications in the normal
course of KDE installation.</P>
course of KDE installation.
<P>In order to compile and install KFind on your system, type the
following in the base directory of the KFind distribution:
<BLOCKQUOTE><CODE>
@ -42,31 +54,30 @@ following in the base directory of the KFind distribution:
% make install
</PRE>
</CODE></BLOCKQUOTE>
</P>
<P>Since KFind uses <CODE>autoconf</CODE> you should have not trouble
compiling it. Should you run into problems please report them to the
<B>KDE</B> mailing lists.</P>
<H2><A NAME="ss2.4">2.4 Configuration</A></H2>
<B>KDE</B> mailing lists.
<P>
<H3><A NAME="ss2.4">2.4 Configuration</A>
</H3>
<P>Configuration is normally performed by means of the Preferences dialog;
see the user section of this manual for more details. A technical description
of <B>kfind</B> configuration follows for interested parties.</P>
of <B>kfind</B> configuration follows for interested parties.
<P>
<P><B>Kfind</B> reads from configuration parameters from a configuration
file (normally <CODE>~/.kfindrc</CODE>).</P>
file (normally <CODE>~/.kfindrc</CODE>).
<P>This file contains information about saving search results, available
archivers and other configuration parameters; these parameters can be edited
from the <CODE>Kfind</CODE> <B>Preferences</B> dialog. </P>
from the <CODE>Kfind</CODE> <B>Preferences</B> dialog.
<P>
<P><B>General information:</B> the resource file consists of sections.
Each section is started by a header title in square braces
e.g.<CODE>[Saving]</CODE></P>
e.g.<CODE>[Saving]</CODE>
<P>
<P>Information following the header relates to a specific aspect of
<CODE>Kfind</CODE> operation.</P>
<CODE>Kfind</CODE> operation.
<P>
<P><B>Saving configuration:</B> The confiuration file holds the filename
and format of the file to be used for saving search results. This parameter
is stored within the .<I>kfindrc</I> file in entry <CODE>[Saving] </CODE>as
@ -79,8 +90,8 @@ Filename=/root/result.html
</PRE>
</CODE></BLOCKQUOTE>
Where <CODE>Format</CODE> entry can have values <CODE>HTML </CODE>or <CODE>Plain Text</CODE>.</P>
Where <CODE>Format</CODE> entry can have values <CODE>HTML </CODE>or <CODE>Plain Text</CODE>.
<P>
<P><B>Archiver configuration:</B> Archivers available for <CODE>kfind </CODE>are
specified in <I>.kfindrc</I> entry <CODE>[Archiver Types]</CODE> as follows:
<BLOCKQUOTE><CODE>
@ -89,7 +100,6 @@ specified in <I>.kfindrc</I> entry <CODE>[Archiver Types]</CODE> as follows:
Archivers=tar;zip;zoo;
</PRE>
</CODE></BLOCKQUOTE>
</P>
<P>And each archiver is detaily described by its own entry:
<BLOCKQUOTE><CODE>
<PRE>
@ -99,29 +109,35 @@ ExecOnUpdate=tar uf %a -C %d %n
Comment=Tar
</PRE>
</CODE></BLOCKQUOTE>
</P>
<P>The first line contains the command to be executed when creating a new
archive and the second is for updating existing archives. The third one
is the comment used for archiver description in <B>Preferences</B> dialog.
Variables may be used in these commands, and are denoted by a leading %
sign.</P>
<P>The following is a list of legal command line variables:</P>
<P><CODE>%a</CODE> The complete name of the archive</P>
<P><CODE>%f</CODE> The normal file name</P>
sign.
<P>The following is a list of legal command line variables:
<P>
<P><CODE>%a</CODE> The complete name of the archive
<P>
<P><CODE>%f</CODE> The normal file name
<P>
<P><CODE>%d</CODE> The parent directory. If the given argument is a file (
not a directory ) then this will give you the directory this file is in.</P>
not a directory ) then this will give you the directory this file is in.
<P>
<P><CODE>%n</CODE> The name of the file. If the given argument is a directory
then this is the name of this directory.</P>
then this is the name of this directory.
<P>
<P>
<P ALIGN="RIGHT">
<HR>
<A HREF="index-1.html">Previous</A>
<A HREF="index-3.html">Next</A>
<A HREF="index-1.html">Previous</A>
<A HREF="index.html#toc2">Table of Contents</A>
</P>
<CENTER>
<HR WIDTH="100%" SIZE=3 ALIGN=CENTER NOSHADE>
</CENTER>
</FONT>
</BODY>
</HTML>

View file

@ -1,44 +1,55 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<TITLE> The KFind Documentation: Onscreen Fundamentals</TITLE>
<META HTTP-EQUIV="content-type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="keywords" CONTENT="kfind finfd">
<META NAME="description" CONTENT="Documentation for kfind">
</HEAD>
<BODY>
<A HREF="index-2.html">Previous</A>
<A HREF="index-4.html">Next</A>
<A HREF="index.html#toc3">Table of Contents</A>
<HR>
<H2><A NAME="s3">3. Onscreen Fundamentals</A></H2>
<BODY BGCOLOR="#ffffff" LINK="#aa0000" TEXT="#000000" >
<FONT FACE="Helvetica">
<A HREF="http://www.kde.org/"><IMG SRC="logotp3.gif" BORDER="0" ALT="The K Desktop Environment"></A>
<HR WIDTH="100%" SIZE=2 ALIGN="CENTER" NOSHADE>
<P>In this section will be briefly described Kfind user interface. </P>
<P ALIGN="RIGHT">
<A HREF="index-4.html">Next</A>
<A HREF="index-2.html">Previous</A>
<A HREF="index.html#toc3">Table of Contents</A>
</P>
<H3><A NAME="s3">3. Onscreen Fundamentals</A></H3>
<P>In this section will be briefly described Kfind user interface.
<P>The Kfind window separated in four areas: toolbar, search parameters
dialog, viewing area and statusbar. The viewing area and
statusbar are visible only after receiving search results.</P>
<H2><A NAME="ss3.1">3.1 Toolbar</A></H2>
statusbar are visible only after receiving search results.
<P>
<P>
<H3><A NAME="ss3.1">3.1 Toolbar</A>
</H3>
<P>
<DL>
<DT><B>Start Search</B><DD><P>Starts new search using parameters specified in parameters
dialog. </P>
<DT><B>New Search</B><DD><P>Clears results and hides viewing area.</P>
<DT><B>Stop Search</B><DD><P>Stops runing search process.</P>
<DT><B>Open</B><DD><P>Asks <B>Kfm</B> to start default binding for selected file.</P>
<DT><B>Add to Archive</B><DD><P>Adds selected file to chosen archive.</P>
<DT><B>Delete</B><DD><P>Deletes selected files and asks <B>Kfm</B> to refresh directory.</P>
<DT><B>Properties</B><DD><P>Shows properties of selected file.</P>
<DT><B>Open Containing Folder</B><DD><P>Asks <B>Kfm</B> to open folder containing selected file.</P>
<DT><B>Save Search Results</B><DD><P>Saves results to file specified in <B>Options->Preferences</B> dialog.</P>
<DT><B>Help</B><DD><P>Shows <B>KFind</B> documentation.</P>
<DT><B>Quit</B><DD><P>Exits KFind.</P>
dialog.
<DT><B>New Search</B><DD><P>Clears results and hides viewing area.
<DT><B>Stop Search</B><DD><P>Stops runing search process.
<DT><B>Open</B><DD><P>Asks <B>Kfm</B> to start default binding for selected file.
<DT><B>Add to Archive</B><DD><P>Adds selected file to chosen archive.
<DT><B>Delete</B><DD><P>Deletes selected files and asks <B>Kfm</B> to refresh directory.
<DT><B>Properties</B><DD><P>Shows properties of selected file.
<DT><B>Open Containing Folder</B><DD><P>Asks <B>Kfm</B> to open folder containing selected file.
<DT><B>Save Search Results</B><DD><P>Saves results to file specified in <B>Options->Preferences</B> dialog.
<DT><B>Help</B><DD><P>Shows <B>KFind</B> documentation.
<DT><B>Quit</B><DD><P>Exits KFind.
</DL>
</P>
<H2><A NAME="ss3.2">3.2 Search Parameters Dialog</A></H2>
<P>
<H3><A NAME="ss3.2">3.2 Search Parameters Dialog</A>
</H3>
<P>This dialog is the main part of <CODE>KFind</CODE>. It's used for specifying
parameter for find utility. There are three find parameters groups:</P>
parameter for find utility. There are three find parameters groups:
<P>
<DL>
<DT><B>Name and location</B><DD><P>This dialog is used to specify filename user is looking
@ -46,36 +57,42 @@ for. Filename is entered into combobox and can contain following
wildcards:
<BLOCKQUOTE><CODE>
? matches any character
<P>* matches any sequence of characters </P>
<P><F>[</F>] matches a defines set of characters, e.g. <F>a-zA-Z0-9\.</F>
matches upper and lower case ASCII letters, digits, and dot.</P>
<P>* matches any sequence of characters
<P>[[]] matches a defines set of characters, e.g. [a-zA-Z0-9\.]
matches upper and lower case ASCII letters, digits, and dot.
</CODE></BLOCKQUOTE>
The combo box stores names history. The <B>Look in</B> combo box and
<B>Browse</B> button are used to specify directory where the search will
be performed. Whether the <CODE>find</CODE> should look into subdirectories
is specified by <B>Include subfolders</B> check button.</P>
is specified by <B>Include subfolders</B> check button.
<DT><B>Date Modified</B><DD><P>This dialog allows searching for files created within a
specified time period.</P>
specified time period.
<DT><B>Advanced</B><DD><P>This page allows file searches for specific types of files e.g
Postscript-documents, JPEG image files or WAV sound files. The search
can also be restricted to files above or below a certain size.</P>
can also be restricted to files above or below a certain size.
<P>
</DL>
</P>
<H2><A NAME="ss3.3">3.3 Viewing Area</A></H2>
<P>
<H3><A NAME="ss3.3">3.3 Viewing Area</A>
</H3>
<P>The viewing area contains results of find
process. After clicking on item the functions open, add to
archive,delete, properties and open containing folder will be enabled.
Double clicking causes executing default binding.</P>
Double clicking causes executing default binding.
<P>
<P ALIGN="RIGHT">
<HR>
<A HREF="index-2.html">Previous</A>
<A HREF="index-4.html">Next</A>
<A HREF="index-2.html">Previous</A>
<A HREF="index.html#toc3">Table of Contents</A>
</P>
<CENTER>
<HR WIDTH="100%" SIZE=3 ALIGN=CENTER NOSHADE>
</CENTER>
</FONT>
</BODY>
</HTML>

View file

@ -1,47 +1,57 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<TITLE> The KFind Documentation: The Menu Entries</TITLE>
<META HTTP-EQUIV="content-type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="keywords" CONTENT="kfind finfd">
<META NAME="description" CONTENT="Documentation for kfind">
</HEAD>
<BODY>
<A HREF="index-3.html">Previous</A>
Next
<BODY BGCOLOR="#ffffff" LINK="#aa0000" TEXT="#000000" >
<FONT FACE="Helvetica">
<A HREF="http://www.kde.org/"><IMG SRC="logotp3.gif" BORDER="0" ALT="The K Desktop Environment"></A>
<HR WIDTH="100%" SIZE=2 ALIGN="CENTER" NOSHADE>
<P ALIGN="RIGHT">
Next<A HREF="index-3.html">Previous</A>
<A HREF="index.html#toc4">Table of Contents</A>
<HR>
<H2><A NAME="s4">4. The Menu Entries</A></H2>
</P>
<H3><A NAME="s4">4. The Menu Entries</A></H3>
<H2><A NAME="ss4.1">4.1 File</A></H2>
<P>
<P>
<H3><A NAME="ss4.1">4.1 File</A>
</H3>
<P>The following functions are available from the file menu:
<DL>
<DT><B>Open</B><DD><P>This option calls kfm to open the currently selected file,
using the default binding e.g Program files will be executed, text
files will start the text editor, etc. This action can also be
performed by double-clicking on the filename in the list.</P>
<DT><B>Add to archive</B><DD><P>Adds the selected file to an archive</P>
<DT><B>Delete</B><DD><P>Deletes the selected file</P>
<DT><B>Properties</B><DD><P>Allows the propertes of the selected file to be altered.</P>
performed by double-clicking on the filename in the list.
<DT><B>Add to archive</B><DD><P>Adds the selected file to an archive
<DT><B>Delete</B><DD><P>Deletes the selected file
<DT><B>Properties</B><DD><P>Allows the propertes of the selected file to be altered.
<DT><B>Open Containing Folder</B><DD><P>Opens the directory containing the selected file in a file
manager (KFM) window</P>
<DT><B>Save Search</B><DD><P>Saves the list of selected files</P>
<DT><B>Quit</B><DD><P>Exit <CODE>Kfind</CODE></P>
manager (KFM) window
<DT><B>Save Search</B><DD><P>Saves the list of selected files
<DT><B>Quit</B><DD><P>Exit <CODE>Kfind</CODE>
</DL>
</P>
<H2><A NAME="ss4.2">4.2 Edit</A></H2>
<P>Entries in this menu are disabled.</P>
<H2><A NAME="ss4.3">4.3 Options </A></H2>
<P>
<H3><A NAME="ss4.2">4.2 Edit</A>
</H3>
<P>Entries in this menu are disabled.
<P>
<H3><A NAME="ss4.3">4.3 Options </A>
</H3>
<P>
<P>From this menu you can start the preferences dialog. This dialog lets
the user determine in which file and file format <CODE>KFind</CODE> should
store search results. User can also look at avaiable filetypes and
archivers details.</P>
archivers details.
<P>
<DL>
<DT><B>Saving</B><DD><P>This dialog lets the user specify a file to save the results
@ -51,25 +61,30 @@ whether the results are saved in raw text format or HTML format. The
results are saved to the default file, or a file specified by the
user. Pressing button <B>File Format</B> lists the types of file a
list of files matching the search parameters can be output to.
Currently HTML format and Text (.txt) format are supported</P>
Currently HTML format and Text (.txt) format are supported
<DT><B>Filetypes</B><DD><P>This dialog allows viewing (editing probably in future) of the
association between filenames and their types. The left selection
box lists all possible file types. Selecting an option from that list
places the attributes of the file type in the other boxes.</P>
places the attributes of the file type in the other boxes.
<DT><B>Archivers</B><DD><P>This dialog allows viewing (editing probably in future) of
archiver definition used by <I>Add to Archive</I> function.</P>
archiver definition used by <I>Add to Archive</I> function.
</DL>
</P>
<P>
<H3><A NAME="ss4.4">4.4 Help</A>
</H3>
<P>From this menu user can show information about KFind and KFind documentation.
<P>
<P ALIGN="RIGHT">
<H2><A NAME="ss4.4">4.4 Help</A></H2>
<P>From this menu user can show information about KFind and KFind documentation.</P>
<HR>
<A HREF="index-3.html">Previous</A>
Next
Next<A HREF="index-3.html">Previous</A>
<A HREF="index.html#toc4">Table of Contents</A>
</P>
<CENTER>
<HR WIDTH="100%" SIZE=3 ALIGN=CENTER NOSHADE>
</CENTER>
</FONT>
</BODY>
</HTML>

View file

@ -1,53 +1,69 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<TITLE> The KFind Documentation</TITLE>
<META HTTP-EQUIV="content-type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="keywords" CONTENT="kfind finfd">
<META NAME="description" CONTENT="Documentation for kfind">
</HEAD>
<BODY>
Previous
<BODY BGCOLOR="#ffffff" LINK="#aa0000" TEXT="#000000" >
<FONT FACE="Helvetica">
<A HREF="http://www.kde.org/"><IMG SRC="logotp3.gif" BORDER="0" ALT="The K Desktop Environment"></A>
<HR WIDTH="100%" SIZE=2 ALIGN="CENTER" NOSHADE>
<P ALIGN="RIGHT">
<A HREF="index-1.html">Next</A>
Table of Contents
<HR>
PreviousTable of Contents</P>
<H1> The KFind Documentation</H1>
<H2>Miroslav Flídr <CODE>flidr@kky.zcu.cz</CODE>,
<SMALL><I>
Miroslav Flídr <CODE>flidr@kky.zcu.cz</CODE>,
Martin Hartig <CODE>hartig@mathematik.uni-kl.de</CODE>,
Mark Roberts <CODE>mar2@scigen.co.uk</CODE></H2>Version 0.3.2, 31 July 1997
<P><HR><EM>This Handbook describes KFind Version 0.3.2
</EM><HR></P>
Mark Roberts <CODE>mar2@scigen.co.uk</CODE>
</I></SMALL>
<BR><I><SMALL>Version 0.3.2, 31 July 1997</SMALL></I><BR>
<P><HR>
<EM>This Handbook describes KFind Version 0.3.2</EM>
<HR>
<P>
<H2><A NAME="toc1">1.</A> <A HREF="index-1.html">Introduction</A></H2>
<P>
<H2><A NAME="toc2">2.</A> <A HREF="index-2.html">Installation</A></H2>
<UL>
<LI><A HREF="index-2.html#ss2.1">2.1 How to obtain KFind</A>
<LI><A HREF="index-2.html#ss2.2">2.2 Requirements</A>
<LI><A HREF="index-2.html#ss2.3">2.3 Compilation and installation</A>
<LI><A HREF="index-2.html#ss2.4">2.4 Configuration</A>
</UL>
<P>
<H2><A NAME="toc3">3.</A> <A HREF="index-3.html">Onscreen Fundamentals</A></H2>
<UL>
<LI><A HREF="index-3.html#ss3.1">3.1 Toolbar</A>
<LI><A HREF="index-3.html#ss3.2">3.2 Search Parameters Dialog</A>
<LI><A HREF="index-3.html#ss3.3">3.3 Viewing Area</A>
</UL>
<P>
<H2><A NAME="toc4">4.</A> <A HREF="index-4.html">The Menu Entries</A></H2>
<UL>
<LI><A HREF="index-4.html#ss4.1">4.1 File</A>
<LI><A HREF="index-4.html#ss4.2">4.2 Edit</A>
<LI><A HREF="index-4.html#ss4.3">4.3 Options </A>
<LI><A HREF="index-4.html#ss4.4">4.4 Help</A>
</UL>
<P ALIGN="RIGHT">
<HR>
Previous
<A HREF="index-1.html">Next</A>
Table of Contents
PreviousTable of Contents</P>
<CENTER>
<HR WIDTH="100%" SIZE=3 ALIGN=CENTER NOSHADE>
</CENTER>
</FONT>
</BODY>
</HTML>

BIN
doc/kfind/logotp3.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1 KiB