/[thuban]/branches/WIP-pyshapelib-bramz/Doc/manual/thuban-manual.xml
ViewVC logotype

Diff of /branches/WIP-pyshapelib-bramz/Doc/manual/thuban-manual.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1689 by jan, Fri Aug 29 10:03:49 2003 UTC revision 1744 by jan, Tue Sep 23 15:37:25 2003 UTC
# Line 95  Line 95 
95                  full installation packages for Debian, Windows and RPM-based systems                  full installation packages for Debian, Windows and RPM-based systems
96                  (Mandrake, RedHat, SuSE, etc).                  (Mandrake, RedHat, SuSE, etc).
97                  </para>                  </para>
98                    <section><title>RPM-based GNU/Linux Systems</title>
99                            <section><title>Installing Binary Packages</title>
100                                    <para>
101                                    The most wide-spread RPM-based GNU/Linux Systems are RedHat,
102                                    Mandrake and SuSE. The documentation of these distributions
103                                    should contain information about how to install third-party
104                                    RPM packages. Nonetheless, a short summary is provided here.
105                                    </para>
106                                    <para>
107                                    RPM packages can be installed applying several tools.
108                                    The most basic one is the command line program "rpm".
109                                    The hardware architecture is identified in the name
110                                    of RPM packages, eg. 'i386' for most Intel/AMD architectures.
111                                    If you have a different hardware architecture, where no
112                                    binary RPM packages are provided, you must rebuild binary
113                                    packages from the RPM source packages first (see below).
114                                    Typical rpm commands look like:
115    
116                                    <programlisting>
117                                    rpm --install Thuban-0.9.0-1.i386.rpm
118                                    </programlisting>
119    
120                                    Depending on what you already have installed on your
121                                    system, you are informed that some packages are
122                                    required, but not installed. You need to install them
123                                    first. Either they are provided by your GNU/Linux distributor
124                                    or available somewhere on the Internet.
125                                    The more essential and special ones are provided together
126                                    with the Thuban package.
127                                    </para>
128    
129                                    <para>
130                                    For rpm exist some graphical user interfaces, notably
131                                    kpackage, GnoRPM and xrpm.
132                                    </para>
133    
134                                    <para>
135                                    Make yourself familiar with one of the tools and apply it
136                                    to install the packages.
137                                    Note, that you need to be administrator (root) for the system
138                                    to do that.
139                                    </para>
140                            </section>
141                            <section><title>Build Binaries from Source Packages</title>
142                                    <para>
143                                    This section describes howto build RPM install-packages
144                                    from RPM source-packages.
145                                    This adapts and optimizes an install-package specifically
146                                    to your system.
147                                    This is especially helpful to resolve version conflicts of
148                                    dependent packages. Furthermore, install-packages for other
149                                    platforms (e.g. PowerPC) can be created.
150                                    </para>
151    
152                                    <para>
153                                    Note: rpm must be at least version 4. Execute
154                                    <literal>rpm --version</literal> to find out about the version.
155                                    </para>
156    
157                                    <para>
158                                    You need to do the following preparations to be able to
159                                    build the packages as a regular user. You should now
160                                    perform the package buling as root since this
161                                    might cause damage to your system.
162                            <itemizedlist>
163                            <listitem>
164                                                    <para>
165                                                    Create RPM directory structure:
166                                                    Choose a directory (e.g. $HOME/myrpm) and create the
167                                                    subdirectories BUILD, RPM, SOURCES, SPECS and SRPMS.
168                                                    A possible command sequence for this is:
169                                                    <programlisting>
170                                                    mkdir $HOME/freegisrpm
171                                                    cd $HOME/freegisrpm
172                                                    mkdir BUILD RPMS SOURCES SPECS SRPMS
173                                                    </programlisting>
174                                                    </para>
175                                            </listitem>
176                                            <listitem>
177                                                    <para>
178                                                    Set environment variable RPM_DIR:
179                                                    <programlisting>
180                                                    export RPM_DIR=$HOME/freegisrpm
181                                                    </programlisting>
182                                                    </para>
183                                            </listitem>
184                                            <listitem>
185                                                    <para>
186                                                    Create $HOME/.rpmmacros:
187                                                    This file sets general preferences and some
188                                                    specific settings for signing packages.
189                                                    If you don't have a GnuPG-key, you can skip
190                                                    the signature settings i.e. drop the last 4 lines.
191                                                    A signature becomes important when you want to
192                                                    give away packages to third parties.
193                                                    <programlisting>
194    <![CDATA[
195    %packager Name Lastname <[email protected]>
196    
197    %_topdir /home/mylogin/myrpm
198    
199    %_signature gpg
200    %_gpg_name Name Lastname
201    %_pgp_path ~/.gnupg
202    %_pgpbin /usr/bin/gpg
203    ]]>
204                                                    </programlisting>
205                                                    </para>
206                                            </listitem>
207                            </itemizedlist>
208    
209                                    Now you can install any RPM source-package.
210                                    It's components are installed into the corresponding
211                                    subdirectories of your rpm-directory.
212                                    Essentially these are the sources (into directory SOURCES)
213                                    and the so-called spec-file which contains all build
214                                    instructions. The spec-file will go into the SPEC directory.
215                                    Example:
216                                    <literal>rpm --install Thuban-0.9.0-1.src.rpm</literal>
217                                    </para>
218    
219                                    <para>
220                                    Create install-package:
221                                    Go to the directory with the spec-files and rebuild the
222                                    package:
223                                    <programlisting>
224    cd $HOME/mypm/SPECS
225    rpm -bb thuban.spec
226                                    </programlisting>
227                                    Next, you will find the newly created package in
228                                    $HOME/myrpm/RPMS/i386.
229                                    If you build the package for another architecture than
230                                    i386, then the name of the directory has a corresponding name.
231                                    </para>
232                                    <para>
233                                    For documentation of RPM, either type
234                                    <literal>man rpm</literal> or <literal>rpm --help</literal>.
235                                    This will provide you with information on the various command
236                                    line options of RPM.
237                                    For more information see the
238                            <ulink url="http://www.rpm.org/">homepage of RPM</ulink>.
239                                    </para>
240                            </section>
241                    </section>
242          </section>          </section>
243    
244          <section><title>The Main Window</title>          <section><title>The Main Window</title>
# Line 1252  Line 1396 
1396                  to this file to keep the actual code of extensions separate.                  to this file to keep the actual code of extensions separate.
1397                  </para>                  </para>
1398                  <para>                  <para>
1399                  The modules to import must either be found though the environment                  The modules to import must either be found through the environment
1400                  variable PYTHONPATH or directly be placed into the .thuban-directory.                  variable PYTHONPATH or directly be placed into the .thuban-directory.
1401                  </para>                  </para>
1402                  <para>                  <para>
# Line 1266  Line 1410 
1410                  </para>                  </para>
1411          </section>          </section>
1412    
1413            <section><title>Extensions included in Thuban package</title>
1414                    <para>
1415                    The extensions described in this section are part of the
1416                    Thuban package, but not activated by default.
1417                    You will find them in the Thuban installation directory
1418                    under <literal>Extensions/</literal>. Activate them as personal
1419                    extensions via PYTHONPATH as described in the previous section.
1420                    Stable extensions will appear under the menu
1421                    <menuchoice><guimenu>Extensions</guimenu></menuchoice> and
1422                    extensions which are in experimental state and therefore
1423                    not fully functional under
1424                    <menuchoice><guimenu>Experimental</guimenu></menuchoice>.
1425                    </para>
1426    
1427                    <section><title>Stable extensions</title>
1428                            <para>
1429                            These extensions provide extra-functionality to Thuban
1430                            that has not (yet) been integrated in the main application.
1431                            They are considered to be free of bugs, but may be
1432                            further polished with helpful user interactions.
1433                            </para>
1434                            <section><title>gns2shp</title>
1435                                    <para>
1436                                    This tool converts data of the Geospatial Names Server
1437                                    (GNS, see <ulink url="http://www.nima.mil/gns"/>)
1438                                    into Shapefile format.
1439                                    The above web-site offer to download named places
1440                                    information grouped by countries for all of the world
1441                                    except USA for which other data are provided.
1442                                    </para>
1443                                    <para>
1444                                    If you download and unpack a package, you will have
1445                                    a text-file with suffix .txt.
1446                                    Selecting such a file via gns2shp will create the
1447                                    corresponding Shapefile with the same basename and
1448                                    place it in the same direcory. Afterwards it
1449                                    is automatically loaded into Thuban.
1450                                    The Shapefile will not automatically be delete afterwards.
1451                                    </para>
1452                                    <para>
1453                                    The gns2shp.py module can also be executed on the
1454                                    command line for batch processing purposes.
1455                                    </para>
1456                                    <para>
1457                                    A sample (<literal>ls.txt</literal> for Liechtenstein)
1458                                    is included in the directory
1459                                    <literal>Extensions/gns2shp/test</literal>.
1460                                    </para>
1461                            </section>
1462                    </section>
1463                    <section><title>Experimental extensions</title>
1464                            <para>
1465                            All all of these functions have to be handled with care,
1466                            since they are neither complete nor well tested.
1467                            They are to be seen as a proof-of-concept and may
1468                            additionally in some cases of practical help.
1469                            </para>
1470                            <para>
1471                            Any interest on further improvement of these extensions
1472                            should be communicated towards the developer and user
1473                            community.
1474                            </para>
1475    
1476                            <section><title>importAPR</title>
1477                                    <para>
1478                                    This command offer to load an ESRI� ArcView� project
1479                                    file (suffix .apr) and convert it for use within Thuban.
1480                                    After selecting a apr-file to load, a list
1481                                    will be presented that offers to select one of the views
1482                                    of the apr-file, provided there is more than one.
1483                                    Furthermore, the Session Info-Tree is extended with
1484                                    a complete representation of the parsed apr-file.
1485                                    </para>
1486                                    <para>
1487                                    The legend of Thuban does not yet cover all of the elements as
1488                                    supported by the legend of ArcView�. Therefore, the Thuban
1489                                    map will look different. Furthermore, the apr-format is
1490                                    a proprietary format, not openly documented.
1491                                    Therefore, the interpretation is
1492                                    partly based on reverse engeneering and good guessing.
1493                                    </para>
1494                                    <para>
1495                                    The file-paths within the apr-file may not fit and potentially
1496                                    are subject to fix in the apr-file. You can do this
1497                                    applying any text editor. The paths are either absolute
1498                                    or relative from where Thuban has been started.
1499                                    </para>
1500                                    <para>
1501                                    A sample for the Iceland data is included as
1502                                    <literal>Extensions/importAPR/samples/iceland.apr</literal>.
1503                                    The file-paths are relative from the Thuban main directory.
1504                                    </para>
1505                            </section>
1506                    </section>
1507            </section>
1508    
1509          <section><title>Writing simple extensions</title>          <section><title>Writing simple extensions</title>
1510                  <para>                  <para>
1511                  Writing an extension for Thuban basically means to                  Writing an extension for Thuban basically means to

Legend:
Removed from v.1689  
changed lines
  Added in v.1744

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26