diff --git a/twander.1 b/twander.1 index ebb093d..bbb6861 100644 --- a/twander.1 +++ b/twander.1 @@ -81,7 +81,8 @@ slow X connections) and/or when working with very large directories. In this situtation, the frequent updating of the \'twander\' display can make the program unacceptably slow and unresponsive. In this case -you can still force an update manually with the Control-l key. +you can still force an update manually with the REFRESH function (default +assinment is to Control-l key). .TP .B -s fontsize @@ -383,7 +384,7 @@ Each command defined in the configuration file has both a "Command Key" and a "Command Name" associated with it. Pressing that key will cause the command associated with it to be run. If no command -is associated with a given key, nothing will happen. +is associated with a given keystroke, nothing will happen. .SH MENU OPTIONS @@ -404,11 +405,15 @@ .SS Commands MENU Every command defined in the configuration file is listed in this menu -by its "Command Name". Clicking on an item in this menu is the same -as invoking it from the keyboard by its "Command Key". This is -a convenient way to invoke an infrequently used command whose -command key you'e forgotten. It is also handy to confirm which commands -are defined after you've edited and reloaded the configuration file. +by its "Command Name". The association "Command Key" is also shown in +parenthesis. Clicking on an item in this menu is the same as invoking +it from the keyboard by its "Command Key". This is a convenient way +to invoke an infrequently used command whose command key you'e +forgotten. It is also handy to confirm which commands are defined +after you've edited and reloaded the configuration file. The commands +are listed in the order in which they are defined in the configuration +file. This allows most frequently used commands to appear at the top +of the menu by defining them first in the configuration file. .SS Directories MENU @@ -421,7 +426,7 @@ The "Directories" menu provides a slightly different approach to the same task. It keeps permanent track of every directory visited and displays that list in sorted order. This provides another way to move -directly to a previously visited directory without having to explictly +directly to a previously visited directory without having to manually navigate to it again, back up to it, or name it explictly using the "Change Directory" command. @@ -430,31 +435,28 @@ \'twander\' needs a configuration file in order to define commands available to the user. Although the program will run without a -configuration file present, it will warn you that it is doing so -without any commands defined. Not only are commands defined in this +configuration file present, it will warn you that it is doing so with +no commands defined. Not only are commands defined in this configuration file, but keyboard bindings can optionally be assigned (changed from their defaults) in this file. By default, the program expects to find configuration information in .B $HOME/.twander -but you can override this with the -.B -c -command line option. +but you can override this with the -c command line option. Actually, \'twander\' can look in a number of places to find its configuration file. It does this using the following scheme (in priority order): -.IP -If the -c argument was given on the command line, -use this argument for a configuration file. +.IP \(bu 4 +If the -c argument was given on the command line, use this argument +for a configuration file. -.IP -If -c was not given on the command line, but the HOME -environment variable is set, look for the a configuration -file as $HOME/.twander. +.IP \(bu 4 +If -c was not given on the command line, but the HOME environment +variable is set, look for the a configuration file as $HOME/.twander. -.IP +.IP \(bu 4 If the HOME environment variable is not set .B and a -c command line argument was not provided, look @@ -487,11 +489,11 @@ .SS Comments -A comment is begun with the "#" character which may exist -anywhere on the line. \'twander\' ignores everything from the -"#" to the end of that line without exception. This means -that the "#" cannot occur anywhere in a User-Defined Variable, -Key Binding Statement, or Command Definition. +A comment is begun with the "#" character which may exist anywhere on +the line. \'twander\' strictly ignores everything from the "#" to the +end of that line without exception. This means that the "#" cannot +occur anywhere in a User-Defined Variable, Key Binding Statement, or +Command Definition. .SS User-Defined Variables @@ -505,11 +507,11 @@ EDITOR = emacs blah blah blah blah .fi -Later on, when defining a command, instead of typing in -"emacs blah blah blah blah", you can just refer to the -variable [EDITOR] - the brackets indicate you are +Later on, when defining a command, instead of typing in "emacs blah +blah blah blah", you can just refer to the variable [EDITOR] - the +brackets indicate you are .B referring -to a variable. +to a previously defined variable. Why bother with this? Because it makes maintaining complex configuration files easier. If you look in the example ".twander" @@ -553,23 +555,25 @@ You will never be able to subsequently reference it because, [$MYVAR] tells \'twander\' to look in the current environment, -not its own symbol table to resolve the reference. +not its own symbol table to resolve the reference. However, note +that "$" symbol may appear anywhere else but the first character +of a variable name. So, for example, MY$VAR is fine. .IP \(bu 4 -Variable Names may not be redefined. This means you can only -define a given Variable Name once per configuration file -.B AND -you cannot use a variable name which matches either one of the -Builtin Variables (used in Command Definitions) or one of the -Program Function Names (used to change key bindings). +Variable Names may not be redefined. This means you can only define a +given Variable Name once per configuration file. It is also +considered a variable redefinition if you try to use a variable name +which matches either one of the Builtin Variables (used in Command +Definitions) or one of the Program Function Names (used for key +bindings). .PD .P .SS Key Binding Statements -Key Binding Statements look just like Variable Definitions. -The \'twander\' parser automatically figures out which is -which. For details of key binding, see the section below entitled, +Key Binding Statements look just like Variable Definitions. The +\'twander\' parser automatically figures out which is which. For a +detailed explanation of key binding, see the section below entitled, .B CHANGING KEYBOARD BINDINGS. .SS Command Definitions @@ -730,7 +734,7 @@ FreeBSD) do not correctly destroy an \'xterm\' window after a command initiated with -e terminates. This is not a \'twander\' problem. The workaround is to manually kill the window or press enter once when -the command is complete and the window has focus. +the command is complete and the window has input focus. .SH OTHER You must have Python 2.2 or later installed as well as Tkinter @@ -837,7 +841,7 @@ of \'twander\'!) to navigate to the directory where "twander.py" is located. Double-click on the file. If Python is properly installed, there should be an association for ".py" file types -and all should start automatically. +and \'twander\' should start automatically. .SH DESIGN PHILOSOPHY