diff --git a/twander.1 b/twander.1 index 9cd0883..af22b44 100644 --- a/twander.1 +++ b/twander.1 @@ -501,30 +501,18 @@ .SS Comments -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). +A comment is begun with the "#" string which may begin anywhere on a +line. Comments may appear freely within a configuration file. +\'twander\' strictly ignores everything from the "#" to the end of the +line on which it appears without exception. This means that "#" +cannot occur anywhere in a User-Defined Variable Definition, Key +Binding Statement, or Command Definition (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. +It is conceivable that the "#" character might be needed in the +Command String portion of a Command Definition. \'twander\' +provides a builtin variable, [HASH], for exactly this purpose. +See the section on Builtin Variables below for a more complete +description. .SS User-Defined Variables @@ -849,6 +837,17 @@ items currently selected in the GUI. .IP \(bu 4 +.B [HASH] + +Because \'twander\' always recognizes the "#" as the beginning +of a comment, there is no direct way to include this character +in a Command String. It is conveivable that some commands (such +as \'sed\') need to make use of this character. The [HASH] +builtin is provided for this purpose. Anywhere it appears in +the Command String, it will be replaced with the "#" at command +execution time. + +.IP \(bu 4 .B [SELECTION] [SELECTION] is replaced with the name of the currently