diff --git a/twander.1 b/twander.1 index 681ba2b..35e1f4c 100644 --- a/twander.1 +++ b/twander.1 @@ -1,17 +1,93 @@ .TH twander 1 "TundraWare Inc." + .SH twander Wander around a filesystem executing commands of your choice on selected -files. +files and directories. + +.SH THE BIG PICTURE +Graphical User Interfaces (GUIs) are a blessing and a curse. On the +one hand, they make it easy to learn and use a computer system. On +the other, they are a real inconvenience to experienced users who are +touch typists. Taking hands off the keyboard to use the mouse +can really slow down a good typist. + +Nowhere is this more apparent than in filesystem browsers. In one +corner we have the GUI variants like \'Konqueror\' and \'Microsoft +Windows Explorer\'. These are very easy to use but you pretty much +need the mouse in your hand to do anything useful. In the other +corner are the text-based file browsers like \'List\', \'Norton +Commander\', and \'Midnight Commander\'. These are really efficient +to use, but have limited functionality and generally do not operate +very well on +.B groups +of things. + +Both of these approaches also suffer from the well-known +interface problem of "What You See Is +.B All +You Get" - Each program has a predefined set of commands and the user +cannot easily extend these with their own, new commands. + +\'twander\' is a new approach to the filesystem navigation problem which +embraces the best of both the GUI-based approach and the text-based +approach. It also provides a rich mechanism whereby each user can +easily define their own command set and thereby customize the program +as they see fit. This is done with a number of key features: + + +.TP +1) +The +.B Navigation +of the filesystem is graphical - you can use the mouse to select files, +directories, or to change directories. However, each major filesystem +navigational feature is also doubled on the keyboard (using Control keys) +so you can move around and select things without ever touching the mouse. + +.TP +2) +\'twander\' also supports a number of +.B navigation shortcuts. +It provides single control-key access to changing directories, moving +to the previous directory, moving up one directory level, moving to +any previously visited directory, (de)selecting any or all +files/directories in the current view, and escaping to the operating +system to run a command. Many (but not all) of these features are +also doubled via GUI/mouse operations. + +.TP +3) +There are +.B no +built-in file or directory commands. All commands which manipulate +the files or directories selected during navigation are user-defined. +This command definition is done in an external configuration file +using a simple but powerful command macro language. This means that +that the command set of the program can easily be changed or expanded +without having to release a new version of \'twander\' every time. +Better still, every different user can have their own command set +defined in a way that suits their style of working. Best of all, +commands can be invoked either graphically (with a mouse click) or via +a single keypress to minimize moving your hands off the keyboard. + +.TP +4) +Because \'twander\' is written in Python using Tkinter, the same +program runs essentially identically on many Unix-style and Win32 +systems. The only thing that may need to be changed across these +various platforms are the command definitions in the configuration +file. You only need to learn one interface (and the commands you've +defined) across all the different systems you use. + +.P +The consquence of all this is that \'twander\' is an extremely +powerful and highly customizable filesystem navigator. Once +learned, both navigation and command execution are lightning-fast +(or at least, as fast as your machine can go ;) while minimizing +dependency on the mouse. + .SH SYNOPSIS twander [-bcdfhnqrstwvxy] [startdir] -.SH DESCRIPTION -\'twander\' is a GUI-based file tree navigation tool. It lets you "wander" -through your file system at will. Unlike other similar programs, -.B YOU -define what features or commands are available to manipulate selected -files. You do this via a configuration file. This gives you the -convenience of a GUI-driven file navigator with the flexibility of -defining almost any kind of command you'd like at your disposal. .SH OPTIONS .TP