 |
|
+ + Mozilla Cross-Reference + + |
+ |||
|---|---|---|---|
+
+
|
+ + |
+
+ This is a cross referenced display of the
+Mozilla source code.
+The sources displayed are those that are currently checked
+in to the mainline of the mozilla.org
+CVS server;
+these pages are updated many times a day, so they should
+be pretty close to the latest- It's possible to search through the entire Mozilla source text;
+or to search for files whose name matches a pattern; or to search
+for the definitions of particular functions, variables, etc.
+
+ The individual files of the source code are formatted on the fly
+and presented with clickable identifiers. An identifier is a
+macro, typedef, struct, enum, union, function, function prototype or
+variable. Clicking on them shows you a summary of how and where they
+are used.
+
+ The free-text search command is implemented
+using Glimpse, so all the
+capabilities of Glimpse are available.
+Regular expression searches are
+especially useful.
+
+ (Don't use use a web-crawler to try and download all of these pages;
+the CGIs will feed you several gigabytes worth of generated HTML!)
+
+ The pages here are generated by the
+LXR tool, which was originally
+written to display the source code of the Linux kernel (LXR stands
+for ``Linux Cross Reference.'') Check out the
+main LXR site for more information.
+
+ Thanks to
+ Arne Georg Gleditsch and
+ Per Kristian Gjermshus, the
+ authors of the LXR tool, for writing it and making it available
+ to the world; and thanks to
+ Dawn Endico for
+ doing almost all of the work to get LXR working with the Mozilla
+ sources.
+
+ |
+ |
diff --git a/mozilla/webtools/lxr/root/search-help.html b/mozilla/webtools/lxr/root/search-help.html new file mode 100644 index 00000000000..a709f1e2737 --- /dev/null +++ b/mozilla/webtools/lxr/root/search-help.html @@ -0,0 +1,166 @@ + +
+ |
search help
+
+for the
+mozilla cross-reference
+
+
+
+
+ ++ +This text is copied from the Glimpse manual page. I have tried to remove +things that do not apply to the lxr searcher, but beware, some things might +have slipped through. I'll try to put together something better when I get +the time. For more information on glimpse go to the +Glimpse homepage. + +
Patterns
+-
+glimpse supports a large variety of patterns, including simple
+strings, strings with classes of characters, sets of strings,
+wild cards, and regular expressions (see Limitations).
+
+
Strings
+-
+
+Strings are any sequence of characters, including the special symbols
+`^' for beginning of line and `$' for end of line. The following
+special characters (`$', `^', `*', `[', `^', `|', `(', `)', `!', and
+`\' ) as well as the following meta characters special to glimpse (and
+agrep): `;', `,', `#', `>', `<', `-', and `.', should be preceded by
+`\\' if they are to be matched as regular characters. For example,
+\\^abc\\\\ corresponds to the string ^abc\\, whereas ^abc corresponds
+to the string abc at the beginning of a line.
+
+
Classes of characters
+-
+
+a list of characters inside [] (in order) corresponds to any character
+from the list. For example, [a-ho-z] is any character between a and h
+or between o and z. The symbol `^' inside [] complements the list.
+For example, [^i-n] denote any character in the character set except
+character 'i' to 'n'.
+The symbol `^' thus has two meanings, but this is consistent with
+egrep.
+The symbol `.' (don't care) stands for any symbol (except for the
+newline symbol).
+
+
Boolean operations
+-
+
+Glimpse
+supports an `AND' operation denoted by the symbol `;'
+an `OR' operation denoted by the symbol `,',
+a limited version of a 'NOT' operation (starting at version 4.0B1)
+denoted by the symbol `~',
+or any combination.
+For example, pizza;cheeseburger' will output all lines containing
+both patterns.
+'{political,computer};science' will match 'political science'
+or 'science of computers'.
+
+
Wild cards
+-
+
+The symbol '#' is used to denote a sequence
+of any number (including 0)
+of arbitrary characters (see Limitations).
+The symbol # is equivalent to .* in egrep.
+In fact, .* will work too, because it is a valid regular expression
+(see below), but unless this is part of an actual regular expression,
+# will work faster.
+(Currently glimpse is experiencing some problems with #.)
+
+
Combination of exact and approximate matching
+-
+
+Any pattern inside angle brackets <> must match the text exactly even
+if the match is with errors. For example, <mathemat>ics matches
+mathematical with one error (replacing the last s with an a), but
+mathe<matics> does not match mathematical no matter how many errors are
+allowed. (This option is buggy at the moment.)
+
+
Regular expressions
+-
+
+Since the index is word based, a regular expression must match words
+that appear in the index for glimpse to find it. Glimpse first strips
+the regular expression from all non-alphabetic characters, and
+searches the index for all remaining words. It then applies the
+regular expression matching algorithm to the files found in the index.
+For example, glimpse 'abc.*xyz' will search the index for all files
+that contain both 'abc' and 'xyz', and then search directly for
+'abc.*xyz' in those files. (If you use glimpse -w 'abc.*xyz', then
+'abcxyz' will not be found, because glimpse will think that abc and
+xyz need to be matches to whole words.) The syntax of regular
+expressions in glimpse is in general the same as that for agrep. The
+union operation `|', Kleene closure `*', and parentheses () are all
+supported. Currently '+' is not supported. Regular expressions are
+currently limited to approximately 30 characters (generally excluding
+meta characters). The maximal number of errors
+for regular expressions that use '*' or '|' is 4.
+
+
Limitations
+-
+
+The index of glimpse is word based. A pattern that contains more than
+one word cannot be found in the index. The way glimpse overcomes this
+weakness is by splitting any multi-word pattern into its set of words
+and looking for all of them in the index.
+For example, 'linear programming' will first consult the index
+to find all files containing both linear and programming,
+and then apply agrep to find the combined pattern.
+This is usually an effective solution, but it can be slow for
+cases where both words are very common, but their combination is not.
+
+
+As was mentioned in the section on Patterns above, some characters +serve as meta characters for glimpse and need to be +preceded by '\\' to search for them. The most common +examples are the characters '.' (which stands for a wild card), +and '*' (the Kleene closure). +So, "glimpse ab.de" will match abcde, but "glimpse ab\\.de" +will not, and "glimpse ab*de" will not match ab*de, but +"glimpse ab\\*de" will. +The meta character - is translated automatically to a hypen +unless it appears between [] (in which case it denotes a range of +characters). + +
+There is no size limit for simple patterns and simple patterns +within Boolean expressions. +More complicated patterns, such as regular expressions, +are currently limited to approximately 30 characters. +Lines are limited to 1024 characters. + +
+
+ + + + Arne Georg Gleditsch and Per Kristian Gjermshus + + + + diff --git a/mozilla/webtools/lxr/source b/mozilla/webtools/lxr/source index 601201f5608..17e5334dd86 100755 --- a/mozilla/webtools/lxr/source +++ b/mozilla/webtools/lxr/source @@ -1,5 +1,5 @@ #!/usr/bonsaitools/bin/perl -# $Id: source,v 1.12 1999-01-21 00:42:23 endico%mozilla.org Exp $ +# $Id: source,v 1.13 1999-03-10 22:58:50 endico%mozilla.org Exp $ # source -- Present sourcecode as html, complete with references # # Arne Georg Gleditsch