Changeset 5931

Timestamp:

12/05/07 12:50:41 (5 years ago)

Author:

jgaeddert

Message:

breaking up guide into separate files

Location:

documentation/ossie/user-guide-0.6.2

Files:

• HelpingWithDevelopment.tex (added)
• Introduction.tex (added)
• RunningWaveforms.tex (added)
• Troubleshooting.tex (added)
• UserGuide.tex (modified) (4 diffs)

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

@@ -126 +126 @@
 \pagenumbering{arabic}
 
-% ------------------------------------------------------------------
-%
-%             SECTION: Quick Start Guide
-%
-% ------------------------------------------------------------------
+% ------------------- Quick Start Guide -------------------
+\newpage
 \input{QuickStartGuide}
 
-
-% ------------------------------------------------------------------
-%
-%             SECTION: Introduction
-%
-% ------------------------------------------------------------------
-\section{Introduction}
-\label{section:introduction}
-
-\subsection{About this Guide}
-\label{section:introduction:about}
-This user guide is meant to be a comprehensive introductory and reference source
-for users of the \href{http://www.mprg.org}{MPRG}'s OSSIE (Open Source SCA
-Implementation Embedded) framework and tools, as well as serve as a useful
-information source for developers. The aim of the OSSIE project is to provide
-an open source framework for testing the behaviour of SDR waveforms and
-platforms. This software can help achieve a better understanding of software-defined
-radio and its trade-offs for educational and commercial purposes. In this guide,
-we attempt to assume only general computer knowledge and explain how things
-work along the way. Additionally, this guide is an evolving document.
-If you have any suggestions for improving it, please submit them to Trac (see
-Section~\ref{section:trac}) or \href{mailto:cov@vt.edu}{email the maintainer} directly.
-
-\subsection{Further Help}
-\label{section:introduction:help}
-This section describes several ways to obtain help and further information. The
-online wiki, the Trac bugtracking tickets, the mailing lists and the IRC
-channel are available in moments of breakage, confusion, and inspiration.
-
-\subsubsection{Wiki}
-\label{section:wiki}
-A wiki is a collaborative website tool. It allows many users to work together
-to write and edit information. Our wiki contains news, documentation
-and other information. You can visit it at \\
-\href{http://ossie.wireless.vt.edu/trac/wiki}{http://ossie.wireless.vt.edu/trac/wiki}.
-
-\subsubsection{Mailing Lists}
-\label{section:mailinglists}
-We maintain two public mailing lists for OSSIE. {\em ossie-discuss} is for
-general discussion and help. {\em ossie-dev} is meant for more technical
-discussion and development-related traffic. Both lists can be subscribed to by sending a
-message to \href{mailto:listserv@listserv.vt.edu}{listserv@listserv.vt.edu}
-with the following in the message body, replacing the information in angle
-brackets with the appropriate information.
-
-\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
-\href{mailto:ossie-discuss@listserv.vt.edu}{ossie-discuss@listserv.vt.edu} or
-\href{mailto:ossie-dev@listserv.vt.edu}{ossie-dev@listserv.vt.edu}.
-
-\subsubsection{Trac Bugtracking System}
-\label{section:trac}
-The Trac software provides a web-based interface to our bug-tracking database.
-Bugtrackers are often good places to search for known problems and
-work-arounds. Reporting previously unreported bugs is also exremely helpful
-to the developers, allowing users to inform them of problems not encountered
-during testing. You will need to register for an account on the website and
-login before being allowed to submit new bugs. Visit 
-\href{http://ossie.wireless.vt.edu/trac/newticket}{http://ossie.wireless.vt.edu/trac/newticket} 
-to initiate the bug-reporting process. Please be sure to tag the bug with
-version 0.6.2. We will strive to squash all bugs as soon as possible and
-incorporate usability and feature improvement suggestions into an appropriate
-future release.
-
-\subsubsection{\#ossie IRC Channel}
-\label{section:irc}
-For those interested in real-time communication, an IRC channel is great. The
-developers are not online all the time but the IRC channel also allows
-users to help solve one anothers' problems. Our channel, \#ossie, is on the
-freenode network \href{http://freenode.net}{(http://freenode.net)}. To visit it, fire up your favorite
-irc client, login to the freenode servers and join the \#ossie channel. If you
-have never used IRC before, irchelp.org's
-\href{http://www.irchelp.org/irchelp/irctutorial.html}{IRC Tutorial} is a good
-starting point.
-
-% ------------------------------------------------------------------
-%
-%             SECTION: Installation
-%
-% ------------------------------------------------------------------
+% ------------------- Introduction -------------------
+\newpage
+\input{Introduction}
+
+% ------------------- Installation Guide -------------------
+\newpage
 \input{Installation}
 
-% ------------------------------------------------------------------
-%
-%             SECTION: Running Waveforms
-%
-% ------------------------------------------------------------------
-\section{Running Waveforms}
-\label{section:runningwaveforms}
-
-\subsection{Start the naming service}
-If you installed omniORB using {\tt rpm} and
-have since restarted your machine chances are the naming service is running.
-If not, you will need to run {\tt omniNames.sh} (see
-Appendix~\ref{appendix:omninamessh}).
-
-\subsection{Run nodeBooter}
-Open a new terminal and execute the following
-\begin{lstlisting}[]
- $ cd /sdr
- $ nodeBooter -D -d nodes/default_GPP_node/DeviceManager.dcd.xml
-\end{lstlisting}
-It is important that {\tt nodeBooter} be run from the {\tt /sdr} directory.
-
-\subsection{Load a waveform}
-The 0.6.2 release supports two options for loading a waveform
-\begin{enumerate}
-\item Using the Python command-line {\tt wavLoader.py} script (discussed
-below)
-\item Using the Python graphical tool ALF (see Section~\ref{section:alf})
-\end{enumerate}
-
-Load the waveform using wavLoader. In a new terminal execute
-\begin{lstlisting}[]
- $ cd /sdr/waveforms/MyWaveform
- $ wavLoader.py MyWaveform_DAS.xml
-\end{lstlisting}
-
-One or more SAD files (ending in {\tt .sad.xml}) will be listed.  To load the
-waveform, enter the number that corresponds to {\tt MyWaveform.sad.xml}.  If
-this file is listed twice, choose the first listing ({\tt
-//MyWaveform.sad.xml}).
-
-Finally, enter {\tt s} to start the waveform.
-
-
-% ------------------------------------------------------------------
-%
-%             SECTION: OSSIE Waveform Developer
-%
-% ------------------------------------------------------------------
+% ------------------- Running Waveforms -------------------
+\newpage
+\input{RunningWaveforms}
+
+% ------------------- OWD Guide -------------------
+\newpage
 \include{OWDGuide}
 
-
-% ------------------------------------------------------------------
-%
-%             SECTION: ALF Graphical Debugging Environment
-%
-% ------------------------------------------------------------------
+% ------------------- ALF Guide -------------------
+\newpage
 \include{ALFGuide}
 
-
-% ------------------------------------------------------------------
-%
-%             SECTION: Helping with Development
-%
-% ------------------------------------------------------------------
-\section{Helping with Development}
-OSSIE is an open source project and we encourage all interested to contribute
-to the project.
-
-\subsection{Giving Feedback and Submitting Bugs}
-The ossie-discuss mailing list and the \#ossie IRC channel on Freenode are
-apt mediums for discussing user-end problems and solutions. For more
-technical discussions, Trac tickets and the ossie-dev mailing list are best.
-See Section ~\ref{section:irc} for more information on the IRC channel and
-Section ~\ref{section:mailinglists} for details on the mailing lists.
-
-\subsection{Making Contributions}
-For those interested in making substantial contributions, SVN access is
-available. The best way to get to know the developers and really get involved 
-is to help by fixing bugs or adding features. Other work such as
-writing documentation is also appreciated.
-
-In order to make sure OSSIE stays open, we have licensed the
-source code under GNU's General Public License Version 2 and the Lesser
-General Public License. Contributions to the project must be made under these
-licenses. Also, the preferred coding style is that devised for the Linux
-kernel~\cite{linuxkernelcodingstyle:web}.
-See~\cite{gnugpl:web, gnuglpl:web} for more information about the
-licenses.
-
-% ------------------------------------------------------------------
-%
-%             SECTION: Troubleshooting
-%
-% ------------------------------------------------------------------
-\section{Troubleshooting}
-\label{section:troubleshooting}
-This section includes several common problems encountered when installing and
-running OSSIE. It is by no means complete.
-If you cannot find your problem here, please feel free to contact the team
-(refer to Section~\ref{section:introduction:help})
-
-\subsection{nodeBooter throws exception}
-\label{section:troubleshooting:nodebooter1}
-When I try to start {\tt nodeBooter} I get this mess:
-\begin{lstlisting}[]
- $ nodeBooter -D -d nodes/default_GPP_node/DeviceManager.dcd.xml
- NB: Starting Domain Manager
- Fatal: An exception occurred! Type:RuntimeException, Message:The primary
-   document entity could not be opened.
- Id=/home/ossieuser/domain/DomainManager.dmd.xml
- PublicId :
- SystemId :
- Line number : 0
- Column number : 0
- terminate called after throwing an instance of 'int'
- Aborted
-\end{lstlisting}
-{\bf Solution: } You need to run {\tt nodeBooter} from the {\tt /sdr} directory.
-
-\subsection{nodeBooter throws instance of `CORBA::TRANSIENT'}
-\label{section:troubleshooting:nodebooter2}
-When I try to start {\tt nodeBooter} I get this mess:
-\begin{lstlisting}[]
- $ nodeBooter -D -d nodes/default_GPP_node/DeviceManager.dcd.xml
- Failed to resolve NameService: TRANSIENT
- terminate called after throwing an instance of 'CORBA::TRANSIENT'
- Aborted
-\end{lstlisting}
-{\bf Solution: } You need to start the naming service.  If you installed
-omniORB from rpms (see Section~\ref{section:installation:dependencies:omniorb})
-{\tt omniNames} will start automatically when you restart your machine.
-You can manually start the {\tt omniNames} by creating and running the shell
-script described in Appendix~\ref{appendix:omninamessh}.
-
-\subsection{OWD Component Editor does not allow me to select the device}
-\label{section:troubleshooting:owdselectdevice}
-I am trying to edit a component to assign it to a device.  I have selected the
-{\tt default\_XXX\_node} under ``Waveform Deployment Settings'' but nothing
-exists under the ``Device'' spinbox.
-
-{\bf Solution: } This is a bug in OWD.  You have probably not actually
-selected {\tt default\_XXX\_node} even though it is visible on the screen.
-Click on the ``Node'' spinbox again and re-select {\tt default\_XXX\_node},
-making sure that you actually click on the text.  Now when you click on the
-``Device'' spinbox you should see the device you want.
-
-
-% ----- NOCITES -----
+% ------------------- Helping With Development -------------------
+\newpage
+\input{HelpingWithDevelopment}
+
+% ------------------- Troubleshooting -------------------
+\newpage
+\input{Troubleshooting}
+
+% ------------------- NoCites -------------------
 \nocite{vmware:web}
 \nocite{irctutorial:web}
@@ -383 +175 @@
 \addappheadtotoc
 
-% ------------------------------------------------------------------
-%
-%             APPENDIX: omniNames.sh
-%
-% ------------------------------------------------------------------
+% ------------------- omniNames.sh -------------------
 \section{Creating {\tt omniNames.sh}}
 \label{appendix:omninamessh}
@@ -425 +213 @@
 \end{verbatim}
 
-% ------------------------------------------------------------------
-%
-%             APPENDIX: ossie.pth
-%
-% ------------------------------------------------------------------
+% ------------------- ossie.pth -------------------
+\newpage
 \section{Configuring {\tt ossie.pth}}
 \label{appendix:ossiepth}
 In order for the Python tools to link properly, a Python path file must be
 created to point to the shared modules.
-The default {\tt ossie.pth} file is located under
-{\tt ossie-0.6.2/src/system/ossie/idl/python/} and is installed by default in
+The default {\tt ossie.pth} file is located under \\
+{\tt ossie-0.6.2/src/system/ossie/idl/python/} and is installed by default in \\
 {\tt /usr/lib/pythonX.X/site-packages} when you install the ossie core
 framework libraries.
 
-If you did {\it not} install omniORBpy using {\tt rpm} you might need to add
+If you did {\it not} install omniORBpy using {\tt rpm} you might need to add \\
 {\tt /usr/local/lib/pythonX.X/site-packages} to {\tt ossie.pth} (where
 {\it X.X} corresponds to the specific version of Python installed on your
 system).
-Now reinstall by running the following command as root within 
-{\tt ossie-0.6.2/src/system/ossie/idl/python/}:
-\begin{lstlisting}[]
- # python setup.py install
-\end{lstlisting}
-
-
-% ------------------------------------------------------------------
-%
-%             APPENDIX: Known Bugs
-%
-% ------------------------------------------------------------------
+Now reinstall by running {\tt python setup.py install} as root within \\
+{\tt ossie-0.6.2/src/system/ossie/idl/python/}.
+
+
+% ------------------- Known Bugs -------------------
 \include{Bugs}
 
-% ------------------------------------------------------------------
-%
-%             APPENDIX: Abbreviations
-%
-% ------------------------------------------------------------------
+% ------------------- Abbreviations -------------------
 \input{Abbreviations}
 
@@ -469 +243 @@
 %
 % ------------------------------------------------------------------
+\newpage
 \bibliography{UserGuide}