Changeset 5868

Timestamp:

11/28/07 16:28:15 (6 years ago)

Author:

jgaeddert

Message:

using lstlistings for code snippets

Location:

documentation/ossie/user-guide-0.6.2

Files:

• UserGuide.tex (modified) (27 diffs)
• fancybox.sty (deleted)

documentation/ossie/user-guide-0.6.2/UserGuide.tex

@@ -13 +13 @@
 \usepackage{url}
 \usepackage{listings}
-\usepackage{fancybox}
 % due to magic hacks, hyperref must be right before document begin
 \usepackage[pdftex]{hyperref}
@@ -29 +28 @@
 \definecolor{MyCommentColor}{rgb}{0.1,0.4,0.1}
 \definecolor{MyCodeBackgroundColor}{rgb}{0.95,0.95,0.95}
+%\definecolor{MyCodeFrameRuleColor}{rgb}{0.9,0.9,0.9}
 \definecolor{MyStringColor}{rgb}{0.6,0.1,0.1}
 \definecolor{MyKeywordColor}{rgb}{0.6,0.1,0.1}
@@ -44 +44 @@
     %showstringspaces=false,     % no special string spaces
     backgroundcolor=\color{MyCodeBackgroundColor},
+    frame=none,
+    %framerule=0.5pt,
+    %framexleftmargin=2pt,
+    %framexrightmargin=2pt,
+    %framexbottommargin=2pt,
+    %framextopmargin=2pt,
+    %rulecolor=\color{MyCodeFrameRuleColor},
+    nolol=true,     % suppress listoflistings entry
     tabsize=4,
-    xleftmargin=10pt,
-    xrightmargin=10pt,
-    caption=\lstname
+    linewidth=\linewidth,
+    breaklines=false,
+    xleftmargin=6pt,
+    xrightmargin=6pt
 }
 
@@ -57 +66 @@
 
 \tableofcontents
+\lstlistoflistings
 
 \section{Quick Start Guide}
@@ -95 +105 @@
 Tools$\rightarrow$Terminal. The first thing that needs to be started is the
 naming service. Type as root:
-\begin{LVerbatim}
-# omniNames.sh
-\end{LVerbatim}
+\begin{lstlisting}[]
+ # omniNames.sh
+\end{lstlisting}
 
 %[USE INITSCRIPT!]
@@ -110 +120 @@
 The next service that needs to be started is the Node Booter. Open a new tab or
 a completely new terminal and type:
-\begin{LVerbatim}
+\begin{lstlisting}[]
 $ cd /sdr/
 $ nodeBooter -D -d nodes/default_GPP_node/DeviceManager.dcd.xml
-\end{LVerbatim}
+\end{lstlisting}
 
 The terminal should look like the following screen shot:
@@ -125 +135 @@
 
 Now load the waveform using wavLoader. In a third tab or terminal, type in:
-\begin{LVerbatim}
+\begin{lstlisting}[]
 $ cd /sdr/waveforms/ossie_demo
 $ wavLoader.py ossie_demo_DAS.xml
-\end{LVerbatim}
+\end{lstlisting}
 
 The terminal should look similar to this:%Figure ~\ref{screen:wavLoader}
@@ -141 +151 @@
 Now select the QPSK demonstration waveform,
 //waveforms/ossie\_demo/ossie\_demo.sad.xml:
-\begin{LVerbatim}
+\begin{lstlisting}[]
 $ 1
-\end{LVerbatim}
+\end{lstlisting}
 
 The tab or terminal window in which nodeBooter was started will now contain the
 output of the demo. The lines will update with output similar to this:
-\begin{LVerbatim}
+\begin{lstlisting}[]
 RxDemo errors:  X  / 1024
-\end{LVerbatim}
+\end{lstlisting}
 
 Where X denotes the number of bit errors out of 1024 that have been detected
@@ -206 +216 @@
 brackets with the appropriate information.
 
-\begin{LVerbatim}
-subscribe <list name (ossie-discuss or ossie-dev)>  <your first name>  <your last name> 
-\end{LVerbatim}
+\begin{lstlisting}[]
+subscribe <list name>  <your first name>  <your last name> 
+\end{lstlisting}
 
 To send a message to all subscribers to the list, simply send it to
@@ -242 +252 @@
 \section{Installation}
 \label{section:installation}
-
 Two methods of installation are currently available: VMware
 image and a source tarball. We are working on packages for the Yum
@@ -255 +264 @@
 method preference.
 
+\subsection{Notes on Linux Installation}
+\label{section:installation:notesonlinux}
+This section on installation assumes that the user is familiar with basic
+Linux commands such as {\tt cd} and {\tt ls}.
+Commands run with root permissions are prefixed with {\tt \#}, while others
+are prefixed with {\tt \$}.
+Additionally this guide assumes that the target system has basic development
+tools necessary for compiling sources.
+
 \subsection{Dependencies}
 \label{section:installation:dependencies}
@@ -263 +281 @@
 \label{section:installation:dependencies:xerces}
 This is a C++ XML parser.  The framework uses this package to interpret the XML files that define your resources and waveforms (among other things).
-\begin{LVerbatim}
-# yum install xerces-c-devel
-\end{LVerbatim}
+\begin{lstlisting}[]
+ # yum install xerces-c-devel
+\end{lstlisting}
 
 \subsubsection{omniORB}
 \label{section:installation:dependencies:omniorb}
 This package handles most of the CORBA implementation for your system.
-\begin{LVerbatim}
-# rpmbuild --rebuild \
+\begin{lstlisting}[]
+ # rpmbuild --rebuild \
     http://www.fourpalms.org/pub/omniORB/SRPMS/omniORB-4.1.0-1.src.rpm
-# cd /usr/src/redhat/RPMS/i386
-# rpm -Uhv omniORB-4.1.0-1.i386.rpm
-# rpm -Uhv omniORB-devel-4.1.0-1.i386.rpm
-# rpm -Uhv omniORB-utils-4.1.0-1.i386.rpm
-# rpm -Uhv omniORB-servers-4.1.0-1.i386.rpm
-# rpm -Uhv omniORB-bootscripts-4.1.0-1.i386.rpm
-\end{LVerbatim}
+ # cd /usr/src/redhat/RPMS/i386
+ # rpm -Uhv omniORB-4.1.0-1.i386.rpm
+ # rpm -Uhv omniORB-devel-4.1.0-1.i386.rpm
+ # rpm -Uhv omniORB-utils-4.1.0-1.i386.rpm
+ # rpm -Uhv omniORB-servers-4.1.0-1.i386.rpm
+ # rpm -Uhv omniORB-bootscripts-4.1.0-1.i386.rpm
+\end{lstlisting}
 
 Configure omniORB:
-\begin{LVerbatim}
-# vim /etc/omniORB.cfg
-\end{LVerbatim}
+\begin{lstlisting}[]
+ # vim /etc/omniORB.cfg
+\end{lstlisting}
 Around line 313 you should see
-\begin{LVerbatim}
-InitRef = NameService=corbaname::my.host.name
-\end{LVerbatim}
+\begin{lstlisting}[]
+ InitRef = NameService=corbaname::my.host.name
+\end{lstlisting}
 Uncomment the line and change to
-\begin{LVerbatim}
-InitRef = NameService=corbaname::localhost
-\end{LVerbatim}
+\begin{lstlisting}[]
+ InitRef = NameService=corbaname::localhost
+\end{lstlisting}
 
 
@@ -299 +317 @@
 This package provides a Python interface for omniORB.  It is used for both the
 Python tools (OWD, ALF, wavLoader.py) and Python components.
-\begin{LVerbatim}
-# rpmbuild --rebuild \
-    http://www.fourpalms.org/pub/omniORB/SRPMS/omniORBpy-3.0-1.src.rpm
-# cd /usr/src/redhat/RPMS/i386
-# rpm -Uhv omniORBpy-3.0-1.i386.rpm
-# rpm -Uhv --force omniORBpy-standard-3.0-1.i386.rpm
-# rpm -Uhv omniORBpy-devel-3.0-1.i386.rpm
-\end{LVerbatim}
+\begin{lstlisting}[]
+ # rpmbuild --rebuild \
+     http://www.fourpalms.org/pub/omniORB/SRPMS/omniORBpy-3.0-1.src.rpm
+ # cd /usr/src/redhat/RPMS/i386
+ # rpm -Uhv omniORBpy-3.0-1.i386.rpm
+ # rpm -Uhv --force omniORBpy-standard-3.0-1.i386.rpm
+ # rpm -Uhv omniORBpy-devel-3.0-1.i386.rpm
+\end{lstlisting}
 
 \subsubsection{wxPython}
@@ -313 +331 @@
 well as many graphical Python components, utilize the wxPython package to
 create their graphical user interfaces.
-\begin{LVerbatim}
-# yum install wxPython-devel
-\end{LVerbatim}
+\begin{lstlisting}[]
+ # yum install wxPython-devel
+\end{lstlisting}
 
 \subsubsection{numpy}
@@ -321 +339 @@
 numpy is a python numerical library that the tools use.  This is only
 necessary for running the tools.
-\begin{LVerbatim}
-# yum install numpy
-\end{LVerbatim}
+\begin{lstlisting}[]
+ # yum install numpy
+\end{lstlisting}
 
 At this time you will need to restart your machine.
@@ -341 +359 @@
 As root, edit the 'sudoers' file\footnote{By default the sudoers file must be
 edited with the {\tt visudo} command}
-\begin{LVerbatim}
-# /usr/sbin/visudo
-\end{LVerbatim}
+\begin{lstlisting}[]
+ # /usr/sbin/visudo
+\end{lstlisting}
 
 At the end of the file, add the following line:
-\begin{LVerbatim}
-ALL ALL = NOPASSWD: /usr/bin/make install
-\end{LVerbatim}
+\begin{lstlisting}[]
+ ALL ALL = NOPASSWD: /usr/bin/make install
+\end{lstlisting}
 
 Save and quit ({\tt :wq}).  If you made an error, visudo will tell you.
@@ -357 +375 @@
 run source from this directory without root permissions you need to create and
 change ownership of {\tt /sdr}.
-\begin{LVerbatim}
-# mkdir /sdr
-# chown -R username.username /sdr
-\end{LVerbatim}
+\begin{lstlisting}[]
+ # mkdir /sdr
+ # chown -R username.username /sdr
+\end{lstlisting}
 where {\tt username} is your user name.
 
@@ -367 +385 @@
 The included {\tt build.py} script automates installation of the OSSIE
 packages.
-Because OSSIE is built as a set of independent libraries it is
-necessary to build and install each one separately.
+Because OSSIE is built as a set of dependent libraries it is
+necessary to build and install each one separately and individually so that
+they can link properly.
 
 To run the script, navigate to the {\tt ossie-0.6.2} directory and run
-\begin{LVerbatim}
-$ python build.py
-\end{LVerbatim}
+\begin{lstlisting}[]
+ $ python build.py
+\end{lstlisting}
 If successful the prompt should say something like ``Complete installation
 successful.''
@@ -387 +406 @@
 /usr/local/lib/python2.X/site-packages} to your {\tt ossie.pth} file (where X
 corresponds to the specific version of Python installed on your system)}
-\begin{LVerbatim}
-/sdr/tools
-\end{LVerbatim}
-
+%
+\begin{lstlisting}[caption={{\tt ossie.pth} file}, nolol=false]
+ /sdr/tools
+\end{lstlisting}
+%
 Once the file is created, it needs to be moved to the {\tt site-packages}
 Python subdirectory.
-\begin{LVerbatim}
-# mv ossie.pth /usr/lib/python2.X/site-packages
-\end{LVerbatim}
+\begin{lstlisting}[]
+ # mv ossie.pth /usr/lib/python2.X/site-packages
+\end{lstlisting}
 where X corresponds to the specific version of Python installed on your
 system.
@@ -405 +425 @@
 Once the OSSIE libraries are installed, they need to be linked.
 As root edit the file {\tt /etc/ld.so.conf} and add the line
-\begin{LVerbatim}
-/usr/local/lib
-\end{LVerbatim}
+\begin{lstlisting}[]
+ /usr/local/lib
+\end{lstlisting}
 Now run
-\begin{LVerbatim}
-# /sbin/ldconfig
-\end{LVerbatim}
+\begin{lstlisting}[]
+ # /sbin/ldconfig
+\end{lstlisting}
 
 \subsection{Using a VMware Image on Any Platform}
@@ -439 +459 @@
 % To access the ebuilds, install and configure layman if you haven't already:
 % \begin{figure}
-% \begin{LVerbatim}
+% \begin{lstlisting}[]
 % # emerge layman
 % # echo "source /usr/portage/local/layman/make.conf" >> /etc/make.conf
-% \end{LVerbatim}
+% \end{lstlisting}
 % \end{figure}
 % 
 % Then, add ossie-overlay to your locally-stored overlays:
 % \begin{figure}
-% \begin{LVerbatim}
+% \begin{lstlisting}[]
 % # layman -a -o https://ossie.wireless.vt.edu/repos/ossie/experimental/scripts/gentoo/ossie-overlay.xml
-% \end{LVerbatim}
+% \end{lstlisting}
 % \end{figure}
 % 
 % You can then proceed with installing OSSIE:
 % \begin{figure}
-% \begin{LVerbatim}
+% \begin{lstlisting}[]
 % # emerge -av ossie
-% \end{LVerbatim}
+% \end{lstlisting}
 % \end{figure}
 % 
@@ -486 +506 @@
 
 \begin{figure}
-\begin{LVerbatim}
-$ cd /sdr/tools/WaveDev/wavedev
-$ python wd.py
-\end{LVerbatim}
+\begin{lstlisting}[]
+ $ cd /sdr/tools/WaveDev/wavedev
+ $ python wd.py
+\end{lstlisting}
 \caption{Starting OWD}
 \label{code:start_owd}
@@ -509 +529 @@
 To start the stand-alone component builder, run {\tt ComponentFrame.py} from
 within the wavedev directory:
-\begin{LVerbatim}
-$ cd /sdr/tools/WaveDev/wavedev/
-$ python ComponentFrame.py
-\end{LVerbatim}
+\begin{lstlisting}[]
+ $ cd /sdr/tools/WaveDev/wavedev/
+ $ python ComponentFrame.py
+\end{lstlisting}
 
 Generating a new component automatically adds it to your waveforms layout, but
@@ -590 +610 @@
 /home/mydir/src/components}). Four commands must be executed (in order) in
 order to install the component to the {\tt /sdr} directory:
-\begin{LVerbatim}
-$ ./reconf
-$ ./configure
-$ make
-$ make install #\(may require root permissions\)
-\end{LVerbatim}
+\begin{lstlisting}[]
+ $ ./reconf
+ $ ./configure
+ $ make
+ $ make install #\(may require root permissions\)
+\end{lstlisting}
 
 In this version, OWD must be restarted for the installed component to appear in
@@ -620 +640 @@
 
 In one tab or terminal:
-\begin{LVerbatim}
-$ nodeBooter -D -d nodes/default_GPP_node/DeviceManager.dcd.xml
-\end{LVerbatim}
+\begin{lstlisting}[]
+ $ nodeBooter -D -d nodes/default_GPP_node/DeviceManager.dcd.xml
+\end{lstlisting}
 
 (Where {\tt default\_GPP\_node} can change if your waveform requires)
@@ -628 +648 @@
 Once nodeBooter is started, open a second tab or terminal,
 navigate to the {\tt alf} directory, and start ALF:
-\begin{LVerbatim}
-$ cd /sdr/tools/alf
-$ python ALF.py
-\end{LVerbatim}
+\begin{lstlisting}[]
+ $ cd /sdr/tools/alf
+ $ python ALF.py
+\end{lstlisting}
 
 On the left hand side of the ALF display you will see a list of available
@@ -717 +737 @@
 \addappheadtotoc
 
-\section{Creating omniNames.sh}
-
-Create a file called omniNames.sh and put the following in it:
-\begin{lstlisting}[frame=single, framerule=0pt, caption={omniNames.sh},
-nolol=true, frame=single]
-$!/bin/sh
-
-killall omniNames
-rm /sdr/logs/omninames*
-
-omniNames -start -logdir /sdr/logs &
+\section{Creating {\tt omniNames.sh}}
+Installing omniORB from rpms automatically starts the naming service when the
+system boots.
+If omniORB was {\it not} installed using rpms, the naming service will
+probably need to be started manually.
+To do so, create a file called {\tt omniNames.sh} containing the following
+\begin{lstlisting}[caption={{\tt omniNames.sh} file}, nolol=false]
+ $!/bin/sh
+ 
+ killall omniNames
+ rm /sdr/logs/omninames*
+ 
+ omniNames -start -logdir /sdr/logs &
 \end{lstlisting}
 
 Once this file is created, the file must be given executable permissions:
-\begin{LVerbatim}
-$ chmod 755 omniNames.sh
-\end{LVerbatim}
-
-To run the omniNames.sh script, navigate to wherever the file is located and type "./omniNames.sh" into the terminal.
-
-\section{Configuring the USRP}
-The universal software radio peripheral (USRP) is produced by Ettus Research
-LLC and is supported by OSSIE. Daughterboards for the USRP are available for a
-variety of bands. Information on the USRP is available at
-\href{http://www.ettus.com}{http://www.ettus.com}.
-
-\subsection{Firmware Installation}
-First, install the SDCC (small device C compiler). Download the 2.6.0 source
-tarball from \\
-\href{http://sdcc.sourceforge.net/} \\
-and execute the following commands:
-\begin{LVerbatim}
-$ tar -xvf sdcc-src-2.6.0.tar.gz
-$ cd sdcc-src-2.6.0
-$ ./configure
-$ make
-# make install
-\end{LVerbatim}
-
-Now install the USRP source. Download \\
-\href{ftp://ftp.gnu.org/gnu/gnuradio/gnuradio-3.1.1.tar.gz} \\ and execute the
-following commands:
-\begin{LVerbatim}
-$ tar -xvf gnuradio-3.1.1.tar.gz
-$ cd gnuradio-3.1.1
-$ ./configure
-$ cd usrp
-$ make
-# make install
-\end{LVerbatim}
-
-For sound card support, you should also have the Advanced Linux Sound
-Architecture (ALSA) libraries installed on you system. ALSA can be added with
-the package manager for your distribution or can be found at:
-\href{http://www.alsa-project.org/}{http://www.alsa-project.org/}. You'll need
-the standard libraries and development libraries.
-
-\begin{LVerbatim}
-$ cd <path to USRP>
-$ ./reconf (skip this step if you are using tarballs)
-$ ./configure
-$ make
-$ su ­-c "make install"
-$ cd <path to USRP_Ctrl>
-$ ./reconf (skip this step if you are using tarballs)
-$ ./configure
-$ make
-$ su ­-c "make install"
-$ cd <path to Sound_Out>
-$ ./reconf (skip this step if you are using tarballs)
-$ ./configure
-$ make
-$ su ­-c "make install"
-$ cd <path to FM_Demodulator>
-$ ./reconf (skip this step if you are using tarballs)
-$ ./configure
-$ make
-$ su ­-c "make install"
-$ cd <path to am_demod>
-$ ./reconf (skip this step if you are using tarballs)
-$ ./configure
-$ make
-$ su ­-c "make install"
-$ cd <path to Decimator>
-$ ./reconf (skip this step if you are using tarballs)
-$ ./configure
-$ make
-$ su ­-c "make install"
-\end{LVerbatim}
-
-\subsection{USRP Permissions}
-To be able to run a waveform that uses the USRP you will either need to have
-root permissions or give access to your user to use the USRP. The process for
-each distribution is different but for Fedora 7, define a group named usrp and
-add yourself to the group.
-(as root)
-\begin{LVerbatim}
-# /usr/sbin/groupadd usrp
-# /usr/sbin/usermod -a usrp [username]
-\end{LVerbatim}
-
-or, if your copy of usermod does not support this syntax try:
-\begin{LVerbatim}
-# /usr/sbin/usermod -G usrp -a [username]
-\end{LVerbatim}
-
-Create a file named /etc/udev/rules.d/10­usrp.rules with the following
-contents, and be sure to include the : in {\tt MODE:="0660"} otherwise the
-default usb\_device rule will override MODE to "0640". This also applies to
-the GROUP setting.
-
-\begin{figure}
-\begin{LVerbatim}
-# rule to grant read/write access on USRP to group named usrp.
-# to use, install this file in /etc/udev/rules.d as 10-usrp.rules
-ACTION=="add", BUS=="usb", SYSFS{idVendor}=="fffe", SYSFS{idProduct}=="0002",
-GROUP:="usrp", MODE:="0660"
-\end{LVerbatim}
-\end{figure}
-
-Restart the udev daemon to enable the changes. 
-\begin{LVerbatim}
-$ sudo killall -HUP udevd
-\end{LVerbatim}
-
-You can check if this is working by examining /dev/bus/usb after plugging in a USRP:
-\begin{LVerbatim}
-$ ls -lR /dev/bus/usb
-\end{LVerbatim}
-
-You should see a device file with group usrp and mode crw­rw­­­­.
+\begin{lstlisting}[]
+ $ chmod 755 omniNames.sh
+ # cp omniNames.sh /usr/local/bin
+\end{lstlisting}
+
+Create a directory for the logs:
+\begin{lstlisting}[]
+ $ mkdir /sdr/logs
+\end{lstlisting}
+
+The script can now be run by executing {\tt omniNames.sh} in any terminal.
+You can check to see if {\tt omniNames} is running by executing
+\begin{lstlisting}[]
+ $ ps ax | grep omniNames
+\end{lstlisting}
 
 %\section{Known Bugs}