diff --git a/twander.1 b/twander.1 index aa5b4fd..e347943 100644 --- a/twander.1 +++ b/twander.1 @@ -9,25 +9,25 @@ .SH OVERVIEW Wander around a filesystem executing commands of your choice on selected files and directories. The general idea here is -that \'twander\' provides GUI facilities for navigating around your +that \fCtwander\fP provides GUI facilities for navigating around your filesystem, but .B you define the commands you want available via "Command Definitions" in the Configuration File. -If you're new to \'twander\' and want +If you're new to \fCtwander\fP and want to know why this program is better and different than whatever you're using at the moment, take a moment to read the section called .B DESIGN PHILOSOPHY toward the end of this document first. -Similarly, if this is the first time you've worked with \'twander\', +Similarly, if this is the first time you've worked with \fCtwander\fP, there is a section near the end of this document entitled -.B INSTALLING \'twander\' +.B INSTALLING \fCtwander\fP which describes how the program should be installed. You can get the latest version of the program and documentation -from the \'twander\' homepage: +from the \fCtwander\fP homepage: .ft C \" courier .nf @@ -39,12 +39,12 @@ You should check this site periodically for program updates, bug fixes, and enhacements. -Also, you are strongly encouraged to join the \'twander\' mailing +Also, you are strongly encouraged to join the \fCtwander\fP mailing list where you'll find help and answers to questions you have about this program. Details of how to do this can be found toward the end of this document in the section entitled, -.B GETTING HELP: THE \'twander\' MAILING LIST. +.B GETTING HELP: THE \fCtwander\fP MAILING LIST. .SH SYNOPSIS @@ -57,7 +57,7 @@ Directory in which to begin. (default: directory in which program was started) -If this directory does not exist or cannot be opened, \'twander\' +If this directory does not exist or cannot be opened, \fCtwander\fP will display an error message and abort. .TP @@ -65,9 +65,9 @@ Specify the location and name of the configuration file. (default is ~/.twander) -If this file does not exist or cannot be opened, \'twander\' will +If this file does not exist or cannot be opened, \fCtwander\fP will display a warning to that effect but continue to run. This is -reasonable behavior because \'twander\' provides a command to reload +reasonable behavior because \fCtwander\fP provides a command to reload the Configuration File without exiting the program (which you would presumably do after fixing the Configuration File problem). @@ -76,7 +76,7 @@ Start in debug mode dumping the items specified in the debuglevel. (default: debuglevel=0/debug off) -\'twander\' is able to selectively dump debugging information to +\fCtwander\fP is able to selectively dump debugging information to stdout. \'debuglevel\' is understood to be a bitfield in which each bit specifies some kind of debugging information or behavior. \'debuglevel\' can be specified in either decimal @@ -121,11 +121,11 @@ Turn off automatic refreshing of directory display. (default: refresh on) -Normally \'twander\' re-reads and displays the current directory +Normally \fCtwander\fP re-reads and displays the current directory 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 situation, the frequent updating of the \'twander\' display +In this situation, the frequent updating of the \fCtwander\fP display can make the program unacceptably slow and unresponsive. In this case you can still force an update manually with the REFRESH function (default assignment is to the Control-l key). @@ -134,7 +134,7 @@ .B -t Turn off quoting when substituting built-in variables. (default: quoting on) -Anytime \'twander\' encounters a reference to one of the built-in +Anytime \fCtwander\fP encounters a reference to one of the built-in variables which do string replacement (DIR, DSELECTION, DSELECTIONS, MEM1-12, PROMPT:, SELECTION, SELECTIONS) in a command, it will replace them with @@ -149,10 +149,10 @@ Print detailed version information. -.SH OTHER WAYS TO SET \'twander\' OPTIONS +.SH OTHER WAYS TO SET \fCtwander\fP OPTIONS In addition to these command line options, there are two other ways -you can set \'twander\' program features. If you prefer, you +you can set \fCtwander\fP program features. If you prefer, you can set the command line options via the environment variable, TWANDER. That way you don't have to type them in each time you start the program. Say you set the environment variable this way @@ -172,7 +172,7 @@ by setting the appropriate entries in the Configuration File. This is covered later in this document. -\'twander\' evaluates options in the following order (from first +\fCtwander\fP evaluates options in the following order (from first to last): .IP \(bu 4 @@ -207,14 +207,14 @@ If the Configuration File is reloaded while the program is running (see the READCONF key below), any options set in the file will have the last word. This allows you to edit the Configuration File and -have your changes reflected in a running instance of \'twander\', but +have your changes reflected in a running instance of \fCtwander\fP, but it also means that the environment variable/command line arguments are ignored after initial program startup. .SH THE TITLE BAR -\'twander\' displays a lot of information about the state of the running +\fCtwander\fP displays a lot of information about the state of the running program in the main window title bar. From left to right you will see: .IP \(bu 4 @@ -225,7 +225,7 @@ .IP \(bu 4 The path of the directory you are currently viewing. If -this path length is greater than 60 characters, \'twander\' will +this path length is greater than 60 characters, \fCtwander\fP will show the last 60 characters of the path length, prepended with "..." to show that it is truncated. @@ -260,8 +260,8 @@ .SH KEYBOARD USE -By design, \'twander\' allows you to do almost everything of interest -using only the keyboard. Various \'twander\' features are thus +By design, \fCtwander\fP allows you to do almost everything of interest +using only the keyboard. Various \fCtwander\fP features are thus associated with particular keystrokes which are described below. It is also very simple to change the default key assignments with entries in the Configuration File, also described below. @@ -275,13 +275,13 @@ X-Windows is somewhat more problematic in this area. Just what an arrow key is "supposed" to do depends on how it's been mapped in your X -server software. Testing \'twander\' on various X servers showed +server software. Testing \fCtwander\fP on various X servers showed quite a bit of variability in how they handled the arrows and keypad. So ... if you're running in an X Windows universe and arrows or keypad do nothing, or do strange things, look into your key maps, don't blame -\'twander\'. +\fCtwander\fP. -There are several features of \'twander\' that will present the user a +There are several features of \fCtwander\fP that will present the user a text entry dialog. These include the CHANGEDIR and RUNCMD features as well as the {PROMPT:...} Built-In Variable (all described below). @@ -296,7 +296,7 @@ .SH DEFAULT KEYBOARD AND MOUSE BINDINGS Here, ordered by category, are the default keyboard and mouse -bindings for \'twander\'. The general format is: +bindings for \fCtwander\fP. The general format is: .TP .B Description (Program Function Name) @@ -305,27 +305,27 @@ Default Mouse Assignment (if any) .P -The "Program Function Name" is the internal variable \'twander\' +The "Program Function Name" is the internal variable \fCtwander\fP uses to associate a particular feature with a particular keystroke or mouse action. You can ignore it unless you intend to override the default key assignments. This use is described below in the section entitled, .B Key Binding Statements. -It is important to realize that \'twander\' key-bindings are +It is important to realize that \fCtwander\fP key-bindings are .B case-sensitive. This means that \'Control-b\' and \'Control-B\' are different. This was a conscious design decision because it effectively doubles the number of Control/Alt key combinations available for the addition of future features. -The default bindings chosen for \'twander\' features are all currently +The default bindings chosen for \fCtwander\fP features are all currently .B lower-case. If your program suddenly stops responding to keyboard commands, check to make sure you don't have CapsLock turned on. .B NOTE: -Some \'twander\' features are doubled on the mouse. These mouse +Some \fCtwander\fP features are doubled on the mouse. These mouse button assignments are documented below for the sake of completeness. However, .B mouse button assignments cannot be changed by the user, @@ -333,7 +333,7 @@ .SS General Program Commands -This family of commands controls the operation of \'twander\' itself. +This family of commands controls the operation of \fCtwander\fP itself. .TP .B Clear History (CLRHIST) @@ -358,15 +358,15 @@ Increase font size. These two features allow you to change the display font sizes while -\'twander\' is running. But, you may not immediately get the results -you expect. \'twander\' internally keeps track of separate font +\fCtwander\fP is running. But, you may not immediately get the results +you expect. \fCtwander\fP internally keeps track of separate font sizes for the main display, the main menu text, and the help menu -text. When you use the two font sizing commands above, \'twander\' +text. When you use the two font sizing commands above, \fCtwander\fP subtracts or adds 1 to each of these three values respectively. On systems like Windows using TrueType fonts, this works as you would expect, because every font is effectively available in every size. However, in systems like X-Windows or Windows using fixed-size fonts, -you may have to press these keys repeatedly until \'twander\' finds +you may have to press these keys repeatedly until \fCtwander\fP finds a font matching the requested size. This can also cause some parts of the display to change but not @@ -376,7 +376,7 @@ available larger than 12 point is 16 point. If you press FONTINCR twice, both the menu text and help text will jump to 12 point, but the main display text will remain unchanged. Why? Because pressing -FONTINCR twice tells \'twander\' to set the main display to 14 point +FONTINCR twice tells \fCtwander\fP to set the main display to 14 point (12+1+1) which does not exist, and the menu and help text to 12 point (10+1+1) which does exist, so that change is visible. @@ -407,7 +407,7 @@ Command Menu at the top of the GUI, or via selection from the Command Menu. -Windows users should note that, unlike Windows Explorer, the \'twander\' +Windows users should note that, unlike Windows Explorer, the \fCtwander\fP Command Menu does not change the set of currently selected items. It merely provides a list of available commands. This allows the command chosen via the Command Menu to operate on a previously @@ -489,7 +489,7 @@ Control-r Re-read the Configuration File. This allows you to edit the -Configuration File while \'twander\' is running and then read your +Configuration File while \fCtwander\fP is running and then read your changes in without having to exit the program. This is handy when editing or changing Command Definitions. @@ -517,7 +517,7 @@ Toggle Autorefreshing on- and off. This is handy if you are about to enter a very large directory and/or a very slow disk (like a CDROM). -With very large or slow directory reads, \'twander\' can end up spending all +With very large or slow directory reads, \fCtwander\fP can end up spending all its time doing re-reads of the directory and never give you time to do anything there. If you find this is consistently the case, then you need to increase REFRESHINT. But for the occasional adventure into @@ -537,7 +537,7 @@ .B Toggle \'win32all\' Features (TOGWIN32ALL) Control-w -As described later in this document, \'twander\' provides enhanced +As described later in this document, \fCtwander\fP provides enhanced features for Windows users who also install Mark Hammond's \'win32all\' extensions for Python on Windows. This key binding will toggle those advanced features on- and off. This is useful if you happen to @@ -551,11 +551,11 @@ This family of commands controls movement between directories. If you attempt to navigate into a directory that does not exist or which does -not have appropriate permissions, \'twander\' will display a warning +not have appropriate permissions, \fCtwander\fP will display a warning message and remain in the current directory. This is .B unlike the case of a non-existent or unreadable directory specified when the program -is first started. In that case, \'twander\' reports the error and aborts. +is first started. In that case, \fCtwander\fP reports the error and aborts. .TP .B Change Directory (CHANGEDIR) @@ -586,7 +586,7 @@ .IP Control-DoubleClick-Left-Mouse-Button -\'twander\' keeps track of every directory visited and the order in +\fCtwander\fP keeps track of every directory visited and the order in which they are visited. This command allows you to move back successively until you get to the directory in which you started. This feature is implemented as a stack - each "backing up" removes @@ -605,7 +605,7 @@ .B Go To Starting Directory (DIRSTART) Control-s -Go back to the original directory in which \'twander\' was started. +Go back to the original directory in which \fCtwander\fP was started. .TP .B Go Up To Parent Directory (DIRUP and MOUSEUP) @@ -690,14 +690,14 @@ .B Select Using Regular-Expression \'Wildcards\' (SELWILD) Control-\\ -Although \'twander\' provides a very rich set of keyboard and mouse +Although \fCtwander\fP provides a very rich set of keyboard and mouse selection commands, selecting a group of files out of list of hundreds or thousands in a large directory can be tedious. If the files/directories you want to select have some lexical commonality .B in their names OR details -you can have \'twander\' select them for you using so-called "Regular +you can have \fCtwander\fP select them for you using so-called "Regular Expressions". The idea here is that you press SELWILD -and enter a "matching" string or regular expression, and \'twander\' will +and enter a "matching" string or regular expression, and \fCtwander\fP will select all entries which match this criteria for you. For example, if you just enter the text, @@ -707,7 +707,7 @@ .fi .ft \" revert -\'twander\' would select every file or directory in the current display +\fCtwander\fP would select every file or directory in the current display where the string "tar" .B appeared anywhere on the line for that file/directory. This is very important: Wildcard matching takes place anywhere on the @@ -726,7 +726,7 @@ .fi .ft \" revert -\'twander\' will select all directories with no permissions enabled for +\fCtwander\fP will select all directories with no permissions enabled for group or world users. @@ -763,7 +763,7 @@ the same thing as the filename "globbing" wildcards commonly used with Unix and Windows shells. If you enter constructs like "*.txt" or "*.tar.gz", you will not get the results you expect. -In fact, these specific examples will cause \'twander\' to grumble +In fact, these specific examples will cause \fCtwander\fP to grumble and present a warning message. For an excellent tutorial on Python-compliant regular @@ -797,7 +797,7 @@ .fi .ft \" revert -Now \'twander\' would select +Now \fCtwander\fP would select .B only the directories without any group and world access because: @@ -808,7 +808,7 @@ The carat (^) at the beginning of the actual regular expression "anchors" the match to the start of the line. For a match -to be declared (and for \'twander\' to select an item) the regular +to be declared (and for \fCtwander\fP to select an item) the regular expression must be satisfied at the beginning-of-line. .P @@ -839,7 +839,7 @@ .SS Scrolling Commands If a given directory's contents cannot be displayed on a single -screen, \'twander\' supports both vertical and horizontal scrolling +screen, \fCtwander\fP supports both vertical and horizontal scrolling via scrollbars. This capability is doubled on the keyboard with: .TP @@ -868,7 +868,7 @@ .SS Command Execution Options -This family of commands causes \'twander\' to actually +This family of commands causes \fCtwander\fP to actually attempt to execute some command you've chosen: .TP @@ -882,7 +882,7 @@ You may enter a number of different things in the RUNCMD dialog. You may type literal text or refer to any of the variable types -(User-Defined, Environment, or Built-In) supported by \'twander\' just +(User-Defined, Environment, or Built-In) supported by \fCtwander\fP just as you do in writing Command Definitions (see below). This makes it easy to enter complex commands without having to type everything literally. For example, if you would like to copy all the currently @@ -894,12 +894,12 @@ .fi .ft \" revert -\'twander\' understands the variable reference syntax here just as it +\fCtwander\fP understands the variable reference syntax here just as it does in a Command Definition. This also gives you a single way of referring to environment variables, regardless of OS platform. Recall that in Unix-like shells, an environment variable is in the form "$NAME", but on Windows it is in the form "%NAME%". Instead if having -to keep track of this difference, you can just use a \'twander\' +to keep track of this difference, you can just use a \fCtwander\fP Environment Variable reference. For instance, assuming the EDITOR environment variable is set, this command works the same on both systems: @@ -962,7 +962,7 @@ handy on Unix. As with command definitions in a configuration file, you can -tell \'twander\' to force a display refresh after the command has been +tell \fCtwander\fP to force a display refresh after the command has been initiated. You do this by beginning the command with the \'+\' symbol. So, for example, if you enter, @@ -972,7 +972,7 @@ .fi .ft \" revert -\'twander\' will initiate the command, wait AFTERWAIT seconds (default: 1), +\fCtwander\fP will initiate the command, wait AFTERWAIT seconds (default: 1), and then update the display. See the discussion below entitled, .B Forcing Display Updates In Command Definitions for a more complete explanation. @@ -990,14 +990,14 @@ .IP DoubleClick-Left-Mouse-Button -If the selected item is a Directory, \'twander\' will move into +If the selected item is a Directory, \fCtwander\fP will move into that directory when this command is issued. If the selected item -is a file, \'twander\' will attempt to execute it. Whether or not +is a file, \fCtwander\fP will attempt to execute it. Whether or not the file is actually executed depends on how the underlying operating system views that file. In the case of Unix-like operating systems, the execute permission -must be set for the user running \'twander\' (or their group) for the +must be set for the user running \fCtwander\fP (or their group) for the file to be executed. On Windows, the file will be executed if the user has permission to do @@ -1009,7 +1009,7 @@ the \'notepad\' program (unless the association for ".txt" has been changed). -If \'twander\' determines that it is running on neither a Unix-like +If \fCtwander\fP determines that it is running on neither a Unix-like or Windows system, double-clicking on a file does nothing. .TP @@ -1023,7 +1023,7 @@ .SS Directory Shortcuts -\'twander\' provides a way to directly navigate into a frequently-used +\fCtwander\fP provides a way to directly navigate into a frequently-used directory using a single keystroke. You can define up to 12 such "Directory Shortcuts" in the Configuration File. Each of the definitions is associated with one of the following 12 keys: @@ -1054,10 +1054,10 @@ It would be nice if we could not only keep adding things to the Clipboard, but be able to do so as we navigate around the filesystem. -\'twander\' addresses these concerns by means of 12 separate "Program -Memories". As you use \'twander\', you can add (append) the names of +\fCtwander\fP addresses these concerns by means of 12 separate "Program +Memories". As you use \fCtwander\fP, you can add (append) the names of any directories or files in the currently viewed directory by -selecting them and then using the appropriate \'twander\' MEMSETx key +selecting them and then using the appropriate \fCtwander\fP MEMSETx key (see below). To take advantage of this feature, you write Command Definitions (or manually issue a command via the RUNCMD key) which reference the contents of a Program Memory using one of the [MEMx] @@ -1065,7 +1065,7 @@ .B Program Memory Built-Ins for more details in how to apply Program Memories). -\'twander\' provides key combinations for selectively setting and +\fCtwander\fP provides key combinations for selectively setting and clearing particular Program Memories as well as a key combination for clearing all Program Memories in a single keystroke: @@ -1092,7 +1092,7 @@ .SS Sorting Options -\'twander\' provides a variety of ways to sort the display. These can be +\fCtwander\fP provides a variety of ways to sort the display. These can be selected with either a keystroke or from the Sorting Menu (see below). The meaning of the sort depends on whether or not you are in Drive List View (see @@ -1147,9 +1147,9 @@ .SH MENU OPTIONS -Although \'twander\' is primarily keyboard-oriented, several +Although \fCtwander\fP is primarily keyboard-oriented, several menu-based features are also implemented to make the program more -convenient to use. These menus appear at the top of the \'twander\' +convenient to use. These menus appear at the top of the \fCtwander\fP display window, above the directory listing. .SS Invoking A Menu @@ -1166,9 +1166,9 @@ The first item in each menu is a dashed line ("----") which indicates that it is a "tearoff" menu. Clicking on the dashed line will detach -the menu from \'twander\' allowing it to be placed anywhere on screen. +the menu from \fCtwander\fP allowing it to be placed anywhere on screen. Even when detatched, these menus remain current and in-sync with -\'twander\' as it continues to run. You can also tear off multiple +\fCtwander\fP as it continues to run. You can also tear off multiple instances of these menus if you'd like copies of them at several locations on the screen simultaneously. @@ -1191,7 +1191,7 @@ which explains how such options are actually set. The MAXMENU option specifies the maximum number entries .B that will be displayed -in any dynamic menu. (\'twander\' internally tracks MAXMENUBUF number of +in any dynamic menu. (\fCtwander\fP internally tracks MAXMENUBUF number of items for each dynamic menu.) This defaults to 32 as is intended to keep the menu size reasonable. @@ -1199,7 +1199,7 @@ .B disabling all dynamic menus. It also means that no interactive dialog will "remember" your last manual entry. For example, with MAXMENU set to -0, \'twander\' will not keep track of your last manual entries for the +0, \fCtwander\fP will not keep track of your last manual entries for the CHANGEDIR, SELWILD, and RUNCMD dialogs. MAXMENUBUF specifies the size of the internal storage buffer for each @@ -1230,7 +1230,7 @@ .SS Directories Menu (Alt-d) [Shift-Right-Mouse-Button] -\'twander\' keeps track of every directory visited. The previously +\fCtwander\fP keeps track of every directory visited. The previously 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 @@ -1253,7 +1253,7 @@ .SS History Menu (Alt-h) [Shift-Control-Right-Mouse-Button] -\'twander\' keeps track of every command you attempt to execute, +\fCtwander\fP keeps track of every command you attempt to execute, whether it is an invocation of a Command Definition found in the Configuration File or a manually entered command via the RUNCMD key. (default: Control-z) This is done whether or not the command is @@ -1345,7 +1345,7 @@ .SS Help Menu (Alt-l) [No Mouse Shortcut] This menu provides information about various internal settings of -\'twander\' including User-Defined Variables, Command Definitions, +\fCtwander\fP including User-Defined Variables, Command Definitions, Internal Program Variables, User-Settable Options, Keyboard Assignments, and Directory Shortcuts. It also has an About feature which provides version and copyright information about the program. @@ -1353,15 +1353,15 @@ For the most part, this help information should fit on screen easily. However, very long Command Definitions will probably not fit on-screen once User-Defined and Environment Variables have been substituted. In -this case, if you are curious about just how \'twander\' is +this case, if you are curious about just how \fCtwander\fP is interpreting your Command Definitions, invoke the program with the relevant debug bit turned on and watch the output on stdout as -\'twander\' runs. +\fCtwander\fP runs. -.SH THE \'twander\' CONFIGURATION FILE +.SH THE \fCtwander\fP CONFIGURATION FILE -Much of \'twander\'s flexibility comes from the fact that it is +Much of \fCtwander\fPs flexibility comes from the fact that it is a .B macro-programmable user interface. The program itself does little more than provide a way to navigate @@ -1380,10 +1380,10 @@ but you can override this with the -c command line option. (Recommended for Windows systems - see the section below entitled, -.B INSTALLING \'twander\' +.B INSTALLING \fCtwander\fP ) -Actually, \'twander\' can look in a number +Actually, \fCtwander\fP can look in a number of places to find its Configuration File. It does this using the following scheme (in priority order): @@ -1400,17 +1400,17 @@ .B and a -c command line argument was not provided, look for a file called ".twander" in the directory from which -\'twander\' was invoked. +\fCtwander\fP was invoked. .SH CONFIGURATION FILE FORMAT -\'twander\' Configuration Files consist of freeform lines of text. +\fCtwander\fP Configuration Files consist of freeform lines of text. Each line is considered independently - no configuration line may cross into the next line. Whitespace is ignored within a line as are blank lines. -There are several possible legal lines in a \'twander\' Configuration +There are several possible legal lines in a \fCtwander\fP Configuration File: .ft C \" courier @@ -1429,16 +1429,16 @@ (See the ".twander" file provided with the program distribution for examples of valid configuration statements.) -Everything else is considered invalid. \'twander\' will respond with +Everything else is considered invalid. \fCtwander\fP will respond with errors or warnings as is appropriate anytime it encounters a problem in a Configuration File. An error will cause the program to terminate, but the program continues to run after a warning. For the -most part, \'twander\' tries to be forgiving and merely ignores +most part, \fCtwander\fP tries to be forgiving and merely ignores invalid configuration statements (after an appropriate warning). It only declares an error when it cannot continue. This is true both when the program initially loads as well as during any subsequent Configuration File reloads initiated from the keyboard while running -\'twander\'. +\fCtwander\fP. The following sections describe each of the valid Configuration File entires in more detail. @@ -1447,7 +1447,7 @@ A comment is begun with the "#" character which may be placed anywhere on a line. Comments may appear freely within a Configuration File. -\'twander\' strictly ignores everything from the "#" to the end of the +\fCtwander\fP strictly ignores everything from the "#" to the end of the line on which it appears without exception. This means that "#" cannot occur anywhere within a User-Defined Variable Definition, Key Binding Statement, or Command Definition (these are described below). @@ -1456,7 +1456,7 @@ 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\' +Command String portion of a Command Definition. \fCtwander\fP provides a Built-In Variable, [HASH], for exactly this purpose. See the section below entitled, .B Variables And Command Definitions, @@ -1464,10 +1464,10 @@ .SS Program Option Statements -Many of \'twander\'s internal program defaults can be overriden in the +Many of \fCtwander\fPs internal program defaults can be overriden in the Configuration File using Program Option statements. These statements look just like the User-Defined variables described later in this -document except \'twander\' recognizes the variable name as a Program +document except \fCtwander\fP recognizes the variable name as a Program Option rather than an arbitrary variable. Program Option Statements thus take the form: @@ -1478,7 +1478,7 @@ .ft \" revert The Option Name is case-sensitive and must be entered exactly as -described below. For instance, \'twander\' understands +described below. For instance, \fCtwander\fP understands "AUTOREFRESH" as a Program Option, but will treat "AutoRefresh" as a User-Defined Variable. @@ -1502,7 +1502,7 @@ the case). Furthermore, as described above, you cannot use the \'#\' symbol -as part of the string assignment because \'twander\' always +as part of the string assignment because \fCtwander\fP always treats this character as the beginning of a comment no matter where it appears. @@ -1530,16 +1530,16 @@ In other words, you should think of Program Option Statements with a blank Right Hand Side as comments - present but ignored. -Other than this basic type-checking, \'twander\' does no further +Other than this basic type-checking, \fCtwander\fP does no further validation of the Right Hand Side of a Program Option Statement. -It is perfectly possible to provide a RHS which passes \'twander\'s +It is perfectly possible to provide a RHS which passes \fCtwander\fPs type validation but which makes no sense whatsoever to the program. -Entries like this cause everything from a mild \'twander\' warning +Entries like this cause everything from a mild \fCtwander\fP warning to a spectacular program failure and Python traceback on stdout: .ft C \" courier .nf - # A Nice Way To Clobber \'twander\' + # A Nice Way To Clobber \fCtwander\fP BCOLOR = goo .fi .ft \" revert @@ -1561,7 +1561,7 @@ directory read took less than REFRESHINT milliseconds to complete - nothing special happens. But, if the actual directory read time takes .B longer -than REFRESHINT milliseconds, \'twander\' adjusts the value of +than REFRESHINT milliseconds, \fCtwander\fP adjusts the value of REFRESHINT upwards. That way, you're guaranteed to have time after the read completes to actually do something. @@ -1583,7 +1583,7 @@ .TP .B AFTERCLEAR [Boolean] (True) -Tells \'twander\' to clear any selections in the GUI if a command +Tells \fCtwander\fP to clear any selections in the GUI if a command forces a display refresh after it completes. (See the AFTERWAIT and .B Forcing Display Updates In Command Definitions sections below). This is done because a command that forces a display @@ -1601,7 +1601,7 @@ It is possible to define commands so that a display refresh is forced after a command is invoked (see the section below entitled, .B Forcing Display Updates In Command Definitions -). The AFTERWAIT option tells \'twander\' how long to wait after the +). The AFTERWAIT option tells \fCtwander\fP how long to wait after the command has been initiated before actually doing the refresh. The idea here is to give the command some time to complete before updating the display. @@ -1610,7 +1610,7 @@ .TP .B AUTOREFRESH [Boolean] (True) -By default, \'twander\' regularly re-reads the current directory to +By default, \fCtwander\fP regularly re-reads the current directory to refresh the display with any changes. If you are running on a very slow machine or slow connection between the X-Windows server and client, set this option to False. You can manually force an update at @@ -1625,7 +1625,7 @@ .TP .B CMDSHELL [String] () -This option is primarily intended for people running \'twander\' on +This option is primarily intended for people running \fCtwander\fP on Unix-like operating systems like FreeBSD and Linux. As described in the .B GOTCHAS @@ -1704,7 +1704,7 @@ CMDSHELL processing, even though that feature has been defined in the Configuration File. You can disable CMDSHELL operation on a per-RUNCMD basis. Just begin your entering your command with the -double-quote (") character. \'twander\' understands this to "escape" +double-quote (") character. \fCtwander\fP understands this to "escape" CMDSHELL processing. As a general matter, CMDSHELL allows you to prepend @@ -1763,7 +1763,7 @@ these strings contain the path separator character appropriate for the underlying operating system ("/" for Unix and "\\" for Windows). -If you set FORCEUNIXPATH to True, \'twander\' will +If you set FORCEUNIXPATH to True, \fCtwander\fP will .B always use the Unix path separator character("/") in these substitutions. @@ -1783,7 +1783,7 @@ .TP .B HEIGHT [Numeric] (600) -Initial vertical size of the \'twander\' window in pixels. +Initial vertical size of the \fCtwander\fP window in pixels. .TP .B HFCOLOR [String] (black) @@ -1811,16 +1811,16 @@ Maximum number of entries to .B display in any dynamic menu. This keeps the menu size reasonable. -Internally, \'twander\' keeps track of way more than this +Internally, \fCtwander\fP keeps track of way more than this number of dynamic entiries (see the MAXMENUBUF option below). .TP .B MAXMENUBUF [Numeric] (250) -Maximum number of items \'twander\' +Maximum number of items \fCtwander\fP .B tracks internally for each dynamic menu. This value need normally not be changed. It is present only -to bound how much memory \'twander\' consumes for this task. +to bound how much memory \fCtwander\fP consumes for this task. .TP .B MAXNESTING [Numeric] (32) @@ -1837,7 +1837,7 @@ .fi .ft \" revert -When you press the x key, the \'twander\' command interpreter has to +When you press the x key, the \fCtwander\fP command interpreter has to process the line repeatedly until all variables are resolved: .ft C \" courier @@ -1858,12 +1858,12 @@ .fi .ft \" revert -This kind of construct will cause \'twander\' to iterate +This kind of construct will cause \fCtwander\fP to iterate MAXNESTING number of times and then give up with a warning about exeeding the nesting (dereferencing) limit. A 32 iteration limit should be plenty for any reasonable -Command Definitions. If you set MAXNESTING to 0, \'twander\' +Command Definitions. If you set MAXNESTING to 0, \fCtwander\fP will not allow .B any variable dereferencing, @@ -1911,7 +1911,7 @@ Prevents the user from navigating out of the starting directory. Command Definitions and commands initiated manually via RUNCMD (default: Control-z) can still "see" other directories, the user -just cannot move elsewhere with any of the \'twander\' navigation +just cannot move elsewhere with any of the \fCtwander\fP navigation commands. The NODETAILS and NONAVIGATE commands are @@ -1923,7 +1923,7 @@ Say you want to define a few simple commands for your boss to use which won't challenge his or her feeble managerial mind ;) By defining these commands and setting both NODETAILS and NONAVIGATE -to TRUE, you really limit what can be done with \'twander\'. +to TRUE, you really limit what can be done with \fCtwander\fP. They can't wander off into other directories and get lost, or worse yet, clobber files they don't understand. There are no details to confuse them. Your instructions for using the program @@ -1939,7 +1939,7 @@ .TP .B QUOTECHAR [String] (") -As described below, \'twander\' ordinarily quotes most Built-In +As described below, \fCtwander\fP ordinarily quotes most Built-In Variables as it replaces them during command processing. This is useful because modern operating systems allow file and directory names to have spaces in them. Such names must be @@ -1971,14 +1971,14 @@ than the default of 5 seconds), but it can be off this nominal value by quite a bit. -If you run \'twander\' on a slow system (or have a slow link between +If you run \fCtwander\fP on a slow system (or have a slow link between X-Client and X-Server) you might want to increase this value substantially. You can get into the situtation where just as one -refresh completes, its time to do the next one, and the \'twander\' +refresh completes, its time to do the next one, and the \fCtwander\fP will seem really sluggish and unresponsive. By lengthening the time between automatic updates, the amount of unresponsive behavior is reduced. Of course, this also means that any changes in the currently -viewed directory will also take longer to appear in the \'twander\' +viewed directory will also take longer to appear in the \fCtwander\fP display. .TP @@ -2042,12 +2042,12 @@ .TP .B STARTX [Numeric] (0) -Initial horizontal offset of the \'twander\' window in pixels. +Initial horizontal offset of the \fCtwander\fP window in pixels. .TP .B STARTY [Numeric] (0) -Initial vertical offset of the \'twander\' window in pixels. +Initial vertical offset of the \fCtwander\fP window in pixels. .TP .B SYMDIR [Boolean] (True) @@ -2063,10 +2063,10 @@ .TP .B USETHREADS [Boolean] (False) -\'twander\' defaults to using normal "heavy weight" processes +\fCtwander\fP defaults to using normal "heavy weight" processes for running commands on Unix. Many Unix implementations also support a "threaded" process model. Setting USETHREADS -to True on such systems will cause \'twander\' to use threads, rather than +to True on such systems will cause \fCtwander\fP to use threads, rather than processes to launch user-defined commands. There are some known issues with thread-based operations (hence the reason this option defaults to False). These are discussed in the @@ -2089,7 +2089,7 @@ Normally, this option should be left alone. However, if you have \'win32all\' installed on your system for some other reason, but don't -want it used by \'twander\', set this option to False. +want it used by \fCtwander\fP, set this option to False. The main reason to do this would be on a slow machine with very large directories. The advanced features of \'win32all\' come at a @@ -2105,7 +2105,7 @@ .B WARN [Boolean] (True) Determines whether interactive warnings should be displayed -as \'twander\' encounters them (while parsing a Configuration +as \fCtwander\fP encounters them (while parsing a Configuration File or just in normal execution). Setting this option to False is the same thing as using the @@ -2118,7 +2118,7 @@ top of your Configuration File will suppress this. It is not recommended that you operate normally with the --q flag or with WARN=False. \'twander\' is pretty +-q flag or with WARN=False. \fCtwander\fP is pretty forgiving in most cases and when it does warn you about something, there is a good reason for it - you probably want to know what the problem is. @@ -2126,14 +2126,14 @@ .TP .B WIDTH [Numeric] (800) -Initial horizontal size of the \'twander\' window in pixels. +Initial horizontal size of the \fCtwander\fP window in pixels. .P A few general notes about Program Options are worth mentioning here: .IP \(bu 4 You can set the same option multiple times in a single -Configuration File - \'twander\' pays no attention. +Configuration File - \fCtwander\fP pays no attention. However, only the .B last (the one nearest the end of the file) instance of that Program Option @@ -2160,14 +2160,14 @@ actually exist on your system. If your setting in the Configuration File seems not to work, take a -look at the command window in which you started \'twander\' (or start +look at the command window in which you started \fCtwander\fP (or start it from one manually, if you're using a GUI shortcut to start it). Attempts to use unavailable colors and weights will cause Python/Tkinter to dump traceback information on stdout. .IP \(bu 4 -Although you can use proportionally spaced fonts with \'twander\', -the result is pretty ugly. \'twander\' assumes a fixed width +Although you can use proportionally spaced fonts with \fCtwander\fP, +the result is pretty ugly. \fCtwander\fP assumes a fixed width font when it calculates display formatting. Variable-width fonts will cause your display to be ragged and hard to read. @@ -2183,7 +2183,7 @@ Changing MAXMENU and then reloading the Configuration File only changes .B the number of items visible on the various dynamic menus. -\'twander\' actually keeps track of more than this internally +\fCtwander\fP actually keeps track of more than this internally (governed by the MAXMENUBUF option). Say MAXMENU is set to 4, but you've actually visited 20 different @@ -2195,10 +2195,10 @@ .IP \(bu 4 At first glance, the ability to set QUOTECHAR to any arbitary string may seem silly, but it actually has a purpose. As good as the -\'twander\' macro capability is, it is still a fairly simple language. +\fCtwander\fP macro capability is, it is still a fairly simple language. Really complex tasks will need to be handed off to some other scripting language (like Python!). It may be useful to delimit -Built-In Variables (which indicate your selections via the \'twander\' +Built-In Variables (which indicate your selections via the \fCtwander\fP interface) in such a way that your script knows where they came from. So, say you set QUOTECHAR=+++ and you have a Command Definition like this: @@ -2210,7 +2210,7 @@ .ft \" revert When MyPythonScript runs, it can immediately tell which arguments -came from \'twander\' (the ones that are in the form +++dir+++ +came from \fCtwander\fP (the ones that are in the form +++dir+++ or +++file+++) and which arguments are just other stuff. You probably won't need this often, but its nice to have. @@ -2229,14 +2229,14 @@ everyone's (anyone's!) idea of what the "correct" key bindings should be. An emacs user, vi user, BSD user, and Windows user are going to differ considerably on what keys should be bound to what -feature. \'twander\' ships from the factory with a set of default key +feature. \fCtwander\fP ships from the factory with a set of default key bindings, but it also provides a mechanism for changing these bindings via entries in the Configuration File. This feature is available only for .B Keyboard Assignments. Mouse Button Assignments may not be changed by the user. An attempt -to do so in the Configuration File will cause \'twander\' to display a +to do so in the Configuration File will cause \fCtwander\fP to display a warning and ignore the offending line. It is not difficult to override the default keyboard bindings by @@ -2258,7 +2258,7 @@ both in print and on the Internet.) Keyboard binding assignments look just like variable definitions -in the Configuration File. (The \'twander\' Configuration File parser +in the Configuration File. (The \fCtwander\fP Configuration File parser automatically distinguishes between Key Binding Statements and Variable Definitions or other legitimate statements. This means you can never use one of the program function names as one of your own @@ -2307,7 +2307,7 @@ .IP \(bu 4 The Program Function Name variables (the left side of the assignment) may not be used as names for your own user-defined variables elsewhere -in the Configuration File. In fact, \'twander\' will never even +in the Configuration File. In fact, \fCtwander\fP will never even recognize such an attempt. For example, suppose you try to do this: .ft C \" courier @@ -2317,11 +2317,11 @@ .ft \" revert Because you want to be able to reference [QUITPROG] in a subsequent -Command Definition. \'twander\' will actually interpret this as just +Command Definition. \fCtwander\fP will actually interpret this as just another key binding command, in this case binding the program function QUITPROG to "something-or-other" - probably not what you intended. Moreover, if you have a Command String somewhere with [QUITPROG] in it, -\'twander\' will declare and error and abort because it has no +\fCtwander\fP will declare and error and abort because it has no User-Defined variable of that name in its symbol table. .IP \(bu 4 @@ -2330,15 +2330,15 @@ the new bindings. .IP \(bu 4 -Be aware that \'twander\' does no sanity testing on the assignments -you change. If you assign a particular \'twander\' function to +Be aware that \fCtwander\fP does no sanity testing on the assignments +you change. If you assign a particular \fCtwander\fP function to an illegal or silly key string, the program will probably blow-up spectacularly. At the very least, that program feature will probably -be unusable, even if \'twander\' manages to run. +be unusable, even if \fCtwander\fP manages to run. .SS Directory Shortcut Statements -\'twander\' provides a mechanism for directly navigating into one +\fCtwander\fP provides a mechanism for directly navigating into one of 12 frequently used directories. 12 keys, KDIRSC1 ... KDIRSC12 (default: F1 ... F12) have been set aside for this purpose. Directory Shortcut Statements are entries in the Configuration File which @@ -2367,7 +2367,7 @@ understand: .IP \(bu 4 -You can end the path with slash or not - \'twander\' +You can end the path with slash or not - \fCtwander\fP will understand the entry either way. .IP \(bu 4 @@ -2383,7 +2383,7 @@ .ft \" revert .IP \(bu 4 -\'twander\' does absolutely no checking of what you enter +\fCtwander\fP does absolutely no checking of what you enter to the right of the equals sign. If you enter something silly for the shortcut path, you will probably get a warning that the directory cannot be opened when you try to run that @@ -2400,12 +2400,12 @@ .IP \(bu 4 If you enter a Directory Shortcut Name that is invalid or out of range - examples include, DIRSC01 and DIRSC13 - -\'twander\' treats them like a User-Defined Variable as +\fCtwander\fP treats them like a User-Defined Variable as described below. .SS Wildcard Statements -As discussed above, \'twander\' provides powerful regular +As discussed above, \fCtwander\fP provides powerful regular expression-based "wildcard" selection capabilities via the SELWILD command. (default: Control-\\) These regular expressions can be complex and tedious to enter @@ -2420,7 +2420,7 @@ .ft \" revert This regular expression will then be pre-loaded into the Wildcard Menu -(making it easy to invoke by just clicking on it) when \'twander\' starts. +(making it easy to invoke by just clicking on it) when \fCtwander\fP starts. You may place as many of these as you like in your Configuration File. (Though the menu will be limited to displaying MAXMENU number of items - see the section above on Program Option Statements.) @@ -2429,23 +2429,23 @@ .SS Variables And Command Definitions Most programs "ship from the factory" with a pre-defined -set of features or commands. \'twander\' comes with +set of features or commands. \fCtwander\fP comes with .B no built-in commands! Instead, it comes with a mechanism which allows you to specify your own .B Command Definitions. By means of a simple and very powerful macro lanuage, you "program" -\'twander\' and equip it with commands of your own choosing. For +\fCtwander\fP and equip it with commands of your own choosing. For example, you might define commands to copy, delete, edit, and move the files or directories you choose. Perhaps you have a specialized shell -script for doing backups. It's a simple matter to write a \'twander\' +script for doing backups. It's a simple matter to write a \fCtwander\fP Command Definition that will pass the names of the files and directories you've selected to that backup script. You might combine -this with \'twander\'s Program Memory feature to keep a running list +this with \fCtwander\fPs Program Memory feature to keep a running list of the files and directories you want to backup and then finally issue the backup command when you're ready. Best of all, commands you define this way are always a single keystroke. This means that -once you've programmed \'twander\' to suit your needs, actually using +once you've programmed \fCtwander\fP to suit your needs, actually using it is very fast and convenient. Command Definitions are built out of literal text and may also have @@ -2503,7 +2503,7 @@ Here are several other subtleties regarding User-Defined Variables: .IP \(bu 4 -\'twander\' variable definitions are nothing more than a +\fCtwander\fP variable definitions are nothing more than a string substitution mechanism. Suppose you have a variable definition that refers to another variable: @@ -2544,7 +2544,7 @@ .fi .ft \" revert -Later on (when defining some command) when \'twander\' runs into the +Later on (when defining some command) when \fCtwander\fP runs into the variable reference [FB], it will keep substituting variables until all [...] references have been resolved or it hits the nesting limit (The default is 32, but you can change it with the MAXNESTING option). @@ -2556,7 +2556,7 @@ .fi .ft \" revert -This recursive definition is a no-no and will be cause \'twander\' +This recursive definition is a no-no and will be cause \fCtwander\fP to generate an error while parsing the Configuration File and then terminate. @@ -2624,7 +2624,7 @@ .IP \(bu 4 A Variable Name must never begin with "$". This is because a Command Definition containing a string in the form [$something] is understood -by \'twander\' to be a reference to an +by \fCtwander\fP to be a reference to an .B Environment Variable, named "something". If you do this: @@ -2635,14 +2635,14 @@ .ft \" revert You will never be able to subsequently reference it because, -[$MYVAR] tells \'twander\' to look in the current environment, +[$MYVAR] tells \fCtwander\fP to look in the current environment, 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 -Unlike previous versions of \'twander\', Variable Names may be redefined. -This makes it more convenient to exploit the ability for \'twander\' +Unlike previous versions of \fCtwander\fP, Variable Names may be redefined. +This makes it more convenient to exploit the ability for \fCtwander\fP to process the contents of a Configuration File conditionally (see the .B Conditional Processing Statements section below). @@ -2665,11 +2665,11 @@ .ft \" revert .SS Command Definitions -The heart of the \'twander\' configuration process is creating +The heart of the \fCtwander\fP configuration process is creating of one or more .B Command Definitions. These definitions are the way user-defined commands are added to a -given instance of \'twander\'. A Command Definition consists of three +given instance of \fCtwander\fP. A Command Definition consists of three fields separated by whitespace: .ft C \" courier @@ -2684,7 +2684,7 @@ the key that will be used to invoke the command from the keyboard. Command Keys are case-sensitive. If "m" is used as a Command Key, "M" will not invoke that command. Command Keys must be unique within a -given Configuration File. If \'twander\' finds multiple Command +given Configuration File. If \fCtwander\fP finds multiple Command Definitions assigned to the same Command Key, it will associate the .B last definition it finds with that Command Key. A Command Key can @@ -2703,7 +2703,7 @@ The .B Command String -is any arbitrary string which is what \'twander\' actually tries to +is any arbitrary string which is what \fCtwander\fP actually tries to execute when the command is invoked. .SS A Simple Command Definition @@ -2720,7 +2720,7 @@ This command can be invoked pressing the "m" key on the keyboard or selecting the "MyMore" entry from the Command Menu - either directly from the menu or from the Command Menu Pop-Up. No matter how it is -invoked, \'twander\' will then execute the command, "more somefile". +invoked, \fCtwander\fP will then execute the command, "more somefile". The problem is that this command as written actually will not give you the result you'd like (...well, on X-Windows - is does work on Windows @@ -2744,12 +2744,12 @@ You are likely to define commands that change the contents of the currently-viewed directory somehow. For instance, commands that rename, create, or delete files in the current directory all have this -effect. When such a command is run, it means that the \'twander\' display is +effect. When such a command is run, it means that the \fCtwander\fP display is "out of sync" with the actual disk contents until the next refresh cycle - automatic if AUTORFRESH is enabled, manual otherwise. Placing \'+\' symbol to the beginning of the Command String tells -\'twander\' that, when the command is run, a display refresh should be +\fCtwander\fP that, when the command is run, a display refresh should be forced afterwards. Not immediately afterwards, but AFTERWAIT seconds (default: 1) later. Why? To give the command in question a chance to complete before updating the display. For instance, @@ -2761,7 +2761,7 @@ .ft \" revert This means that when the \'r\' key is pressed, the command, -"rm -f *.log" is run, and then, AFTERWAIT seconds later, \'twander\' +"rm -f *.log" is run, and then, AFTERWAIT seconds later, \fCtwander\fP will force a display update. This happens regardless of the current AUTOREFRESH settings. @@ -2823,10 +2823,10 @@ .SS Built-In Variables In A Command String It would also be really nice if the command applied to more than just -a single file called "somefile". The whole point of \'twander\' +a single file called "somefile". The whole point of \fCtwander\fP is to allow you to use the GUI to select one or more directories and/or files and have your Command Definitions make use of those -selections. \'twander\' uses a set of +selections. \fCtwander\fP uses a set of .B Built-In Variables to communicate the current directory and user selections to the any commands you've defined. Built-In Variables are referenced @@ -2853,7 +2853,7 @@ .SS Selection-Related Built-Ins -\'twander\' has a rich set of Built-In Variables for use in your +\fCtwander\fP has a rich set of Built-In Variables for use in your Command Definitions. The first group of these is used to convey your current directory and items which you've selected to a Command Definition: @@ -2862,7 +2862,7 @@ .IP \(bu 4 .B [DIR] -[DIR] is replaced with the current directory \'twander\' +[DIR] is replaced with the current directory \fCtwander\fP is viewing. .IP \(bu 4 @@ -2909,7 +2909,7 @@ .IP \(bu 4 .B [HASH] -Because \'twander\' always recognizes the "#" as the beginning of a +Because \fCtwander\fP always recognizes the "#" as the beginning of a comment, there is no direct way to include this character in a Command String. It is conceivable that some commands (such as \'sed\') need to make use of this character. The [HASH] built-in is provided for @@ -3000,7 +3000,7 @@ .SS Program Memory Built-Ins -As described previously, \'twander\' implements an advanced notion of +As described previously, \fCtwander\fP implements an advanced notion of a Clipboard called "Program Memories". There is a corresponding group of Built-In Variables which allows the contents of these memories to be used in a Command Definition: @@ -3028,7 +3028,7 @@ even though it is visible in the GUI. This provides maximum flexibility when defining commands. It is up to the command author to insert the appropriate path separator character where needed. (NOTE: -Earlier releases of \'twander\' +Earlier releases of \fCtwander\fP .B did include the trailing path separator and you may have to edit older Configuration Files accordingly. This change was necessary @@ -3054,7 +3054,7 @@ .fi .ft \" revert -Be aware that, because of \'twander\' quoting rules, such constructs +Be aware that, because of \fCtwander\fP quoting rules, such constructs will result in strings like: .ft C \" courier @@ -3078,7 +3078,7 @@ .IP \(bu 4 User-Defined and Environment Variables are processed -at the time the Configuration File is read by \'twander\'. That +at the time the Configuration File is read by \fCtwander\fP. That is, they are handled .B once at load time. @@ -3094,7 +3094,7 @@ default is recommended so that any built-in substitutions of, say, file names with spaces in them, will be properly recognized by your commands. You can suppress the addition of double-quotes by using the --t command line option when starting \'twander\'. +-t command line option when starting \fCtwander\fP. .IP \(bu 4 Any of the variable types may appear multiple times in the @@ -3114,12 +3114,12 @@ .SS Conditional Processing Statements -Most of \'twander\'s power lies in its ability to be customized to each +Most of \fCtwander\fPs power lies in its ability to be customized to each different user and operating system via its Configuration File. To make this a bit -easier to manage, the \'twander\' configuration language recognizes +easier to manage, the \fCtwander\fP configuration language recognizes so-called "Conditional Processing Statements". These statements give you the ability to write a single Configuration File which automatically tailors -itself to run \'twander\' properly wherever you are running. +itself to run \fCtwander\fP properly wherever you are running. The general idea is to define a "Condition Block" which begins by doing a logical test. If that test evaluates to True, all statements @@ -3129,7 +3129,7 @@ A Conditional Block always begins with a "Condition Test Statement" and ends with the ".endif" statement. Conditional Processing -Statements may be nested without limit. \'twander\' keeps track of which +Statements may be nested without limit. \fCtwander\fP keeps track of which \&'.endif' matches which Condition Test Statement. Like all Configuration File entries, whitespace is ignored when processing Conditional Statements and you are free to indent (or not) as you see fit. @@ -3179,17 +3179,17 @@ .ft \" revert To make it easy to create conditional blocks based on the type of -system you're running, \'twander\' automatically pre-defines two variables +system you're running, \fCtwander\fP automatically pre-defines two variables which provide information about your system: .B \&.OS (typically: nt, posix) and .B \&.PLATFORM -(typically: freebsd4, linux-i386, win32). You should run \'twander\' and +(typically: freebsd4, linux-i386, win32). You should run \fCtwander\fP and examine the "User-Defined Variables" section of the Help Menu to see how these variables are set on your system. These predefined variables show up as "User Defined Variables" in the -various \'twander\' Help and Debug outputs, but they begin with a period to +various \fCtwander\fP Help and Debug outputs, but they begin with a period to remind you of their intended role. They will thus also sort first in the User-Defined Variables section of the Help Menu. @@ -3251,7 +3251,7 @@ You may place as many of these statements in your Configuration File as you wish. The only syntactic requirement is that there must be whitespace -between the directive and the file path. \'twander\' makes no attempt +between the directive and the file path. \fCtwander\fP makes no attempt to validate that path, and you will see an warning message if the file you specify cannot be opened. @@ -3299,7 +3299,7 @@ .ft \" revert -Keep in mind that \'twander\' reads the contents of its Configuration File +Keep in mind that \fCtwander\fP reads the contents of its Configuration File .B in order. In this case, it means that all of "/usr/local/etc/.twander.global" is read and @@ -3312,20 +3312,26 @@ can override previous definitions for User-Defined Variables and even Command Definitions. +The program checks to see if you attempt to do a "circular" include. +For example, say file "A" \fC.include\fPs file "B" and file "B" then +\fC.include\fPs file "A". This wold create a neverending "circle" of +included files. If \fCtwander\fP detects this, it will display an error +describing the problem. + .SH ADVANCED WINDOWS FEATURES -As shipped from the factory, \'twander\' runs pretty much identically on -various Unix variants (FreeBSD, Linux) and Windows. However, \'twander\' is +As shipped from the factory, \fCtwander\fP runs pretty much identically on +various Unix variants (FreeBSD, Linux) and Windows. However, \fCtwander\fP is written to take advantage of Mark Hammond's \'win32all\' Python extensions if they are present on the system. These extensions add many -Windows-specific features to Python and allow \'twander\' to provide quite a +Windows-specific features to Python and allow \fCtwander\fP to provide quite a bit more Windows-centric information about files, directories, and drives. You do .B not -have to install \'win32all\' for \'twander\' to operate properly +have to install \'win32all\' for \fCtwander\fP to operate properly on your Windows system. Installing this package just means you'll -get even more \'twander\' features on Windows than you would otherwise. +get even more \fCtwander\fP features on Windows than you would otherwise. If you've installed \'win32all\', you can toggle these features on- and off with the TOGWIN32ALL key described above. @@ -3349,12 +3355,12 @@ emulate portions of the Win32 API and do not implement the advanced security features found in the NTFS file system. Therefore, as noted below, some of these features will not work on any of the older 16-bit -Windows operating systems. \'twander\' handles this gracefully +Windows operating systems. \fCtwander\fP handles this gracefully without blowing-up so you can safely have \'win32all\' installed on one of these older systems to take advantage of the features that do work. -Once you have these extensions installed, \'twander\' will +Once you have these extensions installed, \fCtwander\fP will automatically enable three new features otherwise unavailable. .IP \(bu 4 @@ -3390,7 +3396,7 @@ drives, the drive label is shown. For network-attached drives, the share string is shown. The drive type (CD/DVD, Fixed, Ramdisk, Remote, Removable) is shown as are the free, and total space -statistics. As is the case with other \'twander\' displays, these details +statistics. As is the case with other \fCtwander\fP displays, these details can be toggled on- and off via the TOGDETAIL key. You can enter the Drive List View in a number of ways: @@ -3399,7 +3405,7 @@ 1) Select the ".." from the root directory of any drive. 2) Enter the string "\\\\" from the CHANGDIR dialog. 3) Press the DRIVELIST key. (default: Control-k) - 4) Start \'twander\' using "\\\\" as the starting directory + 4) Start \fCtwander\fP using "\\\\" as the starting directory argument, either on the command line or using the Configuration File STARTDIR option. .fi @@ -3423,22 +3429,22 @@ The [DIR] Built-In returns an empty string in this view. .IP \(bu 4 -Normally, as you navigate around a file system, \'twander\' sets its +Normally, as you navigate around a file system, \fCtwander\fP sets its own program context to the current directory. This is why you can write Command Definitions using only the file/directory name currently -selected - \'twander\' knows the current directory. When you are in +selected - \fCtwander\fP knows the current directory. When you are in Drive List View, the notion of "current directory" has no real -meaning. So, \'twander\' treats the directory from which you entered +meaning. So, \fCtwander\fP treats the directory from which you entered Drive List View as the "current directory" while in that view. .IP \(bu 4 -By default, \'twander\' automatically rereads the current view +By default, \fCtwander\fP automatically rereads the current view about every 3 seconds. This is fine for a file/directory view but would be annoyingly slow in the Drive List View since it takes a moment or two to get the status of any floppy disk drives attached to the system. Instead of forcing the user to listen to (and wait for) the floppy drive status to be determined -every 3 seconds, \'twander\' +every 3 seconds, \fCtwander\fP .B only reads the drive information once when it enters Drive List View. This means if a drive is connected or a floppy is inserted into the system while in Drive List View, this fact will not be automatically @@ -3469,25 +3475,25 @@ setting the USEWIN32ALL option to False in the Configuration File. This allows you to leave \'win32all\' installed on your system if you need it for other reasons but don't want these features -enabled in \'twander\' +enabled in \fCtwander\fP .SH GOTCHAS -There are several tricky corners of \'twander\' which need +There are several tricky corners of \fCtwander\fP which need further explanation: .SS Program Starts Very Slowly -\'twander\' attempts to determine the name of the host on which it is +\fCtwander\fP attempts to determine the name of the host on which it is running at program startup. This is used in the titlebar display. It first looks to see if the environment variable HOSTNAME is set, and -uses that value if it is. If this variable is not set, \'twander\' +uses that value if it is. If this variable is not set, \fCtwander\fP does a socket call to see if it can determine the hostname that way. Either of these methods works fine, but the socket call can be very slow if the network is misconfigured or malfunctioning. If -\'twander\' is starting very slowly, try setting HOSTNAME explicitly +\fCtwander\fP is starting very slowly, try setting HOSTNAME explicitly in your environment - this will prevent the socket call from ever taking place. A simple way to do this with \'ksh\' or \'bash\' is: @@ -3508,9 +3514,9 @@ On Windows, environment variables are set via the System Properties menu. -.SS \'twander\' Loads Slowly +.SS \fCtwander\fP Loads Slowly -\'twander\' is a fairly large Python program and can take a few seconds to +\fCtwander\fP is a fairly large Python program and can take a few seconds to load and initialize, especially on older, slower systems. You can speed this up a bit by creating an optimized byte-code version of the program as follows (make sure you have appropriate administrative @@ -3520,7 +3526,7 @@ 1) Go to the directory where the twander.py file is located. 2) Type the following command: python -O 3) Once Python is loaded type: import twander - 4) Exit \'twander\'. + 4) Exit \fCtwander\fP. 5) Exit Python by pressing Control-d on Unix or Control-z on Windows. 6) You will now see a new file in this directory: twander.pyo @@ -3572,11 +3578,11 @@ .SS Getting Command Results Displayed In A New Window -When you invoke a command via \'twander\' (whether via a command +When you invoke a command via \fCtwander\fP (whether via a command definition in the Configuration File or the keyboard shortcut), you generally want it to run in a new window. This turns out to be tricky on Unix-like systems. If the program you are running is GUI-aware, -this should not be a problem. However, if you are using \'twander\' +this should not be a problem. However, if you are using \fCtwander\fP to run a command line program or script, you have to take extra care in the formulation of the Command String. In the case of Unix-like systems you have to invoke the command so that it runs in some GUI @@ -3590,15 +3596,15 @@ .ft \" revert Sadly, this will not work, at least not the way you expect. -If you started \'twander\' from a terminal session and use +If you started \fCtwander\fP from a terminal session and use the command above, it will work, but the results will appear in the invoking terminal window, .B not -in a new window as you might expect. If you started \'twander\' +in a new window as you might expect. If you started \fCtwander\fP 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 how +output. This is not a \fCtwander\fP problem, it is innate to how command line programs run under Unix shell control. To achieve the desired results, you have to create a new GUI window in @@ -3655,10 +3661,10 @@ However, .B which terminal window is used for output can be confusing. If you -start \'twander\' from a terminal session, +start \fCtwander\fP from a terminal session, all terminal output will be sent to .B the terminal session you used to invoke the program. -The way to work around this is to start \'twander\' from a Windows +The way to work around this is to start \fCtwander\fP from a Windows shortcut, using \'pythonw.exe\' rather than \'python.exe\'. Now each time you run a command that needs a terminal session for output, Windows will automatically create that session for you. @@ -3693,7 +3699,7 @@ This works fine .B so long as the user does not enter a wildcard pattern -in response to the prompt. Why? Recall that \'twander\' +in response to the prompt. Why? Recall that \fCtwander\fP quotes all Built-In Variable substitutions by default. If the user enters this at the prompt: @@ -3703,7 +3709,7 @@ .fi .ft \" revert -The command \'twander\' tries to execute is: +The command \fCtwander\fP tries to execute is: .ft C \" courier .nf @@ -3758,12 +3764,12 @@ Notice our example commands above do not end with "&". These should not be needed on either Unix-like or Windows operating systems. When a -command is executed, \'twander\' starts a process which runs concurrently -with \'twander\' itself. This means you should be able to continue using -\'twander\' while the new command executes. +command is executed, \fCtwander\fP starts a process which runs concurrently +with \fCtwander\fP itself. This means you should be able to continue using +\fCtwander\fP while the new command executes. If you enable the use of threads by setting USETHREADS to True, you -may see \'twander\' locked out while the new command runs - so-called +may see \fCtwander\fP locked out while the new command runs - so-called "modal" operation. If this happens, it means your system does not completely or correctly implement threading and you must use conventional "heavy weight" processes (the default) rather than @@ -3773,7 +3779,7 @@ It appears that some X Windows implementations (noted on XFree86 / FreeBSD) do not correctly destroy an \'xterm\' window after a command -initiated with -e terminates. This is not a \'twander\' problem - it is +initiated with -e terminates. This is not a \fCtwander\fP problem - it is an artifact of thread behavior on such systems and only happens if you set USETHREADS=True. The workaround is to use the default USETHREADS=False setting. @@ -3793,9 +3799,9 @@ .B really slow response times when you change to a new directory. This occurs when you enter a huge directory with thousands of file or subdirectory -entries. \'twander\' has to to compute the detail information for +entries. \fCtwander\fP has to to compute the detail information for each of these entries and this can take a lot of time. On a fast -machine with modern hard drives and controllers, \'twander\' is able +machine with modern hard drives and controllers, \fCtwander\fP is able to process several thousand entries in just a second or two. However, a number of factors can significantly slow down this process: @@ -3805,11 +3811,11 @@ right away. The program will appear to hang. There are two possibilities here. Either disable autorefreshing (via the -r command line option or the AUTOREFRESH Configuration File option), or set the -REFRESHINT value to some high number so that \'twander\' has plenty +REFRESHINT value to some high number so that \fCtwander\fP has plenty of time to process a directory before the next refresh occurs. .IP \(bu 4 -Slow disk drives. You can really watch \'twander\' grind if you +Slow disk drives. You can really watch \fCtwander\fP grind if you change to a large directory on a CDROM, for instance. There is no good solution here. These drives are inherently slower than hard drives, and you just have to wait. Make sure you lengthen your @@ -3831,14 +3837,14 @@ By disabling these features, the time came down to under 30 seconds. .IP \(bu 4 -For all these reasons, \'twander\' implements an "adaptive refresh" +For all these reasons, \fCtwander\fP implements an "adaptive refresh" scheme by default. Whenever a directory is read, the time to do so is tracked. If that time is less than the current value of REFRESHINT - i.e., The directory read took less than REFRESHINT milliseconds to complete - nothing special happens. But, if the actual directory read time takes .B longer -than REFRESHINT milliseconds, \'twander\' adjusts the value of +than REFRESHINT milliseconds, \fCtwander\fP adjusts the value of REFRESHINT upwards. That way, you're guaranteed to have time after the read completes to actually do something. @@ -3861,7 +3867,7 @@ .SS Your Configuration File Does Not Produce The Desired Results -It's easy to fall into the trap of treating the \'twander\' +It's easy to fall into the trap of treating the \fCtwander\fP configuration capabilities as a real "programming language". It is not, it is a fairly simple macro language that does very little more than string substitutions. @@ -3891,7 +3897,7 @@ .IP \(bu 4 When testing for the existence of a User-Defined or Environment -Variable, \'twander\' does not care what +Variable, \fCtwander\fP does not care what .B value the variable contains. It is perfectly permissible to have either type of variable set to an empty string. The fact @@ -4019,7 +4025,7 @@ the advanced Windows features. You'll find the latest version, and occasionally, Release Candidates -of the next version of \'twander\' at: +of the next version of \fCtwander\fP at: .ft C \" courier .nf @@ -4033,7 +4039,7 @@ .SH BUGS AND MISFEATURES -As of this release, a number of problems relating to \'twander\' +As of this release, a number of problems relating to \fCtwander\fP use have been noted: .IP \(bu 4 @@ -4041,7 +4047,7 @@ of its various entries for Program Options, Key Bindings, Directory Shortcuts, Variable Definitions, and Command Definitions. It is entirely possible to edit something into this file that makes no sense -at all and causes \'twander\' to misbehave. +at all and causes \fCtwander\fP to misbehave. .IP \(bu 4 There appears to be a Tkinter/Tk bug on Unix which sometimes inhibits @@ -4054,7 +4060,7 @@ older Windows OSs. For example, the free/total space available in the Drive List View has been noted to display incorrect values on Win98. Similarly, the owner and group names are displayed as "Unavailable" on -pre-NTFS file systems. These are OS limitations which \'twander\' +pre-NTFS file systems. These are OS limitations which \fCtwander\fP handles gracefully. .IP \(bu 4 @@ -4071,14 +4077,14 @@ .IP \(bu 4 This program has not been tested on MacOS. It has been reported that -Python on MacOS X returns \'posix\' as its OS name. If true, \'twander\' +Python on MacOS X returns \'posix\' as its OS name. If true, \fCtwander\fP should work as written, though we've not verified this. Please let us know how/if it works there and any issues you discover. -.SH INSTALLING \'twander\' +.SH INSTALLING \fCtwander\fP -Installation of \'twander\' is fairly simple and takes only a few +Installation of \fCtwander\fP is fairly simple and takes only a few moments. The most important thing before installing the program is to make sure you have Python 2.2 (or later) with Tkinter support installed on your system. @@ -4091,10 +4097,10 @@ .SS Installing Using The FreeBSD Port -If you've installed \'twander\' using the FreeBSD port, all you have +If you've installed \fCtwander\fP using the FreeBSD port, all you have to do is copy the example Configuration File, ".twander" found in /usr/local/share/doc/twander to your home directory and edit it to -taste. (You'll also find documentation for \'twander\' in various formats in +taste. (You'll also find documentation for \fCtwander\fP in various formats in this directory as well.) Make sure that /usr/local/bin is in your path. To start the program, @@ -4113,8 +4119,8 @@ .B Red Hat Linux Users Please Note: RH Linux (and possibly other Linux systems) installs two versions of Python. Version 1.52 is called \'python\', and Version 2.2 is called -\'python2\'. \'twander\' requires the latter and will not run on the -former. As shipped, \'twander\' invokes Python with the Unix shell +\'python2\'. \fCtwander\fP requires the latter and will not run on the +former. As shipped, \fCtwander\fP invokes Python with the Unix shell "#!" mechanism using the name \'python\' - which in this case is the wrong version. You can work around this problem one of several ways: @@ -4124,7 +4130,7 @@ .IP \(bu 4 Write an alias or shell script which explicity starts -\'twander\' with the correct version of Python: +\fCtwander\fP with the correct version of Python: .ft C \" courier .nf @@ -4134,14 +4140,14 @@ .ft \" revert .IP \(bu 4 -Change the first line of the \'twander\' code to refer +Change the first line of the \fCtwander\fP code to refer to \'python2\' instead of \'python\'. .P Red Hat users who have upgraded from earlier Linux versions should also note that you may have files in your home directories owned by owners and groups which are no longer defined in the system! -\'twander\' shows the owner and group fields for such files as numbers +\fCtwander\fP shows the owner and group fields for such files as numbers rather than names. As best as we can determine, this is caused when an RH installation is updated from an older version. @@ -4160,7 +4166,7 @@ is especially the case for older Windows operating systems like Win98. For this reason, it is recommended that you rename the ".twander" default Configuration File provided in the program distribution to -something else like "twander.conf" and use the \'twander\' -c command +something else like "twander.conf" and use the \fCtwander\fP -c command line option to point to this Configuration File. @@ -4170,7 +4176,7 @@ directory - Well, they do, but it is called "USERPROFILE" not "HOME". So, you can either create a new user-specific environment variable called HOME yourself (which points to your desired home directory) or -you can invoke \'twander\' with the -c argument to explictly declare +you can invoke \fCtwander\fP with the -c argument to explictly declare where it can find its Configuration File. You can run the program several ways on Windows systems: @@ -4199,15 +4205,15 @@ .IP \(bu 4 Use Windows Explorer (or better still, an already running instance -of \'twander\'!) to navigate to the directory where "twander.py" +of \fCtwander\fP!) 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 \'twander\' should start automatically. +and \fCtwander\fP should start automatically. -.SH GETTING HELP: THE \'twander\' MAILING LIST +.SH GETTING HELP: THE \fCtwander\fP MAILING LIST -TundraWare Inc. maintains an email list for \'twander\' +TundraWare Inc. maintains an email list for \fCtwander\fP users to get help and exchange ideas. To subscribe, send mail to: @@ -4252,7 +4258,7 @@ You Get" - Each program has a predefined set of commands and the user cannot easily extend these with their own, new commands. -\'twander\' is another approach to the filesystem navigation problem +\fCtwander\fP is another 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 @@ -4270,7 +4276,7 @@ .TP 2) -\'twander\' also supports a number of +\fCtwander\fP 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 @@ -4288,7 +4294,7 @@ 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. +without having to release a new version of \fCtwander\fP 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 @@ -4296,7 +4302,7 @@ .TP 4) -Because \'twander\' is written in Python using Tkinter, the same +Because \fCtwander\fP is written in Python using Tkinter, the same program runs essentially identically on many Unix-like and Windows systems. The only thing that may need to be changed across these various platforms are the Command Definitions in the configuration @@ -4304,7 +4310,7 @@ defined) across all the different systems you use. .P -The consequence of all this is that \'twander\' is an extremely +The consequence of all this is that \fCtwander\fP 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 @@ -4312,9 +4318,9 @@ .SH COPYRIGHT AND LICENSING -\'twander\' is Copyright(c) \*(CP TundraWare Inc. For terms of +\fCtwander\fP is Copyright(c) \*(CP TundraWare Inc. For terms of use, see the twander-license.txt file in the program distribution. If -you install \'twander\' on a FreeBSD system using the 'ports' +you install \fCtwander\fP on a FreeBSD system using the 'ports' mechanism, you will also find this file in /usr/local/share/doc/twander. @@ -4328,4 +4334,4 @@ .ft \" revert .SH DOCUMENT REVISION INFORMATION -$Id: twander.1,v 1.115 2005/02/02 10:51:16 tundra Exp $ \ No newline at end of file +$Id: twander.1,v 1.116 2005/02/02 22:38:54 tundra Exp $ \ No newline at end of file