diff --git a/twander.1 b/twander.1 index 809ce01..5f58e56 100644 --- a/twander.1 +++ b/twander.1 @@ -827,6 +827,26 @@ their output can been seen in a GUI window. This is particularly handy on Unix. +As with command definitions in a configuration file, you can +tell \*(TW 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, + +.nf ++mycommand +.fi + +\*(TW 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. + +This feature may be used in combination with CMDSHELL escaping +(also described in the +.B Program Option Statements +section below) and the two characters may appear in any order at +the beginning of the command line you enter. + .TP .B Run Selected File / Move To Selected Directory (SELKEY and MOUSESEL) @@ -1378,6 +1398,18 @@ .fi .TP +.B AFTERWAIT [Numeric] (1) + +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 \*(TW 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. + + +.TP .B AUTOREFRESH [Boolean] (True) By default, \*(TW regularly re-reads the current directory to @@ -2420,6 +2452,39 @@ m MyMore xterm -l -e more somefile .fi + +.SS Forcing Display Updates In Command Definitions + +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 \*(TW 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 +\*(TW 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, + +.nf +r removelogs +rm -f *log +.fi + +This means that when the \'r\' key is pressed, the command, +"rm -f *.log" is run, and then, AFTERWAIT seconds later, \*(TW +will force a display update. This happens regardless of the +current AUTOREFRESH settings. + +This feature is handy, but has some practical limitations. If this +feature updates the display before a command actually completes (i.e., +the command you've launched takes longer than AFTERWAIT seconds to +complete), the final state of the directory will not be displayed. +The idea here is to use this feature for "quicky" updates between more +conventional display refreshes, whether via AUTOREFRESH or manually. + + .SS User-Defined Variables In A Command String The last example works quite nicely. But, we're probably going to end up