Commit cb27d1e0 authored by sruizcarmona's avatar sruizcarmona

Cleaned up not necessary files. Removed rodck_nb, gettext and popt from rDock...

Cleaned up not necessary files. Removed rodck_nb, gettext and popt from rDock source, updated documentation files, updated INSTALL file with instructions for installation.
parent 7e69ea09
DEPENDENCIES :
rDOCK BUILD INSTRUCTIONS
For installation of rdock you need :
valid c and c++ compilers
g++
gcc
#########################################
# In this file you have the basic commands for installing rDock in 32- or 64-bits linux computers.
# For a more detailed explanation, please open the Getting Started guide or full documentation
# in our webpage or in docs folder.
#########################################
BACKGROUND
gettext and popt (shipped with the source code)
rDock is written in C++ and makes heavy use of the C++ Standard Template Library (STL).
All source code is compiled into a single shared library (libRbt.so).
The executables are light-weight command-line applications linked with libRbt.so.
rDock should compile on the majority of Unix/Linux platforms with little or no
modification. However, only the following combinations have been thoroughly
tested:
openSUSE 32 and 64 bits.
Ubuntu 32 and 64 bits.
- Both with compiler versions higher than 3.3.
OPTIONAL :
cppunit for building unit tests
########################################################################
PREREQUISITES:
########################################################################
INSTALL :
Make sure you have the following packages installed:
////////////////////////
1 - INSTALLING GETTEXT :
first install gettext, if you do not have it already installed on your system. On modern linux systems like Ubuntu, OpenSuse Fedora etc you should find gettext via the package manager (synaptic, Yast, yum).
In case you want to compile gettext, it is shipped with the rdock code and you can compile it and install it using the following sequence of commands :
- gcc GNU C compiler (or your preferred C compiler)
- g++ GNU C++ compiler (or your preferred C++ compiler)
- make
- popt Command-line argument processing (run-time)
- popt-devel Command-line argument processing (compile-time)
- cppunit C++ unit testing framework (port of JUnit)
- cppunit-devel C++ unit testing framework (port of JUnit)
# tar xzf gettext-0.18.tar.gz
# cd gettext-0.18
# ./configure; make; sudo make install
After installing these dependencies, please follow the following steps:
///////////////////////
///////////////////////
2 - INSTALLING POPT :
next you need to install popt, a library used by rdock for parsing command line arguments:
########################################################################
BASIC BUILD INSTRUCTIONS:
########################################################################
Step 1) BUILD
- Change current directory to build folder:
$ cd rDock_2013.1_src/build
And run, either:
///////////////////////
$ make linux-g++ for 32-bit build with g++ compiler
$ make linux-g++-64 for 64-bit build with g++ compiler
If wish to use a different compiler/architecture combination, or if you wish to
change the compiler flags, see below.
The built libraries and executables are copied to their run-time locations
(../lib and ../bin) as part of Step 1.
Step 2) TEST
$ make test Runs rDock unit tests
If the test has succeed, you are done, enjoy using rDock!
Otherwise, please check your dependencies and all the previous commands or go to
Support Section in the webpage (http://rdock.sourceforge.net) to ask for help.
Step 3) INSTALL
You can either run rDock directly from the build location initial testing), or
install the binaries and data files to a new location.
Set the necessary environmental variables for running rDock in the command line.
(for example, in a bash shell):
$ export RBT_ROOT=/path/to/rDock/installation/
$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$RBT_ROOT/lib
$ export PATH=$PATH:$RBT_ROOT/bin
OTHER MAKE TARGETS
make src_dist Creates source distribution
make clean Removes all intermediate build files
make distclean Also removes installed libs and exes in ../lib and ../bin
########################################################################
rDOCK BUILD INSTRUCTIONS
#########################################
# In this file you have the basic commands for installing rDock in 32- or 64-bits linux computers.
# For a more detailed explanation, please open the Getting Started guide or full documentation
# in our webpage or in docs folder.
#########################################
BACKGROUND
rDock is written in C++ and makes heavy use of the C++ Standard Template Library (STL).
......@@ -10,29 +15,39 @@ rDock should compile on the majority of Unix/Linux platforms with little or no
modification. However, only the following combinations have been thoroughly
tested:
SuSE 9.2 (2.6.8-24.18 kernel), g++ 3.3.4, -march=pentium3 (INTEL)
SuSE 9.2 (2.6.8-24.18 kernel), g++ 3.3.4, -march=k8 (AMD Opteron)
SuSE 9.2 (2.6.8-24.18 kernel), pathCC 2.1,-march=opteron (AMD Opteron)
openSUSE 32 and 64 bits.
Ubuntu 32 and 64 bits.
- Both with compiler versions higher than 3.3.
PREREQUISITES
########################################################################
PREREQUISITES:
########################################################################
Make sure you have the following packages installed:
gcc GNU C compiler (or your preferred C compiler)
g++ GNU C++ compiler (or your preferred C++ compiler)
popt Command-line argument processing (run-time)
popt-devel Command-line argument processing (compile-time)
cppunit C++ unit testing framework (port of JUnit)
BASIC BUILD INSTRUCTIONS
- gcc GNU C compiler (or your preferred C compiler)
- g++ GNU C++ compiler (or your preferred C++ compiler)
- make
- popt Command-line argument processing (run-time)
- popt-devel Command-line argument processing (compile-time)
- cppunit C++ unit testing framework (port of JUnit)
- cppunit-devel C++ unit testing framework (port of JUnit)
After installing these dependencies, please follow the following steps:
########################################################################
BASIC BUILD INSTRUCTIONS:
########################################################################
Step 1) BUILD
Either:
- Change current directory to build folder:
$ cd rDock_2013.1_src/build
And run, either:
$ make linux-g++ for 32-bit build with g++ compiler
$ make linux-g++-64 for 64-bit build with g++ compiler
or
$ make linux-pathCC-64 for 64-bit AMD Opteron build with PathScale compiler
If wish to use a different compiler/architecture combination, or if you wish to
change the compiler flags, see below.
......@@ -44,22 +59,25 @@ Step 2) TEST
$ make test Runs rDock unit tests
If any failed tests are reported, please email XXX, otherwise you are all set.
If the test has succeed, you are done, enjoy using rDock!
Otherwise, please check your dependencies and all the previous commands or go to
Support Section in the webpage (http://rdock.sourceforge.net) to ask for help.
Step 3) INSTALL
You can either run rDock directly from the build location (only recommended for
initial testing), or install the binaries and data files to a new location
(recommended for "production" use).
a) make dist Creates binary distribution (.tgz file)
You can either run rDock directly from the build location initial testing), or
install the binaries and data files to a new location.
b) Copy rdock_<CODELINE>.tgz to the desired location
Set the necessary environmental variables for running rDock in the command line.
(for example, in a bash shell):
c) tar xvzf rdock_<CODELINE>.tgz
$ export RBT_ROOT=/path/to/rDock/installation/
$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$RBT_ROOT/lib
$ export PATH=$PATH:$RBT_ROOT/bin
OTHER MAKE TARGETS
make src_dist Creates source distribution
make clean Removes all intermediate build files
make distclean Also removes installed libs and exes in ../lib and ../bin
########################################################################
This diff is collapsed.
This diff is collapsed.
Getting started with rDock:
See rDock_getting_started.pdf/.html/.xml
LATEST CHANGELIST FOR .././...#have
//depot/dev/client3/rdock/2006.1/... //dave-armari-client3/rdock/2006.1/... /home/dave/dev/client3/rdock/2006.1/...
Change 899 on 2006/09/27 by [email protected] 'Removed outdated historical hea'
LATEST CHANGELIST FOR ../bin/...#have
//depot/dev/client3/rdock/2006.1/bin/... //dave-armari-client3/rdock/2006.1/bin/... /home/dave/dev/client3/rdock/2006.1/bin/...
Change 899 on 2006/09/27 by [email protected] 'Removed outdated historical hea'
LATEST CHANGELIST FOR ../build/...#have
//depot/dev/client3/rdock/2006.1/build/... //dave-armari-client3/rdock/2006.1/build/... /home/dave/dev/client3/rdock/2006.1/build/...
Change 885 on 2006/09/27 by [email protected] 'Integrated final changes from E'
LATEST CHANGELIST FOR ../data/...#have
//depot/dev/client3/rdock/2006.1/data/... //dave-armari-client3/rdock/2006.1/data/... /home/dave/dev/client3/rdock/2006.1/data/...
Change 864 on 2006/09/20 by [email protected] 'Integrated changes from enspira'
LATEST CHANGELIST FOR ../docs/...#have
//depot/dev/client3/rdock/2006.1/docs/... //dave-armari-client3/rdock/2006.1/docs/... /home/dave/dev/client3/rdock/2006.1/docs/...
Change 883 on 2006/09/27 by [email protected] 'Added Unix text version of End '
LATEST CHANGELIST FOR ../include/...#have
//depot/dev/client3/rdock/2006.1/include/... //dave-armari-client3/rdock/2006.1/include/... /home/dave/dev/client3/rdock/2006.1/include/...
Change 890 on 2006/09/27 by [email protected] 'Added standard header to GP hea'
LATEST CHANGELIST FOR ../src/...#have
//depot/dev/client3/rdock/2006.1/src/... //dave-armari-client3/rdock/2006.1/src/... /home/dave/dev/client3/rdock/2006.1/src/...
Change 898 on 2006/09/27 by [email protected] 'Downgraded six of the executabl'
\relax
\ifx\hyper@anchor\@undefined
\global \let \oldcontentsline\contentsline
\gdef \contentsline#1#2#3#4{\oldcontentsline{#1}{#2}{#3}}
\global \let \oldnewlabel\newlabel
\gdef \newlabel#1#2{\newlabelxx{#1}#2}
\gdef \newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}}
\AtEndDocument{\let \contentsline\oldcontentsline
\let \newlabel\oldnewlabel}
\else
\global \let \hyper@last\relax
\fi
This diff is collapsed.
\documentclass[9pt,a4paper]{article}
\usepackage[utf8x]{inputenc}
\usepackage{ucs}
\usepackage{amsmath}
\usepackage{amsfonts}
\usepackage{amssymb}
\usepackage{graphicx}
\usepackage{makeidx}
\usepackage{hyperref}
\usepackage{pdfpages}
\usepackage[sectionbib]{chapterbib}
\usepackage[sectionbib]{natbib}
\renewcommand*{\bibfont}{\small}
\usepackage{booktabs}
%\usepackage{fullpage}
\usepackage[top=2.5cm,left=3.4cm,right=2.2cm,bottom=2.5cm]{geometry}
\usepackage[small,bf]{caption}
%\usepackage{fancyhdr}
%\pagestyle{fancy}
\makeindex
\def\blfootnote{\xdef\@thefnmark{}\@footnotetext}
\begin{document}
\cleardoublepage
\title{RDock\\ How to install and compile}
\author{Peter Schmidtke}
\maketitle
\thispagestyle{empty}
\cleardoublepage
\setcounter{page}{1}
\tableofcontents %put toc in
%\include{conclusions}
\end{document}
\relax
\ifx\hyper@anchor\@undefined
\global \let \oldcontentsline\contentsline
\gdef \contentsline#1#2#3#4{\oldcontentsline{#1}{#2}{#3}}
\global \let \oldnewlabel\newlabel
\gdef \newlabel#1#2{\newlabelxx{#1}#2}
\gdef \newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}}
\AtEndDocument{\let \contentsline\oldcontentsline
\let \newlabel\oldnewlabel}
\else
\global \let \hyper@last\relax
\fi
\gdef\@[email protected]{@-1}\@writefile{toc}{\gdef \the@ipfilectr{@-1}}\@writefile{lof}{\gdef \the@ipfilectr{@-1}}\@writefile{lot}{\gdef \the@ipfilectr{@-1}}
\@input{Introduction.aux}
\gdef\@[email protected]{}\@writefile{toc}{\gdef \the@ipfilectr{}}\@writefile{lof}{\gdef \the@ipfilectr{}}\@writefile{lot}{\gdef \the@ipfilectr{}}
\gdef\@[email protected]{@-2}\@writefile{toc}{\gdef \the@ipfilectr{@-2}}\@writefile{lof}{\gdef \the@ipfilectr{@-2}}\@writefile{lot}{\gdef \the@ipfilectr{@-2}}
\@input{Installation.aux}
\gdef\@[email protected]{}\@writefile{toc}{\gdef \the@ipfilectr{}}\@writefile{lof}{\gdef \the@ipfilectr{}}\@writefile{lot}{\gdef \the@ipfilectr{}}
\indexentry{Introduction|hyperpage}{1}
\indexentry{Prerequisits|hyperpage}{1}
\indexentry{Installation|hyperpage}{2}
This is makeindex, version 2.15 [TeX Live 2009] (kpathsea + Thai support).
Scanning input file INSTALL.idx....done (1 entries accepted, 0 rejected).
Sorting entries...done (0 comparisons).
Generating output file INSTALL.ind....done (5 lines written, 0 warnings).
Output written in INSTALL.ind.
Transcript written in INSTALL.ilg.
\begin{theindex}
\item Introduction, \hyperpage{2}
\end{theindex}
This diff is collapsed.
\BOOKMARK [1][-]{section.1}{Introduction}{}
\BOOKMARK [2][-]{subsection.1.1}{Prerequisites}{section.1}
\BOOKMARK [2][-]{subsection.1.2}{License \046 Warranty}{section.1}
\BOOKMARK [2][-]{subsection.1.3}{Support \046 Contact}{section.1}
\BOOKMARK [1][-]{section.2}{Installation}{}
\BOOKMARK [2][-]{subsection.2.1}{Gettext}{section.2}
\BOOKMARK [2][-]{subsection.2.2}{Popt}{section.2}
\documentclass[9pt,a4paper]{article}
\usepackage[utf8x]{inputenc}
\usepackage{ucs}
\usepackage{amsmath}
\usepackage{amsfonts}
\usepackage{amssymb}
\usepackage{graphicx}
\usepackage{makeidx}
\usepackage{hyperref}
\usepackage{pdfpages}
\usepackage[sectionbib]{chapterbib}
\usepackage[sectionbib]{natbib}
\renewcommand*{\bibfont}{\small}
\usepackage{booktabs}
%\usepackage{fullpage}
\usepackage[top=2.5cm,left=3.4cm,right=2.2cm,bottom=2.5cm]{geometry}
\usepackage[small,bf]{caption}
%\usepackage{fancyhdr}
%\pagestyle{fancy}
\makeindex
\def\blfootnote{\xdef\@thefnmark{}\@footnotetext}
\begin{document}
\cleardoublepage
\title{RDock\\ How to install and compile}
\author{Peter Schmidtke}
\maketitle
\thispagestyle{empty}
\cleardoublepage
\setcounter{page}{1}
%\tableofcontents %put toc in
\include{Introduction}
\include{Installation}
\end{document}
\gdef \the@ipfilectr {@-1}
\contentsline {section}{\numberline {1}Introduction}{2}{section.1}
\contentsline {section}{Introduction}{2}{section.1}
\gdef \the@ipfilectr {}
\relax
\@writefile{toc}{\contentsline {section}{\numberline {2}Installation}{2}{section.2}}
\newlabel{Installation}{{2}{2}{Installation\relax }{section.2}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.1}Gettext}{2}{subsection.2.1}}
\@writefile{toc}{\contentsline {subsection}{\numberline {2.2}Popt}{2}{subsection.2.2}}
\@setckpt{Installation}{
\setcounter{page}{3}
\setcounter{equation}{0}
\setcounter{enumi}{0}
\setcounter{enumii}{0}
\setcounter{enumiii}{0}
\setcounter{enumiv}{0}
\setcounter{footnote}{0}
\setcounter{mpfootnote}{0}
\setcounter{part}{0}
\setcounter{section}{2}
\setcounter{subsection}{2}
\setcounter{subsubsection}{0}
\setcounter{paragraph}{0}
\setcounter{subparagraph}{0}
\setcounter{figure}{0}
\setcounter{table}{0}
\setcounter{parentequation}{0}
\setcounter{Item}{0}
\setcounter{Hfootnote}{0}
\setcounter{[email protected]}{0}
\setcounter{[email protected]}{0}
\setcounter{ContinuedFloat}{0}
\setcounter{[email protected]}{2}
}
\clearpage
\section{Installation} \index{Installation} \label{Installation}
Rdock currently has several prerequisites, you have to install prior to Rdock.
\subsection{Gettext}
First you have to install gettext, which can be either done in different ways :
\begin{itemize}
\item Ubuntu : sudo apt-get install gettext
\item OpenSuse : zypper install gettext
\item Fedora/CentOs/Redhat : yum install gettext
\end{itemize}
In case you have another distribution or you prefer to compile gettext for your machine, you can do so. Gettext version 0.18 is shipped with the rdock source code. You can install by going to the rdock directory and triggering the following commands :\newline\newline
tar xzf gettext-0.18.tar.gz\newline
cd gettext-0.18\newline
./configure; \newline make; \newline sudo make install\newline
\subsection{Popt}
The last mandatory dependency of Rdock is popt. popt is shipped with the Rdock code and can be installed the following way : \newline\newline
\relax
\@writefile{toc}{\contentsline {section}{\numberline {1}Introduction}{1}{section.1}}
\newlabel{Introduction}{{1}{1}{Introduction\relax }{section.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {1.1}Prerequisites}{1}{subsection.1.1}}
\newlabel{Prerequisites}{{1.1}{1}{Prerequisites\relax }{subsection.1.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {1.2}License \& Warranty}{1}{subsection.1.2}}
\@writefile{toc}{\contentsline {subsection}{\numberline {1.3}Support \& Contact}{1}{subsection.1.3}}
\@setckpt{Introduction}{
\setcounter{page}{2}
\setcounter{equation}{0}
\setcounter{enumi}{0}
\setcounter{enumii}{0}
\setcounter{enumiii}{0}
\setcounter{enumiv}{0}
\setcounter{footnote}{0}
\setcounter{mpfootnote}{0}
\setcounter{part}{0}
\setcounter{section}{1}
\setcounter{subsection}{3}
\setcounter{subsubsection}{0}
\setcounter{paragraph}{0}
\setcounter{subparagraph}{0}
\setcounter{figure}{0}
\setcounter{table}{0}
\setcounter{parentequation}{0}
\setcounter{Item}{0}
\setcounter{Hfootnote}{0}
\setcounter{[email protected]}{0}
\setcounter{[email protected]}{0}
\setcounter{ContinuedFloat}{0}
\setcounter{[email protected]}{2}
}
This is pdfTeX, Version 3.1415926-1.40.10 (TeX Live 2009/openSUSE) (format=pdflatex 2012.3.15) 10 JUN 2012 09:15
entering extended mode
%&-line parsing enabled.
**Introduction.tex
(./Introduction.tex
LaTeX2e <2009/09/24>
Babel <v3.8l> and hyphenation patterns for english, usenglishmax, dumylang, noh
yphenation, german-x-2009-06-19, ngerman-x-2009-06-19, ancientgreek, ibycus, ar
abic, basque, bulgarian, catalan, pinyin, coptic, croatian, czech, danish, dutc
h, esperanto, estonian, farsi, finnish, french, galician, german, ngerman, mono
greek, greek, hungarian, icelandic, indonesian, interlingua, irish, italian, ku
rmanji, latin, latvian, lithuanian, mongolian, mongolian2a, bokmal, nynorsk, po
lish, portuguese, romanian, russian, sanskrit, serbian, slovak, slovenian, span
ish, swedish, turkish, ukenglish, ukrainian, uppersorbian, welsh, loaded.
! Undefined control sequence.
l.2 \section
{Introduction} \index{Introduction} \label{Introduction}
The control sequence at the end of the top line
of your error message was never \def'ed. If you have
misspelled it (e.g., `\hobx'), type `I' and the correct
spelling (e.g., `I\hbox'). Otherwise just continue,
and I'll forget about whatever was undefined.
! LaTeX Error: Missing \begin{document}.
See the LaTeX manual or LaTeX Companion for explanation.
Type H <return> for immediate help.
...
l.2 \section{I
ntroduction} \index{Introduction} \label{Introduction}
You're in trouble here. Try typing <return> to proceed.
If that doesn't work, type X <return> to quit.
Missing character: There is no I in font nullfont!
Missing character: There is no n in font nullfont!
Missing character: There is no t in font nullfont!
Missing character: There is no r in font nullfont!
Missing character: There is no o in font nullfont!
Missing character: There is no d in font nullfont!
Missing character: There is no u in font nullfont!
Missing character: There is no c in font nullfont!
Missing character: There is no t in font nullfont!
Missing character: There is no i in font nullfont!
Missing character: There is no o in font nullfont!
Missing character: There is no n in font nullfont!
Overfull \hbox (20.0pt too wide) in paragraph at lines 2--3
[]
[]
)
! Emergency stop.
<*> Introduction.tex
*** (job aborted, no legal \end found)
Here is how much of TeX's memory you used:
5 strings out of 493848
172 string characters out of 3155814
48936 words of memory out of 3500000
3381 multiletter control sequences out of 15000+200000
3640 words of font info for 14 fonts, out of 3000000 for 9000
714 hyphenation exceptions out of 8191
7i,0n,4p,83b,24s stack positions out of 5000i,500n,10000p,200000b,50000s
! ==> Fatal error occurred, no output PDF file produced!
\clearpage
\section{Introduction} \index{Introduction} \label{Introduction}
\subsection{Prerequisites} \index{Prerequisits} \label{Prerequisites}
In order to be able to install RDock properly you need several pre-installed libraries or executables :
\begin{itemize}
\item gcc
\item g++
\item gettext (necessary for popt)
\item popt (shipped with the RDock source code)
\item cppunit (optional if you want to build the tests for RDock)
\end{itemize}
\subsection{License \& Warranty}
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\newline
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.\newline
You should have received a copy of the GNU General Public License
along with this program. If not, see http://www.gnu.org/licenses.
\subsection{Support \& Contact}
%\addcontentsline{toc}{section}{Introduction}
\ No newline at end of file
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
<?xml version="1.0" encoding="UTF-8"?>
<project>
<meta>
<filters directoryPatterns="" filePatterns=""/>
</meta>
<projectTree name="rdock.xpr">
<file name="rDock_getting_started.xml"/>
<file name="rDock_reference_guide.xml"/>
</projectTree>
</project>
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library