00001 /** 00002 @mainpage 00003 00004 @section c_intro_sec Introduction 00005 00006 00007 00008 @section c_install_sec Building and Installation 00009 00010 @subsection starting Getting Started 00011 00012 For general instructions about how to install CCNx, please refer to 00013 the top-level README file. 00014 00015 @subsection howitworks How the c build works 00016 00017 The C build sticks as closely as possible to the common subset 00018 of make(1) features, using the Posix specifications as a guide. 00019 00020 Since most (or all) make implementations have their own extensions, staying 00021 within this subset is a continual challenge. The CCNx build is tested with 00022 GNU make, BSD make, and Solaris make. 00023 00024 The ./configure script's main job is to build the conf.mk file that defines the 00025 configurable make macros. This is done largely just by using the 00026 output of the uname command, but scripted configuration is possible as well. 00027 The csrc/conf/ directory contains the system-specific make fragments and scripts. 00028 00029 If you need to override the configured values, put them into a file 00030 named csrc/conf/local.mk before you execute ./configure in csrc/. 00031 00032 For convenience, there is a Makefile link placed into the subdirectories of 00033 csrc/ so that you can easily rebuild just part of the world. 00034 00035 @subsection installing The test and install targets 00036 00037 After a successful make, you should do `make test` to check that things are 00038 working. Then, if you wish, you can use `make install` to install into 00039 /usr/local (or elsewhere if you have defined an override in local.mk). 00040 Of course, the appropriate permissions are needed. 00041 00042 */ 00043 00044 /* 00045 This file is processed by doxygen to create the main page for 00046 the Content-Centric Networking in C Documentation. 00047 00048 If we want to refer to the directory ccn/csrc/cmd, with a link to the documentation for the 00049 directory under that text, we would use (at)link cmd ccn/csrc/cmd (at)endlink (like this) 00050 @link cmd ccn/csrc/cmd @endlink 00051 as the reference. Note that the single word following the (at)link command is the object 00052 reference for the directory as doxygen believes it is named (see the Directories tab in the generated documentation) 00053 */