diff --git a/twander.1 b/twander.1 index 66538d6..e682181 100644 --- a/twander.1 +++ b/twander.1 @@ -22,6 +22,7 @@ .SH SYNOPSIS twander [-cdhqrstv] [startdir] + .SH OPTIONS .TP .B startdir @@ -186,6 +187,7 @@ is also very simple to change the default key assignments with entries in the Configuration File, also described below. + .SH NOTES ON KEYBOARD ARROW/KEYPAD BEHAVIOR AND TEXT DIALOG EDITS Generally, the arrow and keypad keys should do what you would expect @@ -252,8 +254,7 @@ .B mouse button assignments cannot be changed by the user, even in the Configuration File. - -.SS GENERAL PROGRAM COMMANDS +.SS General Program Commands This family of commands controls the operation of \'twander\' itself. @@ -391,8 +392,7 @@ as a means to temporarily disable the advanced features when viewing such a directory. - -.SS DIRECTORY NAVIGATION +.SS Directory Navigation This family of commands controls movement between directories. If at any point, you attempt to navigate into a directory that does not exist or which @@ -465,8 +465,7 @@ Move to the parent of the current directory (".."). - -.SS SELECTION KEYS +.SS Selection Keys This family of commands controls the selection of one or more (or no) items in the current directory. @@ -534,7 +533,7 @@ (non-adjacent) item is then selected by holding down the "Control" key when clicking on the item. -.SS SCROLLING COMMANDS +.SS Scrolling Commands If a given directory's contents cannot be displayed on a single screen, \'twander\' supports both vertical and horizontal scrolling @@ -564,8 +563,7 @@ Scroll to the left one page width. - -.SS COMMAND EXECUTION OPTIONS +.SS Command Execution Options This family of commands causes \'twander\' to actually attempt to execute some command you've chosen: @@ -658,7 +656,7 @@ command to be run. If no command is associated with a given keystroke, nothing will happen when it is pressed. -.SS PROGRAM MEMORIES +.SS Program Memories If you've used GUIs before, you're probably familiar with the idea of a program "Clipboard" - a temporary holding area which is used when @@ -675,19 +673,40 @@ 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". At any point while using the program, you -can -.B append -the fully qualified path names of your currently selected items -to any one of these 12 Program Memories. This is done using the -MEMSET1-MEMSET12 keys (default: Alt-F1 through Alt-F12). You -can also selectively -.B clear -any of these memories with the CLRMEM1-CLRMEM12 keys (default: -Control-F1 through Control-F12) or you can clear them -.B all -with the MEMCLRALL key (default: Control-m). +\'twander\' addresses these concerns by means of 12 separate "Program +Memories". As you use \'twander\', 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 +(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] +Built-In Variables. (See the section below on Built-In Variables for +more details in how to apply Program Memories). + +\'twander\' 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: + +.TP +.B Clear Selected Program Memory (MEMCLR1 - MEMCLR12) +Control-F1...Control-F12 + +Clear (empty) the selected Program Memory. + +.TP +.B Clear All Program Memories (MEMCLRALL) +Control-m + +Clear (empty) all 12 Program Memories at once. + +.TP +.B Set Selected Program Memory (MEMSET1 - MEMSET12) +Alt-F1...Alt-F12 + +Append the names of the currently selected files and directories to +the Program Memory desired. More specifically, append +.B the full pathname +of each selected directory or path to that Program Memory. .SH MENU OPTIONS @@ -854,7 +873,6 @@ doing so with no commands defined. - .SH LOCATION OF CONFIGURATION FILE By default, the program expects to find configuration information in @@ -919,7 +937,6 @@ The following sections describe each of the valid Configuration File entires in more detail. - .SS Comments A comment is begun with the "#" string which may be placed anywhere on a @@ -939,7 +956,6 @@ .B Variables And Command Definitions, for a more complete description. - .SS Program Option Statements Many of \'twander\'s internal program defaults can be overriden in the @@ -957,7 +973,6 @@ "AUTOREFRESH" as a program option, but will treat "AutoRefresh" as a User-Defined Variable. - .SS Key Binding Statements No program that runs in many operating environments can satisfy @@ -1061,19 +1076,34 @@ spectacularly. At the very least, that program feature will probably be unusable, even if \'twander\' manages to run. - .SS Directory Shortcut Statements .SS Variables And Command Definitions -\'twander\' provides a fairly simple but powerful -macro language. This language is how you "program" -the interface and equip it with commands of your -own choosing. Command Definitions are built -out of literal text and may also have any combination -of three variable types: User-Defined Variables, +Most programs "ship from the factory" with a pre-defined +set of features or commands. \'twander\' 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 +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\' +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 +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 +it is very fast and convenient. + +Command Definitions are built out of literal text and may also have +any combination of three variable types: User-Defined Variables, Environment Variables, and Built-In Variables. .SS User-Defined Variables And Environment Variables @@ -1318,7 +1348,6 @@ m MyMore xterm -l -e more somefile .fi - .SS User-Defined Variables In A Command String The last example works quite nicely. But, we're probably going to end up @@ -1337,7 +1366,6 @@ m MyMore [XTERM] more somefile # And the command then uses it .fi - .SS Environment Variables In A Command String This is all very nice, but we'd really like a command to be generic @@ -1500,7 +1528,7 @@ be used in a Command Definition: .IP \(bu 4 -.B [MEM1] - [MEM12] +.B [MEM1]...[MEM12] Return the file/directory names currently stored in the indicated memory. For example, to move all the files/directories currently named in @@ -1754,7 +1782,6 @@ enabled in \'twander\' - .SH GOTCHAS There are several tricky corners of \'twander\' which need @@ -1858,7 +1885,6 @@ process spawning when a command is run. This mechanism correctly destroys the window upon command completion. - .SH OTHER File/Directory name sorting is done without-case sensitivity on @@ -1964,7 +1990,6 @@ names. As best as we can determine, this is caused when an RH installation is updated from an older version. - .SS Installing Manually On A Win32 System Copy the "twander.py" file to a directory somewhere on your path, or