| Installing the LXR source-code browser is relatively easy for an experienced Linux user. Problems or suggestions for improvement can be published in a mailing list. The following components are required to install the LXR source-code browser: The LXR package with the scripts to generate the source-code index and the HTML pages. The version currently most stable is lxr-0.3. It can be downloaded from http://lxr.sourceforge.org. Figure A-4. Information stored for the C structure packet_type. 
A Web server that can work with CGI (Common Gateway Interface) scripts. We recommend the Apache Web server (http://www.apache.org). Perl is required to run the scripts. Mainly, the possibilities of regular expressions in Perl are used for the functionality of the LXR source-code browser. Glimpse can be used to extend the functionality of the LXR source-code browser. It allows you to search the entire source code of the Linux kernel for full-text search. This is useful mainly when one is searching for certain source-code identifiers the LXR parser was unable to identify. In addition, when you are searching for full text, Glimpse lets you display the corresponding lines of the source code, thereby simplifying and accelerating your search. A Web browser (e.g., Mozilla, Netscape, Konqueror) is needed for navigation through the pages generated by LXR. Finally, you need the source code of the Linux kernel. Notice that you can index several kernel versions or source texts of other programs concurrently.
Once you have installed the LXR scripts by the attached Makefile (read the INSTALL instruction included in the package), you first have to edit the configuration file lxr.conf. This file stores most settings of the LXR source-code browser. You also find details about the configuration of lxr.conf in the INSTALL instruction, included in the LXR package. Subsequently, you have to create the source-code index for various kernel versions or other software projects. To create such an index, you use the Perl script genrefx, which is very time-consuming. Finally, you have to configure the Web server so that it recognizes and executes the Perl scripts in the directory $(LXR-INSTALL)/http. Experience has shown that this is the most delicate point in the LXR installation. Please also consult the literature for the Web server you use. Naturally, readers who don't want to bother with the installation of the LXR source-code browser can easily access the pages of Oslo University at http://lxr.linux.no. |
