diff --git a/twander.1 b/twander.1 index e682181..ad6d300 100644 --- a/twander.1 +++ b/twander.1 @@ -359,10 +359,17 @@ Re-read the Configuration File. This allows you to edit the Configuration File while \'twander\' is running and then read your changes in without having to exit the program. This is handy when -editing or changing Command Definitions. However, if you edit the -Configuration File and introduce an error, \'twander\' will terminate -when you try to re-read it (just as it will if you try to start the -program with a bad Configuration File). +editing or changing Command Definitions. + + +Program Options are set back to their default each time a +Configuration File is about to be read (initially or on reload) just +before the Configuration File is parsed. This means commenting out or +removing a Program Option Statement (see relevant section below) in +the Configuration File and then pressing READCONF causes that option to +be reset to its default value. STARTDIR defaults to either its +internal default ($HOME or ./) or to the value given in the +Environment Variable/Command line. .TP .B Refresh Display (REFRESH) @@ -465,6 +472,22 @@ Move to the parent of the current directory (".."). +.TP +.B Display Drive List View (DRIVELIST) +.PD 000 +Control-k +.PD + +This is a Win32-only feature which displays a list of all available +disk drives. Details about each drive are also displayed if you have +details enabled. In order for this feature to work, you must be +running on Win32 AND have the \'win32all\' package installed, AND the +USEWIN32ALL program option must be True (default condition,) AND you +must not have toggled these features off with the TOGWIN32ALL key +described above. For more details about Drive List View, see the +section below entitled, +.B ADVANCED WIN32 FEATURES. + .SS Selection Keys This family of commands controls the selection of one or more (or no) @@ -656,6 +679,24 @@ command to be run. If no command is associated with a given keystroke, nothing will happen when it is pressed. +.SS Directory Shortcuts + +\'twander\' 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: + +.TP +.B Navigate Directly To A Directory (KDIRSC1...KDIRSC12) +.PD 000 +F1...F12 +.PD + +Pressing one of these keys changes to the directory associated with it +in the Configuration File. For more information on this topic, see +the discussion of the Configuration File below entitled, +.B Directory Shortcut Statements. + .SS Program Memories If you've used GUIs before, you're probably familiar with the idea @@ -1078,7 +1119,62 @@ .SS Directory Shortcut Statements +\'twander\' 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 +associate one of these keys with a particular directory path. +These statements are in the form: +.nf +DIRSCxx = path + + where, xx is a number from 1-12 +.nf + +So, for example, if you want to enter "C:\\Documents And Settings" +when you press the F5 key, you would add this to your Configuration +File: + +.nf +DIRSC5 = c:\\Documents And Settings +.fi + +There are several subtleties to Directory Shortcuts you should +understand: + +.IP \(bu 4 +You can end the path with slash or not - \'twander\' +will understand the entry either way. + +.IP \(bu 4 +All defined Directory Shortcut paths are also automatically +inserted into the Directory Menu at program startup (or +Configuration File reload) whether or not you've actually +visited those directories. The assumption is that you +will be visiting these directories a lot (which is why +you've defined shortcuts to them), so \'twander\' also +makes them available in the directory "history" for easy +access. + +.IP \(bu 4 +\'twander\' 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 +shortcut. + +.IP \(bu 4 +Keep the Program Function Names (KDIRSC1...KDIRSC12) which +are used for Key Binding, distinct in your thinking from +the Directory Shortcut Names (DIRSC1...DIRSC12) which are +used for defining the shortcuts. + +.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 +described below. .SS Variables And Command Definitions @@ -1787,7 +1883,36 @@ There are several tricky corners of \'twander\' which need further explanation: -.B \'twander\' Will Not Enter Certain Directories On Win32 +.B Program Starts Very Slowly + +\'twander\' attempts to determine the name of the host on which it is +running at program startup. This is used in the title bar 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\' +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 +in your environment - this will prevent the socket call from ever +taking place. A simple way to do this with \'ksh\' or \'bash\' is: + +.nf +export HOSTNAME=`hostname` +.nf + +(Note the backticks used to execute the \'hostname\' program +and assign its results to HOSTNAME.) + +Be aware that \'bash\' claims to set this variable when it +starts, but it does not appear to export it properly. Programs +started from \'bash\' do not see HOSTNAME set, so you have +to do this manually as just described even when using \'bash\' + +On Win32, environment variables are set via the System Properties +menu. + +.B Cannot Enter Certain Directories On Win32 Win32 allows file/directory names to contain non-ASCII characters. Python, as shipped, defaults to ASCII only