diff --git a/twander.1 b/twander.1 index 3094b76..4f8279d 100644 --- a/twander.1 +++ b/twander.1 @@ -7,7 +7,14 @@ .SH OVERVIEW Wander around a filesystem executing commands of your choice on -selected files and directories. If you're new to \'twander\' and want +selected files and directories. The general idea here is +that \'twander\' 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 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 @@ -203,7 +210,7 @@ do nothing, or do strange things, look into your key maps, don't blame \'twander\'. -There are several features of \'twander\' than will present the user a +There are several features of \'twander\' 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). @@ -295,7 +302,7 @@ This can also cause some parts of the display to change but not others. Suppose you are running on X-Windows and have specified that -the main display is use a 12 point font, and that menus and help +the main display is to use a 12 point font, and that menus and help should use 10 point font. Let's also suppose that the next font 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 @@ -625,11 +632,14 @@ .fi \'twander\' understands the variable reference syntax here just as it -does in a Command Definition. This is also real handy so you don't -have to remember the exact syntax for environment variables (and how -it differs) across Unix and Win32. Assuming the EDITOR environment -variable is set, for example, this command works the same on both -systems: +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 Win32 it is in the form "%NAME%". Instead if having +to keep track of this difference, you can just use a \'twander\' +Environment Variable reference. For instance, assuming the EDITOR +environment variable is set, this command works the same +on both systems: .nf [$EDITOR] [SELECTIONS] @@ -786,13 +796,12 @@ locations on the screen simultaneously. On Win32 systems, if a menu gets too long to physically fit on screen, -up- and down- scrolling arrows automatically appear at the top- -and bottom of the menu respectively. This is not a feature of the -Unix Tk implementation, so menus which grow too large are simply -truncated to fit the screen on Unix-like systems. As described in -the following paragraphs, \'twander\' provides some options to -limit the size of the Directory and History menus especially, for this -reason. +up- and down- scrolling arrows automatically appear at the top- and +bottom of the menu respectively. This is not a feature of the Unix Tk +implementation, so menus which grow too large are simply truncated to +fit the screen on Unix-like systems. As described in the following +paragraphs, \'twander\' provides some options to limit the size of the +Directory and History menus for this reason. .SS Commands Menu (Alt-c) [Right-Mouse-Button] @@ -889,7 +898,7 @@ in such a way so as to be useful across many different directories and contexts. Running such a command again is simply a matter of pressing its associated letter key once more. By storing the resolved version -of the command in the History, you can see what such a command +of the command in the History, you can see what the command actually did.) @@ -984,7 +993,7 @@ terminate, but the program continues to run after a warning. For the most part, \'twander\' 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 both true +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\'. @@ -994,8 +1003,8 @@ .SS Comments -A comment is begun with the "#" string which may be placed anywhere on a -line. Comments may appear freely within a Configuration File. +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 line on which it appears without exception. This means that "#" cannot occur anywhere within a User-Defined Variable Definition, Key @@ -1039,7 +1048,7 @@ they are displayed as 0 (False) and 1 (True). A Numeric Option must be a number 0 or greater. Numbers can -also be entered in hexadecimal format: 0x#, where # is the +also be entered in hexadecimal format: 0xNNN, where NNN is the numeric expression in hex. A String Option can be any string of characters but the empty string @@ -1103,7 +1112,7 @@ well. So, it's common to see Command Definitions like: .nf -x MyCommand xterm -l -e bash -c stuff-for-my-command +x MyCommand xterm -l -e bash -c 'stuff-for-my-command' .fi In fact, on Unix, the need for this idiom is so common, it's best @@ -1120,7 +1129,7 @@ Now the Command Definition above becomes: .nf -x MyCommand [VSHELL] stuff-for-my-command +x MyCommand [VSHELL] 'stuff-for-my-command' .fi That's all well and good for Command Definitions, but what happens @@ -1429,7 +1438,7 @@ .B STARTDIR [String] (Directory In Which Program Started) This allows you to force a starting directory of your choice no matter -where the program actually is launched. This is useful both for +where the program actually is launched. This is useful for day-to-day operation - perhaps you always want to start in your home directory. STARTDIR is also handy in tandem with the NODETAILS and NONAVIGATE options to force a user to the only directory which they @@ -1465,7 +1474,7 @@ .TP .B USEWIN32ALL [Boolean] (True) -Win32 only. If \'win32all\ is installed, determines whether its +Win32 only. If \'win32all\' is installed, determines whether its features should be used (see section below entitled, .B ADVANCED WIN32 FEATURES for details). @@ -1527,15 +1536,14 @@ your preferred configuration... .IP \(bu 4 -The colors, weights, and sizes available for your use will vary +The font colors, weights, and sizes available for your use will vary somewhat by system. For instance, Win32 TrueType fonts are effectively available in every size and weight. On the other hand, most Unix-like systems have a more limited palette of fonts and colors -with which to work. Most systems should support obvious color -names like, red, white, blue, yellow, beige, and so on. Many also -support colors like lightgreen, lightblue, etc. At a minimum, -you should be able to use normal, bold, italic, and underline -for font weights. +with which to work. Most systems should support obvious color names +like, red, white, blue, yellow, beige, and so on. Many also support +colors like lightgreen, lightblue, etc. At a minimum, you should be +able to use normal, bold, italic, and underline for font weights. Most systems attempt some kind of "best fit" font matching. If you specify a font size/weight/name that does not exist, the system @@ -2293,7 +2301,7 @@ This should not generally be a problem with the various Unix shells, and may work for some Win32 commands. However, some -Win32 programs (noted on \'notepad\') reject this kind of +Win32 programs (noted in \'notepad\') reject this kind of file name when passed on the command line. The workaround (and a generally easier way to do this sort of thing), is to use the [DSELECTION] built-in which returns the full path name of