diff --git a/twander.1 b/twander.1 index 2166d25..29d0d18 100644 --- a/twander.1 +++ b/twander.1 @@ -76,13 +76,13 @@ on) Normally \'twander\' re-reads and displays the current directory -every few seconds to reflect any changes that might have occured to +every few seconds to reflect any changes that might have occurred to that directory's contents. This option is useful on slow machines (or slow X connections) and/or when working with very large directories. -In this situtation, the frequent updating of the \'twander\' display +In this situation, 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 REFRESH function (default -assinment is to Control-l key). +assignment is to the Control-l key). .TP .B -s fontsize @@ -420,7 +420,7 @@ 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 +to invoke an infrequently used command whose command key you've 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 @@ -434,7 +434,7 @@ .SS Directories Menu \'twander\' keeps track of every directory visited. The previously -described command to move "Back" one directory allows directory naviation +described command to move "Back" one directory allows directory navigation in reverse traversal order - you can back up to where you started. However, this feature "throws away" directories as it backs up, sort of like an "undo" function. @@ -509,8 +509,11 @@ line. Comments may appear freely within a configuration file. \'twander\' strictly ignores everything from the "#" to the end of the line on which it appears without exception. This means that "#" -cannot occur anywhere in a User-Defined Variable Definition, Key +cannot occur anywhere within a User-Defined Variable Definition, Key Binding Statement, or Command Definition (these are described below). +Comments +.B can +be placed on the same line to the right of such statements. It is conceivable that the "#" character might be needed in the Command String portion of a Command Definition. \'twander\' @@ -611,16 +614,18 @@ back instead of a command with arguments and a list of selected items. - .IP \(bu 4 Variables must be -.B defined before thye are referenced (in a Command Definition). -The following is OK because all variables are defined by the -time they actually get used in the Command Definition: +.B defined before they are referenced +(in a Command Definition). You can, however, include not-yet defined +variable name in another User-Variable Definition so long as all these +variable are defined by the time they appear in a Command String. The +following is OK because all variables are defined by the time they +actually get used in the Command Definition: .nf Var1 = foo -Var2 = [Var3] # This is just a string substition, not a reference +Var2 = [Var3] # This is just a string substitution, not a reference Var3 = bar MyVar = [Var1][Var2] @@ -631,16 +636,11 @@ x mycommand [MyVar] .fi - .IP \(bu 4 Variable Names are case-sensitive - [EDITOR], [Editor], and [editor] all refer to different variables. .IP \(bu 4 -Variables must be defined before they are referenced - no forward -references are permitted. - -.IP \(bu 4 The "#" character cannot be used in either the variable name or the replacement string since doing so begins a comment. @@ -651,7 +651,7 @@ Other than these minor restrictions, both Variable Names and Replacement Characters can be any string of characters of any length. -Good judgement would suggest that Variable Names should be somewhat +Good judgment would suggest that Variable Names should be somewhat self-descriptive and of reasonable length - i.e., Much shorter than the replacement string! @@ -660,7 +660,7 @@ Definition containing a string in the form [$something] is understood by \'twander\' to be a reference to an .B Environment Variable, -named "$something". If you do something like: +named "something". If you this: .nf $MYVAR = some-string @@ -720,7 +720,7 @@ different Command Definitions may have identical Command Names associated with them, though this is not ordinarily recommended. -The "Command String" is any arbitarary string which is what \'twander\' +The "Command String" is any arbitrary string which is what \'twander\' actually tries to execute when the command is invoked. .SS A Simple Command Definition @@ -740,7 +740,7 @@ The problem is that this command as written actually will not give you the result you'd like. (For more details on why, see the .B GOTCHAS -section below.) It turns out that starting a non-gui program like +section below.) It turns out that starting a non-GUI program like \'more\' in a new window needs some extra work. What we want to do is run \'more\' inside a copy of \'xterm\'. Now our command looks like this: @@ -952,7 +952,7 @@ It is not difficult to override the default keyboard bindings by adding entries in the configuration file. Doing so requires some -familiary with how Tkinter names keystrokes. Good resources for +familiarity with how Tkinter names keystrokes. Good resources for learning this exist abundantly on the Internet, among them: .nf @@ -1062,7 +1062,7 @@ in the invoking terminal window, .B not in a new window as you might expect. If you started \'twander\' -from a GUI or disconnected it from the initating terminal with +from a GUI or disconnected it from the initiating terminal with a \'nohup\' ... & invocation, you will get .B no output. This is not a \'twander\' problem, it is innate to @@ -1124,7 +1124,7 @@ The configuration file parser does no validation of key binding override values. It is entirely possible to bind a \'twander\' feature to a bogus key definition. This will cause either a -spectacular prgram failure or, at the very least, that feature will +spectacular program failure or, at the very least, that feature will not work correctly or at all. The assumption here is that if you are smart enough to want to change key bindings, you're smart enough to learn how Tkinter names keys. You have been warned.