diff --git a/twander.1 b/twander.1 index f43056c..9cd0883 100644 --- a/twander.1 +++ b/twander.1 @@ -501,11 +501,30 @@ .SS Comments -A comment is begun with the "//" string which may exist anywhere on -the line. \'twander\' strictly ignores everything from the "//" to the -end of that line without exception. This means that "//" cannot -occur anywhere in a User-Defined Variable, Key Binding Statement, or -Command Definition. +A comment is begun with the "#" string which may exist anywhere on the +line. In most cases, \'twander\' strictly ignores everything from the +"#" to the end of that line without exception. This means that "#" +cannot occur anywhere in a User-Defined Variable or Key Binding +Statement (these are described below). + +However, it is entirely possible that the "#" character may +be needed somewhere in a Command Definition statement (described +below). To provide maximum flexibility in this regard, \'twander\' +ignores the presence of the "#" character in either the Command +Name or Command String portions of a Command Definition. Under +no circumstances, however, can the Command Key be "#". Lines +in the general form: + +.nf +# something something ... +.fi + +are always understood by \'twander\' to be comments. + +The main consequence of this is that +.B a comment may never be placed at the end of a Command Definition line. +This is because \'twander\' has no way of determining where the +definition (Command String) ends and where the comment begins. .SS User-Defined Variables @@ -542,10 +561,13 @@ references are permitted. .IP \(bu 4 +The "#" character cannot be used in either the variable name +or the replacement string since doing so begins a comment. + +.IP \(bu 4 The "=" is what separates the Variable Name from the replacement string. Therefore, the "=" cannot ever be part of a Variable -Name. Neither can "//", as described previously. Finally, -a Variable Name cannot begin with "$" (see next bullet). +Name. A Variable Name cannot begin with "$" (see next bullet). Other than these minor restrictions, both Variable Names and Replacement Characters can be any string of characters of any length. @@ -650,7 +672,7 @@ actually use it. You edit your configuration file and add: .nf -foo = [BAD-VBL] // Illegal! BAD-VBL is not defined anywhere +foo = [BAD-VBL] # Illegal! BAD-VBL is not defined anywhere bar = x[foo] .fi @@ -699,16 +721,16 @@ that command. Command Keys must be unique within a given configuration file. \'twander\' will declare an error and refuse to run if it sees two Command Definitions with the same Command Key in a -given configuration file. +given configuration file. A described previously, the Command Key can +never be "#". -The "Command Name" is a string of any length containing any -character (except the "//" string). This is the name of the -command which is used to invoke the command from the Command Menu. -Command Names are case-sensitive ("command" and "Command" are different -names), but they are not required to be unique within a given configuration -file. That is, two different Command Definitions may have identical -Command Names associated with them, though this is not ordinarily -recommended. +The "Command Name" is a string of any length containing any +characters. This is the name of the command which is used to invoke +the command from the Command Menu. Command Names are case-sensitive +("command" and "Command" are different names), but they are not +required to be unique within a given configuration file. That is, two +different Command Definitions may have identical Command Names +associated with them, though this is not ordinarily recommended. The "Command String" is any arbitarary string which is what \'twander\' actually tries to execute when the command is invoked. @@ -716,7 +738,7 @@ In its simplest form, a Command Definition looks like this: .nf -// A simple Command Definition +# A simple Command Definition m MyMore more somefile .fi @@ -733,7 +755,7 @@ this: .nf -// Our command setup to run as a GUI window +# Our command setup to run as a GUI window m MyMore xterm -l -e more somefile .fi @@ -748,11 +770,11 @@ like this: .nf -// Our command enhanced with a User-Defined Variable. -// Remember that the variable has to be defined *before* -// it is referenced. -XTERM = xterm -l -e // This defines the variable -m MyMore [XTERM] more somefile // And the command then uses it +# Our command enhanced with a User-Defined Variable. +# Remember that the variable has to be defined *before* +# it is referenced. +XTERM = xterm -l -e # This defines the variable +m MyMore [XTERM] more somefile # And the command then uses it .fi @@ -767,8 +789,8 @@ previously. Now our command looks like this: .nf -// Our command using both a User-Defined Variable and -// an Environment Variable to make it more general +# Our command using both a User-Defined Variable and +# an Environment Variable to make it more general XTERM = xterm -l -e m MyMore [XTERM] [$PAGER] somefile .fi @@ -791,8 +813,8 @@ .nf -// Our command in its most generic form using -// User-Defined, Environment, and Builtin Variables +# Our command in its most generic form using +# User-Defined, Environment, and Builtin Variables XTERM = xterm -l -e m MyMore [XTERM] [$PAGER] [DSELECTION] .fi @@ -856,15 +878,15 @@ command: .nf -// Copy a group of items to a location set by -// the user at runtime +# Copy a group of items to a location set by +# the user at runtime UnixCopy = cp -R Win32Copy = copy -// Unix Version +# Unix Version c UnixCP [UnixCopy] [DSELECTIONS] [PROMPT:Enter Destination] -// Win32 Version +# Win32 Version C Win32CP [UnixCopy] [DSELECTIONS] [PROMPT:Enter Destination] .fi