diff --git a/twander.1 b/twander.1 index dd5bb9c..32659db 100644 --- a/twander.1 +++ b/twander.1 @@ -210,7 +210,7 @@ until after the Configuration File has been processed. So, the -q argument on the command line will not inhibit warnings generated during the reading of the Configuration File. This is best done by -adding the statement, WARN=False, at the top of the Configuration +adding the statement, \fCWARN=False\fP, at the top of the Configuration File. If the Configuration File is reloaded while the program is running @@ -510,7 +510,7 @@ Re-read the current directory's contents and display it. This is most useful if you have turned off automatic directory refreshing with either the -r command -line flag or setting the AUTOREFRESH Program Option to False. +line flag or setting the AUTOREFRESH Program Option to \fCFalse\fP. .TP .B Toggle Autorefreshing (TOGAUTO) @@ -637,7 +637,7 @@ 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 Windows AND have the \'win32all\' package installed, AND the -USEWIN32ALL Program Option must be True (default condition,) AND you +USEWIN32ALL Program Option must be \fCTrue\fP (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, @@ -1709,8 +1709,8 @@ The Option Value is checked to make sure it conforms to the proper type for this variable. The Type can be Boolean, Numeric, or String. -A Boolean Option must be assigned a value of True or False. These -logical values can be in any case, so TRUE, TRue, and tRue all work. +A Boolean Option must be assigned a value of \fCTrue\fP or \fCFalse\fP. These +logical values can be in any case, so \fCTRUE\fP, \fCTRue\fP, and \fCtRue\fP all work. A Numeric Option must be a number 0 or greater. Numbers can also be entered in hexadecimal format: 0xNNN, where NNN is the @@ -1783,7 +1783,7 @@ the display from getting cluttered with the longer strings required to display the actual lengths in bytes. If you want the program to display the actual lengths for these items by default, set -ACTUALLENGTH=True in your Configuration File. You can also "toggle" +\fCACTUALLENGTH=True\fP in your Configuration File. You can also "toggle" between normalized and actual size display with the TOGLENGTH key (default: Control-0). @@ -1809,7 +1809,7 @@ set by default or set in the Configuration File. Think of this as the "base" value for REFRESHINT. -If ADAPTREFRESH is set to False, then adaptive refresh timing is +If ADAPTREFRESH is set to \fCFalse\fP, then adaptive refresh timing is disabled and a directory refresh will be attempted every REFRESHINT milliseconds. @@ -1825,7 +1825,7 @@ (otherwise, why bother with the update?), and the current selections may no longer be relevant. -Setting AFTERCLEAR to False, will leave the current selections alone +Setting AFTERCLEAR to \fCFalse\fP, will leave the current selections alone after doing a command with a forced update. @@ -1847,7 +1847,7 @@ 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 +client, set this option to \fCFalse\fP. You can manually force an update at any time using the REFRESH key. (default: Control-l) @@ -2047,7 +2047,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, \fCtwander\fP will +If you set FORCEUNIXPATH to \fCTrue\fP, \fCtwander\fP will .B always use the Unix path separator character("/") in these substitutions. @@ -2111,7 +2111,7 @@ .TP .B ISODATE [Boolean] (False) -Set this to "True" to display file/directory date and time in ISO 8601 +Set this to \fCTrue\fP to display file/directory date and time in ISO 8601 format instead of the default US localized format. .TP @@ -2272,7 +2272,7 @@ .B REFRESHINT [Numeric] (5000) Nominal time in milliseconds between automatic directory -refreshes (if AUTOREFRESH is True). This time is +refreshes (if AUTOREFRESH is \fCTrue\fP). This time is .B really nominal and should not be used with any accurate timing in mind. REFRESHINT=8000 says that the refresh @@ -2291,6 +2291,18 @@ display. .TP +.B RESOLVSYMLINKS [Boolean] (False) + +\fCtwander\fP ordinarily displays symbolic link targets as they were +defined. That is, targets that were defined relative to the current +(or some other) directory, or targets that point to other symbolic +links will not be "expanded" to show their complete path. Instead, +the path as defined when the symbolic link was created will be shown. +Setting \fCRESOLVSYMLINKS\fP to \fCTrue\fP will cause the absolute path of +symbolic link targets to be displayed. + + +.TP .B SORTBYFIELD [String] (Name) Specifies which field is to be used as the sort key. May be one of @@ -2323,8 +2335,8 @@ .TP .B SORTREVERSE [Boolean] (False) -Specifies whether to reverse the sort order or not. If True and -SORTSEPARATE is also True, then the directory list will appear at the +Specifies whether to reverse the sort order or not. If \fCTrue\fP and +SORTSEPARATE is also \fCTrue\fP, then the directory list will appear at the .B end of the display in addition to being reverse ordered. @@ -2364,7 +2376,7 @@ This option causes symbolic links that point to directories to be treated as directories for purposes of sorting. This is relevant when "separated" sorting is selected - i.e., When the directories are -sorted separately from files. If SYMDIR is set to False, then +sorted separately from files. If SYMDIR is set to \fCFalse\fP, then symbolic links will be sorted as files, regardless of what the link points to. @@ -2375,10 +2387,10 @@ \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 \fCtwander\fP to use threads, rather than +to \fCTrue\fP 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 +this option defaults to \fCFalse\fP). These are discussed in the .B GOTCHAS section below. @@ -2398,7 +2410,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 \fCtwander\fP, set this option to False. +want it used by \fCtwander\fP, set this option to \fCFalse\fP. The main reason to do this would be on a slow machine with very large directories. The advanced features of \'win32all\' come at a @@ -2407,7 +2419,7 @@ hundreds (or more) of entries. Typically, you would just use the TOGWIN32ALL key (default: Control-w) to temporarily disable these features before entering such a directory. However, if your starting -directory is in this category, setting USEWIN32ALL=False might not +directory is in this category, setting \fCUSEWIN32ALL=False\fP might not be a bad idea. .TP @@ -2417,17 +2429,17 @@ 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 +Setting this option to \fCFalse\fP is the same thing as using the -q command line option with one important difference: The Configuration File is parsed before the command line is parsed. Even if you have -q on the command line (or in the TWANDER environment variable), if there is an error in your Configuration File, you will see warning messages -at program startup time. Putting WARN=False at the +at program startup time. Putting \fCWARN=False\fP at the top of your Configuration File will suppress this. It is not recommended that you operate normally with the --q flag or with WARN=False. \fCtwander\fP is pretty +-q flag or with \fCWARN=False\fP. \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. @@ -2441,7 +2453,7 @@ .B WILDNOCASE [Boolean] (True On Win32 / False Elsewhere) Set's whether or not case is significant in wildcard filtering and -selection. If True, case is ignored, if False, case is significant in +selection. If \fCTrue\fP, case is ignored, if \fCFalse\fP, case is significant in these wildcard operations. @@ -3237,7 +3249,7 @@ presumably is required because the command changes something in the current directory. In that case, the current selections may no longer be relevant. If you wish to disable this behavior, set the AFTERCLEAR -program option to False. +program option to \fCFalse\fP. .SS User-Defined Variables In A Command String @@ -4027,7 +4039,7 @@ The general idea is to define a "Condition Block" which begins by doing a logical test. If that test evaluates to True, all statements in the block are included in the current configuration. If the test -evaluates to False, all statements to the end of the block are +evaluates to \fCFalse\fP, all statements to the end of the block are ignored. A Conditional Block always begins with a "Condition Test Statement" @@ -4375,7 +4387,7 @@ .SS Disabling \'win32all\' Features You can toggle these features on-and off using the TOGWIN32ALL key. (default: Control-w) You can also permanently disable them by -setting the USEWIN32ALL option to False in the Configuration File. +setting the USEWIN32ALL option to \fCFalse\fP 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 \fCtwander\fP @@ -4690,8 +4702,8 @@ FreeBSD) do not correctly destroy an \'xterm\' window after a command 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. +if you set \fCUSETHREADS=True\fP. The workaround is to use the default +\fCUSETHREADS=False\fP setting. .SS Program Behavior Incorrect When A Window Is Resized @@ -4700,7 +4712,7 @@ seems to not be properly informed that the window size has changed. This seems to be an interaction caused by running such programs as threads rather than processes. Once again, the workaround here is -to not change the USETHREADS=False default setting. +to not change the \fCUSETHREADS=False\fP default setting. .SS Really Slow Response Times When Changing To A New Directory @@ -4770,7 +4782,7 @@ .P If you don't like this adaptive refresh interval business, set -the ADAPTREFRESH program option to False. In that case, +the ADAPTREFRESH program option to \fCFalse\fP. In that case, REFRESHINT will be strictly observed. @@ -5243,4 +5255,4 @@ .ft \" revert .SH DOCUMENT REVISION INFORMATION -$Id: twander.1,v 1.148 2007/01/08 08:28:36 tundra Exp $ +$Id: twander.1,v 1.149 2007/01/08 18:36:33 tundra Exp $