http://www.read.cs.ucla.edu/click/ 2009-11-22T12:37:58-08:00 http://www.read.cs.ucla.edu/click/ http://www.read.cs.ucla.edu/click/lib/images/favicon.ico text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/docs/click-align?rev=1190150829 This is automatically generated documentation. adds required Align elements to a Click configuration SYNOPSIS click-align [options] [param=value ...] [router-file] DESCRIPTION The click-align tool makes Click router configurations usable on machines that don't support unaligned accesses. It reads a router configuration file in the language language, adds any required Align elements, and writes the new configuration to the standard output. <dl> <dt> </dt> <dd> Read the router configu… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/docs/click-combine?rev=1236475442 This is automatically generated documentation. combines two or more Click configurations into one SYNOPSIS click-combine [options] name=file ... \         name1.element1=name2.element2 ... DESCRIPTION The click-combine tool combines two or more Click router configurations into a single virtual configuration representing the network. Special RouterLink elements represent links between routers. For example, say there is a point-to-point link from router A's eth0 interface to rout… text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/docs/click-devirtualize?rev=1190150829 This is automatically generated documentation. removes virtual function calls from a Click configuration SYNOPSIS click-devirtualize [options] [param=value ...] [router-file] DESCRIPTION The click-devirtualize tool speeds up a Click configuration by removing virtual function calls from its elements. It reads a router configuration file in the language language and creates specialized C++ source code for each element. The virtual function calls in this specialized C++ code are replaced w… text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/docs/click-fastclassifier?rev=1190150829 This is automatically generated documentation. specializes Classifier code in a Click configuration SYNOPSIS click-fastclassifier [options] [param=value ...] [router-file] DESCRIPTION The click-fastclassifier tool speeds up a Click configuration by creating fast versions of all its Classifier, IPClassifier, and IPFilter elements. It reads a router configuration file in the language language and creates specialized C++ source code for each Classifier-like element. A Classifier is expande… text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/docs/click-flatten?rev=1190150829 This is automatically generated documentation. removes compound elements from a Click configuration SYNOPSIS click-flatten [options] [param=value ...] [router-file] DESCRIPTION The click-flatten tool flattens a Click router configuration, compiling all its compound elements away, and writes the resulting configuration to the standard output. It can also output information about the file. <dl> <dt> , </dt> <dd> Output an alphabetical list of the element classes used by the flattened rout… text/html 2009-03-07T17:24:03-08:00 http://www.read.cs.ucla.edu/click/docs/click-install?rev=1236475443 This is automatically generated documentation. installs a Click configuration into the kernel module driver SYNOPSIS click-install [options] [param=value ...] [router-file] DESCRIPTION Click-install is a convenience program that installs a Click router configuration into the current Linux kernel. It reads a router configuration file in the language language, installs the linuxmodule kernel module if necessary, compiles and/or installs any dynamically loadable packages required by the ro… text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/docs/click-mkmindriver?rev=1190150829 This is automatically generated documentation. generates a build environment for a minimal Click driver SYNOPSIS click-mkmindriver -p packagename [options] \ [param=value ...]         [router-files...] DESCRIPTION The click-mkmindriver tool generates a build environment for a minimal Click driver -- that is, a driver containing only the elements necessary to run the configurations in the router-files. You must supply a name for the driver, packagename. Running 'make MINDRIVER=p… text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/docs/click-pretty?rev=1190150829 This is automatically generated documentation. pretty-prints a Click configuration in HTML SYNOPSIS click-pretty [options, param=value ...] [routerfile] " output.html " click-pretty --dot [...] [routerfile\] > output.png DESCRIPTION The click-pretty tool pretty-prints Click configurations into HTML files, including syntax highlighting and optional indexes; or, optionally, it can output a graph definition suitable for passing to dot(1). Click-pretty reads a router configuration an… text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/docs/click-uncombine?rev=1190150829 This is automatically generated documentation. separates a component from a combined Click configuration SYNOPSIS click-uncombine [param=value ...] [options] [router-file [component]] DESCRIPTION The click-uncombine tool reads a combined router configuration created by click-combine and outputs one of its components. The chosen component is specified by its name, as originally specified to click-combine. <dl> <dt> </dt> <dd> Read the combined router configuration from . The default … text/html 2007-09-18T14:27:10-08:00 http://www.read.cs.ucla.edu/click/docs/click-undead?rev=1190150830 This is automatically generated documentation. removes dead code from a Click configuration SYNOPSIS click-undead [param=value ...] [options] [router-file] DESCRIPTION The click-undead tool speeds up some Click configurations by removing dead code. This includes: <dl> <dt> </dt> <dd> Read the router configuration to transform from . The default is the standard input.</dd> <dt> </dt> <dd> Use , a string in the Click language, as the router configuration to transform.</dd> <dt> … text/html 2007-09-18T14:27:10-08:00 http://www.read.cs.ucla.edu/click/docs/click-uninstall?rev=1190150830 This is automatically generated documentation. uninstalls the Click kernel module SYNOPSIS click-uninstall [options] DESCRIPTION Click-uninstall is a convenience program that uninstalls Click from the current Linux kernel. It uninstalls the currently running configuration, any dynamically loadable Click packages, and the linuxmodule kernel module itself. <dl> <dt> </dt> <dd> Print usage information and exit.</dd> <dt> </dt> <dd> Print the version number and some quickie warranty inform… text/html 2007-09-18T14:27:10-08:00 http://www.read.cs.ucla.edu/click/docs/click-xform?rev=1190150830 This is automatically generated documentation. pattern-based Click configuration optimizer SYNOPSIS click-xform [options] [param=value ...] [router-file [pattern-files...]] DESCRIPTION The click-xform tool is a Click router configuration optimizer. It reads files giving Click configuration patterns and their replacements, and a router configuration file. Then it replaces pattern matches in the configuration until none remain and writes the new configuration to the standard output. <dl> … text/html 2007-09-18T14:27:10-08:00 http://www.read.cs.ucla.edu/click/docs/elementdoc?rev=1190150830 This is automatically generated documentation. how to write Click element documentation DESCRIPTION Documentation for a Click element is automatically generated from formatted comments in its header files. This manual page describes how to write one of these formatted comments. <dl> <dt> </dt> <dd> SYNOPSIS</dd> <dt> </dt> <dd> NAME (one-line summary)</dd> <dt> </dt> <dd> INPUTS AND OUTPUTS</dd> <dt> </dt> <dd> PROCESSING TYPE</dd> <dt> </dt> <dd> DESCRIPTION</dd> <dt> </dt> <dd> NOTES</dd>… text/html 2007-02-04T13:47:23-08:00 http://www.read.cs.ucla.edu/click/docs/ipsec-doc?rev=1170625643 IPsec support in Click Router Click IPsec ESP Support IPsec ESP support in click router is summarized in the following processing modules: * IPsecRouteTable: This routing table can be edited from user space as a typical Click IP routing table but (optionally) Security Parameters may be entered for each route. The security parameters are the SPI, 128bit Authentication key (for HMAC), 128bit Encryption Key, Replay start counter, Replay last sequence Replay Window size. Apart from the SPI the … text/html 2009-03-07T17:24:03-08:00 http://www.read.cs.ucla.edu/click/docs/language?rev=1236475443 This is automatically generated documentation. Click configuration language DESCRIPTION The Click language describes the configuration of a Click router. It has two main directives: declarations declare new elements, and connections connect those elements together. Click router configurations are like directed graphs of elements; in this interpretation, declarations specify the vertices of the graph and connections specify the edges. Other language statements define configuration parameter… text/html 2009-03-07T17:24:04-08:00 http://www.read.cs.ucla.edu/click/docs/linuxmodule?rev=1236475444 This is automatically generated documentation. Click kernel module driver for Linux DESCRIPTION The Click modular router can be compiled as a Linux kernel module, called click.o. It can steal packets from network devices before Linux gets a chance to handle them, send packets directly to devices, and send packets to Linux for normal processing. <dl> <dt> </dt> <dd> Read/write. Contains a Click-language description (see (5) of the most recent router configuration, not including any run-time… text/html 2009-03-07T17:24:04-08:00 http://www.read.cs.ucla.edu/click/docs/testie?rev=1236475444 This is automatically generated documentation. ie succie succ.\} simple test harness SYNOPSIS testie [OPTIONS] [FILE]... DESCRIPTION Testie is a simple test harness. Each testie test file incorporates a shell script to be run and, optionally, input and expected output files for that script. Testie runs the script; the test fails if any of the script commands fail, or if the script generates unexpected output. <dl> <dt> =</dt> <dd> Provide a setting for . Occurrences in the script of ' or … text/html 2007-09-18T14:27:10-08:00 http://www.read.cs.ucla.edu/click/docs/userdriver?rev=1190150830 This is automatically generated documentation. Click user-level driver SYNOPSIS click [options] [param=value ...] [router-file] DESCRIPTION The click driver executes a Click modular router specification in a user-level program. It reads a router configuration file, sets up the router according to that file, and generally continues until interrupted. The router configuration is written in the Click language (see click(5)), and can contain dynamically loadable code, which click will link…