# &krusader; Tools

## RemoteMan: the &FTP;/SMB connection manager

RemoteMan
RemoteMan

RemoteMan.

Important: RemoteMan has been replaced by our new bookmark manager since Krusader 1.25-beta1. The new manager handles local files and remote &URL;'s the same way. RemoteMan is being left around to allow an easier transition and give you a chance to move your bookmarks. IT WILL BE REMOVED SOON!

Try the new bookmark-manager: open a new remote connection. once done, press the "Bookmark" button, select "Add bookmark" and that's it!

RemoteMan is a central place for all your &FTP;/SMB needs. It is a tree-like list of remote locations each with its own username and password. You can create new "folders" (or groups) in the tree and place remote sessions inside these groups. Each session includes a name (something that best describes the &URL;) and a host. A hostname is a &URL; which can begin with 'ftp://' or 'smb://'. Additional information that can be filled is the username and password. Not filling these values will trigger an anonymous login. You can also click the 'anonymous' checkbox, which will force an anonymous login. One can also decide on a different port - or keep the default (port 21). If you choose a 'smb://' host, you cannot change the port. Optional are the description (a freetext area) and remote directory. If you enter a remote directory, &krusader; will try, upon connection, to cd into that directory.

- Double clicking on a session makes &krusader; connect to that host. You can also use the "Connect" button for that purpose.

- The "More" button does nothing for now.

## MountMan: handle your mounted filesystems

MountMan is a tool which helps you manage your mounted filesystems. Once invoked, it displays a list of every mounted filesystem. For each filesystem, MountMan displays its name (which is the actual device name - &ie; `/dev/fd0` for a floppy), its type (vfat, ext3, ReiserFS ...) and its mount-point (the directory on which the filesystem is mounted).

MountMan
MountMan

MountMan.

MountMan also displays usage information using total size, free size and percentage free. If those numbers say "N/A", it usually means that the filesystem isn't mounted. Left clicking on a filesystem displays a pie chart on the left of the window, this graphically displays the usage information for the filesystem. Clicking on a non-mounted filesystem will display "not mounted" instead of the graph.

- Double clicking on a filesystem will close MountMan and open that filesystem inside &krusader;'s active panel.

- Right clicking on a filesystem will open a small menu which displays what actions can be performed on that filesystem. For now you can only mount, unmount and eject (if clicking on a removable filesystem - e.g. a cdrom).

We plan to expand MountMan in the next evolution of &krusader;. It will be able to format floppies, edit `/etc/fstab`, create new filesystems and more... btw. we have started working on it, see "Quickmode for MountMan"

Quickmode for MountMan

"Quickmode for MountMan" is only available on &kde; 3.2 - earlier versions will see no difference.

To activate Quickmode for MountMan, click AND HOLD the MountMan button on the &toolbar_lnk;

General idea: display a list of all possible mountpoints. Each time the menu is displayed, it determines if a mountpoint is mounted or not and associated the correct action (mount or umount). This offers a quick interface to MountMan. It is working, and currently uses KMountMan::mount and unmount. It uses the new &kde; services for fstab-reading and this will enable us to remove A LOT of code from the "old" MountMan.

## BookMan: Organize your bookmarks

BookMan is a tool which allows you to bookmark folders and &URL;'s using &krusader;, and later return to them in a click of a button. All you need to do is click on the "Bookmark" button.

BookMan: the Bookmark menu
BookMan: the Bookmark menu

BookMan: the Bookmark menu.

Usually, you click on the "Bookmark" button when you're in the target folder. For example, to bookmark `/usr/tmp`, navigate &krusader; there and click the "Bookmark" button and select "Bookmark Current". When the "Bookmark Current" dialog box appears, the &URL; line will say `/usr/tmp`. "Name" is for the name you would like to give to the bookmark (for example: temporary folder). Hotkeys are supported by adding `&` to the bookmarkname &eg; `&sourceforge, &home, down&loads` &etc;, so you can quickly call the bookmark name with &Alt;foo. If you add the bookmark without entering a name, the bookmarks name will be the same as its target. "URL" is where the bookmark points to. "Create in" allows to make bookmark folders for organizing your bookmarks

You can bookmark inside a remote filesystem (&FTP; or SAMBA) and later use the bookmark to quickly connect to the remote machine. You CANNOT bookmark inside an archive.

To use your bookmarks, click the "Bookmark" button and choose one - as shown in the picture above. You may also use the keyboard shortcuts &Alt;right/left arrow to open right/left panel bookmarks list or &Ctrl;d to open the bookmarks of the active panel. A &MMB; click on bookmarks opens them in a new Folder tab.

Navigation in bookmarks:

1. start typing letters

2. &eg; when you type `'h'` and only 1 bookmark starts with `'h'`, it is executed immediatly - no enter needed

3. if more than one bookmarks start with `'h'`, you will have to continue adding letters, until you specified enough and again, the bookmark is executed.

Bookman supports "special / permanent bookmarks" which means that they are added by the &krusader;-Krew to the top bookmark menu without the need of being saved to the file, right now the only one is `"devices:/"` You are able to turn them off.

&keditbookmarks; your Bookmark Manager
&keditbookmarks; edit and organize your Bookmarks

&keditbookmarks;: your Bookmark Manager.

To edit and organize your bookmarks, click the "Bookmark" button and select "Manage Bookmarks", &keditbookmarks; will be displayed. This is where you can edit/remove and re-arrange the bookmarks. &keditbookmarks; (part of the kdebase package) is a bookmark editor for &konqueror;, &krusader; and other applications, which use the &xbel_url; standard for the bookmark format. The bookmarks are stored in `~/.kde/share/apps/krusader/krbookmarks.xml.`

You can inport bookmarks from IE, Opera, Galeon, &kde;, Mozilla, &Netscape;. &keditbookmarks; is easy to use, please read the &keditbookmarks; or the &konqueror; handbook if you need more info.

## KruSearcher: find what you're looking for

Welcome to &krusader;'s powerful search module - nicknamed Krusearcher. It is the most able tool (that we know of) for &Linux;, since it allows so many different ways to quickly find the file you're looking for. The search function is also available on remote file systems. It is divided into two levels, the general and the advanced. Let's take a look at the general page ...

Krusearcher General
Krusearcher General

Krusearcher General.

The page is divided into four parts: top (search for) part, bottom part - titled 'containing text', left part - titled 'search in' and right part which is called 'don't search in'. Obviously, each part handles different aspects of the search. Let's look at them closely.

### Top Part:

- "Search for": here you enter the main search criteria. You can enter a filename, a wildcard (`*.o.*`, `*.c` &etc;) or both - separated by a space. If you type `'text'` the results is the same as `'*text*'`. You can exclude files from the search with '|' (&eg; `'*.cpp *.h | *.moc.cpp'` ).

- "Case sensitive": unchecking it will allow lower and upper case search (&ie;: `*.c` interprets as `*.c` AND `*.C`).

- "Of type": this box lets you search for a file not only by its name, but also by its mimetype. For example, you can search for all the audio files whose name begins with B. Usually this option defaults to 'all files', but you can choose to search for archives, directories, images, text files, videos and audio files.

### Left and Right Part:

- "Search in" and "Don't search in": Using those two parts, you can specify a search exactly the way you want it. For example, you might want to search for a file in the whole filesystem (beginning with `/`), but don't want to search inside `/mnt`. All you need to do is write `/` in the 'search in' box, and write `/mnt` in the 'dont search in' box. If you want to enter more than one directory in one of the boxes, just write the first name and press &Enter;. The directories name will be copied to the bigger box and you'll be able to enter another name.

  The input line has an auto completion feature, corrosponding to &kde;'s global settings. If you wish, you can click on the folder icon, and browse to the directory you wish to add.

### Bottom Part:

- "Text": entering text here makes &krusader; search for it inside the files (`grep`). That way, you can search for all header files (`*.h`) which include the word `'testing 123'` inside them.

- "Match whole word only"

- "Case sensitive": refers to your text being searched for in upper and lower case or the exact phrase you entered.

- "Search in subdirectories": do a recursive search and dive into every directory on the way.

- "Search in archives": &krusader; will search for your files inside every supported archive. This, however, takes longer to perform.

  If you check this checkbox, you'll notice you cannot `grep` inside files anymore. This is done, since looking inside archived files forces &krusader; to extract them, which results in an extremely time-consuming search.

- "Follow links": if checked, &krusader; will follow soft-links during the search.

- "Profiles": if you have to do regularly the same search operation, you can save the search settings &eg; include files, exclude files, etc.... Press the 'profile' button, and you'll be able to add/ load / save / remove search profiles.

The above screenshot shows a search for all the files which end with `c, cpp` or `h` and include the string `'testing 123'`. &krusader; will search in `/root, /opt, /bin` and `/usr`, but not in `/usr/lib` and `/usr/share`.

Clicking the "Search" button starts the search and displays the results page. During the search, you may press the "Stop" button to stop the search. The "Close" button is not operational during a search, so you must first stop the search and then "Close" the window. When a result is found, double clicking on it will make &krusader;'s active panel point to the found files - but will not close the search window, so you'll be able to click on a different result.

Sometimes, you need to narrow your search even more. Krusearcher allows a much finer search, and for that, let's look at the "Advanced Page"...

Krusearcher Advanced
Krusearcher Advanced

Krusearcher Advanced.

This screenshot shows a search for files whose size is between 10KB and 150KB, which were modified between October 10th and November 1st, which belong to any user in the 'ftp' group, and are readable and writeable by anyone in the 'ftp' group, but only readable to the rest of the world.

The advanced page is divided into three parts: size, date and ownership.

Size

Allows you to choose the size range of the file you're looking for. By checking the checkboxes, you can search for a file which is bigger than XXX bytes (or KB, MB), smaller than XXX bytes or, by checking both search for a file which size is bigger than XXX but smaller than YYY.

Date

This part offers three different ways of defining a date criteria:

- "Modified between": allows you to enter two dates. &krusader; will search for files with a modification date between the first date and the second one. If you only enter a date in the left box, you'll be searching for files older than that date. If you only enter a date in the right box, you'll be searching for files newer than that date.

  You can click on the date icon (near the input boxes) to open a standard date window - which allows you to easily browse through the calender and search for the desired date. Clicking on a date will close the window and the date will appear in the input box.

- "Not modified after": choosing this option makes &krusader; search for files that were NOT modified after a given date, which is the same as searching for files older than that date.

- "Modified in the last/not modified in the last": in these input boxes, you enter not a date, but a number. This number represents days/weeks/months (as chosen in the near dropbox). Entering the number 5 in the upper input box, makes &krusader; search for files that were modified in the last 5 days. Entering the number 2 in the lower input box makes &krusader; search for files that did NOT change in the last 2 days. The combination of both results in a search for files that were changed in the last 5 days, but NOT in the last 2 days.

Ownership

- "Belongs to user/group": by checking each of the corresponding checkboxes, you can search for files which belong to a certain user and/or group. The dropbox lists all the user names and group names in the system, just choose one and go ahead.

- "Permissions": divided into owner, group and all - it allows you to choose certain permissions for the file. You can choose to specify permissions for the owner, group, all or any combination. The question mark (?) is a wildcard - which means that any permission is valid.

To clarify, the screenshot above (the permissions part) describes a search for files that belong to any user in group 'ftp', are readable, writable but not executable to any user in the group, are readable but not writable or executable to the rest of the world and have unknown permissions to its owner.

Clicking on the "Search" button to start the search and open the Results window. Here you can see the progress and the the results of the search action. If you want you can stop the current search action with the "Stop" button. In the result list select the file and use F3/F4 to view/edit or use the right-click menu. When you click on a found item, the directory of the active panel will change if the selected item is not in the current panel directory. When you close the Krusearcher window, the selected item is selected in the active panel.

## KrViewer: &krusader;'s internal viewer-editor

Pressing &Enter; on a selected file opens the file with the associated application.

### Viewer

To view a file as fast as possible according to it's type just put it under the cursor and press F3. &krusader;'s internal viewer is actually a &konqueror; part, which can basically view every file type viewable by &konqueror; (&eg; display pictures, play music, show the content of an archive), this is called the 'Generic viewer'.

The viewer works as follows:

- It will try to view the file with the 'Generic viewer'.

- When the file type cannot be determined or when a file (&eg; a binary) doesn't have a associated action, it disables the 'generic viewer'. The file will be treated as a text file, this is the 'Text viewer'.

- The user can change in the KrViewer menu between: 'Generic viewer' (if available), 'Text viewer' and 'Hex viewer'.

&Shift;F3 views a &URL; on demand, &eg;:

- ``man:/`` views the manpages.

- ``man:/`krusader` views a manpage.

- ``info:/`` views the infopages.

- ``http://`krusader.sourceforce.net/` views a webpage.

- ``ftp://`ftp.kde.org/pub/kde/` views a ftp-server.

- ``sftp://`sftp.foo/` views a secure ftp-server.

- ``file:/`home/frank` views the homedirectory of Frank.

- `/home/frank/archive.tar.gz` views a `tar.gz` archive.

KrViewer can have the following menu's: File, Edit, View, Settings and Krviewer, depending on which file type is viewed. They will be discussed in the Editor section. The internal viewer can follow links on HTML pages. With &Ctrl;E the viewer will start &krusader;'s internal editor (which is basically the same application).

The embedded viewer is not written by us, it is supplied via &kde; (libs) and &kioslaves1_url; We cannot and don't want to change it, usings these libraries reduces the amount of written code. So we don't have to reinvent the wheel ;-)

### Editor

&krusader;'s internal editor has almost everything that you can expect of an editor. Editing is similar to viewing but with the F4 key. The default editor is &krusader;'s internal editor. You can change the default editor in the &konfiggereral_lnk;, if you prefer to use an external editor.

When you use &krusader;'s internal editor for the first time, It is recommended to look at each section of the Settings menu, and configure it the way you want it.

### Menu overview

Most of the menus are pretty self-explanatory. ;-)

#### File menu

&Ctrl;S File Save

  Save file.

File Save As

  Save file with another name.

F5 File Reload

  Reload file.

File Export

  Export the file to `html` format.

&Ctrl;P Print Export

  Print the file.

#### Edit menu

&Ctrl;Z Edit Undo

  Undo last action.

&Ctrl;&Shift;Z Edit Redo

  Redo last action.

&Ctrl;X Edit Cut

  Cut selected text to clipboard.

&Ctrl;C Edit Copy

  Copy selected text to clipboard.

&Ctrl;V Edit Paste

  Paste clipboard content to the document.

&Ctrl;A Edit Select All

  Select whole document.

&Ctrl;&Shift;A Edit Deselect

  Deselect current selection.

&Ctrl;&Shift;B Edit Toggle Block Selection

  Toggle Block Selection, this will activate/deactivate the block selection possibility.

Edit Toggle Insert

  Toggle Insert mode.

&Ctrl;F Edit Find

  Find text.

F3 Edit Find Next

  Find next text.

&Shift;F3 Edit Find Previous

  Find previous text.

&Ctrl;R Edit Replace

  Replace text.

&Ctrl;G Edit Go to line

  Go to given linenumber.

#### View menu

F12 View Dynamic Word Wrap

  Go to the next line at the maximum number of characters per line (default 80).

F9 View Show Folding Markers

  Show Folding Markers.

F6 View Show Icon Border

  Show Icon Border.

F11 View Show Line Numbers

  Shows the line numbers.

View Set Encoding

  &eg; ISO8859-1, utf8, utf16, tscii, ... .

#### Bookmarks menu

&Ctrl;B Bookmark Toggle Bookmark

  Toggle Bookmark.

Bookmark Clear Bookmarks

  Clear Bookmarks.

&Alt;PageDown Bookmark Next Bookmark

  Go to the next Bookmark.

&Alt;PageUp Bookmark Previous Bookmark

  Go to the previous Bookmark.

#### Tools menu

Tools Highlight mode

  Highlight mode for scripts, programming languages, markup file, &etc;: &eg; `html, Bash, C++, XML, Makefile, Diff, ...` .

Tools End of Line

  Change the end of Line termination: &UNIX;, &Windows;/DOS, Macintosh.

&Ctrl;I Tools Indent

  Indent.

&Ctrl;&Shift;I Tools Unindent

  Unindent.

Tools Clean Indendation

  Clean Indendation.

&Ctrl;# Tools Comment

  Add appropriate comment tags, if available.

&Ctrl;&Shift;# Tools Uncomment

  Removes the comment tags on the left.

Tools Apply Word Wrap

  Apply Word Wrap.

&Ctrl;M Tools Editing command

  Opens a dialog box for entering a editing command.

#### Settings -> Configure Editor menu

Settings Configure Editor Colors

  Color configuration for the: background, selected text, current line and bracket highlighting.

Settings Configure Editor Fonts

  Fonts configuration for display and printer: font, font style and size, with a preview window.

Settings Configure Editor Indentation

  Indentation configuration: automatically indent, use spaces to indent, &Tab; keys indent, &Backspace; keys indent, keep indent profile, keep extra spaces.

Settings Configure Editor Selection

  Selection configuration: persistent selections, overwrite selected text.

Settings Configure Editor Editing

  Editing configuration: word wrap config., whitespace config, auto brackets, smart home, wrap cursor, maximum undo steps.

Settings Configure Editor Shortcuts

  Shortcuts configuration.

Settings Configure Editor Highlighting

  Highlighting configuration: default styles and highlight mode.

Settings Configure Editor View defaults

  View defaults: dynamic word wrap, show line numbers, show icon border, show folder markers if available, sort bookmarks menu method.

Settings Configure Editor Plugins

  Plugins configuration: &eg; kTexteditor incremental search plugin, kTexteditor insert file plugin, kTexteditor kdatatoolplugin...

#### KrViewer menu

&Ctrl;G KrViewer Generic viewer

  &krusader;'s internal viewer is actually part of Konqueror, which can basically view every file type viewable by &konqueror; (&eg; display pictures, play music, show the content of an archive).

&Ctrl;T KrViewer Text viewer

  View the file in text mode.

&Ctrl;H KrViewer Hex viewer

  View the file in hex mode.

&Ctrl;E KrViewer Text editor

  Edit the file in text mode.

&Esc; KrViewer Close

  Closes &krusader;'s viewer/editor window.

## KruSyncDir: Synchronize Directories

This function compares the left and the right panel directories and shows the difference between them. After selecting some options and the "compare" function you can synchronize the files and directories. One panel could be a &FTP; server. Don't forget the "compare by content" option if the file size stays equal. Choose Commands Synchronize Directories or &Ctrl;Y to start this feature.

KruSyncDir: Synchronize Directories
KruSyncDir: Synchronize Directories

KruSyncDir: Synchronize Directories.

### Procedure:

1. Set the left and the right directory.

2. Configure the optional file filter.

3. Set the checkbox options: "Recurse subdirectories", "Follow symlinks", "Compare by content", "Ignore Date" and "Asymmetric".

4. Click on the "Compare" button to compare the directories.

5. By using the Show options, you can include/exclude particular filetypes. Those files, that are not in the list, will be untouched by synchronization.

6. If needed you can change the "Task" operations determined by the Comparator with the right click menu.

7. When you agree with the "Compare" results click on the "Synchronize" button to show the synchronize dialog.

8. After selection the options of the Synchronizer, click on the "Start" button to start the synchronization process.

A detailed explanation of all the functions and buttons is described in the following text.

Comparator

Panel elements

  - "Left Directory": the left side base directory.

  - "Right Directory": the right side base directory.

  - "File Filter": filter the filenames at synchronizing. &eg; `*.png` selects only those files whose name's end with `.png` Directories will be listed if the directory name ends with `.png` or if the directory contains files which end with `.png` Multiple include/exclude example: `'*.cpp *.h | *.moc.cpp'` will include `*.cpp *.h` and exclude `*.moc.cpp`

  - "General filters": search for, containing text

  - "Advanced filters": size, date, ownership

Checkbox options

  - "Recurse subdirectories": the Synchronizer walks through subdirectories when comparing.

  - "Follow symlinks": the Synchronizer follows the symbolic links to directories (not the files!).

  - "Compare by content": those files whose sizes are equal will be compared by content as well.

  - "Ignore Date": Ignores the date information (useful for &FTP;, smb, archive, ... ) the date information is relevant only in the local file system.

  - "Asymmetric": The "Left Directory" is the target directory, the "Right Directory" is the source directory. This functions synchronizes the content of the left directory to the right directory.

    - Those files that exist only on the left side will be deleted.

    - Those files that exist only on the right side will be copied to left.

    - Those files considered to be equal will be untouched.

    - Those files considered to be different will be copied to left.

    This function is useful if the date information is unusable, or to synchronize the left directory to the content of a fileserver (like a download). Or to make a backup from the right directory to left directory. NOTE: do NOT use this to option to synchronize a desktop and a notebook (&eg; files that exists only in the left side will be deleted!).

  - "Automatic Scrolling": Is for slow &FTP; servers, ... When the Synchronizer is finished comparing a file, it puts the file into the end of the list at once and scrolls the window, if necessary. It is important if you want to know what the Synchronizer is doing. If the &FTP; server is slow, the comparison of a directory may take a lot of time. By turning this option on, one can see that the comparator is "alive", but slow. For fast file systems, it can reduce the speed of comparing slightly.

When all the above things are done, click on the "Compare" button to compare the directories, the results are displayed in the "File List".

"File List"

  The "File List" has the following columns: "Left name | Left size | Left time | Task | Right time | Right size | Right name".

Tasks (<=>)

  This column will display the task that is planned for the Syncronizer.

  - ->: copy from the left side to the right side. For directories: `mkdir` in the right side.

  - =: the files are the same, don't do anything.

  - !=: the file is excluded, or the Synchronizer does not know what to do.

  - <-: copy from the right side to the left side. For directories: `mkdir` in the left side

  - DEL: delete files from the right side.

  The tasks can be changed with the right click menu.

Show options

  Here you can include/exclude particular filetypes. Those files, that are not in the list, will be untouched at synchronization.

  - ->: Enable/Disable the copy task from left to right.

  - =: Enable/Disable listing the equal files.

  - !=: Enable/Disable listing the excluded / "don't know what to do" files.

  - <-: Enable/Disable the copy task from right to left.

  - Trash: Enable/Disable the file deleting from the left side task.

  - Duplicates: Enable/Disable those files that exist on both side.

  - Singles: Enable/Disable those files that exist only on one side.

Action buttons

  - "Compare": compares the directories, the results are displayed in the File List.

  - "Stop": stops comparing.

  - "Synchronize": shows the synchronize dialog.

  - "Close": closes the Synchronizer window.

The Status line may contain

  - The number of scanned directories while comparing.

  - The filename when comparing by content (for big files).

  - The number of files in the list.

Right click menu on the File List

  The right click menu is split up in three sections:

  1. change the Task operations determined by the Comparator. Select one or multiple files. The change will be applied on the selection and not only on the right clicked item. If the selected item is a directory, the change will be applied on its files/subdirectories as well.

  - "Synchronise Directories": starts synchronization.

  - "Exclude": excludes a file/dir from synchronization ( task change to != ).

  - "Restore original operation": task change to the original result of comparator.

  - "Reverse direction": task change ( -> to <-, and <- to -> ).

  - "Copy from right to left": task change to <-.

  - "Copy from left to right": task change to ->.

  - "Delete ( left single )": task change to DEL.

  2. change the selections

  - "Select items": Opens a dialog which allows you to select items. This is the Select Group dialog from the &markmenu_lnk;.

  - "Unselect items": Opens a dialog which allows you to unselect items. This is the Unselect Group dialog from the &markmenu_lnk;.

  - "Invert selection": Invert the selection status of all items.

  3. others Note: the following operations work on the right-clicked file and not on the selection.

  - "View left file": starts viewer on the left file.

  - "View right file": starts viewer on the right file.

  - "Compare Files": starts the diff utility (&eg; &kompare;) on the files.

Other buttons

  - "Profiles": If you have to synchronize often the same directories you can save the settings &eg; include files, exclude files, ... Press the 'profile' button, and you'll be able to add/ load / save / remove synchronizer profiles.

  - "Swap sides": swaps the File List.

Synchronize with &kget;

  If you want to synchronize a local directory with an unstable ftp server, &kget; is a much better solution than simple file copying. After comparing you may right click on the result list and select "Synchronize with kget" to execute the synchronization, after that the listed files will be downloaded with kget instead of krusader. Of course kget needs to be installed on your computer; otherwise, it will not be available.

Synchronizer

After pressing the "Synchronize" button the synchronization dialog appears.

Check boxes

  Here you confirm the copy and delete operations of the Synchronizer

  - "Right to left": copy X1 files ( Y1 bytes ) enable / disable the copy from right to left.

  - "Left to right": copy X2 files ( Y2 bytes ) enable / disable the copy from left to right.

  - "Left": delete X3 files ( Y3 bytes ) enable / disable the left side deleting.

  - "Confirm overwrites": By switching this option on, Krusader will show the "rename, skip, overwrite, skip all, overwrite all" dialog box, before overwriting the file.

Status labels

  - "Ready": A1/A2 files, B1/B2. This line is changed at synchronizing, showing that synchronizer finished with A1 files from A2 ( B1 bytes from B2 ).

  - "Progress bar": Shows the progress on the synchronization (based on bytes).

Action buttons

  - "Start": starts synchronization.

  - "Pause / Resume": pauses/resumes the synchronization process.

  - "Close": closes the synchronization dialog (and stops synchronization).

## User-Actions

With the User-Action-system the user can make his own actions on files in the panel or to access krusader-internal functions with parameter directly using placeholder. The actions integrate seamlessly into &kde;'s action-system, so the standard edit-toolbar/shortcut-dialogs can will show/manipulate the User-Actions too. The User-Actions are stored in `~/.kde/share/apps/krusader/useraction.xml` (the file-structure is documentated in doxygen-headers of UserActionXML). Several examples of `useraction.xml` files can be found here. User-Actions can be edit/add/im-/export using a new Konfigurator-module, although we plan to move all action-related to a new ActionMan. Once you understand how to write User-Actions you will find that &krusader; is a very powerful, customizable tool. Commands User Menu or &Ctrl;` opens the User Menu. The User Menu is only one place from which you can access User Actions. User-Actions can appear nearly everywhere, not only in the User Menu. A menu entry Add new entry is available to add a new User-Action.

Managing User-Actions

Open Konfigurator and choose "User-Actions", here you can add/edit/remove/inport/export User-Actions.

- "Add Action": If you add an new action, you get an empty input-mask where you can enter all the properties. The action will be added as soon as you press "Ok". Now the name is shown in the list on the left.

- To edit a User-Action: select the User-Action on the left. Now you can choose it if you want to edit the properties, the changes will only take effect when you press "Ok".

- "Remove Action": Select the User-Action on the left and click the remove button.

- "Inport Action": If you import some actions they will be automatically added to your list. If there are name-conflicts (the names have to be unique because these are the ID for &kde;'s action-system) you're asked to resolve them. For this the list on the left will only show the actions where conflicts exists. You now can give them new names or remove them.

- "Export Action": If you export a User-Action you have to give a file where to store it. If it does not exist it will be created. If it contains already some User-Actions, the action you're exporting will be added to that file.

All actions you've defined are now shown in the usermenu and in &kde;'s dialogs for changing shortcuts and managing the toolbar. In addition all actions available for the current item will also show up in the rightclick menu.

Basic Properties

"Distinct Name", "Title" and "Command line" are always required, all the other properties are optional.

- "Distinct Name": a unique name of the User-Action, used to identiy it for &kde;'s action-system.

- "Icon button": the icon for your User-Action.

- "Category": adds an category for an better overview. NOTE: this property is not used yet. It is planed to be used, but this is not implemented yet.

- "Title": the title displayed in the menus/dialogs.

- "Tooltip": a tooltip for your User-Action, &eg; displayed in the toolbar on mouseover.

- "Description": a description of what the User-Action is doing. This is also displayed as "What's This" if you &Shift;F1 click on your User-Action.

- "Use Tooltip checkbox": uses the tooltip as description.

- "Command line": is the command which is finaly executed. You can add placeholder using a GUI with the "add" button.

- "Startpath": the working directory for the command that will be executed.

- "Execution mode":

  - "Normal": normal execution mode.

  - "Run in terminal": runs the command in the terminal.

  - "Collect output": collects the output off te executed programm in a &GUI; window.

  - "Separate standard error" when "Collect output" is used the stdout and stderr are separately collected

- "Command accepts":

  - "Local files (no URL's)": tells the placeholder it should return local addesses.

  - "URL's (local and remote)": tells the placeholder it should return &URL;'s.

- "Shortcut button": configures a shortcut for the User-Action.

Commandline-syntax:

Basically, everything you type in the command line will get executed (if you type "ls -l", "ls -l" gets executed). You have the possiblity to get some character string from &krusader; which represents the current panel-state. This is done by placeholders. A placeholder begins with a percent-sign ('%'), followd by a panel-indicator ('a' for the active, 'o' for the other, 'l' for the left and 'r' for the right panel. If the placeholder doesn't need a panel to operate on you have to indicate this by an underscore ('_')). Then comes the name of the placeholder (see the list below), which may get some parameters enclosed in quotes, and finally, again the percent-sign.

This sounds very complicated, so lets make an example: '%aList("Selected")%' will be replaced by a list of all selected items in the active panel. So a command like 'xmms --enqueue %aList("All", " ", "", "*.mp3")%' will execute xmms with a list of all .mp3's in the current panel, separated by a single blank.

Currently, these placeholders are implemented:

- `Path` - replaced by the panels path

  1. &useraction_optional_parameter; Automatic escape spaces. &useraction_default; yes

- `Count` - replaced by the number of <first parameter>

  1. &useraction_parameter; Which items; either "All", "Selected", "Files" or "Dirs"

- `Filter` - replaced by the panels filter-mask

- `Current` - replaced by the current item

  1. &useraction_optional_parameter; Omit the current path. &useraction_default; no

  2. &useraction_optional_parameter; Automatic escape spaces. &useraction_default; yes

- `List` - replaced by a list of all <first parameter>

  1. &useraction_parameter; Which items; either "All", "Selected", "Files" or "Dirs"

  2. &useraction_optional_parameter; Separator between the items. &useraction_default; " "

  3. &useraction_optional_parameter; Omit the current path. &useraction_default; no

  4. &useraction_optional_parameter; Filtermask (for all but "Selected"). &useraction_default; *

  5. &useraction_optional_parameter; Automatic escape spaces. &useraction_default; yes

- `Select` - manipulates the selection in a panel

  1. &useraction_parameter; Filtermask

  2. &useraction_optional_parameter; manipulate in which way; either "Set", "Add" or "Remove". &useraction_default; "Set"

- `Goto` - changes the panels's path to <first parameter>

  1. &useraction_parameter; A relative or absolute path, or an URL

  2. &useraction_optional_parameter; Open the location in a new tab. &useraction_default; no

- `Ask` - asks the user for a some text and is replaced by the answer

  1. &useraction_parameter; The Question

  2. &useraction_optional_parameter; A default answer

  3. &useraction_optional_parameter; A caption for the questionbox

- `Clipboard` - manipulates the clipboard

  1. &useraction_parameter; The text that should go to the clipboard (you may want to use "%aCurrent%" here)

  2. &useraction_optional_parameter; Append the text to the current clipboard-content with this separator

- `Copy` - copies a file, useful for quick, local backups

  1. &useraction_parameter; What should be copied

  2. &useraction_parameter; Where it should be copied

- `Sync` - opens the Synchronizer with a given profile

  1. &useraction_parameter; A profile for the Synchronizer

- `NewSearch` - opens the search-windows with a given profile

  1. &useraction_parameter; A profile for the search-module

- `Profile` - loads a given panel-profile

  1. &useraction_parameter; A panel-profile

A GUI-based helper for placeholder-adding is provided. Spaces In Path, Current and List are per default automatically escaped. There is one more important thing to know: All placeholders that interact with &krusader;-internal functions are called at expand-time (meaning directly when the placeholders are replaced). External programms are called at execution-time (meaning after all placeholders are replaced).

Advanced Properties

Here you can configure where your command should be visible (for the rightclick-menu) In addition, it's possible to change the command executed and confirm it separately. You can also set a user under which the command should be executed.

- Configures if the action is valid for a Protocol, Path, Mime-type or Filename.

- Tweaking the command line before being executed.

- Set a different user for the execution (this has no effect in krusader-internal functions)