======Makefile======

=====Make Arguments=====
<label>sub:Make-Parameters</label>
<texit>\index{Make}</texit>
Whenever you are in a sub-directory of the software-radio, you can
give some arguments to the //make// command. There are arguments
that may be used everywhere in the tree, some that are only valid
in the //Radios/*// subdirectories and some arguments that are
only valid in the subdirectories that contain code.

====Common====
These arguments may be used anywhere in the tree (except the //Tools//-directory):
<ldl>
<texit>\index{Make!clean}</texit><ldt>clean</ldt><ldd>Remove all object-files in all sub-trees <texit>\index{Make!whole}</texit></ldd>
<ldt>whole</ldt><ldd>Re-compile the whole tree <texit>\index{Make!base}</texit></ldd>
<ldt>base</ldt><ldd>Re-compile base only <texit>\index{Make!tools}</texit></ldd>
<ldt>tools</ldt><ldd>Re-compile tools only <texit>\index{Make!modules}</texit></ldd>
<ldt>modules</ldt><ldd>Re-compile modules only, additionally //mod_coding//, //mod_data//, //mod_general//, //mod_macro//, //mod_signal// re-compile only this special modules-directory <texit>\index{Make!show}</texit></ldd>
<ldt>show</ldt><ldd>Starts the visualisation-tool <texit>\index{Make!server}</texit></ldd>
<ldt>server</ldt><ldd>Start the channel-server <texit>\index{Make!kill}</texit></ldd>
<ldt>kill</ldt><ldd>End all simulations as well as the channel-server <texit>\index{Make!cleanproc}</texit></ldd>
<ldt>cleanproc</ldt><ldd>Remove all simulation-directories from ///tmp// <texit>\index{Make!rmall}</texit></ldd>
<ldt>rmall</ldt><ldd>Unloads all real-time modules and stops RTLinux <texit>\index{Make!cvs_up}</texit></ldd>
<ldt>cvs_up</ldt><ldd>Updates the //whole// SRadio/*-tree using CVS <texit>\index{Make!cvs_commit}</texit></ldd>
<ldt>cvs_commit</ldt><ldd>Commits //all// changes to the SRadio/*-tree</ldd>
</ldl>

====Radios====
Arguments that can be used in the subdirectories of //Radios///
<ldl>
<texit>\index{Make!bsms}</texit><ldt>bsms</ldt><ldd>Starts channel-server and both BS and MS part. To stop, run //make kill// <texit>\index{Make!show_bsms}</texit></ldd>
<ldt>show_bsms</ldt><ldd>Like //bsms//, but also runs the visualisation-tool <texit>\index{Make!wait_bsms}</texit></ldd>
<ldt>wait_bsms</ldt><ldd>Like //bsms//, but stops the MS after 20 seconds and the BS after 30 seconds. Most useful to check whether a radio exits nicely, before trying it in real-time <texit>\index{Make!short_wait_bsms}</texit></ldd>
<ldt>short_wait_bsms</ldt><ldd>Like //wait_bsms// but for the impatient: BS waits for 10 seconds, MS for 5 seconds. Attention: things might not be correctly initialised after 5 seconds! <texit>\index{Make!mc}</texit></ldd>
<ldt>mc</ldt><ldd>Starts channel-server and both Server and Client part. To stop, run //make kill// <texit>\index{Make!show_mc}</texit></ldd>
<ldt>show_mc</ldt><ldd>Like //mc//, but also runs the visualisation-tool <texit>\index{Make!wait_mc}</texit></ldd>
<ldt>wait_mc</ldt><ldd>Like //mc//, but stops the Client after 20 seconds and the Server after 30 seconds. Most useful to check whether a radio exits nicely, before trying it in real-time <texit>\index{Make!short_wait_mc}</texit></ldd>
<ldt>short_wait_mc</ldt><ldd>Like //wait_mc// but for the impatient: Server waits for 10 seconds, Client for 5 seconds. Attention: things might not be correctly initialised after 5 seconds!</ldd>
</ldl>

====Code====
Useful arguments when you are developing code
<ldl>
<texit>\index{Make!user}</texit><ldt>user</ldt><ldd>Loads the modules defined in the Makefile for simulation and unloads them <texit>\index{Make!user_show}</texit></ldd>
<ldt>user_show</ldt><ldd>Like //user//, but also starts the visualisation-tool <texit>\index{Make!user_wait}</texit></ldd>
<ldt>user_wait</ldt><ldd>Like //user//, but doesn't unload the modules <texit>\index{Make!user_wait_5}</texit></ldd>
<ldt>user_wait_5</ldt><ldd>Like //user//, but waits for 5 seconds before unloading <texit>\index{Make!user_wait_10}</texit></ldd>
<ldt>user_wait_10</ldt><ldd>waits for 10 seconds before unloading <texit>\index{Make!user_wait_20}</texit></ldd>
<ldt>user_wait_20</ldt><ldd>waits for 20 seconds before unloading <texit>\index{Make!user_wait_30}</texit></ldd>
<ldt>user_wait_30</ldt><ldd>waits for 30 seconds before unloading <texit>\index{Make!user_wait_60}</texit></ldd>
<ldt>user_wait_60</ldt><ldd>waits for 60 seconds before unloading <texit>\index{Make!ddd}</texit></ldd>
<ldt>ddd</ldt><ldd>Start the graphical debugger in simulation-mode <texit>\index{Make!debug}</texit></ldd>
<ldt>debug</ldt><ldd>Start gdb in simulation-mode <texit>\index{Make!rf}</texit></ldd>
<ldt>rf</ldt><ldd>Starts the radio in real-time mode <texit>\index{Make!rf_tail}</texit></ldd>
<ldt>rf_tail</ldt><ldd>Like //rf// but also tails ///var/log/messages// where //PR_DBGs// will be written to <texit>\index{Make!rf_show}</texit></ldd>
<ldt>rf_show</ldt><ldd>Like //rf_tail// but launches the visualisation-tool <texit>\index{Make!rmall}</texit></ldd>
<ldt>rmall</ldt><ldd>Unloads all modules from real-time mode</ldd>
</ldl>