1. Introduction

Please note: As of TkDesk 1.0b5, this guide unfortunately has become slightly out of date. To find out what has changed or been added since this guide was written, please take a look at the change log ("Help/Changes"), even if you're a first time user.

TkDesk is a graphical desktop manager for UNIX (especially Linux) and the X Window System. Compared with other file managers available, it offers the most complete set of file operations and services, plus gives the user the ability to configure most aspects of TkDesk in a powerful way. The reason for this is the use of Tcl/Tk as the configuration and (for the greatest part of TkDesk) implementation language. TkDesk has been influenced by various other systems and file managers: NeXT, for laying out the file browser windows, Apple Finder, for the idea of file annotations and, (shock horror), Windows 95, for some other (of course minor and unimportant) inspirations.

This is a brief overview of the most prominent features of TkDesk:

• Arbitrary number of automatically refreshed file browsers and file list windows,
• Configurable file-specific popup-menus,
• Drag and drop,
• Files and directories may also be dropped onto the root window, a.k.a. desktop,
• Configurable application bar, with several displays and cascaded popup menus for each button, files can also be dropped here,
• History of visited directories, opened files, executed commands, and others, which is automatically saved to disk,
• Find files through their annotation, name, contents, size or age,
• Trash can for safe deletion of files and directories,
• Calculation of disk usage for directory hierarchies,
• All file operations (find, copy, disk usage, etc.) are carried out in the background,
• Traversal of directory hierarchies through recursive cascaded menus,
• Bookmarks, create menu entries for often used files/directories,
• Comprehensive hypertextish online help,
• Built-in multi-buffer and undo-capable editor,
• Close coupling with Netscape for displaying HTML files or selected URLs,
• Sound support,
• Powerful configuration of nearly all aspect of TkDesk through Tcl/Tk, this also allows the Tcl-literate to extend TkDesk in arbitrary ways,
• Free of charge! But see the file COPYING, or menu entry Help/License for information on usage and redistribution of TkDesk.

1.1 Acknowledgments

TkDesk uses a number of other freely available packages without which TkDesk would not have been possible. I'd like to say many thanks to the following people:

• Chris Sterritt for setting up and managing the TkDesk mailing list (at majordomo@mrj.com, send a mail with the body "subscribe tkdesk" to join),
• Ken Hornstein for his wonderful netscape-remote package,
• Ioi Kim Lan for making an XPM image reader for Tk available,
• George Howlett for his great BLT, of which parts are used by TkDesk,
• Michael McLennan for his massively useful [incr tcl],
• John Ousterhout for Tcl/Tk, which is definitely the best thing since sliced bread,
• Greg Hankins and Matt Welsh for putting together the most wonderful linuxdoc-sgml package,
• and of course, Linus Torvalds whose Linux kind of changed my life, really!

And a very big thank you to the growing TkDesk user community, which provides me with a constant flow of bug reports (getting less now :-)), suggestions for enhancements of TkDesk, and lots of motivation and encouragement.

Special thanks to Chuck Robey for revising a previous version of this guide.

1.2 Using TkDesk's Help System

If you have Netscape running, TkDesk will use that for displaying this User's Guide on-line. Otherwise, to reduce overhead, TkDesk uses its own, rather sophisticated help system. It features hypertext links, context sensitivity (which is not yet utilised by TkDesk) and full text search.

The help window consists of three areas:

1. A listbox listing all the section headings. A section can be selected by pressing the left mouse button,
2. the text display, which contains the actual help text, and
3. a button "Back", which jumps back after a hypertext link has been followed (see next paragraph), a button "Close" which closes the help window, and a text entry. In this entry a regular expression can be entered (such as [Ff]eatures). After hitting Return, the whole help text is searched for this expression. Pressing Return again continues the search.

Text that is displayed blue in the help window is a hypertext link. When the left mouse button is clicked over such a link the display will automatically change to the referenced section. One can jump back by pressing the "Back" button described above.

The following keys are bound when the mouse pointer is inside the help window:

Tab

Moves to the next section.

Shift-Tab

Moves to the previous section.

Control-Tab

Moves to the first section.

Control-Shift-Tab

Moves to the last section.

Up, Down

Scrolls one line up/down.

Page up, Page down

Scrolls one page up/down.

Control-Home

Jumps to start of help text.

Control-End

Jumps to end of help text.

Meta/Alt-b

Equivalent to pressing the "Back" button.

Meta/Alt-c, Escape

Equivalent to pressing the "Close" button.

1.3 Command Line Options

Usually TkDesk is started simply by executing the command "tkdesk" from the shell prompt or your X initialisation file. The command line options understood by TkDesk are the following:

-configdir dir

Reads the configuration from directory dir instead of ~/.tkdesk.

-default

Reads the default configuration of TkDesk instead of the user's one in ~/.tkdesk.

-fvwm

TkDesk uses the icon window facility only if fvwm is the current window manager. Since other window managers may also support icon windows, or TkDesk maybe unable to detect you're running fvwm, this command line option forces TkDesk to use icon windows. The advantage of these is that they look nicer and files can be dropped on them.

-iconic

Iconifies all file browser and file list windows created by TkDesk during start-up.

-startdir dir

If this option is given, the first file browser will open with directory dir.

For example, the command "tkdesk -fvwm -iconic" forces Tkdesk to use icon windows and starts with all windows iconified.