
================================== Warning ====================================
First, a word of caution. This program comes with absolutely no warranty. Do 
not use it to handle files of any great importance. Through all of my testing, 
I have yet to have any data loss due to Knamer, but it is still possible that 
errors may occur. You are strongly discourage from running Knamer as root, 
because if something were to go wrong it could render your system unusable.
===============================================================================



-------------------------------- Introduction ---------------------------------

Knamer is a small utility to help you rename large batches of files.

Knamer is spelt with an uppercase 'K' and a lowercase 'n'. The 'K' is silent.



-------------------------------- Installation ---------------------------------

Knamer is a Kommander script. (For more information about Kommander, see 
http://kommander.kdewebdev.org/) If Kommander is correctly installed on your 
system, you should be able to run Knamer either by clicking on "knamer.kmdr" in
Konqueror or by running "kmdr-executor knamer.kmdr" in a Konsole. You do not 
need to "install" Knamer to try it out, however, if after trying it out, you 
think Knamer is useful enough to hang onto, you will probably want to install 
it to a permanent location.  Installing it greatly increases the usefulness and
convenience of Knamer by adding it as an Action in you Konqueror context menu. 

To install Knamer for all users a script named "install-knamer" is included. It
requires root privileges. I am also looking into creating a Debian package to 
make installation simpler.

To install Knamer for a single user without root privileges, installation is 
done manually as follows:

  1. Choose an installation directory and move "knamer" and "knamer.kmdr" there. 
  2. Open the script "knamer" in your favourite text editor and change the last
     line so that it points to the new location of "knamer.kmdr".
  3. Open "rename_with_knamer.desktop" in your favourite text editor and change
     the second line so that it points to the new location of "knamer". Make 
     sure the line still ends with "%F".
  4. Move "rename_with_knamer.desktop" to 
     "~/.kde/share/apps/konqueror/servicemenus/".
  5. To test that all went well, select a group of files in Konqueror, right-
     click on them and under Actions you should see the option to rename them 
     with Knamer.



----------------------------------- Usage -------------------------------------

Knamer usage is slightly different than that of most other renaming 
applications, so it might be worth your while to read through the Help tab 
before trying to use the program. It outlines the basic operation of Knamer and
also gives an extensive set of examples. Additionally, almost every button or 
setting has "What's this?" information that can be accessed using the question 
mark button on the titlebar or by pressing Shift + F1.



---------------------------------- Support ------------------------------------

I hope you enjoy Knamer and find it useful. If you have any bugs, requests, or 
questions, feel free to contact me at Parker.Coates@gmail.com. 



--------------------------------- Known Bugs ----------------------------------

Ninety-five percent of Knamer code is written for the new Kommander parser, 
with Bash used sparingly. In hindsight it probably would have been wiser to 
keep the majority of the code in Bash, because the new parser is still new and 
has some limitations. But that's life.

Bug - Knamer cannot handle filenames containing double quotes or dollars signs. 
      I'm not sure if this is resolvable due to the nature of Kommander and Bash.

Bug - Knamer claims it cannot find files containing "international" characters. 
      This is a big bug, but I'm not really sure what the problem is.

Bug - Simulation doesn't detect if multiple files have been given the same name.

Bug - The behaviour around the "***" string is new and confusing. Changes are 
      likely to happen here.

Bug - Filenames using relative directories look very funky in the Files and 
      Results tab. The issue is only aesthetic, every thing should work fine.

Bug - The previews in the Files tab

Bug - A separate BASH script is required for passing arguments via the command 
      line. "knamer" writes its arguments to a file and launches Knamer. Knamer
      then reads the list from that file. Hopefully, the next release of 
      Kommander will support reading command line arguments.



--------------------------------- Change Log ----------------------------------

v0.1  - First attempt
      - Made use of the old parser as a front end to a separate Bash script
      - Failed

v0.2  - Basis of all later versions
      - New parser, but still separate Bash script
      - Only most basic functionality

v0.3  - Added more functionality
      - Efforts made to move much of the Bash script into the Kommander script

v0.4  - UI greatly cleaned up
      - Numerous usability improvements
      - Help tab added

v0.5  - External script converted entirely into Kommander script
      - Titlecases still not working

v0.6  - Simple and advanced titlecase options added
      - Fancied up the About tab

v0.7  - Added history dropdown to filename format 
      - Added a separate configuration file
      - Added the Preferences tab

v0.8  - Setting were ported to Kommander's native setting functions
      - Added support for renaming files to other directories
      - Added option to use cp instead of mv
      - Added the option to allow special characters
      - Redid the layout of the Files tab

v0.9  - First public release. Files hosted on kde-apps.org
      - Companion script knamerloader added
      - Numerous bugfixes
      - General polish to all aspects of program
      - Eliminated nesting of tabs within help Tab
      - Redid examples and included them under Help tab
      - Added "***" string

v0.10 - Amazing disappearing progress bar added!
      - Proper support for ' in both input and output filenames added
      - Option to show full filepaths in the Results tab added
      - Option to preview images in the Files tab added (very funky as 
        currently implemented by Kommander)
      - Minor layout changes

